blob: 459b848a51db6451e4b71c4d001fe9dcc39d8701 [file] [log] [blame]
Eric Andersenf349e972001-08-21 16:18:59 +00001#define addgroup_trivial_usage \
Eric Andersene0716ba2003-01-14 06:42:56 +00002 "[OPTIONS] group_name [user_name]"
Eric Andersenf349e972001-08-21 16:18:59 +00003#define addgroup_full_usage \
4 "Adds a group to the system" \
5 "Options:\n" \
6 "\t-g\t\tspecify gid\n"
7
8#define adduser_trivial_usage \
Eric Andersene0716ba2003-01-14 06:42:56 +00009 "[OPTIONS] user_name"
Eric Andersenf349e972001-08-21 16:18:59 +000010#define adduser_full_usage \
11 "Adds a user to the system" \
12 "Options:\n" \
Eric Andersenf0f754a2003-06-21 20:03:07 +000013 "\t-h DIR\t\tAssign home directory DIR\n" \
14 "\t-g GECOS\t\tAssign gecos field GECOS\n" \
15 "\t-s SHELL\t\tAssign login shell SHELL\n" \
16 "\t-G\t\tAdd the user to existing group GROUP\n" \
17 "\t-S\t\tcreate a system user (ignored)\n" \
18 "\t-D\t\tDo not assign a password (logins still possible via ssh)\n" \
19 "\t-H\t\tDo not create the home directory\n"
Eric Andersenf349e972001-08-21 16:18:59 +000020
Mark Whitley6f932772001-03-20 19:18:10 +000021#define adjtimex_trivial_usage \
22 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
23#define adjtimex_full_usage \
24 "Reads and optionally sets system timebase parameters.\n" \
25 "See adjtimex(2).\n\n" \
26 "Options:\n" \
27 "\t-q\t\tquiet mode - do not print\n" \
28 "\t-o offset\ttime offset, microseconds\n" \
29 "\t-f frequency\tfrequency adjust, integer kernel units (65536 is 1ppm)\n" \
30 "\t\t\t(positive values make the system clock run fast)\n" \
31 "\t-t tick\t\tmicroseconds per tick, usually 10000\n" \
32 "\t-p timeconstant\n"
33
Eric Andersen7e9276b2001-02-22 01:15:47 +000034#define ar_trivial_usage \
Glenn L McGrath62ebe2e2001-06-03 05:41:59 +000035 "-[ov][ptx] ARCHIVE FILES"
Eric Andersen7e9276b2001-02-22 01:15:47 +000036#define ar_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +000037 "Extract or list FILES from an ar archive.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +000038 "Options:\n" \
39 "\t-o\t\tpreserve original dates\n" \
40 "\t-p\t\textract to stdout\n" \
41 "\t-t\t\tlist\n" \
42 "\t-x\t\textract\n" \
Glenn L McGrathcda5cf12001-06-03 05:15:04 +000043 "\t-v\t\tverbosely list files processed\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000044
Glenn L McGrath9e598412003-01-09 10:06:01 +000045#define arping_trivial_usage \
46 "[-fqbDUA] [-c count] [-w timeout] [-I device] [-s sender] target\n"
47#define arping_full_usage \
48 "Ping hosts by ARP requests/replies.\n\n" \
49 "Options:\n" \
50 "\t-f\t\tQuit on first ARP reply\n" \
51 "\t-q\t\tBe quiet\n" \
52 "\t-b\t\tKeep broadcasting, don't go unicast\n" \
53 "\t-D\t\tDuplicated address detection mode\n" \
54 "\t-U\t\tUnsolicited ARP mode, update your neighbours\n" \
55 "\t-A\t\tARP answer mode, update your neighbours\n" \
56 "\t-c count\tStop after sending count ARP request packets\n" \
57 "\t-w timeout\tTime to wait for ARP reply, in seconds\n" \
58 "\t-I device\tOutgoing interface name, default is eth0\n" \
59 "\t-s sender\tSet specific sender IP address\n" \
60 "\ttarget\t\tTarget IP address of ARP request\n"
61
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000062#define awk_trivial_usage \
63 "[-v var=val][-F sep] { -f progname | 'programtext' } [FILE ...]"
64#define awk_full_usage \
65 "Options:\n" \
66 "\t-v var=val\tassign value 'val' to variable 'var'\n" \
67 "\t-F sep\t\tuse 'sep' as field separator\n" \
68 "\t-f progname\tread program source from file 'progname'\n"
69
Eric Andersen7e9276b2001-02-22 01:15:47 +000070#define basename_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000071 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000072#define basename_full_usage \
73 "Strips directory path and suffixes from FILE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000074 "If specified, also removes any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000075#define basename_example_usage \
76 "$ basename /usr/local/bin/foo\n" \
77 "foo\n" \
78 "$ basename /usr/local/bin/\n" \
79 "bin\n" \
80 "$ basename /foo/bar.txt .txt\n" \
81 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000082
Glenn L McGrath24e28332001-10-05 03:48:57 +000083#define bunzip2_trivial_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000084 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +000085#define bunzip2_full_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000086 "Uncompress FILE (or standard input if FILE is '-' or omitted).\n\n" \
87 "Options:\n" \
88 "\t-c\tWrite output to standard output\n" \
89 "\t-f\tForce"
Glenn L McGrath24e28332001-10-05 03:48:57 +000090
Glenn L McGrathfff11f12001-11-18 14:20:25 +000091#define bzcat_trivial_usage \
92 "FILE"
93#define bzcat_full_usage \
94 "Uncompress to stdout."
95
Eric Andersenc98c0622001-12-06 15:16:43 +000096#define cal_trivial_usage \
97 "[-jy] [[month] year]"
98#define cal_full_usage \
99 "Display a calendar.\n" \
100 "\nOptions:\n" \
101 "\t-j\tUse julian dates.\n" \
102 "\t-y\tDisplay the entire year."
103
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000104#define cart_trivial_usage \
105 "blah"
106#define cart_full_usage \
107 "blah blah"
108
Eric Andersen7e9276b2001-02-22 01:15:47 +0000109#define cat_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000110 "[-u] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000111#define cat_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000112 "Concatenates FILE(s) and prints them to stdout.\n\n" \
113 "Options:\n" \
114 "\t-u\tignored since unbuffered i/o is always used"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000115#define cat_example_usage \
116 "$ cat /proc/uptime\n" \
117 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000118
Eric Andersen7e9276b2001-02-22 01:15:47 +0000119#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000120 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000121#define chgrp_full_usage \
122 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000123 "\nOptions:\n" \
124 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000125#define chgrp_example_usage \
126 "$ ls -l /tmp/foo\n" \
127 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
128 "$ chgrp root /tmp/foo\n" \
129 "$ ls -l /tmp/foo\n" \
130 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000131
Eric Andersen7e9276b2001-02-22 01:15:47 +0000132#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000133 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000134#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000135 "Each MODE is one or more of the letters ugoa, one of the\n" \
136 "symbols +-= and one or more of the letters rwxst.\n\n" \
137 "Options:\n" \
138 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000139#define chmod_example_usage \
140 "$ ls -l /tmp/foo\n" \
141 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
142 "$ chmod u+x /tmp/foo\n" \
143 "$ ls -l /tmp/foo\n" \
144 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
145 "$ chmod 444 /tmp/foo\n" \
146 "$ ls -l /tmp/foo\n" \
147 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000148
Eric Andersen7e9276b2001-02-22 01:15:47 +0000149#define chown_trivial_usage \
Eric Andersen238da242001-05-11 16:31:46 +0000150 "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000151#define chown_full_usage \
152 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000153 "\nOptions:\n" \
Eric Andersen238da242001-05-11 16:31:46 +0000154 "\t-R\tChanges files and directories recursively.\n" \
155 "\t-h\tDo not dereference symbolic links."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000156#define chown_example_usage \
157 "$ ls -l /tmp/foo\n" \
158 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
159 "$ chown root /tmp/foo\n" \
160 "$ ls -l /tmp/foo\n" \
161 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
162 "$ chown root.root /tmp/foo\n" \
163 "ls -l /tmp/foo\n" \
164 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000165
Eric Andersen7e9276b2001-02-22 01:15:47 +0000166#define chroot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000167 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000168#define chroot_full_usage \
169 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000170#define chroot_example_usage \
171 "$ ls -l /bin/ls\n" \
172 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
173 "$ mount /dev/hdc1 /mnt -t minix\n" \
174 "$ chroot /mnt\n" \
175 "$ ls -l /bin/ls\n" \
176 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000177
Eric Andersen7e9276b2001-02-22 01:15:47 +0000178#define chvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000179 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000180#define chvt_full_usage \
181 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000182
Eric Andersen7e9276b2001-02-22 01:15:47 +0000183#define clear_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000184 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000185#define clear_full_usage \
186 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000187
Eric Andersen7e9276b2001-02-22 01:15:47 +0000188#define cmp_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000189 "[OPTION]... FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000190#define cmp_full_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000191 "Compare files.\n\n" \
192 "Options:\n" \
193 "\t-l\tWrite the byte numbers (decimal) and values (octal)\n" \
194 "\t\t for all differing bytes.\n" \
195 "\t-s\tquiet mode - do not print"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000196
Eric Andersen7e9276b2001-02-22 01:15:47 +0000197#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000198 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000199#define cp_full_usage \
200 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
201 "\n" \
202 "\t-a\tSame as -dpR\n" \
203 "\t-d\tPreserves links\n" \
204 "\t-p\tPreserves file attributes if possible\n" \
205 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersenced97052004-02-20 09:55:37 +0000206 "\t-i\tinteractive, prompt before overwrite\n" \
207 "\t-R,-r\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000208
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000209#define cpio_trivial_usage \
210 "-[dimtuv][F cpiofile]"
211#define cpio_full_usage \
212 "Extract or list files from a cpio archive\n" \
213 "Main operation mode:\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000214 "\td\t\tmake leading directories\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000215 "\ti\t\textract\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000216 "\tm\t\tpreserve mtime\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000217 "\tt\t\tlist\n" \
Eric Andersen6925d502001-12-16 09:23:09 +0000218 "\tu\t\tunconditional overwrite\n" \
219 "\tF\t\tinput from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000220
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000221#define crond_trivial_usage \
222 "-d[#] -c <crondir> -f -b"
223#define crond_full_usage \
224 "\t-d [#] -l [#] -S -L logfile -f -b -c dir\n" \
225 "\t-d num\tdebug level\n" \
226 "\t-l num\tlog level (8 - default)\n" \
Glenn L McGrath2af30442003-09-12 10:58:54 +0000227 "\t-S\tlog to syslod (default)\n" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000228 "\t-L file\tlog to file\n" \
229 "\t-f\trun in fordeground\n" \
230 "\t-b\trun in background (default)\n" \
231 "\t-c dir\tworking dir"
232
233#define crontab_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000234 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000235#define crontab_full_usage \
236 "\tfile <opts> replace crontab from file\n" \
237 "\t- <opts> replace crontab from stdin\n" \
238 "\t-u user specify user\n" \
239 "\t-l [user] list crontab for user\n" \
240 "\t-e [user] edit crontab for user\n" \
241 "\t-d [user] delete crontab for user\n" \
242 "\t-c dir specify crontab directory"
243
244
Eric Andersen7e9276b2001-02-22 01:15:47 +0000245#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000246 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000247#define cut_full_usage \
248 "Prints selected fields from each input FILE to standard output.\n\n" \
249 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000250 "\t-b LIST\t\tOutput only bytes from LIST\n" \
251 "\t-c LIST\t\tOutput only characters from LIST\n" \
252 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
253 "\t-s\t\tOutput only the lines containing delimiter\n" \
254 "\t-f N\t\tPrint only these fields\n" \
255 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000256#define cut_example_usage \
257 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
258 "Hello\n" \
259 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
260 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000261
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000262#ifdef CONFIG_FEATURE_DATE_ISOFMT
263#define USAGE_DATE_ISOFMT(a) a
264#else
265#define USAGE_DATE_ISOFMT(a)
266#endif
267
Eric Andersen7e9276b2001-02-22 01:15:47 +0000268#define date_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +0000269 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000270#define date_full_usage \
271 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000272 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000273 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000274 "\t-d STRING\tDisplays time described by STRING, not `now'\n" \
275 USAGE_DATE_ISOFMT("\t-I[TIMESPEC]\tOutputs an ISO-8601 compliant date/time string.\n" \
276 "\t\t\tTIMESPEC=`date' (or missing) for date only,\n" \
277 "\t\t\t`hours', `minutes', or `seconds' for date and,\n" \
278 "\t\t\ttime to the indicated precision.\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000279 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000280 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000281#define date_example_usage \
282 "$ date\n" \
283 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000284
Eric Andersen7e9276b2001-02-22 01:15:47 +0000285#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000286 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000287#define dc_full_usage \
288 "This is a Tiny RPN calculator that understands the\n" \
Eric Andersena9287742003-10-22 11:24:39 +0000289 "following operations: +, add, -, sub, *, mul, /, div, %, mod, "\
290 "**, exp, and, or, not, eor.\n" \
291 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16.\n" \
292 "\nOptions:\n" \
Glenn L McGrath6d074322002-12-12 10:31:53 +0000293 "p - Prints the value on the top of the stack, without altering the stack.\n" \
294 "f - Prints the entire contents of the stack without altering anything.\n" \
295 "o - Pops the value off the top of the stack and uses it to set the output radix.\n" \
296 " Only 10 and 16 are supported.\n"
297
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000298#define dc_example_usage \
299 "$ dc 2 2 +\n" \
300 "4\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000301 "$ dc 8 8 * 2 2 + /\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000302 "16\n" \
303 "$ dc 0 1 and\n" \
304 "0\n" \
305 "$ dc 0 1 or\n" \
306 "1\n" \
307 "$ echo 72 9 div 8 mul | dc\n" \
308 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000309
Eric Andersen7e9276b2001-02-22 01:15:47 +0000310#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000311 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000312 "\t [seek=N] [conv=notrunc|noerror|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000313#define dd_full_usage \
314 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000315 "\tif=FILE\t\tread from FILE instead of stdin\n" \
316 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
317 "\tbs=N\t\tread and write N bytes at a time\n" \
318 "\tcount=N\t\tcopy only N input blocks\n" \
319 "\tskip=N\t\tskip N input blocks\n" \
320 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000321 "\tconv=notrunc\tdon't truncate output file\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000322 "\tconv=noerror\tcontinue after read errors\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000323 "\tconv=sync\tpad blocks with zeros\n" \
324 "\n" \
325 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000326 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000327#define dd_example_usage \
328 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
329 "4+0 records in\n" \
330 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000331
Eric Andersen7e9276b2001-02-22 01:15:47 +0000332#define deallocvt_trivial_usage \
Glenn L McGrath17b4a202004-01-15 11:50:19 +0000333 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000334#define deallocvt_full_usage \
335 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000336
Eric Andersenf349e972001-08-21 16:18:59 +0000337#define delgroup_trivial_usage \
338 "GROUP"
339#define delgroup_full_usage \
340 "Deletes group GROUP from the system"
341
342#define deluser_trivial_usage \
343 "USER"
344#define deluser_full_usage \
345 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000346
Eric Andersenf18bd892003-12-19 11:07:59 +0000347#ifdef CONFIG_DEVFSD_FG_NP
348 #define USAGE_DEVFSD_FG_NP(a) a
349#else
350 #define USAGE_DEVFSD_FG_NP(a)
351#endif
352
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000353#define devfsd_trivial_usage \
Eric Andersenf18bd892003-12-19 11:07:59 +0000354 "mntpnt [-v]"\
355 USAGE_DEVFSD_FG_NP("[-fg][-np]" )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000356#define devfsd_full_usage \
357 "Optional daemon for managing devfs (the Linux Device Filesystem).\n" \
358 "\nOptions:\n" \
359 "\tmntpnt\tThe mount point where devfs is mounted.\n\n" \
360 "\t-v\tPrint the protocol version numbers for devfsd\n" \
Eric Andersenf18bd892003-12-19 11:07:59 +0000361 "\t\tand the kernel-side protocol version and exits." \
362 USAGE_DEVFSD_FG_NP( "\n\n\t-fg\tRun the daemon in the foreground.\n\n" \
363 "\t-np\tExit after parsing the configuration file\n" \
364 "\t\tand processing synthetic REGISTER events.\n" \
365 "\t\tDo not poll for events.")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000366
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000367#ifdef CONFIG_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000368 #define USAGE_HUMAN_READABLE(a) a
369 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000370#else
Tim Riker7b253f82003-12-28 05:02:40 +0000371 #define USAGE_HUMAN_READABLE(a)
Eric Andersened0d9582001-02-23 13:23:03 +0000372 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000373#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000374#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000375 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000376#define df_full_usage \
377 "Print the filesystem space used and space available.\n\n" \
378 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000379 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000380 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
381 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000382 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000383 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000384#define df_example_usage \
385 "$ df\n" \
386 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
387 "/dev/sda3 8690864 8553540 137324 98% /\n" \
388 "/dev/sda1 64216 36364 27852 57% /boot\n" \
389 "$ df /dev/sda3\n" \
390 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
391 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000392
Eric Andersen7e9276b2001-02-22 01:15:47 +0000393#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000394 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000395#define dirname_full_usage \
396 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000397#define dirname_example_usage \
398 "$ dirname /tmp/foo\n" \
399 "/tmp\n" \
400 "$ dirname /tmp/foo/\n" \
401 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000402
Eric Andersen7e9276b2001-02-22 01:15:47 +0000403#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000404 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000405#define dmesg_full_usage \
406 "Prints or controls the kernel ring buffer\n\n" \
407 "Options:\n" \
408 "\t-c\t\tClears the ring buffer's contents after printing\n" \
409 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000410 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000411
Eric Andersen7e9276b2001-02-22 01:15:47 +0000412#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000413 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000414#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000415 "Converts FILE from dos format to unix format. When no option\n" \
416 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000417 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000418 "Options:\n" \
419 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000420 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000421
Eric Andersen7e9276b2001-02-22 01:15:47 +0000422#define dpkg_trivial_usage \
Eric Andersen9fe5f982002-04-13 14:48:51 +0000423 "-i package_file\n" \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000424 "[-CPru] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000425#define dpkg_full_usage \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000426 "\t-i\tInstall the package\n" \
427 "\t-C\tConfigure an unpackaged package\n" \
428 "\t-P\tPurge all files of a package\n" \
429 "\t-r\tRemove all but the configuration files for a package\n" \
430 "\t-u\tUnpack a package, but dont configure it\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000431
Eric Andersen7e9276b2001-02-22 01:15:47 +0000432#define dpkg_deb_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000433 "[-cefItxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000434#define dpkg_deb_full_usage \
435 "Perform actions on debian packages (.debs)\n\n" \
436 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000437 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000438 "\t-e\tExtract control files to [argument] directory\n" \
439 "\t-f\tDisplay control field name starting with [argument]\n" \
440 "\t-I\tDisplay the control filenamed [argument]\n" \
441 "\t-t\tExtract filesystem tree to stdout in tar format\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000442 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000443 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000444#define dpkg_deb_example_usage \
445 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000446
Glenn L McGrath17b4a202004-01-15 11:50:19 +0000447#define dpkg_divert_trivial_usage \
448 "blah"
449#define dpkg_divert_full_usage \
450 "blah blah"
451
Manuel Novoa III cad53642003-03-19 09:13:01 +0000452#ifdef CONFIG_FEATURE_DU_DEFALT_BLOCKSIZE_1K
453#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a) a
454#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a)
455#else
456#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a)
457#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a) a
458#endif
459
Eric Andersen7e9276b2001-02-22 01:15:47 +0000460#define du_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000461 "[-aHLdclsx" USAGE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000462#define du_full_usage \
463 "Summarizes disk space used for each FILE and/or directory.\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000464 "Disk space is printed in units of " \
465 USAGE_DU_DEFALT_BLOCKSIZE_1k("1024") USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k("512") \
466 " bytes.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000467 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000468 "\t-a\tshow sizes of files in addition to directories\n" \
469 "\t-H\tfollow symbolic links that are FILE command line args\n" \
470 "\t-L\tfollow all symbolic links encountered\n" \
471 "\t-d N\tlimit output to directories (and files with -a) of depth < N\n" \
472 "\t-c\toutput a grand total\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000473 "\t-l\tcount sizes many times if hard linked\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000474 "\t-s\tdisplay only a total for each argument\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000475 "\t-x\tskip directories on different filesystems\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000476 USAGE_HUMAN_READABLE( \
477 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
478 "\t-m\tprint sizes in megabytes\n" ) \
479 "\t-k\tprint sizes in kilobytes" USAGE_DU_DEFALT_BLOCKSIZE_1k("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000480#define du_example_usage \
481 "$ du\n" \
482 "16 ./CVS\n" \
483 "12 ./kernel-patches/CVS\n" \
484 "80 ./kernel-patches\n" \
485 "12 ./tests/CVS\n" \
486 "36 ./tests\n" \
487 "12 ./scripts/CVS\n" \
488 "16 ./scripts\n" \
489 "12 ./docs/CVS\n" \
490 "104 ./docs\n" \
491 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000492
Eric Andersen7e9276b2001-02-22 01:15:47 +0000493#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000494 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000495#define dumpkmap_full_usage \
496 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000497#define dumpkmap_example_usage \
498 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000499
Russ Dill61fb4892002-10-14 21:41:28 +0000500#define dumpleases_trivial_usage \
501 "[-r|-a] [-f LEASEFILE]"
502#define dumpleases_full_usage \
Russ Dill61fb4892002-10-14 21:41:28 +0000503 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
504 "\t-r,\t--remaining\tInterepret lease times as time remaing\n" \
505 "\t-a,\t--absolute\tInterepret lease times as expire time\n"
506
Manuel Novoa III cad53642003-03-19 09:13:01 +0000507#ifdef CONFIG_FEATURE_FANCY_ECHO
508 #define USAGE_FANCY_ECHO(a) a
509#else
Tim Riker7b253f82003-12-28 05:02:40 +0000510 #define USAGE_FANCY_ECHO(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +0000511#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000512
Eric Andersen7e9276b2001-02-22 01:15:47 +0000513#define echo_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000514 USAGE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000515#define echo_full_usage \
516 "Prints the specified ARGs to stdout\n\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000517 USAGE_FANCY_ECHO("Options:\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000518 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000519 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000520 "\t-E\tdisable interpretation of backslash-escaped characters")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000521#define echo_example_usage \
522 "$ echo "Erik is cool"\n" \
523 "Erik is cool\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000524 USAGE_FANCY_ECHO("$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000525 "Erik\n" \
526 "is\n" \
527 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000528 "$ echo "Erik\\nis\\ncool"\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000529 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000530
Eric Andersen84e229c2001-03-29 22:48:33 +0000531#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000532 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000533#define env_full_usage \
534 "Prints the current environment or runs a program after setting\n" \
535 "up the specified environment.\n\n" \
536 "Options:\n" \
537 "\t-, -i\tstart with an empty environment\n" \
538 "\t-u\tremove variable from the environment\n"
539
Eric Andersen7e9276b2001-02-22 01:15:47 +0000540#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000541 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000542#define expr_full_usage \
543 "Prints the value of EXPRESSION to standard output.\n\n" \
544 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000545 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
546 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
547 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
548 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
549 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
550 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
551 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
552 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
553 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
554 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
555 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
556 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
557 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000558 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
559 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
560 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
561 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
562 "\t or 0\n" \
563 "\tlength STRING length of STRING\n" \
564 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
565 "\t it is a keyword like `match' or an\n" \
566 "\t operator like `/'\n" \
567 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000568 "Beware that many operators need to be escaped or quoted for shells.\n" \
569 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
570 "lexicographical. Pattern matches return the string matched between \n" \
571 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
572 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000573
Eric Andersen7e9276b2001-02-22 01:15:47 +0000574#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000575 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000576#define false_full_usage \
577 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000578#define false_example_usage \
579 "$ false\n" \
580 "$ echo $?\n" \
581 "1\n"
582
583#define fbset_trivial_usage \
584 "[options] [mode]"
585#define fbset_full_usage \
586 "Show and modify frame buffer settings"
587#define fbset_example_usage \
588 "$ fbset\n" \
589 "mode "1024x768-76"\n" \
590 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
591 "\tgeometry 1024 768 1024 768 16\n" \
592 "\ttimings 12714 128 32 16 4 128 4\n" \
593 "\taccel false\n" \
594 "\trgba 5/11,6/5,5/0,0/0\n" \
595 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000596
Eric Andersen7e9276b2001-02-22 01:15:47 +0000597#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000598 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000599#define fdflush_full_usage \
600 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000601
Eric Andersen01c3d402003-07-05 07:51:31 +0000602#define fdformat_trivial_usage \
603 "[-n] DEVICE"
604#define fdformat_full_usage \
605 "Low-level formats a floppy disk\n\n" \
606 "Options:\n" \
607 "\t-n\tDon't verify after format"
608
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000609#define fdisk_trivial_usage \
610 "[-l] [-v] [-b SSZ] [-u] DISK"
611#define fdisk_full_usage \
612 "Change partition table\n" \
613 "Options:\n" \
614 "-l List partition table(s)\n" \
615 "-u Give Start and End in sector (instead of cylinder) units\n" \
616 "-s PARTITION Give partition size(s) in blocks\n" \
617 "-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
Glenn L McGrath062c74f2002-11-27 09:29:49 +0000618 "-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000619
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000620#ifdef CONFIG_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000621 #define USAGE_FIND_TYPE(a) a
622#else
623 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000624#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000625#ifdef CONFIG_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000626 #define USAGE_FIND_PERM(a) a
627#else
628 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000629#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000630#ifdef CONFIG_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000631 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000632#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000633 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000634#endif
Eric Andersen97d86f22003-01-23 05:27:42 +0000635#ifdef CONFIG_FEATURE_FIND_NEWER
636 #define USAGE_FIND_NEWER(a) a
637#else
638 #define USAGE_FIND_NEWER(a)
639#endif
640#ifdef CONFIG_FEATURE_FIND_INUM
641 #define USAGE_FIND_INUM(a) a
642#else
643 #define USAGE_FIND_INUM(a)
644#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000645
Eric Andersen7e9276b2001-02-22 01:15:47 +0000646#define find_trivial_usage \
647 "[PATH...] [EXPRESSION]"
648#define find_full_usage \
649 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000650 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000651 "\nEXPRESSION may consist of:\n" \
652 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000653 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000654 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000655 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000656 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
657) USAGE_FIND_PERM( \
658 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
659) USAGE_FIND_MTIME( \
Eric Andersen97d86f22003-01-23 05:27:42 +0000660 "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \
661) USAGE_FIND_NEWER( \
662 "\n\t-newer FILE\tModified time is more recent than FILE's" \
663) USAGE_FIND_INUM( \
664 "\n\t-inum N\t\tFile has inode number N")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000665#define find_example_usage \
666 "$ find / -name /etc/passwd\n" \
667 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000668
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000669#define fold_trivial_usage \
670 "[bsw] [FILE]"
671#define fold_full_usage \
672 "Wrap input lines in each FILE (standard input by default), writing to\n" \
673 "standard output.\n\n" \
674 "Options:\n" \
675 "\t-b\tcount bytes rather than columns\n" \
676 "\t-s\tbreak at spaces\n" \
677 "\t-w\tuse WIDTH columns instead of 80\n"
678
Eric Andersen7e9276b2001-02-22 01:15:47 +0000679#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000680 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000681#define free_full_usage \
682 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000683#define free_example_usage \
684 "$ free\n" \
685 " total used free shared buffers\n" \
686 " Mem: 257628 248724 8904 59644 93124\n" \
687 " Swap: 128516 8404 120112\n" \
688 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000689
Eric Andersen7e9276b2001-02-22 01:15:47 +0000690#define freeramdisk_trivial_usage \
691 "DEVICE"
692#define freeramdisk_full_usage \
693 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000694#define freeramdisk_example_usage \
695 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000696
697#define fsck_minix_trivial_usage \
698 "[-larvsmf] /dev/name"
699#define fsck_minix_full_usage \
700 "Performs a consistency check for MINIX filesystems.\n\n" \
701 "Options:\n" \
702 "\t-l\tLists all filenames\n" \
703 "\t-r\tPerform interactive repairs\n" \
704 "\t-a\tPerform automatic repairs\n" \
705 "\t-v\tverbose\n" \
706 "\t-s\tOutputs super-block information\n" \
707 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
708 "\t-f\tForce file system check."
709
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000710#define ftpget_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000711 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000712#define ftpget_full_usage \
713 "Retrieve a remote file via FTP.\n\n" \
714 "Options:\n" \
715 "\t-c, --continue Continue a previous transfer\n" \
716 "\t-v, --verbose Verbose\n" \
717 "\t-u, --username Username to be used\n" \
718 "\t-p, --password Password to be used\n" \
Tim Riker7b253f82003-12-28 05:02:40 +0000719 "\t-P, --port Port number to be used\n"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000720
721#define ftpput_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000722 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000723#define ftpput_full_usage \
724 "Store a local file on a remote machine via FTP.\n\n" \
725 "Options:\n" \
726 "\t-v, --verbose Verbose\n" \
727 "\t-u, --username Username to be used\n" \
728 "\t-p, --password Password to be used\n" \
Tim Riker7b253f82003-12-28 05:02:40 +0000729 "\t-P, --port Port number to be used\n"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000730
Eric Andersen7e9276b2001-02-22 01:15:47 +0000731#define getopt_trivial_usage \
732 "[OPTIONS]..."
733#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000734 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000735 "\t-a, --alternative Allow long options starting with single -\n" \
736 "\t-l, --longoptions=longopts Long options to be recognized\n" \
737 "\t-n, --name=progname The name under which errors are reported\n" \
738 "\t-o, --options=optstring Short options to be recognized\n" \
739 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
740 "\t-Q, --quiet-output No normal output\n" \
741 "\t-s, --shell=shell Set shell quoting conventions\n" \
742 "\t-T, --test Test for getopt(1) version\n" \
743 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000744#define getopt_example_usage \
745 "$ cat getopt.test\n" \
746 "#!/bin/sh\n" \
747 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
748 " -n 'example.busybox' -- "$@"`\n" \
749 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
750 "eval set -- "$GETOPT"\n" \
751 "while true ; do\n" \
752 " case $1 in\n" \
753 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000754 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000755 " -c|--c-long)\n" \
756 " case "$2" in\n" \
757 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000758 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000759 " esac ;;\n" \
760 " --) shift ; break ;;\n" \
761 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
762 " esac\n" \
763 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000764
Eric Andersenf349e972001-08-21 16:18:59 +0000765#define getty_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000766 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +0000767#define getty_full_usage \
768 "\nOpens a tty, prompts for a login name, then invokes /bin/login\n\n" \
769 "Options:\n" \
770 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
771 "\t-i\t\tDo not display /etc/issue before running login.\n" \
772 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
773 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
774 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
Glenn L McGrath49e74ef2003-05-13 14:59:07 +0000775 "\t-n\t\tDo not prompt the user for a login name.\n" \
776 "\t-f issue_file\tDisplay issue_file instead of /etc/issue.\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000777 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
778 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
779 "\t-I initstring\tSets the init string to send before anything else.\n" \
780 "\t-H login_host\tLog login_host into the utmp file as the hostname."
781
782
Eric Andersen7e9276b2001-02-22 01:15:47 +0000783#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000784 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000785#define grep_full_usage \
786 "Search for PATTERN in each FILE or standard input.\n\n" \
787 "Options:\n" \
788 "\t-H\tprefix output lines with filename where match was found\n" \
789 "\t-h\tsuppress the prefixing filename on output\n" \
790 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000791 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000792 "\t-n\tprint line number with output lines\n" \
793 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
794 "\t-v\tselect non-matching lines\n" \
795 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000796#define grep_example_usage \
797 "$ grep root /etc/passwd\n" \
798 "root:x:0:0:root:/root:/bin/bash\n" \
799 "$ grep ^[rR]oo. /etc/passwd\n" \
800 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000801
Eric Andersen7e9276b2001-02-22 01:15:47 +0000802#define gunzip_trivial_usage \
803 "[OPTION]... FILE"
804#define gunzip_full_usage \
805 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
806 "Options:\n" \
807 "\t-c\tWrite output to standard output\n" \
808 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000809#define gunzip_example_usage \
810 "$ ls -la /tmp/BusyBox*\n" \
811 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
812 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
813 "$ ls -la /tmp/BusyBox*\n" \
814 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000815
816#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000817 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000818#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000819 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000820 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000821 "Options:\n" \
822 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
823 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000824#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000825 "$ ls -la /tmp/busybox*\n" \
826 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
827 "$ gzip /tmp/busybox.tar\n" \
828 "$ ls -la /tmp/busybox*\n" \
829 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000830
831#define halt_trivial_usage \
832 ""
833#define halt_full_usage \
834 "Halt the system."
835
Eric Andersen3443bd72003-07-22 07:30:36 +0000836#ifdef CONFIG_FEATURE_HDPARM_GET_IDENTITY
837#define USAGE_HDPARM_IDENT(a) a
838#else
839#define USAGE_HDPARM_IDENT(a)
840#endif
841
842#ifdef CONFIG_FEATURE_HDPARM_HDIO_SCAN_HWIF
843#define USAGE_SCAN_HWIF(a) a
844#else
845#define USAGE_SCAN_HWIF(a)
846#endif
847
848#ifdef CONFIG_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF
849#define USAGE_UNREGISTER_HWIF(a) a
850#else
851#define USAGE_UNREGISTER_HWIF(a)
852#endif
853
854#ifdef CONFIG_FEATURE_HDPARM_HDIO_DRIVE_RESET
855#define USAGE_DRIVE_RESET(a) a
856#else
857#define USAGE_DRIVE_RESET(a)
858#endif
859
860#ifdef CONFIG_FEATURE_HDPARM_HDIO_TRISTATE_HWIF
861#define USAGE_TRISTATE_HWIF(a) a
862#else
863#define USAGE_TRISTATE_HWIF(a)
864#endif
865
Eric Andersen0a57a792003-08-06 08:57:35 +0000866#ifdef CONFIG_FEATURE_HDPARM_HDIO_GETSET_DMA
867#define USAGE_GETSET_DMA(a) a
868#else
869#define USAGE_GETSET_DMA(a)
870#endif
871
Eric Andersen3443bd72003-07-22 07:30:36 +0000872#define hdparm_trivial_usage \
873 "[options] [device] .."
874#define hdparm_full_usage \
875 "Options:" \
876 " -a get/set fs readahead\n" \
877 " -A set drive read-lookahead flag (0/1)\n" \
878 " -b get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
879 " -B set Advanced Power Management setting (1-255)\n" \
880 " -c get/set IDE 32-bit IO setting\n" \
881 " -C check IDE power mode status\n" \
Eric Andersen0a57a792003-08-06 08:57:35 +0000882 USAGE_GETSET_DMA(" -d get/set using_dma flag\n") \
Eric Andersen3443bd72003-07-22 07:30:36 +0000883 " -D enable/disable drive defect-mgmt\n" \
884 " -f flush buffer cache for device on exit\n" \
885 " -g display drive geometry\n" \
886 " -h display terse usage information\n" \
887 " -i display drive identification\n" \
888 USAGE_HDPARM_IDENT(" -I detailed/current information directly from drive\n") \
889 USAGE_HDPARM_IDENT(" -Istdin similar to -I, but wants /proc/ide/" "*" "/hd?/identify as input\n") \
890 " -k get/set keep_settings_over_reset flag (0/1)\n" \
891 " -K set drive keep_features_over_reset flag (0/1)\n" \
892 " -L set drive doorlock (0/1) (removable harddisks only)\n" \
893 " -m get/set multiple sector count\n" \
894 " -n get/set ignore-write-errors flag (0/1)\n" \
895 " -p set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
896 " -P set drive prefetch count\n" \
897 " -q change next setting quietly\n" \
898 " -Q get/set DMA tagged-queuing depth (if supported)\n" \
899 " -r get/set readonly flag (DANGEROUS to set)\n" \
900 USAGE_SCAN_HWIF(" -R register an IDE interface (DANGEROUS)\n") \
901 " -S set standby (spindown) timeout\n" \
902 " -t perform device read timings\n" \
903 " -T perform cache read timings\n" \
904 " -u get/set unmaskirq flag (0/1)\n" \
905 USAGE_UNREGISTER_HWIF(" -U un-register an IDE interface (DANGEROUS)\n") \
906 " -v defaults; same as -mcudkrag for IDE drives\n" \
907 " -V display program version and exit immediately\n" \
908 USAGE_DRIVE_RESET(" -w perform device reset (DANGEROUS)\n") \
909 " -W set drive write-caching flag (0/1) (DANGEROUS)\n" \
910 USAGE_TRISTATE_HWIF(" -x tristate device for hotswap (0/1) (DANGEROUS)\n") \
911 " -X set IDE xfer mode (DANGEROUS)\n" \
912 " -y put IDE drive in standby mode\n" \
913 " -Y put IDE drive to sleep\n" \
914 " -Z disable Seagate auto-powersaving mode\n" \
915 " -z re-read partition table\n"
916
Manuel Novoa III cad53642003-03-19 09:13:01 +0000917#ifdef CONFIG_FEATURE_FANCY_HEAD
918#define USAGE_FANCY_HEAD(a) a
919#else
920#define USAGE_FANCY_HEAD(a)
921#endif
922
Eric Andersen7e9276b2001-02-22 01:15:47 +0000923#define head_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000924 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000925#define head_full_usage \
926 "Print first 10 lines of each FILE to standard output.\n" \
927 "With more than one FILE, precede each with a header giving the\n" \
928 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000929 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000930 "\t-n NUM\t\tPrint first NUM lines instead of first 10" \
931 USAGE_FANCY_HEAD( \
932 "\n\t-c NUM\t\toutput the first NUM bytes\n" \
933 "\t-q\t\tnever output headers giving file names\n" \
934 "\t-v\t\talways output headers giving file names" )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000935#define head_example_usage \
936 "$ head -n 2 /etc/passwd\n" \
937 "root:x:0:0:root:/root:/bin/bash\n" \
938 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000939
Glenn L McGrath60281112001-11-02 11:39:46 +0000940#define hexdump_trivial_usage \
941 "[-[bcdefnosvx]] [OPTION] FILE"
942#define hexdump_full_usage \
943 "The hexdump utility is a filter which displays the specified files,\n" \
944 "or the standard input, if no files are specified, in a user specified\n"\
945 "format\n" \
946 "\t-b\t\tOne-byte octal display\n" \
947 "\t-c\t\tOne-byte character display\n" \
948 "\t-d\t\tTwo-byte decimal display\n" \
949 "\t-e FORMAT STRING\n" \
950 "\t-f FORMAT FILE\n" \
951 "\t-n LENGTH\tInterpret only length bytes of input\n" \
952 "\t-o\t\tTwo-byte octal display\n" \
953 "\t-s OFFSET\tSkip offset byte\n" \
954 "\t-v\t\tdisplay all input data\n" \
955 "\t-x\t\tTwo-byte hexadecimal display\n"
956
Eric Andersen7e9276b2001-02-22 01:15:47 +0000957#define hostid_trivial_usage \
958 ""
959#define hostid_full_usage \
960 "Print out a unique 32-bit identifier for the machine."
961
962#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000963 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000964#define hostname_full_usage \
965 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000966 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000967 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +0000968 "\t-s\tShort\n" \
969 "\t-i\tAddresses for the hostname\n" \
970 "\t-d\tDNS domain name\n" \
971 "\t-f\tFully qualified domain name\n" \
972 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000973#define hostname_example_usage \
974 "$ hostname\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000975 "sage \n"
Eric Andersen40520512003-07-28 09:59:05 +0000976
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000977#ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH
978 #define USAGE_HTTPD_BASIC_AUTH(a) a
Eric Andersen40520512003-07-28 09:59:05 +0000979 #ifdef CONFIG_FEATURE_HTTPD_AUTH_MD5
980 #define USAGE_HTTPD_AUTH_MD5(a) a
981 #else
982 #define USAGE_HTTPD_AUTH_MD5(a)
983 #endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000984#else
985 #define USAGE_HTTPD_BASIC_AUTH(a)
Eric Andersen40520512003-07-28 09:59:05 +0000986 #define USAGE_HTTPD_AUTH_MD5(a)
987#endif
988#ifdef CONFIG_FEATURE_HTTPD_USAGE_FROM_INETD_ONLY
989 #define USAGE_HTTPD_STANDALONE(a)
990 #define USAGE_HTTPD_SETUID(a)
991#else
992 #define USAGE_HTTPD_STANDALONE(a) a
993 #ifdef CONFIG_FEATURE_HTTPD_SETUID
994 #define USAGE_HTTPD_SETUID(a) a
995 #else
996 #define USAGE_HTTPD_SETUID(a)
997 #endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000998#endif
999#define httpd_trivial_usage \
Eric Andersen40520512003-07-28 09:59:05 +00001000 "[-c <conf file>]" \
1001 USAGE_HTTPD_STANDALONE(" [-p <port>]") \
1002 USAGE_HTTPD_SETUID(" [-u user]") \
1003 USAGE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
1004 USAGE_HTTPD_AUTH_MD5(" [-m pass]") \
1005 " [-d/-e <string>]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001006#define httpd_full_usage \
1007 "Listens for incoming http server requests.\n"\
1008 "Options:\n" \
Eric Andersen40520512003-07-28 09:59:05 +00001009 "\t-c FILE\tSpecifies configuration file. (default httpd.conf)\n" \
1010 USAGE_HTTPD_STANDALONE("\t-p PORT\tServer port (default 80)\n") \
1011 USAGE_HTTPD_SETUID("\t-u USER\tSet uid to USER after listening privilegies port\n") \
1012 USAGE_HTTPD_BASIC_AUTH("\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
1013 USAGE_HTTPD_AUTH_MD5("\t-m PASS\tCrypt PASS with md5 algorithm\n") \
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001014 "\t-e STRING\tHtml encode STRING\n" \
Eric Andersen40520512003-07-28 09:59:05 +00001015 "\t-d STRING\tURL decode STRING"
1016
Robert Griebl1cd04452002-07-21 16:50:49 +00001017#define hwclock_trivial_usage \
1018 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
1019#define hwclock_full_usage \
1020 "Query and set the hardware clock (RTC)\n\n" \
1021 "Options:\n" \
1022 "\t-r\tread hardware clock and print result\n" \
1023 "\t-s\tset the system time from the hardware clock\n" \
1024 "\t-w\tset the hardware clock to the current system time\n" \
1025 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
1026 "\t-l\tthe hardware clock is kept in local time"
1027
Eric Andersen9e480452003-07-03 10:07:04 +00001028#ifdef CONFIG_SELINUX
1029#define USAGE_SELINUX(a, b) a
1030#else
1031#define USAGE_SELINUX(a, b) b
1032#endif
1033
Eric Andersen7e9276b2001-02-22 01:15:47 +00001034#define id_trivial_usage \
1035 "[OPTIONS]... [USERNAME]"
1036#define id_full_usage \
1037 "Print information for USERNAME or the current user\n\n" \
1038 "Options:\n" \
1039 "\t-g\tprints only the group ID\n" \
1040 "\t-u\tprints only the user ID\n" \
Eric Andersen9e480452003-07-03 10:07:04 +00001041 USAGE_SELINUX("\t-c\tprints only the security context\n", "") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001042 "\t-n\tprint a name instead of a number (with for -ug)\n" \
1043 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001044#define id_example_usage \
1045 "$ id\n" \
1046 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001047
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001048#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001049 #define USAGE_SIOCSKEEPALIVE(a) a
1050#else
1051 #define USAGE_SIOCSKEEPALIVE(a)
1052#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001053#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001054 #define USAGE_IFCONFIG_MII(a) a
1055#else
1056 #define USAGE_IFCONFIG_MII(a)
1057#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001058#ifdef CONFIG_FEATURE_IFCONFIG_HW
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001059 #define USAGE_IFCONFIG_HW(a) a
1060#else
1061 #define USAGE_IFCONFIG_HW(a)
1062#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001063#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001064 #define USAGE_IFCONFIG_OPT_A(a) a
1065#else
1066 #define USAGE_IFCONFIG_OPT_A(a)
1067#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +00001068#ifdef CONFIG_FEATURE_IPV6
1069 #define USAGE_IPV6(a) a
1070#else
1071 #define USAGE_IPV6(a)
1072#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001073
Eric Andersen7e9276b2001-02-22 01:15:47 +00001074#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001075 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001076#define ifconfig_full_usage \
1077 "configure a network interface\n\n" \
1078 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +00001079 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
1080 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001081 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001082 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001083 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001084 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
1085 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001086 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001087 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
1088 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001089 "\t[up|down] ..."
1090
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001091#define ifup_trivial_usage \
1092 "<-ahinv> <ifaces...>"
1093#define ifup_full_usage \
1094 "Usage: ifup <options> <ifaces...>\n\n" \
1095 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001096 "\t-h\tthis help\n" \
1097 "\t-a\tde/configure all interfaces automatically\n" \
1098 "\t-i FILE\tuse FILE for interface definitions\n" \
1099 "\t-n\tprint out what would happen, but don't do it\n" \
1100 "\t\t\t(note that this option doesn't disable mappings)\n" \
1101 "\t-v\tprint out what would happen before doing it\n" \
1102 "\t-m\tdon't run any mappings\n" \
1103 "\t-f\tforce de/configuration\n"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001104
1105#define ifdown_trivial_usage \
1106 "<-ahinv> <ifaces...>"
1107#define ifdown_full_usage \
1108 "Usage: ifdown <options> <ifaces...>\n\n" \
1109 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001110 "\t-h\tthis help\n" \
1111 "\t-a\tde/configure all interfaces automatically\n" \
1112 "\t-i FILE\tuse FILE for interface definitions\n" \
1113 "\t-n\tprint out what would happen, but don't do it\n" \
1114 "\t\t(note that this option doesn't disable mappings)\n" \
1115 "\t-v\tprint out what would happen before doing it\n" \
1116 "\t-m\tdon't run any mappings\n" \
1117 "\t-f\tforce de/configuration\n"
Tim Riker7b253f82003-12-28 05:02:40 +00001118
Glenn L McGrath06e95652003-02-09 06:51:14 +00001119#define inetd_trivial_usage \
1120 "[-q len] [conf]"
1121#define inetd_full_usage \
1122 "Usage: [-q len] [conf]\n\n" \
1123 "Option:\n" \
1124 "\t-q\tSets the size of the socket listen queue to\n" \
1125 "the specified value. Default is 128."
1126
Eric Andersen7e9276b2001-02-22 01:15:47 +00001127#define init_trivial_usage \
1128 ""
1129#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001130 "Init is the parent of all processes."
1131#define init_notes_usage \
1132"This version of init is designed to be run only by the kernel.\n" \
1133"\n" \
1134"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
1135"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
1136"runlevels, use sysvinit.\n" \
1137"\n" \
1138"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
1139"it has the following default behavior:\n" \
1140"\n" \
1141" ::sysinit:/etc/init.d/rcS\n" \
1142" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001143" ::ctrlaltdel:/sbin/reboot\n" \
1144" ::shutdown:/sbin/swapoff -a\n" \
1145" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001146" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001147"\n" \
1148"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1149"\n" \
1150" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001151" tty3::askfirst:/bin/sh\n" \
1152" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001153"\n" \
1154"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1155"\n" \
1156" <id>:<runlevels>:<action>:<process>\n" \
1157"\n" \
1158" <id>: \n" \
1159"\n" \
1160" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1161" The id field is used by BusyBox init to specify the controlling tty for\n" \
1162" the specified process to run on. The contents of this field are\n" \
1163" appended to "/dev/" and used as-is. There is no need for this field to\n" \
1164" be unique, although if it isn't you may have strange results. If this\n" \
1165" field is left blank, the controlling tty is set to the console. Also\n" \
1166" note that if BusyBox detects that a serial console is in use, then only\n" \
1167" entries whose controlling tty is either the serial console or /dev/null\n" \
1168" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1169" stinkin' utmp.\n" \
1170"\n" \
1171" <runlevels>: \n" \
1172"\n" \
1173" The runlevels field is completely ignored.\n" \
1174"\n" \
1175" <action>: \n" \
1176"\n" \
1177" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001178" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001179"\n" \
1180" The available actions can be classified into two groups: actions\n" \
1181" that are run only once, and actions that are re-run when the specified\n" \
1182" process exits.\n" \
1183"\n" \
1184" Run only-once actions:\n" \
1185"\n" \
1186" 'sysinit' is the first item run on boot. init waits until all\n" \
1187" sysinit actions are completed before continuing. Following the\n" \
1188" completion of all sysinit actions, all 'wait' actions are run.\n" \
1189" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001190" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001191" therefore, init does not wait for them to complete. 'restart' is\n" \
1192" the action taken to restart the init process. By default this should\n" \
1193" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1194" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001195" actions are run when the system detects that someone on the system\n" \
1196" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1197" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1198" Finally the 'shutdown' action specifies the actions to taken when\n" \
1199" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1200" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001201"\n" \
1202" Run repeatedly actions:\n" \
1203"\n" \
1204" 'respawn' actions are run after the 'once' actions. When a process\n" \
1205" started with a 'respawn' action exits, init automatically restarts\n" \
1206" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1207" respawning out of control. The 'askfirst' actions acts just like\n" \
1208" respawn, except that before running the specified process it\n" \
1209" displays the line "Please press Enter to activate this console."\n" \
1210" and then waits for the user to press enter before starting the\n" \
1211" specified process. \n" \
1212"\n" \
1213" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1214" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001215" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001216"\n" \
1217" <process>: \n" \
1218"\n" \
1219" Specifies the process to be executed and it's command line.\n" \
1220"\n" \
1221"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001222"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001223" # This is run first except when booting in single-user mode.\n" \
1224" #\n" \
1225" ::sysinit:/etc/init.d/rcS\n" \
1226" \n" \
1227" # /bin/sh invocations on selected ttys\n" \
1228" #\n" \
1229" # Start an "askfirst" shell on the console (whatever that may be)\n" \
1230" ::askfirst:-/bin/sh\n" \
1231" # Start an "askfirst" shell on /dev/tty2-4\n" \
1232" tty2::askfirst:-/bin/sh\n" \
1233" tty3::askfirst:-/bin/sh\n" \
1234" tty4::askfirst:-/bin/sh\n" \
1235" \n" \
1236" # /sbin/getty invocations for selected ttys\n" \
1237" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001238" tty4::respawn:/sbin/getty 38400 tty4\n" \
1239" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001240" \n" \
1241" \n" \
1242" # Example of how to put a getty on a serial line (for a terminal)\n" \
1243" #\n" \
1244" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1245" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1246" #\n" \
1247" # Example how to put a getty on a modem line.\n" \
1248" #::respawn:/sbin/getty 57600 ttyS2\n" \
1249" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001250" # Stuff to do when restarting the init process\n" \
1251" ::restart:/sbin/init\n" \
1252" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001253" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001254" ::ctrlaltdel:/sbin/reboot\n" \
1255" ::shutdown:/bin/umount -a -r\n" \
1256" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001257
Eric Andersenbe65c352003-01-23 04:57:35 +00001258#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
1259 #define USAGE_INSMOD_MAP(a) a
1260#else
1261 #define USAGE_INSMOD_MAP(a)
1262#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001263#define insmod_trivial_usage \
1264 "[OPTION]... MODULE [symbol=value]..."
1265#define insmod_full_usage \
1266 "Loads the specified kernel modules into the kernel.\n\n" \
1267 "Options:\n" \
1268 "\t-f\tForce module to load into the wrong kernel version.\n" \
1269 "\t-k\tMake module autoclean-able.\n" \
1270 "\t-v\tverbose output\n" \
1271 "\t-L\tLock to prevent simultaneous loads of a module\n" \
Eric Andersenbe65c352003-01-23 04:57:35 +00001272 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout") \
1273 "\t-x\tdo not export externs\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001274
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001275#define install_trivial_usage \
1276 "[cgmops] [sources] <dest|directory>"
1277#define install_full_usage \
1278 "copy files and set attributes\n\n" \
1279 "Options:\n" \
1280 "\t-c\tcopy the file, default\n" \
1281 "\t-g\tset group ownership\n" \
1282 "\t-m\tset permission modes\n" \
1283 "\t-o\tset ownership\n" \
1284 "\t-p\tpreserve date\n" \
1285 "\t-s\tstrip symbol tables\n"
1286
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001287#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001288 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001289#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001290 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1291 "where OBJECT := { link | addr | route | tunnel }\n" \
1292 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }\n"
1293
1294#define ipaddr_trivial_usage \
1295 "{ {add|del} IFADDR dev STRING | {show|flush} [ dev STRING ] [ to PREFIX ] }"
1296#define ipaddr_full_usage \
1297 "ipaddr {add|del} IFADDR dev STRING\n" \
1298 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
1299 " [ to PREFIX ] [ label PATTERN ]\n" \
1300 "IFADDR := PREFIX | ADDR peer PREFIX\n" \
1301 " [ broadcast ADDR ] [ anycast ADDR ]\n" \
1302 " [ label STRING ] [ scope SCOPE-ID ]\n" \
1303 "SCOPE-ID := [ host | link | global | NUMBER ]\n"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001304
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001305#ifndef CONFIG_FEATURE_IPCALC_FANCY
Eric Andersende4f07e2003-12-11 01:18:07 +00001306#define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001307 "[--broadcast] [--netmask] [--network] ipaddr <netmask>"
1308
Eric Andersende4f07e2003-12-11 01:18:07 +00001309#define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001310 "Calculate IP network settings from a IP address\n\n" \
1311 "Options:\n" \
1312 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1313 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001314 "\t-w\t--network\tDisplay calculated network address."
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001315#else
Eric Andersende4f07e2003-12-11 01:18:07 +00001316#define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001317 "[OPTION]... ipaddr <netmask>"
1318
Eric Andersende4f07e2003-12-11 01:18:07 +00001319#define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001320 "Calculate IP network settings from a IP address\n\n" \
1321 "Options:\n" \
1322 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1323 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
1324 "\t-w\t--network\tDisplay calculated network address.\n" \
1325 "\t-h\t--hostname\tDisplay first resolved host name.\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001326 "\t-s\t--silent\tDon't ever display error messages."
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001327#endif
1328
1329#define ipcalc_notes_usage \
1330 "ipcalc provides a simple way to calculate IP information for\n" \
1331 "a host. The various options specify what information ipcalc\n" \
1332 "should display on standard out. Multiple options may be\n" \
1333 "specified.\n"
1334
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001335#define iplink_trivial_usage \
1336 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1337#define iplink_full_usage \
1338 "iplink set DEVICE { up | down | arp { on | off } |\n" \
1339 " dynamic { on | off } |\n" \
1340 " mtu MTU }\n" \
1341 "iplink show [ DEVICE ]\n"
1342
1343#define iproute_trivial_usage \
1344 "{ list | flush | { add | del | change | append | replace | monitor } ROUTE }"
1345#define iproute_full_usage \
1346 "iproute { list | flush } SELECTOR\n" \
1347 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
1348 " [ oif STRING ] [ tos TOS ]\n" \
1349 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
1350 "SELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1351 "ROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]\n"
1352
1353#define iptunnel_trivial_usage \
1354 "{ add | change | del | show } [ NAME ] [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
1355#define iptunnel_full_usage \
1356 "iptunnel { add | change | del | show } [ NAME ]\n" \
1357 " [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1358 " [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1359 " [ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]\n"
1360
Eric Andersen92fb9392003-08-08 20:09:03 +00001361#define insmod_ng_trivial_usage \
1362 "MODULE [symbol=value]..."
1363#define insmod_ng_full_usage \
1364 "Loads the specified kernel modules into the kernel."
1365
Eric Andersen7e9276b2001-02-22 01:15:47 +00001366#define kill_trivial_usage \
1367 "[-signal] process-id [process-id ...]"
1368#define kill_full_usage \
1369 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +00001370 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001371 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001372#define kill_example_usage \
1373 "$ ps | grep apache\n" \
1374 "252 root root S [apache]\n" \
1375 "263 www-data www-data S [apache]\n" \
1376 "264 www-data www-data S [apache]\n" \
1377 "265 www-data www-data S [apache]\n" \
1378 "266 www-data www-data S [apache]\n" \
1379 "267 www-data www-data S [apache]\n" \
1380 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001381
1382#define killall_trivial_usage \
1383 "[-signal] process-name [process-name ...]"
1384#define killall_full_usage \
1385 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001386 "Options:\n" \
1387 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001388#define killall_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001389 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001390
Mark Whitley6317c4b2001-03-12 22:51:50 +00001391#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001392 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001393#define klogd_full_usage \
1394 "Kernel logger.\n"\
1395 "Options:\n"\
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001396 "\t-c n\tSets the default log level of console messages to n.\n"\
Mark Whitley6317c4b2001-03-12 22:51:50 +00001397 "\t-n\tRun as a foreground process."
1398
Eric Andersen7e9276b2001-02-22 01:15:47 +00001399#define length_trivial_usage \
1400 "STRING"
1401#define length_full_usage \
1402 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001403#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001404 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001405 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001406
1407#define ln_trivial_usage \
1408 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1409#define ln_full_usage \
1410 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
1411 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1412 "Options:\n" \
1413 "\t-s\tmake symbolic links instead of hard links\n" \
1414 "\t-f\tremove existing destination files\n" \
1415 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001416#define ln_example_usage \
1417 "$ ln -s BusyBox /tmp/ls\n" \
1418 "$ ls -l /tmp/ls\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001419 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001420
Eric Andersen7e9276b2001-02-22 01:15:47 +00001421#define loadfont_trivial_usage \
1422 "< font"
1423#define loadfont_full_usage \
1424 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001425#define loadfont_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001426 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001427
1428#define loadkmap_trivial_usage \
1429 "< keymap"
1430#define loadkmap_full_usage \
1431 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001432#define loadkmap_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001433 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001434
1435#define logger_trivial_usage \
1436 "[OPTION]... [MESSAGE]"
1437#define logger_full_usage \
1438 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1439 "Options:\n" \
1440 "\t-s\tLog to stderr as well as the system log.\n" \
1441 "\t-t\tLog using the specified tag (defaults to user name).\n" \
1442 "\t-p\tEnter the message with the specified priority.\n" \
1443 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001444#define logger_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001445 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001446
Robert Griebl1fca5582002-06-04 20:45:46 +00001447#define login_trivial_usage \
1448 "[OPTION]... [username] [ENV=VAR ...]"
1449#define login_full_usage \
1450 "Begin a new session on the system\n\n" \
1451 "Options:\n" \
1452 "\t-f\tDo not authenticate (user already authenticated)\n" \
1453 "\t-h\tName of the remote host for this login.\n" \
1454 "\t-p\tPreserve environment."
1455
Eric Andersen7e9276b2001-02-22 01:15:47 +00001456#define logname_trivial_usage \
1457 ""
1458#define logname_full_usage \
1459 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001460#define logname_example_usage \
1461 "$ logname\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001462 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001463
Mark Whitley6317c4b2001-03-12 22:51:50 +00001464#define logread_trivial_usage \
Eric Andersend4a5e252003-12-19 11:32:14 +00001465 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001466
1467#define logread_full_usage \
Eric Andersend4a5e252003-12-19 11:32:14 +00001468 "Shows the messages from syslogd (using circular buffer).\n\n"
1469 "Options:\n" \
1470 "\t-f\t\toutput data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001471
Matt Kraai83788da2002-03-20 17:38:37 +00001472#define losetup_trivial_usage \
1473 "[OPTION]... LOOPDEVICE FILE\n" \
1474 "or: losetup [OPTION]... -d LOOPDEVICE"
1475#define losetup_full_usage \
1476 "Associate LOOPDEVICE with FILE.\n\n" \
1477 "Options:\n" \
1478 "\t-d\t\tDisassociate LOOPDEVICE.\n" \
1479 "\t-o OFFSET\tStart OFFSET bytes into FILE.\n"
1480
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001481#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001482 #define USAGE_LS_TIMESTAMPS(a) a
1483#else
1484 #define USAGE_LS_TIMESTAMPS(a)
1485#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001486#ifdef CONFIG_FEATURE_LS_FILETYPES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001487 #define USAGE_LS_FILETYPES(a) a
1488#else
1489 #define USAGE_LS_FILETYPES(a)
1490#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001491#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001492 #define USAGE_LS_FOLLOWLINKS(a) a
1493#else
1494 #define USAGE_LS_FOLLOWLINKS(a)
1495#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001496#ifdef CONFIG_FEATURE_LS_RECURSIVE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001497 #define USAGE_LS_RECURSIVE(a) a
1498#else
1499 #define USAGE_LS_RECURSIVE(a)
1500#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001501#ifdef CONFIG_FEATURE_LS_SORTFILES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001502 #define USAGE_LS_SORTFILES(a) a
1503#else
1504 #define USAGE_LS_SORTFILES(a)
1505#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001506#ifdef CONFIG_FEATURE_AUTOWIDTH
Eric Andersen7e9276b2001-02-22 01:15:47 +00001507 #define USAGE_AUTOWIDTH(a) a
1508#else
1509 #define USAGE_AUTOWIDTH(a)
1510#endif
1511#define ls_trivial_usage \
Eric Andersen9e480452003-07-03 10:07:04 +00001512 "[-1Aa" USAGE_LS_TIMESTAMPS("c") "Cd" USAGE_LS_TIMESTAMPS("e") USAGE_LS_FILETYPES("F") "iln" USAGE_LS_FILETYPES("p") USAGE_LS_FOLLOWLINKS("L") USAGE_LS_RECURSIVE("R") USAGE_LS_SORTFILES("rS") "s" USAGE_AUTOWIDTH("T") USAGE_LS_TIMESTAMPS("tu") USAGE_LS_SORTFILES("v") USAGE_AUTOWIDTH("w") "x" USAGE_LS_SORTFILES("X") USAGE_HUMAN_READABLE("h") USAGE_NOT_HUMAN_READABLE("") "k" USAGE_SELINUX("K", "") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001513#define ls_full_usage \
1514 "List directory contents\n\n" \
1515 "Options:\n" \
1516 "\t-1\tlist files in a single column\n" \
1517 "\t-A\tdo not list implied . and ..\n" \
1518 "\t-a\tdo not hide entries starting with .\n" \
1519 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001520 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001521 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001522 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1523 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001524 "\t-i\tlist the i-node for each file\n" \
1525 "\t-l\tuse a long listing format\n" \
1526 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001527 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1528 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1529 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1530 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1531 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001532 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001533 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1534 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1535 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1536 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1537 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001538 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001539 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1540 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001541 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersenbccb3152003-07-03 10:19:20 +00001542 USAGE_SELINUX("\t-k\tprint security context\n\t-K\tprint security context in long format\n", ""))
Eric Andersen7e9276b2001-02-22 01:15:47 +00001543
1544#define lsmod_trivial_usage \
1545 ""
1546#define lsmod_full_usage \
1547 "List the currently loaded kernel modules."
1548
1549#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001550 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001551#define makedevs_full_usage \
1552 "Creates a range of block or character special files\n\n" \
1553 "TYPEs include:\n" \
1554 "\tb:\tMake a block (buffered) device.\n" \
1555 "\tc or u:\tMake a character (un-buffered) device.\n" \
1556 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1557 "FIRST specifies the number appended to NAME to create the first device.\n" \
1558 "LAST specifies the number of the last item that should be created.\n" \
1559 "If 's' is the last argument, the base device is created as well.\n\n" \
1560 "For example:\n" \
1561 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001562 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001563#define makedevs_example_usage \
1564 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
1565 "[creates ttyS2-ttyS63]\n" \
1566 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001567 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001568
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001569#ifdef CONFIG_FEATURE_MD5_SHA1_SUM_CHECK
1570#define USAGE_MD5_SHA1_SUM_CHECK(a) a
1571#else
1572#define USAGE_MD5_SHA1_SUM_CHECK(a)
1573#endif
1574
Eric Andersen7e9276b2001-02-22 01:15:47 +00001575#define md5sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001576 "[OPTION] [FILEs...]" \
1577 USAGE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001578#define md5sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001579 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001580 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001581 "With no FILE, or when FILE is -, read standard input." \
1582 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
1583 "\t-c\tcheck MD5 sums against given list\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001584 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001585 "\t-s\tdon't output anything, status code shows success\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001586 "\t-w\twarn about improperly formated MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001587#define md5sum_example_usage \
1588 "$ md5sum < busybox\n" \
1589 "6fd11e98b98a58f64ff3398d7b324003\n" \
1590 "$ md5sum busybox\n" \
1591 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1592 "$ md5sum -c -\n" \
1593 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1594 "busybox: OK\n" \
1595 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001596
Glenn L McGrath061c9002002-09-16 04:21:46 +00001597#define mesg_trivial_usage \
1598 "mesg [y|n]"
1599#define mesg_full_usage \
1600 "mesg [Y|N], controls write access to your terminal\n" \
1601 "\ty\tAllow write access to your terminal.\n" \
1602 "\tn\tDisallow write access to your terminal.\n"
1603
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001604#define minit_trivial_usage \
1605 "[-spPrRC]"
1606#define minit_full_usage \
1607 "[-spPrRC]"
1608
Eric Andersen7e9276b2001-02-22 01:15:47 +00001609#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001610 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001611#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001612 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001613 "Options:\n" \
1614 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001615 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001616#define mkdir_example_usage \
1617 "$ mkdir /tmp/foo\n" \
1618 "$ mkdir /tmp/foo\n" \
1619 "/tmp/foo: File exists\n" \
1620 "$ mkdir /tmp/foo/bar/baz\n" \
1621 "/tmp/foo/bar/baz: No such file or directory\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001622 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001623
Eric Andersen7e9276b2001-02-22 01:15:47 +00001624#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001625 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001626#define mkfifo_full_usage \
1627 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1628 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001629 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001630
Eric Andersen7e9276b2001-02-22 01:15:47 +00001631#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001632 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001633#define mkfs_minix_full_usage \
1634 "Make a MINIX filesystem.\n\n" \
1635 "Options:\n" \
1636 "\t-c\t\tCheck the device for bad blocks\n" \
1637 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1638 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1639 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001640 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001641
Eric Andersen7e9276b2001-02-22 01:15:47 +00001642#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001643 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001644#define mknod_full_usage \
1645 "Create a special file (block, character, or pipe).\n\n" \
1646 "Options:\n" \
1647 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1648 "TYPEs include:\n" \
1649 "\tb:\tMake a block (buffered) device.\n" \
1650 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001651 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001652#define mknod_example_usage \
1653 "$ mknod /dev/fd0 b 2 0 \n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001654 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001655
Eric Andersen7e9276b2001-02-22 01:15:47 +00001656#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001657 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001658#define mkswap_full_usage \
1659 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001660 "Options:\n" \
1661 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001662 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001663 "\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 +00001664 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001665
Eric Andersen7e9276b2001-02-22 01:15:47 +00001666#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001667 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001668#define mktemp_full_usage \
1669 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001670 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001671#define mktemp_example_usage \
1672 "$ mktemp /tmp/temp.XXXXXX\n" \
1673 "/tmp/temp.mWiLjM\n" \
1674 "$ ls -la /tmp/temp.mWiLjM\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001675 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001676
Eric Andersen8d79ce82001-07-22 23:00:15 +00001677#define modprobe_trivial_usage \
1678 "[FILE ...]"
1679#define modprobe_full_usage \
Eric Andersenabc95682002-07-03 02:52:35 +00001680 "Used for high level module loading and unloading."
Eric Andersen8d79ce82001-07-22 23:00:15 +00001681#define modprobe_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001682 "$ modprobe cdrom\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00001683
Eric Andersen7e9276b2001-02-22 01:15:47 +00001684#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001685 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001686#define more_full_usage \
1687 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001688#define more_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001689 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001690
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001691#ifdef CONFIG_FEATURE_MOUNT_LOOP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001692 #define USAGE_MOUNT_LOOP(a) a
1693#else
1694 #define USAGE_MOUNT_LOOP(a)
1695#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001696#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001697 #define USAGE_MTAB(a) a
1698#else
1699 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001700#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001701#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001702 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001703#define mount_full_usage \
1704 "Mount a filesystem\n\n" \
1705 "Flags:\n" \
1706 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001707 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001708 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001709 "\t-n:\t\tDon't write a mount table entry.\n" \
1710 ) \
1711 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1712 "\t-r:\t\tMount the filesystem read-only.\n" \
1713 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1714 "\t-w:\t\tMount for reading and writing (default).\n" \
1715 "\n" \
1716 "Options for use with the \"-o\" flag:\n" \
1717 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1718 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1719 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1720 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001721 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001722 "\tloop:\t\tMounts a file via loop device.\n" \
1723 ) \
1724 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001725 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001726 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001727 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001728 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001729 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001730#define mount_example_usage \
1731 "$ mount\n" \
1732 "/dev/hda3 on / type minix (rw)\n" \
1733 "proc on /proc type proc (rw)\n" \
1734 "devpts on /dev/pts type devpts (rw)\n" \
1735 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001736 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001737
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001738#define msvc_trivial_usage \
1739 "-[udorspchaitkx] service"
Eric Andersen335816b2003-07-14 22:14:49 +00001740#define msvc_full_usage \
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001741 "[option] service\n" \
1742 "Where option is one of\n" \
1743 "\t-u\tUp. If the service is not running, start it. If the service stops, restart it.\n" \
1744 "\t-d\tDown. If the service is running, stop it, do not restart it.\n" \
1745 "\t-o\tOnce. If the service is not running, start it. Do not restart it if it stops.\n" \
1746 "\t-r\tTell supervise that the service is normally running; this affects status messages.\n" \
1747 "\t-s\tTell supervise that the service is normally stopped; this affects status messages.\n" \
1748 "\t-p\tPause. Send the service a STOP signal.\n" \
1749 "\t-c\tContinue. Send the service a CONT signal.\n" \
1750 "\t-h\tHangup. Send the service a HUP signal.\n" \
1751 "\t-a\tAlarm. Send the service an ALRM signal.\n" \
1752 "\t-i\tInterrupt. Send the service an INT signal.\n" \
1753 "\t-t\tTerminate. Send the service a TERM signal.\n" \
1754 "\t-k\tKill. Send the service a KILL signal.\n" \
1755 "\t-x\tExit. supervise will quit as soon as the service is down.\n"
1756
Eric Andersen7e9276b2001-02-22 01:15:47 +00001757#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001758 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001759#define mt_full_usage \
1760 "Control magnetic tape drive operation\n" \
1761 "\nAvailable Opcodes:\n\n" \
1762 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1763 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
Eric Andersen92fb9392003-08-08 20:09:03 +00001764 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001765 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001766
Eric Andersen7e9276b2001-02-22 01:15:47 +00001767#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001768 "SOURCE DEST\n" \
1769 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001770#define mv_full_usage \
1771 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001772#define mv_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001773 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001774
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001775#define nameif_trivial_usage \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001776 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001777#define nameif_full_usage \
1778 "Nameif renaming network interface while it in the down state.\n\n" \
1779 "Options:\n" \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001780 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001781 "\t-s\t\tUse syslog (LOCAL0 facility).\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001782 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address\n"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001783#define nameif_example_usage \
1784 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
1785 " or\n" \
1786 "$ nameif -c /etc/my_mactab_file\n" \
1787
Eric Andersen7e9276b2001-02-22 01:15:47 +00001788#define nc_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001789 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001790#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001791 "Netcat opens a pipe to IP:port\n\n" \
1792 "Options:\n" \
1793 "\t-l\t\tlisten mode, for inbound connects\n" \
1794 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00001795 "\t-i SECS\t\tdelay interval for lines sent\n" \
Eric Andersen00a6a752002-04-26 23:53:10 +00001796 "\t-e PROG\t\tprogram to exec after connect (dangerous!)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001797#define nc_example_usage \
1798 "$ nc foobar.somedomain.com 25\n" \
1799 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1800 "help\n" \
1801 "214-Commands supported:\n" \
1802 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1803 "214 NOOP QUIT RSET HELP\n" \
1804 "quit\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001805 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001806
Eric Andersen1552ff72001-10-31 11:07:12 +00001807#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00001808 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00001809#define netstat_full_usage \
1810 "-l display listening server sockets\n" \
1811 "-a display all sockets (default: connected)\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001812 "-e display other/more information\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001813 "-n don't resolve names\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001814 "-r display routing table\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001815 "-t tcp sockets\n" \
1816 "-u udp sockets\n" \
1817 "-w raw sockets\n" \
1818 "-x unix sockets\n"
1819
Eric Andersen7e9276b2001-02-22 01:15:47 +00001820#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001821 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001822#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001823 "Queries the nameserver for the IP address of the given HOST\n" \
1824 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001825#define nslookup_example_usage \
1826 "$ nslookup localhost\n" \
1827 "Server: default\n" \
1828 "Address: default\n" \
1829 "\n" \
1830 "Name: debian\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001831 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001832
Glenn L McGrath60281112001-11-02 11:39:46 +00001833#define od_trivial_usage \
1834 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
1835#define od_full_usage \
1836 "Write an unambiguous representation, octal bytes by default, of FILE\n"\
1837 "to standard output. With no FILE, or when FILE is -, read standard input."
1838
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00001839#define openvt_trivial_usage \
1840 "<vtnum> <COMMAND> [ARGS...]"
1841#define openvt_full_usage \
1842 "Start a command on a new virtual terminal"
1843#define openvt_example_usage \
1844 "openvt 2 /bin/ash\n"
1845
Eric Andersen27f64e12002-06-23 04:24:25 +00001846#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
1847 #define PASSWORD_ALG_TYPES(a) a
Tim Riker7b253f82003-12-28 05:02:40 +00001848#else
Eric Andersen27f64e12002-06-23 04:24:25 +00001849 #define PASSWORD_ALG_TYPES(a)
1850#endif
1851#define passwd_trivial_usage \
1852 "[OPTION] [name]"
1853#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00001854 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00001855 "changes the password for the current user.\n" \
1856 "Options:\n" \
1857 "\t-a\tDefine which algorithm shall be used for the password.\n" \
1858 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001859 PASSWORD_ALG_TYPES(", sha1") \
Eric Andersen27f64e12002-06-23 04:24:25 +00001860 ")\n\t-d\tDelete the password for the specified user account.\n" \
1861 "\t-l\tLocks (disables) the specified user account.\n" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001862 "\t-u\tUnlocks (re-enables) the specified user account."
Eric Andersen27f64e12002-06-23 04:24:25 +00001863
Glenn L McGrath655d8142003-06-22 15:32:41 +00001864#define patch_trivial_usage \
1865 "[-p<num>]"
1866#define patch_full_usage \
1867 "[-p<num>]"
1868#define patch_example_usage \
1869 "$ patch -p1 <example.diff"
1870
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001871#define pidfilehack_trivial_usage \
1872 "[daemon.pid] [daemon]"
1873#define pidfilehack_full_usage \
1874 "service /var/run/daemon.pid /usr/sbin/daemon args...\n"
1875
Eric Andersen221b2ea2001-07-31 19:06:07 +00001876#define pidof_trivial_usage \
1877 "process-name [process-name ...]"
1878#define pidof_full_usage \
1879 "Lists the PIDs of all processes with names that match the names on the command line"
1880#define pidof_example_usage \
1881 "$ pidof init\n" \
1882 "1\n"
1883
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001884#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001885#define ping_trivial_usage "host"
1886#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1887#else
1888#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001889 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001890#define ping_full_usage \
1891 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1892 "Options:\n" \
1893 "\t-c COUNT\tSend only COUNT pings.\n" \
1894 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1895 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001896 "\t\t\tand when finished."
1897#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001898#define ping_example_usage \
1899 "$ ping localhost\n" \
1900 "PING slag (127.0.0.1): 56 data bytes\n" \
1901 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1902 "\n" \
1903 "--- debian ping statistics ---\n" \
1904 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001905 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001906
Eric Andersen51b8bd62002-07-03 11:46:38 +00001907#ifndef CONFIG_FEATURE_FANCY_PING6
1908#define ping6_trivial_usage "host"
1909#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1910#else
1911#define ping6_trivial_usage \
1912 "[OPTION]... host"
1913#define ping6_full_usage \
1914 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1915 "Options:\n" \
1916 "\t-c COUNT\tSend only COUNT pings.\n" \
1917 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1918 "\t-q\t\tQuiet mode, only displays output at start\n" \
1919 "\t\t\tand when finished."
1920#endif
1921#define ping6_example_usage \
1922 "$ ping6 ip6-localhost\n" \
1923 "PING ip6-localhost (::1): 56 data bytes\n" \
1924 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
1925 "\n" \
1926 "--- ip6-localhost ping statistics ---\n" \
1927 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001928 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00001929
Eric Andersen7e9276b2001-02-22 01:15:47 +00001930#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001931 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001932#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001933 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001934 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001935
Eric Andersen7e9276b2001-02-22 01:15:47 +00001936#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001937 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001938#define poweroff_full_usage \
1939 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001940
Eric Andersen7e9276b2001-02-22 01:15:47 +00001941#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001942 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001943#define printf_full_usage \
1944 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001945 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001946#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001947 "$ printf "Val=%d\\n" 5\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001948 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001949
Eric Andersen7e9276b2001-02-22 01:15:47 +00001950#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001951 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001952#define ps_full_usage \
1953 "Report process status\n" \
Eric Andersen9e480452003-07-03 10:07:04 +00001954 USAGE_SELINUX("\nOptions:\n\t-c\tshow SE Linux context", "\nThis version of ps accepts no options.")
Tim Riker7b253f82003-12-28 05:02:40 +00001955
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001956#define ps_example_usage \
1957 "$ ps\n" \
1958 " PID Uid Gid State Command\n" \
1959 " 1 root root S init\n" \
1960 " 2 root root S [kflushd]\n" \
1961 " 3 root root S [kupdate]\n" \
1962 " 4 root root S [kpiod]\n" \
1963 " 5 root root S [kswapd]\n" \
1964 " 742 andersen andersen S [bash]\n" \
1965 " 743 andersen andersen S -bash\n" \
1966 " 745 root root S [getty]\n" \
1967 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001968
Eric Andersen7e9276b2001-02-22 01:15:47 +00001969#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001970 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001971#define pwd_full_usage \
1972 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001973#define pwd_example_usage \
1974 "$ pwd\n" \
1975 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001976
Eric Andersen92fb9392003-08-08 20:09:03 +00001977#define raid_start_trivial_usage \
1978 "MD_DEVICE DISK_DEVICE"
1979#define raid_start_full_usage \
1980 "Start MD_DEVICE, taking superblock from DISK_DEVICE.\n" \
1981 "Example: raid_start /dev/md0 /dev/sdb"
Tim Riker7b253f82003-12-28 05:02:40 +00001982
Eric Andersen7e9276b2001-02-22 01:15:47 +00001983#define rdate_trivial_usage \
Eric Andersen725db192003-07-22 08:26:05 +00001984 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001985#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001986 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001987 "Options:\n" \
1988 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001989 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001990
Eric Andersen7e9276b2001-02-22 01:15:47 +00001991#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001992 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001993#define readlink_full_usage \
1994 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001995
Glenn L McGrath62fae302002-12-10 00:14:33 +00001996#define realpath_trivial_usage \
1997 "pathname ..."
1998#define realpath_full_usage \
1999 "return the canonicalized absolute pathnames of given arguments\n\n"
Tim Riker7b253f82003-12-28 05:02:40 +00002000
Eric Andersen7e9276b2001-02-22 01:15:47 +00002001#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002002 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002003#define reboot_full_usage \
2004 "Reboot the system."
2005
2006#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002007 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002008#define renice_full_usage \
2009 "Changes priority of running processes. Allowed priorities range\n" \
2010 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002011 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002012
Eric Andersen7e9276b2001-02-22 01:15:47 +00002013#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002014 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002015#define reset_full_usage \
2016 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002017
Eric Andersen7e9276b2001-02-22 01:15:47 +00002018#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002019 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002020#define rm_full_usage \
2021 "Remove (unlink) the FILE(s). You may use '--' to\n" \
2022 "indicate that all following arguments are non-options.\n\n" \
2023 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002024 "\t-i\t\talways prompt before removing each destination\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002025 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002026 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002027#define rm_example_usage \
2028 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002029
Eric Andersen7e9276b2001-02-22 01:15:47 +00002030#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002031 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002032#define rmdir_full_usage \
2033 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002034#define rmdir_example_usage \
2035 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002036
Eric Andersen7e9276b2001-02-22 01:15:47 +00002037#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002038 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002039#define rmmod_full_usage \
2040 "Unloads the specified kernel modules from the kernel.\n\n" \
2041 "Options:\n" \
Tim Rikercf932742002-12-14 01:58:59 +00002042 "\t-a\tRemove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002043#define rmmod_example_usage \
2044 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002045
Eric Andersen7e9276b2001-02-22 01:15:47 +00002046#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002047 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002048#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002049 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00002050 "Options:\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00002051 "\t-n\tDont resolve names.\n" \
2052 "\t-e\tDisplay other/more information"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002053
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002054#define rpm_trivial_usage \
2055 "-i -q[ildc]p package.rpm"
2056#define rpm_full_usage \
2057 "Manipulates RPM packages" \
Eric Andersendfce3532003-06-15 07:00:54 +00002058 "\n\nOptions:" \
2059 "\n\t-i Install package" \
2060 "\n\t-q Query package" \
2061 "\n\t-p Query uninstalled package" \
2062 "\n\t-i Show information" \
2063 "\n\t-l List contents" \
2064 "\n\t-d List documents" \
2065 "\n\t-c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002066
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002067#define rpm2cpio_trivial_usage \
2068 "package.rpm"
2069#define rpm2cpio_full_usage \
2070 "Outputs a cpio archive of the rpm file."
2071
Eric Andersen6cf47a72001-10-31 10:24:36 +00002072#define run_parts_trivial_usage \
2073 "[-t] [-a ARG] [-u MASK] DIRECTORY"
2074#define run_parts_full_usage \
2075 "Run a bunch of scripts in a directory.\n\n" \
2076 "Options:\n" \
2077 "\t-t\t\tTest only what file will be executed, without execute them.\n" \
2078 "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \
2079 "\t-u MASK\tSet the umask to MASK before executing every program."
2080
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002081#define rx_trivial_usage \
2082 "FILE"
2083#define rx_full_usage \
2084 "Receive a file using the xmodem protocol."
2085#define rx_example_usage \
2086 "$ rx /tmp/foo\n"
2087
Eric Andersen7e9276b2001-02-22 01:15:47 +00002088#define sed_trivial_usage \
Matt Kraai075228a2001-06-21 14:40:55 +00002089 "[-nef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002090#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002091 "Options:\n" \
2092 "\t-n\t\tsuppress automatic printing of pattern space\n" \
2093 "\t-e script\tadd the script to the commands to be executed\n" \
2094 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002095 "\n" \
2096 "If no -e or -f is given, the first non-option argument is taken as the\n" \
2097 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002098 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002099#define sed_example_usage \
2100 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
2101 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002102
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002103#define seq_trivial_usage \
2104 "[first [increment]] last"
2105#define seq_full_usage \
2106 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
2107 "FIRST, INCREMENT default to 1\n" \
2108 "Arguments:\n" \
2109 "\tLAST\n" \
2110 "\tFIRST\tLAST\n" \
2111 "\tFIRST\tINCREMENT\tLAST\n"
2112
Eric Andersen7e9276b2001-02-22 01:15:47 +00002113#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002114 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002115#define setkeycodes_full_usage \
2116 "Set entries into the kernel's scancode-to-keycode map,\n" \
2117 "allowing unusual keyboards to generate usable keycodes.\n\n" \
2118 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002119 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002120#define setkeycodes_example_usage \
2121 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002122
Matt Kraai2d91deb2001-08-01 17:21:35 +00002123#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002124 "[FILE]...\n" \
2125 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00002126#define lash_full_usage \
Eric Andersen2e9c2572003-08-08 22:26:06 +00002127 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00002128#define lash_notes_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002129"This command does not yet have proper documentation.\n" \
2130"\n" \
2131"Use lash just as you would use any other shell. It properly handles pipes,\n" \
2132"redirects, job control, can be used as the shell for scripts, and has a\n" \
2133"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
2134"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
2135"use ash or bash. If you just need a very simple and extremely small shell,\n" \
2136"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002137
Eric Andersen2e9c2572003-08-08 22:26:06 +00002138#define last_trivial_usage \
2139 ""
2140#define last_full_usage \
2141 "Shows listing of the last users that logged into the system"
2142
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002143#define sha1sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002144 "[OPTION] [FILEs...]" \
2145 USAGE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002146#define sha1sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002147 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n\n" \
2148 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002149 "With no FILE, or when FILE is -, read standard input." \
2150 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
2151 "\t-c\tcheck SHA1 sums against given list\n" \
2152 "\nThe following two options are useful only when verifying checksums:\n" \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002153 "\t-s\tdon't output anything, status code shows success\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002154 "\t-w\twarn about improperly formated SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002155
Manuel Novoa III cad53642003-03-19 09:13:01 +00002156#ifdef CONFIG_FEATURE_FANCY_SLEEP
2157 #define USAGE_FANCY_SLEEP(a) a
2158 #define USAGE_NOT_FANCY_SLEEP(a)
2159#else
Tim Riker7b253f82003-12-28 05:02:40 +00002160 #define USAGE_FANCY_SLEEP(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +00002161 #define USAGE_NOT_FANCY_SLEEP(a) a
2162#endif
2163
Eric Andersen7e9276b2001-02-22 01:15:47 +00002164#define sleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002165 USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002166#define sleep_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002167 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \
2168 USAGE_FANCY_SLEEP( \
2169"Pause for a time equal to the total of the args given, where each arg can\n" \
2170"have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002171#define sleep_example_usage \
2172 "$ sleep 2\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002173 "[2 second delay results]\n" \
2174 USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \
2175 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002176
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002177#ifdef CONFIG_FEATURE_SORT_UNIQUE
Mark Whitleyfccaa362001-04-17 18:56:18 +00002178 #define USAGE_SORT_UNIQUE(a) a
2179#else
2180 #define USAGE_SORT_UNIQUE(a)
2181#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002182#ifdef CONFIG_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002183 #define USAGE_SORT_REVERSE(a) a
2184#else
2185 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002186#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002187#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002188 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002189#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002190 "Sorts lines of text in the specified files\n\n"\
2191 "Options:\n" \
2192 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
2193 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
2194 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002195#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002196 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002197 "a\n" \
2198 "b\n" \
2199 "c\n" \
2200 "d\n" \
2201 "e\n" \
2202 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002203
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002204#define start_stop_daemon_trivial_usage \
2205 "[OPTIONS]"
2206#define start_stop_daemon_full_usage \
2207 "Program to start and stop services.\n"\
2208 "Options:\n" \
2209 "-S\t\t\tstart\n"\
2210 "-K\t\t\tstop\n"\
Eric Andersenfe5b1a92002-10-22 19:21:48 +00002211 "-b\t\t\tforce process into background (daemonize)\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002212 "-x <executable>\t\tprogram to start/check if it is running\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002213 "-u <username>|<uid>\tstop this user's processes\n"\
2214 "-n <process-name>\tstop processes with this name\n"\
2215 "-s <signal>\t\tsignal to send (default 15)\n"\
2216 "-a <pathname>\t\tprogram to start (default <executable>)\n"
2217
Eric Andersenef5e8f82002-11-07 02:09:37 +00002218#define strings_trivial_usage \
2219 "[-afo] [-n length] [file ... ]"
2220#define strings_full_usage \
2221 "Display printable strings in a binary file." \
2222 "\n\nOptions:" \
2223 "\n\t-f\tPrecede each string with the name of the file where it was found." \
2224 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
2225 "\n\t-o\tEach string is preceded by its decimal offset in the file."
2226
Eric Andersen7e9276b2001-02-22 01:15:47 +00002227#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002228 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002229#define stty_full_usage \
2230 "Without arguments, prints baud rate, line discipline," \
2231 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002232 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00002233 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002234 "\n\t-a\t\tprint all current settings in human-readable form" \
2235 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00002236 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002237
Robert Griebl1fca5582002-06-04 20:45:46 +00002238#define su_trivial_usage \
2239 "[OPTION]... [-] [username]"
2240#define su_full_usage \
2241 "Change user id or become root.\n" \
2242 "Options:\n" \
2243 "\t-p\tPreserve environment"
2244
Eric Andersen27f64e12002-06-23 04:24:25 +00002245#define sulogin_trivial_usage \
2246 "[OPTION]... [tty-device]"
2247#define sulogin_full_usage \
2248 "Single user login\n" \
2249 "Options:\n" \
2250 "\t-f\tDo not authenticate (user already authenticated)\n" \
2251 "\t-h\tName of the remote host for this login.\n" \
2252 "\t-p\tPreserve environment."
2253
Eric Andersen7e9276b2001-02-22 01:15:47 +00002254#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002255 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002256#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002257 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002258 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002259 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002260
Eric Andersen7e9276b2001-02-22 01:15:47 +00002261#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002262 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002263#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002264 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002265 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002266 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002267
Eric Andersen7e9276b2001-02-22 01:15:47 +00002268#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002269 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002270#define sync_full_usage \
2271 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002272
Eric Andersen7e9276b2001-02-22 01:15:47 +00002273
Eric Andersen29c77f72003-10-09 09:43:18 +00002274#ifdef CONFIG_FEATURE_ROTATE_LOGFILE
2275 #define USAGE_ROTATE_LOGFILE(a) a
2276#else
Tim Riker7b253f82003-12-28 05:02:40 +00002277 #define USAGE_ROTATE_LOGFILE(a)
Eric Andersen29c77f72003-10-09 09:43:18 +00002278#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002279#ifdef CONFIG_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00002280 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002281#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00002282 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002283#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00002284#ifdef CONFIG_FEATURE_IPC_SYSLOG
2285 #define USAGE_IPC_LOG(a) a
2286#else
2287 #define USAGE_IPC_LOG(a)
2288#endif
2289
Eric Andersenb9050282003-12-24 06:02:11 +00002290#ifdef CONFIG_SYSCTL
2291#define sysctl_trivial_usage \
2292 "[OPTIONS]... [VALUE]...\n"
2293#define sysctl_full_usage
2294 "sysctl - configure kernel parameters at runtime\n\n" \
2295 "Options:\n" \
2296 "\t-n\tUse this option to disable printing of the key name when printing values.\n" \
2297 "\t-e\tUse this option to ignore errors about unknown keys.\n" \
2298 "\t-w\tUse this option when you want to change a sysctl setting.\n" \
2299 "\t-p\tLoad in sysctl settings from the file specified or /etc/sysctl.conf if none given.\n" \
2300 "\t-a\tDisplay all values currently available.\n" \
2301 "\t-A\tDisplay all values currently available in table form."
2302
2303#define sysctl_example_usage
2304 "sysctl [-n] [-e] variable ...\n" \
2305 "sysctl [-n] [-e] -w variable=value ...\n" \
2306 "sysctl [-n] [-e] -a\n" \
2307 "sysctl [-n] [-e] -p <file>\t(default /etc/sysctl.conf)\n" \
2308 "sysctl [-n] [-e] -A\n"
2309#endif
2310
Eric Andersen7e9276b2001-02-22 01:15:47 +00002311#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002312 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002313#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002314 "Linux system and kernel logging utility.\n" \
2315 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002316 "Options:\n" \
2317 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
2318 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002319 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen29c77f72003-10-09 09:43:18 +00002320 USAGE_ROTATE_LOGFILE( \
2321 "\n\t-s SIZE\t\tMax size (KB) bevor rotate (default=200KB, 0=off)\n" \
2322 "\t-b NUM\t\tNumber of rotated log files (default=1, 0=purge log)") \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002323 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00002324 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00002325 "\t-L\t\tLog locally and via network logging (default is network only)") \
2326 USAGE_IPC_LOG( \
Eric Andersend4a5e252003-12-19 11:32:14 +00002327 "\n\t-C [size(KiB)]\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002328#define syslogd_example_usage \
2329 "$ syslogd -R masterlog:514\n" \
2330 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002331
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002332
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002333#ifndef CONFIG_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00002334 #define USAGE_UNSIMPLE_TAIL(a)
2335#else
2336 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002337#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002338#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002339 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002340#define tail_full_usage \
2341 "Print last 10 lines of each FILE to standard output.\n" \
2342 "With more than one FILE, precede each with a header giving the\n" \
2343 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
2344 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002345 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002346 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
2347 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002348 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002349 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
2350 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002351 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002352 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002353 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
2354#define tail_example_usage \
2355 "$ tail -n 1 /etc/resolv.conf\n" \
2356 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002357
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002358#ifdef CONFIG_FEATURE_TAR_CREATE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002359 #define USAGE_TAR_CREATE(a) a
2360#else
2361 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002362#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002363#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002364 #define USAGE_TAR_EXCLUDE(a) a
2365#else
2366 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002367#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002368#ifdef CONFIG_FEATURE_TAR_GZIP
2369 #define USAGE_TAR_GZIP(a) a
2370#else
2371 #define USAGE_TAR_GZIP(a)
2372#endif
2373#ifdef CONFIG_FEATURE_TAR_BZIP2
2374 #define USAGE_TAR_BZIP2(a) a
2375#else
2376 #define USAGE_TAR_BZIP2(a)
2377#endif
Glenn L McGrath7370f622003-11-18 21:49:23 +00002378#ifdef CONFIG_FEATURE_TAR_COMPRESS
2379 #define USAGE_TAR_COMPRESS(a) a
2380#else
2381 #define USAGE_TAR_COMPRESS(a)
2382#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002383
Eric Andersen7e9276b2001-02-22 01:15:47 +00002384#define tar_trivial_usage \
Glenn L McGrath7370f622003-11-18 21:49:23 +00002385 "-[" USAGE_TAR_CREATE("c") USAGE_TAR_GZIP("z") USAGE_TAR_BZIP2("j") USAGE_TAR_COMPRESS("Z") "xtvO] " \
Glenn L McGrathce91c8a2003-12-26 14:01:37 +00002386 USAGE_TAR_EXCLUDE("[-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00002387 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002388#define tar_full_usage \
2389 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00002390 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002391 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002392 "\tx\t\textract\n" \
2393 "\tt\t\tlist\n" \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002394 "\nArchive format selection:\n" \
2395 USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
2396 USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
Glenn L McGrath0c5d9c22003-11-18 23:27:49 +00002397 USAGE_TAR_COMPRESS("\tZ\t\tFilter the archive through compress\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002398 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002399 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002400 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002401 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002402 "\texclude\t\tfile to exclude\n" \
2403 "\tX\t\tfile with names to exclude\n" \
2404 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00002405 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002406 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002407#define tar_example_usage \
2408 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
2409 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002410
Eric Andersen7e9276b2001-02-22 01:15:47 +00002411#define tee_trivial_usage \
2412 "[OPTION]... [FILE]..."
2413#define tee_full_usage \
2414 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002415 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002416 "\t-a\tappend to the given FILEs, do not overwrite\n" \
2417 "\t-i\tignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002418#define tee_example_usage \
2419 "$ echo "Hello" | tee /tmp/foo\n" \
2420 "$ cat /tmp/foo\n" \
2421 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002422
Eric Andersen539ffc92004-02-22 12:25:47 +00002423#ifdef CONFIG_FEATURE_TELNET_AUTOLOGIN
2424#define telnet_trivial_usage \
2425 "[-a] [-l USER] HOST [PORT]"
2426#define telnet_full_usage \
2427 "Telnet is used to establish interactive communication with another\n" \
2428 "computer over a network using the TELNET protocol.\n\n" \
2429 "Options:\n" \
2430 "\t-a\t\tAttempt an automatic login with the USER variable.\n" \
2431 "\t-l USER\t\tAttempt an automatic login with the USER argument.\n" \
2432 "\tHOST\t\tThe official name, alias or the IP address of the\n" \
2433 "\t\t\tremote host.\n" \
2434 "\tPORT\t\tThe remote port number to connect to. If it is not\n" \
2435 "\t\t\tspecified, the default telnet (23) port is used.\n"
2436#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00002437#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002438 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002439#define telnet_full_usage \
2440 "Telnet is used to establish interactive communication with another\n"\
2441 "computer over a network using the TELNET protocol."
Eric Andersen539ffc92004-02-22 12:25:47 +00002442#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002443
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002444#ifdef CONFIG_FEATURE_TELNETD_INETD
2445#define telnetd_trivial_usage \
2446 "(inetd mode) [OPTION]"
2447#define telnetd_full_usage \
2448 "Telnetd uses incoming TELNET connections via inetd.\n"\
2449 "Options:\n" \
2450 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
2451#else
Eric Andersen08a72202002-09-30 20:52:10 +00002452#define telnetd_trivial_usage \
2453 "[OPTION]"
2454#define telnetd_full_usage \
2455 "Telnetd listens for incoming TELNET connections on PORT.\n"\
2456 "Options:\n" \
2457 "\t-p PORT\tlisten for connections on PORT (default 23)\n"\
2458 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002459#endif
Eric Andersen08a72202002-09-30 20:52:10 +00002460
Eric Andersen7e9276b2001-02-22 01:15:47 +00002461#define test_trivial_usage \
2462 "EXPRESSION\n or [ EXPRESSION ]"
2463#define test_full_usage \
2464 "Checks file types and compares values returning an exit\n" \
2465 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002466#define test_example_usage \
2467 "$ test 1 -eq 2\n" \
2468 "$ echo $?\n" \
2469 "1\n" \
2470 "$ test 1 -eq 1\n" \
2471 "$ echo $? \n" \
2472 "0\n" \
2473 "$ [ -d /etc ]\n" \
2474 "$ echo $?\n" \
2475 "0\n" \
2476 "$ [ -d /junk ]\n" \
2477 "$ echo $?\n" \
2478 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002479
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002480#ifdef CONFIG_FEATURE_TFTP_GET
Mark Whitley450736c2001-03-02 19:08:50 +00002481 #define USAGE_TFTP_GET(a) a
2482#else
2483 #define USAGE_TFTP_GET(a)
2484#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002485#ifdef CONFIG_FEATURE_TFTP_PUT
Mark Whitley450736c2001-03-02 19:08:50 +00002486 #define USAGE_TFTP_PUT(a) a
2487#else
2488 #define USAGE_TFTP_PUT(a)
2489#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002490#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Glenn L McGrathad117d82001-10-05 04:40:37 +00002491 #define USAGE_TFTP_BS(a) a
2492#else
2493 #define USAGE_TFTP_BS(a)
2494#endif
Mark Whitley450736c2001-03-02 19:08:50 +00002495
2496#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00002497 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00002498#define tftp_full_usage \
2499 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00002500 "Options:\n" \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002501 "\t-l FILE\tLocal FILE.\n" \
2502 "\t-r FILE\tRemote FILE.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002503 USAGE_TFTP_GET( \
Matt Kraai3be34302001-09-21 14:42:30 +00002504 "\t-g\tGet file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002505 ) \
2506 USAGE_TFTP_PUT( \
Matt Kraai3be34302001-09-21 14:42:30 +00002507 "\t-p\tPut file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002508 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002509 USAGE_TFTP_BS( \
2510 "\t-b SIZE\tTransfer blocks of SIZE octets.\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002511 )
Eric Andersenc3657422001-11-30 07:54:32 +00002512#define time_trivial_usage \
2513 "[OPTION]... COMMAND [ARGS...]"
2514#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00002515 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
2516 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00002517 "Options:\n" \
2518 "\t-v\tDisplays verbose resource usage information."
Mark Whitley450736c2001-03-02 19:08:50 +00002519
Eric Andersen420b2082002-09-17 22:14:58 +00002520#define top_trivial_usage \
2521 "[-d <seconds>]"
2522#define top_full_usage \
2523 "top provides an view of processor activity in real time.\n" \
2524 "This utility reads the status for all processes in /proc each <seconds>\n" \
2525 "and shows the status for however many processes will fit on the screen.\n" \
2526 "This utility will not show processes that are started after program startup,\n" \
2527 "but it will show the EXIT status for and PIDs that exit while it is running."
2528
Eric Andersen7e9276b2001-02-22 01:15:47 +00002529#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002530 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002531#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002532 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002533 "Options:\n" \
2534 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002535#define touch_example_usage \
2536 "$ ls -l /tmp/foo\n" \
2537 "/bin/ls: /tmp/foo: No such file or directory\n" \
2538 "$ touch /tmp/foo\n" \
2539 "$ ls -l /tmp/foo\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002540 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002541
2542#define tr_trivial_usage \
2543 "[-cds] STRING1 [STRING2]"
2544#define tr_full_usage \
2545 "Translate, squeeze, and/or delete characters from\n" \
2546 "standard input, writing to standard output.\n\n" \
2547 "Options:\n" \
2548 "\t-c\ttake complement of STRING1\n" \
2549 "\t-d\tdelete input characters coded STRING1\n" \
2550 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002551#define tr_example_usage \
2552 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002553 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002554
Eric Andersen5c58d282001-07-10 16:29:00 +00002555#define traceroute_trivial_usage \
2556 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n\
2557 [-s src_addr] [-t tos] [-w wait] host [data size]"
2558#define traceroute_full_usage \
2559 "trace the route ip packets follow going to \"host\"\n" \
2560 "Options:\n" \
2561 "\t-d\tset SO_DEBUG options to socket\n" \
2562 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
2563 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
2564 "\t-v\tVerbose output\n" \
2565 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
2566 "\t-p port#\tSet the base UDP port number used in probes\n" \
2567 "\t\t(default is 33434)\n" \
2568 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
2569 "\t\t(default is 3)\n" \
2570 "\t-s src_addr\tUse the following IP address as the source address\n" \
2571 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
2572 "\t\t(default 0)\n" \
2573 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
2574 "\t\t(default 3 sec.)."
2575
2576
Eric Andersen7e9276b2001-02-22 01:15:47 +00002577#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002578 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002579#define true_full_usage \
2580 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002581#define true_example_usage \
2582 "$ true\n" \
2583 "$ echo $?\n" \
2584 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002585
Eric Andersen7e9276b2001-02-22 01:15:47 +00002586#define tty_trivial_usage \
2587 ""
2588#define tty_full_usage \
2589 "Print the file name of the terminal connected to standard input.\n\n"\
2590 "Options:\n" \
2591 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002592#define tty_example_usage \
2593 "$ tty\n" \
2594 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002595
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002596#define udhcpc_trivial_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00002597 "[-fbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002598#define udhcpc_full_usage \
2599 "\t-c,\t--clientid=CLIENTID\tClient identifier\n" \
2600 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00002601 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002602 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00002603 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated.\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002604 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
2605 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated.\n" \
2606 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
2607 "\t-q,\t--quit\tQuit after obtaining lease\n" \
2608 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
2609 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
2610 "\t-v,\t--version\tDisplay version"
2611
Russ Dill61fb4892002-10-14 21:41:28 +00002612#define udhcpd_trivial_usage \
2613 "[configfile]\n" \
2614
2615#define udhcpd_full_usage \
Glenn L McGrath9130c852002-12-12 12:56:18 +00002616 ""
Russ Dill61fb4892002-10-14 21:41:28 +00002617
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002618#ifdef CONFIG_FEATURE_MOUNT_FORCE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002619 #define USAGE_MOUNT_FORCE(a) a
2620#else
2621 #define USAGE_MOUNT_FORCE(a)
2622#endif
2623#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002624 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002625#define umount_full_usage \
2626 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00002627 "\nFlags:\n" "\t-a\tUnmount all file systems" \
2628 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
2629 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00002630 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00002631 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 +00002632#define umount_example_usage \
2633 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002634
2635#define uname_trivial_usage \
2636 "[OPTION]..."
2637#define uname_full_usage \
2638 "Print certain system information. With no OPTION, same as -s.\n\n" \
2639 "Options:\n" \
2640 "\t-a\tprint all information\n" \
2641 "\t-m\tthe machine (hardware) type\n" \
2642 "\t-n\tprint the machine's network node hostname\n" \
2643 "\t-r\tprint the operating system release\n" \
2644 "\t-s\tprint the operating system name\n" \
2645 "\t-p\tprint the host processor type\n" \
2646 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002647#define uname_example_usage \
2648 "$ uname -a\n" \
Eric Andersen7f48a952003-12-28 05:06:56 +00002649 "Linux debian 2.4.23 #2 Tue Dec 23 17:09:10 MST 2003 i686 GNU/Linux\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002650
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00002651#define uncompress_trivial_usage \
2652 "[-c] [-f] [ name ... ]"
2653#define uncompress_full_usage \
2654 "Uncompress .Z file[s]\n" \
2655 "Options:\n" \
2656 "\t-c\textract to stdout\n" \
2657 "\t-f\tforce overwrite an existing file\n"
Tim Riker7b253f82003-12-28 05:02:40 +00002658
Eric Andersen7e9276b2001-02-22 01:15:47 +00002659#define uniq_trivial_usage \
2660 "[OPTION]... [INPUT [OUTPUT]]"
2661#define uniq_full_usage \
2662 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00002663 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002664 "Options:\n" \
2665 "\t-c\tprefix lines by the number of occurrences\n" \
2666 "\t-d\tonly print duplicate lines\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002667 "\t-u\tonly print unique lines\n" \
2668 "\t-f N\tskip the first N fields\n" \
2669 "\t-s N\tskip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002670#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002671 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002672 "a\n" \
2673 "b\n" \
2674 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002675
2676#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002677 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002678#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002679 "Converts FILE from unix format to dos format. When no option\n" \
2680 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002681 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002682 "Options:\n" \
2683 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002684 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002685
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002686#define unzip_trivial_usage \
2687 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
2688#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002689 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002690 "Options:\n" \
2691 "\t-l\tlist archive contents (short form)\n" \
2692 "\t-n\tnever overwrite existing files (default)\n" \
2693 "\t-o\toverwrite files without prompting\n" \
2694 "\t-p\tsend output to stdout\n" \
2695 "\t-q\tbe quiet\n" \
2696 "\t-x\texclude these files\n" \
2697 "\t-d\textract files into this directory"
2698
Eric Andersen7e9276b2001-02-22 01:15:47 +00002699#define uptime_trivial_usage \
2700 ""
2701#define uptime_full_usage \
2702 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002703#define uptime_example_usage \
2704 "$ uptime\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002705 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002706
2707#define usleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002708 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002709#define usleep_full_usage \
2710 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002711#define usleep_example_usage \
2712 "$ usleep 1000000\n" \
2713 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002714
2715#define uudecode_trivial_usage \
2716 "[FILE]..."
2717#define uudecode_full_usage \
2718 "Uudecode a file that is uuencoded.\n\n" \
2719 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002720 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002721#define uudecode_example_usage \
2722 "$ uudecode -o busybox busybox.uu\n" \
2723 "$ ls -l busybox\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002724 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002725
2726#define uuencode_trivial_usage \
2727 "[OPTION] [INFILE] REMOTEFILE"
2728#define uuencode_full_usage \
2729 "Uuencode a file.\n\n" \
2730 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00002731 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002732#define uuencode_example_usage \
2733 "$ uuencode busybox busybox\n" \
2734 "begin 755 busybox\n" \
2735 "<encoded file snipped>\n" \
2736 "$ uudecode busybox busybox > busybox.uu\n" \
2737 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002738
Eric Andersen853c4942003-01-23 05:59:32 +00002739#define vconfig_trivial_usage \
2740 "COMMAND [OPTIONS] ..."
2741
2742#define vconfig_full_usage \
2743"Usage: add [interface-name] [vlan_id] \n" \
2744" rem [vlan-name] \n" \
2745" set_flag [interface-name] [flag-num] [0 | 1] \n" \
2746" set_egress_map [vlan-name] [skb_priority] [vlan_qos] \n" \
2747" set_ingress_map [vlan-name] [skb_priority] [vlan_qos] \n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002748" set_name_type [name-type] \n"
Eric Andersen853c4942003-01-23 05:59:32 +00002749
Eric Andersen3f980402001-04-04 17:31:15 +00002750#define vi_trivial_usage \
2751 "[OPTION] [FILE]..."
2752#define vi_full_usage \
2753 "edit FILE.\n\n" \
2754 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002755 "\t-R\tRead-only- do not write to the file."
Eric Andersen3f980402001-04-04 17:31:15 +00002756
Eric Andersen27f64e12002-06-23 04:24:25 +00002757#define vlock_trivial_usage \
2758 "[OPTIONS]"
2759#define vlock_full_usage \
2760 "Lock a virtual terminal. A password is required to unlock\n" \
2761 "Options:\n" \
2762 "\t-a\tLock all VTs"
2763
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002764#define watch_trivial_usage \
2765 "[-n <seconds>] COMMAND..."
2766#define watch_full_usage \
2767 "Executes a program periodically.\n" \
2768 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002769 "\t-n\tLoop period in seconds - default is 2."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002770#define watch_example_usage \
2771 "$ watch date\n" \
2772 "Mon Dec 17 10:31:40 GMT 2000\n" \
2773 "Mon Dec 17 10:31:42 GMT 2000\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002774 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002775
Eric Andersen7e9276b2001-02-22 01:15:47 +00002776#define watchdog_trivial_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00002777 "[-t <seconds>] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002778#define watchdog_full_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00002779 "Periodically write to watchdog device DEV.\n" \
2780 "Options:\n" \
2781 "\t-t\tTimer period in seconds - default is 30."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002782
2783#define wc_trivial_usage \
2784 "[OPTION]... [FILE]..."
2785#define wc_full_usage \
2786 "Print line, word, and byte counts for each FILE, and a total line if\n" \
2787 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
2788 "Options:\n" \
2789 "\t-c\tprint the byte counts\n" \
2790 "\t-l\tprint the newline counts\n" \
2791 "\t-L\tprint the length of the longest line\n" \
2792 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002793#define wc_example_usage \
2794 "$ wc /etc/passwd\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002795 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002796
2797#define wget_trivial_usage \
Robert Griebld7760112002-05-14 23:36:45 +00002798 "[-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 +00002799#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00002800 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002801 "Options:\n" \
2802 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00002803 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00002804 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00002805 "\t-O\tsave to filename ('-' for stdout)\n" \
2806 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002807
2808#define which_trivial_usage \
2809 "[COMMAND ...]"
2810#define which_full_usage \
2811 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002812#define which_example_usage \
2813 "$ which login\n" \
2814 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00002815
Eric Andersen00a6a752002-04-26 23:53:10 +00002816#define who_trivial_usage \
2817 " "
2818#define who_full_usage \
2819 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002820
2821#define whoami_trivial_usage \
2822 ""
2823#define whoami_full_usage \
2824 "Prints the user name associated with the current effective user id."
2825
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002826#ifdef CONFIG_FEATURE_XARGS_SUPPORT_CONFIRMATION
2827#define USAGE_XARGS_CONFIRMATION(a) a
2828#else
2829#define USAGE_XARGS_CONFIRMATION(a)
2830#endif
2831#ifdef CONFIG_FEATURE_XARGS_SUPPORT_TERMOPT
2832#define USAGE_XARGS_TERMOPT(a) a
2833#else
2834#define USAGE_XARGS_TERMOPT(a)
2835#endif
2836#ifdef CONFIG_FEATURE_XARGS_SUPPORT_ZERO_TERM
2837#define USAGE_XARGS_ZERO_TERM(a) a
2838#else
2839#define USAGE_XARGS_ZERO_TERM(a)
2840#endif
2841
2842
Eric Andersen7e9276b2001-02-22 01:15:47 +00002843#define xargs_trivial_usage \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002844 "[COMMAND] [OPTIONS] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002845#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002846 "Executes COMMAND on every item given by standard input.\n\n" \
2847 "Options:\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002848 USAGE_XARGS_CONFIRMATION("\t-p\tPrompt the user about whether to run each command\n") \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002849 "\t-r\tDo not run command for empty readed lines\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002850 USAGE_XARGS_TERMOPT("\t-x\tExit if the size is exceeded\n") \
2851 USAGE_XARGS_ZERO_TERM("\t-0\tInput filenames are terminated by a null character\n") \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002852 "\t-t\tPrint the command line on stderr before executing it."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002853#define xargs_example_usage \
2854 "$ ls | xargs gzip\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002855 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002856
2857#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002858 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002859#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002860 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002861
Eric Andersen7e9276b2001-02-22 01:15:47 +00002862#define zcat_trivial_usage \
2863 "FILE"
2864#define zcat_full_usage \
2865 "Uncompress to stdout."