blob: fdf96d25646ecda6f7626af69843acf927ec0b47 [file] [log] [blame]
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001/* vi: set sw=8 ts=8: */
Denis Vlasenkoe2d3ded2006-11-27 23:43:28 +00002/*
3 * This file suffers from chronically incorrect tabification
4 * of messages. Before editing this file:
5 * 1. Switch you editor to 8-space tab mode.
6 * 2. Do not use \t in messages, use real tab character.
7 * 3. Start each source line with message as follows:
Denis Vlasenko1fffe382006-11-28 00:06:39 +00008 * |<7 spaces>"text with tabs"....
Denis Vlasenkocdf62772008-03-17 08:42:43 +00009 * or
10 * |<5 spaces>"\ntext with tabs"....
Denis Vlasenkoe2d3ded2006-11-27 23:43:28 +000011 */
12
Eric Andersen178de172004-04-06 16:36:20 +000013#ifndef __BB_USAGE_H__
14#define __BB_USAGE_H__
15
Eric Andersenf349e972001-08-21 16:18:59 +000016#define addgroup_trivial_usage \
Bernhard Reutner-Fischer00c2c482007-04-05 13:16:39 +000017 "[-g GID]"USE_FEATURE_ADDUSER_TO_GROUP(" [user_name]")" group_name"
Eric Andersenf349e972001-08-21 16:18:59 +000018#define addgroup_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000019 "Add a group"USE_FEATURE_ADDUSER_TO_GROUP(" or add an user to a group") \
Denis Vlasenko765996a2006-12-24 16:59:27 +000020 "\n\nOptions:\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +000021 " -g GID Group id"
Eric Andersenf349e972001-08-21 16:18:59 +000022
23#define adduser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000024 "[OPTIONS] user_name"
Eric Andersenf349e972001-08-21 16:18:59 +000025#define adduser_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000026 "Add an user" \
Denis Vlasenko765996a2006-12-24 16:59:27 +000027 "\n\nOptions:\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +000028 " -h DIR Home directory\n" \
29 " -g GECOS GECOS field\n" \
30 " -s SHELL Login shell\n" \
31 " -G GROUP Add user to existing group\n" \
Denis Vlasenko15ca51e2007-10-29 19:25:45 +000032 " -S Create a system user\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +000033 " -D Do not assign a password\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +000034 " -H Do not create home directory"
Eric Andersenf349e972001-08-21 16:18:59 +000035
Mark Whitley6f932772001-03-20 19:18:10 +000036#define adjtimex_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000037 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
Mark Whitley6f932772001-03-20 19:18:10 +000038#define adjtimex_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +000039 "Read and optionally set system timebase parameters.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +000040 "See adjtimex(2)." \
41 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +000042 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +000043 " -o offset Time offset, microseconds\n" \
44 " -f frequency Frequency adjust, integer kernel units (65536 is 1ppm)\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +000045 " (positive values make clock run faster)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +000046 " -t tick Microseconds per tick, usually 10000\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000047 " -p timeconstant"
Mark Whitley6f932772001-03-20 19:18:10 +000048
Eric Andersen7e9276b2001-02-22 01:15:47 +000049#define ar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000050 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Eric Andersen7e9276b2001-02-22 01:15:47 +000051#define ar_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +000052 "Extract or list FILES from an ar archive" \
53 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +000054 " -o Preserve original dates\n" \
55 " -p Extract to stdout\n" \
56 " -t List\n" \
57 " -x Extract\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +000058 " -v Verbose"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000059
Denis Vlasenkofa85b862007-01-07 01:24:12 +000060#define arp_trivial_usage \
61 "\n" \
62 "[-vn] [-H type] [-i if] -a [hostname]\n" \
63 "[-v] [-i if] -d hostname [pub]\n" \
64 "[-v] [-H type] [-i if] -s hostname hw_addr [temp]\n" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +000065 "[-v] [-H type] [-i if] -s hostname hw_addr [netmask nm] pub\n" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000066 "[-v] [-H type] [-i if] -Ds hostname ifa [netmask nm] pub\n"
67#define arp_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000068 "Manipulate ARP cache" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000069 "\n\nOptions:" \
70 "\n -a Display (all) hosts" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000071 "\n -s Set new ARP entry" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000072 "\n -d Delete a specified entry" \
73 "\n -v Verbose" \
74 "\n -n Don't resolve names" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000075 "\n -i IF Network interface" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000076 "\n -D Read <hwaddr> from given device" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000077 "\n -A, -p AF Protocol family" \
78 "\n -H HWTYPE Hardware address type"
Denis Vlasenkofa85b862007-01-07 01:24:12 +000079
Glenn L McGrath9e598412003-01-09 10:06:01 +000080#define arping_trivial_usage \
Denis Vlasenkof23c3f92007-11-23 09:27:05 +000081 "[-fqbDUA] [-c count] [-w timeout] [-I dev] [-s sender] target"
Glenn L McGrath9e598412003-01-09 10:06:01 +000082#define arping_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +000083 "Ping hosts by ARP requests/replies" \
84 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000085 " -f Quit on first ARP reply\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +000086 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000087 " -b Keep broadcasting, don't go unicast\n" \
88 " -D Duplicated address detection mode\n" \
Denis Vlasenkof23c3f92007-11-23 09:27:05 +000089 " -U Unsolicited ARP mode, update your neighbors\n" \
90 " -A ARP answer mode, update your neighbors\n" \
91 " -c N Stop after sending N ARP requests\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000092 " -w timeout Time to wait for ARP reply, in seconds\n" \
Denis Vlasenkof23c3f92007-11-23 09:27:05 +000093 " -I dev Interface to use (default eth0)\n" \
94 " -s sender Sender IP address\n" \
95 " target Target IP address"
Glenn L McGrath9e598412003-01-09 10:06:01 +000096
Eric Andersen08f59e32004-03-12 22:07:10 +000097#define ash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000098 "[FILE]...\n" \
99 "or: ash -c command [args]..."
Eric Andersen08f59e32004-03-12 22:07:10 +0000100#define ash_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000101 "The ash shell"
Eric Andersen08f59e32004-03-12 22:07:10 +0000102
103#define awk_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000104 "[OPTION]... [program-text] [FILE...]"
Eric Andersen08f59e32004-03-12 22:07:10 +0000105#define awk_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000106 "Options:\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000107 " -v var=val Set variable\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000108 " -F sep Use sep as field separator\n" \
Denis Vlasenkod898b862007-10-14 07:57:26 +0000109 " -f file Read program from file"
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +0000110
Eric Andersen7e9276b2001-02-22 01:15:47 +0000111#define basename_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000112 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000113#define basename_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000114 "Strip directory path and suffixes from FILE.\n" \
115 "If specified, also remove any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000116#define basename_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000117 "$ basename /usr/local/bin/foo\n" \
118 "foo\n" \
119 "$ basename /usr/local/bin/\n" \
120 "bin\n" \
121 "$ basename /foo/bar.txt .txt\n" \
122 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000123
Bernhard Reutner-Fischerd27d9252008-01-13 15:23:27 +0000124#define brctl_trivial_usage \
125 "COMMAND [BRIDGE [INTERFACE]]"
126#define brctl_full_usage \
127 "Manage ethernet bridges." \
128 "\n\nCommands:\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000129 " addbr BRIDGE Create BRIDGE\n" \
130 " delbr BRIDGE Delete BRIDGE\n" \
131 " addif BRIDGE IFACE Add IFACE to BRIDGE\n" \
132 " delif BRIDGE IFACE Delete IFACE from BRIDGE" \
Bernhard Reutner-Fischer1aac3ab2008-01-13 18:43:50 +0000133USE_FEATURE_BRCTL_FANCY("\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000134 " setageing BRIDGE TIME Set ageing time\n" \
135 " setfd BRIDGE TIME Set bridge forward delay\n" \
136 " sethello BRIDGE TIME Set hello time\n" \
137 " setmaxage BRIDGE TIME Set max message age\n" \
138 " setpathcost BRIDGE COST Set path cost\n" \
139 " setportprio BRIDGE PRIO Set port priority\n" \
140 " setbridgeprio BRIDGE PRIO Set bridge priority\n" \
141 " stp BRIDGE [1|0] STP on/off\n" \
Bernhard Reutner-Fischer1aac3ab2008-01-13 18:43:50 +0000142)
Glenn L McGrath24e28332001-10-05 03:48:57 +0000143#define bunzip2_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000144 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000145#define bunzip2_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000146 "Uncompress FILE (or standard input if FILE is '-' or omitted)" \
147 "\n\nOptions:\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000148 " -c Write to standard output\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000149 " -f Force"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000150
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000151#define bzip2_trivial_usage \
152 "[OPTION]... [FILE]..."
153#define bzip2_full_usage \
154 "Compress FILE(s) with bzip2 algorithm.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000155 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n" \
156 "\nOptions:" \
157 "\n -c Write to standard output" \
158 "\n -d Decompress" \
159 "\n -f Force" \
160 "\n -1..-9 Compression level"
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000161
Rob Landley6130b9b2006-01-23 21:10:38 +0000162#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000163 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000164
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000165#define bzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000166 "FILE"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000167#define bzcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000168 "Uncompress to stdout"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000169
Rob Landleyc1d69902006-01-20 18:28:50 +0000170#define unlzma_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000171 "[OPTION]... [FILE]"
Rob Landleyc1d69902006-01-20 18:28:50 +0000172#define unlzma_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000173 "Uncompress FILE (or standard input if FILE is '-' or omitted)" \
174 "\n\nOptions:\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000175 " -c Write to standard output\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000176 " -f Force"
Rob Landleyc1d69902006-01-20 18:28:50 +0000177
178#define lzmacat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000179 "FILE"
Rob Landleyc1d69902006-01-20 18:28:50 +0000180#define lzmacat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000181 "Uncompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000182
Eric Andersenc98c0622001-12-06 15:16:43 +0000183#define cal_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000184 "[-jy] [[month] year]"
Eric Andersenc98c0622001-12-06 15:16:43 +0000185#define cal_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000186 "Display a calendar" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000187 "\n\nOptions:" \
188 "\n -j Use julian dates" \
189 "\n -y Display the entire year"
Eric Andersenc98c0622001-12-06 15:16:43 +0000190
Eric Andersen7e9276b2001-02-22 01:15:47 +0000191#define cat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000192 "[-u] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000193#define cat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000194 "Concatenate FILE(s) and print them to stdout" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000195 "\n\nOptions:" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000196 "\n -u Use unbuffered i/o (ignored)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000197#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000198 "$ cat /proc/uptime\n" \
199 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000200
Rob Landley8abbee42006-05-31 19:36:04 +0000201#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000202 "[-etv] [FILE]..."
Rob Landley8abbee42006-05-31 19:36:04 +0000203#define catv_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000204 "Display nonprinting characters as ^x or M-x" \
205 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000206 " -e End each line with $\n" \
207 " -t Show tabs as ^I\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000208 " -v Don't use ^x or M-x escapes"
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000209
210#define chat_trivial_usage \
211 "EXPECT [SEND [EXPECT [SEND...]]]"
212#define chat_full_usage \
213 "Useful for interacting with a modem connected to stdin/stdout.\n" \
214 "A script consists of one or more \"expect-send\" pairs of strings,\n" \
215 "each pair is a pair of arguments. Example:\n" \
216 "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \
217
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000218#define chattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000219 "[-R] [-+=AacDdijsStTu] [-v version] files..."
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000220#define chattr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000221 "Change file attributes on an ext2 fs\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000222 "Modifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000223 " - Remove attributes\n" \
224 " + Add attributes\n" \
225 " = Set attributes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000226 "Attributes:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000227 " A Don't track atime\n" \
228 " a Append mode only\n" \
229 " c Enable compress\n" \
230 " D Write dir contents synchronously\n" \
231 " d Do not backup with dump\n" \
232 " i Cannot be modified (immutable)\n" \
233 " j Write all data to journal first\n" \
234 " s Zero disk storage when deleted\n" \
235 " S Write file contents synchronously\n" \
236 " t Disable tail-merging of partial blocks with other files\n" \
237 " u Allow file to be undeleted\n" \
Denis Vlasenko5dd7ef02006-12-26 03:36:28 +0000238 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000239 " -R Recursively list subdirectories\n" \
240 " -v Set the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000241
Denis Vlasenko49622d72007-03-10 16:58:49 +0000242#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000243 "[OPTIONS] CONTEXT FILE..." \
244 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
245 USE_FEATURE_CHCON_LONG_OPTIONS( \
246 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
247 )
Denis Vlasenko49622d72007-03-10 16:58:49 +0000248#define chcon_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000249 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000250 USE_FEATURE_CHCON_LONG_OPTIONS( \
251 "\n -v,--verbose Verbose" \
252 "\n -c,--changes Report changes made" \
253 "\n -h,--no-dereference Affect symlinks instead of their targets" \
254 "\n -f,--silent,--quiet Suppress most error messages" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000255 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000256 "\n -u,--user=USER Set user USER in the target security context" \
257 "\n -r,--role=ROLE Set role ROLE in the target security context" \
258 "\n -t,--type=TYPE Set type TYPE in the target security context" \
259 "\n -l,--range=RANGE Set range RANGE in the target security context" \
260 "\n -R,--recursive Recurse subdirectories" \
261 ) \
262 SKIP_FEATURE_CHCON_LONG_OPTIONS( \
263 "\n -v Verbose" \
264 "\n -c Report changes made" \
265 "\n -h Affect symlinks instead of their targets" \
266 "\n -f Suppress most error messages" \
267 "\n -u USER Set user USER in the target security context" \
268 "\n -r ROLE Set role ROLE in the target security context" \
269 "\n -t TYPE Set type TYPE in the target security context" \
270 "\n -l RNG Set range RNE in the target security context" \
271 "\n -R Recurse subdirectories" \
272 )
273
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000274
Eric Andersen7e9276b2001-02-22 01:15:47 +0000275#define chmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000276 "[-R"USE_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000277#define chmod_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000278 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000279 "symbols +-= and one or more of the letters rwxst" \
280 "\n\nOptions:" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000281 "\n -R Recurse directories" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000282 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000283 "\n -c List changed files" \
284 "\n -v List all files" \
285 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000286 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000287#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000288 "$ ls -l /tmp/foo\n" \
289 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
290 "$ chmod u+x /tmp/foo\n" \
291 "$ ls -l /tmp/foo\n" \
292 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
293 "$ chmod 444 /tmp/foo\n" \
294 "$ ls -l /tmp/foo\n" \
295 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000296
Denis Vlasenko081ef792007-03-17 16:38:21 +0000297#define chgrp_trivial_usage \
298 "[-RhLHP"USE_DESKTOP("cvf")"]... GROUP FILE..."
299#define chgrp_full_usage \
300 "Change the group membership of each FILE to GROUP" \
301 "\n\nOptions:" \
302 "\n -R Recurse directories" \
303 "\n -h Affect symlinks instead of symlink targets" \
304 "\n -L Traverse all symlinks to directories" \
305 "\n -H Traverse symlinks on command line only" \
306 "\n -P Do not traverse symlinks (default)" \
307 USE_DESKTOP( \
308 "\n -c List changed files" \
309 "\n -v Verbose" \
310 "\n -f Hide errors" \
311 )
312#define chgrp_example_usage \
313 "$ ls -l /tmp/foo\n" \
314 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
315 "$ chgrp root /tmp/foo\n" \
316 "$ ls -l /tmp/foo\n" \
317 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
318
Eric Andersen7e9276b2001-02-22 01:15:47 +0000319#define chown_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000320 "[-RhLHP"USE_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000321#define chown_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000322 "Change the owner and/or group of each FILE to OWNER and/or GROUP" \
323 "\n\nOptions:" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000324 "\n -R Recurse directories" \
325 "\n -h Affect symlinks instead of symlink targets" \
326 "\n -L Traverse all symlinks to directories" \
327 "\n -H Traverse symlinks on command line only" \
328 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000329 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000330 "\n -c List changed files" \
331 "\n -v List all files" \
332 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000333 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000334#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000335 "$ ls -l /tmp/foo\n" \
336 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
337 "$ chown root /tmp/foo\n" \
338 "$ ls -l /tmp/foo\n" \
339 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
340 "$ chown root.root /tmp/foo\n" \
341 "ls -l /tmp/foo\n" \
342 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000343
Denis Vlasenkofe544582006-10-03 15:57:40 +0000344#define chpst_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000345 "[-vP012] [-u user[:group]] [-U user[:group]] [-e dir] " \
346 "[-/ dir] [-n nice] [-m bytes] [-d bytes] [-o files] " \
347 "[-p processes] [-f bytes] [-c bytes] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000348#define chpst_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000349 "Change the process state and run specified program" \
350 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000351 " -u user[:grp] Set uid and gid\n" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +0000352 " -U user[:grp] Set environment variables UID and GID\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000353 " -e dir Set environment variables as specified by files\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000354 " in the directory: file=1st_line_of_file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000355 " -/ dir Chroot to dir\n" \
356 " -n inc Add inc to nice value\n" \
357 " -m bytes Limit data segment, stack segment, locked physical pages,\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000358 " and total of all segment per process to bytes bytes each\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000359 " -d bytes Limit data segment\n" \
360 " -o n Limit the number of open file descriptors per process to n\n" \
361 " -p n Limit number of processes per uid to n\n" \
362 " -f bytes Limit output file size to bytes bytes\n" \
363 " -c bytes Limit core file size to bytes bytes\n" \
364 " -v Verbose\n" \
365 " -P Run prog in a new process group\n" \
366 " -0 Close standard input\n" \
367 " -1 Close standard output\n" \
368 " -2 Close standard error"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000369#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000370 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000371#define setuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000372 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
373 "groups, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000374#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000375 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000376#define envuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000377 "Set $UID to account's uid and $GID to account's gid, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000378#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000379 "dir prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000380#define envdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000381 "Set various environment variables as specified by files\n" \
382 "in the directory dir, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000383#define softlimit_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000384 "[-a allbytes] [-c corebytes] [-d databytes] [-f filebytes] " \
385 "[-l lockbytes] [-m membytes] [-o openfiles] [-p processes] " \
386 "[-r residentbytes] [-s stackbytes] [-t cpusecs] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000387#define softlimit_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000388 "Set soft resource limits, then run prog" \
389 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000390 " -m n Same as -d n -s n -l n -a n\n" \
391 " -d n Limit the data segment per process to n bytes\n" \
392 " -s n Limit the stack segment per process to n bytes\n" \
393 " -l n Limit the locked physical pages per process to n bytes\n" \
394 " -a n Limit the total of all segments per process to n bytes\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000395 " -o n Limit the number of open file descriptors per process to n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000396 " -p n Limit the number of processes per uid to n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000397 "Options controlling file sizes:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000398 " -f n Limit output file sizes to n bytes\n" \
399 " -c n Limit core file sizes to n bytes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000400 "Efficiency opts:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000401 " -r n Limit the resident set size to n bytes. This limit is not\n" \
402 " enforced unless physical memory is full\n" \
403 " -t n Limit the CPU time to n seconds. This limit is not enforced\n" \
404 " except that the process receives a SIGXCPU signal after n seconds\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000405 "\n" \
406 "Some options may have no effect on some operating systems\n" \
407 "n may be =, indicating that soft limit should be set equal to hard limit"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000408
Eric Andersen7e9276b2001-02-22 01:15:47 +0000409#define chroot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000410 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000411#define chroot_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000412 "Run COMMAND with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000413#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000414 "$ ls -l /bin/ls\n" \
415 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
416 "# mount /dev/hdc1 /mnt -t minix\n" \
417 "# chroot /mnt\n" \
418 "# ls -l /bin/ls\n" \
419 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000420
Eric Andersen7e9276b2001-02-22 01:15:47 +0000421#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000422 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000423#define chvt_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000424 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000425
Rob Landley856489b2006-04-18 20:57:28 +0000426#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000427 "FILES..."
Rob Landley856489b2006-04-18 20:57:28 +0000428#define cksum_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000429 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000430
Eric Andersen7e9276b2001-02-22 01:15:47 +0000431#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000432 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000433#define clear_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000434 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000435
Eric Andersen7e9276b2001-02-22 01:15:47 +0000436#define cmp_trivial_usage \
Denis Vlasenko9a1fa8c2007-03-21 22:30:14 +0000437 "[-l] [-s] FILE1 [FILE2" USE_DESKTOP(" [SKIP1 [SKIP2]") "]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000438#define cmp_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000439 "Compares FILE1 vs stdin if FILE2 is not specified" \
440 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000441 " -l Write the byte numbers (decimal) and values (octal)\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000442 " for all differing bytes\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +0000443 " -s Quiet"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000444
Rob Landley2acfd7b2005-05-11 23:12:49 +0000445#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000446 "[-123] FILE1 FILE2"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000447#define comm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000448 "Compare FILE1 to FILE2, or to stdin if - is specified" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000449 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000450 " -1 Suppress lines unique to FILE1\n" \
451 " -2 Suppress lines unique to FILE2\n" \
452 " -3 Suppress lines common to both files"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000453
Paul Fox79c142d2005-08-01 16:04:40 +0000454#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000455 ""
Paul Fox79c142d2005-08-01 16:04:40 +0000456#define bbconfig_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000457 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000458
Rob Landley69674942006-09-11 00:34:01 +0000459#define bbsh_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000460 "[FILE]...\n" \
461 "or: bbsh -c command [args]..."
Rob Landley69674942006-09-11 00:34:01 +0000462#define bbsh_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000463 "The bbsh shell (command interpreter)"
Rob Landley69674942006-09-11 00:34:01 +0000464
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000465#define chrt_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000466 "[OPTION]... [prio] [pid | command [arg]...]"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000467#define chrt_full_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000468 "manipulate real-time attributes of a process" \
469 "\n\nOptions:\n" \
470 " -p operate on pid\n" \
471 " -r set scheduling policy to SCHED_RR\n" \
472 " -f set scheduling policy to SCHED_FIFO\n" \
473 " -o set scheduling policy to SCHED_OTHER\n" \
474 " -m show min and max priorities"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000475
476#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000477 "$ chrt -r 4 sleep 900; x=$!\n" \
478 "$ chrt -f -p 3 $x\n" \
479 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000480
Eric Andersen7e9276b2001-02-22 01:15:47 +0000481#define cp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000482 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000483#define cp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000484 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000485 "\n\nOptions:" \
486 "\n -a Same as -dpR" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000487 USE_SELINUX( \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000488 "\n -c Preserves security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000489 ) \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000490 "\n -d,-P Preserve links" \
491 "\n -H,-L Dereference all symlinks (default)" \
492 "\n -p Preserve file attributes if possible" \
493 "\n -f Force overwrite" \
494 "\n -i Prompt before overwrite" \
495 "\n -R,-r Recurse directories" \
496 "\n -l,-s Create (sym)links"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000497
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000498#define cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000499 "-[dimtuv][F cpiofile]"
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000500#define cpio_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000501 "Extract or list files from a cpio archive\n" \
502 "Main operation mode:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000503 " d Make leading directories\n" \
504 " i Extract\n" \
505 " m Preserve mtime\n" \
506 " t List\n" \
507 " v Verbose\n" \
508 " u Unconditional overwrite\n" \
509 " F Input from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000510
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000511#define crond_trivial_usage \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000512 "-fbS -l N " USE_DEBUG_CROND_OPTION("-d N ") "-L LOGFILE -c DIR"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000513#define crond_full_usage \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000514 " -f Foreground\n" \
515 " -b Background (default)\n" \
Denis Vlasenko88ce2742007-10-09 18:08:04 +0000516 " -S Log to syslog (default)\n" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000517 " -l Set log level. 0 is the most verbose, default 8\n" \
518 USE_DEBUG_CROND_OPTION( \
519 " -d Set log level, log to stderr\n" \
520 ) \
521 " -L Log to file\n" \
522 " -c Working dir"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000523
524#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000525 "[-c DIR] [-u USER] [-ler]|[FILE]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000526#define crontab_full_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000527 " -c Crontab directory" \
528 "\n -u User" \
529 "\n -l List crontab" \
530 "\n -e Edit crontab" \
531 "\n -r Delete crontab" \
532 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000533
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000534#define cryptpw_trivial_usage \
535 "[-a des|md5] [string]"
536#define cryptpw_full_usage \
537 "Outputs crypted string.\n" \
538 "If string isn't supplied on cmdline, reads it from stdin.\n" \
539 "\nOptions:" \
540 "\n -a Algorithm to use (default: md5)"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000541
Eric Andersen7e9276b2001-02-22 01:15:47 +0000542#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000543 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000544#define cut_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000545 "Print selected fields from each input FILE to standard output" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000546 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000547 " -b LIST Output only bytes from LIST\n" \
548 " -c LIST Output only characters from LIST\n" \
549 " -d CHAR Use CHAR instead of tab as the field delimiter\n" \
550 " -s Output only the lines containing delimiter\n" \
551 " -f N Print only these fields\n" \
552 " -n Ignored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000553#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000554 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
555 "Hello\n" \
556 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
557 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000558
Eric Andersen7e9276b2001-02-22 01:15:47 +0000559#define date_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000560 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000561#define date_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000562 "Display current time in the given FORMAT, or set system date" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000563 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000564 " -R Outputs RFC-822 compliant date string\n" \
565 " -d STRING Displays time described by STRING, not 'now'\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000566 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000567 " -I[TIMESPEC] Outputs an ISO-8601 compliant date/time string\n" \
568 " TIMESPEC='date' (or missing) for date only,\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000569 " 'hours', 'minutes', or 'seconds' for date and\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000570 " time to the indicated precision\n" \
571 " -D hint Use 'hint' as date format, via strptime()\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000572 ) \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000573 " -s STRING Sets time described by STRING\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000574 " -r FILE Displays the last modification time of FILE\n" \
575 " -u Prints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000576#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000577 "$ date\n" \
578 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000579
Eric Andersen7e9276b2001-02-22 01:15:47 +0000580#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000581 "expression..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000582#define dc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000583 "This is a Tiny RPN calculator that understands the\n" \
584 "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \
585 "**, exp, and, or, not, eor.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000586 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16." \
587 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000588 "p - Prints the value on the top of the stack, without altering the stack\n" \
589 "f - Prints the entire contents of the stack without altering anything\n" \
590 "o - Pops the value off the top of the stack and uses it to set the output radix\n" \
591 " Only 10 and 16 are supported"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000592#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000593 "$ dc 2 2 + p\n" \
594 "4\n" \
595 "$ dc 8 8 \\* 2 2 + / p\n" \
596 "16\n" \
597 "$ dc 0 1 and p\n" \
598 "0\n" \
599 "$ dc 0 1 or p\n" \
600 "1\n" \
601 "$ echo 72 9 div 8 mul p | dc\n" \
602 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000603
Eric Andersen7e9276b2001-02-22 01:15:47 +0000604#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000605 "[if=FILE] [of=FILE] " USE_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000606 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync]")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000607#define dd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000608 "Copy a file with converting and formatting" \
609 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000610 " if=FILE Read from FILE instead of stdin\n" \
611 " of=FILE Write to FILE instead of stdout\n" \
612 " bs=N Read and write N bytes at a time\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000613 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000614 " ibs=N Read N bytes at a time\n") \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000615 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000616 " obs=N Write N bytes at a time\n") \
617 " count=N Copy only N input blocks\n" \
618 " skip=N Skip N input blocks\n" \
619 " seek=N Skip N output blocks\n" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000620 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000621 " conv=notrunc Don't truncate output file\n" \
622 " conv=noerror Continue after read errors\n" \
623 " conv=sync Pad blocks with zeros\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000624 "\n" \
625 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
626 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000627#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000628 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
629 "4+0 records in\n" \
630 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000631
Eric Andersen7e9276b2001-02-22 01:15:47 +0000632#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000633 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000634#define deallocvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000635 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000636
Eric Andersenf349e972001-08-21 16:18:59 +0000637#define delgroup_trivial_usage \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000638 USE_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Eric Andersenf349e972001-08-21 16:18:59 +0000639#define delgroup_full_usage \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000640 "Delete group GROUP from the system" \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000641 USE_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000642
643#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000644 "USER"
Eric Andersenf349e972001-08-21 16:18:59 +0000645#define deluser_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000646 "Delete user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000647
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000648#define devfsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000649 "mntpnt [-v]" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000650 USE_DEVFSD_FG_NP("[-fg][-np]")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000651#define devfsd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000652 "Manage devfs permissions and old device name symlinks" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000653 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000654 "\n mntpnt The mount point where devfs is mounted" \
655 "\n -v Print the protocol version numbers for devfsd" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000656 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000657 USE_DEVFSD_FG_NP( \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000658 "\n -fg Run in foreground" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000659 "\n -np Exit after parsing the configuration file" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000660 "\n and processing synthetic REGISTER events," \
661 "\n do not poll for events")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000662
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000663/* -k is accepted but ignored for !HUMAN_READABLE,
664 * but we won't mention this (unimportant) */
665#if ENABLE_FEATURE_HUMAN_READABLE || ENABLE_FEATURE_DF_INODE
666#define DF_HAS_OPTIONS(x) x
667#else
668#define DF_HAS_OPTIONS(x)
669#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000670#define df_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000671 DF_HAS_OPTIONS("[-") \
672 USE_FEATURE_HUMAN_READABLE("hmk") USE_FEATURE_DF_INODE("i") \
673 DF_HAS_OPTIONS("] ") "[FILESYSTEM...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000674#define df_full_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000675 "Print filesystem usage statistics" \
676 DF_HAS_OPTIONS("\n\nOptions:") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000677 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko08294db2007-08-13 12:27:49 +0000678 "\n -h Human readable (e.g. 1K 243M 2G)" \
679 "\n -m 1024*1024 blocks" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000680 "\n -k 1024 blocks" \
681 ) \
682 USE_FEATURE_DF_INODE( \
683 "\n -i Inodes" \
684 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000685#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000686 "$ df\n" \
687 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
688 "/dev/sda3 8690864 8553540 137324 98% /\n" \
689 "/dev/sda1 64216 36364 27852 57% /boot\n" \
690 "$ df /dev/sda3\n" \
691 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
692 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000693
Denis Vlasenko736230e2006-11-20 19:40:36 +0000694#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000695 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000696#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000697 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000698
699#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000700 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000701#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000702 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000703
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000704#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000705 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000706#define diff_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000707 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000708 "This diff implementation only supports unified diffs." \
709 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000710 " -a Treat all files as text\n" \
711 " -b Ignore changes in the amount of whitespace\n" \
712 " -d Try hard to find a smaller set of changes\n" \
713 " -i Ignore case differences\n" \
714 " -L Use LABEL instead of the filename in the unified header\n" \
715 " -N Treat absent files as empty\n" \
716 " -q Output only whether files differ\n" \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +0000717 " -r Recursively compare subdirectories\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000718 " -S Start with FILE when comparing directories\n" \
719 " -T Make tabs line up by prefixing a tab when necessary\n" \
720 " -s Report when two files are the same\n" \
721 " -t Expand tabs to spaces in output\n" \
722 " -U Output LINES lines of context\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000723 " -w Ignore all whitespace"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000724
Eric Andersen7e9276b2001-02-22 01:15:47 +0000725#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000726 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000727#define dirname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000728 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000729#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000730 "$ dirname /tmp/foo\n" \
731 "/tmp\n" \
732 "$ dirname /tmp/foo/\n" \
733 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000734
Eric Andersen7e9276b2001-02-22 01:15:47 +0000735#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000736 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000737#define dmesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000738 "Print or control the kernel ring buffer" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000739 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000740 " -c Clear ring buffer after printing\n" \
741 " -n LEVEL Set console logging level\n" \
742 " -s SIZE Buffer size"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000743
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000744#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000745 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000746#define dnsd_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000747 "Small static DNS server daemon" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000748 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000749 " -c Config filename\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000750 " -t TTL in seconds\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000751 " -p Listening port\n" \
Denis Vlasenkod3bac032007-03-24 12:13:04 +0000752 " -i Listening ip (default all)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000753 " -d Daemonize"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000754
Eric Andersen7e9276b2001-02-22 01:15:47 +0000755#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000756 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000757#define dos2unix_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000758 "Convert FILE from dos to unix format.\n" \
759 "When no file is given, use stdin/stdout.\n" \
760 "\nOptions:\n" \
761 "\n -u dos2unix" \
762 "\n -d unix2dos"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000763
Eric Andersen7e9276b2001-02-22 01:15:47 +0000764#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000765 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000766#define dpkg_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000767 "Install, remove and manage Debian packages" \
768 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000769 " -i Install the package\n" \
770 " -l List of installed packages\n" \
771 " -C Configure an unpackaged package\n" \
772 " -F depends Ignore dependency problems\n" \
773 " -P Purge all files of a package\n" \
774 " -r Remove all but the configuration files for a package\n" \
775 " -u Unpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000776
Eric Andersen7e9276b2001-02-22 01:15:47 +0000777#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000778 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000779#define dpkg_deb_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000780 "Perform actions on Debian packages (.debs)" \
781 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000782 " -c List contents of filesystem tree\n" \
783 " -e Extract control files to [argument] directory\n" \
784 " -f Display control field name starting with [argument]\n" \
785 " -x Extract packages filesystem tree to directory\n" \
786 " -X Verbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000787#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000788 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000789
Eric Andersen7e9276b2001-02-22 01:15:47 +0000790#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000791 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000792#define du_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000793 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000794 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000795 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
796 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000797 " bytes." \
798 "\n\nOptions:\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000799 " -a Show file sizes too\n" \
800 " -H Follow symlinks on command line\n" \
801 " -L Follow all symlinks\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000802 " -d N Limit output to directories (and files with -a) of depth < N\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000803 " -c Show grand total\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000804 " -l Count sizes many times if hard linked\n" \
805 " -s Display only a total for each argument\n" \
806 " -x Skip directories on different filesystems\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000807 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000808 " -h Sizes in human readable format (e.g., 1K 243M 2G )\n" \
809 " -m Sizes in megabytes\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000810 ) \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000811 " -k Sizes in kilobytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000812 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000813#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000814 "$ du\n" \
815 "16 ./CVS\n" \
816 "12 ./kernel-patches/CVS\n" \
817 "80 ./kernel-patches\n" \
818 "12 ./tests/CVS\n" \
819 "36 ./tests\n" \
820 "12 ./scripts/CVS\n" \
821 "16 ./scripts\n" \
822 "12 ./docs/CVS\n" \
823 "104 ./docs\n" \
824 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000825
Eric Andersen7e9276b2001-02-22 01:15:47 +0000826#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000827 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000828#define dumpkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000829 "Print out a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000830#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000831 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000832
Russ Dill61fb4892002-10-14 21:41:28 +0000833#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000834 "[-r|-a] [-f LEASEFILE]"
Russ Dill61fb4892002-10-14 21:41:28 +0000835#define dumpleases_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000836 "Display DHCP leases granted by udhcpd" \
837 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000838 USE_GETOPT_LONG( \
839 " -f,--file=FILE Leases file to load\n" \
840 " -r,--remaining Interpret lease times as time remaining\n" \
841 " -a,--absolute Interpret lease times as expire time" \
842 ) \
843 SKIP_GETOPT_LONG( \
844 " -f FILE Leases file to load\n" \
845 " -r Interpret lease times as time remaining\n" \
846 " -a Interpret lease times as expire time" \
847 )
Russ Dill61fb4892002-10-14 21:41:28 +0000848
Mike Frysinger51a43b42005-09-24 07:11:16 +0000849#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000850 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
851 "[-I inode_buffer_blocks] [-P process_inode_size] " \
852 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
853 "[-E extended-options] device"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000854#define e2fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000855 "Check ext2/ext3 file system" \
856 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000857 " -p Automatic repair (no questions)\n" \
858 " -n Make no changes to the filesystem\n" \
859 " -y Assume 'yes' to all questions\n" \
860 " -c Check for bad blocks and add them to the badblock list\n" \
861 " -f Force checking even if filesystem is marked clean\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +0000862 " -v Verbose\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000863 " -b superblock Use alternative superblock\n" \
864 " -B blocksize Force blocksize when looking for superblock\n" \
865 " -j journal Set location of the external journal\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000866 " -l file Add to badblocks list\n" \
867 " -L file Set badblocks list"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000868
Eric Andersen7e9276b2001-02-22 01:15:47 +0000869#define echo_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000870 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000871#define echo_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000872 "Print the specified ARGs to stdout" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000873 USE_FEATURE_FANCY_ECHO( \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000874 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000875 " -n Suppress trailing newline\n" \
876 " -e Interpret backslash-escaped characters (i.e., \\t=tab)\n" \
877 " -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000878 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000879#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000880 "$ echo \"Erik is cool\"\n" \
881 "Erik is cool\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000882 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000883 "Erik\n" \
884 "is\n" \
885 "cool\n" \
886 "$ echo \"Erik\\nis\\ncool\"\n" \
887 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000888
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000889#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000890 "[-t] [-T] [DEVICE]"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000891#define eject_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000892 "Eject specified DEVICE (or default /dev/cdrom)" \
893 "\n\nOptions:\n" \
Bernhard Reutner-Fischerafdad652008-02-08 15:04:00 +0000894 USE_FEATURE_EJECT_SCSI( \
895 " -s scsi device\n" \
896 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000897 " -t Close tray\n" \
898 " -T Open/close tray (toggle)"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000899
Rob Landley3b890392006-05-04 20:56:43 +0000900#define ed_trivial_usage ""
901#define ed_full_usage ""
902
Eric Andersen84e229c2001-03-29 22:48:33 +0000903#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000904 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000905#define env_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000906 "Print the current environment or run a program after setting\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000907 "up the specified environment" \
908 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000909 " -, -i Start with an empty environment\n" \
910 " -u Remove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000911
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000912#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000913 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000914#define ether_wake_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000915 "Send a magic packet to wake up sleeping machines.\n" \
916 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000917 "a hostname with a known 'ethers' entry." \
918 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000919 " -b Send wake-up packet to the broadcast address\n" \
920 " -i iface Use interface ifname instead of the default \"eth0\"\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000921 " -p pass Append the four or six byte password PW to the packet"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000922
Denis Vlasenko3952f202007-08-13 14:10:24 +0000923#define expand_trivial_usage \
924 "[-i] [-t NUM] [FILE|-]"
925#define expand_full_usage \
926 "Convert tabs to spaces, writing to standard output." \
927 "\n\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000928 USE_FEATURE_EXPAND_LONG_OPTIONS( \
929 "\n -i,--initial Do not convert tabs after non blanks" \
930 "\n -t,--tabs=N Tabstops every N chars" \
931 ) \
932 SKIP_FEATURE_EXPAND_LONG_OPTIONS( \
933 "\n -i Do not convert tabs after non blanks" \
934 "\n -t Tabstops every N chars" \
935 )
Denis Vlasenko3952f202007-08-13 14:10:24 +0000936
Eric Andersen7e9276b2001-02-22 01:15:47 +0000937#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000938 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000939#define expr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000940 "Print the value of EXPRESSION to standard output.\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000941 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000942 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
943 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
944 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
945 " ARG1 <= ARG2\n" \
946 " ARG1 = ARG2\n" \
947 " ARG1 != ARG2\n" \
948 " ARG1 >= ARG2\n" \
949 " ARG1 > ARG2\n" \
950 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
951 " ARG1 - ARG2\n" \
952 " ARG1 * ARG2\n" \
953 " ARG1 / ARG2\n" \
954 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000955 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
956 " match STRING REGEXP Same as STRING : REGEXP\n" \
957 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
958 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
959 " length STRING Length of STRING\n" \
960 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000961 " it is a keyword like 'match' or an\n" \
962 " operator like '/'\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000963 " (EXPRESSION) Value of EXPRESSION\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000964 "Beware that many operators need to be escaped or quoted for shells.\n" \
965 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000966 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000967 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
968 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000969
Mike Frysingerfa69f112005-04-17 07:24:19 +0000970#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000971 "[-fiw] [-b ADDR] [STRING]"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000972#define fakeidentd_full_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000973 "Provide fake ident (auth) service" \
974 "\n\nOptions:" \
975 "\n -f Run in foreground" \
976 "\n -i Inetd mode" \
977 "\n -w Inetd 'wait' mode" \
978 "\n -b ADDR Bind to specified address" \
979 "\n STRING Ident answer string (default is 'nobody')"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000980
Eric Andersen7e9276b2001-02-22 01:15:47 +0000981#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000982 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000983#define false_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000984 "Return an exit code of FALSE (1)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000985#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000986 "$ false\n" \
987 "$ echo $?\n" \
988 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000989
990#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000991 "[options] [mode]"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000992#define fbset_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000993 "Show and modify frame buffer settings"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000994#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000995 "$ fbset\n" \
996 "mode \"1024x768-76\"\n" \
997 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
998 " geometry 1024 768 1024 768 16\n" \
999 " timings 12714 128 32 16 4 128 4\n" \
1000 " accel false\n" \
1001 " rgba 5/11,6/5,5/0,0/0\n" \
1002 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001003
Eric Andersen7e9276b2001-02-22 01:15:47 +00001004#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001005 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001006#define fdflush_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001007 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001008
Eric Andersen01c3d402003-07-05 07:51:31 +00001009#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001010 "[-n] DEVICE"
Eric Andersen01c3d402003-07-05 07:51:31 +00001011#define fdformat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001012 "Format floppy disk" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001013 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001014 " -n Don't verify after format"
Eric Andersen01c3d402003-07-05 07:51:31 +00001015
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001016/* Looks like someone forgot to add this to config system */
1017#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1018# define ENABLE_FEATURE_FDISK_BLKSIZE 0
1019# define USE_FEATURE_FDISK_BLKSIZE(a)
1020#endif
1021
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001022#define fdisk_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001023 "[-ul" USE_FEATURE_FDISK_BLKSIZE("s") "] " \
1024 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001025#define fdisk_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001026 "Change partition table\n" \
1027 "\nOptions:\n" \
1028 "\n -u Start and End are in sectors (instead of cylinders)" \
1029 "\n -l Show partition table for each DISK, then exit" \
1030 USE_FEATURE_FDISK_BLKSIZE( \
1031 "\n -s Show partition sizes in kb for each DISK, then exit" \
1032 ) \
1033 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1034 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
1035 "\n -H HEADS\n" \
1036 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001037
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001038#define fetchmail_trivial_usage \
Denis Vlasenko17db1a92008-02-26 21:13:17 +00001039 "[-w timeout] [-U user] -P password [-X] [-t] [-z] server[:port] maildir [prog]"
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001040#define fetchmail_full_usage \
1041 "Fetch content of remote mailbox to local Maildir." \
1042 "\n\nOptions:\n" \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001043 " -w timeout Set timeout on network operations\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001044 " -U username Authenticate with specified username/password\n" \
1045 " -P password\n" \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001046 " -X Use openssl connection helper for secured servers\n" \
1047 " -t Get only headers\n" \
Denis Vlasenko8195d202008-02-27 09:39:04 +00001048 " -z Delete messages on server\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001049 " prog Run prog <message_file> on message delivery"
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001050
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001051#define findfs_trivial_usage \
1052 "LABEL=label or UUID=uuid"
1053#define findfs_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001054 "Find a filesystem device based on a label or UUID."
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001055#define findfs_example_usage \
1056 "$ findfs LABEL=MyDevice"
1057
Eric Andersen7e9276b2001-02-22 01:15:47 +00001058#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001059 "[PATH...] [EXPRESSION]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001060#define find_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001061 "Search for files. The default PATH is the current directory,\n" \
1062 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001063 "\nEXPRESSION may consist of:" \
1064 "\n -follow Dereference symlinks" \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001065 USE_FEATURE_FIND_XDEV( \
1066 "\n -xdev Don't descend directories on other filesystems") \
1067 USE_FEATURE_FIND_MAXDEPTH( \
1068 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1069 "\n tests/actions to command line arguments only") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001070 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001071 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001072 USE_FEATURE_FIND_PATH( \
1073 "\n -path PATTERN Path matches PATTERN") \
1074 USE_FEATURE_FIND_REGEX( \
1075 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001076 USE_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001077 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001078 USE_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001079 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001080 "\n or exactly (NNN)") \
1081 USE_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001082 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001083 "\n or exactly (N) days") \
1084 USE_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001085 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001086 "\n or exactly (N) minutes") \
1087 USE_FEATURE_FIND_NEWER( \
1088 "\n -newer FILE Modified time is more recent than FILE's") \
1089 USE_FEATURE_FIND_INUM( \
1090 "\n -inum N File has inode number N") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001091 USE_FEATURE_FIND_USER( \
1092 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
1093 USE_FEATURE_FIND_GROUP( \
1094 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
1095 USE_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001096 "\n -depth Process directory name after traversing it") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001097 USE_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001098 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1099 "\n +/-N: file size is bigger/smaller than N") \
1100 "\n -print Print (default and assumed)" \
1101 USE_FEATURE_FIND_PRINT0( \
1102 "\n -print0 Delimit output with null characters rather than" \
1103 "\n newlines") \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001104 USE_FEATURE_FIND_CONTEXT ( \
1105 "\n -context File has specified security context") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001106 USE_FEATURE_FIND_EXEC( \
1107 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1108 "\n matching files") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001109 USE_FEATURE_FIND_PRUNE( \
1110 "\n -prune Stop traversing current subtree") \
1111 USE_FEATURE_FIND_DELETE( \
1112 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001113 USE_FEATURE_FIND_PAREN( \
1114 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001115
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001116#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001117 "$ find / -name passwd\n" \
1118 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001119
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001120#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001121 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001122#define fold_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001123 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001124 "standard output" \
1125 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001126 " -b Count bytes rather than columns\n" \
1127 " -s Break at spaces\n" \
1128 " -w Use WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001129
Eric Andersen7e9276b2001-02-22 01:15:47 +00001130#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001131 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001132#define free_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001133 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001134#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001135 "$ free\n" \
1136 " total used free shared buffers\n" \
1137 " Mem: 257628 248724 8904 59644 93124\n" \
1138 " Swap: 128516 8404 120112\n" \
1139 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001140
Eric Andersen7e9276b2001-02-22 01:15:47 +00001141#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001142 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001143#define freeramdisk_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001144 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001145#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001146 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001147
Mike Frysinger51a43b42005-09-24 07:11:16 +00001148#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001149 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001150#define fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001151 "Check and repair filesystems" \
1152 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001153 " -A Walk /etc/fstab and check all filesystems\n" \
1154 " -N Don't execute, just show what would be done\n" \
1155 " -P When using -A, check filesystems in parallel\n" \
1156 " -R When using -A, skip the root filesystem\n" \
1157 " -T Don't show title on startup\n" \
Denis Vlasenko0de93752006-12-26 02:51:29 +00001158 " -V Verbose\n" \
1159 " -C n Write status information to specified filedescriptor\n" \
1160 " -t type List of filesystem types to check"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001161
Eric Andersen7e9276b2001-02-22 01:15:47 +00001162#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001163 "[-larvsmf] /dev/name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001164#define fsck_minix_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001165 "Perform a consistency check for MINIX filesystems" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001166 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001167 " -l List all filenames\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001168 " -r Perform interactive repairs\n" \
1169 " -a Perform automatic repairs\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001170 " -v Verbose\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001171 " -s Output super-block information\n" \
1172 " -m Activate MINIX-like \"mode not cleared\" warnings\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001173 " -f Force file system check"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001174
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001175#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001176 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001177#define ftpget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001178 "Retrieve a remote file via FTP" \
1179 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001180 USE_GETOPT_LONG( \
1181 " -c,--continue Continue previous transfer\n" \
1182 " -v,--verbose Verbose\n" \
1183 " -u,--username Username\n" \
1184 " -p,--password Password\n" \
1185 " -P,--port Port number" \
1186 ) \
1187 SKIP_GETOPT_LONG( \
1188 " -c Continue previous transfer\n" \
1189 " -v Verbose\n" \
1190 " -u Username\n" \
1191 " -p Password\n" \
1192 " -P Port number" \
1193 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001194
1195#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001196 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001197#define ftpput_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001198 "Store a local file on a remote machine via FTP" \
1199 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001200 USE_GETOPT_LONG( \
1201 " -v,--verbose Verbose\n" \
1202 " -u,--username Username\n" \
1203 " -p,--password Password\n" \
1204 " -P,--port Port number" \
1205 ) \
1206 SKIP_GETOPT_LONG( \
1207 " -v Verbose\n" \
1208 " -u Username\n" \
1209 " -p Password\n" \
1210 " -P Port number" \
1211 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001212
Rob Landleyaa872762005-10-28 13:05:12 +00001213#define fuser_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001214 "[options] FILE or PORT/PROTO"
Rob Landleyaa872762005-10-28 13:05:12 +00001215#define fuser_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001216 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001217 " -m Show all processes on the same mounted fs\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001218 " -s Don't print or kill anything\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001219 " -4 Search only IPv4 space\n" \
1220 " -6 Search only IPv6 space\n" \
1221 " -k Kill all processes that match\n" \
1222 " -SIGNAL Signal to send (default: TERM)"
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001223
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001224#define getenforce_trivial_usage
1225#define getenforce_full_usage
1226
Eric Andersen7e9276b2001-02-22 01:15:47 +00001227#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001228 "[OPTIONS]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001229#define getopt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001230 "Parse command options\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001231 USE_GETOPT_LONG( \
1232 " -a,--alternative Allow long options starting with single -\n" \
1233 " -l,--longoptions=longopts Long options to be recognized\n" \
1234 " -n,--name=progname The name under which errors are reported\n" \
1235 " -o,--options=optstring Short options to be recognized\n" \
1236 " -q,--quiet Disable error reporting by getopt(3)\n" \
1237 " -Q,--quiet-output No normal output\n" \
1238 " -s,--shell=shell Set shell quoting conventions\n" \
1239 " -T,--test Test for getopt(1) version\n" \
1240 " -u,--unquoted Don't quote the output" \
1241 ) \
1242 SKIP_GETOPT_LONG( \
1243 " -a Allow long options starting with single -\n" \
1244 " -l longopts Long options to be recognized\n" \
1245 " -n progname The name under which errors are reported\n" \
1246 " -o optstring Short options to be recognized\n" \
1247 " -q Disable error reporting by getopt(3)\n" \
1248 " -Q No normal output\n" \
1249 " -s shell Set shell quoting conventions\n" \
1250 " -T Test for getopt(1) version\n" \
1251 " -u Don't quote the output" \
1252 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001253#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001254 "$ cat getopt.test\n" \
1255 "#!/bin/sh\n" \
1256 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1257 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001258 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001259 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001260 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001261 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001262 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1263 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001264 " -c|--c-long)\n" \
1265 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001266 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1267 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1268 " esac;;\n" \
1269 " --) shift; break;;\n" \
1270 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001271 " esac\n" \
1272 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001273
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001274#define getsebool_trivial_usage \
1275 "-a or getsebool boolean..."
1276#define getsebool_full_usage \
1277 " -a Show all SELinux booleans"
1278
Eric Andersenf349e972001-08-21 16:18:59 +00001279#define getty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001280 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +00001281#define getty_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001282 "Open a tty, prompt for a login name, then invoke /bin/login" \
1283 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001284 " -h Enable hardware (RTS/CTS) flow control\n" \
1285 " -i Do not display /etc/issue before running login\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001286 " -L Local line, do not do carrier detect\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001287 " -m Get baud rate from modem's CONNECT status message\n" \
1288 " -w Wait for a CR or LF before sending /etc/issue\n" \
1289 " -n Do not prompt the user for a login name\n" \
1290 " -f issue_file Display issue_file instead of /etc/issue\n" \
1291 " -l login_app Invoke login_app instead of /bin/login\n" \
1292 " -t timeout Terminate after timeout if no username is read\n" \
1293 " -I initstring Sets the init string to send before anything else\n" \
1294 " -H login_host Log login_host into the utmp file as the hostname"
Eric Andersenf349e972001-08-21 16:18:59 +00001295
Eric Andersen7e9276b2001-02-22 01:15:47 +00001296#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001297 "[-HhrilLnqvso" \
1298 USE_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001299 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001300 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1301 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001302 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001303#define grep_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001304 "Search for PATTERN in each FILE or standard input" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001305 "\n\nOptions:" \
1306 "\n -H Prefix output lines with filename where match was found" \
1307 "\n -h Suppress the prefixing filename on output" \
1308 "\n -r Recurse subdirectories" \
1309 "\n -i Ignore case distinctions" \
1310 "\n -l List names of files that match" \
1311 "\n -L List names of files that do not match" \
1312 "\n -n Print line number with output lines" \
Denis Vlasenko79468792007-04-04 11:02:55 +00001313 "\n -q Quiet. Returns 0 if PATTERN was found, 1 otherwise" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001314 "\n -v Select non-matching lines" \
1315 "\n -s Suppress file open/read error messages" \
1316 "\n -c Only print count of matching lines" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001317 "\n -o Show only the part of a line that matches PATTERN" \
Denis Vlasenko4652daa2007-07-15 12:39:08 +00001318 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001319 USE_DESKTOP( \
1320 "\n -w Match whole words only") \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001321 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001322 USE_FEATURE_GREP_EGREP_ALIAS( \
1323 "\n -E PATTERN is an extended regular expression") \
Denis Vlasenko4652daa2007-07-15 12:39:08 +00001324 "\n -e PTRN Pattern to match" \
1325 "\n -f FILE Read pattern from file" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001326 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001327 "\n -A Print NUM lines of trailing context" \
1328 "\n -B Print NUM lines of leading context" \
1329 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001330
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001331#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001332 "$ grep root /etc/passwd\n" \
1333 "root:x:0:0:root:/root:/bin/bash\n" \
1334 "$ grep ^[rR]oo. /etc/passwd\n" \
1335 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001336
Eric Andersen7e9276b2001-02-22 01:15:47 +00001337#define gunzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001338 "[OPTION]... FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001339#define gunzip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001340 "Uncompress FILE (or standard input if FILE is '-')" \
1341 "\n\nOptions:\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001342 " -c Write to standard output\n" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001343 " -f Force\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001344 " -t Test file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001345#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001346 "$ ls -la /tmp/BusyBox*\n" \
1347 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1348 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1349 "$ ls -la /tmp/BusyBox*\n" \
1350 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001351
1352#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001353 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001354#define gzip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001355 "Compress FILE(s) with maximum compression.\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001356 "When FILE is '-' or unspecified, reads standard input. Implies -c." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001357 "\n\nOptions:\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001358 " -c Write to standard output\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001359 " -d Decompress\n" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001360 " -f Force"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001361#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001362 "$ ls -la /tmp/busybox*\n" \
1363 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1364 "$ gzip /tmp/busybox.tar\n" \
1365 "$ ls -la /tmp/busybox*\n" \
1366 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001367
1368#define halt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001369 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001370#define halt_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001371 "Halt the system" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001372 "\n\nOptions:" \
1373 "\n -d Delay interval for halting" \
1374 "\n -n No call to sync()" \
1375 "\n -f Force halt (don't go through init)" \
1376 USE_FEATURE_WTMP( \
1377 "\n -w Only write a wtmp record" \
1378 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001379
Eric Andersen3443bd72003-07-22 07:30:36 +00001380#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001381 "[options] [device] .."
Eric Andersen3443bd72003-07-22 07:30:36 +00001382#define hdparm_full_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001383 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001384 "If no device name is specified try to read from stdin.\n\n") \
1385 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001386 " -a Get/set fs readahead\n" \
1387 " -A Set drive read-lookahead flag (0/1)\n" \
1388 " -b Get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
1389 " -B Set Advanced Power Management setting (1-255)\n" \
1390 " -c Get/set IDE 32-bit IO setting\n" \
1391 " -C Check IDE power mode status\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001392 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001393 " -d Get/set using_dma flag\n") \
1394 " -D Enable/disable drive defect-mgmt\n" \
1395 " -f Flush buffer cache for device on exit\n" \
1396 " -g Display drive geometry\n" \
1397 " -h Display terse usage information\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001398 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001399 " -i Display drive identification\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001400 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001401 " -I Detailed/current information directly from drive\n") \
1402 " -k Get/set keep_settings_over_reset flag (0/1)\n" \
1403 " -K Set drive keep_features_over_reset flag (0/1)\n" \
1404 " -L Set drive doorlock (0/1) (removable harddisks only)\n" \
1405 " -m Get/set multiple sector count\n" \
1406 " -n Get/set ignore-write-errors flag (0/1)\n" \
1407 " -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
1408 " -P Set drive prefetch count\n" \
1409 " -q Change next setting quietly\n" \
1410 " -Q Get/set DMA tagged-queuing depth (if supported)\n" \
1411 " -r Get/set readonly flag (DANGEROUS to set)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001412 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001413 " -R Register an IDE interface (DANGEROUS)\n") \
1414 " -S Set standby (spindown) timeout\n" \
1415 " -t Perform device read timings\n" \
1416 " -T Perform cache read timings\n" \
1417 " -u Get/set unmaskirq flag (0/1)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001418 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001419 " -U Un-register an IDE interface (DANGEROUS)\n") \
1420 " -v Defaults; same as -mcudkrag for IDE drives\n" \
1421 " -V Display program version and exit immediately\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001422 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001423 " -w Perform device reset (DANGEROUS)\n") \
1424 " -W Set drive write-caching flag (0/1) (DANGEROUS)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001425 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001426 " -x Tristate device for hotswap (0/1) (DANGEROUS)\n") \
1427 " -X Set IDE xfer mode (DANGEROUS)\n" \
1428 " -y Put IDE drive in standby mode\n" \
1429 " -Y Put IDE drive to sleep\n" \
1430 " -Z Disable Seagate auto-powersaving mode\n" \
1431 " -z Re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +00001432
Eric Andersen7e9276b2001-02-22 01:15:47 +00001433#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001434 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001435#define head_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001436 "Print first 10 lines of each FILE to standard output.\n" \
1437 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001438 "file name. With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001439 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001440 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001441 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001442 "\n -c NUM Output the first NUM bytes" \
1443 "\n -q Never output headers giving file names" \
1444 "\n -v Always output headers giving file names")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001445#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001446 "$ head -n 2 /etc/passwd\n" \
1447 "root:x:0:0:root:/root:/bin/bash\n" \
1448 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001449
Glenn L McGrath60281112001-11-02 11:39:46 +00001450#define hexdump_trivial_usage \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001451 "[-bcCdefnosvx" USE_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Glenn L McGrath60281112001-11-02 11:39:46 +00001452#define hexdump_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001453 "Display file(s) or standard input in a user specified format" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001454 "\n\nOptions:" \
1455 "\n -b One-byte octal display" \
1456 "\n -c One-byte character display" \
1457 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1458 "\n -d Two-byte decimal display" \
1459 "\n -e FORMAT STRING" \
1460 "\n -f FORMAT FILE" \
1461 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1462 "\n -o Two-byte octal display" \
1463 "\n -s OFFSET Skip OFFSET bytes" \
1464 "\n -v Display all input data" \
1465 "\n -x Two-byte hexadecimal display" \
1466 USE_FEATURE_HEXDUMP_REVERSE( \
1467 "\n -R Reverse of 'hexdump -Cv'") \
1468
1469#define hd_trivial_usage \
1470 "FILE..."
1471#define hd_full_usage \
1472 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001473
Eric Andersen7e9276b2001-02-22 01:15:47 +00001474#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001475 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001476#define hostid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001477 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001478
1479#define hostname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001480 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001481#define hostname_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001482 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001483 "(or FILE with the -F parameter), the host name will be set." \
1484 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001485 " -s Short\n" \
1486 " -i Addresses for the hostname\n" \
1487 " -d DNS domain name\n" \
1488 " -f Fully qualified domain name\n" \
1489 " -F FILE Use the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001490#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001491 "$ hostname\n" \
1492 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001493
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001494#define httpd_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001495 "[-c conffile]" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001496 " [-p [ip:]port]" \
1497 " [-i] [-f] [-v[v]]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001498 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001499 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001500 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001501 " [-h home]" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001502 " [-d/-e string]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001503#define httpd_full_usage \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001504 "Listen for incoming HTTP requests" \
1505 "\n\nOptions:" \
1506 "\n -c FILE Configuration file (default httpd.conf)" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001507 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001508 "\n -i Inetd mode" \
1509 "\n -f Do not daemonize" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001510 "\n -v[v] Verbose" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001511 USE_FEATURE_HTTPD_SETUID( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001512 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001513 USE_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001514 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001515 USE_FEATURE_HTTPD_AUTH_MD5( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001516 "\n -m PASS Crypt PASS with md5 algorithm") \
1517 "\n -h HOME Home directory (default .)" \
1518 "\n -e STRING HTML encode STRING" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001519 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001520
Robert Griebl1cd04452002-07-21 16:50:49 +00001521#define hwclock_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001522 USE_GETOPT_LONG( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001523 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1524 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001525 " [-f FILE]" \
1526 ) \
1527 SKIP_GETOPT_LONG( \
1528 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1529 )
Robert Griebl1cd04452002-07-21 16:50:49 +00001530#define hwclock_full_usage \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001531 "Query and set a hardware clock (RTC)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001532 "\n\nOptions:\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001533 " -r Show time from hardware clock\n" \
1534 " -s Set system time from hardware clock\n" \
1535 " -w Set hardware clock to system time\n" \
1536 " -u Hardware clock is in UTC\n" \
1537 " -l Hardware clock is in local time\n" \
1538 " -f FILE Use specified device (e.g. /dev/rtc2)"
Robert Griebl1cd04452002-07-21 16:50:49 +00001539
Eric Andersen7e9276b2001-02-22 01:15:47 +00001540#define id_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001541 "[OPTIONS]... [USERNAME]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001542#define id_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001543 "Print information for USERNAME or the current user" \
1544 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001545 USE_SELINUX( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001546 " -Z Prints only the security context\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001547 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001548 " -g Prints only the group ID\n" \
1549 " -u Prints only the user ID\n" \
1550 " -n Print a name instead of a number\n" \
1551 " -r Prints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001552#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001553 "$ id\n" \
1554 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001555
Eric Andersen7e9276b2001-02-22 01:15:47 +00001556#define ifconfig_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001557 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001558#define ifconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001559 "Configure a network interface" \
1560 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001561 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001562 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001563 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001564 " [del ADDRESS[/PREFIXLEN]]\n") \
1565 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1566 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001567 USE_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001568 " [outfill NN] [keepalive NN]\n") \
1569 " " USE_FEATURE_IFCONFIG_HW("[hw ether ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001570 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001571 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001572 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001573 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001574 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001575
Denis Vlasenko06aed432008-02-26 18:25:24 +00001576#define ifenslave_trivial_usage \
1577 "[-cdf] master-iface <slave-iface...>"
1578#define ifenslave_full_usage \
1579 "Configure network interfaces for parallel routing\n\n" \
1580 "Options:" \
1581 "\n -c, --change-active Change active slave" \
1582 "\n -d, --detach Remove slave interface from bonding device" \
1583 "\n -f, --force Force, even if interface is not Ethernet" \
1584/* "\n -r, --receive-slave Create a receive-only slave" */
1585#define ifenslave_example_usage \
1586 "To create a bond device, simply follow these three steps :\n" \
1587 "- ensure that the required drivers are properly loaded :\n" \
1588 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
1589 "- assign an IP address to the bond device :\n" \
1590 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
1591 "- attach all the interfaces you need to the bond device :\n" \
1592 " # ifenslave bond0 eth0 eth1 eth2\n" \
1593 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1594 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
1595 " To detach a dead interface without setting the bond device down :\n" \
1596 " # ifenslave -d bond0 eth1\n\n" \
1597 " To set the bond device down and automatically release all the slaves :\n" \
1598 " # ifconfig bond0 down\n\n" \
1599 " To change active slave :\n" \
1600 " # ifenslave -c bond0 eth0\n"
1601
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001602#define ifup_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001603 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001604#define ifup_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001605 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001606 " -a De/configure all interfaces automatically\n" \
1607 " -i FILE Use FILE for interface definitions\n" \
1608 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001609 " (note: doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001610 " -v Print out what would happen before doing it\n" \
1611 " -m Don't run any mappings\n" \
1612 " -f Force de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001613
1614#define ifdown_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001615 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001616#define ifdown_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001617 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001618 " -a De/configure all interfaces automatically\n" \
1619 " -i FILE Use FILE for interface definitions\n" \
1620 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001621 " (note: doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001622 " -v Print out what would happen before doing it\n" \
1623 " -m Don't run any mappings\n" \
1624 " -f Force de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001625
Glenn L McGrath06e95652003-02-09 06:51:14 +00001626#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001627 "[-fe] [-q N] [-R N] [CONFFILE]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001628#define inetd_full_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001629 "Listen for network connections and launch programs\n" \
1630 "\nOptions:" \
1631 "\n -f Run in foreground" \
1632 "\n -e Log to stderr" \
1633 "\n -q N Socket listen queue (default: 128)" \
1634 "\n -R N Pause services after N connects/min" \
1635 "\n (default: 0 - disabled)"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001636
Eric Andersen7e9276b2001-02-22 01:15:47 +00001637#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001638 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001639#define init_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001640 "Init is the parent of all processes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001641#define init_notes_usage \
1642"This version of init is designed to be run only by the kernel.\n" \
1643"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001644"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001645"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001646"runlevels, use sysvinit.\n" \
1647"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001648"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001649"it has the following default behavior:\n" \
1650"\n" \
1651" ::sysinit:/etc/init.d/rcS\n" \
1652" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001653" ::ctrlaltdel:/sbin/reboot\n" \
1654" ::shutdown:/sbin/swapoff -a\n" \
1655" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001656" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001657"\n" \
1658"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1659"\n" \
1660" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001661" tty3::askfirst:/bin/sh\n" \
1662" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001663"\n" \
1664"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1665"\n" \
1666" <id>:<runlevels>:<action>:<process>\n" \
1667"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001668" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001669"\n" \
1670" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1671" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001672" the specified process to run on. The contents of this field are\n" \
1673" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1674" be unique, although if it isn't you may have strange results. If this\n" \
1675" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001676" note that if BusyBox detects that a serial console is in use, then only\n" \
1677" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001678" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001679" stinkin' utmp.\n" \
1680"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001681" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001682"\n" \
1683" The runlevels field is completely ignored.\n" \
1684"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001685" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001686"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001687" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001688" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001689"\n" \
1690" The available actions can be classified into two groups: actions\n" \
1691" that are run only once, and actions that are re-run when the specified\n" \
1692" process exits.\n" \
1693"\n" \
1694" Run only-once actions:\n" \
1695"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001696" 'sysinit' is the first item run on boot. init waits until all\n" \
1697" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001698" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001699" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001700" the specified task completes. 'once' actions are asynchronous,\n" \
1701" therefore, init does not wait for them to complete. 'restart' is\n" \
1702" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001703" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001704" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001705" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001706" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001707" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001708" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001709" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001710" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001711"\n" \
1712" Run repeatedly actions:\n" \
1713"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001714" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001715" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001716" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1717" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001718" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001719" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001720" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001721" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001722"\n" \
1723" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001724" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001725" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001726"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001727" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001728"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001729" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001730"\n" \
1731"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001732"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001733" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001734" #\n" \
1735" ::sysinit:/etc/init.d/rcS\n" \
1736" \n" \
1737" # /bin/sh invocations on selected ttys\n" \
1738" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001739" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001740" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001741" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001742" tty2::askfirst:-/bin/sh\n" \
1743" tty3::askfirst:-/bin/sh\n" \
1744" tty4::askfirst:-/bin/sh\n" \
1745" \n" \
1746" # /sbin/getty invocations for selected ttys\n" \
1747" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001748" tty4::respawn:/sbin/getty 38400 tty4\n" \
1749" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001750" \n" \
1751" \n" \
1752" # Example of how to put a getty on a serial line (for a terminal)\n" \
1753" #\n" \
1754" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1755" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1756" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001757" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001758" #::respawn:/sbin/getty 57600 ttyS2\n" \
1759" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001760" # Stuff to do when restarting the init process\n" \
1761" ::restart:/sbin/init\n" \
1762" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001763" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001764" ::ctrlaltdel:/sbin/reboot\n" \
1765" ::shutdown:/bin/umount -a -r\n" \
1766" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001767
1768#define insmod_trivial_usage \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001769 USE_FEATURE_2_4_MODULES("[OPTION]... ") "MODULE [symbol=value]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001770#define insmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001771 "Load the specified kernel modules into the kernel" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001772 USE_FEATURE_2_4_MODULES( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001773 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001774 " -f Force module to load into the wrong kernel version\n" \
1775 " -k Make module autoclean-able\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001776 " -v Verbose\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00001777 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001778 " -L Lock to prevent simultaneous loads of a module\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001779 USE_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001780 " -m Output load map to stdout\n" \
1781 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001782 " -o NAME Set internal module name to NAME\n" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001783 " -x Do not export externs" \
1784 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001785
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001786#define install_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001787 "[-cgmops] [sources] dest|directory"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001788#define install_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001789 "Copy files and set attributes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001790 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001791 " -c Copy the file, default\n" \
1792 " -d Create directories\n" \
1793 " -g Set group ownership\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001794 " -m Set permissions\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001795 " -o Set ownership\n" \
1796 " -p Preserve date\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001797 " -s Strip symbol tables" \
1798 USE_SELINUX( \
1799 "\n -Z Set security context of copy" \
1800 )
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001801/* would need to make the " | " optional depending on more than one selected */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001802#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001803 "[OPTIONS] {" \
1804 USE_FEATURE_IP_ADDRESS("address | ") \
1805 USE_FEATURE_IP_ROUTE("route | ") \
1806 USE_FEATURE_IP_LINK("link | ") \
1807 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1808 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001809 "} {COMMAND}"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001810#define ip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001811 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001812 "where OBJECT := {" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001813 USE_FEATURE_IP_ADDRESS("address | ") \
1814 USE_FEATURE_IP_ROUTE("route | ") \
1815 USE_FEATURE_IP_LINK("link | ") \
1816 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1817 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001818 "}\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001819 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001820
1821#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001822 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001823 " [dev STRING] [to PREFIX] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001824#define ipaddr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001825 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001826 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
1827 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001828 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001829 " [broadcast ADDR] [anycast ADDR]\n" \
1830 " [label STRING] [scope SCOPE-ID]\n" \
1831 " SCOPE-ID := [host | link | global | NUMBER]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001832
Eric Andersende4f07e2003-12-11 01:18:07 +00001833#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001834 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001835#define ipcalc_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001836 "Calculate IP network settings from a IP address" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001837 "\n\nOptions:" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001838 USE_FEATURE_IPCALC_LONG_OPTIONS( \
1839 "\n -b,--broadcast Display calculated broadcast address" \
1840 "\n -n,--network Display calculated network address" \
1841 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001842 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko03630782007-10-18 11:11:12 +00001843 "\n -p,--prefix Display the prefix for IP/NETMASK" \
1844 "\n -h,--hostname Display first resolved host name" \
1845 "\n -s,--silent Don't ever display error messages" \
1846 ) \
1847 ) \
1848 SKIP_FEATURE_IPCALC_LONG_OPTIONS( \
1849 "\n -b Display calculated broadcast address" \
1850 "\n -n Display calculated network address" \
1851 "\n -m Display default netmask for IP" \
1852 USE_FEATURE_IPCALC_FANCY( \
1853 "\n -p Display the prefix for IP/NETMASK" \
1854 "\n -h Display first resolved host name" \
1855 "\n -s Don't ever display error messages" \
1856 ) \
1857 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001858
Rob Landley6eb1e412005-06-20 04:30:36 +00001859#define ipcrm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001860 "[-[MQS] key] [-[mqs] id]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001861#define ipcrm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001862 "The upper-case options MQS are used to remove a shared memory segment by a\n" \
1863 "segment by a shmkey value. The lower-case options mqs are used\n" \
1864 "to remove a segment by shmid value.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001865 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001866 " -[mM] Remove the memory segment after the last detach\n" \
1867 " -[qQ] Remove the message queue\n" \
1868 " -[sS] Remove the semaphore"
Rob Landley6eb1e412005-06-20 04:30:36 +00001869
1870#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001871 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001872#define ipcs_full_usage \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001873 " -i Show a specific resource\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001874 "Resource specification:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001875 " -m Shared memory segments\n" \
1876 " -q Message queues\n" \
1877 " -s Semaphore arrays\n" \
1878 " -a All (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001879 "Output format:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001880 " -t Time\n" \
1881 " -c Creator\n" \
1882 " -p Pid\n" \
1883 " -l Limits\n" \
1884 " -u Summary"
Rob Landley6eb1e412005-06-20 04:30:36 +00001885
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001886#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001887 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001888#define iplink_full_usage \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00001889 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001890 " dynamic { on | off } |\n" \
1891 " mtu MTU }\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001892 "iplink show [DEVICE]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001893
1894#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001895 "{ list | flush | { add | del | change | append |\n" \
1896 " replace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001897#define iproute_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001898 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001899 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
1900 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001901 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001902 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
1903 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001904
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001905#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001906 "{[list | add | del] RULE}"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001907#define iprule_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001908 "iprule [list | add | del] SELECTOR ACTION\n" \
1909 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
1910 " [dev STRING] [pref NUMBER]\n" \
1911 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
1912 " [prohibit | reject | unreachable]\n" \
1913 " [realms [SRCREALM/]DSTREALM]\n" \
1914 " TABLE_ID := [local | main | default | NUMBER]"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001915
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001916#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001917 "{ add | change | del | show } [NAME]\n" \
1918 " [mode { ipip | gre | sit }]\n" \
1919 " [remote ADDR] [local ADDR] [ttl TTL]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001920#define iptunnel_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001921 "iptunnel { add | change | del | show } [NAME]\n" \
1922 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
1923 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
1924 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001925
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00001926#define kbd_mode_trivial_usage \
1927 "[-a|k|s|u]"
1928#define kbd_mode_full_usage \
1929 "Report or set the keyboard mode" \
1930 "\n\nOptions set mode:\n" \
1931 " -a Default (ASCII)\n" \
1932 " -k Medium-raw (keyboard)\n" \
1933 " -s Raw (scancode)\n" \
1934 " -u Unicode (utf-8)"
1935
Eric Andersen7e9276b2001-02-22 01:15:47 +00001936#define kill_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001937 "[-l] [-signal] process-id [process-id...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001938#define kill_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001939 "Send a signal (default is TERM) to the specified process(es)" \
1940 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001941 " -l List all signal names and numbers"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001942#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001943 "$ ps | grep apache\n" \
1944 "252 root root S [apache]\n" \
1945 "263 www-data www-data S [apache]\n" \
1946 "264 www-data www-data S [apache]\n" \
1947 "265 www-data www-data S [apache]\n" \
1948 "266 www-data www-data S [apache]\n" \
1949 "267 www-data www-data S [apache]\n" \
1950 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001951
1952#define killall_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001953 "[-l] [-q] [-signal] process-name [process-name...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001954#define killall_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001955 "Send a signal (default is TERM) to the specified process(es)" \
1956 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001957 " -l List all signal names and numbers\n" \
1958 " -q Do not complain if no processes were killed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001959#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001960 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001961
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001962#define killall5_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001963 "[-l] [-signal]"
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001964#define killall5_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001965 "Send a signal (default is TERM) to all processes outside current session" \
1966 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001967 " -l List all signal names and numbers\n" \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001968
Mark Whitley6317c4b2001-03-12 22:51:50 +00001969#define klogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001970 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001971#define klogd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001972 "Kernel logger" \
1973 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001974 " -c n Sets the default log level of console messages to n\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001975 " -n Run in foreground"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001976
Eric Andersen7e9276b2001-02-22 01:15:47 +00001977#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001978 "STRING"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001979#define length_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001980 "Print out the length of the specified STRING"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001981#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001982 "$ length Hello\n" \
1983 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001984
Rob Landley9200e792005-09-15 19:26:59 +00001985#define less_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001986 "[-EMNmh~?] [FILE...]"
Rob Landley9200e792005-09-15 19:26:59 +00001987#define less_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001988 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001989 "changed, and files can be manipulated in various ways." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001990 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001991 " -E Quit once the end of a file is reached\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001992 " -M,-m Display a status line containing the line numbers\n" \
1993 " and percentage through the file\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001994 " -N Prefix line numbers to each line\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001995 " -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00001996
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001997#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001998 "personality program [args...]"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001999#define setarch_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002000 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002001 " linux32 Set 32bit uname emulation\n" \
2002 " linux64 Set 64bit uname emulation"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002003
Eric Andersen7e9276b2001-02-22 01:15:47 +00002004#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002005 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002006#define ln_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002007 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
2008 "You may use '--' to indicate that all following arguments are non-options." \
2009 "\n\nOptions:\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00002010 " -s Make symlinks instead of hardlinks\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002011 " -f Remove existing destination files\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00002012 " -n Don't dereference symlinks - treat like normal file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002013 " -b Make a backup of the target (if exists) before link operation\n" \
2014 " -S suf Use suffix instead of ~ when making backup files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002015#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002016 "$ ln -s BusyBox /tmp/ls\n" \
2017 "$ ls -l /tmp/ls\n" \
2018 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002019
Denis Vlasenkob042bd92007-09-26 18:01:32 +00002020#define load_policy_trivial_usage
2021
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002022#define load_policy_full_usage
2023
Eric Andersen7e9276b2001-02-22 01:15:47 +00002024#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002025 "< font"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002026#define loadfont_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002027 "Load a console font from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002028#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002029 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002030
2031#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002032 "< keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002033#define loadkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002034 "Load a binary keyboard translation table from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002035#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002036 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002037
2038#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002039 "[OPTION]... [MESSAGE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002040#define logger_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002041 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002042 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002043 " -s Log to stderr as well as the system log\n" \
2044 " -t TAG Log using the specified tag (defaults to user name)\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002045 " -p PRIO Priority (numeric or facility.level pair)"
2046
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002047#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002048 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002049
Robert Griebl1fca5582002-06-04 20:45:46 +00002050#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002051 "[-p] [-h HOST] [[-f] USER]"
Robert Griebl1fca5582002-06-04 20:45:46 +00002052#define login_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002053 "Begin a new session on the system" \
2054 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002055 " -f Do not authenticate (user already authenticated)\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002056 " -h Name of the remote host\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002057 " -p Preserve environment"
Robert Griebl1fca5582002-06-04 20:45:46 +00002058
Eric Andersen7e9276b2001-02-22 01:15:47 +00002059#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002060 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002061#define logname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002062 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002063#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002064 "$ logname\n" \
2065 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002066
Mark Whitley6317c4b2001-03-12 22:51:50 +00002067#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002068 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00002069#define logread_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002070 "Show messages in syslogd's circular buffer" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002071 "\n\nOptions:\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002072 " -f Output data as log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00002073
Matt Kraai83788da2002-03-20 17:38:37 +00002074#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002075 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2076 " losetup -d LOOPDEV - disassociate\n" \
2077 " losetup [-f] - show"
Matt Kraai83788da2002-03-20 17:38:37 +00002078#define losetup_full_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002079 "Options:\n" \
2080 " -o OFS Start OFS bytes into FILE\n" \
2081 " -f Show first free loop device"
Rob Landley1d589b22005-11-29 23:47:10 +00002082#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002083 "No arguments will display all current associations.\n" \
2084 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002085 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002086 "and filename of the file the loop device is currently bound to.\n\n" \
2087 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002088 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2089 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002090
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002091#define lpd_trivial_usage \
2092 "SPOOLDIR"
2093#define lpd_full_usage \
2094 "Example:" \
Denis Vlasenko394eebe2008-02-25 20:30:24 +00002095 "\n tcpsvd -E 0 515 softlimit -m 99999 lpd /var/spool"
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002096
Denis Vlasenko68444b92008-02-22 22:24:48 +00002097#define lpq_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002098 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID...] [-fs]"
Denis Vlasenko68444b92008-02-22 22:24:48 +00002099#define lpq_full_usage \
2100 "Options:" \
2101 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002102 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002103 "\n -f Force any waiting job to be printed" \
2104 "\n -s Short display" \
2105
2106#define lpr_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002107 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE...]"
2108/* -C CLASS exists too, not shown.
2109 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko68444b92008-02-22 22:24:48 +00002110#define lpr_full_usage \
2111 "Options:" \
2112 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002113 "\n -m Send mail on completion" \
2114 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002115 "\n -V Verbose" \
2116
Eric Andersen7e9276b2001-02-22 01:15:47 +00002117#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002118 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00002119 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002120 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
2121 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
2122 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
2123 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
2124 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
2125 USE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002126#define ls_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002127 "List directory contents" \
2128 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002129 "\n -1 List files in a single column" \
2130 "\n -A Do not list implied . and .." \
2131 "\n -a Do not hide entries starting with ." \
2132 "\n -C List entries by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002133 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002134 "\n -c With -l: show ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002135 USE_FEATURE_LS_COLOR( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002136 "\n --color[={always,never,auto}] Control coloring") \
2137 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002138 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002139 "\n -e List both full date and full time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002140 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002141 "\n -F Append indicator (one of */=@|) to entries") \
2142 "\n -i List the i-node for each file" \
2143 "\n -l Use a long listing format" \
2144 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002145 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002146 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002147 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko081ef792007-03-17 16:38:21 +00002148 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002149 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002150 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002151 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002152 "\n -r Sort the listing in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002153 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002154 "\n -S Sort the listing by file size") \
2155 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002156 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002157 "\n -T NUM Assume Tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002158 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002159 "\n -t With -l: show modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002160 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002161 "\n -u With -l: show access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002162 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002163 "\n -v Sort the listing by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002164 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002165 "\n -w NUM Assume the terminal is NUM columns wide") \
2166 "\n -x List entries by lines instead of by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002167 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002168 "\n -X Sort the listing by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00002169 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002170 "\n -h Print sizes in human readable format (e.g., 1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002171 USE_SELINUX( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002172 "\n -k Print security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002173 USE_SELINUX( \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002174 "\n -K Print security context in long format") \
2175 USE_SELINUX( \
2176 "\n -Z Print security context and permission")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002177
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002178#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002179 "[-Radlv] [files...]"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002180#define lsattr_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002181 "List file attributes on an ext2 fs" \
2182 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002183 " -R Recursively list subdirectories\n" \
2184 " -a Do not hide entries starting with .\n" \
2185 " -d List directory entries instead of contents\n" \
2186 " -l Print long flag names\n" \
2187 " -v List the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002188
Eric Andersen7e9276b2001-02-22 01:15:47 +00002189#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002190 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002191#define lsmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002192 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002193
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002194#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002195#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002196 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002197#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002198 "Create a range of block or character special files\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002199 "TYPEs include:\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002200 " b: Make a block (buffered) device\n" \
2201 " c or u: Make a character (un-buffered) device\n" \
2202 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes\n" \
2203 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002204 "FIRST specifies the number appended to NAME to create the first device.\n" \
2205 "LAST specifies the number of the last item that should be created\n" \
2206 "If 's' is the last argument, the base device is created as well.\n\n" \
2207 "For example:\n" \
2208 " makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
2209 " makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002210#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002211 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2212 "[creates ttyS2-ttyS63]\n" \
2213 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2214 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002215#endif
2216
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002217#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002218#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002219 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00002220#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002221 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002222 "Device table entries take the form of:\n" \
2223 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002224 "Where name is the file name, type can be one of:\n" \
2225 " f A regular file\n" \
2226 " d Directory\n" \
2227 " c Character special device file\n" \
2228 " b Block special device file\n" \
2229 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002230 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002231 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2232 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002233#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002234 "For example:\n" \
2235 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2236 "/dev d 755 0 0 - - - - -\n" \
2237 "/dev/console c 666 0 0 5 1 - - -\n" \
2238 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2239 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2240 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2241 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2242 "Will Produce:\n" \
2243 "/dev\n" \
2244 "/dev/console\n" \
2245 "/dev/null\n" \
2246 "/dev/zero\n" \
2247 "/dev/hda\n" \
2248 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002249#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002250
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002251#define matchpathcon_trivial_usage \
2252 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
2253#define matchpathcon_full_usage \
2254 " -n Do not display path" \
2255 "\n -N Do not use translations" \
2256 "\n -f Use alternate file_context file" \
2257 "\n -p Use prefix to speed translations" \
2258 "\n -V Verify file context on disk matches defaults"
2259
Eric Andersen7e9276b2001-02-22 01:15:47 +00002260#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002261 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002262 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002263#define md5sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002264 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2265 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002266 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002267 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002268 " -c Check MD5 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002269 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002270 " -s Don't output anything, status code shows success\n" \
2271 " -w Warn about improperly formatted MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002272#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002273 "$ md5sum < busybox\n" \
2274 "6fd11e98b98a58f64ff3398d7b324003\n" \
2275 "$ md5sum busybox\n" \
2276 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2277 "$ md5sum -c -\n" \
2278 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2279 "busybox: OK\n" \
2280 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002281
Rob Landley70f7ef72005-12-13 08:21:33 +00002282#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002283 "[-s]"
Rob Landley70f7ef72005-12-13 08:21:33 +00002284#define mdev_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002285 " -s Scan /sys and populate /dev during system boot\n\n" \
2286 "Called with no options (via hotplug) it uses environment variables\n" \
2287 "to determine which device to add/remove."
Rob Landleyef10d522006-06-26 14:11:33 +00002288#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002289 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002290 "The mdev config file contains lines that look like:\n" \
2291 " hd[a-z][0-9]* 0:3 660\n\n" \
2292 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002293 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002294 "Optionally, that can be followed (on the same line) by a special character\n" \
2295 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002296 "device(s). The environment variable $MDEV indicates the active device node\n" \
2297 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002298 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2299 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002300 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002301 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002302 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002303 "Config file parsing stops on the first matching line. If no config\n" \
2304 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002305 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002306 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002307
Glenn L McGrath061c9002002-09-16 04:21:46 +00002308#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002309 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002310#define mesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002311 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002312 " y Allow write access to your terminal\n" \
2313 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002314
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002315#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002316 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002317#define microcom_full_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002318 "Copy bytes for stdin to TTY and from TTY to stdout" \
2319 "\n\nOptions:" \
Mike Frysinger1e47c422008-02-15 01:34:14 +00002320 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2321 "\n next byte to it" \
2322 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2323 "\n -s Set serial line to SPEED" \
2324 "\n -X Disable special meaning of NUL and Ctrl-X from stdin"
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002325
Eric Andersen7e9276b2001-02-22 01:15:47 +00002326#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002327 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002328#define mkdir_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002329 "Create the DIRECTORY(ies) if they do not already exist" \
2330 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002331 " -m Set permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002332 " -p No error if existing, make parent directories as needed" \
2333 USE_SELINUX( \
2334 "\n -Z Set security context" \
2335 )
2336
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002337#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002338 "$ mkdir /tmp/foo\n" \
2339 "$ mkdir /tmp/foo\n" \
2340 "/tmp/foo: File exists\n" \
2341 "$ mkdir /tmp/foo/bar/baz\n" \
2342 "/tmp/foo/bar/baz: No such file or directory\n" \
2343 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002344
Mike Frysinger6447ac02005-06-11 05:29:40 +00002345#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002346 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2347 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2348 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2349 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2350 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2351 "device [blocks-count]"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002352#define mke2fs_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002353 " -b size Block size in bytes\n" \
2354 " -c Check for bad blocks before creating\n" \
2355 " -E opts Set extended options\n" \
2356 " -f size Fragment size in bytes\n" \
2357 " -F Force (ignore sanity checks)\n" \
2358 " -g num Number of blocks in a block group\n" \
2359 " -i ratio The bytes/inode ratio\n" \
2360 " -j Create a journal (ext3)\n" \
2361 " -J opts Set journal options (size/device)\n" \
2362 " -l file Read bad blocks list from file\n" \
2363 " -L lbl Set the volume label\n" \
2364 " -m percent Percent of fs blocks to reserve for admin\n" \
2365 " -M dir Set last mounted directory\n" \
2366 " -n Do not actually create anything\n" \
2367 " -N num Number of inodes to create\n" \
2368 " -o os Set the 'creator os' field\n" \
2369 " -O features Dir_index/filetype/has_journal/journal_dev/sparse_super\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002370 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002371 " -r rev Set filesystem revision\n" \
2372 " -S Write superblock and group descriptors only\n" \
2373 " -T fs-type Set usage type (news/largefile/largefile4)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002374 " -v Verbose"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002375
Eric Andersen7e9276b2001-02-22 01:15:47 +00002376#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002377 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002378#define mkfifo_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002379 "Create a named pipe (identical to 'mknod name p')" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002380 "\n\nOptions:\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002381 " -m Create the pipe using the specified mode (default a=rw)" \
2382 USE_SELINUX( \
2383 "\n -Z Set security context" \
2384 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002385
Eric Andersen7e9276b2001-02-22 01:15:47 +00002386#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002387 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002388#define mkfs_minix_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002389 "Make a MINIX filesystem" \
2390 "\n\nOptions:\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00002391 " -c Check device for bad blocks\n" \
2392 " -n [14|30] Maximum length of filenames\n" \
2393 " -i INODES Number of inodes for the filesystem\n" \
2394 " -l FILENAME Read bad blocks list from FILENAME\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002395 " -v Make version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002396
Eric Andersen7e9276b2001-02-22 01:15:47 +00002397#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002398 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002399#define mknod_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002400 "Create a special file (block, character, or pipe)" \
2401 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002402 " -m Create the special file using the specified mode (default a=rw)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002403 "\n\nTYPEs include:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002404 " b: Make a block (buffered) device\n" \
2405 " c or u: Make a character (un-buffered) device\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002406 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes" \
2407 USE_SELINUX( \
2408 "\n -Z Set security context" \
2409 )
2410
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002411#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002412 "$ mknod /dev/fd0 b 2 0\n" \
2413 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002414
Eric Andersen7e9276b2001-02-22 01:15:47 +00002415#define mkswap_trivial_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002416 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002417#define mkswap_full_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002418 "Prepare block device to be used as swap partition"
2419#if 0
2420 "[-c] [-v0|-v1] DEVICE [BLOCKS]"
2421 "\n\nOptions:"
2422 "\n -c Check for readability"
2423 "\n -v0 Make swap version 0 (max 128M)"
2424 "\n -v1 Make swap version 1 (default for kernels > 2.1.117)"
2425 "\n BLOCKS Number of blocks to use (default is entire partition)"
2426#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002427
Eric Andersen7e9276b2001-02-22 01:15:47 +00002428#define mktemp_trivial_usage \
Denis Vlasenko761e1d12008-02-09 06:29:32 +00002429 "[-dt] [-p DIR] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002430#define mktemp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002431 "Create a temporary file with its name based on TEMPLATE.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002432 "TEMPLATE is any name with six 'Xs' (i.e., /tmp/temp.XXXXXX)." \
2433 "\n\nOptions:\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002434 " -d Make a directory instead of a file\n" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002435 /* " -q Fail silently if an error occurs\n" - we ignore it */ \
2436 " -t Generate a path rooted in temporary directory\n" \
2437 " -p DIR Use DIR as a temporary directory (implies -t)\n" \
2438 "\n" \
2439 "For -t or -p, directory is chosen as follows:\n" \
2440 "$TMPDIR if set, else -p DIR, else /tmp"
2441
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002442#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002443 "$ mktemp /tmp/temp.XXXXXX\n" \
2444 "/tmp/temp.mWiLjM\n" \
2445 "$ ls -la /tmp/temp.mWiLjM\n" \
2446 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002447
Eric Andersen8d79ce82001-07-22 23:00:15 +00002448#define modprobe_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002449 "[-knqrsv] MODULE [symbol=value...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002450#define modprobe_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002451 "Options:\n" \
2452 " -k Make module autoclean-able\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002453 " -n Dry run\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002454 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002455 " -r Remove module (stacks) or do autoclean\n" \
2456 " -s Report via syslog instead of stderr\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002457 " -v Verbose"
Rob Landley9c32a152005-12-11 20:12:24 +00002458#define modprobe_notes_usage \
2459"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2460"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2461"pass each module it loads.\n" \
2462"\n" \
2463"The configuration file is searched (in order) amongst:\n" \
2464"\n" \
2465" /etc/modprobe.conf (2.6 only)\n" \
2466" /etc/modules.conf\n" \
2467" /etc/conf.modules (deprecated)\n" \
2468"\n" \
2469"They all have the same syntax (see below). If none is present, it is\n" \
2470"_not_ an error; each loaded module is then expected to load without\n" \
2471"options. Once a file is found, the others are tested for.\n" \
2472"\n" \
2473"/etc/modules.conf entry format:\n" \
2474"\n" \
2475" alias <alias_name> <mod_name>\n" \
2476" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002477" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002478" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2479" This makes it also possible to use a different set of options (below) for\n" \
2480" the module and the alias.\n" \
2481" A module can be aliased more than once.\n" \
2482"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002483" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002484" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2485" the \"symbol=value\" pairs as option to that module.\n" \
2486"\n" \
2487"Sample /etc/modules.conf file:\n" \
2488"\n" \
2489" options tulip irq=3\n" \
2490" alias tulip tulip2\n" \
2491" options tulip2 irq=4 io=0x308\n" \
2492"\n" \
2493"Other functionality offered by 'classic' modprobe is not available in\n" \
2494"this implementation.\n" \
2495"\n" \
2496"If module options are present both in the config file, and on the command line,\n" \
2497"then the options from the command line will be passed to the module _after_\n" \
2498"the options from the config file. That way, you can have defaults in the config\n" \
2499"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002500#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002501 "(with the above /etc/modules.conf):\n\n" \
2502 "$ modprobe tulip\n" \
2503 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2504 "$ modprobe tulip irq=5\n" \
2505 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2506 "$ modprobe tulip2\n" \
2507 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2508 " which are the default for alias 'tulip2'\n\n" \
2509 "$ modprobe tulip2 irq=8\n" \
2510 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2511 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2512 " from the command line\n\n" \
2513 "$ modprobe tulip2 irq=2 io=0x210\n" \
2514 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2515 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2516 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002517
Eric Andersen7e9276b2001-02-22 01:15:47 +00002518#define more_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002519 "[FILE...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002520#define more_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002521 "View FILE or standard input one screenful at a time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002522#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002523 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002524
Eric Andersen7e9276b2001-02-22 01:15:47 +00002525#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002526 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002527#define mount_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002528 "Mount a filesystem. Filesystem autodetection requires /proc be mounted." \
2529 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002530 " -a Mount all filesystems in fstab\n" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002531 USE_FEATURE_MOUNT_FAKE( \
2532 " -f "USE_FEATURE_MTAB_SUPPORT("Update /etc/mtab, but ")"don't mount\n" \
2533 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002534 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002535 " -n Don't update /etc/mtab\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002536 ) \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002537 " -r Read-only mount\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00002538 " -t fs-type Filesystem type\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002539 " -w Read-write mount (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002540 "\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002541 "-o option:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002542 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002543 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002544 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002545 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002546 " [a]sync Writes are asynchronous / synchronous\n" \
2547 " [no]atime Disable / enable updates to inode access times\n" \
2548 " [no]diratime Disable / enable atime updates to directories\n" \
2549 " [no]dev Allow use of special device files / disallow them\n" \
2550 " [no]exec Allow use of executable files / disallow them\n" \
2551 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2552 " [r]shared Convert [recursively] to a shared subtree\n" \
2553 " [r]slave Convert [recursively] to a slave subtree\n" \
2554 " [r]private Convert [recursively] to a private subtree\n" \
2555 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2556 " bind Bind a directory to an additional location\n" \
2557 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002558 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002559 " remount Remount a mounted filesystem, changing its flags\n" \
2560 " ro/rw Mount for read-only / read-write\n" \
2561 "\n" \
2562 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002563 "You'll have to see the written documentation for those filesystems"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002564#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002565 "$ mount\n" \
2566 "/dev/hda3 on / type minix (rw)\n" \
2567 "proc on /proc type proc (rw)\n" \
2568 "devpts on /dev/pts type devpts (rw)\n" \
2569 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2570 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2571 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002572#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002573 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002574
Rob Landleyd00b3a52005-08-20 05:07:08 +00002575#define mountpoint_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002576 "[-q] <[-d] DIR | -x DEVICE>"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002577#define mountpoint_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002578 "mountpoint checks if the directory is a mountpoint" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002579 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002580 " -q Quiet\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002581 " -d Print major/minor device number of the filesystem\n" \
2582 " -x Print major/minor device number of the blockdevice"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002583#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002584 "$ mountpoint /proc\n" \
2585 "/proc is not a mountpoint\n" \
2586 "$ mountpoint /sys\n" \
2587 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002588
Eric Andersen7e9276b2001-02-22 01:15:47 +00002589#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002590 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002591#define mt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002592 "Control magnetic tape drive operation\n" \
2593 "\nAvailable Opcodes:\n\n" \
2594 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2595 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2596 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
2597 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002598
Eric Andersen7e9276b2001-02-22 01:15:47 +00002599#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002600 "[OPTION]... SOURCE DEST\n" \
2601 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002602#define mv_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002603 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY" \
2604 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002605 " -f Don't prompt before overwriting\n" \
2606 " -i Interactive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002607#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002608 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002609
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002610#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002611 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002612#define nameif_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002613 "Rename network interface while it in the down state" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002614 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002615 " -c FILE Use configuration file (default is /etc/mactab)\n" \
2616 " -s Use syslog (LOCAL0 facility)\n" \
2617 " IFNAME MACADDR new_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002618#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002619 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2620 " or\n" \
2621 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002622
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002623#if !ENABLE_DESKTOP
2624
Rob Landley1cca9482006-07-10 19:45:20 +00002625#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002626#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002627#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002628#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002629#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002630
Eric Andersen7e9276b2001-02-22 01:15:47 +00002631#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002632 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002633 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002634#define nc_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002635 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002636 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002637 USE_NC_EXTRA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002638 "\n -e Exec rest of command line after connect" \
2639 "\n -i SECS Delay interval for lines sent" \
2640 "\n -w SECS Timeout for connect" \
Denis Vlasenko5d687242007-01-12 20:59:31 +00002641 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002642 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002643 USE_NC_SERVER( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002644 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002645 USE_NC_EXTRA( \
2646 "\n (use -l twice with -e for persistent server)") \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002647 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002648 )
2649
Rob Landley1cca9482006-07-10 19:45:20 +00002650#define nc_notes_usage "" \
2651 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002652 "To use netcat as a terminal emulator on a serial port:\n\n" \
2653 "$ stty 115200 -F /dev/ttyS0\n" \
2654 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2655 )
Rob Landley1cca9482006-07-10 19:45:20 +00002656
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002657#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002658 "$ nc foobar.somedomain.com 25\n" \
2659 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2660 "help\n" \
2661 "214-Commands supported:\n" \
2662 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2663 "214 NOOP QUIT RSET HELP\n" \
2664 "quit\n" \
2665 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002666
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002667#else /* DESKTOP nc - much more compatible with nc 1.10 */
2668
2669#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002670 "[-options] hostname port - connect" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002671 USE_NC_SERVER("\nnc [-options] -l -p port [hostname] [port] - listen")
2672#define nc_full_usage \
2673 USE_NC_SERVER( \
2674 "-l Listen mode, for inbound connects\n" \
2675 ) \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002676 "-n Don't do DNS resolution" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002677 "\n-s addr Local address" \
2678 "\n-p port Local port" \
2679 "\n-u UDP mode" \
2680 "\n-v Verbose (cumulative: -vv)" \
2681 "\n-w secs Timeout for connects and final net reads" \
2682 USE_NC_EXTRA( \
2683 "\n-i sec Delay interval for lines sent" /* ", ports scanned" */ \
2684 "\n-o file Hex dump of traffic" \
2685 "\n-z Zero-I/O mode (scanning)" \
2686 ) \
2687 "\n-e prog [args] Program to exec after connect (must be last)" \
2688/* "\n-r Randomize local and remote ports" */
2689/* "\n-g gateway Source-routing hop point[s], up to 8" */
2690/* "\n-G num Source-routing pointer: 4, 8, 12, ..." */
2691/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2692
2693#endif
2694
Eric Andersen1552ff72001-10-31 11:07:12 +00002695#define netstat_trivial_usage \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002696 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")"]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002697#define netstat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002698 "Display networking information" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002699 "\n\nOptions:" \
2700 "\n -l Display listening server sockets" \
2701 "\n -a Display all sockets (default: connected)" \
2702 "\n -e Display other/more information" \
2703 "\n -n Don't resolve names" \
2704 "\n -t Tcp sockets" \
2705 "\n -u Udp sockets" \
2706 "\n -w Raw sockets" \
2707 "\n -x Unix sockets" \
2708 "\n -r Display routing table" \
2709 USE_FEATURE_NETSTAT_WIDE( \
2710 "\n -W Display with no column truncation" \
2711 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002712
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002713#define nice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002714 "[-n ADJUST] [COMMAND [ARG]...]"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002715#define nice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002716 "Run a program with modified scheduling priority" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002717 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002718 " -n ADJUST Adjust the scheduling priority by ADJUST"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002719
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002720#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002721 "format_string"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002722#define nmeter_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002723 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002724 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002725 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002726 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002727 "%[niface] Monitor network interface 'iface'\n" \
2728 "%m Monitor allocated memory\n" \
2729 "%[mf] Monitor free memory\n" \
2730 "%[mt] Monitor total memory\n" \
2731 "%s Monitor allocated swap\n" \
2732 "%f Monitor number of used file descriptors\n" \
2733 "%Ni Monitor total/specific IRQ rate\n" \
2734 "%x Monitor context switch rate\n" \
2735 "%p Monitor forks\n" \
2736 "%[pn] Monitor # of processes\n" \
2737 "%b Monitor block io\n" \
2738 "%Nt Show time (with N decimal points)\n" \
2739 "%Nd Milliseconds between updates (default=1000)\n" \
2740 "%r Print <cr> instead of <lf> at EOL"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002741#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002742 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002743
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002744#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002745 "COMMAND [ARGS]"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002746#define nohup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002747 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002748#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002749 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002750
Eric Andersen7e9276b2001-02-22 01:15:47 +00002751#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002752 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002753#define nslookup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002754 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002755 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002756#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002757 "$ nslookup localhost\n" \
2758 "Server: default\n" \
2759 "Address: default\n" \
2760 "\n" \
2761 "Name: debian\n" \
2762 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002763
Glenn L McGrath60281112001-11-02 11:39:46 +00002764#define od_trivial_usage \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002765 "[-aBbcDdeFfHhIiLlOovXx] " USE_DESKTOP("[-t TYPE] ") "[FILE]"
Glenn L McGrath60281112001-11-02 11:39:46 +00002766#define od_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002767 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002768 "to standard output. With no FILE or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002769
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002770#define openvt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002771 "VTNUM COMMAND [ARGS...]"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002772#define openvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002773 "Start a command on a new virtual terminal"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002774#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002775 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002776
Eric Andersen27f64e12002-06-23 04:24:25 +00002777#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002778 "[OPTION] [name]"
Eric Andersen27f64e12002-06-23 04:24:25 +00002779#define passwd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002780 "Change a user password. If no name is specified,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002781 "changes the password for the current user." \
2782 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002783 " -a Define which algorithm shall be used for the password\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002784 " (choices: des, md5)\n" /* ", sha1)" */ \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002785 " -d Delete the password for the specified user account\n" \
2786 " -l Locks (disables) the specified user account\n" \
2787 " -u Unlocks (re-enables) the specified user account"
Eric Andersen27f64e12002-06-23 04:24:25 +00002788
Denis Vlasenko21d10142007-07-20 21:28:41 +00002789#define chpasswd_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002790 USE_GETOPT_LONG("[--md5|--encrypt]") SKIP_GETOPT_LONG("[-m|-e]")
Denis Vlasenko21d10142007-07-20 21:28:41 +00002791#define chpasswd_full_usage \
2792 "Read user:password information from stdin\n" \
2793 "and update /etc/passwd accordingly." \
2794 "\n\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002795 USE_GETOPT_LONG( \
2796 "\n -e,--encrypt Supplied passwords are in encrypted form" \
2797 "\n -m,--md5 Use MD5 encryption instead of DES" \
2798 ) \
2799 SKIP_GETOPT_LONG( \
2800 "\n -e Supplied passwords are in encrypted form" \
2801 "\n -m Use MD5 encryption instead of DES" \
2802 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00002803
Glenn L McGrath655d8142003-06-22 15:32:41 +00002804#define patch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002805 "[-p num] [-i diff]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002806#define patch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002807 " -p NUM Strip NUM leading components from file names\n" \
2808 " -i DIFF Read DIFF instead of stdin"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002809#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002810 "$ patch -p1 < example.diff\n" \
2811 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002812
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002813#define pgrep_trivial_usage \
2814 "[-flnovx] pattern"
2815#define pgrep_full_usage \
2816 "Display process(es) selected by regex pattern" \
2817 "\n\nOptions:\n" \
2818 " -l Show command name too\n" \
2819 " -f Match against entire command line\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002820 " -n Show the newest process only\n" \
2821 " -o Show the oldest process only\n" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002822 " -v Negate the matching\n" \
2823 " -x Match whole name (not substring)"
2824
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002825#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00002826#define pidof_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002827 "[OPTION] [NAME...]"
2828#define USAGE_PIDOF "\n\nOptions:"
2829#else
2830#define pidof_trivial_usage \
2831 "[NAME...]"
2832#define USAGE_PIDOF /* none */
2833#endif
Eric Andersen221b2ea2001-07-31 19:06:07 +00002834#define pidof_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002835 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002836 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002837 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002838 "\n -s Show only one PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002839 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002840 "\n -o PID Omit given pid" \
2841 "\n Use %PPID to omit pid of pidof's parent")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002842#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002843 "$ pidof init\n" \
2844 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002845 USE_FEATURE_PIDOF_OMIT( \
2846 "$ pidof /bin/sh\n20351 5973 5950\n") \
2847 USE_FEATURE_PIDOF_OMIT( \
2848 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002849
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002850#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002851#define ping_trivial_usage \
2852 "host"
2853#define ping_full_usage \
2854 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002855#define ping6_trivial_usage \
2856 "host"
2857#define ping6_full_usage \
2858 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002859#else
2860#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002861 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002862#define ping_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002863 "Send ICMP ECHO_REQUEST packets to network hosts" \
2864 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002865 " -4, -6 Force IPv4 or IPv6 hostname resolution\n" \
2866 " -c CNT Send only CNT pings\n" \
2867 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2868 " -I iface/IP Use interface or IP address as source\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002869 " -q Quiet, only displays output at start\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002870 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002871#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002872 "[OPTION]... host"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002873#define ping6_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002874 "Send ICMP ECHO_REQUEST packets to network hosts" \
2875 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002876 " -c CNT Send only CNT pings\n" \
2877 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2878 " -I iface/IP Use interface or IP address as source\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002879 " -q Quiet, only displays output at start\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002880 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002881#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002882#define ping_example_usage \
2883 "$ ping localhost\n" \
2884 "PING slag (127.0.0.1): 56 data bytes\n" \
2885 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2886 "\n" \
2887 "--- debian ping statistics ---\n" \
2888 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2889 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002890#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002891 "$ ping6 ip6-localhost\n" \
2892 "PING ip6-localhost (::1): 56 data bytes\n" \
2893 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2894 "\n" \
2895 "--- ip6-localhost ping statistics ---\n" \
2896 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2897 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002898
Eric Andersen7e9276b2001-02-22 01:15:47 +00002899#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002900 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002901#define pivot_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002902 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002903 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002904
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002905#define pkill_trivial_usage \
2906 "[-l] | [-fnovx] [-signal] pattern"
2907#define pkill_full_usage \
2908 "Send a signal to process(es) selected by regex pattern" \
2909 "\n\nOptions:\n" \
2910 " -l List all signals\n" \
2911 " -f Match against entire command line\n" \
2912 " -n Signal the newest process only\n" \
2913 " -o Signal the oldest process only\n" \
2914 " -v Negate the matching\n" \
2915 " -x Match whole name (not substring)"
2916
Eric Andersen7e9276b2001-02-22 01:15:47 +00002917#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002918 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002919#define poweroff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002920 "Halt and shut off power" \
2921 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002922 " -d Delay interval for halting\n" \
2923 " -n No call to sync()\n" \
2924 " -f Force power off (don't go through init)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002925
Mike Frysinger95d3c452005-04-21 23:29:24 +00002926#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002927 "[VARIABLES...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002928#define printenv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002929 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002930 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00002931
Eric Andersen7e9276b2001-02-22 01:15:47 +00002932#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002933 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002934#define printf_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002935 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002936 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002937#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002938 "$ printf \"Val=%d\\n\" 5\n" \
2939 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002940
Denis Vlasenko94949192006-11-05 00:45:47 +00002941
2942#if ENABLE_DESKTOP
2943
2944#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002945 ""
Denis Vlasenko94949192006-11-05 00:45:47 +00002946#define ps_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002947 "Report process status" \
2948 "\n\nOptions:" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002949 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00002950
2951#else /* !ENABLE_DESKTOP */
2952
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002953#if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002954#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00002955#else
2956#define USAGE_PS "\nOptions:"
2957#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002958
Eric Andersen7e9276b2001-02-22 01:15:47 +00002959#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002960 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002961#define ps_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002962 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002963 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002964 USE_SELINUX( \
Bernhard Reutner-Fischer26a80162007-03-14 08:52:28 +00002965 "\n -Z Show SE Linux context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002966 USE_FEATURE_PS_WIDE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002967 "\n w Wide output")
Rob Landley6eb1e412005-06-20 04:30:36 +00002968
Denis Vlasenko94949192006-11-05 00:45:47 +00002969#endif /* ENABLE_DESKTOP */
2970
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002971#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002972 "$ ps\n" \
2973 " PID Uid Gid State Command\n" \
2974 " 1 root root S init\n" \
2975 " 2 root root S [kflushd]\n" \
2976 " 3 root root S [kupdate]\n" \
2977 " 4 root root S [kpiod]\n" \
2978 " 5 root root S [kswapd]\n" \
2979 " 742 andersen andersen S [bash]\n" \
2980 " 743 andersen andersen S -bash\n" \
2981 " 745 root root S [getty]\n" \
2982 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002983
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00002984#define pscan_trivial_usage \
2985 "[-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
2986#define pscan_full_usage \
2987 "Scan a host, print all open ports" \
2988 "\n\nOptions:" \
2989 "\n -p Scan from this port (default 1)" \
2990 "\n -P Scan up to this port (default 1024)" \
2991 "\n -t Timeout (default 5000 ms)" \
2992 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
2993
Eric Andersen7e9276b2001-02-22 01:15:47 +00002994#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002995 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002996#define pwd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002997 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002998#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002999 "$ pwd\n" \
3000 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003001
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003002#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003003 "DEVICE"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003004#define raidautorun_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003005 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003006#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003007 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003008
Eric Andersen7e9276b2001-02-22 01:15:47 +00003009#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003010 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003011#define rdate_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003012 "Get and possibly set the system date and time from a remote HOST" \
3013 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003014 " -s Set the system date and time (default)\n" \
3015 " -p Print the date and time"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003016
Rob Landley0e4690d2006-08-20 22:12:18 +00003017#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003018 "[FILE]..."
Rob Landley0e4690d2006-08-20 22:12:18 +00003019#define readahead_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003020 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
3021 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00003022
Eric Andersen7e9276b2001-02-22 01:15:47 +00003023#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003024 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003025#define readlink_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003026 "Display the value of a symlink" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003027 USE_FEATURE_READLINK_FOLLOW( \
3028 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003029 " -f Canonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003030
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003031#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003032 "[OPTIONS]..."
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003033#define readprofile_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003034 "Options:\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003035 " -m mapfile (Default: /boot/System.map)\n" \
3036 " -p profile (Default: /proc/profile)\n" \
3037 " -M mult Set the profiling multiplier to mult\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003038 " -i Print only info about the sampling step\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003039 " -v Verbose\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003040 " -a Print all symbols, even if count is 0\n" \
3041 " -b Print individual histogram-bin counts\n" \
3042 " -s Print individual counters within functions\n" \
3043 " -r Reset all the counters (root only)\n" \
3044 " -n Disable byte order auto-detection"
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003045
Glenn L McGrath62fae302002-12-10 00:14:33 +00003046#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003047 "pathname..."
Glenn L McGrath62fae302002-12-10 00:14:33 +00003048#define realpath_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003049 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00003050
Eric Andersen7e9276b2001-02-22 01:15:47 +00003051#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003052 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003053#define reboot_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003054 "Reboot the system" \
3055 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003056 " -d Delay interval for rebooting\n" \
3057 " -n No call to sync()\n" \
3058 " -f Force reboot (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003059
3060#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003061 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003062#define renice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003063 "Change priority of running processes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003064 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003065 " -n Adjust current nice value (smaller is faster)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003066 " -p Process id(s) (default)\n" \
3067 " -g Process group id(s)\n" \
3068 " -u Process user name(s) and/or id(s)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003069
Eric Andersen7e9276b2001-02-22 01:15:47 +00003070#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003071 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003072#define reset_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003073 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003074
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003075#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003076 ""
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003077#define resize_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003078 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003079
Denis Vlasenko397137b2007-07-23 14:03:30 +00003080#define restorecon_trivial_usage \
3081 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
3082#define restorecon_full_usage \
3083 "Reset security contexts of files in pathname\n" \
3084 "\n -i Ignore files that do not exist" \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003085 "\n -f file File with list of files to process. Use - for stdin" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003086 "\n -e directory Directory to exclude" \
3087 "\n -R,-r Recurse directories" \
3088 "\n -n Don't change any file labels" \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003089 "\n -o file Save list of files with incorrect context" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003090 "\n -v Verbose" \
3091 "\n -vv Show changed labels" \
3092 "\n -F Force reset of context to match file_context" \
3093 "\n for customizable files, or the user section," \
3094 "\n if it has changed"
3095
Eric Andersen7e9276b2001-02-22 01:15:47 +00003096#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003097 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003098#define rm_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003099 "Remove (unlink) the FILE(s). Use '--' to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003100 "indicate that all following arguments are non-options." \
3101 "\n\nOptions:\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003102 " -i Always prompt before removing\n" \
3103 " -f Never prompt\n" \
3104 " -r,-R Remove directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003105#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003106 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003107
Eric Andersen7e9276b2001-02-22 01:15:47 +00003108#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003109 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003110#define rmdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003111 "Remove the DIRECTORY, if it is empty"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003112#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003113 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003114
Eric Andersen7e9276b2001-02-22 01:15:47 +00003115#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003116 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003117#define rmmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003118 "Unload the specified kernel modules from the kernel" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003119 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003120 " -a Remove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003121#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003122 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003123
Eric Andersen7e9276b2001-02-22 01:15:47 +00003124#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003125 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003126#define route_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003127 "Edit the kernel's routing tables" \
3128 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003129 " -n Dont resolve names\n" \
3130 " -e Display other/more information\n" \
3131 " -A inet" USE_FEATURE_IPV6("{6}") " Select address family"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003132
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003133#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003134 "-i -q[ildc]p package.rpm"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003135#define rpm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003136 "Manipulate RPM packages" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003137 "\n\nOptions:" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003138 "\n -i Install package" \
3139 "\n -q Query package" \
3140 "\n -p Query uninstalled package" \
3141 "\n -i Show information" \
3142 "\n -l List contents" \
3143 "\n -d List documents" \
3144 "\n -c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003145
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003146#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003147 "package.rpm"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003148#define rpm2cpio_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003149 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003150
Mike Frysinger6b160e42008-02-15 02:27:19 +00003151#define rtcwake_trivial_usage \
3152 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SECS | -t TIME]"
3153#define rtcwake_full_usage \
3154 "enter a system sleep state until specified wakeup time\n\n" \
3155 USE_GETOPT_LONG( \
3156 " -a,--auto Read clock mode from adjtime\n" \
3157 " -l,--local Clock is set to local time\n" \
3158 " -u,--utc Clock is set to UTC time\n" \
3159 " -d,--device=DEV Specify the RTC device\n" \
3160 " -m,--mode=MODE Set the sleep state (default: standby)\n" \
3161 " -s,--seconds=SEC Set the timeout in SEC seconds from now\n" \
3162 " -t,--time=TIME Set the timeout to TIME seconds from epoch" \
3163 ) \
3164 SKIP_GETOPT_LONG( \
3165 " -a Read clock mode from adjtime\n" \
3166 " -l Clock is set to local time\n" \
3167 " -u Clock is set to UTC time\n" \
3168 " -d DEV Specify the RTC device\n" \
3169 " -m MODE Set the sleep state (default: standby)\n" \
3170 " -s SEC Set the timeout in SEC seconds from now\n" \
3171 " -t TIME Set the timeout to TIME seconds from epoch" \
3172 )
3173
Denis Vlasenko49622d72007-03-10 16:58:49 +00003174#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003175 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3176 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko49622d72007-03-10 16:58:49 +00003177#define runcon_full_usage \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003178 "Run a program in a different security context\n\n" \
3179 " CONTEXT Complete security context\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003180 USE_GETOPT_LONG( \
3181 " -c,--compute Compute process transition context before modifying\n" \
3182 " -t,--type=TYPE Type (for same role as parent)\n" \
3183 " -u,--user=USER User identity\n" \
3184 " -r,--role=ROLE Role\n" \
3185 " -l,--range=RNG Levelrange" \
3186 ) \
3187 SKIP_GETOPT_LONG( \
3188 " -c Compute process transition context before modifying\n" \
3189 " -t TYPE Type (for same role as parent)\n" \
3190 " -u USER User identity\n" \
3191 " -r ROLE Role\n" \
3192 " -l RNG Levelrange" \
3193 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003194
Eric Andersen6cf47a72001-10-31 10:24:36 +00003195#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003196 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003197#define run_parts_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003198 "Run a bunch of scripts in a directory\n" \
3199 "\nOptions:" \
3200 "\n -t Print what would be run, but don't actually run anything" \
3201 "\n -a ARG Pass ARG as argument for every program" \
3202 "\n -u MASK Set the umask to MASK before running every program" \
3203 USE_FEATURE_RUN_PARTS_FANCY( \
3204 "\n -l Print names of all matching files even if they are not executable" \
3205 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003206
3207#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003208 "$ run-parts -a start /etc/init.d\n" \
3209 "$ run-parts -a stop=now /etc/init.d\n\n" \
3210 "Let's assume you have a script foo/dosomething:\n" \
3211 "#!/bin/sh\n" \
3212 "for i in $*; do eval $i; done; unset i\n" \
3213 "case \"$1\" in\n" \
3214 "start*) echo starting something;;\n" \
3215 "stop*) set -x; shutdown -h $stop;;\n" \
3216 "esac\n\n" \
3217 "Running this yields:\n" \
3218 "$run-parts -a stop=+4m foo/\n" \
3219 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003220
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003221#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003222 "[utmp]"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003223#define runlevel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003224 "Find the current and previous system runlevel.\n\n" \
3225 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003226 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003227#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003228 "$ runlevel /var/run/utmp\n" \
3229 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003230
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003231#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003232 "dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003233#define runsv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003234 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003235
3236#define runsvdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003237 "[-P] dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003238#define runsvdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003239 "Start a runsv process for each subdirectory"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003240
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003241#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003242 "FILE"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003243#define rx_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003244 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003245#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003246 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003247
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003248#define script_trivial_usage \
3249 "[-afq] [-c COMMAND] [OUTFILE]"
3250#define script_full_usage \
3251 "Options:" \
3252 "\n -a Append output" \
3253 "\n -c Run COMMAND, not shell" \
3254 "\n -f Flush output after each write" \
3255 "\n -q Quiet"
3256
Eric Andersen7e9276b2001-02-22 01:15:47 +00003257#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003258 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003259#define sed_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003260 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003261 " -e script Add the script to the commands to be executed\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003262 " -f scriptfile Add scriptfile contents to the\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003263 " commands to be executed\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003264 " -i Edit files in-place\n" \
3265 " -n Suppress automatic printing of pattern space\n" \
3266 " -r Use extended regular expression syntax\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003267 "\n" \
3268 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
3269 "script to interpret. All remaining arguments are names of input files; if no\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003270 "input files are specified, then the standard input is read. Source files\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003271 "will not be modified unless -i option is given."
Eric Andersenf802ff72004-04-12 15:12:06 +00003272
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003273#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003274 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3275 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003276
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003277#define selinuxenabled_trivial_usage
3278#define selinuxenabled_full_usage
3279
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003280#define sendmail_trivial_usage \
Denis Vlasenko17db1a92008-02-26 21:13:17 +00003281 "[-w timeout] [-U user] [-P password] [-X]\n" \
3282 "-t to [-t to]... [-n] [-s subject] [-c charset] server[:port] from [body] [attachment ...]"
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003283#define sendmail_full_usage \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00003284 "Send an email with optional attachments." \
3285 "\n\nOptions:\n" \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00003286 " -w timeout Set timeout on network operations\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003287 " -U username Authenticate with specified username/password\n" \
3288 " -P password\n" \
3289 " -t address Recipient(s). May be repeated\n" \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00003290 " -X Use openssl connection helper for secured servers\n" \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00003291 " -n Request delivery notification to sender\n" \
3292 " -s subject Subject\n" \
3293 " -c charset Assumed charset for body and subject [utf-8]"
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003294
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003295#define seq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003296 "[first [increment]] last"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003297#define seq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003298 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003299 "FIRST, INCREMENT default to 1" \
3300 "\n\nArguments:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003301 " LAST\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003302 " FIRST LAST\n" \
3303 " FIRST INCREMENT LAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003304
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003305#define sestatus_trivial_usage \
3306 "[-vb]"
3307#define sestatus_full_usage \
3308 "-v Verbose\n" \
3309 "-b Display current state of booleans"
3310
Paul Foxfc2256a2005-08-01 18:12:30 +00003311#define setconsole_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003312 "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Paul Foxfc2256a2005-08-01 18:12:30 +00003313#define setconsole_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003314 "Redirect system console output to DEVICE (default: /dev/tty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003315 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003316 " -r Reset output to /dev/console"
Paul Foxfc2256a2005-08-01 18:12:30 +00003317
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003318#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003319 "[Enforcing | Permissive | 1 | 0]"
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003320#define setenforce_full_usage
3321
Denis Vlasenko397137b2007-07-23 14:03:30 +00003322#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003323 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003324 USE_FEATURE_SETFILES_CHECK_OPTION( \
3325 " [-c policyfile] spec_file" \
3326 ) \
3327 " pathname"
3328
3329#define setfiles_full_usage \
3330 "Reset file contexts under pathname according to spec_file" \
3331 USE_FEATURE_SETFILES_CHECK_OPTION( \
3332 "\n -c file Check the validity of the contexts against the specified binary policy" \
3333 ) \
3334 "\n -d Show which specification matched each file" \
3335 "\n -l Log changes in file labels to syslog" \
3336 "\n -n Don't change any file labels" \
Denis Vlasenko1da77722007-07-24 06:17:43 +00003337 "\n -q Suppress warnings" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003338 "\n -r dir Use an altenate root path" \
3339 "\n -e dir Exclude directory" \
3340 "\n -F Force reset of context to match file_context for customizable files" \
3341 "\n -o file Save list of files with incorrect context" \
3342 "\n -s Take a list of files from standard input (instead of command line)" \
3343 "\n -v Show changes in file labels, if type or role are changing" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003344 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3345 "\n -W Display warnings about entries that had no matching files"
Denis Vlasenko397137b2007-07-23 14:03:30 +00003346
Eric Andersen7e9276b2001-02-22 01:15:47 +00003347#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003348 "SCANCODE KEYCODE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003349#define setkeycodes_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003350 "Set entries into the kernel's scancode-to-keycode map,\n" \
3351 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3352 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
3353 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003354#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003355 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003356
Rob Landley87848d92006-03-27 23:23:43 +00003357#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003358 "N"
Rob Landley87848d92006-03-27 23:23:43 +00003359#define setlogcons_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003360 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003361
Denis Vlasenkobe039372007-10-14 04:48:44 +00003362#define setsebool_trivial_usage \
3363 "boolean value"
3364
3365#define setsebool_full_usage \
3366 "Change boolean setting"
3367
Paul Fox42403642005-08-01 22:52:09 +00003368#define setsid_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003369 "program [arg...]"
Paul Fox42403642005-08-01 22:52:09 +00003370#define setsid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003371 "Run any program in a new session by calling setsid() before\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003372 "exec'ing the rest of its arguments. See setsid(2) for details."
Paul Fox42403642005-08-01 22:52:09 +00003373
Matt Kraai2d91deb2001-08-01 17:21:35 +00003374#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003375 "[FILE]...\n" \
3376 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00003377#define lash_full_usage \
Denis Vlasenko96702ca2007-11-23 23:28:55 +00003378 "lash is deprecated, please use hush"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003379
Eric Andersen2e9c2572003-08-08 22:26:06 +00003380#define last_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003381 ""
Eric Andersen2e9c2572003-08-08 22:26:06 +00003382#define last_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003383 "Show listing of the last users that logged into the system"
Eric Andersen2e9c2572003-08-08 22:26:06 +00003384
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003385#define sha1sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003386 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003387 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003388#define sha1sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003389 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003390 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003391 "\n\nOptions:\n" \
3392 USE_FEATURE_MD5_SHA1_SUM_CHECK( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003393 " -c Check SHA1 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003394 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003395 " -s Don't output anything, status code shows success\n" \
3396 " -w Warn about improperly formatted SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003397
Denis Vlasenko14923db2007-06-20 15:23:03 +00003398#define slattach_trivial_usage \
3399 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
3400#define slattach_full_usage \
3401 "Attach network interface(s) to serial line(s)\n" \
3402 "\nOptions:" \
3403 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3404 "\n -s Set line speed" \
3405 "\n -e Exit after initializing device" \
3406 "\n -h Exit when the carrier is lost" \
3407 "\n -c Execute a command when the line is hung up" \
3408 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3409 "\n -L Enable 3-wire operation" \
3410 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003411
Eric Andersen7e9276b2001-02-22 01:15:47 +00003412#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003413 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003414#define sleep_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003415 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003416 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003417 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003418 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003419#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003420 "$ sleep 2\n" \
3421 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003422 USE_FEATURE_FANCY_SLEEP( \
3423 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003424 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003425
Eric Andersen7e9276b2001-02-22 01:15:47 +00003426#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003427 "[-nru" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003428 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003429 "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003430#define sort_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003431 "Sort lines of text in the specified files" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003432 "\n\nOptions:" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003433 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003434 "\n -b Ignore leading blanks" \
3435 "\n -c Check whether input is sorted" \
3436 "\n -d Dictionary order (blank or alphanumeric only)" \
3437 "\n -f Ignore case" \
3438 "\n -g General numerical sort" \
3439 "\n -i Ignore unprintable characters" \
3440 "\n -k Sort key" \
3441 "\n -M Sort month" \
3442 ) \
3443 "\n -n Sort numbers" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003444 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003445 "\n -o Output to file" \
3446 "\n -k Sort by key" \
3447 "\n -t CHAR Key separator" \
3448 ) \
3449 "\n -r Reverse sort order" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003450 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003451 "\n -s Stable (don't sort ties alphabetically)" \
3452 ) \
3453 "\n -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003454 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003455 "\n -z Lines are terminated by NUL, not newline" \
3456 "\n -mST Ignored for GNU compatibility") \
3457
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003458#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003459 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3460 "a\n" \
3461 "b\n" \
3462 "c\n" \
3463 "d\n" \
3464 "e\n" \
3465 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003466 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003467 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3468 "d 2\n" \
3469 "b 2\n" \
3470 "c 3\n" \
3471 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003472 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003473
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003474#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003475 "[OPTION] [INPUT [PREFIX]]"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003476#define split_full_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003477 "Options:" \
3478 "\n -b n[k|m] Split by bytes" \
3479 "\n -l n Split by lines" \
3480 "\n -a n Use n letters as suffix"
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003481#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003482 "$ split TODO foo\n" \
3483 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003484
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003485#define start_stop_daemon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003486 "[OPTIONS] [" \
3487 USE_GETOPT_LONG("--start|--stop") SKIP_GETOPT_LONG("-S|-K") \
3488 "] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003489#define start_stop_daemon_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003490 "Start and stop services" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003491 "\n\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003492 USE_GETOPT_LONG( \
3493 "\n -S,--start Start" \
3494 "\n -K,--stop Stop" \
3495 "\n -a,--startas pathname Starts process specified by pathname" \
3496 "\n -b,--background Put process into background" \
3497 "\n -u,--user username|uid Stop this user's processes" \
3498 "\n -x,--exec executable Program to either start or check" \
3499 "\n -n,--name process-name Stop processes with this name" \
3500 "\n -p,--pidfile pid-file Save or load pid using a pid-file" \
3501 "\n -m,--make-pidfile Create the -p file and enter pid in it" \
3502 "\n -q,--quiet Quiet" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003503 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003504 "\n -o,--oknodo Exit status 0 if nothing done" \
3505 "\n -v,--verbose Verbose" \
3506 "\n -N,--nicelevel N Add N to process's nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003507 ) \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003508 "\n -s,--signal signal Signal to send (default TERM)" \
3509 "\n -c,--chuid user[:[grp]] Change to specified user/group" \
3510 ) \
3511 SKIP_GETOPT_LONG( \
3512 "\n -S Start" \
3513 "\n -K Stop" \
3514 "\n -a pathname Starts process specified by pathname" \
3515 "\n -b Put process into background" \
3516 "\n -u username|uid Stop this user's processes" \
3517 "\n -x executable Program to either start or check" \
3518 "\n -n process-name Stop processes with this name" \
3519 "\n -p pid-file Save or load pid using a pid-file" \
3520 "\n -m Create the -p file and enter pid in it" \
3521 "\n -q Quiet" \
3522 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3523 "\n -o Exit status 0 if nothing done" \
3524 "\n -v Verbose" \
3525 "\n -N N Add N to process's nice level" \
3526 ) \
3527 "\n -s signal Signal to send (default TERM)" \
3528 "\n -c user[:[grp]] Change to specified user/group" \
3529 )
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003530
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003531#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003532 "[OPTION] FILE..."
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003533#define stat_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003534 "Display file (default) or filesystem status" \
3535 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003536 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003537 " -c fmt Use the specified format\n") \
3538 " -f Display filesystem status\n" \
Bernhard Reutner-Fischer52432f22008-01-17 11:05:09 +00003539 " -L Dereference links\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003540 " -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003541 USE_SELINUX( \
3542 "\n -Z Print security context" \
3543 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003544 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003545 "\n\nValid format sequences for files:\n" \
3546 " %a Access rights in octal\n" \
3547 " %A Access rights in human readable form\n" \
3548 " %b Number of blocks allocated (see %B)\n" \
3549 " %B The size in bytes of each block reported by %b\n" \
3550 " %d Device number in decimal\n" \
3551 " %D Device number in hex\n" \
3552 " %f Raw mode in hex\n" \
3553 " %F File type\n" \
3554 " %g Group ID of owner\n" \
3555 " %G Group name of owner\n" \
3556 " %h Number of hard links\n" \
3557 " %i Inode number\n" \
3558 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003559 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003560 " %o I/O block size\n" \
3561 " %s Total size, in bytes\n" \
3562 " %t Major device type in hex\n" \
3563 " %T Minor device type in hex\n" \
3564 " %u User ID of owner\n" \
3565 " %U User name of owner\n" \
3566 " %x Time of last access\n" \
3567 " %X Time of last access as seconds since Epoch\n" \
3568 " %y Time of last modification\n" \
3569 " %Y Time of last modification as seconds since Epoch\n" \
3570 " %z Time of last change\n" \
3571 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003572 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003573 " %a Free blocks available to non-superuser\n" \
3574 " %b Total data blocks in file system\n" \
3575 " %c Total file nodes in file system\n" \
3576 " %d Free file nodes in file system\n" \
3577 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003578 USE_SELINUX( \
3579 " %C Security context in SELinux\n" \
3580 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003581 " %i File System ID in hex\n" \
3582 " %l Maximum length of filenames\n" \
3583 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003584 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003585 " %S Fundamental block size (for block counts)\n" \
3586 " %t Type in hex\n" \
3587 " %T Type in human readable form" \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003588 )
3589
Eric Andersenef5e8f82002-11-07 02:09:37 +00003590#define strings_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003591 "[-afo] [-n length] [file...]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003592#define strings_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003593 "Display printable strings in a binary file" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003594 "\n\nOptions:" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003595 "\n -a Scan whole file (default)" \
3596 "\n -f Precede strings with filenames" \
3597 "\n -n N At least N characters form a string (default 4)" \
3598 "\n -o Precede strings with decimal offsets"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003599
Eric Andersen7e9276b2001-02-22 01:15:47 +00003600#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003601 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003602#define stty_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003603 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003604 "and deviations from stty sane" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003605 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003606 "\n -F DEVICE Open device instead of stdin" \
3607 "\n -a Print all current settings in human-readable form" \
3608 "\n -g Print in stty-readable form" \
3609 "\n [SETTING] See manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003610
Robert Griebl1fca5582002-06-04 20:45:46 +00003611#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003612 "[OPTION]... [-] [username]"
Robert Griebl1fca5582002-06-04 20:45:46 +00003613#define su_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003614 "Change user id or become root" \
3615 "\n\nOptions:" \
3616 "\n -p, -m Preserve environment" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003617 "\n -c Command to pass to 'sh -c'" \
3618 "\n -s Shell to use instead of default shell"
Robert Griebl1fca5582002-06-04 20:45:46 +00003619
Eric Andersen27f64e12002-06-23 04:24:25 +00003620#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003621 "[OPTION]... [tty-device]"
Eric Andersen27f64e12002-06-23 04:24:25 +00003622#define sulogin_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003623 "Single user login" \
3624 "\n\nOptions:" \
3625 "\n -t Timeout"
Eric Andersen27f64e12002-06-23 04:24:25 +00003626
Mike Frysinger95d3c452005-04-21 23:29:24 +00003627#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003628 "[rs] [files...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003629#define sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003630 "Checksum and count the blocks in a file" \
3631 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003632 " -r Use BSD sum algorithm (1K blocks)\n" \
3633 " -s Use System V sum algorithm (512byte blocks)"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003634
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003635#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003636 "[-v] [-w sec] command service..."
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003637#define sv_full_usage \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003638 "Control services monitored by runsv supervisor.\n" \
3639 "Commands (only first character is enough):\n" \
3640 "\n" \
3641 "status: query service status\n" \
3642 "up: if service isn't running, start it. If service stops, restart it\n" \
3643 "once: like 'up', but if service stops, don't restart it\n" \
3644 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
3645 " if it exists. After it stops, do not restart service\n" \
3646 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
3647 " runsv exits too\n" \
3648 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
3649 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003650
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003651#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003652 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003653#define svlogd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003654 "Continuously read log data from standard input, optionally " \
3655 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003656 "rotated logs"
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003657
Eric Andersen7e9276b2001-02-22 01:15:47 +00003658#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003659 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003660#define swapoff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003661 "Stop swapping virtual memory pages on DEVICE" \
3662 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003663 " -a Stop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003664
Eric Andersen7e9276b2001-02-22 01:15:47 +00003665#define swapon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003666 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003667#define swapon_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003668 "Start swapping virtual memory pages on DEVICE" \
3669 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003670 " -a Start swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003671
Rob Landley0f34a822005-10-27 22:55:50 +00003672#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003673 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00003674#define switch_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003675 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003676 "and exec NEW_INIT" \
3677 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003678 " -c Redirect console to device on new root"
Rob Landley0f34a822005-10-27 22:55:50 +00003679
Eric Andersen7e9276b2001-02-22 01:15:47 +00003680#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003681 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003682#define sync_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003683 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003684
Eric Andersenb9050282003-12-24 06:02:11 +00003685#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003686 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003687#define sysctl_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003688 "Configure kernel parameters at runtime" \
3689 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003690 " -n Disable printing of key names\n" \
Denis Vlasenko64309f82007-11-29 06:40:28 +00003691 " -e Don't warn about unknown keys\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003692 " -w Change sysctl setting\n" \
3693 " -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)\n" \
3694 " -a Display all values\n" \
3695 " -A Display all values in table form"
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003696#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00003697 "sysctl [-n] [-e] variable...\n" \
3698 "sysctl [-n] [-e] -w variable=value...\n" \
3699 "sysctl [-n] [-e] -a\n" \
3700 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
3701 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003702
Eric Andersen7e9276b2001-02-22 01:15:47 +00003703#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003704 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003705#define syslogd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003706 "System logging utility.\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003707 "Note that this version of syslogd ignores /etc/syslog.conf.\n" \
3708 "\nOptions:" \
3709 "\n -n Run in foreground" \
3710 "\n -O FILE Log to given file (default=/var/log/messages)" \
3711 "\n -l n Set local log level" \
3712 "\n -S Smaller logging output" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003713 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003714 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3715 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003716 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003717 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
3718 "\n -L Log locally and via network (default is network only if -R)") \
3719 USE_FEATURE_SYSLOGD_DUP( \
3720 "\n -D Drop duplicates") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003721 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003722 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)")
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00003723 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003724/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003725#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003726 "$ syslogd -R masterlog:514\n" \
3727 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003728
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003729#define tac_trivial_usage \
3730 "[FILE]..."
3731#define tac_full_usage \
3732 "Concatenates FILE(s) and prints them to stdout in reverse"
3733
Eric Andersen7e9276b2001-02-22 01:15:47 +00003734#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003735 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003736#define tail_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003737 "Print last 10 lines of each FILE to standard output.\n" \
3738 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003739 "file name. With no FILE, or when FILE is -, read standard input." \
3740 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003741 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003742 "\n -c N[kbm] Output the last N bytes") \
3743 "\n -n N[kbm] Print last N lines instead of last 10" \
3744 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003745 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003746 "\n -q Never output headers giving file names" \
3747 "\n -s SEC Wait SEC seconds between reads with -f" \
3748 "\n -v Always output headers giving file names" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003749 "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003750 "If the first character of N (bytes or lines) is a '+', output begins with\n" \
3751 "the Nth item from the start of each file, otherwise, print the last N items\n" \
3752 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003753#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003754 "$ tail -n 1 /etc/resolv.conf\n" \
3755 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003756
Eric Andersen7e9276b2001-02-22 01:15:47 +00003757#define tar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003758 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_TAR_GZIP("z") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003759 USE_FEATURE_TAR_BZIP2("j") USE_FEATURE_TAR_LZMA("a") \
3760 USE_FEATURE_TAR_COMPRESS("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00003761 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003762 "[-f TARFILE] [-C DIR] [FILE(s)]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003763#define tar_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003764 "Create, extract, or list files from a tar file" \
3765 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003766 USE_FEATURE_TAR_CREATE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003767 " c Create\n") \
3768 " x Extract\n" \
3769 " t List\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003770 "\nArchive format selection:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003771 USE_FEATURE_TAR_GZIP( \
3772 " z Filter the archive through gzip\n") \
3773 USE_FEATURE_TAR_BZIP2( \
3774 " j Filter the archive through bzip2\n") \
3775 USE_FEATURE_TAR_LZMA( \
3776 " a Filter the archive through lzma\n") \
3777 USE_FEATURE_TAR_COMPRESS( \
3778 " Z Filter the archive through compress\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003779 "\nFile selection:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003780 " f Name of TARFILE or \"-\" for stdin\n" \
3781 " O Extract to stdout\n" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003782 USE_FEATURE_TAR_FROM( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003783 " exclude File to exclude\n" \
3784 " X File with names to exclude\n") \
3785 " C Change to directory DIR before operation\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003786 " v Verbose"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003787#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003788 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3789 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003790
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003791#define taskset_trivial_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003792 "[OPTIONS] [mask] [pid | command [arg]...]"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003793#define taskset_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003794 "Set or get CPU affinity" \
3795 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003796 " -p Operate on an existing PID"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003797#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003798 "$ taskset 0x7 ./dgemm_test&\n" \
3799 "$ taskset -p 0x1 $!\n" \
3800 "pid 4790's current affinity mask: 7\n" \
3801 "pid 4790's new affinity mask: 1\n" \
3802 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
3803 "pid 6671's current affinity mask: 1\n" \
3804 "pid 6671's new affinity mask: 1\n" \
3805 "$ taskset -p 1\n" \
3806 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003807
Eric Andersen7e9276b2001-02-22 01:15:47 +00003808#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003809 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003810#define tee_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003811 "Copy standard input to each FILE, and also to standard output" \
3812 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003813 " -a Append to the given FILEs, do not overwrite\n" \
3814 " -i Ignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003815#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003816 "$ echo \"Hello\" | tee /tmp/foo\n" \
3817 "$ cat /tmp/foo\n" \
3818 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003819
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003820#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00003821#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003822 "[-a] [-l USER] HOST [PORT]"
Eric Andersen539ffc92004-02-22 12:25:47 +00003823#define telnet_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003824 "Connect to telnet server\n" \
3825 "\nOptions:" \
3826 "\n -a Attempt an automatic login with USER variable" \
3827 "\n -l USER Attempt an automatic login with USER argument"
Eric Andersen539ffc92004-02-22 12:25:47 +00003828#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003829#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003830 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003831#define telnet_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003832 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00003833#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003834
Eric Andersen08a72202002-09-30 20:52:10 +00003835#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003836 "[OPTION]"
Eric Andersen08a72202002-09-30 20:52:10 +00003837#define telnetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003838 "Handle incoming telnet connections" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003839 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") \
3840 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003841 "\n -l LOGIN Exec LOGIN on connect" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003842 "\n -f issue_file Display issue_file instead of /etc/issue" \
Denis Vlasenko2450c452007-10-15 22:09:15 +00003843 "\n -K Close connection as soon as login exits" \
3844 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003845 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003846 "\n -p PORT Port to listen to" \
3847 "\n -b ADDR Address to bind to" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003848 "\n -F Run in foreground" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003849 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003850 )
Eric Andersen08a72202002-09-30 20:52:10 +00003851
Eric Andersen7e9276b2001-02-22 01:15:47 +00003852#define test_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003853 "EXPRESSION\n or [ EXPRESSION ]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003854#define test_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003855 "Check file types and compares values returning an exit code\n" \
3856 "determined by the value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003857#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003858 "$ test 1 -eq 2\n" \
3859 "$ echo $?\n" \
3860 "1\n" \
3861 "$ test 1 -eq 1\n" \
3862 "$ echo $?\n" \
3863 "0\n" \
3864 "$ [ -d /etc ]\n" \
3865 "$ echo $?\n" \
3866 "0\n" \
3867 "$ [ -d /junk ]\n" \
3868 "$ echo $?\n" \
3869 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003870
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003871#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003872 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003873/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003874/* "[-hpEvv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] [-i dir|-x cdb] [-t sec] ip port prog..." */
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003875#define tcpsvd_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003876 "Create TCP socket, bind it to ip:port and listen\n" \
3877 "for incoming connection. Run PROG for each connection.\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003878 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003879 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003880 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003881 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3882 "\n-u user[:group] Change to user/group after bind" \
3883 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003884 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003885 "\n-C n[:msg] Allow only up to n connections from the same IP" \
3886 "\n New connections from this IP address are closed" \
3887 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003888 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003889 "\n-E Do not set up environment variables" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003890 "\n-v Verbose"
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003891
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003892#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003893 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003894#define udpsvd_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003895 "Create UDP socket, bind it to ip:port and wait\n" \
3896 "for incoming packets. Run PROG for each packet,\n" \
3897 "redirecting all further packets with same peer ip:port to it\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003898 "\nip IP to listen on. '0' = all" \
3899 "\nport Port to listen on" \
3900 "\nprog [arg] Program to run" \
3901 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3902 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003903 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003904 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003905 "\n-E Do not set up environment variables" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003906 "\n-v Verbose"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003907
Mark Whitley450736c2001-03-02 19:08:50 +00003908#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003909 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00003910#define tftp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003911 "Transfer a file from/to tftp server using \"octet\" mode" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003912 "\n\nOptions:" \
3913 "\n -l FILE Local FILE" \
3914 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003915 USE_FEATURE_TFTP_GET( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003916 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003917 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003918 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003919 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00003920 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003921 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003922 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00003923 )
Eric Andersenc3657422001-11-30 07:54:32 +00003924#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003925 "[OPTION]... COMMAND [ARGS...]"
Eric Andersenc3657422001-11-30 07:54:32 +00003926#define time_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003927 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003928 "COMMAND's resource usage information is displayed." \
3929 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003930 " -v Verbose"
Mark Whitley450736c2001-03-02 19:08:50 +00003931
Eric Andersen420b2082002-09-17 22:14:58 +00003932#define top_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003933 "[-b] [-n COUNT] [-d SECONDS]"
Eric Andersen420b2082002-09-17 22:14:58 +00003934#define top_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003935 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003936 "Read the status of all processes from /proc each SECONDS\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003937 "and show the status for however many processes will fit on the screen."
Eric Andersen420b2082002-09-17 22:14:58 +00003938
Eric Andersen7e9276b2001-02-22 01:15:47 +00003939#define touch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003940 "[-c] FILE [FILE...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003941#define touch_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003942 "Update the last-modified date on the given FILE[s]" \
3943 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003944 " -c Do not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003945#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003946 "$ ls -l /tmp/foo\n" \
3947 "/bin/ls: /tmp/foo: No such file or directory\n" \
3948 "$ touch /tmp/foo\n" \
3949 "$ ls -l /tmp/foo\n" \
3950 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003951
3952#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003953 "[-cds] STRING1 [STRING2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003954#define tr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003955 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003956 "standard input, writing to standard output" \
3957 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003958 " -c Take complement of STRING1\n" \
3959 " -d Delete input characters coded STRING1\n" \
3960 " -s Squeeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003961#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003962 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
3963 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003964
Eric Andersen5c58d282001-07-10 16:29:00 +00003965#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003966 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
3967 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
3968 " [-z pausemsecs] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00003969#define traceroute_full_usage \
Denis Vlasenko7930bcf2007-10-07 19:13:55 +00003970 "Trace the route to \"host\"" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003971 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003972 " -F Set the don't fragment bit\n" \
3973 " -I Use ICMP ECHO instead of UDP datagrams\n" \
3974 " -l Display the ttl value of the returned packet\n" \
3975 " -d Set SO_DEBUG options to socket\n" \
3976 " -n Print hop addresses numerically rather than symbolically\n" \
3977 " -r Bypass the normal routing tables and send directly to a host\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003978 " -v Verbose\n" \
3979 " -m max_ttl Max time-to-live (max number of hops)\n" \
3980 " -p port# Base UDP port number used in probes\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003981 " (default is 33434)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003982 " -q nqueries Number of probes per 'ttl' (default 3)\n" \
3983 " -s src_addr IP address to use as the source address\n" \
3984 " -t tos Type-of-service in probe packets (default 0)\n" \
Denis Vlasenko7930bcf2007-10-07 19:13:55 +00003985 " -w wait Time in seconds to wait for a response\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003986 " (default 3 sec)\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003987 " -g Loose source route gateway (8 max)"
Eric Andersen5c58d282001-07-10 16:29:00 +00003988
Eric Andersen7e9276b2001-02-22 01:15:47 +00003989#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003990 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003991#define true_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003992 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003993#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003994 "$ true\n" \
3995 "$ echo $?\n" \
3996 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003997
Eric Andersen7e9276b2001-02-22 01:15:47 +00003998#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003999 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004000#define tty_full_usage \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004001 "Print file name of standard input's terminal" \
Bernhard Reutner-Fischer12f96c12007-01-20 21:34:24 +00004002 USE_INCLUDE_SUSv2( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004003 "\n\nOptions:\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004004 " -s Print nothing, only return exit status")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004005#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004006 "$ tty\n" \
4007 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004008
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004009#define ttysize_trivial_usage \
4010 "[w] [h]"
4011#define ttysize_full_usage \
4012 "Print dimension(s) of standard input's terminal, on error return 80x25"
4013
Mike Frysinger174808c2005-06-11 01:14:09 +00004014#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004015 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
4016 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
4017 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
4018 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
4019 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
4020 "[-T last-check-time] [-U UUID] device"
Mike Frysinger174808c2005-06-11 01:14:09 +00004021#define tune2fs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004022 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004023
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004024#define udhcpc_trivial_usage \
Denis Vlasenkoc82b5102007-07-01 17:05:57 +00004025 "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004026 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." USE_FEATURE_UDHCP_PORT(" [-P N]")
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004027#define udhcpc_full_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00004028 USE_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004029 " -V,--vendorclass=CLASSID Vendor class identifier" \
4030 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00004031 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004032 "\n -c,--clientid=CLIENTID Client identifier" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00004033 "\n -C,--clientid-none Suppress default client identifier" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004034 "\n -p,--pidfile=file Create pidfile" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00004035 "\n -r,--request=IP IP address to request" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004036 "\n -s,--script=file Run file at dhcp events (default /usr/share/udhcpc/default.script)" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004037 "\n -t,--retries=N Send up to N request packets" \
4038 "\n -T,--timeout=N Try to get a lease for N seconds (default 3)" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004039 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004040 "\n -f,--foreground Run in foreground" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004041 "\n -b,--background Background if lease is not immediately obtained" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00004042 "\n -S,--syslog Log to syslog too" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004043 "\n -n,--now Exit with failure if lease is not immediately obtained" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00004044 "\n -q,--quit Quit after obtaining lease" \
4045 "\n -R,--release Release IP on quit" \
Denis Vlasenko19183682007-12-10 07:03:38 +00004046 "\n -O,--request-option=OPT Request DHCP option OPT from server" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004047 USE_FEATURE_UDHCP_PORT( \
4048 "\n -P,--client-port N Use port N instead of default 68" \
4049 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004050 USE_FEATURE_UDHCPC_ARPING( \
4051 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004052 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004053 ) \
4054 SKIP_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004055 " -V CLASSID Vendor class identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004056 "\n -i INTERFACE Interface to use (default: eth0)" \
4057 "\n -H,-h HOSTNAME Client hostname" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004058 "\n -c CLIENTID Client identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004059 "\n -C Suppress default client identifier" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004060 "\n -p file Create pidfile" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004061 "\n -r IP IP address to request" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004062 "\n -s file Run file at dhcp events (default /usr/share/udhcpc/default.script)" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004063 "\n -t N Send up to N request packets" \
4064 "\n -T N Try to get a lease for N seconds (default 3)" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004065 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004066 "\n -f Run in foreground" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004067 "\n -b Background if lease is not immediately obtained" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004068 "\n -S Log to syslog too" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004069 "\n -n Exit with failure if lease is not immediately obtained" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004070 "\n -q Quit after obtaining lease" \
4071 "\n -R Release IP on quit" \
Denis Vlasenko19183682007-12-10 07:03:38 +00004072 "\n -O OPT Request DHCP option OPT from server" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004073 USE_FEATURE_UDHCP_PORT( \
4074 "\n -P N Use port N instead of default 68" \
4075 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004076 USE_FEATURE_UDHCPC_ARPING( \
4077 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004078 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004079 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004080
Russ Dill61fb4892002-10-14 21:41:28 +00004081#define udhcpd_trivial_usage \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004082 "[-fS]" USE_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004083
4084#define udhcpd_full_usage \
Denis Vlasenko9f7b92a2007-08-15 20:03:36 +00004085 "DHCP server" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004086 "\n -f Run in foreground" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004087 "\n -S Log to syslog too" \
4088 USE_FEATURE_UDHCP_PORT( \
4089 "\n -P N Use port N instead of default 67" \
4090 )
Russ Dill61fb4892002-10-14 21:41:28 +00004091
Eric Andersen7e9276b2001-02-22 01:15:47 +00004092#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004093 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004094#define umount_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004095 "Unmount file systems" \
4096 "\n\nOptions:\n" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00004097 USE_FEATURE_UMOUNT_ALL( \
4098 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab")) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004099 USE_FEATURE_MTAB_SUPPORT( \
4100 "\n -n Don't erase /etc/mtab entries") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004101 "\n -r Try to remount devices as read-only if mount is busy" \
4102 "\n -l Lazy umount (detach filesystem)" \
4103 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004104 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkob2e578a2008-02-14 12:00:21 +00004105 "\n -d Free loop device if it has been used")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004106#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004107 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004108
4109#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004110 "[-amnrspv]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004111#define uname_full_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004112 "Print system information." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004113 "\n\nOptions:\n" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004114 " -a Print all\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004115 " -m The machine (hardware) type\n" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004116 " -n Hostname\n" \
4117 " -r OS release\n" \
4118 " -s OS name (default)\n" \
4119 " -p Processor type\n" \
4120 " -v OS version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004121#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004122 "$ uname -a\n" \
4123 "Linux debian 2.4.23 #2 Tue Dec 23 17:09:10 MST 2003 i686 GNU/Linux\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004124
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004125#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004126 "[-c] [-f] [name...]"
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004127#define uncompress_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004128 "Uncompress .Z file[s]" \
4129 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004130 " -c Extract to stdout\n" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004131 " -f Overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00004132
Denis Vlasenko3952f202007-08-13 14:10:24 +00004133#define unexpand_trivial_usage \
4134 "[-f][-a][-t NUM] [FILE|-]"
4135#define unexpand_full_usage \
4136 "Convert spaces to tabs, writing to standard output." \
4137 "\n\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004138 USE_FEATURE_UNEXPAND_LONG_OPTIONS( \
4139 "\n -a,--all Convert all blanks" \
4140 "\n -f,--first-only Convert only leading blanks" \
4141 "\n -t,--tabs=N Tabstops every N chars" \
4142 ) \
4143 SKIP_FEATURE_UNEXPAND_LONG_OPTIONS( \
4144 "\n -a Convert all blanks" \
4145 "\n -f Convert only leading blanks" \
4146 "\n -t N Tabstops every N chars" \
4147 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004148
Eric Andersen7e9276b2001-02-22 01:15:47 +00004149#define uniq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004150 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004151#define uniq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004152 "Discard all but one of successive identical lines from INPUT\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004153 "(or standard input), writing to OUTPUT (or standard output)" \
4154 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004155 " -c Prefix lines by the number of occurrences\n" \
4156 " -d Only print duplicate lines\n" \
4157 " -u Only print unique lines\n" \
4158 " -f N Skip the first N fields\n" \
4159 " -s N Skip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004160#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004161 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4162 "a\n" \
4163 "b\n" \
4164 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004165
4166#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004167 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004168#define unix2dos_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004169 "Convert FILE from unix to dos format.\n" \
4170 "When no file is given, use stdin/stdout.\n" \
4171 "\nOptions:\n" \
4172 "\n -u dos2unix" \
4173 "\n -d unix2dos"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004174
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004175#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004176 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004177#define unzip_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004178 "Extract files from ZIP archives" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004179 "\n\nOptions:\n" \
Paul Fox9382b382007-09-07 20:28:25 +00004180 " -l List archive contents (with -q for short form)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004181 " -n Never overwrite existing files (default)\n" \
4182 " -o Overwrite files without prompting\n" \
4183 " -p Send output to stdout\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004184 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004185 " -x Exclude these files\n" \
4186 " -d Extract files into this directory"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004187
Eric Andersen7e9276b2001-02-22 01:15:47 +00004188#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004189 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004190#define uptime_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004191 "Display the time since the last boot"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004192#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004193 "$ uptime\n" \
4194 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004195
4196#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004197 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004198#define usleep_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004199 "Pause for N microseconds"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004200#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004201 "$ usleep 1000000\n" \
4202 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004203
4204#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004205 "[-o outfile] [infile]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004206#define uudecode_full_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004207 "Uudecode a file\n" \
4208 "NB: finds outfile name in uuencoded source unless -o is given"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004209#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004210 "$ uudecode -o busybox busybox.uu\n" \
4211 "$ ls -l busybox\n" \
4212 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004213
4214#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004215 "[-m] [infile] stored_filename"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004216#define uuencode_full_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004217 "Uuencode a file to stdout" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004218 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004219 " -m Use base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004220#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004221 "$ uuencode busybox busybox\n" \
4222 "begin 755 busybox\n" \
4223 "<encoded file snipped>\n" \
4224 "$ uudecode busybox busybox > busybox.uu\n" \
4225 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004226
Eric Andersen853c4942003-01-23 05:59:32 +00004227#define vconfig_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004228 "COMMAND [OPTIONS]..."
Eric Andersen853c4942003-01-23 05:59:32 +00004229#define vconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004230 "Create and remove virtual ethernet devices" \
4231 "\n\nOptions:\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004232 " add [interface-name] [vlan_id]\n" \
4233 " rem [vlan-name]\n" \
4234 " set_flag [interface-name] [flag-num] [0 | 1]\n" \
4235 " set_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
4236 " set_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
4237 " set_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00004238
Eric Andersen3f980402001-04-04 17:31:15 +00004239#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004240 "[OPTION] [FILE]..."
Eric Andersen3f980402001-04-04 17:31:15 +00004241#define vi_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004242 "Edit FILE" \
4243 "\n\nOptions:\n" \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004244 USE_FEATURE_VI_COLON( \
4245 " -c Initial command to run ($EXINIT also available)\n") \
4246 USE_FEATURE_VI_READONLY( \
4247 " -R Read-only - do not write to the file\n") \
4248 " -H Short help regarding available features"
Eric Andersen3f980402001-04-04 17:31:15 +00004249
Eric Andersen27f64e12002-06-23 04:24:25 +00004250#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004251 "[OPTIONS]"
Eric Andersen27f64e12002-06-23 04:24:25 +00004252#define vlock_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004253 "Lock a virtual terminal. A password is required to unlock." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004254 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004255 " -a Lock all VTs"
Eric Andersen27f64e12002-06-23 04:24:25 +00004256
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004257#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00004258 "[-n seconds] [-t] COMMAND..."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004259#define watch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004260 "Execute a program periodically" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004261 "\n\nOptions:\n" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004262 " -n Loop period in seconds (default 2)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004263 " -t Don't print header"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004264#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004265 "$ watch date\n" \
4266 "Mon Dec 17 10:31:40 GMT 2000\n" \
4267 "Mon Dec 17 10:31:42 GMT 2000\n" \
4268 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004269
Eric Andersen7e9276b2001-02-22 01:15:47 +00004270#define watchdog_trivial_usage \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004271 "[-t N[ms]] [-F] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004272#define watchdog_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004273 "Periodically write to watchdog device DEV" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004274 "\n\nOptions:" \
4275 "\n -t N Timer period (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004276 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004277 "\n" \
4278 "\nUse -t 500ms to specify period in milliseconds"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004279
4280#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004281 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00004282#define wc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004283 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004284 "more than one FILE is specified. With no FILE, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004285 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004286 " -c Print the byte counts\n" \
4287 " -l Print the newline counts\n" \
4288 " -L Print the length of the longest line\n" \
4289 " -w Print the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004290#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004291 "$ wc /etc/passwd\n" \
4292 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004293
4294#define wget_trivial_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00004295 USE_GETOPT_LONG( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004296 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004297 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4298 " [-U|--user-agent agent] url" \
4299 ) \
4300 SKIP_GETOPT_LONG( \
4301 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4302 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00004303#define wget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004304 "Retrieve files via HTTP or FTP" \
4305 "\n\nOptions:\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004306 " -s Spider mode - only check file existence\n" \
4307 " -c Continue retrieval of aborted transfer\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004308 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004309 " -P Set directory prefix to DIR\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004310 " -O Save to filename ('-' for stdout)\n" \
4311 " -U Adjust 'User-Agent' field\n" \
4312 " -Y Use proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004313
4314#define which_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004315 "[COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004316#define which_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004317 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004318#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004319 "$ which login\n" \
4320 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004321
Eric Andersen00a6a752002-04-26 23:53:10 +00004322#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004323 "[-a]"
Eric Andersen00a6a752002-04-26 23:53:10 +00004324#define who_full_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004325 "Show who is logged on" \
4326 "\n\nOptions:\n" \
4327 " -a show all"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004328
4329#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004330 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004331#define whoami_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004332 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004333
4334#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004335 "[OPTIONS] [COMMAND] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004336#define xargs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004337 "Execute COMMAND on every item given by standard input" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004338 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004339 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
4340 " -p Prompt the user about whether to run each command\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004341 " -r Do not run command for empty read lines\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004342 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
4343 " -x Exit if the size is exceeded\n") \
4344 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
4345 " -0 Input filenames are terminated by a null character\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004346 " -t Print the command line on stderr before executing it"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004347#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004348 "$ ls | xargs gzip\n" \
4349 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004350
4351#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004352 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00004353#define yes_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004354 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004355
Eric Andersen7e9276b2001-02-22 01:15:47 +00004356#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004357 "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004358#define zcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004359 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004360
Rob Landleyad8071f2005-04-30 03:49:37 +00004361#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004362 "[OPTIONS] ifname script"
Rob Landleyad8071f2005-04-30 03:49:37 +00004363#define zcip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004364 "Manage a ZeroConf IPv4 link-local address" \
4365 "\n\nOptions:\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004366 " -f Run in foreground\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004367 " -q Quit after address (no daemon)\n" \
4368 " -r 169.254.x.x Request this address first\n" \
4369 " -v Verbose"
Rob Landleyad8071f2005-04-30 03:49:37 +00004370
Eric Andersen178de172004-04-06 16:36:20 +00004371#endif /* __BB_USAGE_H__ */