blob: 9100111157e20e6ee48c45204fa0ebac1126b112 [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 \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000180 "[OPTION]... FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000181#define cmp_full_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000182 "Compare files.\n\n" \
183 "Options:\n" \
184 "\t-l\tWrite the byte numbers (decimal) and values (octal)\n" \
185 "\t\t for all differing bytes.\n" \
186 "\t-s\tquiet mode - do not print"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000187
Eric Andersen7e9276b2001-02-22 01:15:47 +0000188#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000189 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000190#define cp_full_usage \
191 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
192 "\n" \
193 "\t-a\tSame as -dpR\n" \
194 "\t-d\tPreserves links\n" \
195 "\t-p\tPreserves file attributes if possible\n" \
196 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000197 "\t-R\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000198
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000199#define cpio_trivial_usage \
200 "-[dimtuv][F cpiofile]"
201#define cpio_full_usage \
202 "Extract or list files from a cpio archive\n" \
203 "Main operation mode:\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000204 "\td\t\tmake leading directories\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000205 "\ti\t\textract\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000206 "\tm\t\tpreserve mtime\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000207 "\tt\t\tlist\n" \
Eric Andersen6925d502001-12-16 09:23:09 +0000208 "\tu\t\tunconditional overwrite\n" \
209 "\tF\t\tinput from file"
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000210
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000211#define crond_trivial_usage \
212 "-d[#] -c <crondir> -f -b"
213#define crond_full_usage \
214 "\t-d [#] -l [#] -S -L logfile -f -b -c dir\n" \
215 "\t-d num\tdebug level\n" \
216 "\t-l num\tlog level (8 - default)\n" \
217 "\t-S\tlog to syslod (defualt)\n" \
218 "\t-L file\tlog to file\n" \
219 "\t-f\trun in fordeground\n" \
220 "\t-b\trun in background (default)\n" \
221 "\t-c dir\tworking dir"
222
223#define crontab_trivial_usage \
224 "crontab [-c dir] {file|-}|[-u|-l|-e|-d user]"
225#define crontab_full_usage \
226 "\tfile <opts> replace crontab from file\n" \
227 "\t- <opts> replace crontab from stdin\n" \
228 "\t-u user specify user\n" \
229 "\t-l [user] list crontab for user\n" \
230 "\t-e [user] edit crontab for user\n" \
231 "\t-d [user] delete crontab for user\n" \
232 "\t-c dir specify crontab directory"
233
234
Eric Andersen7e9276b2001-02-22 01:15:47 +0000235#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000236 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000237#define cut_full_usage \
238 "Prints selected fields from each input FILE to standard output.\n\n" \
239 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000240 "\t-b LIST\t\tOutput only bytes from LIST\n" \
241 "\t-c LIST\t\tOutput only characters from LIST\n" \
242 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
243 "\t-s\t\tOutput only the lines containing delimiter\n" \
244 "\t-f N\t\tPrint only these fields\n" \
245 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000246#define cut_example_usage \
247 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
248 "Hello\n" \
249 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
250 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000251
Eric Andersen7e9276b2001-02-22 01:15:47 +0000252#define date_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000253 "[OPTION]... [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000254#define date_full_usage \
255 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000256 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000257 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000258 "\t-d STRING\tdisplay time described by STRING, not `now'\n" \
259 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000260 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000261#define date_example_usage \
262 "$ date\n" \
263 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000264
Eric Andersen7e9276b2001-02-22 01:15:47 +0000265#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000266 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000267#define dc_full_usage \
268 "This is a Tiny RPN calculator that understands the\n" \
269 "following operations: +, -, /, *, and, or, not, eor.\n" \
Glenn L McGrath6d074322002-12-12 10:31:53 +0000270 "i.e., 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16" \
271 "p - Prints the value on the top of the stack, without altering the stack.\n" \
272 "f - Prints the entire contents of the stack without altering anything.\n" \
273 "o - Pops the value off the top of the stack and uses it to set the output radix.\n" \
274 " Only 10 and 16 are supported.\n"
275
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000276#define dc_example_usage \
277 "$ dc 2 2 +\n" \
278 "4\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000279 "$ dc 8 8 * 2 2 + /\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000280 "16\n" \
281 "$ dc 0 1 and\n" \
282 "0\n" \
283 "$ dc 0 1 or\n" \
284 "1\n" \
285 "$ echo 72 9 div 8 mul | dc\n" \
286 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000287
Eric Andersen7e9276b2001-02-22 01:15:47 +0000288#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000289 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000290 "\t [seek=N] [conv=notrunc|noerror|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000291#define dd_full_usage \
292 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000293 "\tif=FILE\t\tread from FILE instead of stdin\n" \
294 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
295 "\tbs=N\t\tread and write N bytes at a time\n" \
296 "\tcount=N\t\tcopy only N input blocks\n" \
297 "\tskip=N\t\tskip N input blocks\n" \
298 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000299 "\tconv=notrunc\tdon't truncate output file\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000300 "\tconv=noerror\tcontinue after read errors\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000301 "\tconv=sync\tpad blocks with zeros\n" \
302 "\n" \
303 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000304 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000305#define dd_example_usage \
306 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
307 "4+0 records in\n" \
308 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000309
Eric Andersen7e9276b2001-02-22 01:15:47 +0000310#define deallocvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000311 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000312#define deallocvt_full_usage \
313 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000314
Eric Andersenf349e972001-08-21 16:18:59 +0000315#define delgroup_trivial_usage \
316 "GROUP"
317#define delgroup_full_usage \
318 "Deletes group GROUP from the system"
319
320#define deluser_trivial_usage \
321 "USER"
322#define deluser_full_usage \
323 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000324
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000325#ifdef CONFIG_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000326 #define USAGE_HUMAN_READABLE(a) a
327 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000328#else
Eric Andersened0d9582001-02-23 13:23:03 +0000329 #define USAGE_HUMAN_READABLE(a)
330 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000331#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000332#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000333 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000334#define df_full_usage \
335 "Print the filesystem space used and space available.\n\n" \
336 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000337 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000338 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
339 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000340 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000341 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000342#define df_example_usage \
343 "$ df\n" \
344 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
345 "/dev/sda3 8690864 8553540 137324 98% /\n" \
346 "/dev/sda1 64216 36364 27852 57% /boot\n" \
347 "$ df /dev/sda3\n" \
348 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
349 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000350
Eric Andersen7e9276b2001-02-22 01:15:47 +0000351#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000352 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000353#define dirname_full_usage \
354 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000355#define dirname_example_usage \
356 "$ dirname /tmp/foo\n" \
357 "/tmp\n" \
358 "$ dirname /tmp/foo/\n" \
359 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000360
Eric Andersen7e9276b2001-02-22 01:15:47 +0000361#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000362 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000363#define dmesg_full_usage \
364 "Prints or controls the kernel ring buffer\n\n" \
365 "Options:\n" \
366 "\t-c\t\tClears the ring buffer's contents after printing\n" \
367 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000368 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000369
Eric Andersen7e9276b2001-02-22 01:15:47 +0000370#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000371 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000372#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000373 "Converts FILE from dos format to unix format. When no option\n" \
374 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000375 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000376 "Options:\n" \
377 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000378 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000379
Eric Andersen7e9276b2001-02-22 01:15:47 +0000380#define dpkg_trivial_usage \
Eric Andersen9fe5f982002-04-13 14:48:51 +0000381 "-i package_file\n" \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000382 "[-CPru] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000383#define dpkg_full_usage \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000384 "\t-i\tInstall the package\n" \
385 "\t-C\tConfigure an unpackaged package\n" \
386 "\t-P\tPurge all files of a package\n" \
387 "\t-r\tRemove all but the configuration files for a package\n" \
388 "\t-u\tUnpack a package, but dont configure it\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000389
Eric Andersen7e9276b2001-02-22 01:15:47 +0000390#define dpkg_deb_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000391 "[-cefItxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000392#define dpkg_deb_full_usage \
393 "Perform actions on debian packages (.debs)\n\n" \
394 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000395 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000396 "\t-e\tExtract control files to [argument] directory\n" \
397 "\t-f\tDisplay control field name starting with [argument]\n" \
398 "\t-I\tDisplay the control filenamed [argument]\n" \
399 "\t-t\tExtract filesystem tree to stdout in tar format\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000400 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000401 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000402#define dpkg_deb_example_usage \
403 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000404
Manuel Novoa III cad53642003-03-19 09:13:01 +0000405#ifdef CONFIG_FEATURE_DU_DEFALT_BLOCKSIZE_1K
406#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a) a
407#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a)
408#else
409#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a)
410#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a) a
411#endif
412
Eric Andersen7e9276b2001-02-22 01:15:47 +0000413#define du_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000414 "[-aHLdclsx" USAGE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000415#define du_full_usage \
416 "Summarizes disk space used for each FILE and/or directory.\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000417 "Disk space is printed in units of " \
418 USAGE_DU_DEFALT_BLOCKSIZE_1k("1024") USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k("512") \
419 " bytes.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000420 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000421 "\t-a\tshow sizes of files in addition to directories\n" \
422 "\t-H\tfollow symbolic links that are FILE command line args\n" \
423 "\t-L\tfollow all symbolic links encountered\n" \
424 "\t-d N\tlimit output to directories (and files with -a) of depth < N\n" \
425 "\t-c\toutput a grand total\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000426 "\t-l\tcount sizes many times if hard linked\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000427 "\t-s\tdisplay only a total for each argument\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000428 "\t-x\tskip directories on different filesystems\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000429 USAGE_HUMAN_READABLE( \
430 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
431 "\t-m\tprint sizes in megabytes\n" ) \
432 "\t-k\tprint sizes in kilobytes" USAGE_DU_DEFALT_BLOCKSIZE_1k("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000433#define du_example_usage \
434 "$ du\n" \
435 "16 ./CVS\n" \
436 "12 ./kernel-patches/CVS\n" \
437 "80 ./kernel-patches\n" \
438 "12 ./tests/CVS\n" \
439 "36 ./tests\n" \
440 "12 ./scripts/CVS\n" \
441 "16 ./scripts\n" \
442 "12 ./docs/CVS\n" \
443 "104 ./docs\n" \
444 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000445
Eric Andersen7e9276b2001-02-22 01:15:47 +0000446#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000447 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000448#define dumpkmap_full_usage \
449 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000450#define dumpkmap_example_usage \
451 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000452
Russ Dill61fb4892002-10-14 21:41:28 +0000453#define dumpleases_trivial_usage \
454 "[-r|-a] [-f LEASEFILE]"
455#define dumpleases_full_usage \
Russ Dill61fb4892002-10-14 21:41:28 +0000456 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
457 "\t-r,\t--remaining\tInterepret lease times as time remaing\n" \
458 "\t-a,\t--absolute\tInterepret lease times as expire time\n"
459
Eric Andersen7e9276b2001-02-22 01:15:47 +0000460#define dutmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000461 "[FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000462#define dutmp_full_usage \
463 "Dump utmp file format (pipe delimited) from FILE\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000464 "or stdin to stdout. (i.e., 'dutmp /var/run/utmp')"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000465#define dutmp_example_usage \
466 "$ dutmp /var/run/utmp\n" \
467 "8|7||si|||0|0|0|955637625|760097|0\n" \
468 "2|0|~|~~|reboot||0|0|0|955637625|782235|0\n" \
469 "1|20020|~|~~|runlevel||0|0|0|955637625|800089|0\n" \
470 "8|125||l4|||0|0|0|955637629|998367|0\n" \
471 "6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0\n" \
472 "6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000473 "7|336|pts/0|vt00|andersen|:0.0|0|0|0|955637763|0|0\n"
474
475#ifdef CONFIG_FEATURE_FANCY_ECHO
476 #define USAGE_FANCY_ECHO(a) a
477#else
478 #define USAGE_FANCY_ECHO(a)
479#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000480
Eric Andersen7e9276b2001-02-22 01:15:47 +0000481#define echo_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000482 USAGE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000483#define echo_full_usage \
484 "Prints the specified ARGs to stdout\n\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000485 USAGE_FANCY_ECHO("Options:\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000486 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000487 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000488 "\t-E\tdisable interpretation of backslash-escaped characters")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000489#define echo_example_usage \
490 "$ echo "Erik is cool"\n" \
491 "Erik is cool\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000492 USAGE_FANCY_ECHO("$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000493 "Erik\n" \
494 "is\n" \
495 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000496 "$ echo "Erik\\nis\\ncool"\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000497 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000498
Eric Andersen84e229c2001-03-29 22:48:33 +0000499#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000500 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000501#define env_full_usage \
502 "Prints the current environment or runs a program after setting\n" \
503 "up the specified environment.\n\n" \
504 "Options:\n" \
505 "\t-, -i\tstart with an empty environment\n" \
506 "\t-u\tremove variable from the environment\n"
507
Eric Andersen7e9276b2001-02-22 01:15:47 +0000508#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000509 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000510#define expr_full_usage \
511 "Prints the value of EXPRESSION to standard output.\n\n" \
512 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000513 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
514 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
515 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
516 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
517 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
518 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
519 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
520 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
521 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
522 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
523 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
524 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
525 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000526 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
527 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
528 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
529 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
530 "\t or 0\n" \
531 "\tlength STRING length of STRING\n" \
532 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
533 "\t it is a keyword like `match' or an\n" \
534 "\t operator like `/'\n" \
535 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000536 "Beware that many operators need to be escaped or quoted for shells.\n" \
537 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
538 "lexicographical. Pattern matches return the string matched between \n" \
539 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
540 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000541
Eric Andersen7e9276b2001-02-22 01:15:47 +0000542#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000543 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000544#define false_full_usage \
545 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000546#define false_example_usage \
547 "$ false\n" \
548 "$ echo $?\n" \
549 "1\n"
550
551#define fbset_trivial_usage \
552 "[options] [mode]"
553#define fbset_full_usage \
554 "Show and modify frame buffer settings"
555#define fbset_example_usage \
556 "$ fbset\n" \
557 "mode "1024x768-76"\n" \
558 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
559 "\tgeometry 1024 768 1024 768 16\n" \
560 "\ttimings 12714 128 32 16 4 128 4\n" \
561 "\taccel false\n" \
562 "\trgba 5/11,6/5,5/0,0/0\n" \
563 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000564
Eric Andersen7e9276b2001-02-22 01:15:47 +0000565#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000566 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000567#define fdflush_full_usage \
568 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000569
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000570#define fdisk_trivial_usage \
571 "[-l] [-v] [-b SSZ] [-u] DISK"
572#define fdisk_full_usage \
573 "Change partition table\n" \
574 "Options:\n" \
575 "-l List partition table(s)\n" \
576 "-u Give Start and End in sector (instead of cylinder) units\n" \
577 "-s PARTITION Give partition size(s) in blocks\n" \
578 "-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
Glenn L McGrath062c74f2002-11-27 09:29:49 +0000579 "-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000580
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000581#ifdef CONFIG_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000582 #define USAGE_FIND_TYPE(a) a
583#else
584 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000585#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000586#ifdef CONFIG_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000587 #define USAGE_FIND_PERM(a) a
588#else
589 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000590#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000591#ifdef CONFIG_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000592 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000593#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000594 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000595#endif
Eric Andersen97d86f22003-01-23 05:27:42 +0000596#ifdef CONFIG_FEATURE_FIND_NEWER
597 #define USAGE_FIND_NEWER(a) a
598#else
599 #define USAGE_FIND_NEWER(a)
600#endif
601#ifdef CONFIG_FEATURE_FIND_INUM
602 #define USAGE_FIND_INUM(a) a
603#else
604 #define USAGE_FIND_INUM(a)
605#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000606
Eric Andersen7e9276b2001-02-22 01:15:47 +0000607#define find_trivial_usage \
608 "[PATH...] [EXPRESSION]"
609#define find_full_usage \
610 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000611 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000612 "\nEXPRESSION may consist of:\n" \
613 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000614 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000615 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000616 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000617 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
618) USAGE_FIND_PERM( \
619 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
620) USAGE_FIND_MTIME( \
Eric Andersen97d86f22003-01-23 05:27:42 +0000621 "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \
622) USAGE_FIND_NEWER( \
623 "\n\t-newer FILE\tModified time is more recent than FILE's" \
624) USAGE_FIND_INUM( \
625 "\n\t-inum N\t\tFile has inode number N")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000626#define find_example_usage \
627 "$ find / -name /etc/passwd\n" \
628 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000629
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000630#define fold_trivial_usage \
631 "[bsw] [FILE]"
632#define fold_full_usage \
633 "Wrap input lines in each FILE (standard input by default), writing to\n" \
634 "standard output.\n\n" \
635 "Options:\n" \
636 "\t-b\tcount bytes rather than columns\n" \
637 "\t-s\tbreak at spaces\n" \
638 "\t-w\tuse WIDTH columns instead of 80\n"
639
Eric Andersen7e9276b2001-02-22 01:15:47 +0000640#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000641 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000642#define free_full_usage \
643 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000644#define free_example_usage \
645 "$ free\n" \
646 " total used free shared buffers\n" \
647 " Mem: 257628 248724 8904 59644 93124\n" \
648 " Swap: 128516 8404 120112\n" \
649 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000650
Eric Andersen7e9276b2001-02-22 01:15:47 +0000651#define freeramdisk_trivial_usage \
652 "DEVICE"
653#define freeramdisk_full_usage \
654 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000655#define freeramdisk_example_usage \
656 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000657
658#define fsck_minix_trivial_usage \
659 "[-larvsmf] /dev/name"
660#define fsck_minix_full_usage \
661 "Performs a consistency check for MINIX filesystems.\n\n" \
662 "Options:\n" \
663 "\t-l\tLists all filenames\n" \
664 "\t-r\tPerform interactive repairs\n" \
665 "\t-a\tPerform automatic repairs\n" \
666 "\t-v\tverbose\n" \
667 "\t-s\tOutputs super-block information\n" \
668 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
669 "\t-f\tForce file system check."
670
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000671#define ftpget_trivial_usage \
672 "[options] remote-host local-directory remote-file"
673#define ftpget_full_usage \
674 "Retrieve a remote file via FTP.\n\n" \
675 "Options:\n" \
676 "\t-c, --continue Continue a previous transfer\n" \
677 "\t-v, --verbose Verbose\n" \
678 "\t-u, --username Username to be used\n" \
679 "\t-p, --password Password to be used\n" \
680 "\t-P, --port Port number to be used\n"
681
682#define ftpput_trivial_usage \
683 "[options] remote-host remote-directory local-file"
684#define ftpput_full_usage \
685 "Store a local file on a remote machine via FTP.\n\n" \
686 "Options:\n" \
687 "\t-v, --verbose Verbose\n" \
688 "\t-u, --username Username to be used\n" \
689 "\t-p, --password Password to be used\n" \
690 "\t-P, --port Port number to be used\n"
691
Eric Andersen7e9276b2001-02-22 01:15:47 +0000692#define getopt_trivial_usage \
693 "[OPTIONS]..."
694#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000695 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000696 "\t-a, --alternative Allow long options starting with single -\n" \
697 "\t-l, --longoptions=longopts Long options to be recognized\n" \
698 "\t-n, --name=progname The name under which errors are reported\n" \
699 "\t-o, --options=optstring Short options to be recognized\n" \
700 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
701 "\t-Q, --quiet-output No normal output\n" \
702 "\t-s, --shell=shell Set shell quoting conventions\n" \
703 "\t-T, --test Test for getopt(1) version\n" \
704 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000705#define getopt_example_usage \
706 "$ cat getopt.test\n" \
707 "#!/bin/sh\n" \
708 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
709 " -n 'example.busybox' -- "$@"`\n" \
710 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
711 "eval set -- "$GETOPT"\n" \
712 "while true ; do\n" \
713 " case $1 in\n" \
714 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000715 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000716 " -c|--c-long)\n" \
717 " case "$2" in\n" \
718 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000719 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000720 " esac ;;\n" \
721 " --) shift ; break ;;\n" \
722 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
723 " esac\n" \
724 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000725
Eric Andersenf349e972001-08-21 16:18:59 +0000726#define getty_trivial_usage \
727 "getty [OPTIONS]... baud_rate,... line [termtype]"
728#define getty_full_usage \
729 "\nOpens a tty, prompts for a login name, then invokes /bin/login\n\n" \
730 "Options:\n" \
731 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
732 "\t-i\t\tDo not display /etc/issue before running login.\n" \
733 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
734 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
735 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
Glenn L McGrath49e74ef2003-05-13 14:59:07 +0000736 "\t-n\t\tDo not prompt the user for a login name.\n" \
737 "\t-f issue_file\tDisplay issue_file instead of /etc/issue.\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000738 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
739 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
740 "\t-I initstring\tSets the init string to send before anything else.\n" \
741 "\t-H login_host\tLog login_host into the utmp file as the hostname."
742
743
Eric Andersen7e9276b2001-02-22 01:15:47 +0000744#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000745 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000746#define grep_full_usage \
747 "Search for PATTERN in each FILE or standard input.\n\n" \
748 "Options:\n" \
749 "\t-H\tprefix output lines with filename where match was found\n" \
750 "\t-h\tsuppress the prefixing filename on output\n" \
751 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000752 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000753 "\t-n\tprint line number with output lines\n" \
754 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
755 "\t-v\tselect non-matching lines\n" \
756 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000757#define grep_example_usage \
758 "$ grep root /etc/passwd\n" \
759 "root:x:0:0:root:/root:/bin/bash\n" \
760 "$ grep ^[rR]oo. /etc/passwd\n" \
761 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000762
Eric Andersen7e9276b2001-02-22 01:15:47 +0000763#define gunzip_trivial_usage \
764 "[OPTION]... FILE"
765#define gunzip_full_usage \
766 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
767 "Options:\n" \
768 "\t-c\tWrite output to standard output\n" \
769 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000770#define gunzip_example_usage \
771 "$ ls -la /tmp/BusyBox*\n" \
772 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
773 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
774 "$ ls -la /tmp/BusyBox*\n" \
775 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000776
777#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000778 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000779#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000780 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000781 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000782 "Options:\n" \
783 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
784 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000785#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000786 "$ ls -la /tmp/busybox*\n" \
787 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
788 "$ gzip /tmp/busybox.tar\n" \
789 "$ ls -la /tmp/busybox*\n" \
790 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000791
792#define halt_trivial_usage \
793 ""
794#define halt_full_usage \
795 "Halt the system."
796
Manuel Novoa III cad53642003-03-19 09:13:01 +0000797#ifdef CONFIG_FEATURE_FANCY_HEAD
798#define USAGE_FANCY_HEAD(a) a
799#else
800#define USAGE_FANCY_HEAD(a)
801#endif
802
Eric Andersen7e9276b2001-02-22 01:15:47 +0000803#define head_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000804 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000805#define head_full_usage \
806 "Print first 10 lines of each FILE to standard output.\n" \
807 "With more than one FILE, precede each with a header giving the\n" \
808 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000809 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000810 "\t-n NUM\t\tPrint first NUM lines instead of first 10" \
811 USAGE_FANCY_HEAD( \
812 "\n\t-c NUM\t\toutput the first NUM bytes\n" \
813 "\t-q\t\tnever output headers giving file names\n" \
814 "\t-v\t\talways output headers giving file names" )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000815#define head_example_usage \
816 "$ head -n 2 /etc/passwd\n" \
817 "root:x:0:0:root:/root:/bin/bash\n" \
818 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000819
Glenn L McGrath60281112001-11-02 11:39:46 +0000820#define hexdump_trivial_usage \
821 "[-[bcdefnosvx]] [OPTION] FILE"
822#define hexdump_full_usage \
823 "The hexdump utility is a filter which displays the specified files,\n" \
824 "or the standard input, if no files are specified, in a user specified\n"\
825 "format\n" \
826 "\t-b\t\tOne-byte octal display\n" \
827 "\t-c\t\tOne-byte character display\n" \
828 "\t-d\t\tTwo-byte decimal display\n" \
829 "\t-e FORMAT STRING\n" \
830 "\t-f FORMAT FILE\n" \
831 "\t-n LENGTH\tInterpret only length bytes of input\n" \
832 "\t-o\t\tTwo-byte octal display\n" \
833 "\t-s OFFSET\tSkip offset byte\n" \
834 "\t-v\t\tdisplay all input data\n" \
835 "\t-x\t\tTwo-byte hexadecimal display\n"
836
Eric Andersen7e9276b2001-02-22 01:15:47 +0000837#define hostid_trivial_usage \
838 ""
839#define hostid_full_usage \
840 "Print out a unique 32-bit identifier for the machine."
841
842#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000843 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000844#define hostname_full_usage \
845 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000846 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000847 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +0000848 "\t-s\tShort\n" \
849 "\t-i\tAddresses for the hostname\n" \
850 "\t-d\tDNS domain name\n" \
851 "\t-f\tFully qualified domain name\n" \
852 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000853#define hostname_example_usage \
854 "$ hostname\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000855 "sage \n"
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000856#ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH
857 #define USAGE_HTTPD_BASIC_AUTH(a) a
858#else
859 #define USAGE_HTTPD_BASIC_AUTH(a)
860#endif
861#define httpd_trivial_usage \
862 "[-p <port>] [-d/-e <string>]" USAGE_HTTPD_BASIC_AUTH(" [-c <conf file>] [-r <realm>]")
863#define httpd_full_usage \
864 "Listens for incoming http server requests.\n"\
865 "Options:\n" \
866 "\t-p PORT\tServer port (default 80).\n" \
867 USAGE_HTTPD_BASIC_AUTH("\t-c FILE\tSpecifies configuration file. (default httpd.conf)\n\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
868 "\t-e STRING\tHtml encode STRING\n" \
869 "\t-d STRING\tURL decode STRING\n"
Robert Griebl1cd04452002-07-21 16:50:49 +0000870#define hwclock_trivial_usage \
871 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
872#define hwclock_full_usage \
873 "Query and set the hardware clock (RTC)\n\n" \
874 "Options:\n" \
875 "\t-r\tread hardware clock and print result\n" \
876 "\t-s\tset the system time from the hardware clock\n" \
877 "\t-w\tset the hardware clock to the current system time\n" \
878 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
879 "\t-l\tthe hardware clock is kept in local time"
880
Eric Andersen7e9276b2001-02-22 01:15:47 +0000881#define id_trivial_usage \
882 "[OPTIONS]... [USERNAME]"
883#define id_full_usage \
884 "Print information for USERNAME or the current user\n\n" \
885 "Options:\n" \
886 "\t-g\tprints only the group ID\n" \
887 "\t-u\tprints only the user ID\n" \
888 "\t-n\tprint a name instead of a number (with for -ug)\n" \
889 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000890#define id_example_usage \
891 "$ id\n" \
892 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000893
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000894#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +0000895 #define USAGE_SIOCSKEEPALIVE(a) a
896#else
897 #define USAGE_SIOCSKEEPALIVE(a)
898#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000899#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000900 #define USAGE_IFCONFIG_MII(a) a
901#else
902 #define USAGE_IFCONFIG_MII(a)
903#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000904#ifdef CONFIG_FEATURE_IFCONFIG_HW
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000905 #define USAGE_IFCONFIG_HW(a) a
906#else
907 #define USAGE_IFCONFIG_HW(a)
908#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000909#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000910 #define USAGE_IFCONFIG_OPT_A(a) a
911#else
912 #define USAGE_IFCONFIG_OPT_A(a)
913#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +0000914#ifdef CONFIG_FEATURE_IPV6
915 #define USAGE_IPV6(a) a
916#else
917 #define USAGE_IPV6(a)
918#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000919
Eric Andersen7e9276b2001-02-22 01:15:47 +0000920#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000921 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000922#define ifconfig_full_usage \
923 "configure a network interface\n\n" \
924 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +0000925 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
926 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000927 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000928 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000929 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000930 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
931 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000932 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000933 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
934 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000935 "\t[up|down] ..."
936
Glenn L McGrath021fa7d2002-11-09 09:34:15 +0000937#define ifup_trivial_usage \
938 "<-ahinv> <ifaces...>"
939#define ifup_full_usage \
940 "Usage: ifup <options> <ifaces...>\n\n" \
941 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +0000942 "\t-h\tthis help\n" \
943 "\t-a\tde/configure all interfaces automatically\n" \
944 "\t-i FILE\tuse FILE for interface definitions\n" \
945 "\t-n\tprint out what would happen, but don't do it\n" \
946 "\t\t\t(note that this option doesn't disable mappings)\n" \
947 "\t-v\tprint out what would happen before doing it\n" \
948 "\t-m\tdon't run any mappings\n" \
949 "\t-f\tforce de/configuration\n"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +0000950
951#define ifdown_trivial_usage \
952 "<-ahinv> <ifaces...>"
953#define ifdown_full_usage \
954 "Usage: ifdown <options> <ifaces...>\n\n" \
955 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +0000956 "\t-h\tthis help\n" \
957 "\t-a\tde/configure all interfaces automatically\n" \
958 "\t-i FILE\tuse FILE for interface definitions\n" \
959 "\t-n\tprint out what would happen, but don't do it\n" \
960 "\t\t(note that this option doesn't disable mappings)\n" \
961 "\t-v\tprint out what would happen before doing it\n" \
962 "\t-m\tdon't run any mappings\n" \
963 "\t-f\tforce de/configuration\n"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +0000964
Glenn L McGrath06e95652003-02-09 06:51:14 +0000965#define inetd_trivial_usage \
966 "[-q len] [conf]"
967#define inetd_full_usage \
968 "Usage: [-q len] [conf]\n\n" \
969 "Option:\n" \
970 "\t-q\tSets the size of the socket listen queue to\n" \
971 "the specified value. Default is 128."
972
Eric Andersen7e9276b2001-02-22 01:15:47 +0000973#define init_trivial_usage \
974 ""
975#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000976 "Init is the parent of all processes."
977#define init_notes_usage \
978"This version of init is designed to be run only by the kernel.\n" \
979"\n" \
980"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
981"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
982"runlevels, use sysvinit.\n" \
983"\n" \
984"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
985"it has the following default behavior:\n" \
986"\n" \
987" ::sysinit:/etc/init.d/rcS\n" \
988" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000989" ::ctrlaltdel:/sbin/reboot\n" \
990" ::shutdown:/sbin/swapoff -a\n" \
991" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000992" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000993"\n" \
994"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
995"\n" \
996" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000997" tty3::askfirst:/bin/sh\n" \
998" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000999"\n" \
1000"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1001"\n" \
1002" <id>:<runlevels>:<action>:<process>\n" \
1003"\n" \
1004" <id>: \n" \
1005"\n" \
1006" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1007" The id field is used by BusyBox init to specify the controlling tty for\n" \
1008" the specified process to run on. The contents of this field are\n" \
1009" appended to "/dev/" and used as-is. There is no need for this field to\n" \
1010" be unique, although if it isn't you may have strange results. If this\n" \
1011" field is left blank, the controlling tty is set to the console. Also\n" \
1012" note that if BusyBox detects that a serial console is in use, then only\n" \
1013" entries whose controlling tty is either the serial console or /dev/null\n" \
1014" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1015" stinkin' utmp.\n" \
1016"\n" \
1017" <runlevels>: \n" \
1018"\n" \
1019" The runlevels field is completely ignored.\n" \
1020"\n" \
1021" <action>: \n" \
1022"\n" \
1023" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001024" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001025"\n" \
1026" The available actions can be classified into two groups: actions\n" \
1027" that are run only once, and actions that are re-run when the specified\n" \
1028" process exits.\n" \
1029"\n" \
1030" Run only-once actions:\n" \
1031"\n" \
1032" 'sysinit' is the first item run on boot. init waits until all\n" \
1033" sysinit actions are completed before continuing. Following the\n" \
1034" completion of all sysinit actions, all 'wait' actions are run.\n" \
1035" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001036" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001037" therefore, init does not wait for them to complete. 'restart' is\n" \
1038" the action taken to restart the init process. By default this should\n" \
1039" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1040" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001041" actions are run when the system detects that someone on the system\n" \
1042" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1043" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1044" Finally the 'shutdown' action specifies the actions to taken when\n" \
1045" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1046" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001047"\n" \
1048" Run repeatedly actions:\n" \
1049"\n" \
1050" 'respawn' actions are run after the 'once' actions. When a process\n" \
1051" started with a 'respawn' action exits, init automatically restarts\n" \
1052" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1053" respawning out of control. The 'askfirst' actions acts just like\n" \
1054" respawn, except that before running the specified process it\n" \
1055" displays the line "Please press Enter to activate this console."\n" \
1056" and then waits for the user to press enter before starting the\n" \
1057" specified process. \n" \
1058"\n" \
1059" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1060" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001061" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001062"\n" \
1063" <process>: \n" \
1064"\n" \
1065" Specifies the process to be executed and it's command line.\n" \
1066"\n" \
1067"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001068"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001069" # This is run first except when booting in single-user mode.\n" \
1070" #\n" \
1071" ::sysinit:/etc/init.d/rcS\n" \
1072" \n" \
1073" # /bin/sh invocations on selected ttys\n" \
1074" #\n" \
1075" # Start an "askfirst" shell on the console (whatever that may be)\n" \
1076" ::askfirst:-/bin/sh\n" \
1077" # Start an "askfirst" shell on /dev/tty2-4\n" \
1078" tty2::askfirst:-/bin/sh\n" \
1079" tty3::askfirst:-/bin/sh\n" \
1080" tty4::askfirst:-/bin/sh\n" \
1081" \n" \
1082" # /sbin/getty invocations for selected ttys\n" \
1083" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001084" tty4::respawn:/sbin/getty 38400 tty4\n" \
1085" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001086" \n" \
1087" \n" \
1088" # Example of how to put a getty on a serial line (for a terminal)\n" \
1089" #\n" \
1090" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1091" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1092" #\n" \
1093" # Example how to put a getty on a modem line.\n" \
1094" #::respawn:/sbin/getty 57600 ttyS2\n" \
1095" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001096" # Stuff to do when restarting the init process\n" \
1097" ::restart:/sbin/init\n" \
1098" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001099" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001100" ::ctrlaltdel:/sbin/reboot\n" \
1101" ::shutdown:/bin/umount -a -r\n" \
1102" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001103
Eric Andersenbe65c352003-01-23 04:57:35 +00001104#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
1105 #define USAGE_INSMOD_MAP(a) a
1106#else
1107 #define USAGE_INSMOD_MAP(a)
1108#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001109#define insmod_trivial_usage \
1110 "[OPTION]... MODULE [symbol=value]..."
1111#define insmod_full_usage \
1112 "Loads the specified kernel modules into the kernel.\n\n" \
1113 "Options:\n" \
1114 "\t-f\tForce module to load into the wrong kernel version.\n" \
1115 "\t-k\tMake module autoclean-able.\n" \
1116 "\t-v\tverbose output\n" \
1117 "\t-L\tLock to prevent simultaneous loads of a module\n" \
Eric Andersenbe65c352003-01-23 04:57:35 +00001118 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout") \
1119 "\t-x\tdo not export externs\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001120
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001121#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001122 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001123#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001124 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1125 "where OBJECT := { link | addr | route | tunnel }\n" \
1126 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }\n"
1127
1128#define ipaddr_trivial_usage \
1129 "{ {add|del} IFADDR dev STRING | {show|flush} [ dev STRING ] [ to PREFIX ] }"
1130#define ipaddr_full_usage \
1131 "ipaddr {add|del} IFADDR dev STRING\n" \
1132 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
1133 " [ to PREFIX ] [ label PATTERN ]\n" \
1134 "IFADDR := PREFIX | ADDR peer PREFIX\n" \
1135 " [ broadcast ADDR ] [ anycast ADDR ]\n" \
1136 " [ label STRING ] [ scope SCOPE-ID ]\n" \
1137 "SCOPE-ID := [ host | link | global | NUMBER ]\n"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001138
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001139#ifndef CONFIG_FEATURE_IPCALC_FANCY
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001140# define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001141 "[--broadcast] [--netmask] [--network] ipaddr <netmask>"
1142
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001143# define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001144 "Calculate IP network settings from a IP address\n\n" \
1145 "Options:\n" \
1146 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1147 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
1148 "\t-w\t--network\tDisplay calculated network address."
1149#else
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001150# define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001151 "[OPTION]... ipaddr <netmask>"
1152
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001153# define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001154 "Calculate IP network settings from a IP address\n\n" \
1155 "Options:\n" \
1156 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1157 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
1158 "\t-w\t--network\tDisplay calculated network address.\n" \
1159 "\t-h\t--hostname\tDisplay first resolved host name.\n" \
1160 "\t-s\t--silent\tDon't ever display error messages."
1161#endif
1162
1163#define ipcalc_notes_usage \
1164 "ipcalc provides a simple way to calculate IP information for\n" \
1165 "a host. The various options specify what information ipcalc\n" \
1166 "should display on standard out. Multiple options may be\n" \
1167 "specified.\n"
1168
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001169#define iplink_trivial_usage \
1170 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1171#define iplink_full_usage \
1172 "iplink set DEVICE { up | down | arp { on | off } |\n" \
1173 " dynamic { on | off } |\n" \
1174 " mtu MTU }\n" \
1175 "iplink show [ DEVICE ]\n"
1176
1177#define iproute_trivial_usage \
1178 "{ list | flush | { add | del | change | append | replace | monitor } ROUTE }"
1179#define iproute_full_usage \
1180 "iproute { list | flush } SELECTOR\n" \
1181 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
1182 " [ oif STRING ] [ tos TOS ]\n" \
1183 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
1184 "SELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1185 "ROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]\n"
1186
1187#define iptunnel_trivial_usage \
1188 "{ add | change | del | show } [ NAME ] [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
1189#define iptunnel_full_usage \
1190 "iptunnel { add | change | del | show } [ NAME ]\n" \
1191 " [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1192 " [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1193 " [ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]\n"
1194
Eric Andersen7e9276b2001-02-22 01:15:47 +00001195#define kill_trivial_usage \
1196 "[-signal] process-id [process-id ...]"
1197#define kill_full_usage \
1198 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +00001199 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001200 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001201#define kill_example_usage \
1202 "$ ps | grep apache\n" \
1203 "252 root root S [apache]\n" \
1204 "263 www-data www-data S [apache]\n" \
1205 "264 www-data www-data S [apache]\n" \
1206 "265 www-data www-data S [apache]\n" \
1207 "266 www-data www-data S [apache]\n" \
1208 "267 www-data www-data S [apache]\n" \
1209 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001210
1211#define killall_trivial_usage \
1212 "[-signal] process-name [process-name ...]"
1213#define killall_full_usage \
1214 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001215 "Options:\n" \
1216 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001217#define killall_example_usage \
1218 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001219
Mark Whitley6317c4b2001-03-12 22:51:50 +00001220#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001221 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001222#define klogd_full_usage \
1223 "Kernel logger.\n"\
1224 "Options:\n"\
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001225 "\t-c n\tSets the default log level of console messages to n.\n"\
Mark Whitley6317c4b2001-03-12 22:51:50 +00001226 "\t-n\tRun as a foreground process."
1227
Eric Andersen7e9276b2001-02-22 01:15:47 +00001228#define length_trivial_usage \
1229 "STRING"
1230#define length_full_usage \
1231 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001232#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001233 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001234 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001235
1236#define ln_trivial_usage \
1237 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1238#define ln_full_usage \
1239 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
1240 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1241 "Options:\n" \
1242 "\t-s\tmake symbolic links instead of hard links\n" \
1243 "\t-f\tremove existing destination files\n" \
1244 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001245#define ln_example_usage \
1246 "$ ln -s BusyBox /tmp/ls\n" \
1247 "$ ls -l /tmp/ls\n" \
1248 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001249
1250#define loadacm_trivial_usage \
1251 "< mapfile"
1252#define loadacm_full_usage \
1253 "Loads an acm from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001254#define loadacm_example_usage \
1255 "$ loadacm < /etc/i18n/acmname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001256
1257#define loadfont_trivial_usage \
1258 "< font"
1259#define loadfont_full_usage \
1260 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001261#define loadfont_example_usage \
1262 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001263
1264#define loadkmap_trivial_usage \
1265 "< keymap"
1266#define loadkmap_full_usage \
1267 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001268#define loadkmap_example_usage \
1269 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001270
1271#define logger_trivial_usage \
1272 "[OPTION]... [MESSAGE]"
1273#define logger_full_usage \
1274 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1275 "Options:\n" \
1276 "\t-s\tLog to stderr as well as the system log.\n" \
1277 "\t-t\tLog using the specified tag (defaults to user name).\n" \
1278 "\t-p\tEnter the message with the specified priority.\n" \
1279 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001280#define logger_example_usage \
1281 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001282
Robert Griebl1fca5582002-06-04 20:45:46 +00001283#define login_trivial_usage \
1284 "[OPTION]... [username] [ENV=VAR ...]"
1285#define login_full_usage \
1286 "Begin a new session on the system\n\n" \
1287 "Options:\n" \
1288 "\t-f\tDo not authenticate (user already authenticated)\n" \
1289 "\t-h\tName of the remote host for this login.\n" \
1290 "\t-p\tPreserve environment."
1291
Eric Andersen7e9276b2001-02-22 01:15:47 +00001292#define logname_trivial_usage \
1293 ""
1294#define logname_full_usage \
1295 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001296#define logname_example_usage \
1297 "$ logname\n" \
1298 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001299
Mark Whitley6317c4b2001-03-12 22:51:50 +00001300#define logread_trivial_usage \
1301 ""
1302
1303#define logread_full_usage \
1304 "Shows the messages from syslogd (using circular buffer)."
1305
Matt Kraai83788da2002-03-20 17:38:37 +00001306#define losetup_trivial_usage \
1307 "[OPTION]... LOOPDEVICE FILE\n" \
1308 "or: losetup [OPTION]... -d LOOPDEVICE"
1309#define losetup_full_usage \
1310 "Associate LOOPDEVICE with FILE.\n\n" \
1311 "Options:\n" \
1312 "\t-d\t\tDisassociate LOOPDEVICE.\n" \
1313 "\t-o OFFSET\tStart OFFSET bytes into FILE.\n"
1314
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001315#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001316 #define USAGE_LS_TIMESTAMPS(a) a
1317#else
1318 #define USAGE_LS_TIMESTAMPS(a)
1319#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001320#ifdef CONFIG_FEATURE_LS_FILETYPES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001321 #define USAGE_LS_FILETYPES(a) a
1322#else
1323 #define USAGE_LS_FILETYPES(a)
1324#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001325#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001326 #define USAGE_LS_FOLLOWLINKS(a) a
1327#else
1328 #define USAGE_LS_FOLLOWLINKS(a)
1329#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001330#ifdef CONFIG_FEATURE_LS_RECURSIVE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001331 #define USAGE_LS_RECURSIVE(a) a
1332#else
1333 #define USAGE_LS_RECURSIVE(a)
1334#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001335#ifdef CONFIG_FEATURE_LS_SORTFILES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001336 #define USAGE_LS_SORTFILES(a) a
1337#else
1338 #define USAGE_LS_SORTFILES(a)
1339#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001340#ifdef CONFIG_FEATURE_AUTOWIDTH
Eric Andersen7e9276b2001-02-22 01:15:47 +00001341 #define USAGE_AUTOWIDTH(a) a
1342#else
1343 #define USAGE_AUTOWIDTH(a)
1344#endif
1345#define ls_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +00001346 "[-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 +00001347#define ls_full_usage \
1348 "List directory contents\n\n" \
1349 "Options:\n" \
1350 "\t-1\tlist files in a single column\n" \
1351 "\t-A\tdo not list implied . and ..\n" \
1352 "\t-a\tdo not hide entries starting with .\n" \
1353 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001354 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001355 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001356 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1357 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001358 "\t-i\tlist the i-node for each file\n" \
1359 "\t-l\tuse a long listing format\n" \
1360 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001361 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1362 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1363 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1364 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1365 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001366 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001367 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1368 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1369 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1370 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1371 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001372 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001373 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1374 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001375 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersened0d9582001-02-23 13:23:03 +00001376 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +00001377 "\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001378
1379#define lsmod_trivial_usage \
1380 ""
1381#define lsmod_full_usage \
1382 "List the currently loaded kernel modules."
1383
1384#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001385 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001386#define makedevs_full_usage \
1387 "Creates a range of block or character special files\n\n" \
1388 "TYPEs include:\n" \
1389 "\tb:\tMake a block (buffered) device.\n" \
1390 "\tc or u:\tMake a character (un-buffered) device.\n" \
1391 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1392 "FIRST specifies the number appended to NAME to create the first device.\n" \
1393 "LAST specifies the number of the last item that should be created.\n" \
1394 "If 's' is the last argument, the base device is created as well.\n\n" \
1395 "For example:\n" \
1396 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001397 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001398#define makedevs_example_usage \
1399 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
1400 "[creates ttyS2-ttyS63]\n" \
1401 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
1402 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001403
Eric Andersen7e9276b2001-02-22 01:15:47 +00001404#define md5sum_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001405 "[OPTION] [FILE]...\n" \
1406 "or: md5sum [OPTION] -c [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001407#define md5sum_full_usage \
1408 "Print or check MD5 checksums.\n\n" \
1409 "Options:\n" \
1410 "With no FILE, or when FILE is -, read standard input.\n\n" \
1411 "\t-b\tread files in binary mode\n" \
1412 "\t-c\tcheck MD5 sums against given list\n" \
1413 "\t-t\tread files in text mode (default)\n" \
1414 "\t-g\tread a string\n" \
1415 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001416 "\t-s\tdon't output anything, status code shows success\n" \
1417 "\t-w\twarn about improperly formated MD5 checksum lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001418#define md5sum_example_usage \
1419 "$ md5sum < busybox\n" \
1420 "6fd11e98b98a58f64ff3398d7b324003\n" \
1421 "$ md5sum busybox\n" \
1422 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1423 "$ md5sum -c -\n" \
1424 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1425 "busybox: OK\n" \
1426 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001427
Glenn L McGrath061c9002002-09-16 04:21:46 +00001428#define mesg_trivial_usage \
1429 "mesg [y|n]"
1430#define mesg_full_usage \
1431 "mesg [Y|N], controls write access to your terminal\n" \
1432 "\ty\tAllow write access to your terminal.\n" \
1433 "\tn\tDisallow write access to your terminal.\n"
1434
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001435#define minit_trivial_usage \
1436 "[-spPrRC]"
1437#define minit_full_usage \
1438 "[-spPrRC]"
1439
Eric Andersen7e9276b2001-02-22 01:15:47 +00001440#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001441 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001442#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001443 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001444 "Options:\n" \
1445 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001446 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001447#define mkdir_example_usage \
1448 "$ mkdir /tmp/foo\n" \
1449 "$ mkdir /tmp/foo\n" \
1450 "/tmp/foo: File exists\n" \
1451 "$ mkdir /tmp/foo/bar/baz\n" \
1452 "/tmp/foo/bar/baz: No such file or directory\n" \
1453 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001454
Eric Andersen7e9276b2001-02-22 01:15:47 +00001455#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001456 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001457#define mkfifo_full_usage \
1458 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1459 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001460 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001461
Eric Andersen7e9276b2001-02-22 01:15:47 +00001462#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001463 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001464#define mkfs_minix_full_usage \
1465 "Make a MINIX filesystem.\n\n" \
1466 "Options:\n" \
1467 "\t-c\t\tCheck the device for bad blocks\n" \
1468 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1469 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1470 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001471 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001472
Eric Andersen7e9276b2001-02-22 01:15:47 +00001473#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001474 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001475#define mknod_full_usage \
1476 "Create a special file (block, character, or pipe).\n\n" \
1477 "Options:\n" \
1478 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1479 "TYPEs include:\n" \
1480 "\tb:\tMake a block (buffered) device.\n" \
1481 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001482 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001483#define mknod_example_usage \
1484 "$ mknod /dev/fd0 b 2 0 \n" \
1485 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001486
Eric Andersen7e9276b2001-02-22 01:15:47 +00001487#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001488 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001489#define mkswap_full_usage \
1490 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001491 "Options:\n" \
1492 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001493 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001494 "\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 +00001495 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001496
Eric Andersen7e9276b2001-02-22 01:15:47 +00001497#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001498 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001499#define mktemp_full_usage \
1500 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001501 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001502#define mktemp_example_usage \
1503 "$ mktemp /tmp/temp.XXXXXX\n" \
1504 "/tmp/temp.mWiLjM\n" \
1505 "$ ls -la /tmp/temp.mWiLjM\n" \
1506 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001507
Eric Andersen8d79ce82001-07-22 23:00:15 +00001508#define modprobe_trivial_usage \
1509 "[FILE ...]"
1510#define modprobe_full_usage \
Eric Andersenabc95682002-07-03 02:52:35 +00001511 "Used for high level module loading and unloading."
Eric Andersen8d79ce82001-07-22 23:00:15 +00001512#define modprobe_example_usage \
1513 "$ modprobe cdrom\n"
1514
Eric Andersen7e9276b2001-02-22 01:15:47 +00001515#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001516 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001517#define more_full_usage \
1518 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001519#define more_example_usage \
1520 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001521
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001522#ifdef CONFIG_FEATURE_MOUNT_LOOP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001523 #define USAGE_MOUNT_LOOP(a) a
1524#else
1525 #define USAGE_MOUNT_LOOP(a)
1526#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001527#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001528 #define USAGE_MTAB(a) a
1529#else
1530 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001531#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001532#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001533 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001534#define mount_full_usage \
1535 "Mount a filesystem\n\n" \
1536 "Flags:\n" \
1537 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001538 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001539 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001540 "\t-n:\t\tDon't write a mount table entry.\n" \
1541 ) \
1542 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1543 "\t-r:\t\tMount the filesystem read-only.\n" \
1544 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1545 "\t-w:\t\tMount for reading and writing (default).\n" \
1546 "\n" \
1547 "Options for use with the \"-o\" flag:\n" \
1548 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1549 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1550 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1551 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001552 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001553 "\tloop:\t\tMounts a file via loop device.\n" \
1554 ) \
1555 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001556 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001557 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001558 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001559 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001560 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001561#define mount_example_usage \
1562 "$ mount\n" \
1563 "/dev/hda3 on / type minix (rw)\n" \
1564 "proc on /proc type proc (rw)\n" \
1565 "devpts on /dev/pts type devpts (rw)\n" \
1566 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1567 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001568
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001569#define msvc_trivial_usage \
1570 "-[udorspchaitkx] service"
1571#define msvc_full_usafe \
1572 "[option] service\n" \
1573 "Where option is one of\n" \
1574 "\t-u\tUp. If the service is not running, start it. If the service stops, restart it.\n" \
1575 "\t-d\tDown. If the service is running, stop it, do not restart it.\n" \
1576 "\t-o\tOnce. If the service is not running, start it. Do not restart it if it stops.\n" \
1577 "\t-r\tTell supervise that the service is normally running; this affects status messages.\n" \
1578 "\t-s\tTell supervise that the service is normally stopped; this affects status messages.\n" \
1579 "\t-p\tPause. Send the service a STOP signal.\n" \
1580 "\t-c\tContinue. Send the service a CONT signal.\n" \
1581 "\t-h\tHangup. Send the service a HUP signal.\n" \
1582 "\t-a\tAlarm. Send the service an ALRM signal.\n" \
1583 "\t-i\tInterrupt. Send the service an INT signal.\n" \
1584 "\t-t\tTerminate. Send the service a TERM signal.\n" \
1585 "\t-k\tKill. Send the service a KILL signal.\n" \
1586 "\t-x\tExit. supervise will quit as soon as the service is down.\n"
1587
Eric Andersen7e9276b2001-02-22 01:15:47 +00001588#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001589 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001590#define mt_full_usage \
1591 "Control magnetic tape drive operation\n" \
1592 "\nAvailable Opcodes:\n\n" \
1593 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1594 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
1595 "ras3 reset retension rew rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001596 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001597
Eric Andersen7e9276b2001-02-22 01:15:47 +00001598#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001599 "SOURCE DEST\n" \
1600 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001601#define mv_full_usage \
1602 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001603#define mv_example_usage \
1604 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001605
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001606#define nameif_trivial_usage \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001607 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001608#define nameif_full_usage \
1609 "Nameif renaming network interface while it in the down state.\n\n" \
1610 "Options:\n" \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001611 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001612 "\t-s\t\tUse syslog (LOCAL0 facility).\n" \
1613 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address\n"
1614#define nameif_example_usage \
1615 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
1616 " or\n" \
1617 "$ nameif -c /etc/my_mactab_file\n" \
1618
Eric Andersen7e9276b2001-02-22 01:15:47 +00001619#define nc_trivial_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001620 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001621#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001622 "Netcat opens a pipe to IP:port\n\n" \
1623 "Options:\n" \
1624 "\t-l\t\tlisten mode, for inbound connects\n" \
1625 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00001626 "\t-i SECS\t\tdelay interval for lines sent\n" \
Eric Andersen00a6a752002-04-26 23:53:10 +00001627 "\t-e PROG\t\tprogram to exec after connect (dangerous!)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001628#define nc_example_usage \
1629 "$ nc foobar.somedomain.com 25\n" \
1630 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1631 "help\n" \
1632 "214-Commands supported:\n" \
1633 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1634 "214 NOOP QUIT RSET HELP\n" \
1635 "quit\n" \
1636 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001637
Eric Andersen1552ff72001-10-31 11:07:12 +00001638#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00001639 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00001640#define netstat_full_usage \
1641 "-l display listening server sockets\n" \
1642 "-a display all sockets (default: connected)\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001643 "-e display other/more information\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001644 "-n don't resolve names\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001645 "-r display routing table\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001646 "-t tcp sockets\n" \
1647 "-u udp sockets\n" \
1648 "-w raw sockets\n" \
1649 "-x unix sockets\n"
1650
Eric Andersen7e9276b2001-02-22 01:15:47 +00001651#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001652 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001653#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001654 "Queries the nameserver for the IP address of the given HOST\n" \
1655 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001656#define nslookup_example_usage \
1657 "$ nslookup localhost\n" \
1658 "Server: default\n" \
1659 "Address: default\n" \
1660 "\n" \
1661 "Name: debian\n" \
1662 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001663
Glenn L McGrath60281112001-11-02 11:39:46 +00001664#define od_trivial_usage \
1665 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
1666#define od_full_usage \
1667 "Write an unambiguous representation, octal bytes by default, of FILE\n"\
1668 "to standard output. With no FILE, or when FILE is -, read standard input."
1669
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00001670#define openvt_trivial_usage \
1671 "<vtnum> <COMMAND> [ARGS...]"
1672#define openvt_full_usage \
1673 "Start a command on a new virtual terminal"
1674#define openvt_example_usage \
1675 "openvt 2 /bin/ash\n"
1676
Eric Andersen27f64e12002-06-23 04:24:25 +00001677#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
1678 #define PASSWORD_ALG_TYPES(a) a
1679#else
1680 #define PASSWORD_ALG_TYPES(a)
1681#endif
1682#define passwd_trivial_usage \
1683 "[OPTION] [name]"
1684#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00001685 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00001686 "changes the password for the current user.\n" \
1687 "Options:\n" \
1688 "\t-a\tDefine which algorithm shall be used for the password.\n" \
1689 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001690 PASSWORD_ALG_TYPES(", sha1") \
Eric Andersen27f64e12002-06-23 04:24:25 +00001691 ")\n\t-d\tDelete the password for the specified user account.\n" \
1692 "\t-l\tLocks (disables) the specified user account.\n" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001693 "\t-u\tUnlocks (re-enables) the specified user account."
Eric Andersen27f64e12002-06-23 04:24:25 +00001694
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001695#define pidfilehack_trivial_usage \
1696 "[daemon.pid] [daemon]"
1697#define pidfilehack_full_usage \
1698 "service /var/run/daemon.pid /usr/sbin/daemon args...\n"
1699
Eric Andersen221b2ea2001-07-31 19:06:07 +00001700#define pidof_trivial_usage \
1701 "process-name [process-name ...]"
1702#define pidof_full_usage \
1703 "Lists the PIDs of all processes with names that match the names on the command line"
1704#define pidof_example_usage \
1705 "$ pidof init\n" \
1706 "1\n"
1707
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001708#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001709#define ping_trivial_usage "host"
1710#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1711#else
1712#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001713 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001714#define ping_full_usage \
1715 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1716 "Options:\n" \
1717 "\t-c COUNT\tSend only COUNT pings.\n" \
1718 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1719 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001720 "\t\t\tand when finished."
1721#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001722#define ping_example_usage \
1723 "$ ping localhost\n" \
1724 "PING slag (127.0.0.1): 56 data bytes\n" \
1725 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1726 "\n" \
1727 "--- debian ping statistics ---\n" \
1728 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1729 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001730
Eric Andersen51b8bd62002-07-03 11:46:38 +00001731#ifndef CONFIG_FEATURE_FANCY_PING6
1732#define ping6_trivial_usage "host"
1733#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1734#else
1735#define ping6_trivial_usage \
1736 "[OPTION]... host"
1737#define ping6_full_usage \
1738 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1739 "Options:\n" \
1740 "\t-c COUNT\tSend only COUNT pings.\n" \
1741 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1742 "\t-q\t\tQuiet mode, only displays output at start\n" \
1743 "\t\t\tand when finished."
1744#endif
1745#define ping6_example_usage \
1746 "$ ping6 ip6-localhost\n" \
1747 "PING ip6-localhost (::1): 56 data bytes\n" \
1748 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
1749 "\n" \
1750 "--- ip6-localhost ping statistics ---\n" \
1751 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1752 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
1753
Eric Andersen7e9276b2001-02-22 01:15:47 +00001754#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001755 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001756#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001757 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001758 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001759
Eric Andersen7e9276b2001-02-22 01:15:47 +00001760#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001761 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001762#define poweroff_full_usage \
1763 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001764
Eric Andersen7e9276b2001-02-22 01:15:47 +00001765#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001766 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001767#define printf_full_usage \
1768 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001769 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001770#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001771 "$ printf "Val=%d\\n" 5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001772 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001773
Eric Andersen7e9276b2001-02-22 01:15:47 +00001774#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001775 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001776#define ps_full_usage \
1777 "Report process status\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001778 "\nThis version of ps accepts no options."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001779#define ps_example_usage \
1780 "$ ps\n" \
1781 " PID Uid Gid State Command\n" \
1782 " 1 root root S init\n" \
1783 " 2 root root S [kflushd]\n" \
1784 " 3 root root S [kupdate]\n" \
1785 " 4 root root S [kpiod]\n" \
1786 " 5 root root S [kswapd]\n" \
1787 " 742 andersen andersen S [bash]\n" \
1788 " 743 andersen andersen S -bash\n" \
1789 " 745 root root S [getty]\n" \
1790 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001791
Eric Andersen7e9276b2001-02-22 01:15:47 +00001792#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001793 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001794#define pwd_full_usage \
1795 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001796#define pwd_example_usage \
1797 "$ pwd\n" \
1798 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001799
Eric Andersen7e9276b2001-02-22 01:15:47 +00001800#define rdate_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001801 "[OPTION] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001802#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001803 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001804 "Options:\n" \
1805 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001806 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001807
Eric Andersen7e9276b2001-02-22 01:15:47 +00001808#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001809 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001810#define readlink_full_usage \
1811 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001812
Glenn L McGrath62fae302002-12-10 00:14:33 +00001813#define realpath_trivial_usage \
1814 "pathname ..."
1815#define realpath_full_usage \
1816 "return the canonicalized absolute pathnames of given arguments\n\n"
1817
Eric Andersen7e9276b2001-02-22 01:15:47 +00001818#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001819 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001820#define reboot_full_usage \
1821 "Reboot the system."
1822
1823#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001824 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001825#define renice_full_usage \
1826 "Changes priority of running processes. Allowed priorities range\n" \
1827 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001828 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001829
Eric Andersen7e9276b2001-02-22 01:15:47 +00001830#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001831 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001832#define reset_full_usage \
1833 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001834
Eric Andersen7e9276b2001-02-22 01:15:47 +00001835#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001836 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001837#define rm_full_usage \
1838 "Remove (unlink) the FILE(s). You may use '--' to\n" \
1839 "indicate that all following arguments are non-options.\n\n" \
1840 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001841 "\t-i\t\talways prompt before removing each destination\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001842 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001843 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001844#define rm_example_usage \
1845 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001846
Eric Andersen7e9276b2001-02-22 01:15:47 +00001847#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001848 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001849#define rmdir_full_usage \
1850 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001851#define rmdir_example_usage \
1852 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001853
Eric Andersen7e9276b2001-02-22 01:15:47 +00001854#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001855 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001856#define rmmod_full_usage \
1857 "Unloads the specified kernel modules from the kernel.\n\n" \
1858 "Options:\n" \
Tim Rikercf932742002-12-14 01:58:59 +00001859 "\t-a\tRemove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001860#define rmmod_example_usage \
1861 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001862
Eric Andersen7e9276b2001-02-22 01:15:47 +00001863#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001864 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001865#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00001866 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00001867 "Options:\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001868 "\t-n\tDont resolve names.\n" \
1869 "\t-e\tDisplay other/more information"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001870
Glenn L McGrathb72a7352002-12-10 00:17:22 +00001871#define rpm_trivial_usage \
1872 "-i -q[ildc]p package.rpm"
1873#define rpm_full_usage \
1874 "Manipulates RPM packages" \
1875 "Options:" \
1876 "\t-i Install package" \
1877 "\t-q Query package" \
1878 "\t\t-p Query uninstalled package" \
1879 "\t\t-i Show information" \
1880 "\t\t-l List contents" \
1881 "\t\t-d List documents" \
1882 "\t\t-c List config files"
1883
Glenn L McGrathf8736d22001-06-26 01:19:34 +00001884#define rpm2cpio_trivial_usage \
1885 "package.rpm"
1886#define rpm2cpio_full_usage \
1887 "Outputs a cpio archive of the rpm file."
1888
Eric Andersen6cf47a72001-10-31 10:24:36 +00001889#define run_parts_trivial_usage \
1890 "[-t] [-a ARG] [-u MASK] DIRECTORY"
1891#define run_parts_full_usage \
1892 "Run a bunch of scripts in a directory.\n\n" \
1893 "Options:\n" \
1894 "\t-t\t\tTest only what file will be executed, without execute them.\n" \
1895 "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \
1896 "\t-u MASK\tSet the umask to MASK before executing every program."
1897
Eric Andersen7e9276b2001-02-22 01:15:47 +00001898#define sed_trivial_usage \
Matt Kraai075228a2001-06-21 14:40:55 +00001899 "[-nef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001900#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001901 "Options:\n" \
1902 "\t-n\t\tsuppress automatic printing of pattern space\n" \
1903 "\t-e script\tadd the script to the commands to be executed\n" \
1904 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001905 "\n" \
1906 "If no -e or -f is given, the first non-option argument is taken as the\n" \
1907 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001908 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001909#define sed_example_usage \
1910 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
1911 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001912
Eric Andersen7e9276b2001-02-22 01:15:47 +00001913#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001914 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001915#define setkeycodes_full_usage \
1916 "Set entries into the kernel's scancode-to-keycode map,\n" \
1917 "allowing unusual keyboards to generate usable keycodes.\n\n" \
1918 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001919 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001920#define setkeycodes_example_usage \
1921 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001922
Matt Kraai2d91deb2001-08-01 17:21:35 +00001923#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001924 "[FILE]...\n" \
1925 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00001926#define lash_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001927 "lash: The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00001928#define lash_notes_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001929"This command does not yet have proper documentation.\n" \
1930"\n" \
1931"Use lash just as you would use any other shell. It properly handles pipes,\n" \
1932"redirects, job control, can be used as the shell for scripts, and has a\n" \
1933"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
1934"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
1935"use ash or bash. If you just need a very simple and extremely small shell,\n" \
1936"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001937
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00001938#define sha1sum_trivial_usage \
1939 "[OPTION] [FILE]"
1940#define sha1sum_full_usage \
1941 "[OPTION] [FILE]"
1942
Manuel Novoa III cad53642003-03-19 09:13:01 +00001943#ifdef CONFIG_FEATURE_FANCY_SLEEP
1944 #define USAGE_FANCY_SLEEP(a) a
1945 #define USAGE_NOT_FANCY_SLEEP(a)
1946#else
1947 #define USAGE_FANCY_SLEEP(a)
1948 #define USAGE_NOT_FANCY_SLEEP(a) a
1949#endif
1950
Eric Andersen7e9276b2001-02-22 01:15:47 +00001951#define sleep_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001952 USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001953#define sleep_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001954 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \
1955 USAGE_FANCY_SLEEP( \
1956"Pause for a time equal to the total of the args given, where each arg can\n" \
1957"have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001958#define sleep_example_usage \
1959 "$ sleep 2\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001960 "[2 second delay results]\n" \
1961 USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \
1962 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001963
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001964#ifdef CONFIG_FEATURE_SORT_UNIQUE
Mark Whitleyfccaa362001-04-17 18:56:18 +00001965 #define USAGE_SORT_UNIQUE(a) a
1966#else
1967 #define USAGE_SORT_UNIQUE(a)
1968#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001969#ifdef CONFIG_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001970 #define USAGE_SORT_REVERSE(a) a
1971#else
1972 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001973#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001974#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001975 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001976#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001977 "Sorts lines of text in the specified files\n\n"\
1978 "Options:\n" \
1979 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
1980 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
1981 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001982#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001983 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001984 "a\n" \
1985 "b\n" \
1986 "c\n" \
1987 "d\n" \
1988 "e\n" \
1989 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001990
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001991#define start_stop_daemon_trivial_usage \
1992 "[OPTIONS]"
1993#define start_stop_daemon_full_usage \
1994 "Program to start and stop services.\n"\
1995 "Options:\n" \
1996 "-S\t\t\tstart\n"\
1997 "-K\t\t\tstop\n"\
Eric Andersenfe5b1a92002-10-22 19:21:48 +00001998 "-b\t\t\tforce process into background (daemonize)\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001999 "-x <executable>\t\tprogram to start/check if it is running\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002000 "-u <username>|<uid>\tstop this user's processes\n"\
2001 "-n <process-name>\tstop processes with this name\n"\
2002 "-s <signal>\t\tsignal to send (default 15)\n"\
2003 "-a <pathname>\t\tprogram to start (default <executable>)\n"
2004
Eric Andersenef5e8f82002-11-07 02:09:37 +00002005#define strings_trivial_usage \
2006 "[-afo] [-n length] [file ... ]"
2007#define strings_full_usage \
2008 "Display printable strings in a binary file." \
2009 "\n\nOptions:" \
2010 "\n\t-f\tPrecede each string with the name of the file where it was found." \
2011 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
2012 "\n\t-o\tEach string is preceded by its decimal offset in the file."
2013
Eric Andersen7e9276b2001-02-22 01:15:47 +00002014#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002015 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002016#define stty_full_usage \
2017 "Without arguments, prints baud rate, line discipline," \
2018 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002019 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00002020 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002021 "\n\t-a\t\tprint all current settings in human-readable form" \
2022 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00002023 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002024
Robert Griebl1fca5582002-06-04 20:45:46 +00002025#define su_trivial_usage \
2026 "[OPTION]... [-] [username]"
2027#define su_full_usage \
2028 "Change user id or become root.\n" \
2029 "Options:\n" \
2030 "\t-p\tPreserve environment"
2031
Eric Andersen27f64e12002-06-23 04:24:25 +00002032#define sulogin_trivial_usage \
2033 "[OPTION]... [tty-device]"
2034#define sulogin_full_usage \
2035 "Single user login\n" \
2036 "Options:\n" \
2037 "\t-f\tDo not authenticate (user already authenticated)\n" \
2038 "\t-h\tName of the remote host for this login.\n" \
2039 "\t-p\tPreserve environment."
2040
Eric Andersen7e9276b2001-02-22 01:15:47 +00002041#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002042 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002043#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002044 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002045 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002046 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002047
Eric Andersen7e9276b2001-02-22 01:15:47 +00002048#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002049 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002050#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002051 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002052 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002053 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002054
Eric Andersen7e9276b2001-02-22 01:15:47 +00002055#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002056 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002057#define sync_full_usage \
2058 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002059
Eric Andersen7e9276b2001-02-22 01:15:47 +00002060
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002061#ifdef CONFIG_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00002062 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002063#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00002064 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002065#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00002066#ifdef CONFIG_FEATURE_IPC_SYSLOG
2067 #define USAGE_IPC_LOG(a) a
2068#else
2069 #define USAGE_IPC_LOG(a)
2070#endif
2071
Eric Andersen7e9276b2001-02-22 01:15:47 +00002072#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002073 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002074#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002075 "Linux system and kernel logging utility.\n" \
2076 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002077 "Options:\n" \
2078 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
2079 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002080 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002081 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00002082 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00002083 "\t-L\t\tLog locally and via network logging (default is network only)") \
2084 USAGE_IPC_LOG( \
2085 "\n\t-C\t\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002086#define syslogd_example_usage \
2087 "$ syslogd -R masterlog:514\n" \
2088 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002089
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002090
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002091#ifndef CONFIG_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00002092 #define USAGE_UNSIMPLE_TAIL(a)
2093#else
2094 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002095#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002096#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002097 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002098#define tail_full_usage \
2099 "Print last 10 lines of each FILE to standard output.\n" \
2100 "With more than one FILE, precede each with a header giving the\n" \
2101 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
2102 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002103 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002104 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
2105 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002106 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002107 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
2108 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002109 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002110 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002111 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
2112#define tail_example_usage \
2113 "$ tail -n 1 /etc/resolv.conf\n" \
2114 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002115
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002116#ifdef CONFIG_FEATURE_TAR_CREATE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002117 #define USAGE_TAR_CREATE(a) a
2118#else
2119 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002120#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002121#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002122 #define USAGE_TAR_EXCLUDE(a) a
2123#else
2124 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002125#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002126#ifdef CONFIG_FEATURE_TAR_GZIP
2127 #define USAGE_TAR_GZIP(a) a
2128#else
2129 #define USAGE_TAR_GZIP(a)
2130#endif
2131#ifdef CONFIG_FEATURE_TAR_BZIP2
2132 #define USAGE_TAR_BZIP2(a) a
2133#else
2134 #define USAGE_TAR_BZIP2(a)
2135#endif
2136
Eric Andersen7e9276b2001-02-22 01:15:47 +00002137#define tar_trivial_usage \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002138 "-[" USAGE_TAR_CREATE("c") USAGE_TAR_GZIP("z") USAGE_TAR_BZIP2("j") "xtvO] " \
Eric Andersen317827d2001-05-21 17:50:53 +00002139 USAGE_TAR_EXCLUDE("[--exclude FILE] [-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00002140 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002141#define tar_full_usage \
2142 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00002143 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002144 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002145 "\tx\t\textract\n" \
2146 "\tt\t\tlist\n" \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002147 "\nArchive format selection:\n" \
2148 USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
2149 USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002150 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002151 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002152 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002153 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002154 "\texclude\t\tfile to exclude\n" \
2155 "\tX\t\tfile with names to exclude\n" \
2156 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00002157 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002158 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002159#define tar_example_usage \
2160 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
2161 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002162
Eric Andersen7e9276b2001-02-22 01:15:47 +00002163#define tee_trivial_usage \
2164 "[OPTION]... [FILE]..."
2165#define tee_full_usage \
2166 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002167 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002168 "\t-a\tappend to the given FILEs, do not overwrite\n" \
2169 "\t-i\tignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002170#define tee_example_usage \
2171 "$ echo "Hello" | tee /tmp/foo\n" \
2172 "$ cat /tmp/foo\n" \
2173 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002174
Eric Andersen7e9276b2001-02-22 01:15:47 +00002175#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002176 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002177#define telnet_full_usage \
2178 "Telnet is used to establish interactive communication with another\n"\
2179 "computer over a network using the TELNET protocol."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002180
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002181#ifdef CONFIG_FEATURE_TELNETD_INETD
2182#define telnetd_trivial_usage \
2183 "(inetd mode) [OPTION]"
2184#define telnetd_full_usage \
2185 "Telnetd uses incoming TELNET connections via inetd.\n"\
2186 "Options:\n" \
2187 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
2188#else
Eric Andersen08a72202002-09-30 20:52:10 +00002189#define telnetd_trivial_usage \
2190 "[OPTION]"
2191#define telnetd_full_usage \
2192 "Telnetd listens for incoming TELNET connections on PORT.\n"\
2193 "Options:\n" \
2194 "\t-p PORT\tlisten for connections on PORT (default 23)\n"\
2195 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002196#endif
Eric Andersen08a72202002-09-30 20:52:10 +00002197
Eric Andersen7e9276b2001-02-22 01:15:47 +00002198#define test_trivial_usage \
2199 "EXPRESSION\n or [ EXPRESSION ]"
2200#define test_full_usage \
2201 "Checks file types and compares values returning an exit\n" \
2202 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002203#define test_example_usage \
2204 "$ test 1 -eq 2\n" \
2205 "$ echo $?\n" \
2206 "1\n" \
2207 "$ test 1 -eq 1\n" \
2208 "$ echo $? \n" \
2209 "0\n" \
2210 "$ [ -d /etc ]\n" \
2211 "$ echo $?\n" \
2212 "0\n" \
2213 "$ [ -d /junk ]\n" \
2214 "$ echo $?\n" \
2215 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002216
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002217#ifdef CONFIG_FEATURE_TFTP_GET
Mark Whitley450736c2001-03-02 19:08:50 +00002218 #define USAGE_TFTP_GET(a) a
2219#else
2220 #define USAGE_TFTP_GET(a)
2221#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002222#ifdef CONFIG_FEATURE_TFTP_PUT
Mark Whitley450736c2001-03-02 19:08:50 +00002223 #define USAGE_TFTP_PUT(a) a
2224#else
2225 #define USAGE_TFTP_PUT(a)
2226#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002227#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Glenn L McGrathad117d82001-10-05 04:40:37 +00002228 #define USAGE_TFTP_BS(a) a
2229#else
2230 #define USAGE_TFTP_BS(a)
2231#endif
Mark Whitley450736c2001-03-02 19:08:50 +00002232
2233#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00002234 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00002235#define tftp_full_usage \
2236 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00002237 "Options:\n" \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002238 "\t-l FILE\tLocal FILE.\n" \
2239 "\t-r FILE\tRemote FILE.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002240 USAGE_TFTP_GET( \
Matt Kraai3be34302001-09-21 14:42:30 +00002241 "\t-g\tGet file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002242 ) \
2243 USAGE_TFTP_PUT( \
Matt Kraai3be34302001-09-21 14:42:30 +00002244 "\t-p\tPut file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002245 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002246 USAGE_TFTP_BS( \
2247 "\t-b SIZE\tTransfer blocks of SIZE octets.\n" \
2248 )
Eric Andersenc3657422001-11-30 07:54:32 +00002249#define time_trivial_usage \
2250 "[OPTION]... COMMAND [ARGS...]"
2251#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00002252 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
2253 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00002254 "Options:\n" \
2255 "\t-v\tDisplays verbose resource usage information."
Mark Whitley450736c2001-03-02 19:08:50 +00002256
Eric Andersen420b2082002-09-17 22:14:58 +00002257#define top_trivial_usage \
2258 "[-d <seconds>]"
2259#define top_full_usage \
2260 "top provides an view of processor activity in real time.\n" \
2261 "This utility reads the status for all processes in /proc each <seconds>\n" \
2262 "and shows the status for however many processes will fit on the screen.\n" \
2263 "This utility will not show processes that are started after program startup,\n" \
2264 "but it will show the EXIT status for and PIDs that exit while it is running."
2265
Eric Andersen7e9276b2001-02-22 01:15:47 +00002266#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002267 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002268#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002269 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002270 "Options:\n" \
2271 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002272#define touch_example_usage \
2273 "$ ls -l /tmp/foo\n" \
2274 "/bin/ls: /tmp/foo: No such file or directory\n" \
2275 "$ touch /tmp/foo\n" \
2276 "$ ls -l /tmp/foo\n" \
2277 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002278
2279#define tr_trivial_usage \
2280 "[-cds] STRING1 [STRING2]"
2281#define tr_full_usage \
2282 "Translate, squeeze, and/or delete characters from\n" \
2283 "standard input, writing to standard output.\n\n" \
2284 "Options:\n" \
2285 "\t-c\ttake complement of STRING1\n" \
2286 "\t-d\tdelete input characters coded STRING1\n" \
2287 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002288#define tr_example_usage \
2289 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
2290 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002291
Eric Andersen5c58d282001-07-10 16:29:00 +00002292#define traceroute_trivial_usage \
2293 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n\
2294 [-s src_addr] [-t tos] [-w wait] host [data size]"
2295#define traceroute_full_usage \
2296 "trace the route ip packets follow going to \"host\"\n" \
2297 "Options:\n" \
2298 "\t-d\tset SO_DEBUG options to socket\n" \
2299 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
2300 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
2301 "\t-v\tVerbose output\n" \
2302 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
2303 "\t-p port#\tSet the base UDP port number used in probes\n" \
2304 "\t\t(default is 33434)\n" \
2305 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
2306 "\t\t(default is 3)\n" \
2307 "\t-s src_addr\tUse the following IP address as the source address\n" \
2308 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
2309 "\t\t(default 0)\n" \
2310 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
2311 "\t\t(default 3 sec.)."
2312
2313
Eric Andersen7e9276b2001-02-22 01:15:47 +00002314#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002315 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002316#define true_full_usage \
2317 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002318#define true_example_usage \
2319 "$ true\n" \
2320 "$ echo $?\n" \
2321 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002322
Eric Andersen7e9276b2001-02-22 01:15:47 +00002323#define tty_trivial_usage \
2324 ""
2325#define tty_full_usage \
2326 "Print the file name of the terminal connected to standard input.\n\n"\
2327 "Options:\n" \
2328 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002329#define tty_example_usage \
2330 "$ tty\n" \
2331 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002332
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002333#define udhcpc_trivial_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00002334 "[-fbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002335#define udhcpc_full_usage \
2336 "\t-c,\t--clientid=CLIENTID\tClient identifier\n" \
2337 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00002338 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002339 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00002340 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated.\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002341 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
2342 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated.\n" \
2343 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
2344 "\t-q,\t--quit\tQuit after obtaining lease\n" \
2345 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
2346 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
2347 "\t-v,\t--version\tDisplay version"
2348
Russ Dill61fb4892002-10-14 21:41:28 +00002349#define udhcpd_trivial_usage \
2350 "[configfile]\n" \
2351
2352#define udhcpd_full_usage \
Glenn L McGrath9130c852002-12-12 12:56:18 +00002353 ""
Russ Dill61fb4892002-10-14 21:41:28 +00002354
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002355#ifdef CONFIG_FEATURE_MOUNT_FORCE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002356 #define USAGE_MOUNT_FORCE(a) a
2357#else
2358 #define USAGE_MOUNT_FORCE(a)
2359#endif
2360#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002361 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002362#define umount_full_usage \
2363 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00002364 "\nFlags:\n" "\t-a\tUnmount all file systems" \
2365 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
2366 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00002367 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00002368 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 +00002369#define umount_example_usage \
2370 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002371
2372#define uname_trivial_usage \
2373 "[OPTION]..."
2374#define uname_full_usage \
2375 "Print certain system information. With no OPTION, same as -s.\n\n" \
2376 "Options:\n" \
2377 "\t-a\tprint all information\n" \
2378 "\t-m\tthe machine (hardware) type\n" \
2379 "\t-n\tprint the machine's network node hostname\n" \
2380 "\t-r\tprint the operating system release\n" \
2381 "\t-s\tprint the operating system name\n" \
2382 "\t-p\tprint the host processor type\n" \
2383 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002384#define uname_example_usage \
2385 "$ uname -a\n" \
2386 "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002387
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00002388#define uncompress_trivial_usage \
2389 "[-c] [-f] [ name ... ]"
2390#define uncompress_full_usage \
2391 "Uncompress .Z file[s]\n" \
2392 "Options:\n" \
2393 "\t-c\textract to stdout\n" \
2394 "\t-f\tforce overwrite an existing file\n"
2395
Eric Andersen7e9276b2001-02-22 01:15:47 +00002396#define uniq_trivial_usage \
2397 "[OPTION]... [INPUT [OUTPUT]]"
2398#define uniq_full_usage \
2399 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00002400 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002401 "Options:\n" \
2402 "\t-c\tprefix lines by the number of occurrences\n" \
2403 "\t-d\tonly print duplicate lines\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002404 "\t-u\tonly print unique lines\n" \
2405 "\t-f N\tskip the first N fields\n" \
2406 "\t-s N\tskip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002407#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002408 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002409 "a\n" \
2410 "b\n" \
2411 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002412
2413#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002414 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002415#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002416 "Converts FILE from unix format to dos format. When no option\n" \
2417 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002418 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002419 "Options:\n" \
2420 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002421 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002422
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002423#define unzip_trivial_usage \
2424 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
2425#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002426 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002427 "Options:\n" \
2428 "\t-l\tlist archive contents (short form)\n" \
2429 "\t-n\tnever overwrite existing files (default)\n" \
2430 "\t-o\toverwrite files without prompting\n" \
2431 "\t-p\tsend output to stdout\n" \
2432 "\t-q\tbe quiet\n" \
2433 "\t-x\texclude these files\n" \
2434 "\t-d\textract files into this directory"
2435
Eric Andersen7e9276b2001-02-22 01:15:47 +00002436#define update_trivial_usage \
2437 "[options]"
2438#define update_full_usage \
2439 "Periodically flushes filesystem buffers.\n\n" \
2440 "Options:\n" \
2441 "\t-S\tforce use of sync(2) instead of flushing\n" \
2442 "\t-s SECS\tcall sync this often (default 30)\n" \
2443 "\t-f SECS\tflush some buffers this often (default 5)"
2444
2445#define uptime_trivial_usage \
2446 ""
2447#define uptime_full_usage \
2448 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002449#define uptime_example_usage \
2450 "$ uptime\n" \
2451 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002452
2453#define usleep_trivial_usage \
2454 "N"
2455#define usleep_full_usage \
2456 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002457#define usleep_example_usage \
2458 "$ usleep 1000000\n" \
2459 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002460
2461#define uudecode_trivial_usage \
2462 "[FILE]..."
2463#define uudecode_full_usage \
2464 "Uudecode a file that is uuencoded.\n\n" \
2465 "Options:\n" \
Eric Andersen704b2c22001-03-16 08:06:30 +00002466 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002467#define uudecode_example_usage \
2468 "$ uudecode -o busybox busybox.uu\n" \
2469 "$ ls -l busybox\n" \
2470 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002471
2472#define uuencode_trivial_usage \
2473 "[OPTION] [INFILE] REMOTEFILE"
2474#define uuencode_full_usage \
2475 "Uuencode a file.\n\n" \
2476 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00002477 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002478#define uuencode_example_usage \
2479 "$ uuencode busybox busybox\n" \
2480 "begin 755 busybox\n" \
2481 "<encoded file snipped>\n" \
2482 "$ uudecode busybox busybox > busybox.uu\n" \
2483 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002484
Eric Andersen853c4942003-01-23 05:59:32 +00002485#define vconfig_trivial_usage \
2486 "COMMAND [OPTIONS] ..."
2487
2488#define vconfig_full_usage \
2489"Usage: add [interface-name] [vlan_id] \n" \
2490" rem [vlan-name] \n" \
2491" set_flag [interface-name] [flag-num] [0 | 1] \n" \
2492" set_egress_map [vlan-name] [skb_priority] [vlan_qos] \n" \
2493" set_ingress_map [vlan-name] [skb_priority] [vlan_qos] \n" \
2494" set_name_type [name-type] \n"
2495
Eric Andersen3f980402001-04-04 17:31:15 +00002496#define vi_trivial_usage \
2497 "[OPTION] [FILE]..."
2498#define vi_full_usage \
2499 "edit FILE.\n\n" \
2500 "Options:\n" \
2501 "\t-R\tRead-only- do not write to the file."
2502
Eric Andersen27f64e12002-06-23 04:24:25 +00002503#define vlock_trivial_usage \
2504 "[OPTIONS]"
2505#define vlock_full_usage \
2506 "Lock a virtual terminal. A password is required to unlock\n" \
2507 "Options:\n" \
2508 "\t-a\tLock all VTs"
2509
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002510#define watch_trivial_usage \
2511 "[-n <seconds>] COMMAND..."
2512#define watch_full_usage \
2513 "Executes a program periodically.\n" \
2514 "Options:\n" \
2515 "\t-n\tLoop period in seconds - default is 2."
2516#define watch_example_usage \
2517 "$ watch date\n" \
2518 "Mon Dec 17 10:31:40 GMT 2000\n" \
2519 "Mon Dec 17 10:31:42 GMT 2000\n" \
2520 "Mon Dec 17 10:31:44 GMT 2000"
2521
Eric Andersen7e9276b2001-02-22 01:15:47 +00002522#define watchdog_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002523 "DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002524#define watchdog_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002525 "Periodically write to watchdog device DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002526
2527#define wc_trivial_usage \
2528 "[OPTION]... [FILE]..."
2529#define wc_full_usage \
2530 "Print line, word, and byte counts for each FILE, and a total line if\n" \
2531 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
2532 "Options:\n" \
2533 "\t-c\tprint the byte counts\n" \
2534 "\t-l\tprint the newline counts\n" \
2535 "\t-L\tprint the length of the longest line\n" \
2536 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002537#define wc_example_usage \
2538 "$ wc /etc/passwd\n" \
2539 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002540
2541#define wget_trivial_usage \
Robert Griebld7760112002-05-14 23:36:45 +00002542 "[-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 +00002543#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00002544 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002545 "Options:\n" \
2546 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00002547 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00002548 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00002549 "\t-O\tsave to filename ('-' for stdout)\n" \
2550 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002551
2552#define which_trivial_usage \
2553 "[COMMAND ...]"
2554#define which_full_usage \
2555 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002556#define which_example_usage \
2557 "$ which login\n" \
2558 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00002559
Eric Andersen00a6a752002-04-26 23:53:10 +00002560#define who_trivial_usage \
2561 " "
2562#define who_full_usage \
2563 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002564
2565#define whoami_trivial_usage \
2566 ""
2567#define whoami_full_usage \
2568 "Prints the user name associated with the current effective user id."
2569
2570#define xargs_trivial_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002571 "[COMMAND] [-prt] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002572#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002573 "Executes COMMAND on every item given by standard input.\n\n" \
2574 "Options:\n" \
2575 "\t-p\tPrompt the user about whether to run each command\n" \
2576 "\t-r\tDo not run command for empty readed lines\n" \
2577 "\t-t\tPrint the command line on stderr before executing it."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002578#define xargs_example_usage \
2579 "$ ls | xargs gzip\n" \
2580 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002581
2582#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002583 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002584#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002585 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002586
Eric Andersen7e9276b2001-02-22 01:15:47 +00002587#define zcat_trivial_usage \
2588 "FILE"
2589#define zcat_full_usage \
2590 "Uncompress to stdout."