blob: ba8fdde84895b21c9b466b6ef9d3bd0f3e7f6f20 [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" \
283 "following operations: +, -, /, *, and, or, not, eor.\n" \
Glenn L McGrath6d074322002-12-12 10:31:53 +0000284 "i.e., 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16" \
285 "p - Prints the value on the top of the stack, without altering the stack.\n" \
286 "f - Prints the entire contents of the stack without altering anything.\n" \
287 "o - Pops the value off the top of the stack and uses it to set the output radix.\n" \
288 " Only 10 and 16 are supported.\n"
289
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000290#define dc_example_usage \
291 "$ dc 2 2 +\n" \
292 "4\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000293 "$ dc 8 8 * 2 2 + /\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000294 "16\n" \
295 "$ dc 0 1 and\n" \
296 "0\n" \
297 "$ dc 0 1 or\n" \
298 "1\n" \
299 "$ echo 72 9 div 8 mul | dc\n" \
300 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000301
Eric Andersen7e9276b2001-02-22 01:15:47 +0000302#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000303 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000304 "\t [seek=N] [conv=notrunc|noerror|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000305#define dd_full_usage \
306 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000307 "\tif=FILE\t\tread from FILE instead of stdin\n" \
308 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
309 "\tbs=N\t\tread and write N bytes at a time\n" \
310 "\tcount=N\t\tcopy only N input blocks\n" \
311 "\tskip=N\t\tskip N input blocks\n" \
312 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000313 "\tconv=notrunc\tdon't truncate output file\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000314 "\tconv=noerror\tcontinue after read errors\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000315 "\tconv=sync\tpad blocks with zeros\n" \
316 "\n" \
317 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000318 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000319#define dd_example_usage \
320 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
321 "4+0 records in\n" \
322 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000323
Eric Andersen7e9276b2001-02-22 01:15:47 +0000324#define deallocvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000325 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000326#define deallocvt_full_usage \
327 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000328
Eric Andersenf349e972001-08-21 16:18:59 +0000329#define delgroup_trivial_usage \
330 "GROUP"
331#define delgroup_full_usage \
332 "Deletes group GROUP from the system"
333
334#define deluser_trivial_usage \
335 "USER"
336#define deluser_full_usage \
337 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000338
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000339#ifdef CONFIG_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000340 #define USAGE_HUMAN_READABLE(a) a
341 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000342#else
Eric Andersened0d9582001-02-23 13:23:03 +0000343 #define USAGE_HUMAN_READABLE(a)
344 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000345#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000346#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000347 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000348#define df_full_usage \
349 "Print the filesystem space used and space available.\n\n" \
350 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000351 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000352 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
353 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000354 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000355 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000356#define df_example_usage \
357 "$ df\n" \
358 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
359 "/dev/sda3 8690864 8553540 137324 98% /\n" \
360 "/dev/sda1 64216 36364 27852 57% /boot\n" \
361 "$ df /dev/sda3\n" \
362 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
363 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000364
Eric Andersen7e9276b2001-02-22 01:15:47 +0000365#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000366 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000367#define dirname_full_usage \
368 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000369#define dirname_example_usage \
370 "$ dirname /tmp/foo\n" \
371 "/tmp\n" \
372 "$ dirname /tmp/foo/\n" \
373 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000374
Eric Andersen7e9276b2001-02-22 01:15:47 +0000375#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000376 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000377#define dmesg_full_usage \
378 "Prints or controls the kernel ring buffer\n\n" \
379 "Options:\n" \
380 "\t-c\t\tClears the ring buffer's contents after printing\n" \
381 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000382 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000383
Eric Andersen7e9276b2001-02-22 01:15:47 +0000384#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000385 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000386#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000387 "Converts FILE from dos format to unix format. When no option\n" \
388 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000389 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000390 "Options:\n" \
391 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000392 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000393
Eric Andersen7e9276b2001-02-22 01:15:47 +0000394#define dpkg_trivial_usage \
Eric Andersen9fe5f982002-04-13 14:48:51 +0000395 "-i package_file\n" \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000396 "[-CPru] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000397#define dpkg_full_usage \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000398 "\t-i\tInstall the package\n" \
399 "\t-C\tConfigure an unpackaged package\n" \
400 "\t-P\tPurge all files of a package\n" \
401 "\t-r\tRemove all but the configuration files for a package\n" \
402 "\t-u\tUnpack a package, but dont configure it\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000403
Eric Andersen7e9276b2001-02-22 01:15:47 +0000404#define dpkg_deb_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000405 "[-cefItxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000406#define dpkg_deb_full_usage \
407 "Perform actions on debian packages (.debs)\n\n" \
408 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000409 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000410 "\t-e\tExtract control files to [argument] directory\n" \
411 "\t-f\tDisplay control field name starting with [argument]\n" \
412 "\t-I\tDisplay the control filenamed [argument]\n" \
413 "\t-t\tExtract filesystem tree to stdout in tar format\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000414 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000415 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000416#define dpkg_deb_example_usage \
417 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000418
Manuel Novoa III cad53642003-03-19 09:13:01 +0000419#ifdef CONFIG_FEATURE_DU_DEFALT_BLOCKSIZE_1K
420#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a) a
421#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a)
422#else
423#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a)
424#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a) a
425#endif
426
Eric Andersen7e9276b2001-02-22 01:15:47 +0000427#define du_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000428 "[-aHLdclsx" USAGE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000429#define du_full_usage \
430 "Summarizes disk space used for each FILE and/or directory.\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000431 "Disk space is printed in units of " \
432 USAGE_DU_DEFALT_BLOCKSIZE_1k("1024") USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k("512") \
433 " bytes.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000434 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000435 "\t-a\tshow sizes of files in addition to directories\n" \
436 "\t-H\tfollow symbolic links that are FILE command line args\n" \
437 "\t-L\tfollow all symbolic links encountered\n" \
438 "\t-d N\tlimit output to directories (and files with -a) of depth < N\n" \
439 "\t-c\toutput a grand total\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000440 "\t-l\tcount sizes many times if hard linked\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000441 "\t-s\tdisplay only a total for each argument\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000442 "\t-x\tskip directories on different filesystems\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000443 USAGE_HUMAN_READABLE( \
444 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
445 "\t-m\tprint sizes in megabytes\n" ) \
446 "\t-k\tprint sizes in kilobytes" USAGE_DU_DEFALT_BLOCKSIZE_1k("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000447#define du_example_usage \
448 "$ du\n" \
449 "16 ./CVS\n" \
450 "12 ./kernel-patches/CVS\n" \
451 "80 ./kernel-patches\n" \
452 "12 ./tests/CVS\n" \
453 "36 ./tests\n" \
454 "12 ./scripts/CVS\n" \
455 "16 ./scripts\n" \
456 "12 ./docs/CVS\n" \
457 "104 ./docs\n" \
458 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000459
Eric Andersen7e9276b2001-02-22 01:15:47 +0000460#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000461 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000462#define dumpkmap_full_usage \
463 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000464#define dumpkmap_example_usage \
465 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000466
Russ Dill61fb4892002-10-14 21:41:28 +0000467#define dumpleases_trivial_usage \
468 "[-r|-a] [-f LEASEFILE]"
469#define dumpleases_full_usage \
Russ Dill61fb4892002-10-14 21:41:28 +0000470 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
471 "\t-r,\t--remaining\tInterepret lease times as time remaing\n" \
472 "\t-a,\t--absolute\tInterepret lease times as expire time\n"
473
Manuel Novoa III cad53642003-03-19 09:13:01 +0000474#ifdef CONFIG_FEATURE_FANCY_ECHO
475 #define USAGE_FANCY_ECHO(a) a
476#else
477 #define USAGE_FANCY_ECHO(a)
478#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000479
Eric Andersen7e9276b2001-02-22 01:15:47 +0000480#define echo_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000481 USAGE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000482#define echo_full_usage \
483 "Prints the specified ARGs to stdout\n\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000484 USAGE_FANCY_ECHO("Options:\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000485 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000486 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000487 "\t-E\tdisable interpretation of backslash-escaped characters")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000488#define echo_example_usage \
489 "$ echo "Erik is cool"\n" \
490 "Erik is cool\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000491 USAGE_FANCY_ECHO("$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000492 "Erik\n" \
493 "is\n" \
494 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000495 "$ echo "Erik\\nis\\ncool"\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000496 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000497
Eric Andersen84e229c2001-03-29 22:48:33 +0000498#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000499 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000500#define env_full_usage \
501 "Prints the current environment or runs a program after setting\n" \
502 "up the specified environment.\n\n" \
503 "Options:\n" \
504 "\t-, -i\tstart with an empty environment\n" \
505 "\t-u\tremove variable from the environment\n"
506
Eric Andersen7e9276b2001-02-22 01:15:47 +0000507#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000508 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000509#define expr_full_usage \
510 "Prints the value of EXPRESSION to standard output.\n\n" \
511 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000512 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
513 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
514 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
515 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
516 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
517 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
518 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
519 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
520 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
521 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
522 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
523 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
524 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000525 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
526 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
527 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
528 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
529 "\t or 0\n" \
530 "\tlength STRING length of STRING\n" \
531 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
532 "\t it is a keyword like `match' or an\n" \
533 "\t operator like `/'\n" \
534 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000535 "Beware that many operators need to be escaped or quoted for shells.\n" \
536 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
537 "lexicographical. Pattern matches return the string matched between \n" \
538 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
539 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000540
Eric Andersen7e9276b2001-02-22 01:15:47 +0000541#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000542 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000543#define false_full_usage \
544 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000545#define false_example_usage \
546 "$ false\n" \
547 "$ echo $?\n" \
548 "1\n"
549
550#define fbset_trivial_usage \
551 "[options] [mode]"
552#define fbset_full_usage \
553 "Show and modify frame buffer settings"
554#define fbset_example_usage \
555 "$ fbset\n" \
556 "mode "1024x768-76"\n" \
557 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
558 "\tgeometry 1024 768 1024 768 16\n" \
559 "\ttimings 12714 128 32 16 4 128 4\n" \
560 "\taccel false\n" \
561 "\trgba 5/11,6/5,5/0,0/0\n" \
562 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000563
Eric Andersen7e9276b2001-02-22 01:15:47 +0000564#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000565 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000566#define fdflush_full_usage \
567 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000568
Eric Andersen01c3d402003-07-05 07:51:31 +0000569#define fdformat_trivial_usage \
570 "[-n] DEVICE"
571#define fdformat_full_usage \
572 "Low-level formats a floppy disk\n\n" \
573 "Options:\n" \
574 "\t-n\tDon't verify after format"
575
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000576#define fdisk_trivial_usage \
577 "[-l] [-v] [-b SSZ] [-u] DISK"
578#define fdisk_full_usage \
579 "Change partition table\n" \
580 "Options:\n" \
581 "-l List partition table(s)\n" \
582 "-u Give Start and End in sector (instead of cylinder) units\n" \
583 "-s PARTITION Give partition size(s) in blocks\n" \
584 "-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
Glenn L McGrath062c74f2002-11-27 09:29:49 +0000585 "-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000586
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000587#ifdef CONFIG_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000588 #define USAGE_FIND_TYPE(a) a
589#else
590 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000591#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000592#ifdef CONFIG_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000593 #define USAGE_FIND_PERM(a) a
594#else
595 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000596#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000597#ifdef CONFIG_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000598 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000599#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000600 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000601#endif
Eric Andersen97d86f22003-01-23 05:27:42 +0000602#ifdef CONFIG_FEATURE_FIND_NEWER
603 #define USAGE_FIND_NEWER(a) a
604#else
605 #define USAGE_FIND_NEWER(a)
606#endif
607#ifdef CONFIG_FEATURE_FIND_INUM
608 #define USAGE_FIND_INUM(a) a
609#else
610 #define USAGE_FIND_INUM(a)
611#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000612
Eric Andersen7e9276b2001-02-22 01:15:47 +0000613#define find_trivial_usage \
614 "[PATH...] [EXPRESSION]"
615#define find_full_usage \
616 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000617 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000618 "\nEXPRESSION may consist of:\n" \
619 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000620 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000621 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000622 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000623 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
624) USAGE_FIND_PERM( \
625 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
626) USAGE_FIND_MTIME( \
Eric Andersen97d86f22003-01-23 05:27:42 +0000627 "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \
628) USAGE_FIND_NEWER( \
629 "\n\t-newer FILE\tModified time is more recent than FILE's" \
630) USAGE_FIND_INUM( \
631 "\n\t-inum N\t\tFile has inode number N")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000632#define find_example_usage \
633 "$ find / -name /etc/passwd\n" \
634 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000635
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000636#define fold_trivial_usage \
637 "[bsw] [FILE]"
638#define fold_full_usage \
639 "Wrap input lines in each FILE (standard input by default), writing to\n" \
640 "standard output.\n\n" \
641 "Options:\n" \
642 "\t-b\tcount bytes rather than columns\n" \
643 "\t-s\tbreak at spaces\n" \
644 "\t-w\tuse WIDTH columns instead of 80\n"
645
Eric Andersen7e9276b2001-02-22 01:15:47 +0000646#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000647 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000648#define free_full_usage \
649 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000650#define free_example_usage \
651 "$ free\n" \
652 " total used free shared buffers\n" \
653 " Mem: 257628 248724 8904 59644 93124\n" \
654 " Swap: 128516 8404 120112\n" \
655 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000656
Eric Andersen7e9276b2001-02-22 01:15:47 +0000657#define freeramdisk_trivial_usage \
658 "DEVICE"
659#define freeramdisk_full_usage \
660 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000661#define freeramdisk_example_usage \
662 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000663
664#define fsck_minix_trivial_usage \
665 "[-larvsmf] /dev/name"
666#define fsck_minix_full_usage \
667 "Performs a consistency check for MINIX filesystems.\n\n" \
668 "Options:\n" \
669 "\t-l\tLists all filenames\n" \
670 "\t-r\tPerform interactive repairs\n" \
671 "\t-a\tPerform automatic repairs\n" \
672 "\t-v\tverbose\n" \
673 "\t-s\tOutputs super-block information\n" \
674 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
675 "\t-f\tForce file system check."
676
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000677#define ftpget_trivial_usage \
678 "[options] remote-host local-directory remote-file"
679#define ftpget_full_usage \
680 "Retrieve a remote file via FTP.\n\n" \
681 "Options:\n" \
682 "\t-c, --continue Continue a previous transfer\n" \
683 "\t-v, --verbose Verbose\n" \
684 "\t-u, --username Username to be used\n" \
685 "\t-p, --password Password to be used\n" \
686 "\t-P, --port Port number to be used\n"
687
688#define ftpput_trivial_usage \
689 "[options] remote-host remote-directory local-file"
690#define ftpput_full_usage \
691 "Store a local file on a remote machine via FTP.\n\n" \
692 "Options:\n" \
693 "\t-v, --verbose Verbose\n" \
694 "\t-u, --username Username to be used\n" \
695 "\t-p, --password Password to be used\n" \
696 "\t-P, --port Port number to be used\n"
697
Eric Andersen7e9276b2001-02-22 01:15:47 +0000698#define getopt_trivial_usage \
699 "[OPTIONS]..."
700#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000701 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000702 "\t-a, --alternative Allow long options starting with single -\n" \
703 "\t-l, --longoptions=longopts Long options to be recognized\n" \
704 "\t-n, --name=progname The name under which errors are reported\n" \
705 "\t-o, --options=optstring Short options to be recognized\n" \
706 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
707 "\t-Q, --quiet-output No normal output\n" \
708 "\t-s, --shell=shell Set shell quoting conventions\n" \
709 "\t-T, --test Test for getopt(1) version\n" \
710 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000711#define getopt_example_usage \
712 "$ cat getopt.test\n" \
713 "#!/bin/sh\n" \
714 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
715 " -n 'example.busybox' -- "$@"`\n" \
716 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
717 "eval set -- "$GETOPT"\n" \
718 "while true ; do\n" \
719 " case $1 in\n" \
720 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000721 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000722 " -c|--c-long)\n" \
723 " case "$2" in\n" \
724 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000725 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000726 " esac ;;\n" \
727 " --) shift ; break ;;\n" \
728 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
729 " esac\n" \
730 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000731
Eric Andersenf349e972001-08-21 16:18:59 +0000732#define getty_trivial_usage \
733 "getty [OPTIONS]... baud_rate,... line [termtype]"
734#define getty_full_usage \
735 "\nOpens a tty, prompts for a login name, then invokes /bin/login\n\n" \
736 "Options:\n" \
737 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
738 "\t-i\t\tDo not display /etc/issue before running login.\n" \
739 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
740 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
741 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
Glenn L McGrath49e74ef2003-05-13 14:59:07 +0000742 "\t-n\t\tDo not prompt the user for a login name.\n" \
743 "\t-f issue_file\tDisplay issue_file instead of /etc/issue.\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000744 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
745 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
746 "\t-I initstring\tSets the init string to send before anything else.\n" \
747 "\t-H login_host\tLog login_host into the utmp file as the hostname."
748
749
Eric Andersen7e9276b2001-02-22 01:15:47 +0000750#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000751 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000752#define grep_full_usage \
753 "Search for PATTERN in each FILE or standard input.\n\n" \
754 "Options:\n" \
755 "\t-H\tprefix output lines with filename where match was found\n" \
756 "\t-h\tsuppress the prefixing filename on output\n" \
757 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000758 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000759 "\t-n\tprint line number with output lines\n" \
760 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
761 "\t-v\tselect non-matching lines\n" \
762 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000763#define grep_example_usage \
764 "$ grep root /etc/passwd\n" \
765 "root:x:0:0:root:/root:/bin/bash\n" \
766 "$ grep ^[rR]oo. /etc/passwd\n" \
767 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000768
Eric Andersen7e9276b2001-02-22 01:15:47 +0000769#define gunzip_trivial_usage \
770 "[OPTION]... FILE"
771#define gunzip_full_usage \
772 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
773 "Options:\n" \
774 "\t-c\tWrite output to standard output\n" \
775 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000776#define gunzip_example_usage \
777 "$ ls -la /tmp/BusyBox*\n" \
778 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
779 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
780 "$ ls -la /tmp/BusyBox*\n" \
781 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000782
783#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000784 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000785#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000786 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000787 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000788 "Options:\n" \
789 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
790 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000791#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000792 "$ ls -la /tmp/busybox*\n" \
793 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
794 "$ gzip /tmp/busybox.tar\n" \
795 "$ ls -la /tmp/busybox*\n" \
796 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000797
798#define halt_trivial_usage \
799 ""
800#define halt_full_usage \
801 "Halt the system."
802
Eric Andersen3443bd72003-07-22 07:30:36 +0000803#ifdef CONFIG_FEATURE_HDPARM_GET_IDENTITY
804#define USAGE_HDPARM_IDENT(a) a
805#else
806#define USAGE_HDPARM_IDENT(a)
807#endif
808
809#ifdef CONFIG_FEATURE_HDPARM_HDIO_SCAN_HWIF
810#define USAGE_SCAN_HWIF(a) a
811#else
812#define USAGE_SCAN_HWIF(a)
813#endif
814
815#ifdef CONFIG_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF
816#define USAGE_UNREGISTER_HWIF(a) a
817#else
818#define USAGE_UNREGISTER_HWIF(a)
819#endif
820
821#ifdef CONFIG_FEATURE_HDPARM_HDIO_DRIVE_RESET
822#define USAGE_DRIVE_RESET(a) a
823#else
824#define USAGE_DRIVE_RESET(a)
825#endif
826
827#ifdef CONFIG_FEATURE_HDPARM_HDIO_TRISTATE_HWIF
828#define USAGE_TRISTATE_HWIF(a) a
829#else
830#define USAGE_TRISTATE_HWIF(a)
831#endif
832
Eric Andersen0a57a792003-08-06 08:57:35 +0000833#ifdef CONFIG_FEATURE_HDPARM_HDIO_GETSET_DMA
834#define USAGE_GETSET_DMA(a) a
835#else
836#define USAGE_GETSET_DMA(a)
837#endif
838
Eric Andersen3443bd72003-07-22 07:30:36 +0000839#define hdparm_trivial_usage \
840 "[options] [device] .."
841#define hdparm_full_usage \
842 "Options:" \
843 " -a get/set fs readahead\n" \
844 " -A set drive read-lookahead flag (0/1)\n" \
845 " -b get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
846 " -B set Advanced Power Management setting (1-255)\n" \
847 " -c get/set IDE 32-bit IO setting\n" \
848 " -C check IDE power mode status\n" \
Eric Andersen0a57a792003-08-06 08:57:35 +0000849 USAGE_GETSET_DMA(" -d get/set using_dma flag\n") \
Eric Andersen3443bd72003-07-22 07:30:36 +0000850 " -D enable/disable drive defect-mgmt\n" \
851 " -f flush buffer cache for device on exit\n" \
852 " -g display drive geometry\n" \
853 " -h display terse usage information\n" \
854 " -i display drive identification\n" \
855 USAGE_HDPARM_IDENT(" -I detailed/current information directly from drive\n") \
856 USAGE_HDPARM_IDENT(" -Istdin similar to -I, but wants /proc/ide/" "*" "/hd?/identify as input\n") \
857 " -k get/set keep_settings_over_reset flag (0/1)\n" \
858 " -K set drive keep_features_over_reset flag (0/1)\n" \
859 " -L set drive doorlock (0/1) (removable harddisks only)\n" \
860 " -m get/set multiple sector count\n" \
861 " -n get/set ignore-write-errors flag (0/1)\n" \
862 " -p set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
863 " -P set drive prefetch count\n" \
864 " -q change next setting quietly\n" \
865 " -Q get/set DMA tagged-queuing depth (if supported)\n" \
866 " -r get/set readonly flag (DANGEROUS to set)\n" \
867 USAGE_SCAN_HWIF(" -R register an IDE interface (DANGEROUS)\n") \
868 " -S set standby (spindown) timeout\n" \
869 " -t perform device read timings\n" \
870 " -T perform cache read timings\n" \
871 " -u get/set unmaskirq flag (0/1)\n" \
872 USAGE_UNREGISTER_HWIF(" -U un-register an IDE interface (DANGEROUS)\n") \
873 " -v defaults; same as -mcudkrag for IDE drives\n" \
874 " -V display program version and exit immediately\n" \
875 USAGE_DRIVE_RESET(" -w perform device reset (DANGEROUS)\n") \
876 " -W set drive write-caching flag (0/1) (DANGEROUS)\n" \
877 USAGE_TRISTATE_HWIF(" -x tristate device for hotswap (0/1) (DANGEROUS)\n") \
878 " -X set IDE xfer mode (DANGEROUS)\n" \
879 " -y put IDE drive in standby mode\n" \
880 " -Y put IDE drive to sleep\n" \
881 " -Z disable Seagate auto-powersaving mode\n" \
882 " -z re-read partition table\n"
883
Manuel Novoa III cad53642003-03-19 09:13:01 +0000884#ifdef CONFIG_FEATURE_FANCY_HEAD
885#define USAGE_FANCY_HEAD(a) a
886#else
887#define USAGE_FANCY_HEAD(a)
888#endif
889
Eric Andersen7e9276b2001-02-22 01:15:47 +0000890#define head_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000891 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000892#define head_full_usage \
893 "Print first 10 lines of each FILE to standard output.\n" \
894 "With more than one FILE, precede each with a header giving the\n" \
895 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000896 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000897 "\t-n NUM\t\tPrint first NUM lines instead of first 10" \
898 USAGE_FANCY_HEAD( \
899 "\n\t-c NUM\t\toutput the first NUM bytes\n" \
900 "\t-q\t\tnever output headers giving file names\n" \
901 "\t-v\t\talways output headers giving file names" )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000902#define head_example_usage \
903 "$ head -n 2 /etc/passwd\n" \
904 "root:x:0:0:root:/root:/bin/bash\n" \
905 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000906
Glenn L McGrath60281112001-11-02 11:39:46 +0000907#define hexdump_trivial_usage \
908 "[-[bcdefnosvx]] [OPTION] FILE"
909#define hexdump_full_usage \
910 "The hexdump utility is a filter which displays the specified files,\n" \
911 "or the standard input, if no files are specified, in a user specified\n"\
912 "format\n" \
913 "\t-b\t\tOne-byte octal display\n" \
914 "\t-c\t\tOne-byte character display\n" \
915 "\t-d\t\tTwo-byte decimal display\n" \
916 "\t-e FORMAT STRING\n" \
917 "\t-f FORMAT FILE\n" \
918 "\t-n LENGTH\tInterpret only length bytes of input\n" \
919 "\t-o\t\tTwo-byte octal display\n" \
920 "\t-s OFFSET\tSkip offset byte\n" \
921 "\t-v\t\tdisplay all input data\n" \
922 "\t-x\t\tTwo-byte hexadecimal display\n"
923
Eric Andersen7e9276b2001-02-22 01:15:47 +0000924#define hostid_trivial_usage \
925 ""
926#define hostid_full_usage \
927 "Print out a unique 32-bit identifier for the machine."
928
929#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000930 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000931#define hostname_full_usage \
932 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000933 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000934 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +0000935 "\t-s\tShort\n" \
936 "\t-i\tAddresses for the hostname\n" \
937 "\t-d\tDNS domain name\n" \
938 "\t-f\tFully qualified domain name\n" \
939 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000940#define hostname_example_usage \
941 "$ hostname\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000942 "sage \n"
Eric Andersen40520512003-07-28 09:59:05 +0000943
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000944#ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH
945 #define USAGE_HTTPD_BASIC_AUTH(a) a
Eric Andersen40520512003-07-28 09:59:05 +0000946 #ifdef CONFIG_FEATURE_HTTPD_AUTH_MD5
947 #define USAGE_HTTPD_AUTH_MD5(a) a
948 #else
949 #define USAGE_HTTPD_AUTH_MD5(a)
950 #endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000951#else
952 #define USAGE_HTTPD_BASIC_AUTH(a)
Eric Andersen40520512003-07-28 09:59:05 +0000953 #define USAGE_HTTPD_AUTH_MD5(a)
954#endif
955#ifdef CONFIG_FEATURE_HTTPD_USAGE_FROM_INETD_ONLY
956 #define USAGE_HTTPD_STANDALONE(a)
957 #define USAGE_HTTPD_SETUID(a)
958#else
959 #define USAGE_HTTPD_STANDALONE(a) a
960 #ifdef CONFIG_FEATURE_HTTPD_SETUID
961 #define USAGE_HTTPD_SETUID(a) a
962 #else
963 #define USAGE_HTTPD_SETUID(a)
964 #endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000965#endif
966#define httpd_trivial_usage \
Eric Andersen40520512003-07-28 09:59:05 +0000967 "[-c <conf file>]" \
968 USAGE_HTTPD_STANDALONE(" [-p <port>]") \
969 USAGE_HTTPD_SETUID(" [-u user]") \
970 USAGE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
971 USAGE_HTTPD_AUTH_MD5(" [-m pass]") \
972 " [-d/-e <string>]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000973#define httpd_full_usage \
974 "Listens for incoming http server requests.\n"\
975 "Options:\n" \
Eric Andersen40520512003-07-28 09:59:05 +0000976 "\t-c FILE\tSpecifies configuration file. (default httpd.conf)\n" \
977 USAGE_HTTPD_STANDALONE("\t-p PORT\tServer port (default 80)\n") \
978 USAGE_HTTPD_SETUID("\t-u USER\tSet uid to USER after listening privilegies port\n") \
979 USAGE_HTTPD_BASIC_AUTH("\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
980 USAGE_HTTPD_AUTH_MD5("\t-m PASS\tCrypt PASS with md5 algorithm\n") \
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000981 "\t-e STRING\tHtml encode STRING\n" \
Eric Andersen40520512003-07-28 09:59:05 +0000982 "\t-d STRING\tURL decode STRING"
983
Robert Griebl1cd04452002-07-21 16:50:49 +0000984#define hwclock_trivial_usage \
985 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
986#define hwclock_full_usage \
987 "Query and set the hardware clock (RTC)\n\n" \
988 "Options:\n" \
989 "\t-r\tread hardware clock and print result\n" \
990 "\t-s\tset the system time from the hardware clock\n" \
991 "\t-w\tset the hardware clock to the current system time\n" \
992 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
993 "\t-l\tthe hardware clock is kept in local time"
994
Eric Andersen9e480452003-07-03 10:07:04 +0000995#ifdef CONFIG_SELINUX
996#define USAGE_SELINUX(a, b) a
997#else
998#define USAGE_SELINUX(a, b) b
999#endif
1000
Eric Andersen7e9276b2001-02-22 01:15:47 +00001001#define id_trivial_usage \
1002 "[OPTIONS]... [USERNAME]"
1003#define id_full_usage \
1004 "Print information for USERNAME or the current user\n\n" \
1005 "Options:\n" \
1006 "\t-g\tprints only the group ID\n" \
1007 "\t-u\tprints only the user ID\n" \
Eric Andersen9e480452003-07-03 10:07:04 +00001008 USAGE_SELINUX("\t-c\tprints only the security context\n", "") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001009 "\t-n\tprint a name instead of a number (with for -ug)\n" \
1010 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001011#define id_example_usage \
1012 "$ id\n" \
1013 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001014
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001015#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001016 #define USAGE_SIOCSKEEPALIVE(a) a
1017#else
1018 #define USAGE_SIOCSKEEPALIVE(a)
1019#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001020#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001021 #define USAGE_IFCONFIG_MII(a) a
1022#else
1023 #define USAGE_IFCONFIG_MII(a)
1024#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001025#ifdef CONFIG_FEATURE_IFCONFIG_HW
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001026 #define USAGE_IFCONFIG_HW(a) a
1027#else
1028 #define USAGE_IFCONFIG_HW(a)
1029#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001030#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001031 #define USAGE_IFCONFIG_OPT_A(a) a
1032#else
1033 #define USAGE_IFCONFIG_OPT_A(a)
1034#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +00001035#ifdef CONFIG_FEATURE_IPV6
1036 #define USAGE_IPV6(a) a
1037#else
1038 #define USAGE_IPV6(a)
1039#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001040
Eric Andersen7e9276b2001-02-22 01:15:47 +00001041#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001042 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001043#define ifconfig_full_usage \
1044 "configure a network interface\n\n" \
1045 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +00001046 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
1047 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001048 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001049 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001050 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001051 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
1052 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001053 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001054 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
1055 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001056 "\t[up|down] ..."
1057
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001058#define ifup_trivial_usage \
1059 "<-ahinv> <ifaces...>"
1060#define ifup_full_usage \
1061 "Usage: ifup <options> <ifaces...>\n\n" \
1062 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001063 "\t-h\tthis help\n" \
1064 "\t-a\tde/configure all interfaces automatically\n" \
1065 "\t-i FILE\tuse FILE for interface definitions\n" \
1066 "\t-n\tprint out what would happen, but don't do it\n" \
1067 "\t\t\t(note that this option doesn't disable mappings)\n" \
1068 "\t-v\tprint out what would happen before doing it\n" \
1069 "\t-m\tdon't run any mappings\n" \
1070 "\t-f\tforce de/configuration\n"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001071
1072#define ifdown_trivial_usage \
1073 "<-ahinv> <ifaces...>"
1074#define ifdown_full_usage \
1075 "Usage: ifdown <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(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
Glenn L McGrath06e95652003-02-09 06:51:14 +00001086#define inetd_trivial_usage \
1087 "[-q len] [conf]"
1088#define inetd_full_usage \
1089 "Usage: [-q len] [conf]\n\n" \
1090 "Option:\n" \
1091 "\t-q\tSets the size of the socket listen queue to\n" \
1092 "the specified value. Default is 128."
1093
Eric Andersen7e9276b2001-02-22 01:15:47 +00001094#define init_trivial_usage \
1095 ""
1096#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001097 "Init is the parent of all processes."
1098#define init_notes_usage \
1099"This version of init is designed to be run only by the kernel.\n" \
1100"\n" \
1101"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
1102"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
1103"runlevels, use sysvinit.\n" \
1104"\n" \
1105"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
1106"it has the following default behavior:\n" \
1107"\n" \
1108" ::sysinit:/etc/init.d/rcS\n" \
1109" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001110" ::ctrlaltdel:/sbin/reboot\n" \
1111" ::shutdown:/sbin/swapoff -a\n" \
1112" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001113" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001114"\n" \
1115"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1116"\n" \
1117" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001118" tty3::askfirst:/bin/sh\n" \
1119" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001120"\n" \
1121"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1122"\n" \
1123" <id>:<runlevels>:<action>:<process>\n" \
1124"\n" \
1125" <id>: \n" \
1126"\n" \
1127" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1128" The id field is used by BusyBox init to specify the controlling tty for\n" \
1129" the specified process to run on. The contents of this field are\n" \
1130" appended to "/dev/" and used as-is. There is no need for this field to\n" \
1131" be unique, although if it isn't you may have strange results. If this\n" \
1132" field is left blank, the controlling tty is set to the console. Also\n" \
1133" note that if BusyBox detects that a serial console is in use, then only\n" \
1134" entries whose controlling tty is either the serial console or /dev/null\n" \
1135" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1136" stinkin' utmp.\n" \
1137"\n" \
1138" <runlevels>: \n" \
1139"\n" \
1140" The runlevels field is completely ignored.\n" \
1141"\n" \
1142" <action>: \n" \
1143"\n" \
1144" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001145" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001146"\n" \
1147" The available actions can be classified into two groups: actions\n" \
1148" that are run only once, and actions that are re-run when the specified\n" \
1149" process exits.\n" \
1150"\n" \
1151" Run only-once actions:\n" \
1152"\n" \
1153" 'sysinit' is the first item run on boot. init waits until all\n" \
1154" sysinit actions are completed before continuing. Following the\n" \
1155" completion of all sysinit actions, all 'wait' actions are run.\n" \
1156" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001157" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001158" therefore, init does not wait for them to complete. 'restart' is\n" \
1159" the action taken to restart the init process. By default this should\n" \
1160" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1161" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001162" actions are run when the system detects that someone on the system\n" \
1163" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1164" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1165" Finally the 'shutdown' action specifies the actions to taken when\n" \
1166" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1167" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001168"\n" \
1169" Run repeatedly actions:\n" \
1170"\n" \
1171" 'respawn' actions are run after the 'once' actions. When a process\n" \
1172" started with a 'respawn' action exits, init automatically restarts\n" \
1173" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1174" respawning out of control. The 'askfirst' actions acts just like\n" \
1175" respawn, except that before running the specified process it\n" \
1176" displays the line "Please press Enter to activate this console."\n" \
1177" and then waits for the user to press enter before starting the\n" \
1178" specified process. \n" \
1179"\n" \
1180" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1181" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001182" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001183"\n" \
1184" <process>: \n" \
1185"\n" \
1186" Specifies the process to be executed and it's command line.\n" \
1187"\n" \
1188"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001189"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001190" # This is run first except when booting in single-user mode.\n" \
1191" #\n" \
1192" ::sysinit:/etc/init.d/rcS\n" \
1193" \n" \
1194" # /bin/sh invocations on selected ttys\n" \
1195" #\n" \
1196" # Start an "askfirst" shell on the console (whatever that may be)\n" \
1197" ::askfirst:-/bin/sh\n" \
1198" # Start an "askfirst" shell on /dev/tty2-4\n" \
1199" tty2::askfirst:-/bin/sh\n" \
1200" tty3::askfirst:-/bin/sh\n" \
1201" tty4::askfirst:-/bin/sh\n" \
1202" \n" \
1203" # /sbin/getty invocations for selected ttys\n" \
1204" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001205" tty4::respawn:/sbin/getty 38400 tty4\n" \
1206" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001207" \n" \
1208" \n" \
1209" # Example of how to put a getty on a serial line (for a terminal)\n" \
1210" #\n" \
1211" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1212" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1213" #\n" \
1214" # Example how to put a getty on a modem line.\n" \
1215" #::respawn:/sbin/getty 57600 ttyS2\n" \
1216" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001217" # Stuff to do when restarting the init process\n" \
1218" ::restart:/sbin/init\n" \
1219" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001220" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001221" ::ctrlaltdel:/sbin/reboot\n" \
1222" ::shutdown:/bin/umount -a -r\n" \
1223" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001224
Eric Andersenbe65c352003-01-23 04:57:35 +00001225#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
1226 #define USAGE_INSMOD_MAP(a) a
1227#else
1228 #define USAGE_INSMOD_MAP(a)
1229#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001230#define insmod_trivial_usage \
1231 "[OPTION]... MODULE [symbol=value]..."
1232#define insmod_full_usage \
1233 "Loads the specified kernel modules into the kernel.\n\n" \
1234 "Options:\n" \
1235 "\t-f\tForce module to load into the wrong kernel version.\n" \
1236 "\t-k\tMake module autoclean-able.\n" \
1237 "\t-v\tverbose output\n" \
1238 "\t-L\tLock to prevent simultaneous loads of a module\n" \
Eric Andersenbe65c352003-01-23 04:57:35 +00001239 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout") \
1240 "\t-x\tdo not export externs\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001241
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001242#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001243 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001244#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001245 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1246 "where OBJECT := { link | addr | route | tunnel }\n" \
1247 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }\n"
1248
1249#define ipaddr_trivial_usage \
1250 "{ {add|del} IFADDR dev STRING | {show|flush} [ dev STRING ] [ to PREFIX ] }"
1251#define ipaddr_full_usage \
1252 "ipaddr {add|del} IFADDR dev STRING\n" \
1253 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
1254 " [ to PREFIX ] [ label PATTERN ]\n" \
1255 "IFADDR := PREFIX | ADDR peer PREFIX\n" \
1256 " [ broadcast ADDR ] [ anycast ADDR ]\n" \
1257 " [ label STRING ] [ scope SCOPE-ID ]\n" \
1258 "SCOPE-ID := [ host | link | global | NUMBER ]\n"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001259
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001260#ifndef CONFIG_FEATURE_IPCALC_FANCY
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001261# define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001262 "[--broadcast] [--netmask] [--network] ipaddr <netmask>"
1263
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001264# define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001265 "Calculate IP network settings from a IP address\n\n" \
1266 "Options:\n" \
1267 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1268 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
1269 "\t-w\t--network\tDisplay calculated network address."
1270#else
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001271# define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001272 "[OPTION]... ipaddr <netmask>"
1273
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001274# define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001275 "Calculate IP network settings from a IP address\n\n" \
1276 "Options:\n" \
1277 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1278 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
1279 "\t-w\t--network\tDisplay calculated network address.\n" \
1280 "\t-h\t--hostname\tDisplay first resolved host name.\n" \
1281 "\t-s\t--silent\tDon't ever display error messages."
1282#endif
1283
1284#define ipcalc_notes_usage \
1285 "ipcalc provides a simple way to calculate IP information for\n" \
1286 "a host. The various options specify what information ipcalc\n" \
1287 "should display on standard out. Multiple options may be\n" \
1288 "specified.\n"
1289
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001290#define iplink_trivial_usage \
1291 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1292#define iplink_full_usage \
1293 "iplink set DEVICE { up | down | arp { on | off } |\n" \
1294 " dynamic { on | off } |\n" \
1295 " mtu MTU }\n" \
1296 "iplink show [ DEVICE ]\n"
1297
1298#define iproute_trivial_usage \
1299 "{ list | flush | { add | del | change | append | replace | monitor } ROUTE }"
1300#define iproute_full_usage \
1301 "iproute { list | flush } SELECTOR\n" \
1302 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
1303 " [ oif STRING ] [ tos TOS ]\n" \
1304 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
1305 "SELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1306 "ROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]\n"
1307
1308#define iptunnel_trivial_usage \
1309 "{ add | change | del | show } [ NAME ] [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
1310#define iptunnel_full_usage \
1311 "iptunnel { add | change | del | show } [ NAME ]\n" \
1312 " [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1313 " [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1314 " [ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]\n"
1315
Eric Andersen92fb9392003-08-08 20:09:03 +00001316#define insmod_ng_trivial_usage \
1317 "MODULE [symbol=value]..."
1318#define insmod_ng_full_usage \
1319 "Loads the specified kernel modules into the kernel."
1320
Eric Andersen7e9276b2001-02-22 01:15:47 +00001321#define kill_trivial_usage \
1322 "[-signal] process-id [process-id ...]"
1323#define kill_full_usage \
1324 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +00001325 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001326 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001327#define kill_example_usage \
1328 "$ ps | grep apache\n" \
1329 "252 root root S [apache]\n" \
1330 "263 www-data www-data S [apache]\n" \
1331 "264 www-data www-data S [apache]\n" \
1332 "265 www-data www-data S [apache]\n" \
1333 "266 www-data www-data S [apache]\n" \
1334 "267 www-data www-data S [apache]\n" \
1335 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001336
1337#define killall_trivial_usage \
1338 "[-signal] process-name [process-name ...]"
1339#define killall_full_usage \
1340 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001341 "Options:\n" \
1342 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001343#define killall_example_usage \
1344 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001345
Mark Whitley6317c4b2001-03-12 22:51:50 +00001346#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001347 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001348#define klogd_full_usage \
1349 "Kernel logger.\n"\
1350 "Options:\n"\
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001351 "\t-c n\tSets the default log level of console messages to n.\n"\
Mark Whitley6317c4b2001-03-12 22:51:50 +00001352 "\t-n\tRun as a foreground process."
1353
Eric Andersen7e9276b2001-02-22 01:15:47 +00001354#define length_trivial_usage \
1355 "STRING"
1356#define length_full_usage \
1357 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001358#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001359 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001360 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001361
1362#define ln_trivial_usage \
1363 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1364#define ln_full_usage \
1365 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
1366 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1367 "Options:\n" \
1368 "\t-s\tmake symbolic links instead of hard links\n" \
1369 "\t-f\tremove existing destination files\n" \
1370 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001371#define ln_example_usage \
1372 "$ ln -s BusyBox /tmp/ls\n" \
1373 "$ ls -l /tmp/ls\n" \
1374 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001375
1376#define loadacm_trivial_usage \
1377 "< mapfile"
1378#define loadacm_full_usage \
1379 "Loads an acm from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001380#define loadacm_example_usage \
1381 "$ loadacm < /etc/i18n/acmname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001382
1383#define loadfont_trivial_usage \
1384 "< font"
1385#define loadfont_full_usage \
1386 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001387#define loadfont_example_usage \
1388 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001389
1390#define loadkmap_trivial_usage \
1391 "< keymap"
1392#define loadkmap_full_usage \
1393 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001394#define loadkmap_example_usage \
1395 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001396
1397#define logger_trivial_usage \
1398 "[OPTION]... [MESSAGE]"
1399#define logger_full_usage \
1400 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1401 "Options:\n" \
1402 "\t-s\tLog to stderr as well as the system log.\n" \
1403 "\t-t\tLog using the specified tag (defaults to user name).\n" \
1404 "\t-p\tEnter the message with the specified priority.\n" \
1405 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001406#define logger_example_usage \
1407 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001408
Robert Griebl1fca5582002-06-04 20:45:46 +00001409#define login_trivial_usage \
1410 "[OPTION]... [username] [ENV=VAR ...]"
1411#define login_full_usage \
1412 "Begin a new session on the system\n\n" \
1413 "Options:\n" \
1414 "\t-f\tDo not authenticate (user already authenticated)\n" \
1415 "\t-h\tName of the remote host for this login.\n" \
1416 "\t-p\tPreserve environment."
1417
Eric Andersen7e9276b2001-02-22 01:15:47 +00001418#define logname_trivial_usage \
1419 ""
1420#define logname_full_usage \
1421 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001422#define logname_example_usage \
1423 "$ logname\n" \
1424 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001425
Mark Whitley6317c4b2001-03-12 22:51:50 +00001426#define logread_trivial_usage \
1427 ""
1428
1429#define logread_full_usage \
1430 "Shows the messages from syslogd (using circular buffer)."
1431
Matt Kraai83788da2002-03-20 17:38:37 +00001432#define losetup_trivial_usage \
1433 "[OPTION]... LOOPDEVICE FILE\n" \
1434 "or: losetup [OPTION]... -d LOOPDEVICE"
1435#define losetup_full_usage \
1436 "Associate LOOPDEVICE with FILE.\n\n" \
1437 "Options:\n" \
1438 "\t-d\t\tDisassociate LOOPDEVICE.\n" \
1439 "\t-o OFFSET\tStart OFFSET bytes into FILE.\n"
1440
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001441#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001442 #define USAGE_LS_TIMESTAMPS(a) a
1443#else
1444 #define USAGE_LS_TIMESTAMPS(a)
1445#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001446#ifdef CONFIG_FEATURE_LS_FILETYPES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001447 #define USAGE_LS_FILETYPES(a) a
1448#else
1449 #define USAGE_LS_FILETYPES(a)
1450#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001451#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001452 #define USAGE_LS_FOLLOWLINKS(a) a
1453#else
1454 #define USAGE_LS_FOLLOWLINKS(a)
1455#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001456#ifdef CONFIG_FEATURE_LS_RECURSIVE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001457 #define USAGE_LS_RECURSIVE(a) a
1458#else
1459 #define USAGE_LS_RECURSIVE(a)
1460#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001461#ifdef CONFIG_FEATURE_LS_SORTFILES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001462 #define USAGE_LS_SORTFILES(a) a
1463#else
1464 #define USAGE_LS_SORTFILES(a)
1465#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001466#ifdef CONFIG_FEATURE_AUTOWIDTH
Eric Andersen7e9276b2001-02-22 01:15:47 +00001467 #define USAGE_AUTOWIDTH(a) a
1468#else
1469 #define USAGE_AUTOWIDTH(a)
1470#endif
1471#define ls_trivial_usage \
Eric Andersen9e480452003-07-03 10:07:04 +00001472 "[-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 +00001473#define ls_full_usage \
1474 "List directory contents\n\n" \
1475 "Options:\n" \
1476 "\t-1\tlist files in a single column\n" \
1477 "\t-A\tdo not list implied . and ..\n" \
1478 "\t-a\tdo not hide entries starting with .\n" \
1479 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001480 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001481 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001482 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1483 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001484 "\t-i\tlist the i-node for each file\n" \
1485 "\t-l\tuse a long listing format\n" \
1486 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001487 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1488 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1489 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1490 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1491 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001492 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001493 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1494 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1495 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1496 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1497 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001498 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001499 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1500 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001501 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersenbccb3152003-07-03 10:19:20 +00001502 USAGE_SELINUX("\t-k\tprint security context\n\t-K\tprint security context in long format\n", ""))
Eric Andersen7e9276b2001-02-22 01:15:47 +00001503
1504#define lsmod_trivial_usage \
1505 ""
1506#define lsmod_full_usage \
1507 "List the currently loaded kernel modules."
1508
1509#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001510 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001511#define makedevs_full_usage \
1512 "Creates a range of block or character special files\n\n" \
1513 "TYPEs include:\n" \
1514 "\tb:\tMake a block (buffered) device.\n" \
1515 "\tc or u:\tMake a character (un-buffered) device.\n" \
1516 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1517 "FIRST specifies the number appended to NAME to create the first device.\n" \
1518 "LAST specifies the number of the last item that should be created.\n" \
1519 "If 's' is the last argument, the base device is created as well.\n\n" \
1520 "For example:\n" \
1521 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001522 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001523#define makedevs_example_usage \
1524 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
1525 "[creates ttyS2-ttyS63]\n" \
1526 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
1527 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001528
Eric Andersen7e9276b2001-02-22 01:15:47 +00001529#define md5sum_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001530 "[OPTION] [FILE]...\n" \
1531 "or: md5sum [OPTION] -c [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001532#define md5sum_full_usage \
1533 "Print or check MD5 checksums.\n\n" \
1534 "Options:\n" \
1535 "With no FILE, or when FILE is -, read standard input.\n\n" \
1536 "\t-b\tread files in binary mode\n" \
1537 "\t-c\tcheck MD5 sums against given list\n" \
1538 "\t-t\tread files in text mode (default)\n" \
1539 "\t-g\tread a string\n" \
1540 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001541 "\t-s\tdon't output anything, status code shows success\n" \
1542 "\t-w\twarn about improperly formated MD5 checksum lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001543#define md5sum_example_usage \
1544 "$ md5sum < busybox\n" \
1545 "6fd11e98b98a58f64ff3398d7b324003\n" \
1546 "$ md5sum busybox\n" \
1547 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1548 "$ md5sum -c -\n" \
1549 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1550 "busybox: OK\n" \
1551 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001552
Glenn L McGrath061c9002002-09-16 04:21:46 +00001553#define mesg_trivial_usage \
1554 "mesg [y|n]"
1555#define mesg_full_usage \
1556 "mesg [Y|N], controls write access to your terminal\n" \
1557 "\ty\tAllow write access to your terminal.\n" \
1558 "\tn\tDisallow write access to your terminal.\n"
1559
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001560#define minit_trivial_usage \
1561 "[-spPrRC]"
1562#define minit_full_usage \
1563 "[-spPrRC]"
1564
Eric Andersen7e9276b2001-02-22 01:15:47 +00001565#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001566 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001567#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001568 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001569 "Options:\n" \
1570 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001571 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001572#define mkdir_example_usage \
1573 "$ mkdir /tmp/foo\n" \
1574 "$ mkdir /tmp/foo\n" \
1575 "/tmp/foo: File exists\n" \
1576 "$ mkdir /tmp/foo/bar/baz\n" \
1577 "/tmp/foo/bar/baz: No such file or directory\n" \
1578 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001579
Eric Andersen7e9276b2001-02-22 01:15:47 +00001580#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001581 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001582#define mkfifo_full_usage \
1583 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1584 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001585 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001586
Eric Andersen7e9276b2001-02-22 01:15:47 +00001587#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001588 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001589#define mkfs_minix_full_usage \
1590 "Make a MINIX filesystem.\n\n" \
1591 "Options:\n" \
1592 "\t-c\t\tCheck the device for bad blocks\n" \
1593 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1594 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1595 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001596 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001597
Eric Andersen7e9276b2001-02-22 01:15:47 +00001598#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001599 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001600#define mknod_full_usage \
1601 "Create a special file (block, character, or pipe).\n\n" \
1602 "Options:\n" \
1603 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1604 "TYPEs include:\n" \
1605 "\tb:\tMake a block (buffered) device.\n" \
1606 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001607 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001608#define mknod_example_usage \
1609 "$ mknod /dev/fd0 b 2 0 \n" \
1610 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001611
Eric Andersen7e9276b2001-02-22 01:15:47 +00001612#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001613 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001614#define mkswap_full_usage \
1615 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001616 "Options:\n" \
1617 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001618 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001619 "\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 +00001620 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001621
Eric Andersen7e9276b2001-02-22 01:15:47 +00001622#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001623 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001624#define mktemp_full_usage \
1625 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001626 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001627#define mktemp_example_usage \
1628 "$ mktemp /tmp/temp.XXXXXX\n" \
1629 "/tmp/temp.mWiLjM\n" \
1630 "$ ls -la /tmp/temp.mWiLjM\n" \
1631 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001632
Eric Andersen8d79ce82001-07-22 23:00:15 +00001633#define modprobe_trivial_usage \
1634 "[FILE ...]"
1635#define modprobe_full_usage \
Eric Andersenabc95682002-07-03 02:52:35 +00001636 "Used for high level module loading and unloading."
Eric Andersen8d79ce82001-07-22 23:00:15 +00001637#define modprobe_example_usage \
1638 "$ modprobe cdrom\n"
1639
Eric Andersen7e9276b2001-02-22 01:15:47 +00001640#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001641 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001642#define more_full_usage \
1643 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001644#define more_example_usage \
1645 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001646
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001647#ifdef CONFIG_FEATURE_MOUNT_LOOP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001648 #define USAGE_MOUNT_LOOP(a) a
1649#else
1650 #define USAGE_MOUNT_LOOP(a)
1651#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001652#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001653 #define USAGE_MTAB(a) a
1654#else
1655 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001656#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001657#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001658 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001659#define mount_full_usage \
1660 "Mount a filesystem\n\n" \
1661 "Flags:\n" \
1662 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001663 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001664 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001665 "\t-n:\t\tDon't write a mount table entry.\n" \
1666 ) \
1667 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1668 "\t-r:\t\tMount the filesystem read-only.\n" \
1669 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1670 "\t-w:\t\tMount for reading and writing (default).\n" \
1671 "\n" \
1672 "Options for use with the \"-o\" flag:\n" \
1673 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1674 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1675 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1676 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001677 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001678 "\tloop:\t\tMounts a file via loop device.\n" \
1679 ) \
1680 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001681 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001682 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001683 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001684 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001685 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001686#define mount_example_usage \
1687 "$ mount\n" \
1688 "/dev/hda3 on / type minix (rw)\n" \
1689 "proc on /proc type proc (rw)\n" \
1690 "devpts on /dev/pts type devpts (rw)\n" \
1691 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1692 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001693
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001694#define msvc_trivial_usage \
1695 "-[udorspchaitkx] service"
Eric Andersen335816b2003-07-14 22:14:49 +00001696#define msvc_full_usage \
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001697 "[option] service\n" \
1698 "Where option is one of\n" \
1699 "\t-u\tUp. If the service is not running, start it. If the service stops, restart it.\n" \
1700 "\t-d\tDown. If the service is running, stop it, do not restart it.\n" \
1701 "\t-o\tOnce. If the service is not running, start it. Do not restart it if it stops.\n" \
1702 "\t-r\tTell supervise that the service is normally running; this affects status messages.\n" \
1703 "\t-s\tTell supervise that the service is normally stopped; this affects status messages.\n" \
1704 "\t-p\tPause. Send the service a STOP signal.\n" \
1705 "\t-c\tContinue. Send the service a CONT signal.\n" \
1706 "\t-h\tHangup. Send the service a HUP signal.\n" \
1707 "\t-a\tAlarm. Send the service an ALRM signal.\n" \
1708 "\t-i\tInterrupt. Send the service an INT signal.\n" \
1709 "\t-t\tTerminate. Send the service a TERM signal.\n" \
1710 "\t-k\tKill. Send the service a KILL signal.\n" \
1711 "\t-x\tExit. supervise will quit as soon as the service is down.\n"
1712
Eric Andersen7e9276b2001-02-22 01:15:47 +00001713#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001714 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001715#define mt_full_usage \
1716 "Control magnetic tape drive operation\n" \
1717 "\nAvailable Opcodes:\n\n" \
1718 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1719 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
Eric Andersen92fb9392003-08-08 20:09:03 +00001720 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001721 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001722
Eric Andersen7e9276b2001-02-22 01:15:47 +00001723#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001724 "SOURCE DEST\n" \
1725 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001726#define mv_full_usage \
1727 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001728#define mv_example_usage \
1729 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001730
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001731#define nameif_trivial_usage \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001732 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001733#define nameif_full_usage \
1734 "Nameif renaming network interface while it in the down state.\n\n" \
1735 "Options:\n" \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001736 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001737 "\t-s\t\tUse syslog (LOCAL0 facility).\n" \
1738 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address\n"
1739#define nameif_example_usage \
1740 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
1741 " or\n" \
1742 "$ nameif -c /etc/my_mactab_file\n" \
1743
Eric Andersen7e9276b2001-02-22 01:15:47 +00001744#define nc_trivial_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001745 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001746#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001747 "Netcat opens a pipe to IP:port\n\n" \
1748 "Options:\n" \
1749 "\t-l\t\tlisten mode, for inbound connects\n" \
1750 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00001751 "\t-i SECS\t\tdelay interval for lines sent\n" \
Eric Andersen00a6a752002-04-26 23:53:10 +00001752 "\t-e PROG\t\tprogram to exec after connect (dangerous!)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001753#define nc_example_usage \
1754 "$ nc foobar.somedomain.com 25\n" \
1755 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1756 "help\n" \
1757 "214-Commands supported:\n" \
1758 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1759 "214 NOOP QUIT RSET HELP\n" \
1760 "quit\n" \
1761 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001762
Eric Andersen1552ff72001-10-31 11:07:12 +00001763#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00001764 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00001765#define netstat_full_usage \
1766 "-l display listening server sockets\n" \
1767 "-a display all sockets (default: connected)\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001768 "-e display other/more information\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001769 "-n don't resolve names\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001770 "-r display routing table\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001771 "-t tcp sockets\n" \
1772 "-u udp sockets\n" \
1773 "-w raw sockets\n" \
1774 "-x unix sockets\n"
1775
Eric Andersen7e9276b2001-02-22 01:15:47 +00001776#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001777 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001778#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001779 "Queries the nameserver for the IP address of the given HOST\n" \
1780 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001781#define nslookup_example_usage \
1782 "$ nslookup localhost\n" \
1783 "Server: default\n" \
1784 "Address: default\n" \
1785 "\n" \
1786 "Name: debian\n" \
1787 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001788
Glenn L McGrath60281112001-11-02 11:39:46 +00001789#define od_trivial_usage \
1790 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
1791#define od_full_usage \
1792 "Write an unambiguous representation, octal bytes by default, of FILE\n"\
1793 "to standard output. With no FILE, or when FILE is -, read standard input."
1794
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00001795#define openvt_trivial_usage \
1796 "<vtnum> <COMMAND> [ARGS...]"
1797#define openvt_full_usage \
1798 "Start a command on a new virtual terminal"
1799#define openvt_example_usage \
1800 "openvt 2 /bin/ash\n"
1801
Eric Andersen27f64e12002-06-23 04:24:25 +00001802#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
1803 #define PASSWORD_ALG_TYPES(a) a
1804#else
1805 #define PASSWORD_ALG_TYPES(a)
1806#endif
1807#define passwd_trivial_usage \
1808 "[OPTION] [name]"
1809#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00001810 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00001811 "changes the password for the current user.\n" \
1812 "Options:\n" \
1813 "\t-a\tDefine which algorithm shall be used for the password.\n" \
1814 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001815 PASSWORD_ALG_TYPES(", sha1") \
Eric Andersen27f64e12002-06-23 04:24:25 +00001816 ")\n\t-d\tDelete the password for the specified user account.\n" \
1817 "\t-l\tLocks (disables) the specified user account.\n" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001818 "\t-u\tUnlocks (re-enables) the specified user account."
Eric Andersen27f64e12002-06-23 04:24:25 +00001819
Glenn L McGrath655d8142003-06-22 15:32:41 +00001820#define patch_trivial_usage \
1821 "[-p<num>]"
1822#define patch_full_usage \
1823 "[-p<num>]"
1824#define patch_example_usage \
1825 "$ patch -p1 <example.diff"
1826
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001827#define pidfilehack_trivial_usage \
1828 "[daemon.pid] [daemon]"
1829#define pidfilehack_full_usage \
1830 "service /var/run/daemon.pid /usr/sbin/daemon args...\n"
1831
Eric Andersen221b2ea2001-07-31 19:06:07 +00001832#define pidof_trivial_usage \
1833 "process-name [process-name ...]"
1834#define pidof_full_usage \
1835 "Lists the PIDs of all processes with names that match the names on the command line"
1836#define pidof_example_usage \
1837 "$ pidof init\n" \
1838 "1\n"
1839
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001840#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001841#define ping_trivial_usage "host"
1842#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1843#else
1844#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001845 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001846#define ping_full_usage \
1847 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1848 "Options:\n" \
1849 "\t-c COUNT\tSend only COUNT pings.\n" \
1850 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1851 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001852 "\t\t\tand when finished."
1853#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001854#define ping_example_usage \
1855 "$ ping localhost\n" \
1856 "PING slag (127.0.0.1): 56 data bytes\n" \
1857 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1858 "\n" \
1859 "--- debian ping statistics ---\n" \
1860 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1861 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001862
Eric Andersen51b8bd62002-07-03 11:46:38 +00001863#ifndef CONFIG_FEATURE_FANCY_PING6
1864#define ping6_trivial_usage "host"
1865#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1866#else
1867#define ping6_trivial_usage \
1868 "[OPTION]... host"
1869#define ping6_full_usage \
1870 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1871 "Options:\n" \
1872 "\t-c COUNT\tSend only COUNT pings.\n" \
1873 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1874 "\t-q\t\tQuiet mode, only displays output at start\n" \
1875 "\t\t\tand when finished."
1876#endif
1877#define ping6_example_usage \
1878 "$ ping6 ip6-localhost\n" \
1879 "PING ip6-localhost (::1): 56 data bytes\n" \
1880 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
1881 "\n" \
1882 "--- ip6-localhost ping statistics ---\n" \
1883 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1884 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
1885
Eric Andersen7e9276b2001-02-22 01:15:47 +00001886#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001887 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001888#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001889 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001890 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001891
Eric Andersen7e9276b2001-02-22 01:15:47 +00001892#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001893 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001894#define poweroff_full_usage \
1895 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001896
Eric Andersen7e9276b2001-02-22 01:15:47 +00001897#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001898 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001899#define printf_full_usage \
1900 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001901 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001902#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001903 "$ printf "Val=%d\\n" 5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001904 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001905
Eric Andersen7e9276b2001-02-22 01:15:47 +00001906#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001907 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001908#define ps_full_usage \
1909 "Report process status\n" \
Eric Andersen9e480452003-07-03 10:07:04 +00001910 USAGE_SELINUX("\nOptions:\n\t-c\tshow SE Linux context", "\nThis version of ps accepts no options.")
1911
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001912#define ps_example_usage \
1913 "$ ps\n" \
1914 " PID Uid Gid State Command\n" \
1915 " 1 root root S init\n" \
1916 " 2 root root S [kflushd]\n" \
1917 " 3 root root S [kupdate]\n" \
1918 " 4 root root S [kpiod]\n" \
1919 " 5 root root S [kswapd]\n" \
1920 " 742 andersen andersen S [bash]\n" \
1921 " 743 andersen andersen S -bash\n" \
1922 " 745 root root S [getty]\n" \
1923 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001924
Eric Andersen7e9276b2001-02-22 01:15:47 +00001925#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001926 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001927#define pwd_full_usage \
1928 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001929#define pwd_example_usage \
1930 "$ pwd\n" \
1931 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001932
Eric Andersen92fb9392003-08-08 20:09:03 +00001933#define raid_start_trivial_usage \
1934 "MD_DEVICE DISK_DEVICE"
1935#define raid_start_full_usage \
1936 "Start MD_DEVICE, taking superblock from DISK_DEVICE.\n" \
1937 "Example: raid_start /dev/md0 /dev/sdb"
1938
Eric Andersen7e9276b2001-02-22 01:15:47 +00001939#define rdate_trivial_usage \
Eric Andersen725db192003-07-22 08:26:05 +00001940 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001941#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001942 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001943 "Options:\n" \
1944 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001945 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001946
Eric Andersen7e9276b2001-02-22 01:15:47 +00001947#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001948 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001949#define readlink_full_usage \
1950 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001951
Glenn L McGrath62fae302002-12-10 00:14:33 +00001952#define realpath_trivial_usage \
1953 "pathname ..."
1954#define realpath_full_usage \
1955 "return the canonicalized absolute pathnames of given arguments\n\n"
1956
Eric Andersen7e9276b2001-02-22 01:15:47 +00001957#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001958 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001959#define reboot_full_usage \
1960 "Reboot the system."
1961
1962#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001963 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001964#define renice_full_usage \
1965 "Changes priority of running processes. Allowed priorities range\n" \
1966 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001967 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001968
Eric Andersen7e9276b2001-02-22 01:15:47 +00001969#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001970 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001971#define reset_full_usage \
1972 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001973
Eric Andersen7e9276b2001-02-22 01:15:47 +00001974#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001975 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001976#define rm_full_usage \
1977 "Remove (unlink) the FILE(s). You may use '--' to\n" \
1978 "indicate that all following arguments are non-options.\n\n" \
1979 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001980 "\t-i\t\talways prompt before removing each destination\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001981 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001982 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001983#define rm_example_usage \
1984 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001985
Eric Andersen7e9276b2001-02-22 01:15:47 +00001986#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001987 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001988#define rmdir_full_usage \
1989 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001990#define rmdir_example_usage \
1991 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001992
Eric Andersen7e9276b2001-02-22 01:15:47 +00001993#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001994 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001995#define rmmod_full_usage \
1996 "Unloads the specified kernel modules from the kernel.\n\n" \
1997 "Options:\n" \
Tim Rikercf932742002-12-14 01:58:59 +00001998 "\t-a\tRemove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001999#define rmmod_example_usage \
2000 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002001
Eric Andersen7e9276b2001-02-22 01:15:47 +00002002#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002003 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002004#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002005 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00002006 "Options:\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00002007 "\t-n\tDont resolve names.\n" \
2008 "\t-e\tDisplay other/more information"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002009
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002010#define rpm_trivial_usage \
2011 "-i -q[ildc]p package.rpm"
2012#define rpm_full_usage \
2013 "Manipulates RPM packages" \
Eric Andersendfce3532003-06-15 07:00:54 +00002014 "\n\nOptions:" \
2015 "\n\t-i Install package" \
2016 "\n\t-q Query package" \
2017 "\n\t-p Query uninstalled package" \
2018 "\n\t-i Show information" \
2019 "\n\t-l List contents" \
2020 "\n\t-d List documents" \
2021 "\n\t-c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002022
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002023#define rpm2cpio_trivial_usage \
2024 "package.rpm"
2025#define rpm2cpio_full_usage \
2026 "Outputs a cpio archive of the rpm file."
2027
Eric Andersen6cf47a72001-10-31 10:24:36 +00002028#define run_parts_trivial_usage \
2029 "[-t] [-a ARG] [-u MASK] DIRECTORY"
2030#define run_parts_full_usage \
2031 "Run a bunch of scripts in a directory.\n\n" \
2032 "Options:\n" \
2033 "\t-t\t\tTest only what file will be executed, without execute them.\n" \
2034 "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \
2035 "\t-u MASK\tSet the umask to MASK before executing every program."
2036
Eric Andersen7e9276b2001-02-22 01:15:47 +00002037#define sed_trivial_usage \
Matt Kraai075228a2001-06-21 14:40:55 +00002038 "[-nef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002039#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002040 "Options:\n" \
2041 "\t-n\t\tsuppress automatic printing of pattern space\n" \
2042 "\t-e script\tadd the script to the commands to be executed\n" \
2043 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002044 "\n" \
2045 "If no -e or -f is given, the first non-option argument is taken as the\n" \
2046 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002047 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002048#define sed_example_usage \
2049 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
2050 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002051
Eric Andersen7e9276b2001-02-22 01:15:47 +00002052#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002053 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002054#define setkeycodes_full_usage \
2055 "Set entries into the kernel's scancode-to-keycode map,\n" \
2056 "allowing unusual keyboards to generate usable keycodes.\n\n" \
2057 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002058 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002059#define setkeycodes_example_usage \
2060 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002061
Matt Kraai2d91deb2001-08-01 17:21:35 +00002062#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002063 "[FILE]...\n" \
2064 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00002065#define lash_full_usage \
Eric Andersen2e9c2572003-08-08 22:26:06 +00002066 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00002067#define lash_notes_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002068"This command does not yet have proper documentation.\n" \
2069"\n" \
2070"Use lash just as you would use any other shell. It properly handles pipes,\n" \
2071"redirects, job control, can be used as the shell for scripts, and has a\n" \
2072"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
2073"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
2074"use ash or bash. If you just need a very simple and extremely small shell,\n" \
2075"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002076
Eric Andersen2e9c2572003-08-08 22:26:06 +00002077#define last_trivial_usage \
2078 ""
2079#define last_full_usage \
2080 "Shows listing of the last users that logged into the system"
2081
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002082#define sha1sum_trivial_usage \
2083 "[OPTION] [FILE]"
2084#define sha1sum_full_usage \
2085 "[OPTION] [FILE]"
2086
Manuel Novoa III cad53642003-03-19 09:13:01 +00002087#ifdef CONFIG_FEATURE_FANCY_SLEEP
2088 #define USAGE_FANCY_SLEEP(a) a
2089 #define USAGE_NOT_FANCY_SLEEP(a)
2090#else
2091 #define USAGE_FANCY_SLEEP(a)
2092 #define USAGE_NOT_FANCY_SLEEP(a) a
2093#endif
2094
Eric Andersen7e9276b2001-02-22 01:15:47 +00002095#define sleep_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002096 USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002097#define sleep_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002098 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \
2099 USAGE_FANCY_SLEEP( \
2100"Pause for a time equal to the total of the args given, where each arg can\n" \
2101"have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002102#define sleep_example_usage \
2103 "$ sleep 2\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002104 "[2 second delay results]\n" \
2105 USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \
2106 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002107
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002108#ifdef CONFIG_FEATURE_SORT_UNIQUE
Mark Whitleyfccaa362001-04-17 18:56:18 +00002109 #define USAGE_SORT_UNIQUE(a) a
2110#else
2111 #define USAGE_SORT_UNIQUE(a)
2112#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002113#ifdef CONFIG_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002114 #define USAGE_SORT_REVERSE(a) a
2115#else
2116 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002117#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002118#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002119 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002120#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002121 "Sorts lines of text in the specified files\n\n"\
2122 "Options:\n" \
2123 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
2124 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
2125 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002126#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002127 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002128 "a\n" \
2129 "b\n" \
2130 "c\n" \
2131 "d\n" \
2132 "e\n" \
2133 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002134
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002135#define start_stop_daemon_trivial_usage \
2136 "[OPTIONS]"
2137#define start_stop_daemon_full_usage \
2138 "Program to start and stop services.\n"\
2139 "Options:\n" \
2140 "-S\t\t\tstart\n"\
2141 "-K\t\t\tstop\n"\
Eric Andersenfe5b1a92002-10-22 19:21:48 +00002142 "-b\t\t\tforce process into background (daemonize)\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002143 "-x <executable>\t\tprogram to start/check if it is running\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002144 "-u <username>|<uid>\tstop this user's processes\n"\
2145 "-n <process-name>\tstop processes with this name\n"\
2146 "-s <signal>\t\tsignal to send (default 15)\n"\
2147 "-a <pathname>\t\tprogram to start (default <executable>)\n"
2148
Eric Andersenef5e8f82002-11-07 02:09:37 +00002149#define strings_trivial_usage \
2150 "[-afo] [-n length] [file ... ]"
2151#define strings_full_usage \
2152 "Display printable strings in a binary file." \
2153 "\n\nOptions:" \
2154 "\n\t-f\tPrecede each string with the name of the file where it was found." \
2155 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
2156 "\n\t-o\tEach string is preceded by its decimal offset in the file."
2157
Eric Andersen7e9276b2001-02-22 01:15:47 +00002158#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002159 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002160#define stty_full_usage \
2161 "Without arguments, prints baud rate, line discipline," \
2162 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002163 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00002164 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002165 "\n\t-a\t\tprint all current settings in human-readable form" \
2166 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00002167 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002168
Robert Griebl1fca5582002-06-04 20:45:46 +00002169#define su_trivial_usage \
2170 "[OPTION]... [-] [username]"
2171#define su_full_usage \
2172 "Change user id or become root.\n" \
2173 "Options:\n" \
2174 "\t-p\tPreserve environment"
2175
Eric Andersen27f64e12002-06-23 04:24:25 +00002176#define sulogin_trivial_usage \
2177 "[OPTION]... [tty-device]"
2178#define sulogin_full_usage \
2179 "Single user login\n" \
2180 "Options:\n" \
2181 "\t-f\tDo not authenticate (user already authenticated)\n" \
2182 "\t-h\tName of the remote host for this login.\n" \
2183 "\t-p\tPreserve environment."
2184
Eric Andersen7e9276b2001-02-22 01:15:47 +00002185#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002186 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002187#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002188 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002189 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002190 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002191
Eric Andersen7e9276b2001-02-22 01:15:47 +00002192#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002193 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002194#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002195 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002196 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002197 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002198
Eric Andersen7e9276b2001-02-22 01:15:47 +00002199#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002200 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002201#define sync_full_usage \
2202 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002203
Eric Andersen7e9276b2001-02-22 01:15:47 +00002204
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002205#ifdef CONFIG_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00002206 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002207#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00002208 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002209#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00002210#ifdef CONFIG_FEATURE_IPC_SYSLOG
2211 #define USAGE_IPC_LOG(a) a
2212#else
2213 #define USAGE_IPC_LOG(a)
2214#endif
2215
Eric Andersen7e9276b2001-02-22 01:15:47 +00002216#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002217 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002218#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002219 "Linux system and kernel logging utility.\n" \
2220 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002221 "Options:\n" \
2222 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
2223 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002224 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002225 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00002226 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00002227 "\t-L\t\tLog locally and via network logging (default is network only)") \
2228 USAGE_IPC_LOG( \
2229 "\n\t-C\t\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002230#define syslogd_example_usage \
2231 "$ syslogd -R masterlog:514\n" \
2232 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002233
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002234
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002235#ifndef CONFIG_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00002236 #define USAGE_UNSIMPLE_TAIL(a)
2237#else
2238 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002239#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002240#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002241 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002242#define tail_full_usage \
2243 "Print last 10 lines of each FILE to standard output.\n" \
2244 "With more than one FILE, precede each with a header giving the\n" \
2245 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
2246 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002247 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002248 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
2249 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002250 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002251 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
2252 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002253 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002254 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002255 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
2256#define tail_example_usage \
2257 "$ tail -n 1 /etc/resolv.conf\n" \
2258 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002259
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002260#ifdef CONFIG_FEATURE_TAR_CREATE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002261 #define USAGE_TAR_CREATE(a) a
2262#else
2263 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002264#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002265#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002266 #define USAGE_TAR_EXCLUDE(a) a
2267#else
2268 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002269#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002270#ifdef CONFIG_FEATURE_TAR_GZIP
2271 #define USAGE_TAR_GZIP(a) a
2272#else
2273 #define USAGE_TAR_GZIP(a)
2274#endif
2275#ifdef CONFIG_FEATURE_TAR_BZIP2
2276 #define USAGE_TAR_BZIP2(a) a
2277#else
2278 #define USAGE_TAR_BZIP2(a)
2279#endif
2280
Eric Andersen7e9276b2001-02-22 01:15:47 +00002281#define tar_trivial_usage \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002282 "-[" USAGE_TAR_CREATE("c") USAGE_TAR_GZIP("z") USAGE_TAR_BZIP2("j") "xtvO] " \
Eric Andersen317827d2001-05-21 17:50:53 +00002283 USAGE_TAR_EXCLUDE("[--exclude FILE] [-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00002284 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002285#define tar_full_usage \
2286 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00002287 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002288 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002289 "\tx\t\textract\n" \
2290 "\tt\t\tlist\n" \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002291 "\nArchive format selection:\n" \
2292 USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
2293 USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002294 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002295 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002296 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002297 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002298 "\texclude\t\tfile to exclude\n" \
2299 "\tX\t\tfile with names to exclude\n" \
2300 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00002301 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002302 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002303#define tar_example_usage \
2304 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
2305 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002306
Eric Andersen7e9276b2001-02-22 01:15:47 +00002307#define tee_trivial_usage \
2308 "[OPTION]... [FILE]..."
2309#define tee_full_usage \
2310 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002311 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002312 "\t-a\tappend to the given FILEs, do not overwrite\n" \
2313 "\t-i\tignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002314#define tee_example_usage \
2315 "$ echo "Hello" | tee /tmp/foo\n" \
2316 "$ cat /tmp/foo\n" \
2317 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002318
Eric Andersen7e9276b2001-02-22 01:15:47 +00002319#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002320 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002321#define telnet_full_usage \
2322 "Telnet is used to establish interactive communication with another\n"\
2323 "computer over a network using the TELNET protocol."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002324
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002325#ifdef CONFIG_FEATURE_TELNETD_INETD
2326#define telnetd_trivial_usage \
2327 "(inetd mode) [OPTION]"
2328#define telnetd_full_usage \
2329 "Telnetd uses incoming TELNET connections via inetd.\n"\
2330 "Options:\n" \
2331 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
2332#else
Eric Andersen08a72202002-09-30 20:52:10 +00002333#define telnetd_trivial_usage \
2334 "[OPTION]"
2335#define telnetd_full_usage \
2336 "Telnetd listens for incoming TELNET connections on PORT.\n"\
2337 "Options:\n" \
2338 "\t-p PORT\tlisten for connections on PORT (default 23)\n"\
2339 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002340#endif
Eric Andersen08a72202002-09-30 20:52:10 +00002341
Eric Andersen7e9276b2001-02-22 01:15:47 +00002342#define test_trivial_usage \
2343 "EXPRESSION\n or [ EXPRESSION ]"
2344#define test_full_usage \
2345 "Checks file types and compares values returning an exit\n" \
2346 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002347#define test_example_usage \
2348 "$ test 1 -eq 2\n" \
2349 "$ echo $?\n" \
2350 "1\n" \
2351 "$ test 1 -eq 1\n" \
2352 "$ echo $? \n" \
2353 "0\n" \
2354 "$ [ -d /etc ]\n" \
2355 "$ echo $?\n" \
2356 "0\n" \
2357 "$ [ -d /junk ]\n" \
2358 "$ echo $?\n" \
2359 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002360
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002361#ifdef CONFIG_FEATURE_TFTP_GET
Mark Whitley450736c2001-03-02 19:08:50 +00002362 #define USAGE_TFTP_GET(a) a
2363#else
2364 #define USAGE_TFTP_GET(a)
2365#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002366#ifdef CONFIG_FEATURE_TFTP_PUT
Mark Whitley450736c2001-03-02 19:08:50 +00002367 #define USAGE_TFTP_PUT(a) a
2368#else
2369 #define USAGE_TFTP_PUT(a)
2370#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002371#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Glenn L McGrathad117d82001-10-05 04:40:37 +00002372 #define USAGE_TFTP_BS(a) a
2373#else
2374 #define USAGE_TFTP_BS(a)
2375#endif
Mark Whitley450736c2001-03-02 19:08:50 +00002376
2377#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00002378 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00002379#define tftp_full_usage \
2380 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00002381 "Options:\n" \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002382 "\t-l FILE\tLocal FILE.\n" \
2383 "\t-r FILE\tRemote FILE.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002384 USAGE_TFTP_GET( \
Matt Kraai3be34302001-09-21 14:42:30 +00002385 "\t-g\tGet file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002386 ) \
2387 USAGE_TFTP_PUT( \
Matt Kraai3be34302001-09-21 14:42:30 +00002388 "\t-p\tPut file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002389 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002390 USAGE_TFTP_BS( \
2391 "\t-b SIZE\tTransfer blocks of SIZE octets.\n" \
2392 )
Eric Andersenc3657422001-11-30 07:54:32 +00002393#define time_trivial_usage \
2394 "[OPTION]... COMMAND [ARGS...]"
2395#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00002396 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
2397 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00002398 "Options:\n" \
2399 "\t-v\tDisplays verbose resource usage information."
Mark Whitley450736c2001-03-02 19:08:50 +00002400
Eric Andersen420b2082002-09-17 22:14:58 +00002401#define top_trivial_usage \
2402 "[-d <seconds>]"
2403#define top_full_usage \
2404 "top provides an view of processor activity in real time.\n" \
2405 "This utility reads the status for all processes in /proc each <seconds>\n" \
2406 "and shows the status for however many processes will fit on the screen.\n" \
2407 "This utility will not show processes that are started after program startup,\n" \
2408 "but it will show the EXIT status for and PIDs that exit while it is running."
2409
Eric Andersen7e9276b2001-02-22 01:15:47 +00002410#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002411 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002412#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002413 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002414 "Options:\n" \
2415 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002416#define touch_example_usage \
2417 "$ ls -l /tmp/foo\n" \
2418 "/bin/ls: /tmp/foo: No such file or directory\n" \
2419 "$ touch /tmp/foo\n" \
2420 "$ ls -l /tmp/foo\n" \
2421 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002422
2423#define tr_trivial_usage \
2424 "[-cds] STRING1 [STRING2]"
2425#define tr_full_usage \
2426 "Translate, squeeze, and/or delete characters from\n" \
2427 "standard input, writing to standard output.\n\n" \
2428 "Options:\n" \
2429 "\t-c\ttake complement of STRING1\n" \
2430 "\t-d\tdelete input characters coded STRING1\n" \
2431 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002432#define tr_example_usage \
2433 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
2434 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002435
Eric Andersen5c58d282001-07-10 16:29:00 +00002436#define traceroute_trivial_usage \
2437 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n\
2438 [-s src_addr] [-t tos] [-w wait] host [data size]"
2439#define traceroute_full_usage \
2440 "trace the route ip packets follow going to \"host\"\n" \
2441 "Options:\n" \
2442 "\t-d\tset SO_DEBUG options to socket\n" \
2443 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
2444 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
2445 "\t-v\tVerbose output\n" \
2446 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
2447 "\t-p port#\tSet the base UDP port number used in probes\n" \
2448 "\t\t(default is 33434)\n" \
2449 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
2450 "\t\t(default is 3)\n" \
2451 "\t-s src_addr\tUse the following IP address as the source address\n" \
2452 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
2453 "\t\t(default 0)\n" \
2454 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
2455 "\t\t(default 3 sec.)."
2456
2457
Eric Andersen7e9276b2001-02-22 01:15:47 +00002458#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002459 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002460#define true_full_usage \
2461 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002462#define true_example_usage \
2463 "$ true\n" \
2464 "$ echo $?\n" \
2465 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002466
Eric Andersen7e9276b2001-02-22 01:15:47 +00002467#define tty_trivial_usage \
2468 ""
2469#define tty_full_usage \
2470 "Print the file name of the terminal connected to standard input.\n\n"\
2471 "Options:\n" \
2472 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002473#define tty_example_usage \
2474 "$ tty\n" \
2475 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002476
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002477#define udhcpc_trivial_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00002478 "[-fbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002479#define udhcpc_full_usage \
2480 "\t-c,\t--clientid=CLIENTID\tClient identifier\n" \
2481 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00002482 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002483 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00002484 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated.\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002485 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
2486 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated.\n" \
2487 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
2488 "\t-q,\t--quit\tQuit after obtaining lease\n" \
2489 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
2490 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
2491 "\t-v,\t--version\tDisplay version"
2492
Russ Dill61fb4892002-10-14 21:41:28 +00002493#define udhcpd_trivial_usage \
2494 "[configfile]\n" \
2495
2496#define udhcpd_full_usage \
Glenn L McGrath9130c852002-12-12 12:56:18 +00002497 ""
Russ Dill61fb4892002-10-14 21:41:28 +00002498
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002499#ifdef CONFIG_FEATURE_MOUNT_FORCE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002500 #define USAGE_MOUNT_FORCE(a) a
2501#else
2502 #define USAGE_MOUNT_FORCE(a)
2503#endif
2504#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002505 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002506#define umount_full_usage \
2507 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00002508 "\nFlags:\n" "\t-a\tUnmount all file systems" \
2509 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
2510 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00002511 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00002512 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 +00002513#define umount_example_usage \
2514 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002515
2516#define uname_trivial_usage \
2517 "[OPTION]..."
2518#define uname_full_usage \
2519 "Print certain system information. With no OPTION, same as -s.\n\n" \
2520 "Options:\n" \
2521 "\t-a\tprint all information\n" \
2522 "\t-m\tthe machine (hardware) type\n" \
2523 "\t-n\tprint the machine's network node hostname\n" \
2524 "\t-r\tprint the operating system release\n" \
2525 "\t-s\tprint the operating system name\n" \
2526 "\t-p\tprint the host processor type\n" \
2527 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002528#define uname_example_usage \
2529 "$ uname -a\n" \
2530 "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002531
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00002532#define uncompress_trivial_usage \
2533 "[-c] [-f] [ name ... ]"
2534#define uncompress_full_usage \
2535 "Uncompress .Z file[s]\n" \
2536 "Options:\n" \
2537 "\t-c\textract to stdout\n" \
2538 "\t-f\tforce overwrite an existing file\n"
2539
Eric Andersen7e9276b2001-02-22 01:15:47 +00002540#define uniq_trivial_usage \
2541 "[OPTION]... [INPUT [OUTPUT]]"
2542#define uniq_full_usage \
2543 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00002544 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002545 "Options:\n" \
2546 "\t-c\tprefix lines by the number of occurrences\n" \
2547 "\t-d\tonly print duplicate lines\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002548 "\t-u\tonly print unique lines\n" \
2549 "\t-f N\tskip the first N fields\n" \
2550 "\t-s N\tskip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002551#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002552 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002553 "a\n" \
2554 "b\n" \
2555 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002556
2557#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002558 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002559#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002560 "Converts FILE from unix format to dos format. When no option\n" \
2561 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002562 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002563 "Options:\n" \
2564 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002565 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002566
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002567#define unzip_trivial_usage \
2568 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
2569#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002570 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002571 "Options:\n" \
2572 "\t-l\tlist archive contents (short form)\n" \
2573 "\t-n\tnever overwrite existing files (default)\n" \
2574 "\t-o\toverwrite files without prompting\n" \
2575 "\t-p\tsend output to stdout\n" \
2576 "\t-q\tbe quiet\n" \
2577 "\t-x\texclude these files\n" \
2578 "\t-d\textract files into this directory"
2579
Eric Andersen7e9276b2001-02-22 01:15:47 +00002580#define uptime_trivial_usage \
2581 ""
2582#define uptime_full_usage \
2583 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002584#define uptime_example_usage \
2585 "$ uptime\n" \
2586 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002587
2588#define usleep_trivial_usage \
2589 "N"
2590#define usleep_full_usage \
2591 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002592#define usleep_example_usage \
2593 "$ usleep 1000000\n" \
2594 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002595
2596#define uudecode_trivial_usage \
2597 "[FILE]..."
2598#define uudecode_full_usage \
2599 "Uudecode a file that is uuencoded.\n\n" \
2600 "Options:\n" \
Eric Andersen704b2c22001-03-16 08:06:30 +00002601 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002602#define uudecode_example_usage \
2603 "$ uudecode -o busybox busybox.uu\n" \
2604 "$ ls -l busybox\n" \
2605 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002606
2607#define uuencode_trivial_usage \
2608 "[OPTION] [INFILE] REMOTEFILE"
2609#define uuencode_full_usage \
2610 "Uuencode a file.\n\n" \
2611 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00002612 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002613#define uuencode_example_usage \
2614 "$ uuencode busybox busybox\n" \
2615 "begin 755 busybox\n" \
2616 "<encoded file snipped>\n" \
2617 "$ uudecode busybox busybox > busybox.uu\n" \
2618 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002619
Eric Andersen853c4942003-01-23 05:59:32 +00002620#define vconfig_trivial_usage \
2621 "COMMAND [OPTIONS] ..."
2622
2623#define vconfig_full_usage \
2624"Usage: add [interface-name] [vlan_id] \n" \
2625" rem [vlan-name] \n" \
2626" set_flag [interface-name] [flag-num] [0 | 1] \n" \
2627" set_egress_map [vlan-name] [skb_priority] [vlan_qos] \n" \
2628" set_ingress_map [vlan-name] [skb_priority] [vlan_qos] \n" \
2629" set_name_type [name-type] \n"
2630
Eric Andersen3f980402001-04-04 17:31:15 +00002631#define vi_trivial_usage \
2632 "[OPTION] [FILE]..."
2633#define vi_full_usage \
2634 "edit FILE.\n\n" \
2635 "Options:\n" \
2636 "\t-R\tRead-only- do not write to the file."
2637
Eric Andersen27f64e12002-06-23 04:24:25 +00002638#define vlock_trivial_usage \
2639 "[OPTIONS]"
2640#define vlock_full_usage \
2641 "Lock a virtual terminal. A password is required to unlock\n" \
2642 "Options:\n" \
2643 "\t-a\tLock all VTs"
2644
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002645#define watch_trivial_usage \
2646 "[-n <seconds>] COMMAND..."
2647#define watch_full_usage \
2648 "Executes a program periodically.\n" \
2649 "Options:\n" \
2650 "\t-n\tLoop period in seconds - default is 2."
2651#define watch_example_usage \
2652 "$ watch date\n" \
2653 "Mon Dec 17 10:31:40 GMT 2000\n" \
2654 "Mon Dec 17 10:31:42 GMT 2000\n" \
2655 "Mon Dec 17 10:31:44 GMT 2000"
2656
Eric Andersen7e9276b2001-02-22 01:15:47 +00002657#define watchdog_trivial_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00002658 "[-t <seconds>] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002659#define watchdog_full_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00002660 "Periodically write to watchdog device DEV.\n" \
2661 "Options:\n" \
2662 "\t-t\tTimer period in seconds - default is 30."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002663
2664#define wc_trivial_usage \
2665 "[OPTION]... [FILE]..."
2666#define wc_full_usage \
2667 "Print line, word, and byte counts for each FILE, and a total line if\n" \
2668 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
2669 "Options:\n" \
2670 "\t-c\tprint the byte counts\n" \
2671 "\t-l\tprint the newline counts\n" \
2672 "\t-L\tprint the length of the longest line\n" \
2673 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002674#define wc_example_usage \
2675 "$ wc /etc/passwd\n" \
2676 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002677
2678#define wget_trivial_usage \
Robert Griebld7760112002-05-14 23:36:45 +00002679 "[-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 +00002680#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00002681 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002682 "Options:\n" \
2683 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00002684 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00002685 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00002686 "\t-O\tsave to filename ('-' for stdout)\n" \
2687 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002688
2689#define which_trivial_usage \
2690 "[COMMAND ...]"
2691#define which_full_usage \
2692 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002693#define which_example_usage \
2694 "$ which login\n" \
2695 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00002696
Eric Andersen00a6a752002-04-26 23:53:10 +00002697#define who_trivial_usage \
2698 " "
2699#define who_full_usage \
2700 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002701
2702#define whoami_trivial_usage \
2703 ""
2704#define whoami_full_usage \
2705 "Prints the user name associated with the current effective user id."
2706
2707#define xargs_trivial_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002708 "[COMMAND] [-prt] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002709#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002710 "Executes COMMAND on every item given by standard input.\n\n" \
2711 "Options:\n" \
2712 "\t-p\tPrompt the user about whether to run each command\n" \
2713 "\t-r\tDo not run command for empty readed lines\n" \
2714 "\t-t\tPrint the command line on stderr before executing it."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002715#define xargs_example_usage \
2716 "$ ls | xargs gzip\n" \
2717 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002718
2719#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002720 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002721#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002722 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002723
Eric Andersen7e9276b2001-02-22 01:15:47 +00002724#define zcat_trivial_usage \
2725 "FILE"
2726#define zcat_full_usage \
2727 "Uncompress to stdout."