blob: ec8f3c80865bd18c9b0bd2168d76ab77a2fb41a9 [file] [log] [blame]
Eric Andersenf349e972001-08-21 16:18:59 +00001#define addgroup_trivial_usage \
Eric Andersene0716ba2003-01-14 06:42:56 +00002 "[OPTIONS] group_name [user_name]"
Eric Andersenf349e972001-08-21 16:18:59 +00003#define addgroup_full_usage \
4 "Adds a group to the system" \
5 "Options:\n" \
6 "\t-g\t\tspecify gid\n"
7
8#define adduser_trivial_usage \
Eric Andersene0716ba2003-01-14 06:42:56 +00009 "[OPTIONS] user_name"
Eric Andersenf349e972001-08-21 16:18:59 +000010#define adduser_full_usage \
11 "Adds a user to the system" \
12 "Options:\n" \
Eric Andersenf0f754a2003-06-21 20:03:07 +000013 "\t-h DIR\t\tAssign home directory DIR\n" \
14 "\t-g GECOS\t\tAssign gecos field GECOS\n" \
15 "\t-s SHELL\t\tAssign login shell SHELL\n" \
16 "\t-G\t\tAdd the user to existing group GROUP\n" \
17 "\t-S\t\tcreate a system user (ignored)\n" \
18 "\t-D\t\tDo not assign a password (logins still possible via ssh)\n" \
19 "\t-H\t\tDo not create the home directory\n"
Eric Andersenf349e972001-08-21 16:18:59 +000020
Mark Whitley6f932772001-03-20 19:18:10 +000021#define adjtimex_trivial_usage \
22 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
23#define adjtimex_full_usage \
24 "Reads and optionally sets system timebase parameters.\n" \
25 "See adjtimex(2).\n\n" \
26 "Options:\n" \
27 "\t-q\t\tquiet mode - do not print\n" \
28 "\t-o offset\ttime offset, microseconds\n" \
29 "\t-f frequency\tfrequency adjust, integer kernel units (65536 is 1ppm)\n" \
30 "\t\t\t(positive values make the system clock run fast)\n" \
31 "\t-t tick\t\tmicroseconds per tick, usually 10000\n" \
32 "\t-p timeconstant\n"
33
Eric Andersen7e9276b2001-02-22 01:15:47 +000034#define ar_trivial_usage \
Glenn L McGrath62ebe2e2001-06-03 05:41:59 +000035 "-[ov][ptx] ARCHIVE FILES"
Eric Andersen7e9276b2001-02-22 01:15:47 +000036#define ar_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +000037 "Extract or list FILES from an ar archive.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +000038 "Options:\n" \
39 "\t-o\t\tpreserve original dates\n" \
40 "\t-p\t\textract to stdout\n" \
41 "\t-t\t\tlist\n" \
42 "\t-x\t\textract\n" \
Glenn L McGrathcda5cf12001-06-03 05:15:04 +000043 "\t-v\t\tverbosely list files processed\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000044
Glenn L McGrath9e598412003-01-09 10:06:01 +000045#define arping_trivial_usage \
46 "[-fqbDUA] [-c count] [-w timeout] [-I device] [-s sender] target\n"
47#define arping_full_usage \
48 "Ping hosts by ARP requests/replies.\n\n" \
49 "Options:\n" \
50 "\t-f\t\tQuit on first ARP reply\n" \
51 "\t-q\t\tBe quiet\n" \
52 "\t-b\t\tKeep broadcasting, don't go unicast\n" \
53 "\t-D\t\tDuplicated address detection mode\n" \
54 "\t-U\t\tUnsolicited ARP mode, update your neighbours\n" \
55 "\t-A\t\tARP answer mode, update your neighbours\n" \
56 "\t-c count\tStop after sending count ARP request packets\n" \
57 "\t-w timeout\tTime to wait for ARP reply, in seconds\n" \
58 "\t-I device\tOutgoing interface name, default is eth0\n" \
59 "\t-s sender\tSet specific sender IP address\n" \
60 "\ttarget\t\tTarget IP address of ARP request\n"
61
Eric Andersen08f59e32004-03-12 22:07:10 +000062#define ash_trivial_usage \
63 "[FILE]...\n" \
64 "or: ash -c command [args]...\n"
65#define ash_full_usage \
66 "The ash shell (command interpreter)"
67
68#define awk_trivial_usage \
69 "[OPTION]... [program-text] [FILE ...]"
70#define awk_full_usage \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000071 "Options:\n" \
Eric Andersen08f59e32004-03-12 22:07:10 +000072 "\t-v var=val\t\tassign value 'val' to variable 'var'\n" \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000073 "\t-F sep\t\tuse 'sep' as field separator\n" \
Eric Andersen08f59e32004-03-12 22:07:10 +000074 "\t-f progname\t\tread program source from file 'progname'\n"
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000075
Eric Andersen7e9276b2001-02-22 01:15:47 +000076#define basename_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000077 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000078#define basename_full_usage \
79 "Strips directory path and suffixes from FILE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000080 "If specified, also removes any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000081#define basename_example_usage \
82 "$ basename /usr/local/bin/foo\n" \
83 "foo\n" \
84 "$ basename /usr/local/bin/\n" \
85 "bin\n" \
86 "$ basename /foo/bar.txt .txt\n" \
87 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000088
Glenn L McGrath24e28332001-10-05 03:48:57 +000089#define bunzip2_trivial_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000090 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +000091#define bunzip2_full_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000092 "Uncompress FILE (or standard input if FILE is '-' or omitted).\n\n" \
93 "Options:\n" \
94 "\t-c\tWrite output to standard output\n" \
95 "\t-f\tForce"
Glenn L McGrath24e28332001-10-05 03:48:57 +000096
Glenn L McGrathfff11f12001-11-18 14:20:25 +000097#define bzcat_trivial_usage \
98 "FILE"
99#define bzcat_full_usage \
100 "Uncompress to stdout."
101
Eric Andersenc98c0622001-12-06 15:16:43 +0000102#define cal_trivial_usage \
103 "[-jy] [[month] year]"
104#define cal_full_usage \
105 "Display a calendar.\n" \
106 "\nOptions:\n" \
107 "\t-j\tUse julian dates.\n" \
108 "\t-y\tDisplay the entire year."
109
Eric Andersen7e9276b2001-02-22 01:15:47 +0000110#define cat_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000111 "[-u] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000112#define cat_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000113 "Concatenates FILE(s) and prints them to stdout.\n\n" \
114 "Options:\n" \
115 "\t-u\tignored since unbuffered i/o is always used"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000116#define cat_example_usage \
117 "$ cat /proc/uptime\n" \
118 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000119
Eric Andersen7e9276b2001-02-22 01:15:47 +0000120#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000121 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000122#define chgrp_full_usage \
123 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000124 "\nOptions:\n" \
125 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000126#define chgrp_example_usage \
127 "$ ls -l /tmp/foo\n" \
128 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
129 "$ chgrp root /tmp/foo\n" \
130 "$ ls -l /tmp/foo\n" \
131 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000132
Eric Andersen7e9276b2001-02-22 01:15:47 +0000133#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000134 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000135#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000136 "Each MODE is one or more of the letters ugoa, one of the\n" \
137 "symbols +-= and one or more of the letters rwxst.\n\n" \
138 "Options:\n" \
139 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000140#define chmod_example_usage \
141 "$ ls -l /tmp/foo\n" \
142 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
143 "$ chmod u+x /tmp/foo\n" \
144 "$ ls -l /tmp/foo\n" \
145 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
146 "$ chmod 444 /tmp/foo\n" \
147 "$ ls -l /tmp/foo\n" \
148 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000149
Eric Andersen7e9276b2001-02-22 01:15:47 +0000150#define chown_trivial_usage \
Eric Andersen238da242001-05-11 16:31:46 +0000151 "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000152#define chown_full_usage \
153 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000154 "\nOptions:\n" \
Eric Andersen238da242001-05-11 16:31:46 +0000155 "\t-R\tChanges files and directories recursively.\n" \
156 "\t-h\tDo not dereference symbolic links."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000157#define chown_example_usage \
158 "$ ls -l /tmp/foo\n" \
159 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
160 "$ chown root /tmp/foo\n" \
161 "$ ls -l /tmp/foo\n" \
162 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
163 "$ chown root.root /tmp/foo\n" \
164 "ls -l /tmp/foo\n" \
165 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000166
Eric Andersen7e9276b2001-02-22 01:15:47 +0000167#define chroot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000168 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000169#define chroot_full_usage \
170 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000171#define chroot_example_usage \
172 "$ ls -l /bin/ls\n" \
173 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
174 "$ mount /dev/hdc1 /mnt -t minix\n" \
175 "$ chroot /mnt\n" \
176 "$ ls -l /bin/ls\n" \
177 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000178
Eric Andersen7e9276b2001-02-22 01:15:47 +0000179#define chvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000180 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000181#define chvt_full_usage \
182 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000183
Eric Andersen7e9276b2001-02-22 01:15:47 +0000184#define clear_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000185 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000186#define clear_full_usage \
187 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000188
Eric Andersen7e9276b2001-02-22 01:15:47 +0000189#define cmp_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000190 "[OPTION]... FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000191#define cmp_full_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000192 "Compare files.\n\n" \
193 "Options:\n" \
194 "\t-l\tWrite the byte numbers (decimal) and values (octal)\n" \
195 "\t\t for all differing bytes.\n" \
196 "\t-s\tquiet mode - do not print"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000197
Eric Andersen7e9276b2001-02-22 01:15:47 +0000198#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000199 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000200#define cp_full_usage \
201 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
202 "\n" \
203 "\t-a\tSame as -dpR\n" \
204 "\t-d\tPreserves links\n" \
205 "\t-p\tPreserves file attributes if possible\n" \
206 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersenced97052004-02-20 09:55:37 +0000207 "\t-i\tinteractive, prompt before overwrite\n" \
208 "\t-R,-r\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000209
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000210#define cpio_trivial_usage \
211 "-[dimtuv][F cpiofile]"
212#define cpio_full_usage \
213 "Extract or list files from a cpio archive\n" \
214 "Main operation mode:\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000215 "\td\t\tmake leading directories\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000216 "\ti\t\textract\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000217 "\tm\t\tpreserve mtime\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000218 "\tt\t\tlist\n" \
Eric Andersen6925d502001-12-16 09:23:09 +0000219 "\tu\t\tunconditional overwrite\n" \
220 "\tF\t\tinput from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000221
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000222#define crond_trivial_usage \
223 "-d[#] -c <crondir> -f -b"
224#define crond_full_usage \
225 "\t-d [#] -l [#] -S -L logfile -f -b -c dir\n" \
226 "\t-d num\tdebug level\n" \
227 "\t-l num\tlog level (8 - default)\n" \
Glenn L McGrath2af30442003-09-12 10:58:54 +0000228 "\t-S\tlog to syslod (default)\n" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000229 "\t-L file\tlog to file\n" \
230 "\t-f\trun in fordeground\n" \
231 "\t-b\trun in background (default)\n" \
232 "\t-c dir\tworking dir"
233
234#define crontab_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000235 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000236#define crontab_full_usage \
237 "\tfile <opts> replace crontab from file\n" \
238 "\t- <opts> replace crontab from stdin\n" \
239 "\t-u user specify user\n" \
240 "\t-l [user] list crontab for user\n" \
241 "\t-e [user] edit crontab for user\n" \
242 "\t-d [user] delete crontab for user\n" \
243 "\t-c dir specify crontab directory"
244
245
Eric Andersen7e9276b2001-02-22 01:15:47 +0000246#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000247 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000248#define cut_full_usage \
249 "Prints selected fields from each input FILE to standard output.\n\n" \
250 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000251 "\t-b LIST\t\tOutput only bytes from LIST\n" \
252 "\t-c LIST\t\tOutput only characters from LIST\n" \
253 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
254 "\t-s\t\tOutput only the lines containing delimiter\n" \
255 "\t-f N\t\tPrint only these fields\n" \
256 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000257#define cut_example_usage \
258 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
259 "Hello\n" \
260 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
261 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000262
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000263#ifdef CONFIG_FEATURE_DATE_ISOFMT
264#define USAGE_DATE_ISOFMT(a) a
265#else
266#define USAGE_DATE_ISOFMT(a)
267#endif
268
Eric Andersen7e9276b2001-02-22 01:15:47 +0000269#define date_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +0000270 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000271#define date_full_usage \
272 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000273 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000274 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000275 "\t-d STRING\tDisplays time described by STRING, not `now'\n" \
276 USAGE_DATE_ISOFMT("\t-I[TIMESPEC]\tOutputs an ISO-8601 compliant date/time string.\n" \
277 "\t\t\tTIMESPEC=`date' (or missing) for date only,\n" \
278 "\t\t\t`hours', `minutes', or `seconds' for date and,\n" \
279 "\t\t\ttime to the indicated precision.\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000280 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000281 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000282#define date_example_usage \
283 "$ date\n" \
284 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000285
Eric Andersen7e9276b2001-02-22 01:15:47 +0000286#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000287 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000288#define dc_full_usage \
289 "This is a Tiny RPN calculator that understands the\n" \
Eric Andersena9287742003-10-22 11:24:39 +0000290 "following operations: +, add, -, sub, *, mul, /, div, %, mod, "\
291 "**, exp, and, or, not, eor.\n" \
292 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16.\n" \
293 "\nOptions:\n" \
Glenn L McGrath6d074322002-12-12 10:31:53 +0000294 "p - Prints the value on the top of the stack, without altering the stack.\n" \
295 "f - Prints the entire contents of the stack without altering anything.\n" \
296 "o - Pops the value off the top of the stack and uses it to set the output radix.\n" \
297 " Only 10 and 16 are supported.\n"
298
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000299#define dc_example_usage \
300 "$ dc 2 2 +\n" \
301 "4\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000302 "$ dc 8 8 * 2 2 + /\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000303 "16\n" \
304 "$ dc 0 1 and\n" \
305 "0\n" \
306 "$ dc 0 1 or\n" \
307 "1\n" \
308 "$ echo 72 9 div 8 mul | dc\n" \
309 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000310
Eric Andersen7e9276b2001-02-22 01:15:47 +0000311#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000312 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000313 "\t [seek=N] [conv=notrunc|noerror|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000314#define dd_full_usage \
315 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000316 "\tif=FILE\t\tread from FILE instead of stdin\n" \
317 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
318 "\tbs=N\t\tread and write N bytes at a time\n" \
319 "\tcount=N\t\tcopy only N input blocks\n" \
320 "\tskip=N\t\tskip N input blocks\n" \
321 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000322 "\tconv=notrunc\tdon't truncate output file\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000323 "\tconv=noerror\tcontinue after read errors\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000324 "\tconv=sync\tpad blocks with zeros\n" \
325 "\n" \
326 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000327 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000328#define dd_example_usage \
329 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
330 "4+0 records in\n" \
331 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000332
Eric Andersen7e9276b2001-02-22 01:15:47 +0000333#define deallocvt_trivial_usage \
Glenn L McGrath17b4a202004-01-15 11:50:19 +0000334 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000335#define deallocvt_full_usage \
336 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000337
Eric Andersenf349e972001-08-21 16:18:59 +0000338#define delgroup_trivial_usage \
339 "GROUP"
340#define delgroup_full_usage \
341 "Deletes group GROUP from the system"
342
343#define deluser_trivial_usage \
344 "USER"
345#define deluser_full_usage \
346 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000347
Eric Andersenf18bd892003-12-19 11:07:59 +0000348#ifdef CONFIG_DEVFSD_FG_NP
349 #define USAGE_DEVFSD_FG_NP(a) a
350#else
351 #define USAGE_DEVFSD_FG_NP(a)
352#endif
353
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000354#define devfsd_trivial_usage \
Eric Andersenf18bd892003-12-19 11:07:59 +0000355 "mntpnt [-v]"\
356 USAGE_DEVFSD_FG_NP("[-fg][-np]" )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000357#define devfsd_full_usage \
358 "Optional daemon for managing devfs (the Linux Device Filesystem).\n" \
359 "\nOptions:\n" \
360 "\tmntpnt\tThe mount point where devfs is mounted.\n\n" \
361 "\t-v\tPrint the protocol version numbers for devfsd\n" \
Eric Andersenf18bd892003-12-19 11:07:59 +0000362 "\t\tand the kernel-side protocol version and exits." \
363 USAGE_DEVFSD_FG_NP( "\n\n\t-fg\tRun the daemon in the foreground.\n\n" \
364 "\t-np\tExit after parsing the configuration file\n" \
365 "\t\tand processing synthetic REGISTER events.\n" \
366 "\t\tDo not poll for events.")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000367
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000368#ifdef CONFIG_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000369 #define USAGE_HUMAN_READABLE(a) a
370 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000371#else
Tim Riker7b253f82003-12-28 05:02:40 +0000372 #define USAGE_HUMAN_READABLE(a)
Eric Andersened0d9582001-02-23 13:23:03 +0000373 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000374#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000375#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000376 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000377#define df_full_usage \
378 "Print the filesystem space used and space available.\n\n" \
379 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000380 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000381 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
382 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000383 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000384 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000385#define df_example_usage \
386 "$ df\n" \
387 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
388 "/dev/sda3 8690864 8553540 137324 98% /\n" \
389 "/dev/sda1 64216 36364 27852 57% /boot\n" \
390 "$ df /dev/sda3\n" \
391 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
392 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000393
Eric Andersen7e9276b2001-02-22 01:15:47 +0000394#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000395 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000396#define dirname_full_usage \
397 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000398#define dirname_example_usage \
399 "$ dirname /tmp/foo\n" \
400 "/tmp\n" \
401 "$ dirname /tmp/foo/\n" \
402 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000403
Eric Andersen7e9276b2001-02-22 01:15:47 +0000404#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000405 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000406#define dmesg_full_usage \
407 "Prints or controls the kernel ring buffer\n\n" \
408 "Options:\n" \
409 "\t-c\t\tClears the ring buffer's contents after printing\n" \
410 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000411 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000412
Eric Andersen7e9276b2001-02-22 01:15:47 +0000413#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000414 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000415#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000416 "Converts FILE from dos format to unix format. When no option\n" \
417 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000418 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000419 "Options:\n" \
420 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000421 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000422
Eric Andersen7e9276b2001-02-22 01:15:47 +0000423#define dpkg_trivial_usage \
Eric Andersen9fe5f982002-04-13 14:48:51 +0000424 "-i package_file\n" \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000425 "[-CPru] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000426#define dpkg_full_usage \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000427 "\t-i\tInstall the package\n" \
428 "\t-C\tConfigure an unpackaged package\n" \
429 "\t-P\tPurge all files of a package\n" \
430 "\t-r\tRemove all but the configuration files for a package\n" \
431 "\t-u\tUnpack a package, but dont configure it\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000432
Eric Andersen7e9276b2001-02-22 01:15:47 +0000433#define dpkg_deb_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000434 "[-cefItxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000435#define dpkg_deb_full_usage \
436 "Perform actions on debian packages (.debs)\n\n" \
437 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000438 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000439 "\t-e\tExtract control files to [argument] directory\n" \
440 "\t-f\tDisplay control field name starting with [argument]\n" \
441 "\t-I\tDisplay the control filenamed [argument]\n" \
442 "\t-t\tExtract filesystem tree to stdout in tar format\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000443 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000444 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000445#define dpkg_deb_example_usage \
446 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000447
Glenn L McGrath17b4a202004-01-15 11:50:19 +0000448#define dpkg_divert_trivial_usage \
449 "blah"
450#define dpkg_divert_full_usage \
451 "blah blah"
452
Manuel Novoa III cad53642003-03-19 09:13:01 +0000453#ifdef CONFIG_FEATURE_DU_DEFALT_BLOCKSIZE_1K
454#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a) a
455#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a)
456#else
457#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a)
458#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a) a
459#endif
460
Eric Andersen7e9276b2001-02-22 01:15:47 +0000461#define du_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000462 "[-aHLdclsx" USAGE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000463#define du_full_usage \
464 "Summarizes disk space used for each FILE and/or directory.\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000465 "Disk space is printed in units of " \
466 USAGE_DU_DEFALT_BLOCKSIZE_1k("1024") USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k("512") \
467 " bytes.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000468 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000469 "\t-a\tshow sizes of files in addition to directories\n" \
470 "\t-H\tfollow symbolic links that are FILE command line args\n" \
471 "\t-L\tfollow all symbolic links encountered\n" \
472 "\t-d N\tlimit output to directories (and files with -a) of depth < N\n" \
473 "\t-c\toutput a grand total\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000474 "\t-l\tcount sizes many times if hard linked\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000475 "\t-s\tdisplay only a total for each argument\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000476 "\t-x\tskip directories on different filesystems\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000477 USAGE_HUMAN_READABLE( \
478 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
479 "\t-m\tprint sizes in megabytes\n" ) \
480 "\t-k\tprint sizes in kilobytes" USAGE_DU_DEFALT_BLOCKSIZE_1k("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000481#define du_example_usage \
482 "$ du\n" \
483 "16 ./CVS\n" \
484 "12 ./kernel-patches/CVS\n" \
485 "80 ./kernel-patches\n" \
486 "12 ./tests/CVS\n" \
487 "36 ./tests\n" \
488 "12 ./scripts/CVS\n" \
489 "16 ./scripts\n" \
490 "12 ./docs/CVS\n" \
491 "104 ./docs\n" \
492 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000493
Eric Andersen7e9276b2001-02-22 01:15:47 +0000494#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000495 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000496#define dumpkmap_full_usage \
497 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000498#define dumpkmap_example_usage \
499 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000500
Russ Dill61fb4892002-10-14 21:41:28 +0000501#define dumpleases_trivial_usage \
502 "[-r|-a] [-f LEASEFILE]"
503#define dumpleases_full_usage \
Russ Dill61fb4892002-10-14 21:41:28 +0000504 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
505 "\t-r,\t--remaining\tInterepret lease times as time remaing\n" \
506 "\t-a,\t--absolute\tInterepret lease times as expire time\n"
507
Manuel Novoa III cad53642003-03-19 09:13:01 +0000508#ifdef CONFIG_FEATURE_FANCY_ECHO
509 #define USAGE_FANCY_ECHO(a) a
510#else
Tim Riker7b253f82003-12-28 05:02:40 +0000511 #define USAGE_FANCY_ECHO(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +0000512#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000513
Eric Andersen7e9276b2001-02-22 01:15:47 +0000514#define echo_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000515 USAGE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000516#define echo_full_usage \
517 "Prints the specified ARGs to stdout\n\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000518 USAGE_FANCY_ECHO("Options:\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000519 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000520 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000521 "\t-E\tdisable interpretation of backslash-escaped characters")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000522#define echo_example_usage \
523 "$ echo "Erik is cool"\n" \
524 "Erik is cool\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000525 USAGE_FANCY_ECHO("$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000526 "Erik\n" \
527 "is\n" \
528 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000529 "$ echo "Erik\\nis\\ncool"\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000530 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000531
Eric Andersen84e229c2001-03-29 22:48:33 +0000532#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000533 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000534#define env_full_usage \
535 "Prints the current environment or runs a program after setting\n" \
536 "up the specified environment.\n\n" \
537 "Options:\n" \
538 "\t-, -i\tstart with an empty environment\n" \
539 "\t-u\tremove variable from the environment\n"
540
Eric Andersen7e9276b2001-02-22 01:15:47 +0000541#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000542 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000543#define expr_full_usage \
544 "Prints the value of EXPRESSION to standard output.\n\n" \
545 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000546 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
547 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
548 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
549 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
550 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
551 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
552 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
553 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
554 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
555 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
556 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
557 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
558 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000559 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
560 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
561 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
562 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
563 "\t or 0\n" \
564 "\tlength STRING length of STRING\n" \
565 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
566 "\t it is a keyword like `match' or an\n" \
567 "\t operator like `/'\n" \
568 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000569 "Beware that many operators need to be escaped or quoted for shells.\n" \
570 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
571 "lexicographical. Pattern matches return the string matched between \n" \
572 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
573 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000574
Eric Andersen7e9276b2001-02-22 01:15:47 +0000575#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000576 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000577#define false_full_usage \
578 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000579#define false_example_usage \
580 "$ false\n" \
581 "$ echo $?\n" \
582 "1\n"
583
584#define fbset_trivial_usage \
585 "[options] [mode]"
586#define fbset_full_usage \
587 "Show and modify frame buffer settings"
588#define fbset_example_usage \
589 "$ fbset\n" \
590 "mode "1024x768-76"\n" \
591 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
592 "\tgeometry 1024 768 1024 768 16\n" \
593 "\ttimings 12714 128 32 16 4 128 4\n" \
594 "\taccel false\n" \
595 "\trgba 5/11,6/5,5/0,0/0\n" \
596 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000597
Eric Andersen7e9276b2001-02-22 01:15:47 +0000598#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000599 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000600#define fdflush_full_usage \
601 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000602
Eric Andersen01c3d402003-07-05 07:51:31 +0000603#define fdformat_trivial_usage \
604 "[-n] DEVICE"
605#define fdformat_full_usage \
606 "Low-level formats a floppy disk\n\n" \
607 "Options:\n" \
608 "\t-n\tDon't verify after format"
609
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000610#define fdisk_trivial_usage \
611 "[-l] [-v] [-b SSZ] [-u] DISK"
612#define fdisk_full_usage \
613 "Change partition table\n" \
614 "Options:\n" \
615 "-l List partition table(s)\n" \
616 "-u Give Start and End in sector (instead of cylinder) units\n" \
617 "-s PARTITION Give partition size(s) in blocks\n" \
618 "-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
Glenn L McGrath062c74f2002-11-27 09:29:49 +0000619 "-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000620
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000621#ifdef CONFIG_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000622 #define USAGE_FIND_TYPE(a) a
623#else
624 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000625#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000626#ifdef CONFIG_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000627 #define USAGE_FIND_PERM(a) a
628#else
629 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000630#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000631#ifdef CONFIG_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000632 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000633#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000634 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000635#endif
Eric Andersen97d86f22003-01-23 05:27:42 +0000636#ifdef CONFIG_FEATURE_FIND_NEWER
637 #define USAGE_FIND_NEWER(a) a
638#else
639 #define USAGE_FIND_NEWER(a)
640#endif
641#ifdef CONFIG_FEATURE_FIND_INUM
642 #define USAGE_FIND_INUM(a) a
643#else
644 #define USAGE_FIND_INUM(a)
645#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000646
Eric Andersen7e9276b2001-02-22 01:15:47 +0000647#define find_trivial_usage \
648 "[PATH...] [EXPRESSION]"
649#define find_full_usage \
650 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000651 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000652 "\nEXPRESSION may consist of:\n" \
653 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000654 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000655 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000656 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000657 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
658) USAGE_FIND_PERM( \
659 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
660) USAGE_FIND_MTIME( \
Eric Andersen97d86f22003-01-23 05:27:42 +0000661 "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \
662) USAGE_FIND_NEWER( \
663 "\n\t-newer FILE\tModified time is more recent than FILE's" \
664) USAGE_FIND_INUM( \
665 "\n\t-inum N\t\tFile has inode number N")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000666#define find_example_usage \
667 "$ find / -name /etc/passwd\n" \
668 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000669
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000670#define fold_trivial_usage \
671 "[bsw] [FILE]"
672#define fold_full_usage \
673 "Wrap input lines in each FILE (standard input by default), writing to\n" \
674 "standard output.\n\n" \
675 "Options:\n" \
676 "\t-b\tcount bytes rather than columns\n" \
677 "\t-s\tbreak at spaces\n" \
678 "\t-w\tuse WIDTH columns instead of 80\n"
679
Eric Andersen7e9276b2001-02-22 01:15:47 +0000680#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000681 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000682#define free_full_usage \
683 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000684#define free_example_usage \
685 "$ free\n" \
686 " total used free shared buffers\n" \
687 " Mem: 257628 248724 8904 59644 93124\n" \
688 " Swap: 128516 8404 120112\n" \
689 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000690
Eric Andersen7e9276b2001-02-22 01:15:47 +0000691#define freeramdisk_trivial_usage \
692 "DEVICE"
693#define freeramdisk_full_usage \
694 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000695#define freeramdisk_example_usage \
696 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000697
698#define fsck_minix_trivial_usage \
699 "[-larvsmf] /dev/name"
700#define fsck_minix_full_usage \
701 "Performs a consistency check for MINIX filesystems.\n\n" \
702 "Options:\n" \
703 "\t-l\tLists all filenames\n" \
704 "\t-r\tPerform interactive repairs\n" \
705 "\t-a\tPerform automatic repairs\n" \
706 "\t-v\tverbose\n" \
707 "\t-s\tOutputs super-block information\n" \
708 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
709 "\t-f\tForce file system check."
710
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000711#define ftpget_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000712 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000713#define ftpget_full_usage \
714 "Retrieve a remote file via FTP.\n\n" \
715 "Options:\n" \
716 "\t-c, --continue Continue a previous transfer\n" \
717 "\t-v, --verbose Verbose\n" \
718 "\t-u, --username Username to be used\n" \
719 "\t-p, --password Password to be used\n" \
Tim Riker7b253f82003-12-28 05:02:40 +0000720 "\t-P, --port Port number to be used\n"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000721
722#define ftpput_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000723 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000724#define ftpput_full_usage \
725 "Store a local file on a remote machine via FTP.\n\n" \
726 "Options:\n" \
727 "\t-v, --verbose Verbose\n" \
728 "\t-u, --username Username to be used\n" \
729 "\t-p, --password Password to be used\n" \
Tim Riker7b253f82003-12-28 05:02:40 +0000730 "\t-P, --port Port number to be used\n"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000731
Eric Andersen7e9276b2001-02-22 01:15:47 +0000732#define getopt_trivial_usage \
733 "[OPTIONS]..."
734#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000735 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000736 "\t-a, --alternative Allow long options starting with single -\n" \
737 "\t-l, --longoptions=longopts Long options to be recognized\n" \
738 "\t-n, --name=progname The name under which errors are reported\n" \
739 "\t-o, --options=optstring Short options to be recognized\n" \
740 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
741 "\t-Q, --quiet-output No normal output\n" \
742 "\t-s, --shell=shell Set shell quoting conventions\n" \
743 "\t-T, --test Test for getopt(1) version\n" \
744 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000745#define getopt_example_usage \
746 "$ cat getopt.test\n" \
747 "#!/bin/sh\n" \
748 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
749 " -n 'example.busybox' -- "$@"`\n" \
750 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
751 "eval set -- "$GETOPT"\n" \
752 "while true ; do\n" \
753 " case $1 in\n" \
754 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000755 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000756 " -c|--c-long)\n" \
757 " case "$2" in\n" \
758 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000759 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000760 " esac ;;\n" \
761 " --) shift ; break ;;\n" \
762 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
763 " esac\n" \
764 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000765
Eric Andersenf349e972001-08-21 16:18:59 +0000766#define getty_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000767 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +0000768#define getty_full_usage \
769 "\nOpens a tty, prompts for a login name, then invokes /bin/login\n\n" \
770 "Options:\n" \
771 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
772 "\t-i\t\tDo not display /etc/issue before running login.\n" \
773 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
774 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
775 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
Glenn L McGrath49e74ef2003-05-13 14:59:07 +0000776 "\t-n\t\tDo not prompt the user for a login name.\n" \
777 "\t-f issue_file\tDisplay issue_file instead of /etc/issue.\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000778 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
779 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
780 "\t-I initstring\tSets the init string to send before anything else.\n" \
781 "\t-H login_host\tLog login_host into the utmp file as the hostname."
782
783
Eric Andersen7e9276b2001-02-22 01:15:47 +0000784#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000785 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000786#define grep_full_usage \
787 "Search for PATTERN in each FILE or standard input.\n\n" \
788 "Options:\n" \
789 "\t-H\tprefix output lines with filename where match was found\n" \
790 "\t-h\tsuppress the prefixing filename on output\n" \
791 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000792 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000793 "\t-n\tprint line number with output lines\n" \
794 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
795 "\t-v\tselect non-matching lines\n" \
796 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000797#define grep_example_usage \
798 "$ grep root /etc/passwd\n" \
799 "root:x:0:0:root:/root:/bin/bash\n" \
800 "$ grep ^[rR]oo. /etc/passwd\n" \
801 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000802
Eric Andersen7e9276b2001-02-22 01:15:47 +0000803#define gunzip_trivial_usage \
804 "[OPTION]... FILE"
805#define gunzip_full_usage \
806 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
807 "Options:\n" \
808 "\t-c\tWrite output to standard output\n" \
809 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000810#define gunzip_example_usage \
811 "$ ls -la /tmp/BusyBox*\n" \
812 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
813 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
814 "$ ls -la /tmp/BusyBox*\n" \
815 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000816
817#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000818 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000819#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000820 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000821 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000822 "Options:\n" \
823 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
824 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000825#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000826 "$ ls -la /tmp/busybox*\n" \
827 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
828 "$ gzip /tmp/busybox.tar\n" \
829 "$ ls -la /tmp/busybox*\n" \
830 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000831
832#define halt_trivial_usage \
833 ""
834#define halt_full_usage \
835 "Halt the system."
836
Eric Andersen3443bd72003-07-22 07:30:36 +0000837#ifdef CONFIG_FEATURE_HDPARM_GET_IDENTITY
838#define USAGE_HDPARM_IDENT(a) a
839#else
840#define USAGE_HDPARM_IDENT(a)
841#endif
842
843#ifdef CONFIG_FEATURE_HDPARM_HDIO_SCAN_HWIF
844#define USAGE_SCAN_HWIF(a) a
845#else
846#define USAGE_SCAN_HWIF(a)
847#endif
848
849#ifdef CONFIG_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF
850#define USAGE_UNREGISTER_HWIF(a) a
851#else
852#define USAGE_UNREGISTER_HWIF(a)
853#endif
854
855#ifdef CONFIG_FEATURE_HDPARM_HDIO_DRIVE_RESET
856#define USAGE_DRIVE_RESET(a) a
857#else
858#define USAGE_DRIVE_RESET(a)
859#endif
860
861#ifdef CONFIG_FEATURE_HDPARM_HDIO_TRISTATE_HWIF
862#define USAGE_TRISTATE_HWIF(a) a
863#else
864#define USAGE_TRISTATE_HWIF(a)
865#endif
866
Eric Andersen0a57a792003-08-06 08:57:35 +0000867#ifdef CONFIG_FEATURE_HDPARM_HDIO_GETSET_DMA
868#define USAGE_GETSET_DMA(a) a
869#else
870#define USAGE_GETSET_DMA(a)
871#endif
872
Eric Andersen3443bd72003-07-22 07:30:36 +0000873#define hdparm_trivial_usage \
874 "[options] [device] .."
875#define hdparm_full_usage \
876 "Options:" \
877 " -a get/set fs readahead\n" \
878 " -A set drive read-lookahead flag (0/1)\n" \
879 " -b get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
880 " -B set Advanced Power Management setting (1-255)\n" \
881 " -c get/set IDE 32-bit IO setting\n" \
882 " -C check IDE power mode status\n" \
Eric Andersen0a57a792003-08-06 08:57:35 +0000883 USAGE_GETSET_DMA(" -d get/set using_dma flag\n") \
Eric Andersen3443bd72003-07-22 07:30:36 +0000884 " -D enable/disable drive defect-mgmt\n" \
885 " -f flush buffer cache for device on exit\n" \
886 " -g display drive geometry\n" \
887 " -h display terse usage information\n" \
888 " -i display drive identification\n" \
889 USAGE_HDPARM_IDENT(" -I detailed/current information directly from drive\n") \
890 USAGE_HDPARM_IDENT(" -Istdin similar to -I, but wants /proc/ide/" "*" "/hd?/identify as input\n") \
891 " -k get/set keep_settings_over_reset flag (0/1)\n" \
892 " -K set drive keep_features_over_reset flag (0/1)\n" \
893 " -L set drive doorlock (0/1) (removable harddisks only)\n" \
894 " -m get/set multiple sector count\n" \
895 " -n get/set ignore-write-errors flag (0/1)\n" \
896 " -p set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
897 " -P set drive prefetch count\n" \
898 " -q change next setting quietly\n" \
899 " -Q get/set DMA tagged-queuing depth (if supported)\n" \
900 " -r get/set readonly flag (DANGEROUS to set)\n" \
901 USAGE_SCAN_HWIF(" -R register an IDE interface (DANGEROUS)\n") \
902 " -S set standby (spindown) timeout\n" \
903 " -t perform device read timings\n" \
904 " -T perform cache read timings\n" \
905 " -u get/set unmaskirq flag (0/1)\n" \
906 USAGE_UNREGISTER_HWIF(" -U un-register an IDE interface (DANGEROUS)\n") \
907 " -v defaults; same as -mcudkrag for IDE drives\n" \
908 " -V display program version and exit immediately\n" \
909 USAGE_DRIVE_RESET(" -w perform device reset (DANGEROUS)\n") \
910 " -W set drive write-caching flag (0/1) (DANGEROUS)\n" \
911 USAGE_TRISTATE_HWIF(" -x tristate device for hotswap (0/1) (DANGEROUS)\n") \
912 " -X set IDE xfer mode (DANGEROUS)\n" \
913 " -y put IDE drive in standby mode\n" \
914 " -Y put IDE drive to sleep\n" \
915 " -Z disable Seagate auto-powersaving mode\n" \
916 " -z re-read partition table\n"
917
Manuel Novoa III cad53642003-03-19 09:13:01 +0000918#ifdef CONFIG_FEATURE_FANCY_HEAD
919#define USAGE_FANCY_HEAD(a) a
920#else
921#define USAGE_FANCY_HEAD(a)
922#endif
923
Eric Andersen7e9276b2001-02-22 01:15:47 +0000924#define head_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000925 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000926#define head_full_usage \
927 "Print first 10 lines of each FILE to standard output.\n" \
928 "With more than one FILE, precede each with a header giving the\n" \
929 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000930 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000931 "\t-n NUM\t\tPrint first NUM lines instead of first 10" \
932 USAGE_FANCY_HEAD( \
933 "\n\t-c NUM\t\toutput the first NUM bytes\n" \
934 "\t-q\t\tnever output headers giving file names\n" \
935 "\t-v\t\talways output headers giving file names" )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000936#define head_example_usage \
937 "$ head -n 2 /etc/passwd\n" \
938 "root:x:0:0:root:/root:/bin/bash\n" \
939 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000940
Glenn L McGrath60281112001-11-02 11:39:46 +0000941#define hexdump_trivial_usage \
942 "[-[bcdefnosvx]] [OPTION] FILE"
943#define hexdump_full_usage \
944 "The hexdump utility is a filter which displays the specified files,\n" \
945 "or the standard input, if no files are specified, in a user specified\n"\
946 "format\n" \
947 "\t-b\t\tOne-byte octal display\n" \
948 "\t-c\t\tOne-byte character display\n" \
949 "\t-d\t\tTwo-byte decimal display\n" \
950 "\t-e FORMAT STRING\n" \
951 "\t-f FORMAT FILE\n" \
952 "\t-n LENGTH\tInterpret only length bytes of input\n" \
953 "\t-o\t\tTwo-byte octal display\n" \
954 "\t-s OFFSET\tSkip offset byte\n" \
955 "\t-v\t\tdisplay all input data\n" \
956 "\t-x\t\tTwo-byte hexadecimal display\n"
957
Eric Andersen7e9276b2001-02-22 01:15:47 +0000958#define hostid_trivial_usage \
959 ""
960#define hostid_full_usage \
961 "Print out a unique 32-bit identifier for the machine."
962
963#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000964 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000965#define hostname_full_usage \
966 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000967 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000968 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +0000969 "\t-s\tShort\n" \
970 "\t-i\tAddresses for the hostname\n" \
971 "\t-d\tDNS domain name\n" \
972 "\t-f\tFully qualified domain name\n" \
973 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000974#define hostname_example_usage \
975 "$ hostname\n" \
Eric Andersen08f59e32004-03-12 22:07:10 +0000976 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +0000977
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000978#ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH
979 #define USAGE_HTTPD_BASIC_AUTH(a) a
Eric Andersen40520512003-07-28 09:59:05 +0000980 #ifdef CONFIG_FEATURE_HTTPD_AUTH_MD5
981 #define USAGE_HTTPD_AUTH_MD5(a) a
982 #else
983 #define USAGE_HTTPD_AUTH_MD5(a)
984 #endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000985#else
986 #define USAGE_HTTPD_BASIC_AUTH(a)
Eric Andersen40520512003-07-28 09:59:05 +0000987 #define USAGE_HTTPD_AUTH_MD5(a)
988#endif
989#ifdef CONFIG_FEATURE_HTTPD_USAGE_FROM_INETD_ONLY
990 #define USAGE_HTTPD_STANDALONE(a)
991 #define USAGE_HTTPD_SETUID(a)
992#else
993 #define USAGE_HTTPD_STANDALONE(a) a
994 #ifdef CONFIG_FEATURE_HTTPD_SETUID
995 #define USAGE_HTTPD_SETUID(a) a
996 #else
997 #define USAGE_HTTPD_SETUID(a)
998 #endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000999#endif
1000#define httpd_trivial_usage \
Eric Andersen40520512003-07-28 09:59:05 +00001001 "[-c <conf file>]" \
1002 USAGE_HTTPD_STANDALONE(" [-p <port>]") \
1003 USAGE_HTTPD_SETUID(" [-u user]") \
1004 USAGE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
1005 USAGE_HTTPD_AUTH_MD5(" [-m pass]") \
1006 " [-d/-e <string>]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001007#define httpd_full_usage \
1008 "Listens for incoming http server requests.\n"\
1009 "Options:\n" \
Eric Andersen40520512003-07-28 09:59:05 +00001010 "\t-c FILE\tSpecifies configuration file. (default httpd.conf)\n" \
1011 USAGE_HTTPD_STANDALONE("\t-p PORT\tServer port (default 80)\n") \
1012 USAGE_HTTPD_SETUID("\t-u USER\tSet uid to USER after listening privilegies port\n") \
1013 USAGE_HTTPD_BASIC_AUTH("\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
1014 USAGE_HTTPD_AUTH_MD5("\t-m PASS\tCrypt PASS with md5 algorithm\n") \
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001015 "\t-e STRING\tHtml encode STRING\n" \
Eric Andersen40520512003-07-28 09:59:05 +00001016 "\t-d STRING\tURL decode STRING"
1017
Robert Griebl1cd04452002-07-21 16:50:49 +00001018#define hwclock_trivial_usage \
1019 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
1020#define hwclock_full_usage \
1021 "Query and set the hardware clock (RTC)\n\n" \
1022 "Options:\n" \
1023 "\t-r\tread hardware clock and print result\n" \
1024 "\t-s\tset the system time from the hardware clock\n" \
1025 "\t-w\tset the hardware clock to the current system time\n" \
1026 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
1027 "\t-l\tthe hardware clock is kept in local time"
1028
Eric Andersen9e480452003-07-03 10:07:04 +00001029#ifdef CONFIG_SELINUX
1030#define USAGE_SELINUX(a, b) a
1031#else
1032#define USAGE_SELINUX(a, b) b
1033#endif
1034
Eric Andersen7e9276b2001-02-22 01:15:47 +00001035#define id_trivial_usage \
1036 "[OPTIONS]... [USERNAME]"
1037#define id_full_usage \
1038 "Print information for USERNAME or the current user\n\n" \
1039 "Options:\n" \
1040 "\t-g\tprints only the group ID\n" \
1041 "\t-u\tprints only the user ID\n" \
Eric Andersen9e480452003-07-03 10:07:04 +00001042 USAGE_SELINUX("\t-c\tprints only the security context\n", "") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001043 "\t-n\tprint a name instead of a number (with for -ug)\n" \
1044 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001045#define id_example_usage \
1046 "$ id\n" \
1047 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001048
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001049#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001050 #define USAGE_SIOCSKEEPALIVE(a) a
1051#else
1052 #define USAGE_SIOCSKEEPALIVE(a)
1053#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001054#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001055 #define USAGE_IFCONFIG_MII(a) a
1056#else
1057 #define USAGE_IFCONFIG_MII(a)
1058#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001059#ifdef CONFIG_FEATURE_IFCONFIG_HW
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001060 #define USAGE_IFCONFIG_HW(a) a
1061#else
1062 #define USAGE_IFCONFIG_HW(a)
1063#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001064#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001065 #define USAGE_IFCONFIG_OPT_A(a) a
1066#else
1067 #define USAGE_IFCONFIG_OPT_A(a)
1068#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +00001069#ifdef CONFIG_FEATURE_IPV6
1070 #define USAGE_IPV6(a) a
1071#else
1072 #define USAGE_IPV6(a)
1073#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001074
Eric Andersen7e9276b2001-02-22 01:15:47 +00001075#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001076 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001077#define ifconfig_full_usage \
1078 "configure a network interface\n\n" \
1079 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +00001080 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
1081 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001082 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001083 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001084 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001085 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
1086 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001087 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001088 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
1089 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001090 "\t[up|down] ..."
1091
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001092#define ifup_trivial_usage \
1093 "<-ahinv> <ifaces...>"
1094#define ifup_full_usage \
1095 "Usage: ifup <options> <ifaces...>\n\n" \
1096 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001097 "\t-h\tthis help\n" \
1098 "\t-a\tde/configure all interfaces automatically\n" \
1099 "\t-i FILE\tuse FILE for interface definitions\n" \
1100 "\t-n\tprint out what would happen, but don't do it\n" \
1101 "\t\t\t(note that this option doesn't disable mappings)\n" \
1102 "\t-v\tprint out what would happen before doing it\n" \
1103 "\t-m\tdon't run any mappings\n" \
1104 "\t-f\tforce de/configuration\n"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001105
1106#define ifdown_trivial_usage \
1107 "<-ahinv> <ifaces...>"
1108#define ifdown_full_usage \
1109 "Usage: ifdown <options> <ifaces...>\n\n" \
1110 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001111 "\t-h\tthis help\n" \
1112 "\t-a\tde/configure all interfaces automatically\n" \
1113 "\t-i FILE\tuse FILE for interface definitions\n" \
1114 "\t-n\tprint out what would happen, but don't do it\n" \
1115 "\t\t(note that this option doesn't disable mappings)\n" \
1116 "\t-v\tprint out what would happen before doing it\n" \
1117 "\t-m\tdon't run any mappings\n" \
1118 "\t-f\tforce de/configuration\n"
Tim Riker7b253f82003-12-28 05:02:40 +00001119
Glenn L McGrath06e95652003-02-09 06:51:14 +00001120#define inetd_trivial_usage \
1121 "[-q len] [conf]"
1122#define inetd_full_usage \
1123 "Usage: [-q len] [conf]\n\n" \
1124 "Option:\n" \
1125 "\t-q\tSets the size of the socket listen queue to\n" \
1126 "the specified value. Default is 128."
1127
Eric Andersen7e9276b2001-02-22 01:15:47 +00001128#define init_trivial_usage \
1129 ""
1130#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001131 "Init is the parent of all processes."
1132#define init_notes_usage \
1133"This version of init is designed to be run only by the kernel.\n" \
1134"\n" \
1135"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
1136"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
1137"runlevels, use sysvinit.\n" \
1138"\n" \
1139"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
1140"it has the following default behavior:\n" \
1141"\n" \
1142" ::sysinit:/etc/init.d/rcS\n" \
1143" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001144" ::ctrlaltdel:/sbin/reboot\n" \
1145" ::shutdown:/sbin/swapoff -a\n" \
1146" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001147" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001148"\n" \
1149"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1150"\n" \
1151" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001152" tty3::askfirst:/bin/sh\n" \
1153" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001154"\n" \
1155"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1156"\n" \
1157" <id>:<runlevels>:<action>:<process>\n" \
1158"\n" \
1159" <id>: \n" \
1160"\n" \
1161" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1162" The id field is used by BusyBox init to specify the controlling tty for\n" \
1163" the specified process to run on. The contents of this field are\n" \
1164" appended to "/dev/" and used as-is. There is no need for this field to\n" \
1165" be unique, although if it isn't you may have strange results. If this\n" \
1166" field is left blank, the controlling tty is set to the console. Also\n" \
1167" note that if BusyBox detects that a serial console is in use, then only\n" \
1168" entries whose controlling tty is either the serial console or /dev/null\n" \
1169" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1170" stinkin' utmp.\n" \
1171"\n" \
1172" <runlevels>: \n" \
1173"\n" \
1174" The runlevels field is completely ignored.\n" \
1175"\n" \
1176" <action>: \n" \
1177"\n" \
1178" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001179" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001180"\n" \
1181" The available actions can be classified into two groups: actions\n" \
1182" that are run only once, and actions that are re-run when the specified\n" \
1183" process exits.\n" \
1184"\n" \
1185" Run only-once actions:\n" \
1186"\n" \
1187" 'sysinit' is the first item run on boot. init waits until all\n" \
1188" sysinit actions are completed before continuing. Following the\n" \
1189" completion of all sysinit actions, all 'wait' actions are run.\n" \
1190" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001191" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001192" therefore, init does not wait for them to complete. 'restart' is\n" \
1193" the action taken to restart the init process. By default this should\n" \
1194" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1195" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001196" actions are run when the system detects that someone on the system\n" \
1197" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1198" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1199" Finally the 'shutdown' action specifies the actions to taken when\n" \
1200" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1201" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001202"\n" \
1203" Run repeatedly actions:\n" \
1204"\n" \
1205" 'respawn' actions are run after the 'once' actions. When a process\n" \
1206" started with a 'respawn' action exits, init automatically restarts\n" \
1207" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1208" respawning out of control. The 'askfirst' actions acts just like\n" \
1209" respawn, except that before running the specified process it\n" \
1210" displays the line "Please press Enter to activate this console."\n" \
1211" and then waits for the user to press enter before starting the\n" \
1212" specified process. \n" \
1213"\n" \
1214" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1215" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001216" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001217"\n" \
1218" <process>: \n" \
1219"\n" \
1220" Specifies the process to be executed and it's command line.\n" \
1221"\n" \
1222"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001223"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001224" # This is run first except when booting in single-user mode.\n" \
1225" #\n" \
1226" ::sysinit:/etc/init.d/rcS\n" \
1227" \n" \
1228" # /bin/sh invocations on selected ttys\n" \
1229" #\n" \
1230" # Start an "askfirst" shell on the console (whatever that may be)\n" \
1231" ::askfirst:-/bin/sh\n" \
1232" # Start an "askfirst" shell on /dev/tty2-4\n" \
1233" tty2::askfirst:-/bin/sh\n" \
1234" tty3::askfirst:-/bin/sh\n" \
1235" tty4::askfirst:-/bin/sh\n" \
1236" \n" \
1237" # /sbin/getty invocations for selected ttys\n" \
1238" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001239" tty4::respawn:/sbin/getty 38400 tty4\n" \
1240" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001241" \n" \
1242" \n" \
1243" # Example of how to put a getty on a serial line (for a terminal)\n" \
1244" #\n" \
1245" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1246" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1247" #\n" \
1248" # Example how to put a getty on a modem line.\n" \
1249" #::respawn:/sbin/getty 57600 ttyS2\n" \
1250" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001251" # Stuff to do when restarting the init process\n" \
1252" ::restart:/sbin/init\n" \
1253" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001254" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001255" ::ctrlaltdel:/sbin/reboot\n" \
1256" ::shutdown:/bin/umount -a -r\n" \
1257" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001258
Eric Andersenbe65c352003-01-23 04:57:35 +00001259#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
1260 #define USAGE_INSMOD_MAP(a) a
1261#else
1262 #define USAGE_INSMOD_MAP(a)
1263#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001264#define insmod_trivial_usage \
1265 "[OPTION]... MODULE [symbol=value]..."
1266#define insmod_full_usage \
1267 "Loads the specified kernel modules into the kernel.\n\n" \
1268 "Options:\n" \
1269 "\t-f\tForce module to load into the wrong kernel version.\n" \
1270 "\t-k\tMake module autoclean-able.\n" \
1271 "\t-v\tverbose output\n" \
1272 "\t-L\tLock to prevent simultaneous loads of a module\n" \
Eric Andersenbe65c352003-01-23 04:57:35 +00001273 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout") \
1274 "\t-x\tdo not export externs\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001275
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001276#define install_trivial_usage \
1277 "[cgmops] [sources] <dest|directory>"
1278#define install_full_usage \
1279 "copy files and set attributes\n\n" \
1280 "Options:\n" \
1281 "\t-c\tcopy the file, default\n" \
1282 "\t-g\tset group ownership\n" \
1283 "\t-m\tset permission modes\n" \
1284 "\t-o\tset ownership\n" \
1285 "\t-p\tpreserve date\n" \
1286 "\t-s\tstrip symbol tables\n"
1287
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001288#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001289 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001290#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001291 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1292 "where OBJECT := { link | addr | route | tunnel }\n" \
1293 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }\n"
1294
1295#define ipaddr_trivial_usage \
1296 "{ {add|del} IFADDR dev STRING | {show|flush} [ dev STRING ] [ to PREFIX ] }"
1297#define ipaddr_full_usage \
1298 "ipaddr {add|del} IFADDR dev STRING\n" \
1299 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
1300 " [ to PREFIX ] [ label PATTERN ]\n" \
1301 "IFADDR := PREFIX | ADDR peer PREFIX\n" \
1302 " [ broadcast ADDR ] [ anycast ADDR ]\n" \
1303 " [ label STRING ] [ scope SCOPE-ID ]\n" \
1304 "SCOPE-ID := [ host | link | global | NUMBER ]\n"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001305
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001306#ifndef CONFIG_FEATURE_IPCALC_FANCY
Eric Andersende4f07e2003-12-11 01:18:07 +00001307#define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001308 "[--broadcast] [--netmask] [--network] ipaddr <netmask>"
1309
Eric Andersende4f07e2003-12-11 01:18:07 +00001310#define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001311 "Calculate IP network settings from a IP address\n\n" \
1312 "Options:\n" \
1313 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1314 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001315 "\t-w\t--network\tDisplay calculated network address."
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001316#else
Eric Andersende4f07e2003-12-11 01:18:07 +00001317#define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001318 "[OPTION]... ipaddr <netmask>"
1319
Eric Andersende4f07e2003-12-11 01:18:07 +00001320#define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001321 "Calculate IP network settings from a IP address\n\n" \
1322 "Options:\n" \
1323 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1324 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
1325 "\t-w\t--network\tDisplay calculated network address.\n" \
1326 "\t-h\t--hostname\tDisplay first resolved host name.\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001327 "\t-s\t--silent\tDon't ever display error messages."
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001328#endif
1329
1330#define ipcalc_notes_usage \
1331 "ipcalc provides a simple way to calculate IP information for\n" \
1332 "a host. The various options specify what information ipcalc\n" \
1333 "should display on standard out. Multiple options may be\n" \
1334 "specified.\n"
1335
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001336#define iplink_trivial_usage \
1337 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1338#define iplink_full_usage \
1339 "iplink set DEVICE { up | down | arp { on | off } |\n" \
1340 " dynamic { on | off } |\n" \
1341 " mtu MTU }\n" \
1342 "iplink show [ DEVICE ]\n"
1343
1344#define iproute_trivial_usage \
1345 "{ list | flush | { add | del | change | append | replace | monitor } ROUTE }"
1346#define iproute_full_usage \
1347 "iproute { list | flush } SELECTOR\n" \
1348 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
1349 " [ oif STRING ] [ tos TOS ]\n" \
1350 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
1351 "SELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1352 "ROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]\n"
1353
1354#define iptunnel_trivial_usage \
1355 "{ add | change | del | show } [ NAME ] [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
1356#define iptunnel_full_usage \
1357 "iptunnel { add | change | del | show } [ NAME ]\n" \
1358 " [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1359 " [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1360 " [ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]\n"
1361
Eric Andersen92fb9392003-08-08 20:09:03 +00001362#define insmod_ng_trivial_usage \
1363 "MODULE [symbol=value]..."
1364#define insmod_ng_full_usage \
1365 "Loads the specified kernel modules into the kernel."
1366
Eric Andersen7e9276b2001-02-22 01:15:47 +00001367#define kill_trivial_usage \
1368 "[-signal] process-id [process-id ...]"
1369#define kill_full_usage \
1370 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +00001371 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001372 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001373#define kill_example_usage \
1374 "$ ps | grep apache\n" \
1375 "252 root root S [apache]\n" \
1376 "263 www-data www-data S [apache]\n" \
1377 "264 www-data www-data S [apache]\n" \
1378 "265 www-data www-data S [apache]\n" \
1379 "266 www-data www-data S [apache]\n" \
1380 "267 www-data www-data S [apache]\n" \
1381 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001382
1383#define killall_trivial_usage \
1384 "[-signal] process-name [process-name ...]"
1385#define killall_full_usage \
1386 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001387 "Options:\n" \
1388 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001389#define killall_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001390 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001391
Mark Whitley6317c4b2001-03-12 22:51:50 +00001392#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001393 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001394#define klogd_full_usage \
1395 "Kernel logger.\n"\
1396 "Options:\n"\
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001397 "\t-c n\tSets the default log level of console messages to n.\n"\
Mark Whitley6317c4b2001-03-12 22:51:50 +00001398 "\t-n\tRun as a foreground process."
1399
Eric Andersen7e9276b2001-02-22 01:15:47 +00001400#define length_trivial_usage \
1401 "STRING"
1402#define length_full_usage \
1403 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001404#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001405 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001406 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001407
1408#define ln_trivial_usage \
1409 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1410#define ln_full_usage \
1411 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
1412 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1413 "Options:\n" \
1414 "\t-s\tmake symbolic links instead of hard links\n" \
1415 "\t-f\tremove existing destination files\n" \
1416 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001417#define ln_example_usage \
1418 "$ ln -s BusyBox /tmp/ls\n" \
1419 "$ ls -l /tmp/ls\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001420 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001421
Eric Andersen7e9276b2001-02-22 01:15:47 +00001422#define loadfont_trivial_usage \
1423 "< font"
1424#define loadfont_full_usage \
1425 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001426#define loadfont_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001427 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001428
1429#define loadkmap_trivial_usage \
1430 "< keymap"
1431#define loadkmap_full_usage \
1432 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001433#define loadkmap_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001434 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001435
1436#define logger_trivial_usage \
1437 "[OPTION]... [MESSAGE]"
1438#define logger_full_usage \
1439 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1440 "Options:\n" \
1441 "\t-s\tLog to stderr as well as the system log.\n" \
1442 "\t-t\tLog using the specified tag (defaults to user name).\n" \
1443 "\t-p\tEnter the message with the specified priority.\n" \
1444 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001445#define logger_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001446 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001447
Robert Griebl1fca5582002-06-04 20:45:46 +00001448#define login_trivial_usage \
1449 "[OPTION]... [username] [ENV=VAR ...]"
1450#define login_full_usage \
1451 "Begin a new session on the system\n\n" \
1452 "Options:\n" \
1453 "\t-f\tDo not authenticate (user already authenticated)\n" \
1454 "\t-h\tName of the remote host for this login.\n" \
1455 "\t-p\tPreserve environment."
1456
Eric Andersen7e9276b2001-02-22 01:15:47 +00001457#define logname_trivial_usage \
1458 ""
1459#define logname_full_usage \
1460 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001461#define logname_example_usage \
1462 "$ logname\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001463 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001464
Mark Whitley6317c4b2001-03-12 22:51:50 +00001465#define logread_trivial_usage \
Eric Andersend4a5e252003-12-19 11:32:14 +00001466 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001467
1468#define logread_full_usage \
Eric Andersend4a5e252003-12-19 11:32:14 +00001469 "Shows the messages from syslogd (using circular buffer).\n\n"
1470 "Options:\n" \
1471 "\t-f\t\toutput data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001472
Matt Kraai83788da2002-03-20 17:38:37 +00001473#define losetup_trivial_usage \
1474 "[OPTION]... LOOPDEVICE FILE\n" \
1475 "or: losetup [OPTION]... -d LOOPDEVICE"
1476#define losetup_full_usage \
1477 "Associate LOOPDEVICE with FILE.\n\n" \
1478 "Options:\n" \
1479 "\t-d\t\tDisassociate LOOPDEVICE.\n" \
1480 "\t-o OFFSET\tStart OFFSET bytes into FILE.\n"
1481
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001482#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001483 #define USAGE_LS_TIMESTAMPS(a) a
1484#else
1485 #define USAGE_LS_TIMESTAMPS(a)
1486#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001487#ifdef CONFIG_FEATURE_LS_FILETYPES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001488 #define USAGE_LS_FILETYPES(a) a
1489#else
1490 #define USAGE_LS_FILETYPES(a)
1491#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001492#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001493 #define USAGE_LS_FOLLOWLINKS(a) a
1494#else
1495 #define USAGE_LS_FOLLOWLINKS(a)
1496#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001497#ifdef CONFIG_FEATURE_LS_RECURSIVE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001498 #define USAGE_LS_RECURSIVE(a) a
1499#else
1500 #define USAGE_LS_RECURSIVE(a)
1501#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001502#ifdef CONFIG_FEATURE_LS_SORTFILES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001503 #define USAGE_LS_SORTFILES(a) a
1504#else
1505 #define USAGE_LS_SORTFILES(a)
1506#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001507#ifdef CONFIG_FEATURE_AUTOWIDTH
Eric Andersen7e9276b2001-02-22 01:15:47 +00001508 #define USAGE_AUTOWIDTH(a) a
1509#else
1510 #define USAGE_AUTOWIDTH(a)
1511#endif
1512#define ls_trivial_usage \
Eric Andersen9e480452003-07-03 10:07:04 +00001513 "[-1Aa" USAGE_LS_TIMESTAMPS("c") "Cd" USAGE_LS_TIMESTAMPS("e") USAGE_LS_FILETYPES("F") "iln" USAGE_LS_FILETYPES("p") USAGE_LS_FOLLOWLINKS("L") USAGE_LS_RECURSIVE("R") USAGE_LS_SORTFILES("rS") "s" USAGE_AUTOWIDTH("T") USAGE_LS_TIMESTAMPS("tu") USAGE_LS_SORTFILES("v") USAGE_AUTOWIDTH("w") "x" USAGE_LS_SORTFILES("X") USAGE_HUMAN_READABLE("h") USAGE_NOT_HUMAN_READABLE("") "k" USAGE_SELINUX("K", "") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001514#define ls_full_usage \
1515 "List directory contents\n\n" \
1516 "Options:\n" \
1517 "\t-1\tlist files in a single column\n" \
1518 "\t-A\tdo not list implied . and ..\n" \
1519 "\t-a\tdo not hide entries starting with .\n" \
1520 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001521 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001522 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001523 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1524 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001525 "\t-i\tlist the i-node for each file\n" \
1526 "\t-l\tuse a long listing format\n" \
1527 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001528 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1529 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1530 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1531 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1532 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001533 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001534 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1535 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1536 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1537 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1538 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001539 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001540 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1541 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001542 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersenbccb3152003-07-03 10:19:20 +00001543 USAGE_SELINUX("\t-k\tprint security context\n\t-K\tprint security context in long format\n", ""))
Eric Andersen7e9276b2001-02-22 01:15:47 +00001544
1545#define lsmod_trivial_usage \
1546 ""
1547#define lsmod_full_usage \
1548 "List the currently loaded kernel modules."
1549
1550#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001551 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001552#define makedevs_full_usage \
1553 "Creates a range of block or character special files\n\n" \
1554 "TYPEs include:\n" \
1555 "\tb:\tMake a block (buffered) device.\n" \
1556 "\tc or u:\tMake a character (un-buffered) device.\n" \
1557 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1558 "FIRST specifies the number appended to NAME to create the first device.\n" \
1559 "LAST specifies the number of the last item that should be created.\n" \
1560 "If 's' is the last argument, the base device is created as well.\n\n" \
1561 "For example:\n" \
1562 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001563 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001564#define makedevs_example_usage \
1565 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
1566 "[creates ttyS2-ttyS63]\n" \
1567 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001568 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001569
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001570#ifdef CONFIG_FEATURE_MD5_SHA1_SUM_CHECK
1571#define USAGE_MD5_SHA1_SUM_CHECK(a) a
1572#else
1573#define USAGE_MD5_SHA1_SUM_CHECK(a)
1574#endif
1575
Eric Andersen7e9276b2001-02-22 01:15:47 +00001576#define md5sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001577 "[OPTION] [FILEs...]" \
1578 USAGE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001579#define md5sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001580 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001581 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001582 "With no FILE, or when FILE is -, read standard input." \
1583 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
1584 "\t-c\tcheck MD5 sums against given list\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001585 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001586 "\t-s\tdon't output anything, status code shows success\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001587 "\t-w\twarn about improperly formated MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001588#define md5sum_example_usage \
1589 "$ md5sum < busybox\n" \
1590 "6fd11e98b98a58f64ff3398d7b324003\n" \
1591 "$ md5sum busybox\n" \
1592 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1593 "$ md5sum -c -\n" \
1594 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1595 "busybox: OK\n" \
1596 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001597
Glenn L McGrath061c9002002-09-16 04:21:46 +00001598#define mesg_trivial_usage \
1599 "mesg [y|n]"
1600#define mesg_full_usage \
1601 "mesg [Y|N], controls write access to your terminal\n" \
1602 "\ty\tAllow write access to your terminal.\n" \
1603 "\tn\tDisallow write access to your terminal.\n"
1604
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001605#define minit_trivial_usage \
1606 "[-spPrRC]"
1607#define minit_full_usage \
1608 "[-spPrRC]"
1609
Eric Andersen7e9276b2001-02-22 01:15:47 +00001610#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001611 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001612#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001613 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001614 "Options:\n" \
1615 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001616 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001617#define mkdir_example_usage \
1618 "$ mkdir /tmp/foo\n" \
1619 "$ mkdir /tmp/foo\n" \
1620 "/tmp/foo: File exists\n" \
1621 "$ mkdir /tmp/foo/bar/baz\n" \
1622 "/tmp/foo/bar/baz: No such file or directory\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001623 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001624
Eric Andersen7e9276b2001-02-22 01:15:47 +00001625#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001626 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001627#define mkfifo_full_usage \
1628 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1629 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001630 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001631
Eric Andersen7e9276b2001-02-22 01:15:47 +00001632#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001633 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001634#define mkfs_minix_full_usage \
1635 "Make a MINIX filesystem.\n\n" \
1636 "Options:\n" \
1637 "\t-c\t\tCheck the device for bad blocks\n" \
1638 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1639 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1640 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001641 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001642
Eric Andersen7e9276b2001-02-22 01:15:47 +00001643#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001644 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001645#define mknod_full_usage \
1646 "Create a special file (block, character, or pipe).\n\n" \
1647 "Options:\n" \
1648 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1649 "TYPEs include:\n" \
1650 "\tb:\tMake a block (buffered) device.\n" \
1651 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001652 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001653#define mknod_example_usage \
1654 "$ mknod /dev/fd0 b 2 0 \n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001655 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001656
Eric Andersen7e9276b2001-02-22 01:15:47 +00001657#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001658 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001659#define mkswap_full_usage \
1660 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001661 "Options:\n" \
1662 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001663 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001664 "\t-v1\t\tMake version 1 swap [big!] (default for kernels >\n\t\t\t2.1.117).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001665 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001666
Eric Andersen7e9276b2001-02-22 01:15:47 +00001667#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001668 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001669#define mktemp_full_usage \
1670 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001671 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001672#define mktemp_example_usage \
1673 "$ mktemp /tmp/temp.XXXXXX\n" \
1674 "/tmp/temp.mWiLjM\n" \
1675 "$ ls -la /tmp/temp.mWiLjM\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001676 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001677
Eric Andersen8d79ce82001-07-22 23:00:15 +00001678#define modprobe_trivial_usage \
1679 "[FILE ...]"
1680#define modprobe_full_usage \
Eric Andersenabc95682002-07-03 02:52:35 +00001681 "Used for high level module loading and unloading."
Eric Andersen8d79ce82001-07-22 23:00:15 +00001682#define modprobe_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001683 "$ modprobe cdrom\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00001684
Eric Andersen7e9276b2001-02-22 01:15:47 +00001685#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001686 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001687#define more_full_usage \
1688 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001689#define more_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001690 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001691
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001692#ifdef CONFIG_FEATURE_MOUNT_LOOP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001693 #define USAGE_MOUNT_LOOP(a) a
1694#else
1695 #define USAGE_MOUNT_LOOP(a)
1696#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001697#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001698 #define USAGE_MTAB(a) a
1699#else
1700 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001701#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001702#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001703 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001704#define mount_full_usage \
Eric Andersen2715fa12004-03-09 21:32:57 +00001705 "Mount a filesystem. Autodetection of filesystem type requires the\n" \
1706 "/proc filesystem be already mounted.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001707 "Flags:\n" \
1708 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001709 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001710 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001711 "\t-n:\t\tDon't write a mount table entry.\n" \
1712 ) \
1713 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1714 "\t-r:\t\tMount the filesystem read-only.\n" \
1715 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1716 "\t-w:\t\tMount for reading and writing (default).\n" \
1717 "\n" \
1718 "Options for use with the \"-o\" flag:\n" \
1719 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1720 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1721 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1722 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001723 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001724 "\tloop:\t\tMounts a file via loop device.\n" \
1725 ) \
1726 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001727 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001728 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001729 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001730 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001731 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001732#define mount_example_usage \
1733 "$ mount\n" \
1734 "/dev/hda3 on / type minix (rw)\n" \
1735 "proc on /proc type proc (rw)\n" \
1736 "devpts on /dev/pts type devpts (rw)\n" \
1737 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001738 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001739
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001740#define msvc_trivial_usage \
1741 "-[udorspchaitkx] service"
Eric Andersen335816b2003-07-14 22:14:49 +00001742#define msvc_full_usage \
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001743 "[option] service\n" \
1744 "Where option is one of\n" \
1745 "\t-u\tUp. If the service is not running, start it. If the service stops, restart it.\n" \
1746 "\t-d\tDown. If the service is running, stop it, do not restart it.\n" \
1747 "\t-o\tOnce. If the service is not running, start it. Do not restart it if it stops.\n" \
1748 "\t-r\tTell supervise that the service is normally running; this affects status messages.\n" \
1749 "\t-s\tTell supervise that the service is normally stopped; this affects status messages.\n" \
1750 "\t-p\tPause. Send the service a STOP signal.\n" \
1751 "\t-c\tContinue. Send the service a CONT signal.\n" \
1752 "\t-h\tHangup. Send the service a HUP signal.\n" \
1753 "\t-a\tAlarm. Send the service an ALRM signal.\n" \
1754 "\t-i\tInterrupt. Send the service an INT signal.\n" \
1755 "\t-t\tTerminate. Send the service a TERM signal.\n" \
1756 "\t-k\tKill. Send the service a KILL signal.\n" \
1757 "\t-x\tExit. supervise will quit as soon as the service is down.\n"
1758
Eric Andersen7e9276b2001-02-22 01:15:47 +00001759#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001760 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001761#define mt_full_usage \
1762 "Control magnetic tape drive operation\n" \
1763 "\nAvailable Opcodes:\n\n" \
1764 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1765 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
Eric Andersen92fb9392003-08-08 20:09:03 +00001766 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001767 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001768
Eric Andersen7e9276b2001-02-22 01:15:47 +00001769#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001770 "SOURCE DEST\n" \
1771 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001772#define mv_full_usage \
1773 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001774#define mv_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001775 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001776
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001777#define nameif_trivial_usage \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001778 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001779#define nameif_full_usage \
1780 "Nameif renaming network interface while it in the down state.\n\n" \
1781 "Options:\n" \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001782 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001783 "\t-s\t\tUse syslog (LOCAL0 facility).\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001784 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address\n"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001785#define nameif_example_usage \
1786 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
1787 " or\n" \
1788 "$ nameif -c /etc/my_mactab_file\n" \
1789
Eric Andersen7e9276b2001-02-22 01:15:47 +00001790#define nc_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001791 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001792#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001793 "Netcat opens a pipe to IP:port\n\n" \
1794 "Options:\n" \
1795 "\t-l\t\tlisten mode, for inbound connects\n" \
1796 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00001797 "\t-i SECS\t\tdelay interval for lines sent\n" \
Eric Andersen00a6a752002-04-26 23:53:10 +00001798 "\t-e PROG\t\tprogram to exec after connect (dangerous!)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001799#define nc_example_usage \
1800 "$ nc foobar.somedomain.com 25\n" \
1801 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1802 "help\n" \
1803 "214-Commands supported:\n" \
1804 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1805 "214 NOOP QUIT RSET HELP\n" \
1806 "quit\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001807 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001808
Eric Andersen1552ff72001-10-31 11:07:12 +00001809#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00001810 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00001811#define netstat_full_usage \
1812 "-l display listening server sockets\n" \
1813 "-a display all sockets (default: connected)\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001814 "-e display other/more information\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001815 "-n don't resolve names\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001816 "-r display routing table\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001817 "-t tcp sockets\n" \
1818 "-u udp sockets\n" \
1819 "-w raw sockets\n" \
1820 "-x unix sockets\n"
1821
Eric Andersen7e9276b2001-02-22 01:15:47 +00001822#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001823 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001824#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001825 "Queries the nameserver for the IP address of the given HOST\n" \
1826 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001827#define nslookup_example_usage \
1828 "$ nslookup localhost\n" \
1829 "Server: default\n" \
1830 "Address: default\n" \
1831 "\n" \
1832 "Name: debian\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001833 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001834
Glenn L McGrath60281112001-11-02 11:39:46 +00001835#define od_trivial_usage \
1836 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
1837#define od_full_usage \
1838 "Write an unambiguous representation, octal bytes by default, of FILE\n"\
1839 "to standard output. With no FILE, or when FILE is -, read standard input."
1840
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00001841#define openvt_trivial_usage \
1842 "<vtnum> <COMMAND> [ARGS...]"
1843#define openvt_full_usage \
1844 "Start a command on a new virtual terminal"
1845#define openvt_example_usage \
1846 "openvt 2 /bin/ash\n"
1847
Eric Andersen27f64e12002-06-23 04:24:25 +00001848#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
1849 #define PASSWORD_ALG_TYPES(a) a
Tim Riker7b253f82003-12-28 05:02:40 +00001850#else
Eric Andersen27f64e12002-06-23 04:24:25 +00001851 #define PASSWORD_ALG_TYPES(a)
1852#endif
1853#define passwd_trivial_usage \
1854 "[OPTION] [name]"
1855#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00001856 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00001857 "changes the password for the current user.\n" \
1858 "Options:\n" \
1859 "\t-a\tDefine which algorithm shall be used for the password.\n" \
1860 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001861 PASSWORD_ALG_TYPES(", sha1") \
Eric Andersen27f64e12002-06-23 04:24:25 +00001862 ")\n\t-d\tDelete the password for the specified user account.\n" \
1863 "\t-l\tLocks (disables) the specified user account.\n" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001864 "\t-u\tUnlocks (re-enables) the specified user account."
Eric Andersen27f64e12002-06-23 04:24:25 +00001865
Glenn L McGrath655d8142003-06-22 15:32:41 +00001866#define patch_trivial_usage \
1867 "[-p<num>]"
1868#define patch_full_usage \
1869 "[-p<num>]"
1870#define patch_example_usage \
1871 "$ patch -p1 <example.diff"
1872
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001873#define pidfilehack_trivial_usage \
1874 "[daemon.pid] [daemon]"
1875#define pidfilehack_full_usage \
1876 "service /var/run/daemon.pid /usr/sbin/daemon args...\n"
1877
Eric Andersen221b2ea2001-07-31 19:06:07 +00001878#define pidof_trivial_usage \
1879 "process-name [process-name ...]"
1880#define pidof_full_usage \
1881 "Lists the PIDs of all processes with names that match the names on the command line"
1882#define pidof_example_usage \
1883 "$ pidof init\n" \
1884 "1\n"
1885
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001886#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001887#define ping_trivial_usage "host"
1888#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1889#else
1890#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001891 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001892#define ping_full_usage \
1893 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1894 "Options:\n" \
1895 "\t-c COUNT\tSend only COUNT pings.\n" \
1896 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1897 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001898 "\t\t\tand when finished."
1899#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001900#define ping_example_usage \
1901 "$ ping localhost\n" \
1902 "PING slag (127.0.0.1): 56 data bytes\n" \
1903 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1904 "\n" \
1905 "--- debian ping statistics ---\n" \
1906 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001907 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001908
Eric Andersen51b8bd62002-07-03 11:46:38 +00001909#ifndef CONFIG_FEATURE_FANCY_PING6
1910#define ping6_trivial_usage "host"
1911#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1912#else
1913#define ping6_trivial_usage \
1914 "[OPTION]... host"
1915#define ping6_full_usage \
1916 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1917 "Options:\n" \
1918 "\t-c COUNT\tSend only COUNT pings.\n" \
1919 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1920 "\t-q\t\tQuiet mode, only displays output at start\n" \
1921 "\t\t\tand when finished."
1922#endif
1923#define ping6_example_usage \
1924 "$ ping6 ip6-localhost\n" \
1925 "PING ip6-localhost (::1): 56 data bytes\n" \
1926 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
1927 "\n" \
1928 "--- ip6-localhost ping statistics ---\n" \
1929 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001930 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00001931
Eric Andersen7e9276b2001-02-22 01:15:47 +00001932#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001933 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001934#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001935 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001936 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001937
Eric Andersen7e9276b2001-02-22 01:15:47 +00001938#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001939 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001940#define poweroff_full_usage \
1941 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001942
Eric Andersen7e9276b2001-02-22 01:15:47 +00001943#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001944 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001945#define printf_full_usage \
1946 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001947 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001948#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001949 "$ printf "Val=%d\\n" 5\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001950 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001951
Eric Andersen7e9276b2001-02-22 01:15:47 +00001952#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001953 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001954#define ps_full_usage \
1955 "Report process status\n" \
Eric Andersen9e480452003-07-03 10:07:04 +00001956 USAGE_SELINUX("\nOptions:\n\t-c\tshow SE Linux context", "\nThis version of ps accepts no options.")
Tim Riker7b253f82003-12-28 05:02:40 +00001957
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001958#define ps_example_usage \
1959 "$ ps\n" \
1960 " PID Uid Gid State Command\n" \
1961 " 1 root root S init\n" \
1962 " 2 root root S [kflushd]\n" \
1963 " 3 root root S [kupdate]\n" \
1964 " 4 root root S [kpiod]\n" \
1965 " 5 root root S [kswapd]\n" \
1966 " 742 andersen andersen S [bash]\n" \
1967 " 743 andersen andersen S -bash\n" \
1968 " 745 root root S [getty]\n" \
1969 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001970
Eric Andersen7e9276b2001-02-22 01:15:47 +00001971#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001972 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001973#define pwd_full_usage \
1974 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001975#define pwd_example_usage \
1976 "$ pwd\n" \
1977 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001978
Eric Andersen92fb9392003-08-08 20:09:03 +00001979#define raid_start_trivial_usage \
1980 "MD_DEVICE DISK_DEVICE"
1981#define raid_start_full_usage \
1982 "Start MD_DEVICE, taking superblock from DISK_DEVICE.\n" \
1983 "Example: raid_start /dev/md0 /dev/sdb"
Tim Riker7b253f82003-12-28 05:02:40 +00001984
Eric Andersen7e9276b2001-02-22 01:15:47 +00001985#define rdate_trivial_usage \
Eric Andersen725db192003-07-22 08:26:05 +00001986 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001987#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001988 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001989 "Options:\n" \
1990 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001991 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001992
Eric Andersen7e9276b2001-02-22 01:15:47 +00001993#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001994 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001995#define readlink_full_usage \
1996 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001997
Glenn L McGrath62fae302002-12-10 00:14:33 +00001998#define realpath_trivial_usage \
1999 "pathname ..."
2000#define realpath_full_usage \
2001 "return the canonicalized absolute pathnames of given arguments\n\n"
Tim Riker7b253f82003-12-28 05:02:40 +00002002
Eric Andersen7e9276b2001-02-22 01:15:47 +00002003#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002004 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002005#define reboot_full_usage \
2006 "Reboot the system."
2007
2008#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002009 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002010#define renice_full_usage \
2011 "Changes priority of running processes. Allowed priorities range\n" \
2012 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002013 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002014
Eric Andersen7e9276b2001-02-22 01:15:47 +00002015#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002016 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002017#define reset_full_usage \
2018 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002019
Eric Andersen7e9276b2001-02-22 01:15:47 +00002020#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002021 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002022#define rm_full_usage \
2023 "Remove (unlink) the FILE(s). You may use '--' to\n" \
2024 "indicate that all following arguments are non-options.\n\n" \
2025 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002026 "\t-i\t\talways prompt before removing each destination\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002027 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002028 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002029#define rm_example_usage \
2030 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002031
Eric Andersen7e9276b2001-02-22 01:15:47 +00002032#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002033 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002034#define rmdir_full_usage \
2035 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002036#define rmdir_example_usage \
2037 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002038
Eric Andersen7e9276b2001-02-22 01:15:47 +00002039#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002040 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002041#define rmmod_full_usage \
2042 "Unloads the specified kernel modules from the kernel.\n\n" \
2043 "Options:\n" \
Tim Rikercf932742002-12-14 01:58:59 +00002044 "\t-a\tRemove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002045#define rmmod_example_usage \
2046 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002047
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002048#ifdef CONFIG_FEATURE_IPV6
2049 #define USAGE_ROUTE_IPV6(a) a
2050#else
2051 #define USAGE_ROUTE_IPV6(a) "\t"
2052#endif
2053
2054
Eric Andersen7e9276b2001-02-22 01:15:47 +00002055#define route_trivial_usage \
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002056 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002057#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002058 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00002059 "Options:\n" \
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002060 "\t-n\t\tDont resolve names.\n" \
2061 "\t-e\t\tDisplay other/more information.\n" \
2062 "\t-A inet" USAGE_ROUTE_IPV6("{6}") "\tSelect address family."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002063
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002064#define rpm_trivial_usage \
2065 "-i -q[ildc]p package.rpm"
2066#define rpm_full_usage \
2067 "Manipulates RPM packages" \
Eric Andersendfce3532003-06-15 07:00:54 +00002068 "\n\nOptions:" \
2069 "\n\t-i Install package" \
2070 "\n\t-q Query package" \
2071 "\n\t-p Query uninstalled package" \
2072 "\n\t-i Show information" \
2073 "\n\t-l List contents" \
2074 "\n\t-d List documents" \
2075 "\n\t-c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002076
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002077#define rpm2cpio_trivial_usage \
2078 "package.rpm"
2079#define rpm2cpio_full_usage \
2080 "Outputs a cpio archive of the rpm file."
2081
Eric Andersen6cf47a72001-10-31 10:24:36 +00002082#define run_parts_trivial_usage \
2083 "[-t] [-a ARG] [-u MASK] DIRECTORY"
2084#define run_parts_full_usage \
2085 "Run a bunch of scripts in a directory.\n\n" \
2086 "Options:\n" \
2087 "\t-t\t\tTest only what file will be executed, without execute them.\n" \
2088 "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \
2089 "\t-u MASK\tSet the umask to MASK before executing every program."
2090
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002091#define rx_trivial_usage \
2092 "FILE"
2093#define rx_full_usage \
2094 "Receive a file using the xmodem protocol."
2095#define rx_example_usage \
2096 "$ rx /tmp/foo\n"
2097
Eric Andersen7e9276b2001-02-22 01:15:47 +00002098#define sed_trivial_usage \
Matt Kraai075228a2001-06-21 14:40:55 +00002099 "[-nef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002100#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002101 "Options:\n" \
2102 "\t-n\t\tsuppress automatic printing of pattern space\n" \
2103 "\t-e script\tadd the script to the commands to be executed\n" \
2104 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002105 "\n" \
2106 "If no -e or -f is given, the first non-option argument is taken as the\n" \
2107 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002108 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002109#define sed_example_usage \
2110 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
2111 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002112
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002113#define seq_trivial_usage \
2114 "[first [increment]] last"
2115#define seq_full_usage \
2116 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
2117 "FIRST, INCREMENT default to 1\n" \
2118 "Arguments:\n" \
2119 "\tLAST\n" \
2120 "\tFIRST\tLAST\n" \
2121 "\tFIRST\tINCREMENT\tLAST\n"
2122
Eric Andersen7e9276b2001-02-22 01:15:47 +00002123#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002124 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002125#define setkeycodes_full_usage \
2126 "Set entries into the kernel's scancode-to-keycode map,\n" \
2127 "allowing unusual keyboards to generate usable keycodes.\n\n" \
2128 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002129 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002130#define setkeycodes_example_usage \
2131 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002132
Matt Kraai2d91deb2001-08-01 17:21:35 +00002133#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002134 "[FILE]...\n" \
2135 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00002136#define lash_full_usage \
Eric Andersen2e9c2572003-08-08 22:26:06 +00002137 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00002138#define lash_notes_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002139"This command does not yet have proper documentation.\n" \
2140"\n" \
2141"Use lash just as you would use any other shell. It properly handles pipes,\n" \
2142"redirects, job control, can be used as the shell for scripts, and has a\n" \
2143"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
2144"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
2145"use ash or bash. If you just need a very simple and extremely small shell,\n" \
2146"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002147
Eric Andersen2e9c2572003-08-08 22:26:06 +00002148#define last_trivial_usage \
2149 ""
2150#define last_full_usage \
2151 "Shows listing of the last users that logged into the system"
2152
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002153#define sha1sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002154 "[OPTION] [FILEs...]" \
2155 USAGE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002156#define sha1sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002157 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n\n" \
2158 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002159 "With no FILE, or when FILE is -, read standard input." \
2160 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
2161 "\t-c\tcheck SHA1 sums against given list\n" \
2162 "\nThe following two options are useful only when verifying checksums:\n" \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002163 "\t-s\tdon't output anything, status code shows success\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002164 "\t-w\twarn about improperly formated SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002165
Manuel Novoa III cad53642003-03-19 09:13:01 +00002166#ifdef CONFIG_FEATURE_FANCY_SLEEP
2167 #define USAGE_FANCY_SLEEP(a) a
2168 #define USAGE_NOT_FANCY_SLEEP(a)
2169#else
Tim Riker7b253f82003-12-28 05:02:40 +00002170 #define USAGE_FANCY_SLEEP(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +00002171 #define USAGE_NOT_FANCY_SLEEP(a) a
2172#endif
2173
Eric Andersen7e9276b2001-02-22 01:15:47 +00002174#define sleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002175 USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002176#define sleep_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002177 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \
2178 USAGE_FANCY_SLEEP( \
2179"Pause for a time equal to the total of the args given, where each arg can\n" \
2180"have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002181#define sleep_example_usage \
2182 "$ sleep 2\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002183 "[2 second delay results]\n" \
2184 USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \
2185 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002186
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002187#ifdef CONFIG_FEATURE_SORT_UNIQUE
Mark Whitleyfccaa362001-04-17 18:56:18 +00002188 #define USAGE_SORT_UNIQUE(a) a
2189#else
2190 #define USAGE_SORT_UNIQUE(a)
2191#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002192#ifdef CONFIG_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002193 #define USAGE_SORT_REVERSE(a) a
2194#else
2195 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002196#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002197#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002198 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002199#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002200 "Sorts lines of text in the specified files\n\n"\
2201 "Options:\n" \
2202 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
2203 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
2204 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002205#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002206 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002207 "a\n" \
2208 "b\n" \
2209 "c\n" \
2210 "d\n" \
2211 "e\n" \
2212 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002213
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002214#define start_stop_daemon_trivial_usage \
2215 "[OPTIONS]"
2216#define start_stop_daemon_full_usage \
2217 "Program to start and stop services.\n"\
2218 "Options:\n" \
2219 "-S\t\t\tstart\n"\
2220 "-K\t\t\tstop\n"\
Eric Andersenfe5b1a92002-10-22 19:21:48 +00002221 "-b\t\t\tforce process into background (daemonize)\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002222 "-x <executable>\t\tprogram to start/check if it is running\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002223 "-u <username>|<uid>\tstop this user's processes\n"\
2224 "-n <process-name>\tstop processes with this name\n"\
2225 "-s <signal>\t\tsignal to send (default 15)\n"\
2226 "-a <pathname>\t\tprogram to start (default <executable>)\n"
2227
Eric Andersenef5e8f82002-11-07 02:09:37 +00002228#define strings_trivial_usage \
2229 "[-afo] [-n length] [file ... ]"
2230#define strings_full_usage \
2231 "Display printable strings in a binary file." \
2232 "\n\nOptions:" \
2233 "\n\t-f\tPrecede each string with the name of the file where it was found." \
2234 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
2235 "\n\t-o\tEach string is preceded by its decimal offset in the file."
2236
Eric Andersen7e9276b2001-02-22 01:15:47 +00002237#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002238 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002239#define stty_full_usage \
2240 "Without arguments, prints baud rate, line discipline," \
2241 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002242 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00002243 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002244 "\n\t-a\t\tprint all current settings in human-readable form" \
2245 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00002246 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002247
Robert Griebl1fca5582002-06-04 20:45:46 +00002248#define su_trivial_usage \
2249 "[OPTION]... [-] [username]"
2250#define su_full_usage \
2251 "Change user id or become root.\n" \
2252 "Options:\n" \
2253 "\t-p\tPreserve environment"
2254
Eric Andersen27f64e12002-06-23 04:24:25 +00002255#define sulogin_trivial_usage \
2256 "[OPTION]... [tty-device]"
2257#define sulogin_full_usage \
2258 "Single user login\n" \
2259 "Options:\n" \
2260 "\t-f\tDo not authenticate (user already authenticated)\n" \
2261 "\t-h\tName of the remote host for this login.\n" \
2262 "\t-p\tPreserve environment."
2263
Eric Andersen7e9276b2001-02-22 01:15:47 +00002264#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002265 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002266#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002267 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002268 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002269 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002270
Eric Andersen7e9276b2001-02-22 01:15:47 +00002271#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002272 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002273#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002274 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002275 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002276 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002277
Eric Andersen7e9276b2001-02-22 01:15:47 +00002278#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002279 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002280#define sync_full_usage \
2281 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002282
Eric Andersen7e9276b2001-02-22 01:15:47 +00002283
Eric Andersen29c77f72003-10-09 09:43:18 +00002284#ifdef CONFIG_FEATURE_ROTATE_LOGFILE
2285 #define USAGE_ROTATE_LOGFILE(a) a
2286#else
Tim Riker7b253f82003-12-28 05:02:40 +00002287 #define USAGE_ROTATE_LOGFILE(a)
Eric Andersen29c77f72003-10-09 09:43:18 +00002288#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002289#ifdef CONFIG_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00002290 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002291#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00002292 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002293#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00002294#ifdef CONFIG_FEATURE_IPC_SYSLOG
2295 #define USAGE_IPC_LOG(a) a
2296#else
2297 #define USAGE_IPC_LOG(a)
2298#endif
2299
Eric Andersenb9050282003-12-24 06:02:11 +00002300#ifdef CONFIG_SYSCTL
2301#define sysctl_trivial_usage \
2302 "[OPTIONS]... [VALUE]...\n"
2303#define sysctl_full_usage
2304 "sysctl - configure kernel parameters at runtime\n\n" \
2305 "Options:\n" \
2306 "\t-n\tUse this option to disable printing of the key name when printing values.\n" \
2307 "\t-e\tUse this option to ignore errors about unknown keys.\n" \
2308 "\t-w\tUse this option when you want to change a sysctl setting.\n" \
2309 "\t-p\tLoad in sysctl settings from the file specified or /etc/sysctl.conf if none given.\n" \
2310 "\t-a\tDisplay all values currently available.\n" \
2311 "\t-A\tDisplay all values currently available in table form."
2312
2313#define sysctl_example_usage
2314 "sysctl [-n] [-e] variable ...\n" \
2315 "sysctl [-n] [-e] -w variable=value ...\n" \
2316 "sysctl [-n] [-e] -a\n" \
2317 "sysctl [-n] [-e] -p <file>\t(default /etc/sysctl.conf)\n" \
2318 "sysctl [-n] [-e] -A\n"
2319#endif
2320
Eric Andersen7e9276b2001-02-22 01:15:47 +00002321#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002322 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002323#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002324 "Linux system and kernel logging utility.\n" \
2325 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002326 "Options:\n" \
2327 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
2328 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002329 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen29c77f72003-10-09 09:43:18 +00002330 USAGE_ROTATE_LOGFILE( \
2331 "\n\t-s SIZE\t\tMax size (KB) bevor rotate (default=200KB, 0=off)\n" \
2332 "\t-b NUM\t\tNumber of rotated log files (default=1, 0=purge log)") \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002333 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00002334 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00002335 "\t-L\t\tLog locally and via network logging (default is network only)") \
2336 USAGE_IPC_LOG( \
Eric Andersend4a5e252003-12-19 11:32:14 +00002337 "\n\t-C [size(KiB)]\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002338#define syslogd_example_usage \
2339 "$ syslogd -R masterlog:514\n" \
2340 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002341
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002342
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002343#ifndef CONFIG_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00002344 #define USAGE_UNSIMPLE_TAIL(a)
2345#else
2346 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002347#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002348#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002349 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002350#define tail_full_usage \
2351 "Print last 10 lines of each FILE to standard output.\n" \
2352 "With more than one FILE, precede each with a header giving the\n" \
2353 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
2354 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002355 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002356 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
2357 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002358 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002359 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
2360 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002361 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002362 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002363 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
2364#define tail_example_usage \
2365 "$ tail -n 1 /etc/resolv.conf\n" \
2366 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002367
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002368#ifdef CONFIG_FEATURE_TAR_CREATE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002369 #define USAGE_TAR_CREATE(a) a
2370#else
2371 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002372#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002373#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002374 #define USAGE_TAR_EXCLUDE(a) a
2375#else
2376 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002377#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002378#ifdef CONFIG_FEATURE_TAR_GZIP
2379 #define USAGE_TAR_GZIP(a) a
2380#else
2381 #define USAGE_TAR_GZIP(a)
2382#endif
2383#ifdef CONFIG_FEATURE_TAR_BZIP2
2384 #define USAGE_TAR_BZIP2(a) a
2385#else
2386 #define USAGE_TAR_BZIP2(a)
2387#endif
Glenn L McGrath7370f622003-11-18 21:49:23 +00002388#ifdef CONFIG_FEATURE_TAR_COMPRESS
2389 #define USAGE_TAR_COMPRESS(a) a
2390#else
2391 #define USAGE_TAR_COMPRESS(a)
2392#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002393
Eric Andersen7e9276b2001-02-22 01:15:47 +00002394#define tar_trivial_usage \
Glenn L McGrath7370f622003-11-18 21:49:23 +00002395 "-[" USAGE_TAR_CREATE("c") USAGE_TAR_GZIP("z") USAGE_TAR_BZIP2("j") USAGE_TAR_COMPRESS("Z") "xtvO] " \
Glenn L McGrathce91c8a2003-12-26 14:01:37 +00002396 USAGE_TAR_EXCLUDE("[-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00002397 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002398#define tar_full_usage \
2399 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00002400 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002401 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002402 "\tx\t\textract\n" \
2403 "\tt\t\tlist\n" \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002404 "\nArchive format selection:\n" \
2405 USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
2406 USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
Glenn L McGrath0c5d9c22003-11-18 23:27:49 +00002407 USAGE_TAR_COMPRESS("\tZ\t\tFilter the archive through compress\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002408 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002409 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002410 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002411 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002412 "\texclude\t\tfile to exclude\n" \
2413 "\tX\t\tfile with names to exclude\n" \
2414 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00002415 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002416 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002417#define tar_example_usage \
2418 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
2419 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002420
Eric Andersen7e9276b2001-02-22 01:15:47 +00002421#define tee_trivial_usage \
2422 "[OPTION]... [FILE]..."
2423#define tee_full_usage \
2424 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002425 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002426 "\t-a\tappend to the given FILEs, do not overwrite\n" \
2427 "\t-i\tignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002428#define tee_example_usage \
2429 "$ echo "Hello" | tee /tmp/foo\n" \
2430 "$ cat /tmp/foo\n" \
2431 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002432
Eric Andersen539ffc92004-02-22 12:25:47 +00002433#ifdef CONFIG_FEATURE_TELNET_AUTOLOGIN
2434#define telnet_trivial_usage \
2435 "[-a] [-l USER] HOST [PORT]"
2436#define telnet_full_usage \
2437 "Telnet is used to establish interactive communication with another\n" \
2438 "computer over a network using the TELNET protocol.\n\n" \
2439 "Options:\n" \
2440 "\t-a\t\tAttempt an automatic login with the USER variable.\n" \
2441 "\t-l USER\t\tAttempt an automatic login with the USER argument.\n" \
2442 "\tHOST\t\tThe official name, alias or the IP address of the\n" \
2443 "\t\t\tremote host.\n" \
2444 "\tPORT\t\tThe remote port number to connect to. If it is not\n" \
2445 "\t\t\tspecified, the default telnet (23) port is used.\n"
2446#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00002447#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002448 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002449#define telnet_full_usage \
2450 "Telnet is used to establish interactive communication with another\n"\
2451 "computer over a network using the TELNET protocol."
Eric Andersen539ffc92004-02-22 12:25:47 +00002452#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002453
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002454#ifdef CONFIG_FEATURE_TELNETD_INETD
2455#define telnetd_trivial_usage \
2456 "(inetd mode) [OPTION]"
2457#define telnetd_full_usage \
2458 "Telnetd uses incoming TELNET connections via inetd.\n"\
2459 "Options:\n" \
2460 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
2461#else
Eric Andersen08a72202002-09-30 20:52:10 +00002462#define telnetd_trivial_usage \
2463 "[OPTION]"
2464#define telnetd_full_usage \
2465 "Telnetd listens for incoming TELNET connections on PORT.\n"\
2466 "Options:\n" \
2467 "\t-p PORT\tlisten for connections on PORT (default 23)\n"\
2468 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002469#endif
Eric Andersen08a72202002-09-30 20:52:10 +00002470
Eric Andersen7e9276b2001-02-22 01:15:47 +00002471#define test_trivial_usage \
2472 "EXPRESSION\n or [ EXPRESSION ]"
2473#define test_full_usage \
2474 "Checks file types and compares values returning an exit\n" \
2475 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002476#define test_example_usage \
2477 "$ test 1 -eq 2\n" \
2478 "$ echo $?\n" \
2479 "1\n" \
2480 "$ test 1 -eq 1\n" \
2481 "$ echo $? \n" \
2482 "0\n" \
2483 "$ [ -d /etc ]\n" \
2484 "$ echo $?\n" \
2485 "0\n" \
2486 "$ [ -d /junk ]\n" \
2487 "$ echo $?\n" \
2488 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002489
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002490#ifdef CONFIG_FEATURE_TFTP_GET
Mark Whitley450736c2001-03-02 19:08:50 +00002491 #define USAGE_TFTP_GET(a) a
2492#else
2493 #define USAGE_TFTP_GET(a)
2494#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002495#ifdef CONFIG_FEATURE_TFTP_PUT
Mark Whitley450736c2001-03-02 19:08:50 +00002496 #define USAGE_TFTP_PUT(a) a
2497#else
2498 #define USAGE_TFTP_PUT(a)
2499#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002500#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Glenn L McGrathad117d82001-10-05 04:40:37 +00002501 #define USAGE_TFTP_BS(a) a
2502#else
2503 #define USAGE_TFTP_BS(a)
2504#endif
Mark Whitley450736c2001-03-02 19:08:50 +00002505
2506#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00002507 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00002508#define tftp_full_usage \
2509 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00002510 "Options:\n" \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002511 "\t-l FILE\tLocal FILE.\n" \
2512 "\t-r FILE\tRemote FILE.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002513 USAGE_TFTP_GET( \
Matt Kraai3be34302001-09-21 14:42:30 +00002514 "\t-g\tGet file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002515 ) \
2516 USAGE_TFTP_PUT( \
Matt Kraai3be34302001-09-21 14:42:30 +00002517 "\t-p\tPut file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002518 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002519 USAGE_TFTP_BS( \
2520 "\t-b SIZE\tTransfer blocks of SIZE octets.\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002521 )
Eric Andersenc3657422001-11-30 07:54:32 +00002522#define time_trivial_usage \
2523 "[OPTION]... COMMAND [ARGS...]"
2524#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00002525 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
2526 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00002527 "Options:\n" \
2528 "\t-v\tDisplays verbose resource usage information."
Mark Whitley450736c2001-03-02 19:08:50 +00002529
Eric Andersen420b2082002-09-17 22:14:58 +00002530#define top_trivial_usage \
2531 "[-d <seconds>]"
2532#define top_full_usage \
2533 "top provides an view of processor activity in real time.\n" \
2534 "This utility reads the status for all processes in /proc each <seconds>\n" \
2535 "and shows the status for however many processes will fit on the screen.\n" \
2536 "This utility will not show processes that are started after program startup,\n" \
2537 "but it will show the EXIT status for and PIDs that exit while it is running."
2538
Eric Andersen7e9276b2001-02-22 01:15:47 +00002539#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002540 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002541#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002542 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002543 "Options:\n" \
2544 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002545#define touch_example_usage \
2546 "$ ls -l /tmp/foo\n" \
2547 "/bin/ls: /tmp/foo: No such file or directory\n" \
2548 "$ touch /tmp/foo\n" \
2549 "$ ls -l /tmp/foo\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002550 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002551
2552#define tr_trivial_usage \
2553 "[-cds] STRING1 [STRING2]"
2554#define tr_full_usage \
2555 "Translate, squeeze, and/or delete characters from\n" \
2556 "standard input, writing to standard output.\n\n" \
2557 "Options:\n" \
2558 "\t-c\ttake complement of STRING1\n" \
2559 "\t-d\tdelete input characters coded STRING1\n" \
2560 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002561#define tr_example_usage \
2562 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002563 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002564
Eric Andersen5c58d282001-07-10 16:29:00 +00002565#define traceroute_trivial_usage \
2566 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n\
2567 [-s src_addr] [-t tos] [-w wait] host [data size]"
2568#define traceroute_full_usage \
2569 "trace the route ip packets follow going to \"host\"\n" \
2570 "Options:\n" \
2571 "\t-d\tset SO_DEBUG options to socket\n" \
2572 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
2573 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
2574 "\t-v\tVerbose output\n" \
2575 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
2576 "\t-p port#\tSet the base UDP port number used in probes\n" \
2577 "\t\t(default is 33434)\n" \
2578 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
2579 "\t\t(default is 3)\n" \
2580 "\t-s src_addr\tUse the following IP address as the source address\n" \
2581 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
2582 "\t\t(default 0)\n" \
2583 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
2584 "\t\t(default 3 sec.)."
2585
2586
Eric Andersen7e9276b2001-02-22 01:15:47 +00002587#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002588 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002589#define true_full_usage \
2590 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002591#define true_example_usage \
2592 "$ true\n" \
2593 "$ echo $?\n" \
2594 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002595
Eric Andersen7e9276b2001-02-22 01:15:47 +00002596#define tty_trivial_usage \
2597 ""
2598#define tty_full_usage \
2599 "Print the file name of the terminal connected to standard input.\n\n"\
2600 "Options:\n" \
2601 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002602#define tty_example_usage \
2603 "$ tty\n" \
2604 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002605
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002606#define udhcpc_trivial_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00002607 "[-fbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002608#define udhcpc_full_usage \
2609 "\t-c,\t--clientid=CLIENTID\tClient identifier\n" \
2610 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00002611 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002612 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00002613 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated.\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002614 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
2615 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated.\n" \
2616 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
2617 "\t-q,\t--quit\tQuit after obtaining lease\n" \
2618 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
2619 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
2620 "\t-v,\t--version\tDisplay version"
2621
Russ Dill61fb4892002-10-14 21:41:28 +00002622#define udhcpd_trivial_usage \
2623 "[configfile]\n" \
2624
2625#define udhcpd_full_usage \
Glenn L McGrath9130c852002-12-12 12:56:18 +00002626 ""
Russ Dill61fb4892002-10-14 21:41:28 +00002627
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002628#ifdef CONFIG_FEATURE_MOUNT_FORCE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002629 #define USAGE_MOUNT_FORCE(a) a
2630#else
2631 #define USAGE_MOUNT_FORCE(a)
2632#endif
2633#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002634 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002635#define umount_full_usage \
2636 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00002637 "\nFlags:\n" "\t-a\tUnmount all file systems" \
2638 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
2639 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00002640 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00002641 USAGE_MOUNT_LOOP("\n\t-l\tDo not free loop device (if a loop device has been used)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002642#define umount_example_usage \
2643 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002644
2645#define uname_trivial_usage \
2646 "[OPTION]..."
2647#define uname_full_usage \
2648 "Print certain system information. With no OPTION, same as -s.\n\n" \
2649 "Options:\n" \
2650 "\t-a\tprint all information\n" \
2651 "\t-m\tthe machine (hardware) type\n" \
2652 "\t-n\tprint the machine's network node hostname\n" \
2653 "\t-r\tprint the operating system release\n" \
2654 "\t-s\tprint the operating system name\n" \
2655 "\t-p\tprint the host processor type\n" \
2656 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002657#define uname_example_usage \
2658 "$ uname -a\n" \
Eric Andersen7f48a952003-12-28 05:06:56 +00002659 "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 +00002660
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00002661#define uncompress_trivial_usage \
2662 "[-c] [-f] [ name ... ]"
2663#define uncompress_full_usage \
2664 "Uncompress .Z file[s]\n" \
2665 "Options:\n" \
2666 "\t-c\textract to stdout\n" \
2667 "\t-f\tforce overwrite an existing file\n"
Tim Riker7b253f82003-12-28 05:02:40 +00002668
Eric Andersen7e9276b2001-02-22 01:15:47 +00002669#define uniq_trivial_usage \
2670 "[OPTION]... [INPUT [OUTPUT]]"
2671#define uniq_full_usage \
2672 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00002673 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002674 "Options:\n" \
2675 "\t-c\tprefix lines by the number of occurrences\n" \
2676 "\t-d\tonly print duplicate lines\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002677 "\t-u\tonly print unique lines\n" \
2678 "\t-f N\tskip the first N fields\n" \
2679 "\t-s N\tskip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002680#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002681 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002682 "a\n" \
2683 "b\n" \
2684 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002685
2686#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002687 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002688#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002689 "Converts FILE from unix format to dos format. When no option\n" \
2690 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002691 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002692 "Options:\n" \
2693 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002694 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002695
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002696#define unzip_trivial_usage \
2697 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
2698#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002699 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002700 "Options:\n" \
2701 "\t-l\tlist archive contents (short form)\n" \
2702 "\t-n\tnever overwrite existing files (default)\n" \
2703 "\t-o\toverwrite files without prompting\n" \
2704 "\t-p\tsend output to stdout\n" \
2705 "\t-q\tbe quiet\n" \
2706 "\t-x\texclude these files\n" \
2707 "\t-d\textract files into this directory"
2708
Eric Andersen7e9276b2001-02-22 01:15:47 +00002709#define uptime_trivial_usage \
2710 ""
2711#define uptime_full_usage \
2712 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002713#define uptime_example_usage \
2714 "$ uptime\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002715 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002716
2717#define usleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002718 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002719#define usleep_full_usage \
2720 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002721#define usleep_example_usage \
2722 "$ usleep 1000000\n" \
2723 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002724
2725#define uudecode_trivial_usage \
2726 "[FILE]..."
2727#define uudecode_full_usage \
2728 "Uudecode a file that is uuencoded.\n\n" \
2729 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002730 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002731#define uudecode_example_usage \
2732 "$ uudecode -o busybox busybox.uu\n" \
2733 "$ ls -l busybox\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002734 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002735
2736#define uuencode_trivial_usage \
2737 "[OPTION] [INFILE] REMOTEFILE"
2738#define uuencode_full_usage \
2739 "Uuencode a file.\n\n" \
2740 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00002741 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002742#define uuencode_example_usage \
2743 "$ uuencode busybox busybox\n" \
2744 "begin 755 busybox\n" \
2745 "<encoded file snipped>\n" \
2746 "$ uudecode busybox busybox > busybox.uu\n" \
2747 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002748
Eric Andersen853c4942003-01-23 05:59:32 +00002749#define vconfig_trivial_usage \
2750 "COMMAND [OPTIONS] ..."
2751
2752#define vconfig_full_usage \
2753"Usage: add [interface-name] [vlan_id] \n" \
2754" rem [vlan-name] \n" \
2755" set_flag [interface-name] [flag-num] [0 | 1] \n" \
2756" set_egress_map [vlan-name] [skb_priority] [vlan_qos] \n" \
2757" set_ingress_map [vlan-name] [skb_priority] [vlan_qos] \n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002758" set_name_type [name-type] \n"
Eric Andersen853c4942003-01-23 05:59:32 +00002759
Eric Andersen3f980402001-04-04 17:31:15 +00002760#define vi_trivial_usage \
2761 "[OPTION] [FILE]..."
2762#define vi_full_usage \
2763 "edit FILE.\n\n" \
2764 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002765 "\t-R\tRead-only- do not write to the file."
Eric Andersen3f980402001-04-04 17:31:15 +00002766
Eric Andersen27f64e12002-06-23 04:24:25 +00002767#define vlock_trivial_usage \
2768 "[OPTIONS]"
2769#define vlock_full_usage \
2770 "Lock a virtual terminal. A password is required to unlock\n" \
2771 "Options:\n" \
2772 "\t-a\tLock all VTs"
2773
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002774#define watch_trivial_usage \
2775 "[-n <seconds>] COMMAND..."
2776#define watch_full_usage \
2777 "Executes a program periodically.\n" \
2778 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002779 "\t-n\tLoop period in seconds - default is 2."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002780#define watch_example_usage \
2781 "$ watch date\n" \
2782 "Mon Dec 17 10:31:40 GMT 2000\n" \
2783 "Mon Dec 17 10:31:42 GMT 2000\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002784 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002785
Eric Andersen7e9276b2001-02-22 01:15:47 +00002786#define watchdog_trivial_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00002787 "[-t <seconds>] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002788#define watchdog_full_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00002789 "Periodically write to watchdog device DEV.\n" \
2790 "Options:\n" \
2791 "\t-t\tTimer period in seconds - default is 30."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002792
2793#define wc_trivial_usage \
2794 "[OPTION]... [FILE]..."
2795#define wc_full_usage \
2796 "Print line, word, and byte counts for each FILE, and a total line if\n" \
2797 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
2798 "Options:\n" \
2799 "\t-c\tprint the byte counts\n" \
2800 "\t-l\tprint the newline counts\n" \
2801 "\t-L\tprint the length of the longest line\n" \
2802 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002803#define wc_example_usage \
2804 "$ wc /etc/passwd\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002805 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002806
2807#define wget_trivial_usage \
Robert Griebld7760112002-05-14 23:36:45 +00002808 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n\t[--header 'header: value'] [-Y|--proxy on/off] [-P DIR] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002809#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00002810 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002811 "Options:\n" \
2812 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00002813 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00002814 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00002815 "\t-O\tsave to filename ('-' for stdout)\n" \
2816 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002817
2818#define which_trivial_usage \
2819 "[COMMAND ...]"
2820#define which_full_usage \
2821 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002822#define which_example_usage \
2823 "$ which login\n" \
2824 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00002825
Eric Andersen00a6a752002-04-26 23:53:10 +00002826#define who_trivial_usage \
2827 " "
2828#define who_full_usage \
2829 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002830
2831#define whoami_trivial_usage \
2832 ""
2833#define whoami_full_usage \
2834 "Prints the user name associated with the current effective user id."
2835
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002836#ifdef CONFIG_FEATURE_XARGS_SUPPORT_CONFIRMATION
2837#define USAGE_XARGS_CONFIRMATION(a) a
2838#else
2839#define USAGE_XARGS_CONFIRMATION(a)
2840#endif
2841#ifdef CONFIG_FEATURE_XARGS_SUPPORT_TERMOPT
2842#define USAGE_XARGS_TERMOPT(a) a
2843#else
2844#define USAGE_XARGS_TERMOPT(a)
2845#endif
2846#ifdef CONFIG_FEATURE_XARGS_SUPPORT_ZERO_TERM
2847#define USAGE_XARGS_ZERO_TERM(a) a
2848#else
2849#define USAGE_XARGS_ZERO_TERM(a)
2850#endif
2851
2852
Eric Andersen7e9276b2001-02-22 01:15:47 +00002853#define xargs_trivial_usage \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002854 "[COMMAND] [OPTIONS] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002855#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002856 "Executes COMMAND on every item given by standard input.\n\n" \
2857 "Options:\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002858 USAGE_XARGS_CONFIRMATION("\t-p\tPrompt the user about whether to run each command\n") \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002859 "\t-r\tDo not run command for empty readed lines\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002860 USAGE_XARGS_TERMOPT("\t-x\tExit if the size is exceeded\n") \
2861 USAGE_XARGS_ZERO_TERM("\t-0\tInput filenames are terminated by a null character\n") \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002862 "\t-t\tPrint the command line on stderr before executing it."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002863#define xargs_example_usage \
2864 "$ ls | xargs gzip\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002865 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002866
2867#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002868 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002869#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002870 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002871
Eric Andersen7e9276b2001-02-22 01:15:47 +00002872#define zcat_trivial_usage \
2873 "FILE"
2874#define zcat_full_usage \
2875 "Uncompress to stdout."