blob: 268c23cac038396304ceddd352382b333a7d654b [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
Eric Andersen7e9276b2001-02-22 01:15:47 +0000104#define cat_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000105 "[-u] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000106#define cat_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000107 "Concatenates FILE(s) and prints them to stdout.\n\n" \
108 "Options:\n" \
109 "\t-u\tignored since unbuffered i/o is always used"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000110#define cat_example_usage \
111 "$ cat /proc/uptime\n" \
112 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000113
Eric Andersen7e9276b2001-02-22 01:15:47 +0000114#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000115 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000116#define chgrp_full_usage \
117 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000118 "\nOptions:\n" \
119 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000120#define chgrp_example_usage \
121 "$ ls -l /tmp/foo\n" \
122 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
123 "$ chgrp root /tmp/foo\n" \
124 "$ ls -l /tmp/foo\n" \
125 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000126
Eric Andersen7e9276b2001-02-22 01:15:47 +0000127#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000128 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000129#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000130 "Each MODE is one or more of the letters ugoa, one of the\n" \
131 "symbols +-= and one or more of the letters rwxst.\n\n" \
132 "Options:\n" \
133 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000134#define chmod_example_usage \
135 "$ ls -l /tmp/foo\n" \
136 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
137 "$ chmod u+x /tmp/foo\n" \
138 "$ ls -l /tmp/foo\n" \
139 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
140 "$ chmod 444 /tmp/foo\n" \
141 "$ ls -l /tmp/foo\n" \
142 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000143
Eric Andersen7e9276b2001-02-22 01:15:47 +0000144#define chown_trivial_usage \
Eric Andersen238da242001-05-11 16:31:46 +0000145 "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000146#define chown_full_usage \
147 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000148 "\nOptions:\n" \
Eric Andersen238da242001-05-11 16:31:46 +0000149 "\t-R\tChanges files and directories recursively.\n" \
150 "\t-h\tDo not dereference symbolic links."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000151#define chown_example_usage \
152 "$ ls -l /tmp/foo\n" \
153 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
154 "$ chown root /tmp/foo\n" \
155 "$ ls -l /tmp/foo\n" \
156 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
157 "$ chown root.root /tmp/foo\n" \
158 "ls -l /tmp/foo\n" \
159 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000160
Eric Andersen7e9276b2001-02-22 01:15:47 +0000161#define chroot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000162 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000163#define chroot_full_usage \
164 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000165#define chroot_example_usage \
166 "$ ls -l /bin/ls\n" \
167 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
168 "$ mount /dev/hdc1 /mnt -t minix\n" \
169 "$ chroot /mnt\n" \
170 "$ ls -l /bin/ls\n" \
171 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000172
Eric Andersen7e9276b2001-02-22 01:15:47 +0000173#define chvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000174 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000175#define chvt_full_usage \
176 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000177
Eric Andersen7e9276b2001-02-22 01:15:47 +0000178#define clear_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000179 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000180#define clear_full_usage \
181 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000182
Eric Andersen7e9276b2001-02-22 01:15:47 +0000183#define cmp_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000184 "[OPTION]... FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000185#define cmp_full_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000186 "Compare files.\n\n" \
187 "Options:\n" \
188 "\t-l\tWrite the byte numbers (decimal) and values (octal)\n" \
189 "\t\t for all differing bytes.\n" \
190 "\t-s\tquiet mode - do not print"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000191
Eric Andersen7e9276b2001-02-22 01:15:47 +0000192#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000193 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000194#define cp_full_usage \
195 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
196 "\n" \
197 "\t-a\tSame as -dpR\n" \
198 "\t-d\tPreserves links\n" \
199 "\t-p\tPreserves file attributes if possible\n" \
200 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000201 "\t-R\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000202
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000203#define cpio_trivial_usage \
204 "-[dimtuv][F cpiofile]"
205#define cpio_full_usage \
206 "Extract or list files from a cpio archive\n" \
207 "Main operation mode:\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000208 "\td\t\tmake leading directories\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000209 "\ti\t\textract\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000210 "\tm\t\tpreserve mtime\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000211 "\tt\t\tlist\n" \
Eric Andersen6925d502001-12-16 09:23:09 +0000212 "\tu\t\tunconditional overwrite\n" \
213 "\tF\t\tinput from file"
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000214
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000215#define crond_trivial_usage \
216 "-d[#] -c <crondir> -f -b"
217#define crond_full_usage \
218 "\t-d [#] -l [#] -S -L logfile -f -b -c dir\n" \
219 "\t-d num\tdebug level\n" \
220 "\t-l num\tlog level (8 - default)\n" \
Glenn L McGrath2af30442003-09-12 10:58:54 +0000221 "\t-S\tlog to syslod (default)\n" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000222 "\t-L file\tlog to file\n" \
223 "\t-f\trun in fordeground\n" \
224 "\t-b\trun in background (default)\n" \
225 "\t-c dir\tworking dir"
226
227#define crontab_trivial_usage \
228 "crontab [-c dir] {file|-}|[-u|-l|-e|-d user]"
229#define crontab_full_usage \
230 "\tfile <opts> replace crontab from file\n" \
231 "\t- <opts> replace crontab from stdin\n" \
232 "\t-u user specify user\n" \
233 "\t-l [user] list crontab for user\n" \
234 "\t-e [user] edit crontab for user\n" \
235 "\t-d [user] delete crontab for user\n" \
236 "\t-c dir specify crontab directory"
237
238
Eric Andersen7e9276b2001-02-22 01:15:47 +0000239#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000240 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000241#define cut_full_usage \
242 "Prints selected fields from each input FILE to standard output.\n\n" \
243 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000244 "\t-b LIST\t\tOutput only bytes from LIST\n" \
245 "\t-c LIST\t\tOutput only characters from LIST\n" \
246 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
247 "\t-s\t\tOutput only the lines containing delimiter\n" \
248 "\t-f N\t\tPrint only these fields\n" \
249 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000250#define cut_example_usage \
251 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
252 "Hello\n" \
253 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
254 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000255
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000256#ifdef CONFIG_FEATURE_DATE_ISOFMT
257#define USAGE_DATE_ISOFMT(a) a
258#else
259#define USAGE_DATE_ISOFMT(a)
260#endif
261
Eric Andersen7e9276b2001-02-22 01:15:47 +0000262#define date_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000263 "[OPTION]... [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000264#define date_full_usage \
265 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000266 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000267 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000268 "\t-d STRING\tDisplays time described by STRING, not `now'\n" \
269 USAGE_DATE_ISOFMT("\t-I[TIMESPEC]\tOutputs an ISO-8601 compliant date/time string.\n" \
270 "\t\t\tTIMESPEC=`date' (or missing) for date only,\n" \
271 "\t\t\t`hours', `minutes', or `seconds' for date and,\n" \
272 "\t\t\ttime to the indicated precision.\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000273 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000274 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000275#define date_example_usage \
276 "$ date\n" \
277 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000278
Eric Andersen7e9276b2001-02-22 01:15:47 +0000279#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000280 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000281#define dc_full_usage \
282 "This is a Tiny RPN calculator that understands the\n" \
Eric Andersena9287742003-10-22 11:24:39 +0000283 "following operations: +, add, -, sub, *, mul, /, div, %, mod, "\
284 "**, exp, and, or, not, eor.\n" \
285 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16.\n" \
286 "\nOptions:\n" \
Glenn L McGrath6d074322002-12-12 10:31:53 +0000287 "p - Prints the value on the top of the stack, without altering the stack.\n" \
288 "f - Prints the entire contents of the stack without altering anything.\n" \
289 "o - Pops the value off the top of the stack and uses it to set the output radix.\n" \
290 " Only 10 and 16 are supported.\n"
291
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000292#define dc_example_usage \
293 "$ dc 2 2 +\n" \
294 "4\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000295 "$ dc 8 8 * 2 2 + /\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000296 "16\n" \
297 "$ dc 0 1 and\n" \
298 "0\n" \
299 "$ dc 0 1 or\n" \
300 "1\n" \
301 "$ echo 72 9 div 8 mul | dc\n" \
302 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000303
Eric Andersen7e9276b2001-02-22 01:15:47 +0000304#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000305 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000306 "\t [seek=N] [conv=notrunc|noerror|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000307#define dd_full_usage \
308 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000309 "\tif=FILE\t\tread from FILE instead of stdin\n" \
310 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
311 "\tbs=N\t\tread and write N bytes at a time\n" \
312 "\tcount=N\t\tcopy only N input blocks\n" \
313 "\tskip=N\t\tskip N input blocks\n" \
314 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000315 "\tconv=notrunc\tdon't truncate output file\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000316 "\tconv=noerror\tcontinue after read errors\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000317 "\tconv=sync\tpad blocks with zeros\n" \
318 "\n" \
319 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000320 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000321#define dd_example_usage \
322 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
323 "4+0 records in\n" \
324 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000325
Eric Andersen7e9276b2001-02-22 01:15:47 +0000326#define deallocvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000327 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000328#define deallocvt_full_usage \
329 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000330
Eric Andersenf349e972001-08-21 16:18:59 +0000331#define delgroup_trivial_usage \
332 "GROUP"
333#define delgroup_full_usage \
334 "Deletes group GROUP from the system"
335
336#define deluser_trivial_usage \
337 "USER"
338#define deluser_full_usage \
339 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000340
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000341#define devfsd_trivial_usage \
342 "mntpnt [-v] [-fg] [-np]"
343#define devfsd_full_usage \
344 "Optional daemon for managing devfs (the Linux Device Filesystem).\n" \
345 "\nOptions:\n" \
346 "\tmntpnt\tThe mount point where devfs is mounted.\n\n" \
347 "\t-v\tPrint the protocol version numbers for devfsd\n" \
348 "\t\tand the kernel-side protocol version and exits.\n" \
349 "\t-fg\tRun the daemon in the foreground.\n\n" \
350 "\t-np\tExit after parsing the configuration file and processing syn-\n" \
351 "\t\tthetic REGISTER events. Do not poll for events."
352
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000353#ifdef CONFIG_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000354 #define USAGE_HUMAN_READABLE(a) a
355 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000356#else
Eric Andersened0d9582001-02-23 13:23:03 +0000357 #define USAGE_HUMAN_READABLE(a)
358 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000359#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000360#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000361 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000362#define df_full_usage \
363 "Print the filesystem space used and space available.\n\n" \
364 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000365 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000366 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
367 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000368 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000369 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000370#define df_example_usage \
371 "$ df\n" \
372 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
373 "/dev/sda3 8690864 8553540 137324 98% /\n" \
374 "/dev/sda1 64216 36364 27852 57% /boot\n" \
375 "$ df /dev/sda3\n" \
376 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
377 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000378
Eric Andersen7e9276b2001-02-22 01:15:47 +0000379#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000380 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000381#define dirname_full_usage \
382 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000383#define dirname_example_usage \
384 "$ dirname /tmp/foo\n" \
385 "/tmp\n" \
386 "$ dirname /tmp/foo/\n" \
387 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000388
Eric Andersen7e9276b2001-02-22 01:15:47 +0000389#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000390 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000391#define dmesg_full_usage \
392 "Prints or controls the kernel ring buffer\n\n" \
393 "Options:\n" \
394 "\t-c\t\tClears the ring buffer's contents after printing\n" \
395 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000396 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000397
Eric Andersen7e9276b2001-02-22 01:15:47 +0000398#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000399 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000400#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000401 "Converts FILE from dos format to unix format. When no option\n" \
402 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000403 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000404 "Options:\n" \
405 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000406 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000407
Eric Andersen7e9276b2001-02-22 01:15:47 +0000408#define dpkg_trivial_usage \
Eric Andersen9fe5f982002-04-13 14:48:51 +0000409 "-i package_file\n" \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000410 "[-CPru] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000411#define dpkg_full_usage \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000412 "\t-i\tInstall the package\n" \
413 "\t-C\tConfigure an unpackaged package\n" \
414 "\t-P\tPurge all files of a package\n" \
415 "\t-r\tRemove all but the configuration files for a package\n" \
416 "\t-u\tUnpack a package, but dont configure it\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000417
Eric Andersen7e9276b2001-02-22 01:15:47 +0000418#define dpkg_deb_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000419 "[-cefItxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000420#define dpkg_deb_full_usage \
421 "Perform actions on debian packages (.debs)\n\n" \
422 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000423 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000424 "\t-e\tExtract control files to [argument] directory\n" \
425 "\t-f\tDisplay control field name starting with [argument]\n" \
426 "\t-I\tDisplay the control filenamed [argument]\n" \
427 "\t-t\tExtract filesystem tree to stdout in tar format\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000428 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000429 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000430#define dpkg_deb_example_usage \
431 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000432
Manuel Novoa III cad53642003-03-19 09:13:01 +0000433#ifdef CONFIG_FEATURE_DU_DEFALT_BLOCKSIZE_1K
434#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a) a
435#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a)
436#else
437#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a)
438#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a) a
439#endif
440
Eric Andersen7e9276b2001-02-22 01:15:47 +0000441#define du_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000442 "[-aHLdclsx" USAGE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000443#define du_full_usage \
444 "Summarizes disk space used for each FILE and/or directory.\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000445 "Disk space is printed in units of " \
446 USAGE_DU_DEFALT_BLOCKSIZE_1k("1024") USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k("512") \
447 " bytes.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000448 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000449 "\t-a\tshow sizes of files in addition to directories\n" \
450 "\t-H\tfollow symbolic links that are FILE command line args\n" \
451 "\t-L\tfollow all symbolic links encountered\n" \
452 "\t-d N\tlimit output to directories (and files with -a) of depth < N\n" \
453 "\t-c\toutput a grand total\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000454 "\t-l\tcount sizes many times if hard linked\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000455 "\t-s\tdisplay only a total for each argument\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000456 "\t-x\tskip directories on different filesystems\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000457 USAGE_HUMAN_READABLE( \
458 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
459 "\t-m\tprint sizes in megabytes\n" ) \
460 "\t-k\tprint sizes in kilobytes" USAGE_DU_DEFALT_BLOCKSIZE_1k("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000461#define du_example_usage \
462 "$ du\n" \
463 "16 ./CVS\n" \
464 "12 ./kernel-patches/CVS\n" \
465 "80 ./kernel-patches\n" \
466 "12 ./tests/CVS\n" \
467 "36 ./tests\n" \
468 "12 ./scripts/CVS\n" \
469 "16 ./scripts\n" \
470 "12 ./docs/CVS\n" \
471 "104 ./docs\n" \
472 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000473
Eric Andersen7e9276b2001-02-22 01:15:47 +0000474#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000475 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000476#define dumpkmap_full_usage \
477 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000478#define dumpkmap_example_usage \
479 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000480
Russ Dill61fb4892002-10-14 21:41:28 +0000481#define dumpleases_trivial_usage \
482 "[-r|-a] [-f LEASEFILE]"
483#define dumpleases_full_usage \
Russ Dill61fb4892002-10-14 21:41:28 +0000484 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
485 "\t-r,\t--remaining\tInterepret lease times as time remaing\n" \
486 "\t-a,\t--absolute\tInterepret lease times as expire time\n"
487
Manuel Novoa III cad53642003-03-19 09:13:01 +0000488#ifdef CONFIG_FEATURE_FANCY_ECHO
489 #define USAGE_FANCY_ECHO(a) a
490#else
491 #define USAGE_FANCY_ECHO(a)
492#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000493
Eric Andersen7e9276b2001-02-22 01:15:47 +0000494#define echo_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000495 USAGE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000496#define echo_full_usage \
497 "Prints the specified ARGs to stdout\n\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000498 USAGE_FANCY_ECHO("Options:\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000499 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000500 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000501 "\t-E\tdisable interpretation of backslash-escaped characters")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000502#define echo_example_usage \
503 "$ echo "Erik is cool"\n" \
504 "Erik is cool\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000505 USAGE_FANCY_ECHO("$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000506 "Erik\n" \
507 "is\n" \
508 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000509 "$ echo "Erik\\nis\\ncool"\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000510 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000511
Eric Andersen84e229c2001-03-29 22:48:33 +0000512#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000513 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000514#define env_full_usage \
515 "Prints the current environment or runs a program after setting\n" \
516 "up the specified environment.\n\n" \
517 "Options:\n" \
518 "\t-, -i\tstart with an empty environment\n" \
519 "\t-u\tremove variable from the environment\n"
520
Eric Andersen7e9276b2001-02-22 01:15:47 +0000521#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000522 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000523#define expr_full_usage \
524 "Prints the value of EXPRESSION to standard output.\n\n" \
525 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000526 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
527 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
528 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
529 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
530 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
531 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
532 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
533 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
534 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
535 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
536 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
537 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
538 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000539 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
540 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
541 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
542 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
543 "\t or 0\n" \
544 "\tlength STRING length of STRING\n" \
545 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
546 "\t it is a keyword like `match' or an\n" \
547 "\t operator like `/'\n" \
548 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000549 "Beware that many operators need to be escaped or quoted for shells.\n" \
550 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
551 "lexicographical. Pattern matches return the string matched between \n" \
552 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
553 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000554
Eric Andersen7e9276b2001-02-22 01:15:47 +0000555#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000556 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000557#define false_full_usage \
558 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000559#define false_example_usage \
560 "$ false\n" \
561 "$ echo $?\n" \
562 "1\n"
563
564#define fbset_trivial_usage \
565 "[options] [mode]"
566#define fbset_full_usage \
567 "Show and modify frame buffer settings"
568#define fbset_example_usage \
569 "$ fbset\n" \
570 "mode "1024x768-76"\n" \
571 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
572 "\tgeometry 1024 768 1024 768 16\n" \
573 "\ttimings 12714 128 32 16 4 128 4\n" \
574 "\taccel false\n" \
575 "\trgba 5/11,6/5,5/0,0/0\n" \
576 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000577
Eric Andersen7e9276b2001-02-22 01:15:47 +0000578#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000579 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000580#define fdflush_full_usage \
581 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000582
Eric Andersen01c3d402003-07-05 07:51:31 +0000583#define fdformat_trivial_usage \
584 "[-n] DEVICE"
585#define fdformat_full_usage \
586 "Low-level formats a floppy disk\n\n" \
587 "Options:\n" \
588 "\t-n\tDon't verify after format"
589
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000590#define fdisk_trivial_usage \
591 "[-l] [-v] [-b SSZ] [-u] DISK"
592#define fdisk_full_usage \
593 "Change partition table\n" \
594 "Options:\n" \
595 "-l List partition table(s)\n" \
596 "-u Give Start and End in sector (instead of cylinder) units\n" \
597 "-s PARTITION Give partition size(s) in blocks\n" \
598 "-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
Glenn L McGrath062c74f2002-11-27 09:29:49 +0000599 "-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000600
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000601#ifdef CONFIG_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000602 #define USAGE_FIND_TYPE(a) a
603#else
604 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000605#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000606#ifdef CONFIG_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000607 #define USAGE_FIND_PERM(a) a
608#else
609 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000610#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000611#ifdef CONFIG_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000612 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000613#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000614 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000615#endif
Eric Andersen97d86f22003-01-23 05:27:42 +0000616#ifdef CONFIG_FEATURE_FIND_NEWER
617 #define USAGE_FIND_NEWER(a) a
618#else
619 #define USAGE_FIND_NEWER(a)
620#endif
621#ifdef CONFIG_FEATURE_FIND_INUM
622 #define USAGE_FIND_INUM(a) a
623#else
624 #define USAGE_FIND_INUM(a)
625#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000626
Eric Andersen7e9276b2001-02-22 01:15:47 +0000627#define find_trivial_usage \
628 "[PATH...] [EXPRESSION]"
629#define find_full_usage \
630 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000631 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000632 "\nEXPRESSION may consist of:\n" \
633 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000634 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000635 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000636 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000637 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
638) USAGE_FIND_PERM( \
639 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
640) USAGE_FIND_MTIME( \
Eric Andersen97d86f22003-01-23 05:27:42 +0000641 "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \
642) USAGE_FIND_NEWER( \
643 "\n\t-newer FILE\tModified time is more recent than FILE's" \
644) USAGE_FIND_INUM( \
645 "\n\t-inum N\t\tFile has inode number N")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000646#define find_example_usage \
647 "$ find / -name /etc/passwd\n" \
648 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000649
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000650#define fold_trivial_usage \
651 "[bsw] [FILE]"
652#define fold_full_usage \
653 "Wrap input lines in each FILE (standard input by default), writing to\n" \
654 "standard output.\n\n" \
655 "Options:\n" \
656 "\t-b\tcount bytes rather than columns\n" \
657 "\t-s\tbreak at spaces\n" \
658 "\t-w\tuse WIDTH columns instead of 80\n"
659
Eric Andersen7e9276b2001-02-22 01:15:47 +0000660#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000661 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000662#define free_full_usage \
663 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000664#define free_example_usage \
665 "$ free\n" \
666 " total used free shared buffers\n" \
667 " Mem: 257628 248724 8904 59644 93124\n" \
668 " Swap: 128516 8404 120112\n" \
669 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000670
Eric Andersen7e9276b2001-02-22 01:15:47 +0000671#define freeramdisk_trivial_usage \
672 "DEVICE"
673#define freeramdisk_full_usage \
674 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000675#define freeramdisk_example_usage \
676 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000677
678#define fsck_minix_trivial_usage \
679 "[-larvsmf] /dev/name"
680#define fsck_minix_full_usage \
681 "Performs a consistency check for MINIX filesystems.\n\n" \
682 "Options:\n" \
683 "\t-l\tLists all filenames\n" \
684 "\t-r\tPerform interactive repairs\n" \
685 "\t-a\tPerform automatic repairs\n" \
686 "\t-v\tverbose\n" \
687 "\t-s\tOutputs super-block information\n" \
688 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
689 "\t-f\tForce file system check."
690
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000691#define ftpget_trivial_usage \
692 "[options] remote-host local-directory remote-file"
693#define ftpget_full_usage \
694 "Retrieve a remote file via FTP.\n\n" \
695 "Options:\n" \
696 "\t-c, --continue Continue a previous transfer\n" \
697 "\t-v, --verbose Verbose\n" \
698 "\t-u, --username Username to be used\n" \
699 "\t-p, --password Password to be used\n" \
700 "\t-P, --port Port number to be used\n"
701
702#define ftpput_trivial_usage \
703 "[options] remote-host remote-directory local-file"
704#define ftpput_full_usage \
705 "Store a local file on a remote machine via FTP.\n\n" \
706 "Options:\n" \
707 "\t-v, --verbose Verbose\n" \
708 "\t-u, --username Username to be used\n" \
709 "\t-p, --password Password to be used\n" \
710 "\t-P, --port Port number to be used\n"
711
Eric Andersen7e9276b2001-02-22 01:15:47 +0000712#define getopt_trivial_usage \
713 "[OPTIONS]..."
714#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000715 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000716 "\t-a, --alternative Allow long options starting with single -\n" \
717 "\t-l, --longoptions=longopts Long options to be recognized\n" \
718 "\t-n, --name=progname The name under which errors are reported\n" \
719 "\t-o, --options=optstring Short options to be recognized\n" \
720 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
721 "\t-Q, --quiet-output No normal output\n" \
722 "\t-s, --shell=shell Set shell quoting conventions\n" \
723 "\t-T, --test Test for getopt(1) version\n" \
724 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000725#define getopt_example_usage \
726 "$ cat getopt.test\n" \
727 "#!/bin/sh\n" \
728 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
729 " -n 'example.busybox' -- "$@"`\n" \
730 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
731 "eval set -- "$GETOPT"\n" \
732 "while true ; do\n" \
733 " case $1 in\n" \
734 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000735 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000736 " -c|--c-long)\n" \
737 " case "$2" in\n" \
738 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000739 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000740 " esac ;;\n" \
741 " --) shift ; break ;;\n" \
742 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
743 " esac\n" \
744 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000745
Eric Andersenf349e972001-08-21 16:18:59 +0000746#define getty_trivial_usage \
747 "getty [OPTIONS]... baud_rate,... line [termtype]"
748#define getty_full_usage \
749 "\nOpens a tty, prompts for a login name, then invokes /bin/login\n\n" \
750 "Options:\n" \
751 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
752 "\t-i\t\tDo not display /etc/issue before running login.\n" \
753 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
754 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
755 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
Glenn L McGrath49e74ef2003-05-13 14:59:07 +0000756 "\t-n\t\tDo not prompt the user for a login name.\n" \
757 "\t-f issue_file\tDisplay issue_file instead of /etc/issue.\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000758 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
759 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
760 "\t-I initstring\tSets the init string to send before anything else.\n" \
761 "\t-H login_host\tLog login_host into the utmp file as the hostname."
762
763
Eric Andersen7e9276b2001-02-22 01:15:47 +0000764#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000765 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000766#define grep_full_usage \
767 "Search for PATTERN in each FILE or standard input.\n\n" \
768 "Options:\n" \
769 "\t-H\tprefix output lines with filename where match was found\n" \
770 "\t-h\tsuppress the prefixing filename on output\n" \
771 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000772 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000773 "\t-n\tprint line number with output lines\n" \
774 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
775 "\t-v\tselect non-matching lines\n" \
776 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000777#define grep_example_usage \
778 "$ grep root /etc/passwd\n" \
779 "root:x:0:0:root:/root:/bin/bash\n" \
780 "$ grep ^[rR]oo. /etc/passwd\n" \
781 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000782
Eric Andersen7e9276b2001-02-22 01:15:47 +0000783#define gunzip_trivial_usage \
784 "[OPTION]... FILE"
785#define gunzip_full_usage \
786 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
787 "Options:\n" \
788 "\t-c\tWrite output to standard output\n" \
789 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000790#define gunzip_example_usage \
791 "$ ls -la /tmp/BusyBox*\n" \
792 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
793 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
794 "$ ls -la /tmp/BusyBox*\n" \
795 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000796
797#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000798 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000799#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000800 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000801 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000802 "Options:\n" \
803 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
804 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000805#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000806 "$ ls -la /tmp/busybox*\n" \
807 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
808 "$ gzip /tmp/busybox.tar\n" \
809 "$ ls -la /tmp/busybox*\n" \
810 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000811
812#define halt_trivial_usage \
813 ""
814#define halt_full_usage \
815 "Halt the system."
816
Eric Andersen3443bd72003-07-22 07:30:36 +0000817#ifdef CONFIG_FEATURE_HDPARM_GET_IDENTITY
818#define USAGE_HDPARM_IDENT(a) a
819#else
820#define USAGE_HDPARM_IDENT(a)
821#endif
822
823#ifdef CONFIG_FEATURE_HDPARM_HDIO_SCAN_HWIF
824#define USAGE_SCAN_HWIF(a) a
825#else
826#define USAGE_SCAN_HWIF(a)
827#endif
828
829#ifdef CONFIG_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF
830#define USAGE_UNREGISTER_HWIF(a) a
831#else
832#define USAGE_UNREGISTER_HWIF(a)
833#endif
834
835#ifdef CONFIG_FEATURE_HDPARM_HDIO_DRIVE_RESET
836#define USAGE_DRIVE_RESET(a) a
837#else
838#define USAGE_DRIVE_RESET(a)
839#endif
840
841#ifdef CONFIG_FEATURE_HDPARM_HDIO_TRISTATE_HWIF
842#define USAGE_TRISTATE_HWIF(a) a
843#else
844#define USAGE_TRISTATE_HWIF(a)
845#endif
846
Eric Andersen0a57a792003-08-06 08:57:35 +0000847#ifdef CONFIG_FEATURE_HDPARM_HDIO_GETSET_DMA
848#define USAGE_GETSET_DMA(a) a
849#else
850#define USAGE_GETSET_DMA(a)
851#endif
852
Eric Andersen3443bd72003-07-22 07:30:36 +0000853#define hdparm_trivial_usage \
854 "[options] [device] .."
855#define hdparm_full_usage \
856 "Options:" \
857 " -a get/set fs readahead\n" \
858 " -A set drive read-lookahead flag (0/1)\n" \
859 " -b get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
860 " -B set Advanced Power Management setting (1-255)\n" \
861 " -c get/set IDE 32-bit IO setting\n" \
862 " -C check IDE power mode status\n" \
Eric Andersen0a57a792003-08-06 08:57:35 +0000863 USAGE_GETSET_DMA(" -d get/set using_dma flag\n") \
Eric Andersen3443bd72003-07-22 07:30:36 +0000864 " -D enable/disable drive defect-mgmt\n" \
865 " -f flush buffer cache for device on exit\n" \
866 " -g display drive geometry\n" \
867 " -h display terse usage information\n" \
868 " -i display drive identification\n" \
869 USAGE_HDPARM_IDENT(" -I detailed/current information directly from drive\n") \
870 USAGE_HDPARM_IDENT(" -Istdin similar to -I, but wants /proc/ide/" "*" "/hd?/identify as input\n") \
871 " -k get/set keep_settings_over_reset flag (0/1)\n" \
872 " -K set drive keep_features_over_reset flag (0/1)\n" \
873 " -L set drive doorlock (0/1) (removable harddisks only)\n" \
874 " -m get/set multiple sector count\n" \
875 " -n get/set ignore-write-errors flag (0/1)\n" \
876 " -p set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
877 " -P set drive prefetch count\n" \
878 " -q change next setting quietly\n" \
879 " -Q get/set DMA tagged-queuing depth (if supported)\n" \
880 " -r get/set readonly flag (DANGEROUS to set)\n" \
881 USAGE_SCAN_HWIF(" -R register an IDE interface (DANGEROUS)\n") \
882 " -S set standby (spindown) timeout\n" \
883 " -t perform device read timings\n" \
884 " -T perform cache read timings\n" \
885 " -u get/set unmaskirq flag (0/1)\n" \
886 USAGE_UNREGISTER_HWIF(" -U un-register an IDE interface (DANGEROUS)\n") \
887 " -v defaults; same as -mcudkrag for IDE drives\n" \
888 " -V display program version and exit immediately\n" \
889 USAGE_DRIVE_RESET(" -w perform device reset (DANGEROUS)\n") \
890 " -W set drive write-caching flag (0/1) (DANGEROUS)\n" \
891 USAGE_TRISTATE_HWIF(" -x tristate device for hotswap (0/1) (DANGEROUS)\n") \
892 " -X set IDE xfer mode (DANGEROUS)\n" \
893 " -y put IDE drive in standby mode\n" \
894 " -Y put IDE drive to sleep\n" \
895 " -Z disable Seagate auto-powersaving mode\n" \
896 " -z re-read partition table\n"
897
Manuel Novoa III cad53642003-03-19 09:13:01 +0000898#ifdef CONFIG_FEATURE_FANCY_HEAD
899#define USAGE_FANCY_HEAD(a) a
900#else
901#define USAGE_FANCY_HEAD(a)
902#endif
903
Eric Andersen7e9276b2001-02-22 01:15:47 +0000904#define head_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000905 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000906#define head_full_usage \
907 "Print first 10 lines of each FILE to standard output.\n" \
908 "With more than one FILE, precede each with a header giving the\n" \
909 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000910 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000911 "\t-n NUM\t\tPrint first NUM lines instead of first 10" \
912 USAGE_FANCY_HEAD( \
913 "\n\t-c NUM\t\toutput the first NUM bytes\n" \
914 "\t-q\t\tnever output headers giving file names\n" \
915 "\t-v\t\talways output headers giving file names" )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000916#define head_example_usage \
917 "$ head -n 2 /etc/passwd\n" \
918 "root:x:0:0:root:/root:/bin/bash\n" \
919 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000920
Glenn L McGrath60281112001-11-02 11:39:46 +0000921#define hexdump_trivial_usage \
922 "[-[bcdefnosvx]] [OPTION] FILE"
923#define hexdump_full_usage \
924 "The hexdump utility is a filter which displays the specified files,\n" \
925 "or the standard input, if no files are specified, in a user specified\n"\
926 "format\n" \
927 "\t-b\t\tOne-byte octal display\n" \
928 "\t-c\t\tOne-byte character display\n" \
929 "\t-d\t\tTwo-byte decimal display\n" \
930 "\t-e FORMAT STRING\n" \
931 "\t-f FORMAT FILE\n" \
932 "\t-n LENGTH\tInterpret only length bytes of input\n" \
933 "\t-o\t\tTwo-byte octal display\n" \
934 "\t-s OFFSET\tSkip offset byte\n" \
935 "\t-v\t\tdisplay all input data\n" \
936 "\t-x\t\tTwo-byte hexadecimal display\n"
937
Eric Andersen7e9276b2001-02-22 01:15:47 +0000938#define hostid_trivial_usage \
939 ""
940#define hostid_full_usage \
941 "Print out a unique 32-bit identifier for the machine."
942
943#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000944 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000945#define hostname_full_usage \
946 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000947 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000948 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +0000949 "\t-s\tShort\n" \
950 "\t-i\tAddresses for the hostname\n" \
951 "\t-d\tDNS domain name\n" \
952 "\t-f\tFully qualified domain name\n" \
953 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000954#define hostname_example_usage \
955 "$ hostname\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000956 "sage \n"
Eric Andersen40520512003-07-28 09:59:05 +0000957
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000958#ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH
959 #define USAGE_HTTPD_BASIC_AUTH(a) a
Eric Andersen40520512003-07-28 09:59:05 +0000960 #ifdef CONFIG_FEATURE_HTTPD_AUTH_MD5
961 #define USAGE_HTTPD_AUTH_MD5(a) a
962 #else
963 #define USAGE_HTTPD_AUTH_MD5(a)
964 #endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000965#else
966 #define USAGE_HTTPD_BASIC_AUTH(a)
Eric Andersen40520512003-07-28 09:59:05 +0000967 #define USAGE_HTTPD_AUTH_MD5(a)
968#endif
969#ifdef CONFIG_FEATURE_HTTPD_USAGE_FROM_INETD_ONLY
970 #define USAGE_HTTPD_STANDALONE(a)
971 #define USAGE_HTTPD_SETUID(a)
972#else
973 #define USAGE_HTTPD_STANDALONE(a) a
974 #ifdef CONFIG_FEATURE_HTTPD_SETUID
975 #define USAGE_HTTPD_SETUID(a) a
976 #else
977 #define USAGE_HTTPD_SETUID(a)
978 #endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000979#endif
980#define httpd_trivial_usage \
Eric Andersen40520512003-07-28 09:59:05 +0000981 "[-c <conf file>]" \
982 USAGE_HTTPD_STANDALONE(" [-p <port>]") \
983 USAGE_HTTPD_SETUID(" [-u user]") \
984 USAGE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
985 USAGE_HTTPD_AUTH_MD5(" [-m pass]") \
986 " [-d/-e <string>]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000987#define httpd_full_usage \
988 "Listens for incoming http server requests.\n"\
989 "Options:\n" \
Eric Andersen40520512003-07-28 09:59:05 +0000990 "\t-c FILE\tSpecifies configuration file. (default httpd.conf)\n" \
991 USAGE_HTTPD_STANDALONE("\t-p PORT\tServer port (default 80)\n") \
992 USAGE_HTTPD_SETUID("\t-u USER\tSet uid to USER after listening privilegies port\n") \
993 USAGE_HTTPD_BASIC_AUTH("\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
994 USAGE_HTTPD_AUTH_MD5("\t-m PASS\tCrypt PASS with md5 algorithm\n") \
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000995 "\t-e STRING\tHtml encode STRING\n" \
Eric Andersen40520512003-07-28 09:59:05 +0000996 "\t-d STRING\tURL decode STRING"
997
Robert Griebl1cd04452002-07-21 16:50:49 +0000998#define hwclock_trivial_usage \
999 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
1000#define hwclock_full_usage \
1001 "Query and set the hardware clock (RTC)\n\n" \
1002 "Options:\n" \
1003 "\t-r\tread hardware clock and print result\n" \
1004 "\t-s\tset the system time from the hardware clock\n" \
1005 "\t-w\tset the hardware clock to the current system time\n" \
1006 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
1007 "\t-l\tthe hardware clock is kept in local time"
1008
Eric Andersen9e480452003-07-03 10:07:04 +00001009#ifdef CONFIG_SELINUX
1010#define USAGE_SELINUX(a, b) a
1011#else
1012#define USAGE_SELINUX(a, b) b
1013#endif
1014
Eric Andersen7e9276b2001-02-22 01:15:47 +00001015#define id_trivial_usage \
1016 "[OPTIONS]... [USERNAME]"
1017#define id_full_usage \
1018 "Print information for USERNAME or the current user\n\n" \
1019 "Options:\n" \
1020 "\t-g\tprints only the group ID\n" \
1021 "\t-u\tprints only the user ID\n" \
Eric Andersen9e480452003-07-03 10:07:04 +00001022 USAGE_SELINUX("\t-c\tprints only the security context\n", "") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001023 "\t-n\tprint a name instead of a number (with for -ug)\n" \
1024 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001025#define id_example_usage \
1026 "$ id\n" \
1027 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001028
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001029#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001030 #define USAGE_SIOCSKEEPALIVE(a) a
1031#else
1032 #define USAGE_SIOCSKEEPALIVE(a)
1033#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001034#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001035 #define USAGE_IFCONFIG_MII(a) a
1036#else
1037 #define USAGE_IFCONFIG_MII(a)
1038#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001039#ifdef CONFIG_FEATURE_IFCONFIG_HW
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001040 #define USAGE_IFCONFIG_HW(a) a
1041#else
1042 #define USAGE_IFCONFIG_HW(a)
1043#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001044#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001045 #define USAGE_IFCONFIG_OPT_A(a) a
1046#else
1047 #define USAGE_IFCONFIG_OPT_A(a)
1048#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +00001049#ifdef CONFIG_FEATURE_IPV6
1050 #define USAGE_IPV6(a) a
1051#else
1052 #define USAGE_IPV6(a)
1053#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001054
Eric Andersen7e9276b2001-02-22 01:15:47 +00001055#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001056 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001057#define ifconfig_full_usage \
1058 "configure a network interface\n\n" \
1059 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +00001060 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
1061 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001062 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001063 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001064 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001065 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
1066 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001067 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001068 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
1069 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001070 "\t[up|down] ..."
1071
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001072#define ifup_trivial_usage \
1073 "<-ahinv> <ifaces...>"
1074#define ifup_full_usage \
1075 "Usage: ifup <options> <ifaces...>\n\n" \
1076 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001077 "\t-h\tthis help\n" \
1078 "\t-a\tde/configure all interfaces automatically\n" \
1079 "\t-i FILE\tuse FILE for interface definitions\n" \
1080 "\t-n\tprint out what would happen, but don't do it\n" \
1081 "\t\t\t(note that this option doesn't disable mappings)\n" \
1082 "\t-v\tprint out what would happen before doing it\n" \
1083 "\t-m\tdon't run any mappings\n" \
1084 "\t-f\tforce de/configuration\n"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001085
1086#define ifdown_trivial_usage \
1087 "<-ahinv> <ifaces...>"
1088#define ifdown_full_usage \
1089 "Usage: ifdown <options> <ifaces...>\n\n" \
1090 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001091 "\t-h\tthis help\n" \
1092 "\t-a\tde/configure all interfaces automatically\n" \
1093 "\t-i FILE\tuse FILE for interface definitions\n" \
1094 "\t-n\tprint out what would happen, but don't do it\n" \
1095 "\t\t(note that this option doesn't disable mappings)\n" \
1096 "\t-v\tprint out what would happen before doing it\n" \
1097 "\t-m\tdon't run any mappings\n" \
1098 "\t-f\tforce de/configuration\n"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001099
Glenn L McGrath06e95652003-02-09 06:51:14 +00001100#define inetd_trivial_usage \
1101 "[-q len] [conf]"
1102#define inetd_full_usage \
1103 "Usage: [-q len] [conf]\n\n" \
1104 "Option:\n" \
1105 "\t-q\tSets the size of the socket listen queue to\n" \
1106 "the specified value. Default is 128."
1107
Eric Andersen7e9276b2001-02-22 01:15:47 +00001108#define init_trivial_usage \
1109 ""
1110#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001111 "Init is the parent of all processes."
1112#define init_notes_usage \
1113"This version of init is designed to be run only by the kernel.\n" \
1114"\n" \
1115"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
1116"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
1117"runlevels, use sysvinit.\n" \
1118"\n" \
1119"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
1120"it has the following default behavior:\n" \
1121"\n" \
1122" ::sysinit:/etc/init.d/rcS\n" \
1123" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001124" ::ctrlaltdel:/sbin/reboot\n" \
1125" ::shutdown:/sbin/swapoff -a\n" \
1126" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001127" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001128"\n" \
1129"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1130"\n" \
1131" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001132" tty3::askfirst:/bin/sh\n" \
1133" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001134"\n" \
1135"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1136"\n" \
1137" <id>:<runlevels>:<action>:<process>\n" \
1138"\n" \
1139" <id>: \n" \
1140"\n" \
1141" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1142" The id field is used by BusyBox init to specify the controlling tty for\n" \
1143" the specified process to run on. The contents of this field are\n" \
1144" appended to "/dev/" and used as-is. There is no need for this field to\n" \
1145" be unique, although if it isn't you may have strange results. If this\n" \
1146" field is left blank, the controlling tty is set to the console. Also\n" \
1147" note that if BusyBox detects that a serial console is in use, then only\n" \
1148" entries whose controlling tty is either the serial console or /dev/null\n" \
1149" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1150" stinkin' utmp.\n" \
1151"\n" \
1152" <runlevels>: \n" \
1153"\n" \
1154" The runlevels field is completely ignored.\n" \
1155"\n" \
1156" <action>: \n" \
1157"\n" \
1158" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001159" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001160"\n" \
1161" The available actions can be classified into two groups: actions\n" \
1162" that are run only once, and actions that are re-run when the specified\n" \
1163" process exits.\n" \
1164"\n" \
1165" Run only-once actions:\n" \
1166"\n" \
1167" 'sysinit' is the first item run on boot. init waits until all\n" \
1168" sysinit actions are completed before continuing. Following the\n" \
1169" completion of all sysinit actions, all 'wait' actions are run.\n" \
1170" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001171" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001172" therefore, init does not wait for them to complete. 'restart' is\n" \
1173" the action taken to restart the init process. By default this should\n" \
1174" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1175" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001176" actions are run when the system detects that someone on the system\n" \
1177" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1178" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1179" Finally the 'shutdown' action specifies the actions to taken when\n" \
1180" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1181" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001182"\n" \
1183" Run repeatedly actions:\n" \
1184"\n" \
1185" 'respawn' actions are run after the 'once' actions. When a process\n" \
1186" started with a 'respawn' action exits, init automatically restarts\n" \
1187" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1188" respawning out of control. The 'askfirst' actions acts just like\n" \
1189" respawn, except that before running the specified process it\n" \
1190" displays the line "Please press Enter to activate this console."\n" \
1191" and then waits for the user to press enter before starting the\n" \
1192" specified process. \n" \
1193"\n" \
1194" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1195" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001196" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001197"\n" \
1198" <process>: \n" \
1199"\n" \
1200" Specifies the process to be executed and it's command line.\n" \
1201"\n" \
1202"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001203"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001204" # This is run first except when booting in single-user mode.\n" \
1205" #\n" \
1206" ::sysinit:/etc/init.d/rcS\n" \
1207" \n" \
1208" # /bin/sh invocations on selected ttys\n" \
1209" #\n" \
1210" # Start an "askfirst" shell on the console (whatever that may be)\n" \
1211" ::askfirst:-/bin/sh\n" \
1212" # Start an "askfirst" shell on /dev/tty2-4\n" \
1213" tty2::askfirst:-/bin/sh\n" \
1214" tty3::askfirst:-/bin/sh\n" \
1215" tty4::askfirst:-/bin/sh\n" \
1216" \n" \
1217" # /sbin/getty invocations for selected ttys\n" \
1218" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001219" tty4::respawn:/sbin/getty 38400 tty4\n" \
1220" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001221" \n" \
1222" \n" \
1223" # Example of how to put a getty on a serial line (for a terminal)\n" \
1224" #\n" \
1225" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1226" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1227" #\n" \
1228" # Example how to put a getty on a modem line.\n" \
1229" #::respawn:/sbin/getty 57600 ttyS2\n" \
1230" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001231" # Stuff to do when restarting the init process\n" \
1232" ::restart:/sbin/init\n" \
1233" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001234" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001235" ::ctrlaltdel:/sbin/reboot\n" \
1236" ::shutdown:/bin/umount -a -r\n" \
1237" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001238
Eric Andersenbe65c352003-01-23 04:57:35 +00001239#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
1240 #define USAGE_INSMOD_MAP(a) a
1241#else
1242 #define USAGE_INSMOD_MAP(a)
1243#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001244#define insmod_trivial_usage \
1245 "[OPTION]... MODULE [symbol=value]..."
1246#define insmod_full_usage \
1247 "Loads the specified kernel modules into the kernel.\n\n" \
1248 "Options:\n" \
1249 "\t-f\tForce module to load into the wrong kernel version.\n" \
1250 "\t-k\tMake module autoclean-able.\n" \
1251 "\t-v\tverbose output\n" \
1252 "\t-L\tLock to prevent simultaneous loads of a module\n" \
Eric Andersenbe65c352003-01-23 04:57:35 +00001253 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout") \
1254 "\t-x\tdo not export externs\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001255
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001256#define install_trivial_usage \
1257 "[cgmops] [sources] <dest|directory>"
1258#define install_full_usage \
1259 "copy files and set attributes\n\n" \
1260 "Options:\n" \
1261 "\t-c\tcopy the file, default\n" \
1262 "\t-g\tset group ownership\n" \
1263 "\t-m\tset permission modes\n" \
1264 "\t-o\tset ownership\n" \
1265 "\t-p\tpreserve date\n" \
1266 "\t-s\tstrip symbol tables\n"
1267
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001268#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001269 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001270#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001271 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1272 "where OBJECT := { link | addr | route | tunnel }\n" \
1273 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }\n"
1274
1275#define ipaddr_trivial_usage \
1276 "{ {add|del} IFADDR dev STRING | {show|flush} [ dev STRING ] [ to PREFIX ] }"
1277#define ipaddr_full_usage \
1278 "ipaddr {add|del} IFADDR dev STRING\n" \
1279 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
1280 " [ to PREFIX ] [ label PATTERN ]\n" \
1281 "IFADDR := PREFIX | ADDR peer PREFIX\n" \
1282 " [ broadcast ADDR ] [ anycast ADDR ]\n" \
1283 " [ label STRING ] [ scope SCOPE-ID ]\n" \
1284 "SCOPE-ID := [ host | link | global | NUMBER ]\n"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001285
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001286#ifndef CONFIG_FEATURE_IPCALC_FANCY
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001287# define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001288 "[--broadcast] [--netmask] [--network] ipaddr <netmask>"
1289
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001290# define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001291 "Calculate IP network settings from a IP address\n\n" \
1292 "Options:\n" \
1293 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1294 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
1295 "\t-w\t--network\tDisplay calculated network address."
1296#else
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001297# define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001298 "[OPTION]... ipaddr <netmask>"
1299
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001300# define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001301 "Calculate IP network settings from a IP address\n\n" \
1302 "Options:\n" \
1303 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1304 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
1305 "\t-w\t--network\tDisplay calculated network address.\n" \
1306 "\t-h\t--hostname\tDisplay first resolved host name.\n" \
1307 "\t-s\t--silent\tDon't ever display error messages."
1308#endif
1309
1310#define ipcalc_notes_usage \
1311 "ipcalc provides a simple way to calculate IP information for\n" \
1312 "a host. The various options specify what information ipcalc\n" \
1313 "should display on standard out. Multiple options may be\n" \
1314 "specified.\n"
1315
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001316#define iplink_trivial_usage \
1317 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1318#define iplink_full_usage \
1319 "iplink set DEVICE { up | down | arp { on | off } |\n" \
1320 " dynamic { on | off } |\n" \
1321 " mtu MTU }\n" \
1322 "iplink show [ DEVICE ]\n"
1323
1324#define iproute_trivial_usage \
1325 "{ list | flush | { add | del | change | append | replace | monitor } ROUTE }"
1326#define iproute_full_usage \
1327 "iproute { list | flush } SELECTOR\n" \
1328 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
1329 " [ oif STRING ] [ tos TOS ]\n" \
1330 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
1331 "SELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1332 "ROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]\n"
1333
1334#define iptunnel_trivial_usage \
1335 "{ add | change | del | show } [ NAME ] [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
1336#define iptunnel_full_usage \
1337 "iptunnel { add | change | del | show } [ NAME ]\n" \
1338 " [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1339 " [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1340 " [ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]\n"
1341
Eric Andersen92fb9392003-08-08 20:09:03 +00001342#define insmod_ng_trivial_usage \
1343 "MODULE [symbol=value]..."
1344#define insmod_ng_full_usage \
1345 "Loads the specified kernel modules into the kernel."
1346
Eric Andersen7e9276b2001-02-22 01:15:47 +00001347#define kill_trivial_usage \
1348 "[-signal] process-id [process-id ...]"
1349#define kill_full_usage \
1350 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +00001351 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001352 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001353#define kill_example_usage \
1354 "$ ps | grep apache\n" \
1355 "252 root root S [apache]\n" \
1356 "263 www-data www-data S [apache]\n" \
1357 "264 www-data www-data S [apache]\n" \
1358 "265 www-data www-data S [apache]\n" \
1359 "266 www-data www-data S [apache]\n" \
1360 "267 www-data www-data S [apache]\n" \
1361 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001362
1363#define killall_trivial_usage \
1364 "[-signal] process-name [process-name ...]"
1365#define killall_full_usage \
1366 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001367 "Options:\n" \
1368 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001369#define killall_example_usage \
1370 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001371
Mark Whitley6317c4b2001-03-12 22:51:50 +00001372#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001373 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001374#define klogd_full_usage \
1375 "Kernel logger.\n"\
1376 "Options:\n"\
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001377 "\t-c n\tSets the default log level of console messages to n.\n"\
Mark Whitley6317c4b2001-03-12 22:51:50 +00001378 "\t-n\tRun as a foreground process."
1379
Eric Andersen7e9276b2001-02-22 01:15:47 +00001380#define length_trivial_usage \
1381 "STRING"
1382#define length_full_usage \
1383 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001384#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001385 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001386 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001387
1388#define ln_trivial_usage \
1389 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1390#define ln_full_usage \
1391 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
1392 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1393 "Options:\n" \
1394 "\t-s\tmake symbolic links instead of hard links\n" \
1395 "\t-f\tremove existing destination files\n" \
1396 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001397#define ln_example_usage \
1398 "$ ln -s BusyBox /tmp/ls\n" \
1399 "$ ls -l /tmp/ls\n" \
1400 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001401
1402#define loadacm_trivial_usage \
1403 "< mapfile"
1404#define loadacm_full_usage \
1405 "Loads an acm from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001406#define loadacm_example_usage \
1407 "$ loadacm < /etc/i18n/acmname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001408
1409#define loadfont_trivial_usage \
1410 "< font"
1411#define loadfont_full_usage \
1412 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001413#define loadfont_example_usage \
1414 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001415
1416#define loadkmap_trivial_usage \
1417 "< keymap"
1418#define loadkmap_full_usage \
1419 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001420#define loadkmap_example_usage \
1421 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001422
1423#define logger_trivial_usage \
1424 "[OPTION]... [MESSAGE]"
1425#define logger_full_usage \
1426 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1427 "Options:\n" \
1428 "\t-s\tLog to stderr as well as the system log.\n" \
1429 "\t-t\tLog using the specified tag (defaults to user name).\n" \
1430 "\t-p\tEnter the message with the specified priority.\n" \
1431 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001432#define logger_example_usage \
1433 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001434
Robert Griebl1fca5582002-06-04 20:45:46 +00001435#define login_trivial_usage \
1436 "[OPTION]... [username] [ENV=VAR ...]"
1437#define login_full_usage \
1438 "Begin a new session on the system\n\n" \
1439 "Options:\n" \
1440 "\t-f\tDo not authenticate (user already authenticated)\n" \
1441 "\t-h\tName of the remote host for this login.\n" \
1442 "\t-p\tPreserve environment."
1443
Eric Andersen7e9276b2001-02-22 01:15:47 +00001444#define logname_trivial_usage \
1445 ""
1446#define logname_full_usage \
1447 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001448#define logname_example_usage \
1449 "$ logname\n" \
1450 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001451
Mark Whitley6317c4b2001-03-12 22:51:50 +00001452#define logread_trivial_usage \
1453 ""
1454
1455#define logread_full_usage \
1456 "Shows the messages from syslogd (using circular buffer)."
1457
Matt Kraai83788da2002-03-20 17:38:37 +00001458#define losetup_trivial_usage \
1459 "[OPTION]... LOOPDEVICE FILE\n" \
1460 "or: losetup [OPTION]... -d LOOPDEVICE"
1461#define losetup_full_usage \
1462 "Associate LOOPDEVICE with FILE.\n\n" \
1463 "Options:\n" \
1464 "\t-d\t\tDisassociate LOOPDEVICE.\n" \
1465 "\t-o OFFSET\tStart OFFSET bytes into FILE.\n"
1466
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001467#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001468 #define USAGE_LS_TIMESTAMPS(a) a
1469#else
1470 #define USAGE_LS_TIMESTAMPS(a)
1471#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001472#ifdef CONFIG_FEATURE_LS_FILETYPES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001473 #define USAGE_LS_FILETYPES(a) a
1474#else
1475 #define USAGE_LS_FILETYPES(a)
1476#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001477#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001478 #define USAGE_LS_FOLLOWLINKS(a) a
1479#else
1480 #define USAGE_LS_FOLLOWLINKS(a)
1481#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001482#ifdef CONFIG_FEATURE_LS_RECURSIVE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001483 #define USAGE_LS_RECURSIVE(a) a
1484#else
1485 #define USAGE_LS_RECURSIVE(a)
1486#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001487#ifdef CONFIG_FEATURE_LS_SORTFILES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001488 #define USAGE_LS_SORTFILES(a) a
1489#else
1490 #define USAGE_LS_SORTFILES(a)
1491#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001492#ifdef CONFIG_FEATURE_AUTOWIDTH
Eric Andersen7e9276b2001-02-22 01:15:47 +00001493 #define USAGE_AUTOWIDTH(a) a
1494#else
1495 #define USAGE_AUTOWIDTH(a)
1496#endif
1497#define ls_trivial_usage \
Eric Andersen9e480452003-07-03 10:07:04 +00001498 "[-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 +00001499#define ls_full_usage \
1500 "List directory contents\n\n" \
1501 "Options:\n" \
1502 "\t-1\tlist files in a single column\n" \
1503 "\t-A\tdo not list implied . and ..\n" \
1504 "\t-a\tdo not hide entries starting with .\n" \
1505 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001506 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001507 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001508 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1509 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001510 "\t-i\tlist the i-node for each file\n" \
1511 "\t-l\tuse a long listing format\n" \
1512 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001513 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1514 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1515 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1516 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1517 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001518 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001519 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1520 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1521 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1522 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1523 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001524 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001525 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1526 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001527 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersenbccb3152003-07-03 10:19:20 +00001528 USAGE_SELINUX("\t-k\tprint security context\n\t-K\tprint security context in long format\n", ""))
Eric Andersen7e9276b2001-02-22 01:15:47 +00001529
1530#define lsmod_trivial_usage \
1531 ""
1532#define lsmod_full_usage \
1533 "List the currently loaded kernel modules."
1534
1535#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001536 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001537#define makedevs_full_usage \
1538 "Creates a range of block or character special files\n\n" \
1539 "TYPEs include:\n" \
1540 "\tb:\tMake a block (buffered) device.\n" \
1541 "\tc or u:\tMake a character (un-buffered) device.\n" \
1542 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1543 "FIRST specifies the number appended to NAME to create the first device.\n" \
1544 "LAST specifies the number of the last item that should be created.\n" \
1545 "If 's' is the last argument, the base device is created as well.\n\n" \
1546 "For example:\n" \
1547 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001548 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001549#define makedevs_example_usage \
1550 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
1551 "[creates ttyS2-ttyS63]\n" \
1552 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
1553 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001554
Eric Andersen7e9276b2001-02-22 01:15:47 +00001555#define md5sum_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001556 "[OPTION] [FILE]...\n" \
1557 "or: md5sum [OPTION] -c [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001558#define md5sum_full_usage \
1559 "Print or check MD5 checksums.\n\n" \
1560 "Options:\n" \
1561 "With no FILE, or when FILE is -, read standard input.\n\n" \
1562 "\t-b\tread files in binary mode\n" \
1563 "\t-c\tcheck MD5 sums against given list\n" \
1564 "\t-t\tread files in text mode (default)\n" \
1565 "\t-g\tread a string\n" \
1566 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001567 "\t-s\tdon't output anything, status code shows success\n" \
1568 "\t-w\twarn about improperly formated MD5 checksum lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001569#define md5sum_example_usage \
1570 "$ md5sum < busybox\n" \
1571 "6fd11e98b98a58f64ff3398d7b324003\n" \
1572 "$ md5sum busybox\n" \
1573 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1574 "$ md5sum -c -\n" \
1575 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1576 "busybox: OK\n" \
1577 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001578
Glenn L McGrath061c9002002-09-16 04:21:46 +00001579#define mesg_trivial_usage \
1580 "mesg [y|n]"
1581#define mesg_full_usage \
1582 "mesg [Y|N], controls write access to your terminal\n" \
1583 "\ty\tAllow write access to your terminal.\n" \
1584 "\tn\tDisallow write access to your terminal.\n"
1585
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001586#define minit_trivial_usage \
1587 "[-spPrRC]"
1588#define minit_full_usage \
1589 "[-spPrRC]"
1590
Eric Andersen7e9276b2001-02-22 01:15:47 +00001591#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001592 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001593#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001594 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001595 "Options:\n" \
1596 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001597 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001598#define mkdir_example_usage \
1599 "$ mkdir /tmp/foo\n" \
1600 "$ mkdir /tmp/foo\n" \
1601 "/tmp/foo: File exists\n" \
1602 "$ mkdir /tmp/foo/bar/baz\n" \
1603 "/tmp/foo/bar/baz: No such file or directory\n" \
1604 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001605
Eric Andersen7e9276b2001-02-22 01:15:47 +00001606#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001607 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001608#define mkfifo_full_usage \
1609 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1610 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001611 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001612
Eric Andersen7e9276b2001-02-22 01:15:47 +00001613#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001614 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001615#define mkfs_minix_full_usage \
1616 "Make a MINIX filesystem.\n\n" \
1617 "Options:\n" \
1618 "\t-c\t\tCheck the device for bad blocks\n" \
1619 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1620 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1621 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001622 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001623
Eric Andersen7e9276b2001-02-22 01:15:47 +00001624#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001625 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001626#define mknod_full_usage \
1627 "Create a special file (block, character, or pipe).\n\n" \
1628 "Options:\n" \
1629 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1630 "TYPEs include:\n" \
1631 "\tb:\tMake a block (buffered) device.\n" \
1632 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001633 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001634#define mknod_example_usage \
1635 "$ mknod /dev/fd0 b 2 0 \n" \
1636 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001637
Eric Andersen7e9276b2001-02-22 01:15:47 +00001638#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001639 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001640#define mkswap_full_usage \
1641 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001642 "Options:\n" \
1643 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001644 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001645 "\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 +00001646 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001647
Eric Andersen7e9276b2001-02-22 01:15:47 +00001648#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001649 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001650#define mktemp_full_usage \
1651 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001652 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001653#define mktemp_example_usage \
1654 "$ mktemp /tmp/temp.XXXXXX\n" \
1655 "/tmp/temp.mWiLjM\n" \
1656 "$ ls -la /tmp/temp.mWiLjM\n" \
1657 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001658
Eric Andersen8d79ce82001-07-22 23:00:15 +00001659#define modprobe_trivial_usage \
1660 "[FILE ...]"
1661#define modprobe_full_usage \
Eric Andersenabc95682002-07-03 02:52:35 +00001662 "Used for high level module loading and unloading."
Eric Andersen8d79ce82001-07-22 23:00:15 +00001663#define modprobe_example_usage \
1664 "$ modprobe cdrom\n"
1665
Eric Andersen7e9276b2001-02-22 01:15:47 +00001666#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001667 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001668#define more_full_usage \
1669 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001670#define more_example_usage \
1671 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001672
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001673#ifdef CONFIG_FEATURE_MOUNT_LOOP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001674 #define USAGE_MOUNT_LOOP(a) a
1675#else
1676 #define USAGE_MOUNT_LOOP(a)
1677#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001678#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001679 #define USAGE_MTAB(a) a
1680#else
1681 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001682#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001683#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001684 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001685#define mount_full_usage \
1686 "Mount a filesystem\n\n" \
1687 "Flags:\n" \
1688 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001689 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001690 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001691 "\t-n:\t\tDon't write a mount table entry.\n" \
1692 ) \
1693 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1694 "\t-r:\t\tMount the filesystem read-only.\n" \
1695 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1696 "\t-w:\t\tMount for reading and writing (default).\n" \
1697 "\n" \
1698 "Options for use with the \"-o\" flag:\n" \
1699 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1700 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1701 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1702 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001703 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001704 "\tloop:\t\tMounts a file via loop device.\n" \
1705 ) \
1706 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001707 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001708 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001709 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001710 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001711 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001712#define mount_example_usage \
1713 "$ mount\n" \
1714 "/dev/hda3 on / type minix (rw)\n" \
1715 "proc on /proc type proc (rw)\n" \
1716 "devpts on /dev/pts type devpts (rw)\n" \
1717 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1718 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001719
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001720#define msvc_trivial_usage \
1721 "-[udorspchaitkx] service"
Eric Andersen335816b2003-07-14 22:14:49 +00001722#define msvc_full_usage \
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001723 "[option] service\n" \
1724 "Where option is one of\n" \
1725 "\t-u\tUp. If the service is not running, start it. If the service stops, restart it.\n" \
1726 "\t-d\tDown. If the service is running, stop it, do not restart it.\n" \
1727 "\t-o\tOnce. If the service is not running, start it. Do not restart it if it stops.\n" \
1728 "\t-r\tTell supervise that the service is normally running; this affects status messages.\n" \
1729 "\t-s\tTell supervise that the service is normally stopped; this affects status messages.\n" \
1730 "\t-p\tPause. Send the service a STOP signal.\n" \
1731 "\t-c\tContinue. Send the service a CONT signal.\n" \
1732 "\t-h\tHangup. Send the service a HUP signal.\n" \
1733 "\t-a\tAlarm. Send the service an ALRM signal.\n" \
1734 "\t-i\tInterrupt. Send the service an INT signal.\n" \
1735 "\t-t\tTerminate. Send the service a TERM signal.\n" \
1736 "\t-k\tKill. Send the service a KILL signal.\n" \
1737 "\t-x\tExit. supervise will quit as soon as the service is down.\n"
1738
Eric Andersen7e9276b2001-02-22 01:15:47 +00001739#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001740 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001741#define mt_full_usage \
1742 "Control magnetic tape drive operation\n" \
1743 "\nAvailable Opcodes:\n\n" \
1744 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1745 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
Eric Andersen92fb9392003-08-08 20:09:03 +00001746 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001747 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001748
Eric Andersen7e9276b2001-02-22 01:15:47 +00001749#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001750 "SOURCE DEST\n" \
1751 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001752#define mv_full_usage \
1753 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001754#define mv_example_usage \
1755 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001756
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001757#define nameif_trivial_usage \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001758 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001759#define nameif_full_usage \
1760 "Nameif renaming network interface while it in the down state.\n\n" \
1761 "Options:\n" \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001762 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001763 "\t-s\t\tUse syslog (LOCAL0 facility).\n" \
1764 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address\n"
1765#define nameif_example_usage \
1766 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
1767 " or\n" \
1768 "$ nameif -c /etc/my_mactab_file\n" \
1769
Eric Andersen7e9276b2001-02-22 01:15:47 +00001770#define nc_trivial_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001771 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001772#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001773 "Netcat opens a pipe to IP:port\n\n" \
1774 "Options:\n" \
1775 "\t-l\t\tlisten mode, for inbound connects\n" \
1776 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00001777 "\t-i SECS\t\tdelay interval for lines sent\n" \
Eric Andersen00a6a752002-04-26 23:53:10 +00001778 "\t-e PROG\t\tprogram to exec after connect (dangerous!)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001779#define nc_example_usage \
1780 "$ nc foobar.somedomain.com 25\n" \
1781 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1782 "help\n" \
1783 "214-Commands supported:\n" \
1784 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1785 "214 NOOP QUIT RSET HELP\n" \
1786 "quit\n" \
1787 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001788
Eric Andersen1552ff72001-10-31 11:07:12 +00001789#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00001790 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00001791#define netstat_full_usage \
1792 "-l display listening server sockets\n" \
1793 "-a display all sockets (default: connected)\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001794 "-e display other/more information\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001795 "-n don't resolve names\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001796 "-r display routing table\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001797 "-t tcp sockets\n" \
1798 "-u udp sockets\n" \
1799 "-w raw sockets\n" \
1800 "-x unix sockets\n"
1801
Eric Andersen7e9276b2001-02-22 01:15:47 +00001802#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001803 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001804#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001805 "Queries the nameserver for the IP address of the given HOST\n" \
1806 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001807#define nslookup_example_usage \
1808 "$ nslookup localhost\n" \
1809 "Server: default\n" \
1810 "Address: default\n" \
1811 "\n" \
1812 "Name: debian\n" \
1813 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001814
Glenn L McGrath60281112001-11-02 11:39:46 +00001815#define od_trivial_usage \
1816 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
1817#define od_full_usage \
1818 "Write an unambiguous representation, octal bytes by default, of FILE\n"\
1819 "to standard output. With no FILE, or when FILE is -, read standard input."
1820
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00001821#define openvt_trivial_usage \
1822 "<vtnum> <COMMAND> [ARGS...]"
1823#define openvt_full_usage \
1824 "Start a command on a new virtual terminal"
1825#define openvt_example_usage \
1826 "openvt 2 /bin/ash\n"
1827
Eric Andersen27f64e12002-06-23 04:24:25 +00001828#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
1829 #define PASSWORD_ALG_TYPES(a) a
1830#else
1831 #define PASSWORD_ALG_TYPES(a)
1832#endif
1833#define passwd_trivial_usage \
1834 "[OPTION] [name]"
1835#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00001836 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00001837 "changes the password for the current user.\n" \
1838 "Options:\n" \
1839 "\t-a\tDefine which algorithm shall be used for the password.\n" \
1840 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001841 PASSWORD_ALG_TYPES(", sha1") \
Eric Andersen27f64e12002-06-23 04:24:25 +00001842 ")\n\t-d\tDelete the password for the specified user account.\n" \
1843 "\t-l\tLocks (disables) the specified user account.\n" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001844 "\t-u\tUnlocks (re-enables) the specified user account."
Eric Andersen27f64e12002-06-23 04:24:25 +00001845
Glenn L McGrath655d8142003-06-22 15:32:41 +00001846#define patch_trivial_usage \
1847 "[-p<num>]"
1848#define patch_full_usage \
1849 "[-p<num>]"
1850#define patch_example_usage \
1851 "$ patch -p1 <example.diff"
1852
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001853#define pidfilehack_trivial_usage \
1854 "[daemon.pid] [daemon]"
1855#define pidfilehack_full_usage \
1856 "service /var/run/daemon.pid /usr/sbin/daemon args...\n"
1857
Eric Andersen221b2ea2001-07-31 19:06:07 +00001858#define pidof_trivial_usage \
1859 "process-name [process-name ...]"
1860#define pidof_full_usage \
1861 "Lists the PIDs of all processes with names that match the names on the command line"
1862#define pidof_example_usage \
1863 "$ pidof init\n" \
1864 "1\n"
1865
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001866#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001867#define ping_trivial_usage "host"
1868#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1869#else
1870#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001871 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001872#define ping_full_usage \
1873 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1874 "Options:\n" \
1875 "\t-c COUNT\tSend only COUNT pings.\n" \
1876 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1877 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001878 "\t\t\tand when finished."
1879#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001880#define ping_example_usage \
1881 "$ ping localhost\n" \
1882 "PING slag (127.0.0.1): 56 data bytes\n" \
1883 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1884 "\n" \
1885 "--- debian ping statistics ---\n" \
1886 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1887 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001888
Eric Andersen51b8bd62002-07-03 11:46:38 +00001889#ifndef CONFIG_FEATURE_FANCY_PING6
1890#define ping6_trivial_usage "host"
1891#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1892#else
1893#define ping6_trivial_usage \
1894 "[OPTION]... host"
1895#define ping6_full_usage \
1896 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1897 "Options:\n" \
1898 "\t-c COUNT\tSend only COUNT pings.\n" \
1899 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1900 "\t-q\t\tQuiet mode, only displays output at start\n" \
1901 "\t\t\tand when finished."
1902#endif
1903#define ping6_example_usage \
1904 "$ ping6 ip6-localhost\n" \
1905 "PING ip6-localhost (::1): 56 data bytes\n" \
1906 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
1907 "\n" \
1908 "--- ip6-localhost ping statistics ---\n" \
1909 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1910 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
1911
Eric Andersen7e9276b2001-02-22 01:15:47 +00001912#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001913 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001914#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001915 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001916 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001917
Eric Andersen7e9276b2001-02-22 01:15:47 +00001918#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001919 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001920#define poweroff_full_usage \
1921 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001922
Eric Andersen7e9276b2001-02-22 01:15:47 +00001923#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001924 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001925#define printf_full_usage \
1926 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001927 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001928#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001929 "$ printf "Val=%d\\n" 5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001930 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001931
Eric Andersen7e9276b2001-02-22 01:15:47 +00001932#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001933 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001934#define ps_full_usage \
1935 "Report process status\n" \
Eric Andersen9e480452003-07-03 10:07:04 +00001936 USAGE_SELINUX("\nOptions:\n\t-c\tshow SE Linux context", "\nThis version of ps accepts no options.")
1937
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001938#define ps_example_usage \
1939 "$ ps\n" \
1940 " PID Uid Gid State Command\n" \
1941 " 1 root root S init\n" \
1942 " 2 root root S [kflushd]\n" \
1943 " 3 root root S [kupdate]\n" \
1944 " 4 root root S [kpiod]\n" \
1945 " 5 root root S [kswapd]\n" \
1946 " 742 andersen andersen S [bash]\n" \
1947 " 743 andersen andersen S -bash\n" \
1948 " 745 root root S [getty]\n" \
1949 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001950
Eric Andersen7e9276b2001-02-22 01:15:47 +00001951#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001952 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001953#define pwd_full_usage \
1954 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001955#define pwd_example_usage \
1956 "$ pwd\n" \
1957 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001958
Eric Andersen92fb9392003-08-08 20:09:03 +00001959#define raid_start_trivial_usage \
1960 "MD_DEVICE DISK_DEVICE"
1961#define raid_start_full_usage \
1962 "Start MD_DEVICE, taking superblock from DISK_DEVICE.\n" \
1963 "Example: raid_start /dev/md0 /dev/sdb"
1964
Eric Andersen7e9276b2001-02-22 01:15:47 +00001965#define rdate_trivial_usage \
Eric Andersen725db192003-07-22 08:26:05 +00001966 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001967#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001968 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001969 "Options:\n" \
1970 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001971 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001972
Eric Andersen7e9276b2001-02-22 01:15:47 +00001973#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001974 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001975#define readlink_full_usage \
1976 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001977
Glenn L McGrath62fae302002-12-10 00:14:33 +00001978#define realpath_trivial_usage \
1979 "pathname ..."
1980#define realpath_full_usage \
1981 "return the canonicalized absolute pathnames of given arguments\n\n"
1982
Eric Andersen7e9276b2001-02-22 01:15:47 +00001983#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001984 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001985#define reboot_full_usage \
1986 "Reboot the system."
1987
1988#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001989 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001990#define renice_full_usage \
1991 "Changes priority of running processes. Allowed priorities range\n" \
1992 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001993 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001994
Eric Andersen7e9276b2001-02-22 01:15:47 +00001995#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001996 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001997#define reset_full_usage \
1998 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001999
Eric Andersen7e9276b2001-02-22 01:15:47 +00002000#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002001 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002002#define rm_full_usage \
2003 "Remove (unlink) the FILE(s). You may use '--' to\n" \
2004 "indicate that all following arguments are non-options.\n\n" \
2005 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002006 "\t-i\t\talways prompt before removing each destination\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002007 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002008 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002009#define rm_example_usage \
2010 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002011
Eric Andersen7e9276b2001-02-22 01:15:47 +00002012#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002013 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002014#define rmdir_full_usage \
2015 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002016#define rmdir_example_usage \
2017 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002018
Eric Andersen7e9276b2001-02-22 01:15:47 +00002019#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002020 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002021#define rmmod_full_usage \
2022 "Unloads the specified kernel modules from the kernel.\n\n" \
2023 "Options:\n" \
Tim Rikercf932742002-12-14 01:58:59 +00002024 "\t-a\tRemove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002025#define rmmod_example_usage \
2026 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002027
Eric Andersen7e9276b2001-02-22 01:15:47 +00002028#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002029 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002030#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002031 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00002032 "Options:\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00002033 "\t-n\tDont resolve names.\n" \
2034 "\t-e\tDisplay other/more information"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002035
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002036#define rpm_trivial_usage \
2037 "-i -q[ildc]p package.rpm"
2038#define rpm_full_usage \
2039 "Manipulates RPM packages" \
Eric Andersendfce3532003-06-15 07:00:54 +00002040 "\n\nOptions:" \
2041 "\n\t-i Install package" \
2042 "\n\t-q Query package" \
2043 "\n\t-p Query uninstalled package" \
2044 "\n\t-i Show information" \
2045 "\n\t-l List contents" \
2046 "\n\t-d List documents" \
2047 "\n\t-c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002048
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002049#define rpm2cpio_trivial_usage \
2050 "package.rpm"
2051#define rpm2cpio_full_usage \
2052 "Outputs a cpio archive of the rpm file."
2053
Eric Andersen6cf47a72001-10-31 10:24:36 +00002054#define run_parts_trivial_usage \
2055 "[-t] [-a ARG] [-u MASK] DIRECTORY"
2056#define run_parts_full_usage \
2057 "Run a bunch of scripts in a directory.\n\n" \
2058 "Options:\n" \
2059 "\t-t\t\tTest only what file will be executed, without execute them.\n" \
2060 "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \
2061 "\t-u MASK\tSet the umask to MASK before executing every program."
2062
Eric Andersen7e9276b2001-02-22 01:15:47 +00002063#define sed_trivial_usage \
Matt Kraai075228a2001-06-21 14:40:55 +00002064 "[-nef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002065#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002066 "Options:\n" \
2067 "\t-n\t\tsuppress automatic printing of pattern space\n" \
2068 "\t-e script\tadd the script to the commands to be executed\n" \
2069 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002070 "\n" \
2071 "If no -e or -f is given, the first non-option argument is taken as the\n" \
2072 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002073 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002074#define sed_example_usage \
2075 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
2076 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002077
Eric Andersen7e9276b2001-02-22 01:15:47 +00002078#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002079 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002080#define setkeycodes_full_usage \
2081 "Set entries into the kernel's scancode-to-keycode map,\n" \
2082 "allowing unusual keyboards to generate usable keycodes.\n\n" \
2083 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002084 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002085#define setkeycodes_example_usage \
2086 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002087
Matt Kraai2d91deb2001-08-01 17:21:35 +00002088#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002089 "[FILE]...\n" \
2090 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00002091#define lash_full_usage \
Eric Andersen2e9c2572003-08-08 22:26:06 +00002092 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00002093#define lash_notes_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002094"This command does not yet have proper documentation.\n" \
2095"\n" \
2096"Use lash just as you would use any other shell. It properly handles pipes,\n" \
2097"redirects, job control, can be used as the shell for scripts, and has a\n" \
2098"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
2099"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
2100"use ash or bash. If you just need a very simple and extremely small shell,\n" \
2101"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002102
Eric Andersen2e9c2572003-08-08 22:26:06 +00002103#define last_trivial_usage \
2104 ""
2105#define last_full_usage \
2106 "Shows listing of the last users that logged into the system"
2107
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002108#define sha1sum_trivial_usage \
2109 "[OPTION] [FILE]"
2110#define sha1sum_full_usage \
2111 "[OPTION] [FILE]"
2112
Manuel Novoa III cad53642003-03-19 09:13:01 +00002113#ifdef CONFIG_FEATURE_FANCY_SLEEP
2114 #define USAGE_FANCY_SLEEP(a) a
2115 #define USAGE_NOT_FANCY_SLEEP(a)
2116#else
2117 #define USAGE_FANCY_SLEEP(a)
2118 #define USAGE_NOT_FANCY_SLEEP(a) a
2119#endif
2120
Eric Andersen7e9276b2001-02-22 01:15:47 +00002121#define sleep_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002122 USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002123#define sleep_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002124 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \
2125 USAGE_FANCY_SLEEP( \
2126"Pause for a time equal to the total of the args given, where each arg can\n" \
2127"have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002128#define sleep_example_usage \
2129 "$ sleep 2\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002130 "[2 second delay results]\n" \
2131 USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \
2132 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002133
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002134#ifdef CONFIG_FEATURE_SORT_UNIQUE
Mark Whitleyfccaa362001-04-17 18:56:18 +00002135 #define USAGE_SORT_UNIQUE(a) a
2136#else
2137 #define USAGE_SORT_UNIQUE(a)
2138#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002139#ifdef CONFIG_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002140 #define USAGE_SORT_REVERSE(a) a
2141#else
2142 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002143#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002144#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002145 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002146#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002147 "Sorts lines of text in the specified files\n\n"\
2148 "Options:\n" \
2149 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
2150 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
2151 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002152#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002153 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002154 "a\n" \
2155 "b\n" \
2156 "c\n" \
2157 "d\n" \
2158 "e\n" \
2159 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002160
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002161#define start_stop_daemon_trivial_usage \
2162 "[OPTIONS]"
2163#define start_stop_daemon_full_usage \
2164 "Program to start and stop services.\n"\
2165 "Options:\n" \
2166 "-S\t\t\tstart\n"\
2167 "-K\t\t\tstop\n"\
Eric Andersenfe5b1a92002-10-22 19:21:48 +00002168 "-b\t\t\tforce process into background (daemonize)\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002169 "-x <executable>\t\tprogram to start/check if it is running\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002170 "-u <username>|<uid>\tstop this user's processes\n"\
2171 "-n <process-name>\tstop processes with this name\n"\
2172 "-s <signal>\t\tsignal to send (default 15)\n"\
2173 "-a <pathname>\t\tprogram to start (default <executable>)\n"
2174
Eric Andersenef5e8f82002-11-07 02:09:37 +00002175#define strings_trivial_usage \
2176 "[-afo] [-n length] [file ... ]"
2177#define strings_full_usage \
2178 "Display printable strings in a binary file." \
2179 "\n\nOptions:" \
2180 "\n\t-f\tPrecede each string with the name of the file where it was found." \
2181 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
2182 "\n\t-o\tEach string is preceded by its decimal offset in the file."
2183
Eric Andersen7e9276b2001-02-22 01:15:47 +00002184#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002185 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002186#define stty_full_usage \
2187 "Without arguments, prints baud rate, line discipline," \
2188 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002189 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00002190 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002191 "\n\t-a\t\tprint all current settings in human-readable form" \
2192 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00002193 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002194
Robert Griebl1fca5582002-06-04 20:45:46 +00002195#define su_trivial_usage \
2196 "[OPTION]... [-] [username]"
2197#define su_full_usage \
2198 "Change user id or become root.\n" \
2199 "Options:\n" \
2200 "\t-p\tPreserve environment"
2201
Eric Andersen27f64e12002-06-23 04:24:25 +00002202#define sulogin_trivial_usage \
2203 "[OPTION]... [tty-device]"
2204#define sulogin_full_usage \
2205 "Single user login\n" \
2206 "Options:\n" \
2207 "\t-f\tDo not authenticate (user already authenticated)\n" \
2208 "\t-h\tName of the remote host for this login.\n" \
2209 "\t-p\tPreserve environment."
2210
Eric Andersen7e9276b2001-02-22 01:15:47 +00002211#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002212 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002213#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002214 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002215 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002216 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002217
Eric Andersen7e9276b2001-02-22 01:15:47 +00002218#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002219 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002220#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002221 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002222 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002223 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002224
Eric Andersen7e9276b2001-02-22 01:15:47 +00002225#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002226 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002227#define sync_full_usage \
2228 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002229
Eric Andersen7e9276b2001-02-22 01:15:47 +00002230
Eric Andersen29c77f72003-10-09 09:43:18 +00002231#ifdef CONFIG_FEATURE_ROTATE_LOGFILE
2232 #define USAGE_ROTATE_LOGFILE(a) a
2233#else
2234 #define USAGE_ROTATE_LOGFILE(a)
2235#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002236#ifdef CONFIG_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00002237 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002238#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00002239 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002240#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00002241#ifdef CONFIG_FEATURE_IPC_SYSLOG
2242 #define USAGE_IPC_LOG(a) a
2243#else
2244 #define USAGE_IPC_LOG(a)
2245#endif
2246
Eric Andersen7e9276b2001-02-22 01:15:47 +00002247#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002248 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002249#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002250 "Linux system and kernel logging utility.\n" \
2251 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002252 "Options:\n" \
2253 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
2254 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002255 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen29c77f72003-10-09 09:43:18 +00002256 USAGE_ROTATE_LOGFILE( \
2257 "\n\t-s SIZE\t\tMax size (KB) bevor rotate (default=200KB, 0=off)\n" \
2258 "\t-b NUM\t\tNumber of rotated log files (default=1, 0=purge log)") \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002259 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00002260 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00002261 "\t-L\t\tLog locally and via network logging (default is network only)") \
2262 USAGE_IPC_LOG( \
2263 "\n\t-C\t\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002264#define syslogd_example_usage \
2265 "$ syslogd -R masterlog:514\n" \
2266 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002267
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002268
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002269#ifndef CONFIG_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00002270 #define USAGE_UNSIMPLE_TAIL(a)
2271#else
2272 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002273#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002274#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002275 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002276#define tail_full_usage \
2277 "Print last 10 lines of each FILE to standard output.\n" \
2278 "With more than one FILE, precede each with a header giving the\n" \
2279 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
2280 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002281 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002282 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
2283 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002284 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002285 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
2286 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002287 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002288 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002289 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
2290#define tail_example_usage \
2291 "$ tail -n 1 /etc/resolv.conf\n" \
2292 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002293
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002294#ifdef CONFIG_FEATURE_TAR_CREATE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002295 #define USAGE_TAR_CREATE(a) a
2296#else
2297 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002298#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002299#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002300 #define USAGE_TAR_EXCLUDE(a) a
2301#else
2302 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002303#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002304#ifdef CONFIG_FEATURE_TAR_GZIP
2305 #define USAGE_TAR_GZIP(a) a
2306#else
2307 #define USAGE_TAR_GZIP(a)
2308#endif
2309#ifdef CONFIG_FEATURE_TAR_BZIP2
2310 #define USAGE_TAR_BZIP2(a) a
2311#else
2312 #define USAGE_TAR_BZIP2(a)
2313#endif
2314
Eric Andersen7e9276b2001-02-22 01:15:47 +00002315#define tar_trivial_usage \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002316 "-[" USAGE_TAR_CREATE("c") USAGE_TAR_GZIP("z") USAGE_TAR_BZIP2("j") "xtvO] " \
Eric Andersen317827d2001-05-21 17:50:53 +00002317 USAGE_TAR_EXCLUDE("[--exclude FILE] [-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00002318 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002319#define tar_full_usage \
2320 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00002321 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002322 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002323 "\tx\t\textract\n" \
2324 "\tt\t\tlist\n" \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002325 "\nArchive format selection:\n" \
2326 USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
2327 USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002328 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002329 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002330 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002331 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002332 "\texclude\t\tfile to exclude\n" \
2333 "\tX\t\tfile with names to exclude\n" \
2334 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00002335 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002336 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002337#define tar_example_usage \
2338 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
2339 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002340
Eric Andersen7e9276b2001-02-22 01:15:47 +00002341#define tee_trivial_usage \
2342 "[OPTION]... [FILE]..."
2343#define tee_full_usage \
2344 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002345 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002346 "\t-a\tappend to the given FILEs, do not overwrite\n" \
2347 "\t-i\tignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002348#define tee_example_usage \
2349 "$ echo "Hello" | tee /tmp/foo\n" \
2350 "$ cat /tmp/foo\n" \
2351 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002352
Eric Andersen7e9276b2001-02-22 01:15:47 +00002353#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002354 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002355#define telnet_full_usage \
2356 "Telnet is used to establish interactive communication with another\n"\
2357 "computer over a network using the TELNET protocol."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002358
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002359#ifdef CONFIG_FEATURE_TELNETD_INETD
2360#define telnetd_trivial_usage \
2361 "(inetd mode) [OPTION]"
2362#define telnetd_full_usage \
2363 "Telnetd uses incoming TELNET connections via inetd.\n"\
2364 "Options:\n" \
2365 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
2366#else
Eric Andersen08a72202002-09-30 20:52:10 +00002367#define telnetd_trivial_usage \
2368 "[OPTION]"
2369#define telnetd_full_usage \
2370 "Telnetd listens for incoming TELNET connections on PORT.\n"\
2371 "Options:\n" \
2372 "\t-p PORT\tlisten for connections on PORT (default 23)\n"\
2373 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002374#endif
Eric Andersen08a72202002-09-30 20:52:10 +00002375
Eric Andersen7e9276b2001-02-22 01:15:47 +00002376#define test_trivial_usage \
2377 "EXPRESSION\n or [ EXPRESSION ]"
2378#define test_full_usage \
2379 "Checks file types and compares values returning an exit\n" \
2380 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002381#define test_example_usage \
2382 "$ test 1 -eq 2\n" \
2383 "$ echo $?\n" \
2384 "1\n" \
2385 "$ test 1 -eq 1\n" \
2386 "$ echo $? \n" \
2387 "0\n" \
2388 "$ [ -d /etc ]\n" \
2389 "$ echo $?\n" \
2390 "0\n" \
2391 "$ [ -d /junk ]\n" \
2392 "$ echo $?\n" \
2393 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002394
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002395#ifdef CONFIG_FEATURE_TFTP_GET
Mark Whitley450736c2001-03-02 19:08:50 +00002396 #define USAGE_TFTP_GET(a) a
2397#else
2398 #define USAGE_TFTP_GET(a)
2399#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002400#ifdef CONFIG_FEATURE_TFTP_PUT
Mark Whitley450736c2001-03-02 19:08:50 +00002401 #define USAGE_TFTP_PUT(a) a
2402#else
2403 #define USAGE_TFTP_PUT(a)
2404#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002405#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Glenn L McGrathad117d82001-10-05 04:40:37 +00002406 #define USAGE_TFTP_BS(a) a
2407#else
2408 #define USAGE_TFTP_BS(a)
2409#endif
Mark Whitley450736c2001-03-02 19:08:50 +00002410
2411#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00002412 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00002413#define tftp_full_usage \
2414 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00002415 "Options:\n" \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002416 "\t-l FILE\tLocal FILE.\n" \
2417 "\t-r FILE\tRemote FILE.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002418 USAGE_TFTP_GET( \
Matt Kraai3be34302001-09-21 14:42:30 +00002419 "\t-g\tGet file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002420 ) \
2421 USAGE_TFTP_PUT( \
Matt Kraai3be34302001-09-21 14:42:30 +00002422 "\t-p\tPut file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002423 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002424 USAGE_TFTP_BS( \
2425 "\t-b SIZE\tTransfer blocks of SIZE octets.\n" \
2426 )
Eric Andersenc3657422001-11-30 07:54:32 +00002427#define time_trivial_usage \
2428 "[OPTION]... COMMAND [ARGS...]"
2429#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00002430 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
2431 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00002432 "Options:\n" \
2433 "\t-v\tDisplays verbose resource usage information."
Mark Whitley450736c2001-03-02 19:08:50 +00002434
Eric Andersen420b2082002-09-17 22:14:58 +00002435#define top_trivial_usage \
2436 "[-d <seconds>]"
2437#define top_full_usage \
2438 "top provides an view of processor activity in real time.\n" \
2439 "This utility reads the status for all processes in /proc each <seconds>\n" \
2440 "and shows the status for however many processes will fit on the screen.\n" \
2441 "This utility will not show processes that are started after program startup,\n" \
2442 "but it will show the EXIT status for and PIDs that exit while it is running."
2443
Eric Andersen7e9276b2001-02-22 01:15:47 +00002444#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002445 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002446#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002447 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002448 "Options:\n" \
2449 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002450#define touch_example_usage \
2451 "$ ls -l /tmp/foo\n" \
2452 "/bin/ls: /tmp/foo: No such file or directory\n" \
2453 "$ touch /tmp/foo\n" \
2454 "$ ls -l /tmp/foo\n" \
2455 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002456
2457#define tr_trivial_usage \
2458 "[-cds] STRING1 [STRING2]"
2459#define tr_full_usage \
2460 "Translate, squeeze, and/or delete characters from\n" \
2461 "standard input, writing to standard output.\n\n" \
2462 "Options:\n" \
2463 "\t-c\ttake complement of STRING1\n" \
2464 "\t-d\tdelete input characters coded STRING1\n" \
2465 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002466#define tr_example_usage \
2467 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
2468 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002469
Eric Andersen5c58d282001-07-10 16:29:00 +00002470#define traceroute_trivial_usage \
2471 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n\
2472 [-s src_addr] [-t tos] [-w wait] host [data size]"
2473#define traceroute_full_usage \
2474 "trace the route ip packets follow going to \"host\"\n" \
2475 "Options:\n" \
2476 "\t-d\tset SO_DEBUG options to socket\n" \
2477 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
2478 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
2479 "\t-v\tVerbose output\n" \
2480 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
2481 "\t-p port#\tSet the base UDP port number used in probes\n" \
2482 "\t\t(default is 33434)\n" \
2483 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
2484 "\t\t(default is 3)\n" \
2485 "\t-s src_addr\tUse the following IP address as the source address\n" \
2486 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
2487 "\t\t(default 0)\n" \
2488 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
2489 "\t\t(default 3 sec.)."
2490
2491
Eric Andersen7e9276b2001-02-22 01:15:47 +00002492#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002493 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002494#define true_full_usage \
2495 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002496#define true_example_usage \
2497 "$ true\n" \
2498 "$ echo $?\n" \
2499 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002500
Eric Andersen7e9276b2001-02-22 01:15:47 +00002501#define tty_trivial_usage \
2502 ""
2503#define tty_full_usage \
2504 "Print the file name of the terminal connected to standard input.\n\n"\
2505 "Options:\n" \
2506 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002507#define tty_example_usage \
2508 "$ tty\n" \
2509 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002510
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002511#define udhcpc_trivial_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00002512 "[-fbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002513#define udhcpc_full_usage \
2514 "\t-c,\t--clientid=CLIENTID\tClient identifier\n" \
2515 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00002516 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002517 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00002518 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated.\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002519 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
2520 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated.\n" \
2521 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
2522 "\t-q,\t--quit\tQuit after obtaining lease\n" \
2523 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
2524 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
2525 "\t-v,\t--version\tDisplay version"
2526
Russ Dill61fb4892002-10-14 21:41:28 +00002527#define udhcpd_trivial_usage \
2528 "[configfile]\n" \
2529
2530#define udhcpd_full_usage \
Glenn L McGrath9130c852002-12-12 12:56:18 +00002531 ""
Russ Dill61fb4892002-10-14 21:41:28 +00002532
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002533#ifdef CONFIG_FEATURE_MOUNT_FORCE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002534 #define USAGE_MOUNT_FORCE(a) a
2535#else
2536 #define USAGE_MOUNT_FORCE(a)
2537#endif
2538#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002539 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002540#define umount_full_usage \
2541 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00002542 "\nFlags:\n" "\t-a\tUnmount all file systems" \
2543 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
2544 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00002545 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00002546 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 +00002547#define umount_example_usage \
2548 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002549
2550#define uname_trivial_usage \
2551 "[OPTION]..."
2552#define uname_full_usage \
2553 "Print certain system information. With no OPTION, same as -s.\n\n" \
2554 "Options:\n" \
2555 "\t-a\tprint all information\n" \
2556 "\t-m\tthe machine (hardware) type\n" \
2557 "\t-n\tprint the machine's network node hostname\n" \
2558 "\t-r\tprint the operating system release\n" \
2559 "\t-s\tprint the operating system name\n" \
2560 "\t-p\tprint the host processor type\n" \
2561 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002562#define uname_example_usage \
2563 "$ uname -a\n" \
2564 "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002565
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00002566#define uncompress_trivial_usage \
2567 "[-c] [-f] [ name ... ]"
2568#define uncompress_full_usage \
2569 "Uncompress .Z file[s]\n" \
2570 "Options:\n" \
2571 "\t-c\textract to stdout\n" \
2572 "\t-f\tforce overwrite an existing file\n"
2573
Eric Andersen7e9276b2001-02-22 01:15:47 +00002574#define uniq_trivial_usage \
2575 "[OPTION]... [INPUT [OUTPUT]]"
2576#define uniq_full_usage \
2577 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00002578 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002579 "Options:\n" \
2580 "\t-c\tprefix lines by the number of occurrences\n" \
2581 "\t-d\tonly print duplicate lines\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002582 "\t-u\tonly print unique lines\n" \
2583 "\t-f N\tskip the first N fields\n" \
2584 "\t-s N\tskip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002585#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002586 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002587 "a\n" \
2588 "b\n" \
2589 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002590
2591#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002592 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002593#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002594 "Converts FILE from unix format to dos format. When no option\n" \
2595 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002596 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002597 "Options:\n" \
2598 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002599 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002600
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002601#define unzip_trivial_usage \
2602 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
2603#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002604 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002605 "Options:\n" \
2606 "\t-l\tlist archive contents (short form)\n" \
2607 "\t-n\tnever overwrite existing files (default)\n" \
2608 "\t-o\toverwrite files without prompting\n" \
2609 "\t-p\tsend output to stdout\n" \
2610 "\t-q\tbe quiet\n" \
2611 "\t-x\texclude these files\n" \
2612 "\t-d\textract files into this directory"
2613
Eric Andersen7e9276b2001-02-22 01:15:47 +00002614#define uptime_trivial_usage \
2615 ""
2616#define uptime_full_usage \
2617 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002618#define uptime_example_usage \
2619 "$ uptime\n" \
2620 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002621
2622#define usleep_trivial_usage \
2623 "N"
2624#define usleep_full_usage \
2625 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002626#define usleep_example_usage \
2627 "$ usleep 1000000\n" \
2628 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002629
2630#define uudecode_trivial_usage \
2631 "[FILE]..."
2632#define uudecode_full_usage \
2633 "Uudecode a file that is uuencoded.\n\n" \
2634 "Options:\n" \
Eric Andersen704b2c22001-03-16 08:06:30 +00002635 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002636#define uudecode_example_usage \
2637 "$ uudecode -o busybox busybox.uu\n" \
2638 "$ ls -l busybox\n" \
2639 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002640
2641#define uuencode_trivial_usage \
2642 "[OPTION] [INFILE] REMOTEFILE"
2643#define uuencode_full_usage \
2644 "Uuencode a file.\n\n" \
2645 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00002646 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002647#define uuencode_example_usage \
2648 "$ uuencode busybox busybox\n" \
2649 "begin 755 busybox\n" \
2650 "<encoded file snipped>\n" \
2651 "$ uudecode busybox busybox > busybox.uu\n" \
2652 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002653
Eric Andersen853c4942003-01-23 05:59:32 +00002654#define vconfig_trivial_usage \
2655 "COMMAND [OPTIONS] ..."
2656
2657#define vconfig_full_usage \
2658"Usage: add [interface-name] [vlan_id] \n" \
2659" rem [vlan-name] \n" \
2660" set_flag [interface-name] [flag-num] [0 | 1] \n" \
2661" set_egress_map [vlan-name] [skb_priority] [vlan_qos] \n" \
2662" set_ingress_map [vlan-name] [skb_priority] [vlan_qos] \n" \
2663" set_name_type [name-type] \n"
2664
Eric Andersen3f980402001-04-04 17:31:15 +00002665#define vi_trivial_usage \
2666 "[OPTION] [FILE]..."
2667#define vi_full_usage \
2668 "edit FILE.\n\n" \
2669 "Options:\n" \
2670 "\t-R\tRead-only- do not write to the file."
2671
Eric Andersen27f64e12002-06-23 04:24:25 +00002672#define vlock_trivial_usage \
2673 "[OPTIONS]"
2674#define vlock_full_usage \
2675 "Lock a virtual terminal. A password is required to unlock\n" \
2676 "Options:\n" \
2677 "\t-a\tLock all VTs"
2678
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002679#define watch_trivial_usage \
2680 "[-n <seconds>] COMMAND..."
2681#define watch_full_usage \
2682 "Executes a program periodically.\n" \
2683 "Options:\n" \
2684 "\t-n\tLoop period in seconds - default is 2."
2685#define watch_example_usage \
2686 "$ watch date\n" \
2687 "Mon Dec 17 10:31:40 GMT 2000\n" \
2688 "Mon Dec 17 10:31:42 GMT 2000\n" \
2689 "Mon Dec 17 10:31:44 GMT 2000"
2690
Eric Andersen7e9276b2001-02-22 01:15:47 +00002691#define watchdog_trivial_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00002692 "[-t <seconds>] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002693#define watchdog_full_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00002694 "Periodically write to watchdog device DEV.\n" \
2695 "Options:\n" \
2696 "\t-t\tTimer period in seconds - default is 30."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002697
2698#define wc_trivial_usage \
2699 "[OPTION]... [FILE]..."
2700#define wc_full_usage \
2701 "Print line, word, and byte counts for each FILE, and a total line if\n" \
2702 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
2703 "Options:\n" \
2704 "\t-c\tprint the byte counts\n" \
2705 "\t-l\tprint the newline counts\n" \
2706 "\t-L\tprint the length of the longest line\n" \
2707 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002708#define wc_example_usage \
2709 "$ wc /etc/passwd\n" \
2710 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002711
2712#define wget_trivial_usage \
Robert Griebld7760112002-05-14 23:36:45 +00002713 "[-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 +00002714#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00002715 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002716 "Options:\n" \
2717 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00002718 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00002719 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00002720 "\t-O\tsave to filename ('-' for stdout)\n" \
2721 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002722
2723#define which_trivial_usage \
2724 "[COMMAND ...]"
2725#define which_full_usage \
2726 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002727#define which_example_usage \
2728 "$ which login\n" \
2729 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00002730
Eric Andersen00a6a752002-04-26 23:53:10 +00002731#define who_trivial_usage \
2732 " "
2733#define who_full_usage \
2734 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002735
2736#define whoami_trivial_usage \
2737 ""
2738#define whoami_full_usage \
2739 "Prints the user name associated with the current effective user id."
2740
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002741#ifdef CONFIG_FEATURE_XARGS_SUPPORT_CONFIRMATION
2742#define USAGE_XARGS_CONFIRMATION(a) a
2743#else
2744#define USAGE_XARGS_CONFIRMATION(a)
2745#endif
2746#ifdef CONFIG_FEATURE_XARGS_SUPPORT_TERMOPT
2747#define USAGE_XARGS_TERMOPT(a) a
2748#else
2749#define USAGE_XARGS_TERMOPT(a)
2750#endif
2751#ifdef CONFIG_FEATURE_XARGS_SUPPORT_ZERO_TERM
2752#define USAGE_XARGS_ZERO_TERM(a) a
2753#else
2754#define USAGE_XARGS_ZERO_TERM(a)
2755#endif
2756
2757
Eric Andersen7e9276b2001-02-22 01:15:47 +00002758#define xargs_trivial_usage \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002759 "[COMMAND] [OPTIONS] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002760#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002761 "Executes COMMAND on every item given by standard input.\n\n" \
2762 "Options:\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002763 USAGE_XARGS_CONFIRMATION("\t-p\tPrompt the user about whether to run each command\n") \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002764 "\t-r\tDo not run command for empty readed lines\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002765 USAGE_XARGS_TERMOPT("\t-x\tExit if the size is exceeded\n") \
2766 USAGE_XARGS_ZERO_TERM("\t-0\tInput filenames are terminated by a null character\n") \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002767 "\t-t\tPrint the command line on stderr before executing it."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002768#define xargs_example_usage \
2769 "$ ls | xargs gzip\n" \
2770 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002771
2772#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002773 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002774#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002775 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002776
Eric Andersen7e9276b2001-02-22 01:15:47 +00002777#define zcat_trivial_usage \
2778 "FILE"
2779#define zcat_full_usage \
2780 "Uncompress to stdout."