blob: bbc0babfc72996b51503b5a632738f30fae3595e [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" \
13 "\t-h\t\thome directory\n" \
14 "\t-s\t\tshell\n" \
15 "\t-g\t\tGECOS string\n"
16
Mark Whitley6f932772001-03-20 19:18:10 +000017#define adjtimex_trivial_usage \
18 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
19#define adjtimex_full_usage \
20 "Reads and optionally sets system timebase parameters.\n" \
21 "See adjtimex(2).\n\n" \
22 "Options:\n" \
23 "\t-q\t\tquiet mode - do not print\n" \
24 "\t-o offset\ttime offset, microseconds\n" \
25 "\t-f frequency\tfrequency adjust, integer kernel units (65536 is 1ppm)\n" \
26 "\t\t\t(positive values make the system clock run fast)\n" \
27 "\t-t tick\t\tmicroseconds per tick, usually 10000\n" \
28 "\t-p timeconstant\n"
29
Eric Andersen7e9276b2001-02-22 01:15:47 +000030#define ar_trivial_usage \
Glenn L McGrath62ebe2e2001-06-03 05:41:59 +000031 "-[ov][ptx] ARCHIVE FILES"
Eric Andersen7e9276b2001-02-22 01:15:47 +000032#define ar_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +000033 "Extract or list FILES from an ar archive.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +000034 "Options:\n" \
35 "\t-o\t\tpreserve original dates\n" \
36 "\t-p\t\textract to stdout\n" \
37 "\t-t\t\tlist\n" \
38 "\t-x\t\textract\n" \
Glenn L McGrathcda5cf12001-06-03 05:15:04 +000039 "\t-v\t\tverbosely list files processed\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000040
Glenn L McGrath9e598412003-01-09 10:06:01 +000041#define arping_trivial_usage \
42 "[-fqbDUA] [-c count] [-w timeout] [-I device] [-s sender] target\n"
43#define arping_full_usage \
44 "Ping hosts by ARP requests/replies.\n\n" \
45 "Options:\n" \
46 "\t-f\t\tQuit on first ARP reply\n" \
47 "\t-q\t\tBe quiet\n" \
48 "\t-b\t\tKeep broadcasting, don't go unicast\n" \
49 "\t-D\t\tDuplicated address detection mode\n" \
50 "\t-U\t\tUnsolicited ARP mode, update your neighbours\n" \
51 "\t-A\t\tARP answer mode, update your neighbours\n" \
52 "\t-c count\tStop after sending count ARP request packets\n" \
53 "\t-w timeout\tTime to wait for ARP reply, in seconds\n" \
54 "\t-I device\tOutgoing interface name, default is eth0\n" \
55 "\t-s sender\tSet specific sender IP address\n" \
56 "\ttarget\t\tTarget IP address of ARP request\n"
57
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000058#define awk_trivial_usage \
59 "[-v var=val][-F sep] { -f progname | 'programtext' } [FILE ...]"
60#define awk_full_usage \
61 "Options:\n" \
62 "\t-v var=val\tassign value 'val' to variable 'var'\n" \
63 "\t-F sep\t\tuse 'sep' as field separator\n" \
64 "\t-f progname\tread program source from file 'progname'\n"
65
Eric Andersen7e9276b2001-02-22 01:15:47 +000066#define basename_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000067 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000068#define basename_full_usage \
69 "Strips directory path and suffixes from FILE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000070 "If specified, also removes any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000071#define basename_example_usage \
72 "$ basename /usr/local/bin/foo\n" \
73 "foo\n" \
74 "$ basename /usr/local/bin/\n" \
75 "bin\n" \
76 "$ basename /foo/bar.txt .txt\n" \
77 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000078
Glenn L McGrath24e28332001-10-05 03:48:57 +000079#define bunzip2_trivial_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000080 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +000081#define bunzip2_full_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000082 "Uncompress FILE (or standard input if FILE is '-' or omitted).\n\n" \
83 "Options:\n" \
84 "\t-c\tWrite output to standard output\n" \
85 "\t-f\tForce"
Glenn L McGrath24e28332001-10-05 03:48:57 +000086
Glenn L McGrathfff11f12001-11-18 14:20:25 +000087#define bzcat_trivial_usage \
88 "FILE"
89#define bzcat_full_usage \
90 "Uncompress to stdout."
91
Eric Andersenc98c0622001-12-06 15:16:43 +000092#define cal_trivial_usage \
93 "[-jy] [[month] year]"
94#define cal_full_usage \
95 "Display a calendar.\n" \
96 "\nOptions:\n" \
97 "\t-j\tUse julian dates.\n" \
98 "\t-y\tDisplay the entire year."
99
Eric Andersen7e9276b2001-02-22 01:15:47 +0000100#define cat_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000101 "[-u] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000102#define cat_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000103 "Concatenates FILE(s) and prints them to stdout.\n\n" \
104 "Options:\n" \
105 "\t-u\tignored since unbuffered i/o is always used"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000106#define cat_example_usage \
107 "$ cat /proc/uptime\n" \
108 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000109
Eric Andersen7e9276b2001-02-22 01:15:47 +0000110#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000111 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000112#define chgrp_full_usage \
113 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000114 "\nOptions:\n" \
115 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000116#define chgrp_example_usage \
117 "$ ls -l /tmp/foo\n" \
118 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
119 "$ chgrp root /tmp/foo\n" \
120 "$ ls -l /tmp/foo\n" \
121 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000122
Eric Andersen7e9276b2001-02-22 01:15:47 +0000123#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000124 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000125#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000126 "Each MODE is one or more of the letters ugoa, one of the\n" \
127 "symbols +-= and one or more of the letters rwxst.\n\n" \
128 "Options:\n" \
129 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000130#define chmod_example_usage \
131 "$ ls -l /tmp/foo\n" \
132 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
133 "$ chmod u+x /tmp/foo\n" \
134 "$ ls -l /tmp/foo\n" \
135 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
136 "$ chmod 444 /tmp/foo\n" \
137 "$ ls -l /tmp/foo\n" \
138 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000139
Eric Andersen7e9276b2001-02-22 01:15:47 +0000140#define chown_trivial_usage \
Eric Andersen238da242001-05-11 16:31:46 +0000141 "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000142#define chown_full_usage \
143 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000144 "\nOptions:\n" \
Eric Andersen238da242001-05-11 16:31:46 +0000145 "\t-R\tChanges files and directories recursively.\n" \
146 "\t-h\tDo not dereference symbolic links."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000147#define chown_example_usage \
148 "$ ls -l /tmp/foo\n" \
149 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
150 "$ chown root /tmp/foo\n" \
151 "$ ls -l /tmp/foo\n" \
152 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
153 "$ chown root.root /tmp/foo\n" \
154 "ls -l /tmp/foo\n" \
155 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000156
Eric Andersen7e9276b2001-02-22 01:15:47 +0000157#define chroot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000158 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000159#define chroot_full_usage \
160 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000161#define chroot_example_usage \
162 "$ ls -l /bin/ls\n" \
163 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
164 "$ mount /dev/hdc1 /mnt -t minix\n" \
165 "$ chroot /mnt\n" \
166 "$ ls -l /bin/ls\n" \
167 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000168
Eric Andersen7e9276b2001-02-22 01:15:47 +0000169#define chvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000170 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000171#define chvt_full_usage \
172 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000173
Eric Andersen7e9276b2001-02-22 01:15:47 +0000174#define clear_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000175 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000176#define clear_full_usage \
177 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000178
Eric Andersen7e9276b2001-02-22 01:15:47 +0000179#define cmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000180 "FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000181#define cmp_full_usage \
Mark Whitley207587a2001-04-25 20:41:02 +0000182 "\t-s\tquiet mode - do not print\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000183 "Compare files."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000184
Eric Andersen7e9276b2001-02-22 01:15:47 +0000185#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000186 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000187#define cp_full_usage \
188 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
189 "\n" \
190 "\t-a\tSame as -dpR\n" \
191 "\t-d\tPreserves links\n" \
192 "\t-p\tPreserves file attributes if possible\n" \
193 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000194 "\t-R\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000195
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000196#define cpio_trivial_usage \
197 "-[dimtuv][F cpiofile]"
198#define cpio_full_usage \
199 "Extract or list files from a cpio archive\n" \
200 "Main operation mode:\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000201 "\td\t\tmake leading directories\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000202 "\ti\t\textract\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000203 "\tm\t\tpreserve mtime\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000204 "\tt\t\tlist\n" \
Eric Andersen6925d502001-12-16 09:23:09 +0000205 "\tu\t\tunconditional overwrite\n" \
206 "\tF\t\tinput from file"
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000207
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000208#define crond_trivial_usage \
209 "-d[#] -c <crondir> -f -b"
210#define crond_full_usage \
211 "\t-d [#] -l [#] -S -L logfile -f -b -c dir\n" \
212 "\t-d num\tdebug level\n" \
213 "\t-l num\tlog level (8 - default)\n" \
214 "\t-S\tlog to syslod (defualt)\n" \
215 "\t-L file\tlog to file\n" \
216 "\t-f\trun in fordeground\n" \
217 "\t-b\trun in background (default)\n" \
218 "\t-c dir\tworking dir"
219
220#define crontab_trivial_usage \
221 "crontab [-c dir] {file|-}|[-u|-l|-e|-d user]"
222#define crontab_full_usage \
223 "\tfile <opts> replace crontab from file\n" \
224 "\t- <opts> replace crontab from stdin\n" \
225 "\t-u user specify user\n" \
226 "\t-l [user] list crontab for user\n" \
227 "\t-e [user] edit crontab for user\n" \
228 "\t-d [user] delete crontab for user\n" \
229 "\t-c dir specify crontab directory"
230
231
Eric Andersen7e9276b2001-02-22 01:15:47 +0000232#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000233 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000234#define cut_full_usage \
235 "Prints selected fields from each input FILE to standard output.\n\n" \
236 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000237 "\t-b LIST\t\tOutput only bytes from LIST\n" \
238 "\t-c LIST\t\tOutput only characters from LIST\n" \
239 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
240 "\t-s\t\tOutput only the lines containing delimiter\n" \
241 "\t-f N\t\tPrint only these fields\n" \
242 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000243#define cut_example_usage \
244 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
245 "Hello\n" \
246 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
247 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000248
Eric Andersen7e9276b2001-02-22 01:15:47 +0000249#define date_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000250 "[OPTION]... [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000251#define date_full_usage \
252 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000253 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000254 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000255 "\t-d STRING\tdisplay time described by STRING, not `now'\n" \
256 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000257 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000258#define date_example_usage \
259 "$ date\n" \
260 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000261
Eric Andersen7e9276b2001-02-22 01:15:47 +0000262#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000263 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000264#define dc_full_usage \
265 "This is a Tiny RPN calculator that understands the\n" \
266 "following operations: +, -, /, *, and, or, not, eor.\n" \
Glenn L McGrath6d074322002-12-12 10:31:53 +0000267 "i.e., 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16" \
268 "p - Prints the value on the top of the stack, without altering the stack.\n" \
269 "f - Prints the entire contents of the stack without altering anything.\n" \
270 "o - Pops the value off the top of the stack and uses it to set the output radix.\n" \
271 " Only 10 and 16 are supported.\n"
272
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000273#define dc_example_usage \
274 "$ dc 2 2 +\n" \
275 "4\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000276 "$ dc 8 8 * 2 2 + /\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000277 "16\n" \
278 "$ dc 0 1 and\n" \
279 "0\n" \
280 "$ dc 0 1 or\n" \
281 "1\n" \
282 "$ echo 72 9 div 8 mul | dc\n" \
283 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000284
Eric Andersen7e9276b2001-02-22 01:15:47 +0000285#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000286 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000287 "\t [seek=N] [conv=notrunc|noerror|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000288#define dd_full_usage \
289 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000290 "\tif=FILE\t\tread from FILE instead of stdin\n" \
291 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
292 "\tbs=N\t\tread and write N bytes at a time\n" \
293 "\tcount=N\t\tcopy only N input blocks\n" \
294 "\tskip=N\t\tskip N input blocks\n" \
295 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000296 "\tconv=notrunc\tdon't truncate output file\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000297 "\tconv=noerror\tcontinue after read errors\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000298 "\tconv=sync\tpad blocks with zeros\n" \
299 "\n" \
300 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000301 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000302#define dd_example_usage \
303 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
304 "4+0 records in\n" \
305 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000306
Eric Andersen7e9276b2001-02-22 01:15:47 +0000307#define deallocvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000308 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000309#define deallocvt_full_usage \
310 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000311
Eric Andersenf349e972001-08-21 16:18:59 +0000312#define delgroup_trivial_usage \
313 "GROUP"
314#define delgroup_full_usage \
315 "Deletes group GROUP from the system"
316
317#define deluser_trivial_usage \
318 "USER"
319#define deluser_full_usage \
320 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000321
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000322#ifdef CONFIG_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000323 #define USAGE_HUMAN_READABLE(a) a
324 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000325#else
Eric Andersened0d9582001-02-23 13:23:03 +0000326 #define USAGE_HUMAN_READABLE(a)
327 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000328#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000329#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000330 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000331#define df_full_usage \
332 "Print the filesystem space used and space available.\n\n" \
333 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000334 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000335 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
336 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000337 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000338 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000339#define df_example_usage \
340 "$ df\n" \
341 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
342 "/dev/sda3 8690864 8553540 137324 98% /\n" \
343 "/dev/sda1 64216 36364 27852 57% /boot\n" \
344 "$ df /dev/sda3\n" \
345 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
346 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000347
Eric Andersen7e9276b2001-02-22 01:15:47 +0000348#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000349 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000350#define dirname_full_usage \
351 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000352#define dirname_example_usage \
353 "$ dirname /tmp/foo\n" \
354 "/tmp\n" \
355 "$ dirname /tmp/foo/\n" \
356 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000357
Eric Andersen7e9276b2001-02-22 01:15:47 +0000358#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000359 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000360#define dmesg_full_usage \
361 "Prints or controls the kernel ring buffer\n\n" \
362 "Options:\n" \
363 "\t-c\t\tClears the ring buffer's contents after printing\n" \
364 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000365 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000366
Eric Andersen7e9276b2001-02-22 01:15:47 +0000367#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000368 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000369#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000370 "Converts FILE from dos format to unix format. When no option\n" \
371 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000372 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000373 "Options:\n" \
374 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000375 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000376
Eric Andersen7e9276b2001-02-22 01:15:47 +0000377#define dpkg_trivial_usage \
Eric Andersen9fe5f982002-04-13 14:48:51 +0000378 "-i package_file\n" \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000379 "[-CPru] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000380#define dpkg_full_usage \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000381 "\t-i\tInstall the package\n" \
382 "\t-C\tConfigure an unpackaged package\n" \
383 "\t-P\tPurge all files of a package\n" \
384 "\t-r\tRemove all but the configuration files for a package\n" \
385 "\t-u\tUnpack a package, but dont configure it\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000386
Eric Andersen7e9276b2001-02-22 01:15:47 +0000387#define dpkg_deb_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000388 "[-cefItxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000389#define dpkg_deb_full_usage \
390 "Perform actions on debian packages (.debs)\n\n" \
391 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000392 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000393 "\t-e\tExtract control files to [argument] directory\n" \
394 "\t-f\tDisplay control field name starting with [argument]\n" \
395 "\t-I\tDisplay the control filenamed [argument]\n" \
396 "\t-t\tExtract filesystem tree to stdout in tar format\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000397 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000398 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000399#define dpkg_deb_example_usage \
400 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000401
Manuel Novoa III cad53642003-03-19 09:13:01 +0000402#ifdef CONFIG_FEATURE_DU_DEFALT_BLOCKSIZE_1K
403#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a) a
404#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a)
405#else
406#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a)
407#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a) a
408#endif
409
Eric Andersen7e9276b2001-02-22 01:15:47 +0000410#define du_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000411 "[-aHLdclsx" USAGE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000412#define du_full_usage \
413 "Summarizes disk space used for each FILE and/or directory.\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000414 "Disk space is printed in units of " \
415 USAGE_DU_DEFALT_BLOCKSIZE_1k("1024") USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k("512") \
416 " bytes.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000417 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000418 "\t-a\tshow sizes of files in addition to directories\n" \
419 "\t-H\tfollow symbolic links that are FILE command line args\n" \
420 "\t-L\tfollow all symbolic links encountered\n" \
421 "\t-d N\tlimit output to directories (and files with -a) of depth < N\n" \
422 "\t-c\toutput a grand total\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000423 "\t-l\tcount sizes many times if hard linked\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000424 "\t-s\tdisplay only a total for each argument\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000425 "\t-x\tskip directories on different filesystems\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000426 USAGE_HUMAN_READABLE( \
427 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
428 "\t-m\tprint sizes in megabytes\n" ) \
429 "\t-k\tprint sizes in kilobytes" USAGE_DU_DEFALT_BLOCKSIZE_1k("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000430#define du_example_usage \
431 "$ du\n" \
432 "16 ./CVS\n" \
433 "12 ./kernel-patches/CVS\n" \
434 "80 ./kernel-patches\n" \
435 "12 ./tests/CVS\n" \
436 "36 ./tests\n" \
437 "12 ./scripts/CVS\n" \
438 "16 ./scripts\n" \
439 "12 ./docs/CVS\n" \
440 "104 ./docs\n" \
441 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000442
Eric Andersen7e9276b2001-02-22 01:15:47 +0000443#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000444 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000445#define dumpkmap_full_usage \
446 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000447#define dumpkmap_example_usage \
448 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000449
Russ Dill61fb4892002-10-14 21:41:28 +0000450#define dumpleases_trivial_usage \
451 "[-r|-a] [-f LEASEFILE]"
452#define dumpleases_full_usage \
Russ Dill61fb4892002-10-14 21:41:28 +0000453 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
454 "\t-r,\t--remaining\tInterepret lease times as time remaing\n" \
455 "\t-a,\t--absolute\tInterepret lease times as expire time\n"
456
Eric Andersen7e9276b2001-02-22 01:15:47 +0000457#define dutmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000458 "[FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000459#define dutmp_full_usage \
460 "Dump utmp file format (pipe delimited) from FILE\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000461 "or stdin to stdout. (i.e., 'dutmp /var/run/utmp')"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000462#define dutmp_example_usage \
463 "$ dutmp /var/run/utmp\n" \
464 "8|7||si|||0|0|0|955637625|760097|0\n" \
465 "2|0|~|~~|reboot||0|0|0|955637625|782235|0\n" \
466 "1|20020|~|~~|runlevel||0|0|0|955637625|800089|0\n" \
467 "8|125||l4|||0|0|0|955637629|998367|0\n" \
468 "6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0\n" \
469 "6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000470 "7|336|pts/0|vt00|andersen|:0.0|0|0|0|955637763|0|0\n"
471
472#ifdef CONFIG_FEATURE_FANCY_ECHO
473 #define USAGE_FANCY_ECHO(a) a
474#else
475 #define USAGE_FANCY_ECHO(a)
476#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000477
Eric Andersen7e9276b2001-02-22 01:15:47 +0000478#define echo_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000479 USAGE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000480#define echo_full_usage \
481 "Prints the specified ARGs to stdout\n\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000482 USAGE_FANCY_ECHO("Options:\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000483 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000484 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000485 "\t-E\tdisable interpretation of backslash-escaped characters")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000486#define echo_example_usage \
487 "$ echo "Erik is cool"\n" \
488 "Erik is cool\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000489 USAGE_FANCY_ECHO("$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000490 "Erik\n" \
491 "is\n" \
492 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000493 "$ echo "Erik\\nis\\ncool"\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000494 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000495
Eric Andersen84e229c2001-03-29 22:48:33 +0000496#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000497 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000498#define env_full_usage \
499 "Prints the current environment or runs a program after setting\n" \
500 "up the specified environment.\n\n" \
501 "Options:\n" \
502 "\t-, -i\tstart with an empty environment\n" \
503 "\t-u\tremove variable from the environment\n"
504
Eric Andersen7e9276b2001-02-22 01:15:47 +0000505#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000506 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000507#define expr_full_usage \
508 "Prints the value of EXPRESSION to standard output.\n\n" \
509 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000510 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
511 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
512 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
513 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
514 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
515 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
516 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
517 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
518 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
519 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
520 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
521 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
522 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000523 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
524 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
525 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
526 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
527 "\t or 0\n" \
528 "\tlength STRING length of STRING\n" \
529 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
530 "\t it is a keyword like `match' or an\n" \
531 "\t operator like `/'\n" \
532 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000533 "Beware that many operators need to be escaped or quoted for shells.\n" \
534 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
535 "lexicographical. Pattern matches return the string matched between \n" \
536 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
537 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000538
Eric Andersen7e9276b2001-02-22 01:15:47 +0000539#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000540 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000541#define false_full_usage \
542 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000543#define false_example_usage \
544 "$ false\n" \
545 "$ echo $?\n" \
546 "1\n"
547
548#define fbset_trivial_usage \
549 "[options] [mode]"
550#define fbset_full_usage \
551 "Show and modify frame buffer settings"
552#define fbset_example_usage \
553 "$ fbset\n" \
554 "mode "1024x768-76"\n" \
555 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
556 "\tgeometry 1024 768 1024 768 16\n" \
557 "\ttimings 12714 128 32 16 4 128 4\n" \
558 "\taccel false\n" \
559 "\trgba 5/11,6/5,5/0,0/0\n" \
560 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000561
Eric Andersen7e9276b2001-02-22 01:15:47 +0000562#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000563 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000564#define fdflush_full_usage \
565 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000566
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000567#define fdisk_trivial_usage \
568 "[-l] [-v] [-b SSZ] [-u] DISK"
569#define fdisk_full_usage \
570 "Change partition table\n" \
571 "Options:\n" \
572 "-l List partition table(s)\n" \
573 "-u Give Start and End in sector (instead of cylinder) units\n" \
574 "-s PARTITION Give partition size(s) in blocks\n" \
575 "-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
Glenn L McGrath062c74f2002-11-27 09:29:49 +0000576 "-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000577
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000578#ifdef CONFIG_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000579 #define USAGE_FIND_TYPE(a) a
580#else
581 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000582#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000583#ifdef CONFIG_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000584 #define USAGE_FIND_PERM(a) a
585#else
586 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000587#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000588#ifdef CONFIG_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000589 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000590#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000591 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000592#endif
Eric Andersen97d86f22003-01-23 05:27:42 +0000593#ifdef CONFIG_FEATURE_FIND_NEWER
594 #define USAGE_FIND_NEWER(a) a
595#else
596 #define USAGE_FIND_NEWER(a)
597#endif
598#ifdef CONFIG_FEATURE_FIND_INUM
599 #define USAGE_FIND_INUM(a) a
600#else
601 #define USAGE_FIND_INUM(a)
602#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000603
Eric Andersen7e9276b2001-02-22 01:15:47 +0000604#define find_trivial_usage \
605 "[PATH...] [EXPRESSION]"
606#define find_full_usage \
607 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000608 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000609 "\nEXPRESSION may consist of:\n" \
610 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000611 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000612 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000613 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000614 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
615) USAGE_FIND_PERM( \
616 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
617) USAGE_FIND_MTIME( \
Eric Andersen97d86f22003-01-23 05:27:42 +0000618 "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \
619) USAGE_FIND_NEWER( \
620 "\n\t-newer FILE\tModified time is more recent than FILE's" \
621) USAGE_FIND_INUM( \
622 "\n\t-inum N\t\tFile has inode number N")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000623#define find_example_usage \
624 "$ find / -name /etc/passwd\n" \
625 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000626
Eric Andersen7e9276b2001-02-22 01:15:47 +0000627#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000628 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000629#define free_full_usage \
630 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000631#define free_example_usage \
632 "$ free\n" \
633 " total used free shared buffers\n" \
634 " Mem: 257628 248724 8904 59644 93124\n" \
635 " Swap: 128516 8404 120112\n" \
636 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000637
Eric Andersen7e9276b2001-02-22 01:15:47 +0000638#define freeramdisk_trivial_usage \
639 "DEVICE"
640#define freeramdisk_full_usage \
641 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000642#define freeramdisk_example_usage \
643 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000644
645#define fsck_minix_trivial_usage \
646 "[-larvsmf] /dev/name"
647#define fsck_minix_full_usage \
648 "Performs a consistency check for MINIX filesystems.\n\n" \
649 "Options:\n" \
650 "\t-l\tLists all filenames\n" \
651 "\t-r\tPerform interactive repairs\n" \
652 "\t-a\tPerform automatic repairs\n" \
653 "\t-v\tverbose\n" \
654 "\t-s\tOutputs super-block information\n" \
655 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
656 "\t-f\tForce file system check."
657
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000658#define ftpget_trivial_usage \
659 "[options] remote-host local-directory remote-file"
660#define ftpget_full_usage \
661 "Retrieve a remote file via FTP.\n\n" \
662 "Options:\n" \
663 "\t-c, --continue Continue a previous transfer\n" \
664 "\t-v, --verbose Verbose\n" \
665 "\t-u, --username Username to be used\n" \
666 "\t-p, --password Password to be used\n" \
667 "\t-P, --port Port number to be used\n"
668
669#define ftpput_trivial_usage \
670 "[options] remote-host remote-directory local-file"
671#define ftpput_full_usage \
672 "Store a local file on a remote machine via FTP.\n\n" \
673 "Options:\n" \
674 "\t-v, --verbose Verbose\n" \
675 "\t-u, --username Username to be used\n" \
676 "\t-p, --password Password to be used\n" \
677 "\t-P, --port Port number to be used\n"
678
Eric Andersen7e9276b2001-02-22 01:15:47 +0000679#define getopt_trivial_usage \
680 "[OPTIONS]..."
681#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000682 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000683 "\t-a, --alternative Allow long options starting with single -\n" \
684 "\t-l, --longoptions=longopts Long options to be recognized\n" \
685 "\t-n, --name=progname The name under which errors are reported\n" \
686 "\t-o, --options=optstring Short options to be recognized\n" \
687 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
688 "\t-Q, --quiet-output No normal output\n" \
689 "\t-s, --shell=shell Set shell quoting conventions\n" \
690 "\t-T, --test Test for getopt(1) version\n" \
691 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000692#define getopt_example_usage \
693 "$ cat getopt.test\n" \
694 "#!/bin/sh\n" \
695 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
696 " -n 'example.busybox' -- "$@"`\n" \
697 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
698 "eval set -- "$GETOPT"\n" \
699 "while true ; do\n" \
700 " case $1 in\n" \
701 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000702 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000703 " -c|--c-long)\n" \
704 " case "$2" in\n" \
705 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000706 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000707 " esac ;;\n" \
708 " --) shift ; break ;;\n" \
709 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
710 " esac\n" \
711 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000712
Eric Andersenf349e972001-08-21 16:18:59 +0000713#define getty_trivial_usage \
714 "getty [OPTIONS]... baud_rate,... line [termtype]"
715#define getty_full_usage \
716 "\nOpens a tty, prompts for a login name, then invokes /bin/login\n\n" \
717 "Options:\n" \
718 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
719 "\t-i\t\tDo not display /etc/issue before running login.\n" \
720 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
721 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
722 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
723 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
724 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
725 "\t-I initstring\tSets the init string to send before anything else.\n" \
726 "\t-H login_host\tLog login_host into the utmp file as the hostname."
727
728
Eric Andersen7e9276b2001-02-22 01:15:47 +0000729#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000730 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000731#define grep_full_usage \
732 "Search for PATTERN in each FILE or standard input.\n\n" \
733 "Options:\n" \
734 "\t-H\tprefix output lines with filename where match was found\n" \
735 "\t-h\tsuppress the prefixing filename on output\n" \
736 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000737 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000738 "\t-n\tprint line number with output lines\n" \
739 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
740 "\t-v\tselect non-matching lines\n" \
741 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000742#define grep_example_usage \
743 "$ grep root /etc/passwd\n" \
744 "root:x:0:0:root:/root:/bin/bash\n" \
745 "$ grep ^[rR]oo. /etc/passwd\n" \
746 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000747
Eric Andersen7e9276b2001-02-22 01:15:47 +0000748#define gunzip_trivial_usage \
749 "[OPTION]... FILE"
750#define gunzip_full_usage \
751 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
752 "Options:\n" \
753 "\t-c\tWrite output to standard output\n" \
754 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000755#define gunzip_example_usage \
756 "$ ls -la /tmp/BusyBox*\n" \
757 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
758 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
759 "$ ls -la /tmp/BusyBox*\n" \
760 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000761
762#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000763 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000764#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000765 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000766 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000767 "Options:\n" \
768 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
769 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000770#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000771 "$ ls -la /tmp/busybox*\n" \
772 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
773 "$ gzip /tmp/busybox.tar\n" \
774 "$ ls -la /tmp/busybox*\n" \
775 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000776
777#define halt_trivial_usage \
778 ""
779#define halt_full_usage \
780 "Halt the system."
781
Manuel Novoa III cad53642003-03-19 09:13:01 +0000782#ifdef CONFIG_FEATURE_FANCY_HEAD
783#define USAGE_FANCY_HEAD(a) a
784#else
785#define USAGE_FANCY_HEAD(a)
786#endif
787
Eric Andersen7e9276b2001-02-22 01:15:47 +0000788#define head_trivial_usage \
789 "[OPTION] [FILE]..."
790#define head_full_usage \
791 "Print first 10 lines of each FILE to standard output.\n" \
792 "With more than one FILE, precede each with a header giving the\n" \
793 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000794 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000795 "\t-n NUM\t\tPrint first NUM lines instead of first 10" \
796 USAGE_FANCY_HEAD( \
797 "\n\t-c NUM\t\toutput the first NUM bytes\n" \
798 "\t-q\t\tnever output headers giving file names\n" \
799 "\t-v\t\talways output headers giving file names" )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000800#define head_example_usage \
801 "$ head -n 2 /etc/passwd\n" \
802 "root:x:0:0:root:/root:/bin/bash\n" \
803 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000804
Glenn L McGrath60281112001-11-02 11:39:46 +0000805#define hexdump_trivial_usage \
806 "[-[bcdefnosvx]] [OPTION] FILE"
807#define hexdump_full_usage \
808 "The hexdump utility is a filter which displays the specified files,\n" \
809 "or the standard input, if no files are specified, in a user specified\n"\
810 "format\n" \
811 "\t-b\t\tOne-byte octal display\n" \
812 "\t-c\t\tOne-byte character display\n" \
813 "\t-d\t\tTwo-byte decimal display\n" \
814 "\t-e FORMAT STRING\n" \
815 "\t-f FORMAT FILE\n" \
816 "\t-n LENGTH\tInterpret only length bytes of input\n" \
817 "\t-o\t\tTwo-byte octal display\n" \
818 "\t-s OFFSET\tSkip offset byte\n" \
819 "\t-v\t\tdisplay all input data\n" \
820 "\t-x\t\tTwo-byte hexadecimal display\n"
821
Eric Andersen7e9276b2001-02-22 01:15:47 +0000822#define hostid_trivial_usage \
823 ""
824#define hostid_full_usage \
825 "Print out a unique 32-bit identifier for the machine."
826
827#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000828 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000829#define hostname_full_usage \
830 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000831 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000832 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +0000833 "\t-s\tShort\n" \
834 "\t-i\tAddresses for the hostname\n" \
835 "\t-d\tDNS domain name\n" \
836 "\t-f\tFully qualified domain name\n" \
837 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000838#define hostname_example_usage \
839 "$ hostname\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000840 "sage \n"
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000841#ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH
842 #define USAGE_HTTPD_BASIC_AUTH(a) a
843#else
844 #define USAGE_HTTPD_BASIC_AUTH(a)
845#endif
846#define httpd_trivial_usage \
847 "[-p <port>] [-d/-e <string>]" USAGE_HTTPD_BASIC_AUTH(" [-c <conf file>] [-r <realm>]")
848#define httpd_full_usage \
849 "Listens for incoming http server requests.\n"\
850 "Options:\n" \
851 "\t-p PORT\tServer port (default 80).\n" \
852 USAGE_HTTPD_BASIC_AUTH("\t-c FILE\tSpecifies configuration file. (default httpd.conf)\n\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
853 "\t-e STRING\tHtml encode STRING\n" \
854 "\t-d STRING\tURL decode STRING\n"
Robert Griebl1cd04452002-07-21 16:50:49 +0000855#define hwclock_trivial_usage \
856 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
857#define hwclock_full_usage \
858 "Query and set the hardware clock (RTC)\n\n" \
859 "Options:\n" \
860 "\t-r\tread hardware clock and print result\n" \
861 "\t-s\tset the system time from the hardware clock\n" \
862 "\t-w\tset the hardware clock to the current system time\n" \
863 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
864 "\t-l\tthe hardware clock is kept in local time"
865
Eric Andersen7e9276b2001-02-22 01:15:47 +0000866#define id_trivial_usage \
867 "[OPTIONS]... [USERNAME]"
868#define id_full_usage \
869 "Print information for USERNAME or the current user\n\n" \
870 "Options:\n" \
871 "\t-g\tprints only the group ID\n" \
872 "\t-u\tprints only the user ID\n" \
873 "\t-n\tprint a name instead of a number (with for -ug)\n" \
874 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000875#define id_example_usage \
876 "$ id\n" \
877 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000878
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000879#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +0000880 #define USAGE_SIOCSKEEPALIVE(a) a
881#else
882 #define USAGE_SIOCSKEEPALIVE(a)
883#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000884#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000885 #define USAGE_IFCONFIG_MII(a) a
886#else
887 #define USAGE_IFCONFIG_MII(a)
888#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000889#ifdef CONFIG_FEATURE_IFCONFIG_HW
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000890 #define USAGE_IFCONFIG_HW(a) a
891#else
892 #define USAGE_IFCONFIG_HW(a)
893#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000894#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000895 #define USAGE_IFCONFIG_OPT_A(a) a
896#else
897 #define USAGE_IFCONFIG_OPT_A(a)
898#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +0000899#ifdef CONFIG_FEATURE_IPV6
900 #define USAGE_IPV6(a) a
901#else
902 #define USAGE_IPV6(a)
903#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000904
Eric Andersen7e9276b2001-02-22 01:15:47 +0000905#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000906 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000907#define ifconfig_full_usage \
908 "configure a network interface\n\n" \
909 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +0000910 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
911 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000912 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000913 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000914 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000915 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
916 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000917 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000918 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
919 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000920 "\t[up|down] ..."
921
Glenn L McGrath021fa7d2002-11-09 09:34:15 +0000922#define ifup_trivial_usage \
923 "<-ahinv> <ifaces...>"
924#define ifup_full_usage \
925 "Usage: ifup <options> <ifaces...>\n\n" \
926 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +0000927 "\t-h\tthis help\n" \
928 "\t-a\tde/configure all interfaces automatically\n" \
929 "\t-i FILE\tuse FILE for interface definitions\n" \
930 "\t-n\tprint out what would happen, but don't do it\n" \
931 "\t\t\t(note that this option doesn't disable mappings)\n" \
932 "\t-v\tprint out what would happen before doing it\n" \
933 "\t-m\tdon't run any mappings\n" \
934 "\t-f\tforce de/configuration\n"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +0000935
936#define ifdown_trivial_usage \
937 "<-ahinv> <ifaces...>"
938#define ifdown_full_usage \
939 "Usage: ifdown <options> <ifaces...>\n\n" \
940 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +0000941 "\t-h\tthis help\n" \
942 "\t-a\tde/configure all interfaces automatically\n" \
943 "\t-i FILE\tuse FILE for interface definitions\n" \
944 "\t-n\tprint out what would happen, but don't do it\n" \
945 "\t\t(note that this option doesn't disable mappings)\n" \
946 "\t-v\tprint out what would happen before doing it\n" \
947 "\t-m\tdon't run any mappings\n" \
948 "\t-f\tforce de/configuration\n"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +0000949
Glenn L McGrath06e95652003-02-09 06:51:14 +0000950#define inetd_trivial_usage \
951 "[-q len] [conf]"
952#define inetd_full_usage \
953 "Usage: [-q len] [conf]\n\n" \
954 "Option:\n" \
955 "\t-q\tSets the size of the socket listen queue to\n" \
956 "the specified value. Default is 128."
957
Eric Andersen7e9276b2001-02-22 01:15:47 +0000958#define init_trivial_usage \
959 ""
960#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000961 "Init is the parent of all processes."
962#define init_notes_usage \
963"This version of init is designed to be run only by the kernel.\n" \
964"\n" \
965"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
966"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
967"runlevels, use sysvinit.\n" \
968"\n" \
969"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
970"it has the following default behavior:\n" \
971"\n" \
972" ::sysinit:/etc/init.d/rcS\n" \
973" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000974" ::ctrlaltdel:/sbin/reboot\n" \
975" ::shutdown:/sbin/swapoff -a\n" \
976" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000977" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000978"\n" \
979"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
980"\n" \
981" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000982" tty3::askfirst:/bin/sh\n" \
983" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000984"\n" \
985"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
986"\n" \
987" <id>:<runlevels>:<action>:<process>\n" \
988"\n" \
989" <id>: \n" \
990"\n" \
991" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
992" The id field is used by BusyBox init to specify the controlling tty for\n" \
993" the specified process to run on. The contents of this field are\n" \
994" appended to "/dev/" and used as-is. There is no need for this field to\n" \
995" be unique, although if it isn't you may have strange results. If this\n" \
996" field is left blank, the controlling tty is set to the console. Also\n" \
997" note that if BusyBox detects that a serial console is in use, then only\n" \
998" entries whose controlling tty is either the serial console or /dev/null\n" \
999" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1000" stinkin' utmp.\n" \
1001"\n" \
1002" <runlevels>: \n" \
1003"\n" \
1004" The runlevels field is completely ignored.\n" \
1005"\n" \
1006" <action>: \n" \
1007"\n" \
1008" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001009" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001010"\n" \
1011" The available actions can be classified into two groups: actions\n" \
1012" that are run only once, and actions that are re-run when the specified\n" \
1013" process exits.\n" \
1014"\n" \
1015" Run only-once actions:\n" \
1016"\n" \
1017" 'sysinit' is the first item run on boot. init waits until all\n" \
1018" sysinit actions are completed before continuing. Following the\n" \
1019" completion of all sysinit actions, all 'wait' actions are run.\n" \
1020" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001021" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001022" therefore, init does not wait for them to complete. 'restart' is\n" \
1023" the action taken to restart the init process. By default this should\n" \
1024" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1025" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001026" actions are run when the system detects that someone on the system\n" \
1027" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1028" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1029" Finally the 'shutdown' action specifies the actions to taken when\n" \
1030" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1031" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001032"\n" \
1033" Run repeatedly actions:\n" \
1034"\n" \
1035" 'respawn' actions are run after the 'once' actions. When a process\n" \
1036" started with a 'respawn' action exits, init automatically restarts\n" \
1037" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1038" respawning out of control. The 'askfirst' actions acts just like\n" \
1039" respawn, except that before running the specified process it\n" \
1040" displays the line "Please press Enter to activate this console."\n" \
1041" and then waits for the user to press enter before starting the\n" \
1042" specified process. \n" \
1043"\n" \
1044" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1045" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001046" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001047"\n" \
1048" <process>: \n" \
1049"\n" \
1050" Specifies the process to be executed and it's command line.\n" \
1051"\n" \
1052"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001053"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001054" # This is run first except when booting in single-user mode.\n" \
1055" #\n" \
1056" ::sysinit:/etc/init.d/rcS\n" \
1057" \n" \
1058" # /bin/sh invocations on selected ttys\n" \
1059" #\n" \
1060" # Start an "askfirst" shell on the console (whatever that may be)\n" \
1061" ::askfirst:-/bin/sh\n" \
1062" # Start an "askfirst" shell on /dev/tty2-4\n" \
1063" tty2::askfirst:-/bin/sh\n" \
1064" tty3::askfirst:-/bin/sh\n" \
1065" tty4::askfirst:-/bin/sh\n" \
1066" \n" \
1067" # /sbin/getty invocations for selected ttys\n" \
1068" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001069" tty4::respawn:/sbin/getty 38400 tty4\n" \
1070" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001071" \n" \
1072" \n" \
1073" # Example of how to put a getty on a serial line (for a terminal)\n" \
1074" #\n" \
1075" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1076" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1077" #\n" \
1078" # Example how to put a getty on a modem line.\n" \
1079" #::respawn:/sbin/getty 57600 ttyS2\n" \
1080" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001081" # Stuff to do when restarting the init process\n" \
1082" ::restart:/sbin/init\n" \
1083" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001084" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001085" ::ctrlaltdel:/sbin/reboot\n" \
1086" ::shutdown:/bin/umount -a -r\n" \
1087" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001088
Eric Andersenbe65c352003-01-23 04:57:35 +00001089#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
1090 #define USAGE_INSMOD_MAP(a) a
1091#else
1092 #define USAGE_INSMOD_MAP(a)
1093#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001094#define insmod_trivial_usage \
1095 "[OPTION]... MODULE [symbol=value]..."
1096#define insmod_full_usage \
1097 "Loads the specified kernel modules into the kernel.\n\n" \
1098 "Options:\n" \
1099 "\t-f\tForce module to load into the wrong kernel version.\n" \
1100 "\t-k\tMake module autoclean-able.\n" \
1101 "\t-v\tverbose output\n" \
1102 "\t-L\tLock to prevent simultaneous loads of a module\n" \
Eric Andersenbe65c352003-01-23 04:57:35 +00001103 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout") \
1104 "\t-x\tdo not export externs\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001105
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001106#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001107 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001108#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001109 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1110 "where OBJECT := { link | addr | route | tunnel }\n" \
1111 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }\n"
1112
1113#define ipaddr_trivial_usage \
1114 "{ {add|del} IFADDR dev STRING | {show|flush} [ dev STRING ] [ to PREFIX ] }"
1115#define ipaddr_full_usage \
1116 "ipaddr {add|del} IFADDR dev STRING\n" \
1117 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
1118 " [ to PREFIX ] [ label PATTERN ]\n" \
1119 "IFADDR := PREFIX | ADDR peer PREFIX\n" \
1120 " [ broadcast ADDR ] [ anycast ADDR ]\n" \
1121 " [ label STRING ] [ scope SCOPE-ID ]\n" \
1122 "SCOPE-ID := [ host | link | global | NUMBER ]\n"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001123
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001124#ifndef CONFIG_FEATURE_IPCALC_FANCY
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001125# define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001126 "[--broadcast] [--netmask] [--network] ipaddr <netmask>"
1127
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001128# define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001129 "Calculate IP network settings from a IP address\n\n" \
1130 "Options:\n" \
1131 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1132 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
1133 "\t-w\t--network\tDisplay calculated network address."
1134#else
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001135# define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001136 "[OPTION]... ipaddr <netmask>"
1137
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001138# define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001139 "Calculate IP network settings from a IP address\n\n" \
1140 "Options:\n" \
1141 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1142 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
1143 "\t-w\t--network\tDisplay calculated network address.\n" \
1144 "\t-h\t--hostname\tDisplay first resolved host name.\n" \
1145 "\t-s\t--silent\tDon't ever display error messages."
1146#endif
1147
1148#define ipcalc_notes_usage \
1149 "ipcalc provides a simple way to calculate IP information for\n" \
1150 "a host. The various options specify what information ipcalc\n" \
1151 "should display on standard out. Multiple options may be\n" \
1152 "specified.\n"
1153
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001154#define iplink_trivial_usage \
1155 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1156#define iplink_full_usage \
1157 "iplink set DEVICE { up | down | arp { on | off } |\n" \
1158 " dynamic { on | off } |\n" \
1159 " mtu MTU }\n" \
1160 "iplink show [ DEVICE ]\n"
1161
1162#define iproute_trivial_usage \
1163 "{ list | flush | { add | del | change | append | replace | monitor } ROUTE }"
1164#define iproute_full_usage \
1165 "iproute { list | flush } SELECTOR\n" \
1166 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
1167 " [ oif STRING ] [ tos TOS ]\n" \
1168 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
1169 "SELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1170 "ROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]\n"
1171
1172#define iptunnel_trivial_usage \
1173 "{ add | change | del | show } [ NAME ] [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
1174#define iptunnel_full_usage \
1175 "iptunnel { add | change | del | show } [ NAME ]\n" \
1176 " [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1177 " [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1178 " [ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]\n"
1179
Eric Andersen7e9276b2001-02-22 01:15:47 +00001180#define kill_trivial_usage \
1181 "[-signal] process-id [process-id ...]"
1182#define kill_full_usage \
1183 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +00001184 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001185 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001186#define kill_example_usage \
1187 "$ ps | grep apache\n" \
1188 "252 root root S [apache]\n" \
1189 "263 www-data www-data S [apache]\n" \
1190 "264 www-data www-data S [apache]\n" \
1191 "265 www-data www-data S [apache]\n" \
1192 "266 www-data www-data S [apache]\n" \
1193 "267 www-data www-data S [apache]\n" \
1194 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001195
1196#define killall_trivial_usage \
1197 "[-signal] process-name [process-name ...]"
1198#define killall_full_usage \
1199 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001200 "Options:\n" \
1201 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001202#define killall_example_usage \
1203 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001204
Mark Whitley6317c4b2001-03-12 22:51:50 +00001205#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001206 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001207#define klogd_full_usage \
1208 "Kernel logger.\n"\
1209 "Options:\n"\
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001210 "\t-c n\tSets the default log level of console messages to n.\n"\
Mark Whitley6317c4b2001-03-12 22:51:50 +00001211 "\t-n\tRun as a foreground process."
1212
Eric Andersen7e9276b2001-02-22 01:15:47 +00001213#define length_trivial_usage \
1214 "STRING"
1215#define length_full_usage \
1216 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001217#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001218 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001219 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001220
1221#define ln_trivial_usage \
1222 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1223#define ln_full_usage \
1224 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
1225 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1226 "Options:\n" \
1227 "\t-s\tmake symbolic links instead of hard links\n" \
1228 "\t-f\tremove existing destination files\n" \
1229 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001230#define ln_example_usage \
1231 "$ ln -s BusyBox /tmp/ls\n" \
1232 "$ ls -l /tmp/ls\n" \
1233 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001234
1235#define loadacm_trivial_usage \
1236 "< mapfile"
1237#define loadacm_full_usage \
1238 "Loads an acm from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001239#define loadacm_example_usage \
1240 "$ loadacm < /etc/i18n/acmname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001241
1242#define loadfont_trivial_usage \
1243 "< font"
1244#define loadfont_full_usage \
1245 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001246#define loadfont_example_usage \
1247 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001248
1249#define loadkmap_trivial_usage \
1250 "< keymap"
1251#define loadkmap_full_usage \
1252 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001253#define loadkmap_example_usage \
1254 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001255
1256#define logger_trivial_usage \
1257 "[OPTION]... [MESSAGE]"
1258#define logger_full_usage \
1259 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1260 "Options:\n" \
1261 "\t-s\tLog to stderr as well as the system log.\n" \
1262 "\t-t\tLog using the specified tag (defaults to user name).\n" \
1263 "\t-p\tEnter the message with the specified priority.\n" \
1264 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001265#define logger_example_usage \
1266 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001267
Robert Griebl1fca5582002-06-04 20:45:46 +00001268#define login_trivial_usage \
1269 "[OPTION]... [username] [ENV=VAR ...]"
1270#define login_full_usage \
1271 "Begin a new session on the system\n\n" \
1272 "Options:\n" \
1273 "\t-f\tDo not authenticate (user already authenticated)\n" \
1274 "\t-h\tName of the remote host for this login.\n" \
1275 "\t-p\tPreserve environment."
1276
Eric Andersen7e9276b2001-02-22 01:15:47 +00001277#define logname_trivial_usage \
1278 ""
1279#define logname_full_usage \
1280 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001281#define logname_example_usage \
1282 "$ logname\n" \
1283 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001284
Mark Whitley6317c4b2001-03-12 22:51:50 +00001285#define logread_trivial_usage \
1286 ""
1287
1288#define logread_full_usage \
1289 "Shows the messages from syslogd (using circular buffer)."
1290
Matt Kraai83788da2002-03-20 17:38:37 +00001291#define losetup_trivial_usage \
1292 "[OPTION]... LOOPDEVICE FILE\n" \
1293 "or: losetup [OPTION]... -d LOOPDEVICE"
1294#define losetup_full_usage \
1295 "Associate LOOPDEVICE with FILE.\n\n" \
1296 "Options:\n" \
1297 "\t-d\t\tDisassociate LOOPDEVICE.\n" \
1298 "\t-o OFFSET\tStart OFFSET bytes into FILE.\n"
1299
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001300#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001301 #define USAGE_LS_TIMESTAMPS(a) a
1302#else
1303 #define USAGE_LS_TIMESTAMPS(a)
1304#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001305#ifdef CONFIG_FEATURE_LS_FILETYPES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001306 #define USAGE_LS_FILETYPES(a) a
1307#else
1308 #define USAGE_LS_FILETYPES(a)
1309#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001310#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001311 #define USAGE_LS_FOLLOWLINKS(a) a
1312#else
1313 #define USAGE_LS_FOLLOWLINKS(a)
1314#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001315#ifdef CONFIG_FEATURE_LS_RECURSIVE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001316 #define USAGE_LS_RECURSIVE(a) a
1317#else
1318 #define USAGE_LS_RECURSIVE(a)
1319#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001320#ifdef CONFIG_FEATURE_LS_SORTFILES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001321 #define USAGE_LS_SORTFILES(a) a
1322#else
1323 #define USAGE_LS_SORTFILES(a)
1324#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001325#ifdef CONFIG_FEATURE_AUTOWIDTH
Eric Andersen7e9276b2001-02-22 01:15:47 +00001326 #define USAGE_AUTOWIDTH(a) a
1327#else
1328 #define USAGE_AUTOWIDTH(a)
1329#endif
1330#define ls_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +00001331 "[-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] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001332#define ls_full_usage \
1333 "List directory contents\n\n" \
1334 "Options:\n" \
1335 "\t-1\tlist files in a single column\n" \
1336 "\t-A\tdo not list implied . and ..\n" \
1337 "\t-a\tdo not hide entries starting with .\n" \
1338 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001339 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001340 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001341 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1342 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001343 "\t-i\tlist the i-node for each file\n" \
1344 "\t-l\tuse a long listing format\n" \
1345 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001346 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1347 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1348 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1349 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1350 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001351 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001352 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1353 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1354 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1355 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1356 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001357 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001358 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1359 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001360 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersened0d9582001-02-23 13:23:03 +00001361 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +00001362 "\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001363
1364#define lsmod_trivial_usage \
1365 ""
1366#define lsmod_full_usage \
1367 "List the currently loaded kernel modules."
1368
1369#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001370 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001371#define makedevs_full_usage \
1372 "Creates a range of block or character special files\n\n" \
1373 "TYPEs include:\n" \
1374 "\tb:\tMake a block (buffered) device.\n" \
1375 "\tc or u:\tMake a character (un-buffered) device.\n" \
1376 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1377 "FIRST specifies the number appended to NAME to create the first device.\n" \
1378 "LAST specifies the number of the last item that should be created.\n" \
1379 "If 's' is the last argument, the base device is created as well.\n\n" \
1380 "For example:\n" \
1381 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001382 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001383#define makedevs_example_usage \
1384 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
1385 "[creates ttyS2-ttyS63]\n" \
1386 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
1387 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001388
Eric Andersen7e9276b2001-02-22 01:15:47 +00001389#define md5sum_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001390 "[OPTION] [FILE]...\n" \
1391 "or: md5sum [OPTION] -c [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001392#define md5sum_full_usage \
1393 "Print or check MD5 checksums.\n\n" \
1394 "Options:\n" \
1395 "With no FILE, or when FILE is -, read standard input.\n\n" \
1396 "\t-b\tread files in binary mode\n" \
1397 "\t-c\tcheck MD5 sums against given list\n" \
1398 "\t-t\tread files in text mode (default)\n" \
1399 "\t-g\tread a string\n" \
1400 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001401 "\t-s\tdon't output anything, status code shows success\n" \
1402 "\t-w\twarn about improperly formated MD5 checksum lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001403#define md5sum_example_usage \
1404 "$ md5sum < busybox\n" \
1405 "6fd11e98b98a58f64ff3398d7b324003\n" \
1406 "$ md5sum busybox\n" \
1407 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1408 "$ md5sum -c -\n" \
1409 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1410 "busybox: OK\n" \
1411 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001412
Glenn L McGrath061c9002002-09-16 04:21:46 +00001413#define mesg_trivial_usage \
1414 "mesg [y|n]"
1415#define mesg_full_usage \
1416 "mesg [Y|N], controls write access to your terminal\n" \
1417 "\ty\tAllow write access to your terminal.\n" \
1418 "\tn\tDisallow write access to your terminal.\n"
1419
Eric Andersen7e9276b2001-02-22 01:15:47 +00001420#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001421 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001422#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001423 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001424 "Options:\n" \
1425 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001426 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001427#define mkdir_example_usage \
1428 "$ mkdir /tmp/foo\n" \
1429 "$ mkdir /tmp/foo\n" \
1430 "/tmp/foo: File exists\n" \
1431 "$ mkdir /tmp/foo/bar/baz\n" \
1432 "/tmp/foo/bar/baz: No such file or directory\n" \
1433 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001434
Eric Andersen7e9276b2001-02-22 01:15:47 +00001435#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001436 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001437#define mkfifo_full_usage \
1438 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1439 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001440 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001441
Eric Andersen7e9276b2001-02-22 01:15:47 +00001442#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001443 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001444#define mkfs_minix_full_usage \
1445 "Make a MINIX filesystem.\n\n" \
1446 "Options:\n" \
1447 "\t-c\t\tCheck the device for bad blocks\n" \
1448 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1449 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1450 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001451 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001452
Eric Andersen7e9276b2001-02-22 01:15:47 +00001453#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001454 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001455#define mknod_full_usage \
1456 "Create a special file (block, character, or pipe).\n\n" \
1457 "Options:\n" \
1458 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1459 "TYPEs include:\n" \
1460 "\tb:\tMake a block (buffered) device.\n" \
1461 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001462 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001463#define mknod_example_usage \
1464 "$ mknod /dev/fd0 b 2 0 \n" \
1465 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001466
Eric Andersen7e9276b2001-02-22 01:15:47 +00001467#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001468 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001469#define mkswap_full_usage \
1470 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001471 "Options:\n" \
1472 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001473 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001474 "\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 +00001475 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001476
Eric Andersen7e9276b2001-02-22 01:15:47 +00001477#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001478 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001479#define mktemp_full_usage \
1480 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001481 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001482#define mktemp_example_usage \
1483 "$ mktemp /tmp/temp.XXXXXX\n" \
1484 "/tmp/temp.mWiLjM\n" \
1485 "$ ls -la /tmp/temp.mWiLjM\n" \
1486 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001487
Eric Andersen8d79ce82001-07-22 23:00:15 +00001488#define modprobe_trivial_usage \
1489 "[FILE ...]"
1490#define modprobe_full_usage \
Eric Andersenabc95682002-07-03 02:52:35 +00001491 "Used for high level module loading and unloading."
Eric Andersen8d79ce82001-07-22 23:00:15 +00001492#define modprobe_example_usage \
1493 "$ modprobe cdrom\n"
1494
Eric Andersen7e9276b2001-02-22 01:15:47 +00001495#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001496 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001497#define more_full_usage \
1498 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001499#define more_example_usage \
1500 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001501
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001502#ifdef CONFIG_FEATURE_MOUNT_LOOP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001503 #define USAGE_MOUNT_LOOP(a) a
1504#else
1505 #define USAGE_MOUNT_LOOP(a)
1506#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001507#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001508 #define USAGE_MTAB(a) a
1509#else
1510 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001511#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001512#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001513 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001514#define mount_full_usage \
1515 "Mount a filesystem\n\n" \
1516 "Flags:\n" \
1517 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001518 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001519 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001520 "\t-n:\t\tDon't write a mount table entry.\n" \
1521 ) \
1522 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1523 "\t-r:\t\tMount the filesystem read-only.\n" \
1524 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1525 "\t-w:\t\tMount for reading and writing (default).\n" \
1526 "\n" \
1527 "Options for use with the \"-o\" flag:\n" \
1528 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1529 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1530 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1531 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001532 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001533 "\tloop:\t\tMounts a file via loop device.\n" \
1534 ) \
1535 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001536 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001537 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001538 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001539 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001540 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001541#define mount_example_usage \
1542 "$ mount\n" \
1543 "/dev/hda3 on / type minix (rw)\n" \
1544 "proc on /proc type proc (rw)\n" \
1545 "devpts on /dev/pts type devpts (rw)\n" \
1546 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1547 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001548
Eric Andersen7e9276b2001-02-22 01:15:47 +00001549#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001550 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001551#define mt_full_usage \
1552 "Control magnetic tape drive operation\n" \
1553 "\nAvailable Opcodes:\n\n" \
1554 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1555 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
1556 "ras3 reset retension rew rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001557 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001558
Eric Andersen7e9276b2001-02-22 01:15:47 +00001559#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001560 "SOURCE DEST\n" \
1561 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001562#define mv_full_usage \
1563 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001564#define mv_example_usage \
1565 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001566
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001567#define nameif_trivial_usage \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001568 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001569#define nameif_full_usage \
1570 "Nameif renaming network interface while it in the down state.\n\n" \
1571 "Options:\n" \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001572 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001573 "\t-s\t\tUse syslog (LOCAL0 facility).\n" \
1574 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address\n"
1575#define nameif_example_usage \
1576 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
1577 " or\n" \
1578 "$ nameif -c /etc/my_mactab_file\n" \
1579
Eric Andersen7e9276b2001-02-22 01:15:47 +00001580#define nc_trivial_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001581 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001582#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001583 "Netcat opens a pipe to IP:port\n\n" \
1584 "Options:\n" \
1585 "\t-l\t\tlisten mode, for inbound connects\n" \
1586 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00001587 "\t-i SECS\t\tdelay interval for lines sent\n" \
Eric Andersen00a6a752002-04-26 23:53:10 +00001588 "\t-e PROG\t\tprogram to exec after connect (dangerous!)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001589#define nc_example_usage \
1590 "$ nc foobar.somedomain.com 25\n" \
1591 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1592 "help\n" \
1593 "214-Commands supported:\n" \
1594 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1595 "214 NOOP QUIT RSET HELP\n" \
1596 "quit\n" \
1597 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001598
Eric Andersen1552ff72001-10-31 11:07:12 +00001599#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00001600 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00001601#define netstat_full_usage \
1602 "-l display listening server sockets\n" \
1603 "-a display all sockets (default: connected)\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001604 "-e display other/more information\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001605 "-n don't resolve names\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001606 "-r display routing table\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001607 "-t tcp sockets\n" \
1608 "-u udp sockets\n" \
1609 "-w raw sockets\n" \
1610 "-x unix sockets\n"
1611
Eric Andersen7e9276b2001-02-22 01:15:47 +00001612#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001613 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001614#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001615 "Queries the nameserver for the IP address of the given HOST\n" \
1616 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001617#define nslookup_example_usage \
1618 "$ nslookup localhost\n" \
1619 "Server: default\n" \
1620 "Address: default\n" \
1621 "\n" \
1622 "Name: debian\n" \
1623 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001624
Glenn L McGrath60281112001-11-02 11:39:46 +00001625#define od_trivial_usage \
1626 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
1627#define od_full_usage \
1628 "Write an unambiguous representation, octal bytes by default, of FILE\n"\
1629 "to standard output. With no FILE, or when FILE is -, read standard input."
1630
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00001631#define openvt_trivial_usage \
1632 "<vtnum> <COMMAND> [ARGS...]"
1633#define openvt_full_usage \
1634 "Start a command on a new virtual terminal"
1635#define openvt_example_usage \
1636 "openvt 2 /bin/ash\n"
1637
Eric Andersen27f64e12002-06-23 04:24:25 +00001638#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
1639 #define PASSWORD_ALG_TYPES(a) a
1640#else
1641 #define PASSWORD_ALG_TYPES(a)
1642#endif
1643#define passwd_trivial_usage \
1644 "[OPTION] [name]"
1645#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00001646 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00001647 "changes the password for the current user.\n" \
1648 "Options:\n" \
1649 "\t-a\tDefine which algorithm shall be used for the password.\n" \
1650 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001651 PASSWORD_ALG_TYPES(", sha1") \
Eric Andersen27f64e12002-06-23 04:24:25 +00001652 ")\n\t-d\tDelete the password for the specified user account.\n" \
1653 "\t-l\tLocks (disables) the specified user account.\n" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001654 "\t-u\tUnlocks (re-enables) the specified user account."
Eric Andersen27f64e12002-06-23 04:24:25 +00001655
Eric Andersen221b2ea2001-07-31 19:06:07 +00001656#define pidof_trivial_usage \
1657 "process-name [process-name ...]"
1658#define pidof_full_usage \
1659 "Lists the PIDs of all processes with names that match the names on the command line"
1660#define pidof_example_usage \
1661 "$ pidof init\n" \
1662 "1\n"
1663
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001664#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001665#define ping_trivial_usage "host"
1666#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1667#else
1668#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001669 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001670#define ping_full_usage \
1671 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1672 "Options:\n" \
1673 "\t-c COUNT\tSend only COUNT pings.\n" \
1674 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1675 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001676 "\t\t\tand when finished."
1677#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001678#define ping_example_usage \
1679 "$ ping localhost\n" \
1680 "PING slag (127.0.0.1): 56 data bytes\n" \
1681 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1682 "\n" \
1683 "--- debian ping statistics ---\n" \
1684 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1685 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001686
Eric Andersen51b8bd62002-07-03 11:46:38 +00001687#ifndef CONFIG_FEATURE_FANCY_PING6
1688#define ping6_trivial_usage "host"
1689#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1690#else
1691#define ping6_trivial_usage \
1692 "[OPTION]... host"
1693#define ping6_full_usage \
1694 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1695 "Options:\n" \
1696 "\t-c COUNT\tSend only COUNT pings.\n" \
1697 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1698 "\t-q\t\tQuiet mode, only displays output at start\n" \
1699 "\t\t\tand when finished."
1700#endif
1701#define ping6_example_usage \
1702 "$ ping6 ip6-localhost\n" \
1703 "PING ip6-localhost (::1): 56 data bytes\n" \
1704 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
1705 "\n" \
1706 "--- ip6-localhost ping statistics ---\n" \
1707 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1708 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
1709
Eric Andersen7e9276b2001-02-22 01:15:47 +00001710#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001711 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001712#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001713 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001714 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001715
Eric Andersen7e9276b2001-02-22 01:15:47 +00001716#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001717 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001718#define poweroff_full_usage \
1719 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001720
Eric Andersen7e9276b2001-02-22 01:15:47 +00001721#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001722 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001723#define printf_full_usage \
1724 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001725 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001726#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001727 "$ printf "Val=%d\\n" 5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001728 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001729
Eric Andersen7e9276b2001-02-22 01:15:47 +00001730#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001731 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001732#define ps_full_usage \
1733 "Report process status\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001734 "\nThis version of ps accepts no options."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001735#define ps_example_usage \
1736 "$ ps\n" \
1737 " PID Uid Gid State Command\n" \
1738 " 1 root root S init\n" \
1739 " 2 root root S [kflushd]\n" \
1740 " 3 root root S [kupdate]\n" \
1741 " 4 root root S [kpiod]\n" \
1742 " 5 root root S [kswapd]\n" \
1743 " 742 andersen andersen S [bash]\n" \
1744 " 743 andersen andersen S -bash\n" \
1745 " 745 root root S [getty]\n" \
1746 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001747
Eric Andersen7e9276b2001-02-22 01:15:47 +00001748#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001749 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001750#define pwd_full_usage \
1751 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001752#define pwd_example_usage \
1753 "$ pwd\n" \
1754 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001755
Eric Andersen7e9276b2001-02-22 01:15:47 +00001756#define rdate_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001757 "[OPTION] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001758#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001759 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001760 "Options:\n" \
1761 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001762 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001763
Eric Andersen7e9276b2001-02-22 01:15:47 +00001764#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001765 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001766#define readlink_full_usage \
1767 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001768
Glenn L McGrath62fae302002-12-10 00:14:33 +00001769#define realpath_trivial_usage \
1770 "pathname ..."
1771#define realpath_full_usage \
1772 "return the canonicalized absolute pathnames of given arguments\n\n"
1773
Eric Andersen7e9276b2001-02-22 01:15:47 +00001774#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001775 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001776#define reboot_full_usage \
1777 "Reboot the system."
1778
1779#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001780 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001781#define renice_full_usage \
1782 "Changes priority of running processes. Allowed priorities range\n" \
1783 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001784 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001785
Eric Andersen7e9276b2001-02-22 01:15:47 +00001786#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001787 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001788#define reset_full_usage \
1789 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001790
Eric Andersen7e9276b2001-02-22 01:15:47 +00001791#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001792 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001793#define rm_full_usage \
1794 "Remove (unlink) the FILE(s). You may use '--' to\n" \
1795 "indicate that all following arguments are non-options.\n\n" \
1796 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001797 "\t-i\t\talways prompt before removing each destination\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001798 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001799 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001800#define rm_example_usage \
1801 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001802
Eric Andersen7e9276b2001-02-22 01:15:47 +00001803#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001804 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001805#define rmdir_full_usage \
1806 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001807#define rmdir_example_usage \
1808 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001809
Eric Andersen7e9276b2001-02-22 01:15:47 +00001810#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001811 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001812#define rmmod_full_usage \
1813 "Unloads the specified kernel modules from the kernel.\n\n" \
1814 "Options:\n" \
Tim Rikercf932742002-12-14 01:58:59 +00001815 "\t-a\tRemove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001816#define rmmod_example_usage \
1817 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001818
Eric Andersen7e9276b2001-02-22 01:15:47 +00001819#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001820 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001821#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00001822 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00001823 "Options:\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001824 "\t-n\tDont resolve names.\n" \
1825 "\t-e\tDisplay other/more information"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001826
Glenn L McGrathb72a7352002-12-10 00:17:22 +00001827#define rpm_trivial_usage \
1828 "-i -q[ildc]p package.rpm"
1829#define rpm_full_usage \
1830 "Manipulates RPM packages" \
1831 "Options:" \
1832 "\t-i Install package" \
1833 "\t-q Query package" \
1834 "\t\t-p Query uninstalled package" \
1835 "\t\t-i Show information" \
1836 "\t\t-l List contents" \
1837 "\t\t-d List documents" \
1838 "\t\t-c List config files"
1839
Glenn L McGrathf8736d22001-06-26 01:19:34 +00001840#define rpm2cpio_trivial_usage \
1841 "package.rpm"
1842#define rpm2cpio_full_usage \
1843 "Outputs a cpio archive of the rpm file."
1844
Eric Andersen6cf47a72001-10-31 10:24:36 +00001845#define run_parts_trivial_usage \
1846 "[-t] [-a ARG] [-u MASK] DIRECTORY"
1847#define run_parts_full_usage \
1848 "Run a bunch of scripts in a directory.\n\n" \
1849 "Options:\n" \
1850 "\t-t\t\tTest only what file will be executed, without execute them.\n" \
1851 "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \
1852 "\t-u MASK\tSet the umask to MASK before executing every program."
1853
Eric Andersen7e9276b2001-02-22 01:15:47 +00001854#define sed_trivial_usage \
Matt Kraai075228a2001-06-21 14:40:55 +00001855 "[-nef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001856#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001857 "Options:\n" \
1858 "\t-n\t\tsuppress automatic printing of pattern space\n" \
1859 "\t-e script\tadd the script to the commands to be executed\n" \
1860 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001861 "\n" \
1862 "If no -e or -f is given, the first non-option argument is taken as the\n" \
1863 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001864 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001865#define sed_example_usage \
1866 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
1867 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001868
Eric Andersen7e9276b2001-02-22 01:15:47 +00001869#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001870 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001871#define setkeycodes_full_usage \
1872 "Set entries into the kernel's scancode-to-keycode map,\n" \
1873 "allowing unusual keyboards to generate usable keycodes.\n\n" \
1874 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001875 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001876#define setkeycodes_example_usage \
1877 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001878
Matt Kraai2d91deb2001-08-01 17:21:35 +00001879#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001880 "[FILE]...\n" \
1881 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00001882#define lash_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001883 "lash: The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00001884#define lash_notes_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001885"This command does not yet have proper documentation.\n" \
1886"\n" \
1887"Use lash just as you would use any other shell. It properly handles pipes,\n" \
1888"redirects, job control, can be used as the shell for scripts, and has a\n" \
1889"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
1890"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
1891"use ash or bash. If you just need a very simple and extremely small shell,\n" \
1892"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001893
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00001894#define sha1sum_trivial_usage \
1895 "[OPTION] [FILE]"
1896#define sha1sum_full_usage \
1897 "[OPTION] [FILE]"
1898
Manuel Novoa III cad53642003-03-19 09:13:01 +00001899#ifdef CONFIG_FEATURE_FANCY_SLEEP
1900 #define USAGE_FANCY_SLEEP(a) a
1901 #define USAGE_NOT_FANCY_SLEEP(a)
1902#else
1903 #define USAGE_FANCY_SLEEP(a)
1904 #define USAGE_NOT_FANCY_SLEEP(a) a
1905#endif
1906
Eric Andersen7e9276b2001-02-22 01:15:47 +00001907#define sleep_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001908 USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001909#define sleep_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001910 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \
1911 USAGE_FANCY_SLEEP( \
1912"Pause for a time equal to the total of the args given, where each arg can\n" \
1913"have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001914#define sleep_example_usage \
1915 "$ sleep 2\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001916 "[2 second delay results]\n" \
1917 USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \
1918 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001919
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001920#ifdef CONFIG_FEATURE_SORT_UNIQUE
Mark Whitleyfccaa362001-04-17 18:56:18 +00001921 #define USAGE_SORT_UNIQUE(a) a
1922#else
1923 #define USAGE_SORT_UNIQUE(a)
1924#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001925#ifdef CONFIG_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001926 #define USAGE_SORT_REVERSE(a) a
1927#else
1928 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001929#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001930#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001931 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001932#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001933 "Sorts lines of text in the specified files\n\n"\
1934 "Options:\n" \
1935 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
1936 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
1937 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001938#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001939 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001940 "a\n" \
1941 "b\n" \
1942 "c\n" \
1943 "d\n" \
1944 "e\n" \
1945 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001946
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001947#define start_stop_daemon_trivial_usage \
1948 "[OPTIONS]"
1949#define start_stop_daemon_full_usage \
1950 "Program to start and stop services.\n"\
1951 "Options:\n" \
1952 "-S\t\t\tstart\n"\
1953 "-K\t\t\tstop\n"\
Eric Andersenfe5b1a92002-10-22 19:21:48 +00001954 "-b\t\t\tforce process into background (daemonize)\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001955 "-x <executable>\t\tprogram to start/check if it is running\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001956 "-u <username>|<uid>\tstop this user's processes\n"\
1957 "-n <process-name>\tstop processes with this name\n"\
1958 "-s <signal>\t\tsignal to send (default 15)\n"\
1959 "-a <pathname>\t\tprogram to start (default <executable>)\n"
1960
Eric Andersenef5e8f82002-11-07 02:09:37 +00001961#define strings_trivial_usage \
1962 "[-afo] [-n length] [file ... ]"
1963#define strings_full_usage \
1964 "Display printable strings in a binary file." \
1965 "\n\nOptions:" \
1966 "\n\t-f\tPrecede each string with the name of the file where it was found." \
1967 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
1968 "\n\t-o\tEach string is preceded by its decimal offset in the file."
1969
Eric Andersen7e9276b2001-02-22 01:15:47 +00001970#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001971 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001972#define stty_full_usage \
1973 "Without arguments, prints baud rate, line discipline," \
1974 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001975 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00001976 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001977 "\n\t-a\t\tprint all current settings in human-readable form" \
1978 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00001979 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001980
Robert Griebl1fca5582002-06-04 20:45:46 +00001981#define su_trivial_usage \
1982 "[OPTION]... [-] [username]"
1983#define su_full_usage \
1984 "Change user id or become root.\n" \
1985 "Options:\n" \
1986 "\t-p\tPreserve environment"
1987
Eric Andersen27f64e12002-06-23 04:24:25 +00001988#define sulogin_trivial_usage \
1989 "[OPTION]... [tty-device]"
1990#define sulogin_full_usage \
1991 "Single user login\n" \
1992 "Options:\n" \
1993 "\t-f\tDo not authenticate (user already authenticated)\n" \
1994 "\t-h\tName of the remote host for this login.\n" \
1995 "\t-p\tPreserve environment."
1996
Eric Andersen7e9276b2001-02-22 01:15:47 +00001997#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001998 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001999#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002000 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002001 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002002 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002003
Eric Andersen7e9276b2001-02-22 01:15:47 +00002004#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002005 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002006#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002007 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002008 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002009 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002010
Eric Andersen7e9276b2001-02-22 01:15:47 +00002011#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002012 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002013#define sync_full_usage \
2014 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002015
Eric Andersen7e9276b2001-02-22 01:15:47 +00002016
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002017#ifdef CONFIG_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00002018 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002019#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00002020 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002021#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00002022#ifdef CONFIG_FEATURE_IPC_SYSLOG
2023 #define USAGE_IPC_LOG(a) a
2024#else
2025 #define USAGE_IPC_LOG(a)
2026#endif
2027
Eric Andersen7e9276b2001-02-22 01:15:47 +00002028#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002029 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002030#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002031 "Linux system and kernel logging utility.\n" \
2032 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002033 "Options:\n" \
2034 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
2035 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002036 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002037 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00002038 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00002039 "\t-L\t\tLog locally and via network logging (default is network only)") \
2040 USAGE_IPC_LOG( \
2041 "\n\t-C\t\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002042#define syslogd_example_usage \
2043 "$ syslogd -R masterlog:514\n" \
2044 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002045
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002046
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002047#ifndef CONFIG_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00002048 #define USAGE_UNSIMPLE_TAIL(a)
2049#else
2050 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002051#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002052#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002053 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002054#define tail_full_usage \
2055 "Print last 10 lines of each FILE to standard output.\n" \
2056 "With more than one FILE, precede each with a header giving the\n" \
2057 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
2058 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002059 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002060 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
2061 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002062 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002063 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
2064 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002065 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002066 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002067 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
2068#define tail_example_usage \
2069 "$ tail -n 1 /etc/resolv.conf\n" \
2070 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002071
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002072#ifdef CONFIG_FEATURE_TAR_CREATE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002073 #define USAGE_TAR_CREATE(a) a
2074#else
2075 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002076#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002077#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002078 #define USAGE_TAR_EXCLUDE(a) a
2079#else
2080 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002081#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002082#ifdef CONFIG_FEATURE_TAR_GZIP
2083 #define USAGE_TAR_GZIP(a) a
2084#else
2085 #define USAGE_TAR_GZIP(a)
2086#endif
2087#ifdef CONFIG_FEATURE_TAR_BZIP2
2088 #define USAGE_TAR_BZIP2(a) a
2089#else
2090 #define USAGE_TAR_BZIP2(a)
2091#endif
2092
Eric Andersen7e9276b2001-02-22 01:15:47 +00002093#define tar_trivial_usage \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002094 "-[" USAGE_TAR_CREATE("c") USAGE_TAR_GZIP("z") USAGE_TAR_BZIP2("j") "xtvO] " \
Eric Andersen317827d2001-05-21 17:50:53 +00002095 USAGE_TAR_EXCLUDE("[--exclude FILE] [-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00002096 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002097#define tar_full_usage \
2098 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00002099 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002100 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002101 "\tx\t\textract\n" \
2102 "\tt\t\tlist\n" \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002103 "\nArchive format selection:\n" \
2104 USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
2105 USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002106 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002107 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002108 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002109 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002110 "\texclude\t\tfile to exclude\n" \
2111 "\tX\t\tfile with names to exclude\n" \
2112 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00002113 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002114 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002115#define tar_example_usage \
2116 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
2117 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002118
Eric Andersen7e9276b2001-02-22 01:15:47 +00002119#define tee_trivial_usage \
2120 "[OPTION]... [FILE]..."
2121#define tee_full_usage \
2122 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002123 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002124 "\t-a\tappend to the given FILEs, do not overwrite\n" \
2125 "\t-i\tignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002126#define tee_example_usage \
2127 "$ echo "Hello" | tee /tmp/foo\n" \
2128 "$ cat /tmp/foo\n" \
2129 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002130
Eric Andersen7e9276b2001-02-22 01:15:47 +00002131#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002132 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002133#define telnet_full_usage \
2134 "Telnet is used to establish interactive communication with another\n"\
2135 "computer over a network using the TELNET protocol."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002136
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002137#ifdef CONFIG_FEATURE_TELNETD_INETD
2138#define telnetd_trivial_usage \
2139 "(inetd mode) [OPTION]"
2140#define telnetd_full_usage \
2141 "Telnetd uses incoming TELNET connections via inetd.\n"\
2142 "Options:\n" \
2143 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
2144#else
Eric Andersen08a72202002-09-30 20:52:10 +00002145#define telnetd_trivial_usage \
2146 "[OPTION]"
2147#define telnetd_full_usage \
2148 "Telnetd listens for incoming TELNET connections on PORT.\n"\
2149 "Options:\n" \
2150 "\t-p PORT\tlisten for connections on PORT (default 23)\n"\
2151 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002152#endif
Eric Andersen08a72202002-09-30 20:52:10 +00002153
Eric Andersen7e9276b2001-02-22 01:15:47 +00002154#define test_trivial_usage \
2155 "EXPRESSION\n or [ EXPRESSION ]"
2156#define test_full_usage \
2157 "Checks file types and compares values returning an exit\n" \
2158 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002159#define test_example_usage \
2160 "$ test 1 -eq 2\n" \
2161 "$ echo $?\n" \
2162 "1\n" \
2163 "$ test 1 -eq 1\n" \
2164 "$ echo $? \n" \
2165 "0\n" \
2166 "$ [ -d /etc ]\n" \
2167 "$ echo $?\n" \
2168 "0\n" \
2169 "$ [ -d /junk ]\n" \
2170 "$ echo $?\n" \
2171 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002172
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002173#ifdef CONFIG_FEATURE_TFTP_GET
Mark Whitley450736c2001-03-02 19:08:50 +00002174 #define USAGE_TFTP_GET(a) a
2175#else
2176 #define USAGE_TFTP_GET(a)
2177#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002178#ifdef CONFIG_FEATURE_TFTP_PUT
Mark Whitley450736c2001-03-02 19:08:50 +00002179 #define USAGE_TFTP_PUT(a) a
2180#else
2181 #define USAGE_TFTP_PUT(a)
2182#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002183#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Glenn L McGrathad117d82001-10-05 04:40:37 +00002184 #define USAGE_TFTP_BS(a) a
2185#else
2186 #define USAGE_TFTP_BS(a)
2187#endif
Mark Whitley450736c2001-03-02 19:08:50 +00002188
2189#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00002190 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00002191#define tftp_full_usage \
2192 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00002193 "Options:\n" \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002194 "\t-l FILE\tLocal FILE.\n" \
2195 "\t-r FILE\tRemote FILE.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002196 USAGE_TFTP_GET( \
Matt Kraai3be34302001-09-21 14:42:30 +00002197 "\t-g\tGet file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002198 ) \
2199 USAGE_TFTP_PUT( \
Matt Kraai3be34302001-09-21 14:42:30 +00002200 "\t-p\tPut file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002201 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002202 USAGE_TFTP_BS( \
2203 "\t-b SIZE\tTransfer blocks of SIZE octets.\n" \
2204 )
Eric Andersenc3657422001-11-30 07:54:32 +00002205#define time_trivial_usage \
2206 "[OPTION]... COMMAND [ARGS...]"
2207#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00002208 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
2209 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00002210 "Options:\n" \
2211 "\t-v\tDisplays verbose resource usage information."
Mark Whitley450736c2001-03-02 19:08:50 +00002212
Eric Andersen420b2082002-09-17 22:14:58 +00002213#define top_trivial_usage \
2214 "[-d <seconds>]"
2215#define top_full_usage \
2216 "top provides an view of processor activity in real time.\n" \
2217 "This utility reads the status for all processes in /proc each <seconds>\n" \
2218 "and shows the status for however many processes will fit on the screen.\n" \
2219 "This utility will not show processes that are started after program startup,\n" \
2220 "but it will show the EXIT status for and PIDs that exit while it is running."
2221
Eric Andersen7e9276b2001-02-22 01:15:47 +00002222#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002223 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002224#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002225 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002226 "Options:\n" \
2227 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002228#define touch_example_usage \
2229 "$ ls -l /tmp/foo\n" \
2230 "/bin/ls: /tmp/foo: No such file or directory\n" \
2231 "$ touch /tmp/foo\n" \
2232 "$ ls -l /tmp/foo\n" \
2233 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002234
2235#define tr_trivial_usage \
2236 "[-cds] STRING1 [STRING2]"
2237#define tr_full_usage \
2238 "Translate, squeeze, and/or delete characters from\n" \
2239 "standard input, writing to standard output.\n\n" \
2240 "Options:\n" \
2241 "\t-c\ttake complement of STRING1\n" \
2242 "\t-d\tdelete input characters coded STRING1\n" \
2243 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002244#define tr_example_usage \
2245 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
2246 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002247
Eric Andersen5c58d282001-07-10 16:29:00 +00002248#define traceroute_trivial_usage \
2249 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n\
2250 [-s src_addr] [-t tos] [-w wait] host [data size]"
2251#define traceroute_full_usage \
2252 "trace the route ip packets follow going to \"host\"\n" \
2253 "Options:\n" \
2254 "\t-d\tset SO_DEBUG options to socket\n" \
2255 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
2256 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
2257 "\t-v\tVerbose output\n" \
2258 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
2259 "\t-p port#\tSet the base UDP port number used in probes\n" \
2260 "\t\t(default is 33434)\n" \
2261 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
2262 "\t\t(default is 3)\n" \
2263 "\t-s src_addr\tUse the following IP address as the source address\n" \
2264 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
2265 "\t\t(default 0)\n" \
2266 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
2267 "\t\t(default 3 sec.)."
2268
2269
Eric Andersen7e9276b2001-02-22 01:15:47 +00002270#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002271 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002272#define true_full_usage \
2273 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002274#define true_example_usage \
2275 "$ true\n" \
2276 "$ echo $?\n" \
2277 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002278
Eric Andersen7e9276b2001-02-22 01:15:47 +00002279#define tty_trivial_usage \
2280 ""
2281#define tty_full_usage \
2282 "Print the file name of the terminal connected to standard input.\n\n"\
2283 "Options:\n" \
2284 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002285#define tty_example_usage \
2286 "$ tty\n" \
2287 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002288
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002289#define udhcpc_trivial_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00002290 "[-fbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002291#define udhcpc_full_usage \
2292 "\t-c,\t--clientid=CLIENTID\tClient identifier\n" \
2293 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00002294 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002295 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00002296 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated.\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002297 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
2298 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated.\n" \
2299 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
2300 "\t-q,\t--quit\tQuit after obtaining lease\n" \
2301 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
2302 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
2303 "\t-v,\t--version\tDisplay version"
2304
Russ Dill61fb4892002-10-14 21:41:28 +00002305#define udhcpd_trivial_usage \
2306 "[configfile]\n" \
2307
2308#define udhcpd_full_usage \
Glenn L McGrath9130c852002-12-12 12:56:18 +00002309 ""
Russ Dill61fb4892002-10-14 21:41:28 +00002310
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002311#ifdef CONFIG_FEATURE_MOUNT_FORCE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002312 #define USAGE_MOUNT_FORCE(a) a
2313#else
2314 #define USAGE_MOUNT_FORCE(a)
2315#endif
2316#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002317 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002318#define umount_full_usage \
2319 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00002320 "\nFlags:\n" "\t-a\tUnmount all file systems" \
2321 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
2322 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00002323 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00002324 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 +00002325#define umount_example_usage \
2326 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002327
2328#define uname_trivial_usage \
2329 "[OPTION]..."
2330#define uname_full_usage \
2331 "Print certain system information. With no OPTION, same as -s.\n\n" \
2332 "Options:\n" \
2333 "\t-a\tprint all information\n" \
2334 "\t-m\tthe machine (hardware) type\n" \
2335 "\t-n\tprint the machine's network node hostname\n" \
2336 "\t-r\tprint the operating system release\n" \
2337 "\t-s\tprint the operating system name\n" \
2338 "\t-p\tprint the host processor type\n" \
2339 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002340#define uname_example_usage \
2341 "$ uname -a\n" \
2342 "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002343
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00002344#define uncompress_trivial_usage \
2345 "[-c] [-f] [ name ... ]"
2346#define uncompress_full_usage \
2347 "Uncompress .Z file[s]\n" \
2348 "Options:\n" \
2349 "\t-c\textract to stdout\n" \
2350 "\t-f\tforce overwrite an existing file\n"
2351
Eric Andersen7e9276b2001-02-22 01:15:47 +00002352#define uniq_trivial_usage \
2353 "[OPTION]... [INPUT [OUTPUT]]"
2354#define uniq_full_usage \
2355 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00002356 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002357 "Options:\n" \
2358 "\t-c\tprefix lines by the number of occurrences\n" \
2359 "\t-d\tonly print duplicate lines\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002360 "\t-u\tonly print unique lines\n" \
2361 "\t-f N\tskip the first N fields\n" \
2362 "\t-s N\tskip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002363#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002364 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002365 "a\n" \
2366 "b\n" \
2367 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002368
2369#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002370 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002371#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002372 "Converts FILE from unix format to dos format. When no option\n" \
2373 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002374 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002375 "Options:\n" \
2376 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002377 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002378
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002379#define unzip_trivial_usage \
2380 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
2381#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002382 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002383 "Options:\n" \
2384 "\t-l\tlist archive contents (short form)\n" \
2385 "\t-n\tnever overwrite existing files (default)\n" \
2386 "\t-o\toverwrite files without prompting\n" \
2387 "\t-p\tsend output to stdout\n" \
2388 "\t-q\tbe quiet\n" \
2389 "\t-x\texclude these files\n" \
2390 "\t-d\textract files into this directory"
2391
Eric Andersen7e9276b2001-02-22 01:15:47 +00002392#define update_trivial_usage \
2393 "[options]"
2394#define update_full_usage \
2395 "Periodically flushes filesystem buffers.\n\n" \
2396 "Options:\n" \
2397 "\t-S\tforce use of sync(2) instead of flushing\n" \
2398 "\t-s SECS\tcall sync this often (default 30)\n" \
2399 "\t-f SECS\tflush some buffers this often (default 5)"
2400
2401#define uptime_trivial_usage \
2402 ""
2403#define uptime_full_usage \
2404 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002405#define uptime_example_usage \
2406 "$ uptime\n" \
2407 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002408
2409#define usleep_trivial_usage \
2410 "N"
2411#define usleep_full_usage \
2412 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002413#define usleep_example_usage \
2414 "$ usleep 1000000\n" \
2415 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002416
2417#define uudecode_trivial_usage \
2418 "[FILE]..."
2419#define uudecode_full_usage \
2420 "Uudecode a file that is uuencoded.\n\n" \
2421 "Options:\n" \
Eric Andersen704b2c22001-03-16 08:06:30 +00002422 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002423#define uudecode_example_usage \
2424 "$ uudecode -o busybox busybox.uu\n" \
2425 "$ ls -l busybox\n" \
2426 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002427
2428#define uuencode_trivial_usage \
2429 "[OPTION] [INFILE] REMOTEFILE"
2430#define uuencode_full_usage \
2431 "Uuencode a file.\n\n" \
2432 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00002433 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002434#define uuencode_example_usage \
2435 "$ uuencode busybox busybox\n" \
2436 "begin 755 busybox\n" \
2437 "<encoded file snipped>\n" \
2438 "$ uudecode busybox busybox > busybox.uu\n" \
2439 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002440
Eric Andersen853c4942003-01-23 05:59:32 +00002441#define vconfig_trivial_usage \
2442 "COMMAND [OPTIONS] ..."
2443
2444#define vconfig_full_usage \
2445"Usage: add [interface-name] [vlan_id] \n" \
2446" rem [vlan-name] \n" \
2447" set_flag [interface-name] [flag-num] [0 | 1] \n" \
2448" set_egress_map [vlan-name] [skb_priority] [vlan_qos] \n" \
2449" set_ingress_map [vlan-name] [skb_priority] [vlan_qos] \n" \
2450" set_name_type [name-type] \n"
2451
Eric Andersen3f980402001-04-04 17:31:15 +00002452#define vi_trivial_usage \
2453 "[OPTION] [FILE]..."
2454#define vi_full_usage \
2455 "edit FILE.\n\n" \
2456 "Options:\n" \
2457 "\t-R\tRead-only- do not write to the file."
2458
Eric Andersen27f64e12002-06-23 04:24:25 +00002459#define vlock_trivial_usage \
2460 "[OPTIONS]"
2461#define vlock_full_usage \
2462 "Lock a virtual terminal. A password is required to unlock\n" \
2463 "Options:\n" \
2464 "\t-a\tLock all VTs"
2465
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002466#define watch_trivial_usage \
2467 "[-n <seconds>] COMMAND..."
2468#define watch_full_usage \
2469 "Executes a program periodically.\n" \
2470 "Options:\n" \
2471 "\t-n\tLoop period in seconds - default is 2."
2472#define watch_example_usage \
2473 "$ watch date\n" \
2474 "Mon Dec 17 10:31:40 GMT 2000\n" \
2475 "Mon Dec 17 10:31:42 GMT 2000\n" \
2476 "Mon Dec 17 10:31:44 GMT 2000"
2477
Eric Andersen7e9276b2001-02-22 01:15:47 +00002478#define watchdog_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002479 "DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002480#define watchdog_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002481 "Periodically write to watchdog device DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002482
2483#define wc_trivial_usage \
2484 "[OPTION]... [FILE]..."
2485#define wc_full_usage \
2486 "Print line, word, and byte counts for each FILE, and a total line if\n" \
2487 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
2488 "Options:\n" \
2489 "\t-c\tprint the byte counts\n" \
2490 "\t-l\tprint the newline counts\n" \
2491 "\t-L\tprint the length of the longest line\n" \
2492 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002493#define wc_example_usage \
2494 "$ wc /etc/passwd\n" \
2495 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002496
2497#define wget_trivial_usage \
Robert Griebld7760112002-05-14 23:36:45 +00002498 "[-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 +00002499#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00002500 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002501 "Options:\n" \
2502 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00002503 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00002504 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00002505 "\t-O\tsave to filename ('-' for stdout)\n" \
2506 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002507
2508#define which_trivial_usage \
2509 "[COMMAND ...]"
2510#define which_full_usage \
2511 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002512#define which_example_usage \
2513 "$ which login\n" \
2514 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00002515
Eric Andersen00a6a752002-04-26 23:53:10 +00002516#define who_trivial_usage \
2517 " "
2518#define who_full_usage \
2519 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002520
2521#define whoami_trivial_usage \
2522 ""
2523#define whoami_full_usage \
2524 "Prints the user name associated with the current effective user id."
2525
2526#define xargs_trivial_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002527 "[COMMAND] [-prt] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002528#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002529 "Executes COMMAND on every item given by standard input.\n\n" \
2530 "Options:\n" \
2531 "\t-p\tPrompt the user about whether to run each command\n" \
2532 "\t-r\tDo not run command for empty readed lines\n" \
2533 "\t-t\tPrint the command line on stderr before executing it."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002534#define xargs_example_usage \
2535 "$ ls | xargs gzip\n" \
2536 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002537
2538#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002539 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002540#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002541 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002542
Eric Andersen7e9276b2001-02-22 01:15:47 +00002543#define zcat_trivial_usage \
2544 "FILE"
2545#define zcat_full_usage \
2546 "Uncompress to stdout."