blob: d60a4dc78a3de4f688e0361ccebddfc1228bd5e4 [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" \
221 "\t-S\tlog to syslod (defualt)\n" \
222 "\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
Eric Andersen7e9276b2001-02-22 01:15:47 +0000256#define date_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000257 "[OPTION]... [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000258#define date_full_usage \
259 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000260 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000261 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000262 "\t-d STRING\tdisplay time described by STRING, not `now'\n" \
263 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000264 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000265#define date_example_usage \
266 "$ date\n" \
267 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000268
Eric Andersen7e9276b2001-02-22 01:15:47 +0000269#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000270 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000271#define dc_full_usage \
272 "This is a Tiny RPN calculator that understands the\n" \
273 "following operations: +, -, /, *, and, or, not, eor.\n" \
Glenn L McGrath6d074322002-12-12 10:31:53 +0000274 "i.e., 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16" \
275 "p - Prints the value on the top of the stack, without altering the stack.\n" \
276 "f - Prints the entire contents of the stack without altering anything.\n" \
277 "o - Pops the value off the top of the stack and uses it to set the output radix.\n" \
278 " Only 10 and 16 are supported.\n"
279
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000280#define dc_example_usage \
281 "$ dc 2 2 +\n" \
282 "4\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000283 "$ dc 8 8 * 2 2 + /\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000284 "16\n" \
285 "$ dc 0 1 and\n" \
286 "0\n" \
287 "$ dc 0 1 or\n" \
288 "1\n" \
289 "$ echo 72 9 div 8 mul | dc\n" \
290 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000291
Eric Andersen7e9276b2001-02-22 01:15:47 +0000292#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000293 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000294 "\t [seek=N] [conv=notrunc|noerror|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000295#define dd_full_usage \
296 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000297 "\tif=FILE\t\tread from FILE instead of stdin\n" \
298 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
299 "\tbs=N\t\tread and write N bytes at a time\n" \
300 "\tcount=N\t\tcopy only N input blocks\n" \
301 "\tskip=N\t\tskip N input blocks\n" \
302 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000303 "\tconv=notrunc\tdon't truncate output file\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000304 "\tconv=noerror\tcontinue after read errors\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000305 "\tconv=sync\tpad blocks with zeros\n" \
306 "\n" \
307 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000308 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000309#define dd_example_usage \
310 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
311 "4+0 records in\n" \
312 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000313
Eric Andersen7e9276b2001-02-22 01:15:47 +0000314#define deallocvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000315 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000316#define deallocvt_full_usage \
317 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000318
Eric Andersenf349e972001-08-21 16:18:59 +0000319#define delgroup_trivial_usage \
320 "GROUP"
321#define delgroup_full_usage \
322 "Deletes group GROUP from the system"
323
324#define deluser_trivial_usage \
325 "USER"
326#define deluser_full_usage \
327 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000328
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000329#ifdef CONFIG_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000330 #define USAGE_HUMAN_READABLE(a) a
331 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000332#else
Eric Andersened0d9582001-02-23 13:23:03 +0000333 #define USAGE_HUMAN_READABLE(a)
334 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000335#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000336#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000337 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000338#define df_full_usage \
339 "Print the filesystem space used and space available.\n\n" \
340 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000341 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000342 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
343 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000344 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000345 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000346#define df_example_usage \
347 "$ df\n" \
348 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
349 "/dev/sda3 8690864 8553540 137324 98% /\n" \
350 "/dev/sda1 64216 36364 27852 57% /boot\n" \
351 "$ df /dev/sda3\n" \
352 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
353 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000354
Eric Andersen7e9276b2001-02-22 01:15:47 +0000355#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000356 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000357#define dirname_full_usage \
358 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000359#define dirname_example_usage \
360 "$ dirname /tmp/foo\n" \
361 "/tmp\n" \
362 "$ dirname /tmp/foo/\n" \
363 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000364
Eric Andersen7e9276b2001-02-22 01:15:47 +0000365#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000366 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000367#define dmesg_full_usage \
368 "Prints or controls the kernel ring buffer\n\n" \
369 "Options:\n" \
370 "\t-c\t\tClears the ring buffer's contents after printing\n" \
371 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000372 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000373
Eric Andersen7e9276b2001-02-22 01:15:47 +0000374#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000375 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000376#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000377 "Converts FILE from dos format to unix format. When no option\n" \
378 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000379 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000380 "Options:\n" \
381 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000382 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000383
Eric Andersen7e9276b2001-02-22 01:15:47 +0000384#define dpkg_trivial_usage \
Eric Andersen9fe5f982002-04-13 14:48:51 +0000385 "-i package_file\n" \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000386 "[-CPru] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000387#define dpkg_full_usage \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000388 "\t-i\tInstall the package\n" \
389 "\t-C\tConfigure an unpackaged package\n" \
390 "\t-P\tPurge all files of a package\n" \
391 "\t-r\tRemove all but the configuration files for a package\n" \
392 "\t-u\tUnpack a package, but dont configure it\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000393
Eric Andersen7e9276b2001-02-22 01:15:47 +0000394#define dpkg_deb_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000395 "[-cefItxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000396#define dpkg_deb_full_usage \
397 "Perform actions on debian packages (.debs)\n\n" \
398 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000399 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000400 "\t-e\tExtract control files to [argument] directory\n" \
401 "\t-f\tDisplay control field name starting with [argument]\n" \
402 "\t-I\tDisplay the control filenamed [argument]\n" \
403 "\t-t\tExtract filesystem tree to stdout in tar format\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000404 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000405 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000406#define dpkg_deb_example_usage \
407 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000408
Manuel Novoa III cad53642003-03-19 09:13:01 +0000409#ifdef CONFIG_FEATURE_DU_DEFALT_BLOCKSIZE_1K
410#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a) a
411#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a)
412#else
413#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a)
414#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a) a
415#endif
416
Eric Andersen7e9276b2001-02-22 01:15:47 +0000417#define du_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000418 "[-aHLdclsx" USAGE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000419#define du_full_usage \
420 "Summarizes disk space used for each FILE and/or directory.\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000421 "Disk space is printed in units of " \
422 USAGE_DU_DEFALT_BLOCKSIZE_1k("1024") USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k("512") \
423 " bytes.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000424 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000425 "\t-a\tshow sizes of files in addition to directories\n" \
426 "\t-H\tfollow symbolic links that are FILE command line args\n" \
427 "\t-L\tfollow all symbolic links encountered\n" \
428 "\t-d N\tlimit output to directories (and files with -a) of depth < N\n" \
429 "\t-c\toutput a grand total\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000430 "\t-l\tcount sizes many times if hard linked\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000431 "\t-s\tdisplay only a total for each argument\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000432 "\t-x\tskip directories on different filesystems\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000433 USAGE_HUMAN_READABLE( \
434 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
435 "\t-m\tprint sizes in megabytes\n" ) \
436 "\t-k\tprint sizes in kilobytes" USAGE_DU_DEFALT_BLOCKSIZE_1k("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000437#define du_example_usage \
438 "$ du\n" \
439 "16 ./CVS\n" \
440 "12 ./kernel-patches/CVS\n" \
441 "80 ./kernel-patches\n" \
442 "12 ./tests/CVS\n" \
443 "36 ./tests\n" \
444 "12 ./scripts/CVS\n" \
445 "16 ./scripts\n" \
446 "12 ./docs/CVS\n" \
447 "104 ./docs\n" \
448 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000449
Eric Andersen7e9276b2001-02-22 01:15:47 +0000450#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000451 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000452#define dumpkmap_full_usage \
453 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000454#define dumpkmap_example_usage \
455 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000456
Russ Dill61fb4892002-10-14 21:41:28 +0000457#define dumpleases_trivial_usage \
458 "[-r|-a] [-f LEASEFILE]"
459#define dumpleases_full_usage \
Russ Dill61fb4892002-10-14 21:41:28 +0000460 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
461 "\t-r,\t--remaining\tInterepret lease times as time remaing\n" \
462 "\t-a,\t--absolute\tInterepret lease times as expire time\n"
463
Eric Andersen7e9276b2001-02-22 01:15:47 +0000464#define dutmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000465 "[FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000466#define dutmp_full_usage \
467 "Dump utmp file format (pipe delimited) from FILE\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000468 "or stdin to stdout. (i.e., 'dutmp /var/run/utmp')"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000469#define dutmp_example_usage \
470 "$ dutmp /var/run/utmp\n" \
471 "8|7||si|||0|0|0|955637625|760097|0\n" \
472 "2|0|~|~~|reboot||0|0|0|955637625|782235|0\n" \
473 "1|20020|~|~~|runlevel||0|0|0|955637625|800089|0\n" \
474 "8|125||l4|||0|0|0|955637629|998367|0\n" \
475 "6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0\n" \
476 "6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000477 "7|336|pts/0|vt00|andersen|:0.0|0|0|0|955637763|0|0\n"
478
479#ifdef CONFIG_FEATURE_FANCY_ECHO
480 #define USAGE_FANCY_ECHO(a) a
481#else
482 #define USAGE_FANCY_ECHO(a)
483#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000484
Eric Andersen7e9276b2001-02-22 01:15:47 +0000485#define echo_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000486 USAGE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000487#define echo_full_usage \
488 "Prints the specified ARGs to stdout\n\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000489 USAGE_FANCY_ECHO("Options:\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000490 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000491 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000492 "\t-E\tdisable interpretation of backslash-escaped characters")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000493#define echo_example_usage \
494 "$ echo "Erik is cool"\n" \
495 "Erik is cool\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000496 USAGE_FANCY_ECHO("$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000497 "Erik\n" \
498 "is\n" \
499 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000500 "$ echo "Erik\\nis\\ncool"\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000501 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000502
Eric Andersen84e229c2001-03-29 22:48:33 +0000503#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000504 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000505#define env_full_usage \
506 "Prints the current environment or runs a program after setting\n" \
507 "up the specified environment.\n\n" \
508 "Options:\n" \
509 "\t-, -i\tstart with an empty environment\n" \
510 "\t-u\tremove variable from the environment\n"
511
Eric Andersen7e9276b2001-02-22 01:15:47 +0000512#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000513 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000514#define expr_full_usage \
515 "Prints the value of EXPRESSION to standard output.\n\n" \
516 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000517 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
518 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
519 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
520 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
521 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
522 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
523 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
524 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
525 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
526 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
527 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
528 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
529 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000530 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
531 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
532 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
533 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
534 "\t or 0\n" \
535 "\tlength STRING length of STRING\n" \
536 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
537 "\t it is a keyword like `match' or an\n" \
538 "\t operator like `/'\n" \
539 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000540 "Beware that many operators need to be escaped or quoted for shells.\n" \
541 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
542 "lexicographical. Pattern matches return the string matched between \n" \
543 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
544 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000545
Eric Andersen7e9276b2001-02-22 01:15:47 +0000546#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000547 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000548#define false_full_usage \
549 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000550#define false_example_usage \
551 "$ false\n" \
552 "$ echo $?\n" \
553 "1\n"
554
555#define fbset_trivial_usage \
556 "[options] [mode]"
557#define fbset_full_usage \
558 "Show and modify frame buffer settings"
559#define fbset_example_usage \
560 "$ fbset\n" \
561 "mode "1024x768-76"\n" \
562 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
563 "\tgeometry 1024 768 1024 768 16\n" \
564 "\ttimings 12714 128 32 16 4 128 4\n" \
565 "\taccel false\n" \
566 "\trgba 5/11,6/5,5/0,0/0\n" \
567 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000568
Eric Andersen7e9276b2001-02-22 01:15:47 +0000569#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000570 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000571#define fdflush_full_usage \
572 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000573
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000574#define fdisk_trivial_usage \
575 "[-l] [-v] [-b SSZ] [-u] DISK"
576#define fdisk_full_usage \
577 "Change partition table\n" \
578 "Options:\n" \
579 "-l List partition table(s)\n" \
580 "-u Give Start and End in sector (instead of cylinder) units\n" \
581 "-s PARTITION Give partition size(s) in blocks\n" \
582 "-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
Glenn L McGrath062c74f2002-11-27 09:29:49 +0000583 "-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000584
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000585#ifdef CONFIG_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000586 #define USAGE_FIND_TYPE(a) a
587#else
588 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000589#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000590#ifdef CONFIG_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000591 #define USAGE_FIND_PERM(a) a
592#else
593 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000594#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000595#ifdef CONFIG_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000596 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000597#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000598 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000599#endif
Eric Andersen97d86f22003-01-23 05:27:42 +0000600#ifdef CONFIG_FEATURE_FIND_NEWER
601 #define USAGE_FIND_NEWER(a) a
602#else
603 #define USAGE_FIND_NEWER(a)
604#endif
605#ifdef CONFIG_FEATURE_FIND_INUM
606 #define USAGE_FIND_INUM(a) a
607#else
608 #define USAGE_FIND_INUM(a)
609#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000610
Eric Andersen7e9276b2001-02-22 01:15:47 +0000611#define find_trivial_usage \
612 "[PATH...] [EXPRESSION]"
613#define find_full_usage \
614 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000615 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000616 "\nEXPRESSION may consist of:\n" \
617 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000618 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000619 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000620 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000621 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
622) USAGE_FIND_PERM( \
623 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
624) USAGE_FIND_MTIME( \
Eric Andersen97d86f22003-01-23 05:27:42 +0000625 "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \
626) USAGE_FIND_NEWER( \
627 "\n\t-newer FILE\tModified time is more recent than FILE's" \
628) USAGE_FIND_INUM( \
629 "\n\t-inum N\t\tFile has inode number N")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000630#define find_example_usage \
631 "$ find / -name /etc/passwd\n" \
632 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000633
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000634#define fold_trivial_usage \
635 "[bsw] [FILE]"
636#define fold_full_usage \
637 "Wrap input lines in each FILE (standard input by default), writing to\n" \
638 "standard output.\n\n" \
639 "Options:\n" \
640 "\t-b\tcount bytes rather than columns\n" \
641 "\t-s\tbreak at spaces\n" \
642 "\t-w\tuse WIDTH columns instead of 80\n"
643
Eric Andersen7e9276b2001-02-22 01:15:47 +0000644#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000645 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000646#define free_full_usage \
647 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000648#define free_example_usage \
649 "$ free\n" \
650 " total used free shared buffers\n" \
651 " Mem: 257628 248724 8904 59644 93124\n" \
652 " Swap: 128516 8404 120112\n" \
653 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000654
Eric Andersen7e9276b2001-02-22 01:15:47 +0000655#define freeramdisk_trivial_usage \
656 "DEVICE"
657#define freeramdisk_full_usage \
658 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000659#define freeramdisk_example_usage \
660 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000661
662#define fsck_minix_trivial_usage \
663 "[-larvsmf] /dev/name"
664#define fsck_minix_full_usage \
665 "Performs a consistency check for MINIX filesystems.\n\n" \
666 "Options:\n" \
667 "\t-l\tLists all filenames\n" \
668 "\t-r\tPerform interactive repairs\n" \
669 "\t-a\tPerform automatic repairs\n" \
670 "\t-v\tverbose\n" \
671 "\t-s\tOutputs super-block information\n" \
672 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
673 "\t-f\tForce file system check."
674
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000675#define ftpget_trivial_usage \
676 "[options] remote-host local-directory remote-file"
677#define ftpget_full_usage \
678 "Retrieve a remote file via FTP.\n\n" \
679 "Options:\n" \
680 "\t-c, --continue Continue a previous transfer\n" \
681 "\t-v, --verbose Verbose\n" \
682 "\t-u, --username Username to be used\n" \
683 "\t-p, --password Password to be used\n" \
684 "\t-P, --port Port number to be used\n"
685
686#define ftpput_trivial_usage \
687 "[options] remote-host remote-directory local-file"
688#define ftpput_full_usage \
689 "Store a local file on a remote machine via FTP.\n\n" \
690 "Options:\n" \
691 "\t-v, --verbose Verbose\n" \
692 "\t-u, --username Username to be used\n" \
693 "\t-p, --password Password to be used\n" \
694 "\t-P, --port Port number to be used\n"
695
Eric Andersen7e9276b2001-02-22 01:15:47 +0000696#define getopt_trivial_usage \
697 "[OPTIONS]..."
698#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000699 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000700 "\t-a, --alternative Allow long options starting with single -\n" \
701 "\t-l, --longoptions=longopts Long options to be recognized\n" \
702 "\t-n, --name=progname The name under which errors are reported\n" \
703 "\t-o, --options=optstring Short options to be recognized\n" \
704 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
705 "\t-Q, --quiet-output No normal output\n" \
706 "\t-s, --shell=shell Set shell quoting conventions\n" \
707 "\t-T, --test Test for getopt(1) version\n" \
708 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000709#define getopt_example_usage \
710 "$ cat getopt.test\n" \
711 "#!/bin/sh\n" \
712 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
713 " -n 'example.busybox' -- "$@"`\n" \
714 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
715 "eval set -- "$GETOPT"\n" \
716 "while true ; do\n" \
717 " case $1 in\n" \
718 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000719 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000720 " -c|--c-long)\n" \
721 " case "$2" in\n" \
722 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000723 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000724 " esac ;;\n" \
725 " --) shift ; break ;;\n" \
726 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
727 " esac\n" \
728 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000729
Eric Andersenf349e972001-08-21 16:18:59 +0000730#define getty_trivial_usage \
731 "getty [OPTIONS]... baud_rate,... line [termtype]"
732#define getty_full_usage \
733 "\nOpens a tty, prompts for a login name, then invokes /bin/login\n\n" \
734 "Options:\n" \
735 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
736 "\t-i\t\tDo not display /etc/issue before running login.\n" \
737 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
738 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
739 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
Glenn L McGrath49e74ef2003-05-13 14:59:07 +0000740 "\t-n\t\tDo not prompt the user for a login name.\n" \
741 "\t-f issue_file\tDisplay issue_file instead of /etc/issue.\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000742 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
743 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
744 "\t-I initstring\tSets the init string to send before anything else.\n" \
745 "\t-H login_host\tLog login_host into the utmp file as the hostname."
746
747
Eric Andersen7e9276b2001-02-22 01:15:47 +0000748#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000749 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000750#define grep_full_usage \
751 "Search for PATTERN in each FILE or standard input.\n\n" \
752 "Options:\n" \
753 "\t-H\tprefix output lines with filename where match was found\n" \
754 "\t-h\tsuppress the prefixing filename on output\n" \
755 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000756 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000757 "\t-n\tprint line number with output lines\n" \
758 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
759 "\t-v\tselect non-matching lines\n" \
760 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000761#define grep_example_usage \
762 "$ grep root /etc/passwd\n" \
763 "root:x:0:0:root:/root:/bin/bash\n" \
764 "$ grep ^[rR]oo. /etc/passwd\n" \
765 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000766
Eric Andersen7e9276b2001-02-22 01:15:47 +0000767#define gunzip_trivial_usage \
768 "[OPTION]... FILE"
769#define gunzip_full_usage \
770 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
771 "Options:\n" \
772 "\t-c\tWrite output to standard output\n" \
773 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000774#define gunzip_example_usage \
775 "$ ls -la /tmp/BusyBox*\n" \
776 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
777 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
778 "$ ls -la /tmp/BusyBox*\n" \
779 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000780
781#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000782 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000783#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000784 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000785 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000786 "Options:\n" \
787 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
788 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000789#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000790 "$ ls -la /tmp/busybox*\n" \
791 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
792 "$ gzip /tmp/busybox.tar\n" \
793 "$ ls -la /tmp/busybox*\n" \
794 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000795
796#define halt_trivial_usage \
797 ""
798#define halt_full_usage \
799 "Halt the system."
800
Manuel Novoa III cad53642003-03-19 09:13:01 +0000801#ifdef CONFIG_FEATURE_FANCY_HEAD
802#define USAGE_FANCY_HEAD(a) a
803#else
804#define USAGE_FANCY_HEAD(a)
805#endif
806
Eric Andersen7e9276b2001-02-22 01:15:47 +0000807#define head_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000808 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000809#define head_full_usage \
810 "Print first 10 lines of each FILE to standard output.\n" \
811 "With more than one FILE, precede each with a header giving the\n" \
812 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000813 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000814 "\t-n NUM\t\tPrint first NUM lines instead of first 10" \
815 USAGE_FANCY_HEAD( \
816 "\n\t-c NUM\t\toutput the first NUM bytes\n" \
817 "\t-q\t\tnever output headers giving file names\n" \
818 "\t-v\t\talways output headers giving file names" )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000819#define head_example_usage \
820 "$ head -n 2 /etc/passwd\n" \
821 "root:x:0:0:root:/root:/bin/bash\n" \
822 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000823
Glenn L McGrath60281112001-11-02 11:39:46 +0000824#define hexdump_trivial_usage \
825 "[-[bcdefnosvx]] [OPTION] FILE"
826#define hexdump_full_usage \
827 "The hexdump utility is a filter which displays the specified files,\n" \
828 "or the standard input, if no files are specified, in a user specified\n"\
829 "format\n" \
830 "\t-b\t\tOne-byte octal display\n" \
831 "\t-c\t\tOne-byte character display\n" \
832 "\t-d\t\tTwo-byte decimal display\n" \
833 "\t-e FORMAT STRING\n" \
834 "\t-f FORMAT FILE\n" \
835 "\t-n LENGTH\tInterpret only length bytes of input\n" \
836 "\t-o\t\tTwo-byte octal display\n" \
837 "\t-s OFFSET\tSkip offset byte\n" \
838 "\t-v\t\tdisplay all input data\n" \
839 "\t-x\t\tTwo-byte hexadecimal display\n"
840
Eric Andersen7e9276b2001-02-22 01:15:47 +0000841#define hostid_trivial_usage \
842 ""
843#define hostid_full_usage \
844 "Print out a unique 32-bit identifier for the machine."
845
846#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000847 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000848#define hostname_full_usage \
849 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000850 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000851 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +0000852 "\t-s\tShort\n" \
853 "\t-i\tAddresses for the hostname\n" \
854 "\t-d\tDNS domain name\n" \
855 "\t-f\tFully qualified domain name\n" \
856 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000857#define hostname_example_usage \
858 "$ hostname\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000859 "sage \n"
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000860#ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH
861 #define USAGE_HTTPD_BASIC_AUTH(a) a
862#else
863 #define USAGE_HTTPD_BASIC_AUTH(a)
864#endif
865#define httpd_trivial_usage \
866 "[-p <port>] [-d/-e <string>]" USAGE_HTTPD_BASIC_AUTH(" [-c <conf file>] [-r <realm>]")
867#define httpd_full_usage \
868 "Listens for incoming http server requests.\n"\
869 "Options:\n" \
870 "\t-p PORT\tServer port (default 80).\n" \
871 USAGE_HTTPD_BASIC_AUTH("\t-c FILE\tSpecifies configuration file. (default httpd.conf)\n\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
872 "\t-e STRING\tHtml encode STRING\n" \
873 "\t-d STRING\tURL decode STRING\n"
Robert Griebl1cd04452002-07-21 16:50:49 +0000874#define hwclock_trivial_usage \
875 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
876#define hwclock_full_usage \
877 "Query and set the hardware clock (RTC)\n\n" \
878 "Options:\n" \
879 "\t-r\tread hardware clock and print result\n" \
880 "\t-s\tset the system time from the hardware clock\n" \
881 "\t-w\tset the hardware clock to the current system time\n" \
882 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
883 "\t-l\tthe hardware clock is kept in local time"
884
Eric Andersen7e9276b2001-02-22 01:15:47 +0000885#define id_trivial_usage \
886 "[OPTIONS]... [USERNAME]"
887#define id_full_usage \
888 "Print information for USERNAME or the current user\n\n" \
889 "Options:\n" \
890 "\t-g\tprints only the group ID\n" \
891 "\t-u\tprints only the user ID\n" \
892 "\t-n\tprint a name instead of a number (with for -ug)\n" \
893 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000894#define id_example_usage \
895 "$ id\n" \
896 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000897
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000898#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +0000899 #define USAGE_SIOCSKEEPALIVE(a) a
900#else
901 #define USAGE_SIOCSKEEPALIVE(a)
902#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000903#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000904 #define USAGE_IFCONFIG_MII(a) a
905#else
906 #define USAGE_IFCONFIG_MII(a)
907#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000908#ifdef CONFIG_FEATURE_IFCONFIG_HW
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000909 #define USAGE_IFCONFIG_HW(a) a
910#else
911 #define USAGE_IFCONFIG_HW(a)
912#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000913#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000914 #define USAGE_IFCONFIG_OPT_A(a) a
915#else
916 #define USAGE_IFCONFIG_OPT_A(a)
917#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +0000918#ifdef CONFIG_FEATURE_IPV6
919 #define USAGE_IPV6(a) a
920#else
921 #define USAGE_IPV6(a)
922#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000923
Eric Andersen7e9276b2001-02-22 01:15:47 +0000924#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000925 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000926#define ifconfig_full_usage \
927 "configure a network interface\n\n" \
928 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +0000929 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
930 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000931 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000932 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000933 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000934 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
935 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000936 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000937 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
938 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000939 "\t[up|down] ..."
940
Glenn L McGrath021fa7d2002-11-09 09:34:15 +0000941#define ifup_trivial_usage \
942 "<-ahinv> <ifaces...>"
943#define ifup_full_usage \
944 "Usage: ifup <options> <ifaces...>\n\n" \
945 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +0000946 "\t-h\tthis help\n" \
947 "\t-a\tde/configure all interfaces automatically\n" \
948 "\t-i FILE\tuse FILE for interface definitions\n" \
949 "\t-n\tprint out what would happen, but don't do it\n" \
950 "\t\t\t(note that this option doesn't disable mappings)\n" \
951 "\t-v\tprint out what would happen before doing it\n" \
952 "\t-m\tdon't run any mappings\n" \
953 "\t-f\tforce de/configuration\n"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +0000954
955#define ifdown_trivial_usage \
956 "<-ahinv> <ifaces...>"
957#define ifdown_full_usage \
958 "Usage: ifdown <options> <ifaces...>\n\n" \
959 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +0000960 "\t-h\tthis help\n" \
961 "\t-a\tde/configure all interfaces automatically\n" \
962 "\t-i FILE\tuse FILE for interface definitions\n" \
963 "\t-n\tprint out what would happen, but don't do it\n" \
964 "\t\t(note that this option doesn't disable mappings)\n" \
965 "\t-v\tprint out what would happen before doing it\n" \
966 "\t-m\tdon't run any mappings\n" \
967 "\t-f\tforce de/configuration\n"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +0000968
Glenn L McGrath06e95652003-02-09 06:51:14 +0000969#define inetd_trivial_usage \
970 "[-q len] [conf]"
971#define inetd_full_usage \
972 "Usage: [-q len] [conf]\n\n" \
973 "Option:\n" \
974 "\t-q\tSets the size of the socket listen queue to\n" \
975 "the specified value. Default is 128."
976
Eric Andersen7e9276b2001-02-22 01:15:47 +0000977#define init_trivial_usage \
978 ""
979#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000980 "Init is the parent of all processes."
981#define init_notes_usage \
982"This version of init is designed to be run only by the kernel.\n" \
983"\n" \
984"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
985"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
986"runlevels, use sysvinit.\n" \
987"\n" \
988"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
989"it has the following default behavior:\n" \
990"\n" \
991" ::sysinit:/etc/init.d/rcS\n" \
992" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000993" ::ctrlaltdel:/sbin/reboot\n" \
994" ::shutdown:/sbin/swapoff -a\n" \
995" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000996" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000997"\n" \
998"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
999"\n" \
1000" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001001" tty3::askfirst:/bin/sh\n" \
1002" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001003"\n" \
1004"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1005"\n" \
1006" <id>:<runlevels>:<action>:<process>\n" \
1007"\n" \
1008" <id>: \n" \
1009"\n" \
1010" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1011" The id field is used by BusyBox init to specify the controlling tty for\n" \
1012" the specified process to run on. The contents of this field are\n" \
1013" appended to "/dev/" and used as-is. There is no need for this field to\n" \
1014" be unique, although if it isn't you may have strange results. If this\n" \
1015" field is left blank, the controlling tty is set to the console. Also\n" \
1016" note that if BusyBox detects that a serial console is in use, then only\n" \
1017" entries whose controlling tty is either the serial console or /dev/null\n" \
1018" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1019" stinkin' utmp.\n" \
1020"\n" \
1021" <runlevels>: \n" \
1022"\n" \
1023" The runlevels field is completely ignored.\n" \
1024"\n" \
1025" <action>: \n" \
1026"\n" \
1027" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001028" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001029"\n" \
1030" The available actions can be classified into two groups: actions\n" \
1031" that are run only once, and actions that are re-run when the specified\n" \
1032" process exits.\n" \
1033"\n" \
1034" Run only-once actions:\n" \
1035"\n" \
1036" 'sysinit' is the first item run on boot. init waits until all\n" \
1037" sysinit actions are completed before continuing. Following the\n" \
1038" completion of all sysinit actions, all 'wait' actions are run.\n" \
1039" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001040" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001041" therefore, init does not wait for them to complete. 'restart' is\n" \
1042" the action taken to restart the init process. By default this should\n" \
1043" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1044" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001045" actions are run when the system detects that someone on the system\n" \
1046" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1047" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1048" Finally the 'shutdown' action specifies the actions to taken when\n" \
1049" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1050" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001051"\n" \
1052" Run repeatedly actions:\n" \
1053"\n" \
1054" 'respawn' actions are run after the 'once' actions. When a process\n" \
1055" started with a 'respawn' action exits, init automatically restarts\n" \
1056" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1057" respawning out of control. The 'askfirst' actions acts just like\n" \
1058" respawn, except that before running the specified process it\n" \
1059" displays the line "Please press Enter to activate this console."\n" \
1060" and then waits for the user to press enter before starting the\n" \
1061" specified process. \n" \
1062"\n" \
1063" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1064" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001065" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001066"\n" \
1067" <process>: \n" \
1068"\n" \
1069" Specifies the process to be executed and it's command line.\n" \
1070"\n" \
1071"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001072"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001073" # This is run first except when booting in single-user mode.\n" \
1074" #\n" \
1075" ::sysinit:/etc/init.d/rcS\n" \
1076" \n" \
1077" # /bin/sh invocations on selected ttys\n" \
1078" #\n" \
1079" # Start an "askfirst" shell on the console (whatever that may be)\n" \
1080" ::askfirst:-/bin/sh\n" \
1081" # Start an "askfirst" shell on /dev/tty2-4\n" \
1082" tty2::askfirst:-/bin/sh\n" \
1083" tty3::askfirst:-/bin/sh\n" \
1084" tty4::askfirst:-/bin/sh\n" \
1085" \n" \
1086" # /sbin/getty invocations for selected ttys\n" \
1087" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001088" tty4::respawn:/sbin/getty 38400 tty4\n" \
1089" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001090" \n" \
1091" \n" \
1092" # Example of how to put a getty on a serial line (for a terminal)\n" \
1093" #\n" \
1094" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1095" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1096" #\n" \
1097" # Example how to put a getty on a modem line.\n" \
1098" #::respawn:/sbin/getty 57600 ttyS2\n" \
1099" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001100" # Stuff to do when restarting the init process\n" \
1101" ::restart:/sbin/init\n" \
1102" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001103" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001104" ::ctrlaltdel:/sbin/reboot\n" \
1105" ::shutdown:/bin/umount -a -r\n" \
1106" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001107
Eric Andersenbe65c352003-01-23 04:57:35 +00001108#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
1109 #define USAGE_INSMOD_MAP(a) a
1110#else
1111 #define USAGE_INSMOD_MAP(a)
1112#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001113#define insmod_trivial_usage \
1114 "[OPTION]... MODULE [symbol=value]..."
1115#define insmod_full_usage \
1116 "Loads the specified kernel modules into the kernel.\n\n" \
1117 "Options:\n" \
1118 "\t-f\tForce module to load into the wrong kernel version.\n" \
1119 "\t-k\tMake module autoclean-able.\n" \
1120 "\t-v\tverbose output\n" \
1121 "\t-L\tLock to prevent simultaneous loads of a module\n" \
Eric Andersenbe65c352003-01-23 04:57:35 +00001122 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout") \
1123 "\t-x\tdo not export externs\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001124
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001125#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001126 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001127#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001128 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1129 "where OBJECT := { link | addr | route | tunnel }\n" \
1130 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }\n"
1131
1132#define ipaddr_trivial_usage \
1133 "{ {add|del} IFADDR dev STRING | {show|flush} [ dev STRING ] [ to PREFIX ] }"
1134#define ipaddr_full_usage \
1135 "ipaddr {add|del} IFADDR dev STRING\n" \
1136 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
1137 " [ to PREFIX ] [ label PATTERN ]\n" \
1138 "IFADDR := PREFIX | ADDR peer PREFIX\n" \
1139 " [ broadcast ADDR ] [ anycast ADDR ]\n" \
1140 " [ label STRING ] [ scope SCOPE-ID ]\n" \
1141 "SCOPE-ID := [ host | link | global | NUMBER ]\n"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001142
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001143#ifndef CONFIG_FEATURE_IPCALC_FANCY
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001144# define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001145 "[--broadcast] [--netmask] [--network] ipaddr <netmask>"
1146
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001147# define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001148 "Calculate IP network settings from a IP address\n\n" \
1149 "Options:\n" \
1150 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1151 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
1152 "\t-w\t--network\tDisplay calculated network address."
1153#else
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001154# define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001155 "[OPTION]... ipaddr <netmask>"
1156
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001157# define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001158 "Calculate IP network settings from a IP address\n\n" \
1159 "Options:\n" \
1160 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1161 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
1162 "\t-w\t--network\tDisplay calculated network address.\n" \
1163 "\t-h\t--hostname\tDisplay first resolved host name.\n" \
1164 "\t-s\t--silent\tDon't ever display error messages."
1165#endif
1166
1167#define ipcalc_notes_usage \
1168 "ipcalc provides a simple way to calculate IP information for\n" \
1169 "a host. The various options specify what information ipcalc\n" \
1170 "should display on standard out. Multiple options may be\n" \
1171 "specified.\n"
1172
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001173#define iplink_trivial_usage \
1174 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1175#define iplink_full_usage \
1176 "iplink set DEVICE { up | down | arp { on | off } |\n" \
1177 " dynamic { on | off } |\n" \
1178 " mtu MTU }\n" \
1179 "iplink show [ DEVICE ]\n"
1180
1181#define iproute_trivial_usage \
1182 "{ list | flush | { add | del | change | append | replace | monitor } ROUTE }"
1183#define iproute_full_usage \
1184 "iproute { list | flush } SELECTOR\n" \
1185 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
1186 " [ oif STRING ] [ tos TOS ]\n" \
1187 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
1188 "SELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1189 "ROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]\n"
1190
1191#define iptunnel_trivial_usage \
1192 "{ add | change | del | show } [ NAME ] [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
1193#define iptunnel_full_usage \
1194 "iptunnel { add | change | del | show } [ NAME ]\n" \
1195 " [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1196 " [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1197 " [ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]\n"
1198
Eric Andersen7e9276b2001-02-22 01:15:47 +00001199#define kill_trivial_usage \
1200 "[-signal] process-id [process-id ...]"
1201#define kill_full_usage \
1202 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +00001203 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001204 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001205#define kill_example_usage \
1206 "$ ps | grep apache\n" \
1207 "252 root root S [apache]\n" \
1208 "263 www-data www-data S [apache]\n" \
1209 "264 www-data www-data S [apache]\n" \
1210 "265 www-data www-data S [apache]\n" \
1211 "266 www-data www-data S [apache]\n" \
1212 "267 www-data www-data S [apache]\n" \
1213 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001214
1215#define killall_trivial_usage \
1216 "[-signal] process-name [process-name ...]"
1217#define killall_full_usage \
1218 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001219 "Options:\n" \
1220 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001221#define killall_example_usage \
1222 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001223
Mark Whitley6317c4b2001-03-12 22:51:50 +00001224#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001225 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001226#define klogd_full_usage \
1227 "Kernel logger.\n"\
1228 "Options:\n"\
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001229 "\t-c n\tSets the default log level of console messages to n.\n"\
Mark Whitley6317c4b2001-03-12 22:51:50 +00001230 "\t-n\tRun as a foreground process."
1231
Eric Andersen7e9276b2001-02-22 01:15:47 +00001232#define length_trivial_usage \
1233 "STRING"
1234#define length_full_usage \
1235 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001236#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001237 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001238 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001239
1240#define ln_trivial_usage \
1241 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1242#define ln_full_usage \
1243 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
1244 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1245 "Options:\n" \
1246 "\t-s\tmake symbolic links instead of hard links\n" \
1247 "\t-f\tremove existing destination files\n" \
1248 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001249#define ln_example_usage \
1250 "$ ln -s BusyBox /tmp/ls\n" \
1251 "$ ls -l /tmp/ls\n" \
1252 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001253
1254#define loadacm_trivial_usage \
1255 "< mapfile"
1256#define loadacm_full_usage \
1257 "Loads an acm from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001258#define loadacm_example_usage \
1259 "$ loadacm < /etc/i18n/acmname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001260
1261#define loadfont_trivial_usage \
1262 "< font"
1263#define loadfont_full_usage \
1264 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001265#define loadfont_example_usage \
1266 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001267
1268#define loadkmap_trivial_usage \
1269 "< keymap"
1270#define loadkmap_full_usage \
1271 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001272#define loadkmap_example_usage \
1273 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001274
1275#define logger_trivial_usage \
1276 "[OPTION]... [MESSAGE]"
1277#define logger_full_usage \
1278 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1279 "Options:\n" \
1280 "\t-s\tLog to stderr as well as the system log.\n" \
1281 "\t-t\tLog using the specified tag (defaults to user name).\n" \
1282 "\t-p\tEnter the message with the specified priority.\n" \
1283 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001284#define logger_example_usage \
1285 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001286
Robert Griebl1fca5582002-06-04 20:45:46 +00001287#define login_trivial_usage \
1288 "[OPTION]... [username] [ENV=VAR ...]"
1289#define login_full_usage \
1290 "Begin a new session on the system\n\n" \
1291 "Options:\n" \
1292 "\t-f\tDo not authenticate (user already authenticated)\n" \
1293 "\t-h\tName of the remote host for this login.\n" \
1294 "\t-p\tPreserve environment."
1295
Eric Andersen7e9276b2001-02-22 01:15:47 +00001296#define logname_trivial_usage \
1297 ""
1298#define logname_full_usage \
1299 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001300#define logname_example_usage \
1301 "$ logname\n" \
1302 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001303
Mark Whitley6317c4b2001-03-12 22:51:50 +00001304#define logread_trivial_usage \
1305 ""
1306
1307#define logread_full_usage \
1308 "Shows the messages from syslogd (using circular buffer)."
1309
Matt Kraai83788da2002-03-20 17:38:37 +00001310#define losetup_trivial_usage \
1311 "[OPTION]... LOOPDEVICE FILE\n" \
1312 "or: losetup [OPTION]... -d LOOPDEVICE"
1313#define losetup_full_usage \
1314 "Associate LOOPDEVICE with FILE.\n\n" \
1315 "Options:\n" \
1316 "\t-d\t\tDisassociate LOOPDEVICE.\n" \
1317 "\t-o OFFSET\tStart OFFSET bytes into FILE.\n"
1318
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001319#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001320 #define USAGE_LS_TIMESTAMPS(a) a
1321#else
1322 #define USAGE_LS_TIMESTAMPS(a)
1323#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001324#ifdef CONFIG_FEATURE_LS_FILETYPES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001325 #define USAGE_LS_FILETYPES(a) a
1326#else
1327 #define USAGE_LS_FILETYPES(a)
1328#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001329#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001330 #define USAGE_LS_FOLLOWLINKS(a) a
1331#else
1332 #define USAGE_LS_FOLLOWLINKS(a)
1333#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001334#ifdef CONFIG_FEATURE_LS_RECURSIVE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001335 #define USAGE_LS_RECURSIVE(a) a
1336#else
1337 #define USAGE_LS_RECURSIVE(a)
1338#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001339#ifdef CONFIG_FEATURE_LS_SORTFILES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001340 #define USAGE_LS_SORTFILES(a) a
1341#else
1342 #define USAGE_LS_SORTFILES(a)
1343#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001344#ifdef CONFIG_FEATURE_AUTOWIDTH
Eric Andersen7e9276b2001-02-22 01:15:47 +00001345 #define USAGE_AUTOWIDTH(a) a
1346#else
1347 #define USAGE_AUTOWIDTH(a)
1348#endif
1349#define ls_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +00001350 "[-1Aa" USAGE_LS_TIMESTAMPS("c") "Cd" USAGE_LS_TIMESTAMPS("e") USAGE_LS_FILETYPES("F") "iln" USAGE_LS_FILETYPES("p") USAGE_LS_FOLLOWLINKS("L") USAGE_LS_RECURSIVE("R") USAGE_LS_SORTFILES("rS") "s" USAGE_AUTOWIDTH("T") USAGE_LS_TIMESTAMPS("tu") USAGE_LS_SORTFILES("v") USAGE_AUTOWIDTH("w") "x" USAGE_LS_SORTFILES("X") USAGE_HUMAN_READABLE("h") USAGE_NOT_HUMAN_READABLE("") "k] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001351#define ls_full_usage \
1352 "List directory contents\n\n" \
1353 "Options:\n" \
1354 "\t-1\tlist files in a single column\n" \
1355 "\t-A\tdo not list implied . and ..\n" \
1356 "\t-a\tdo not hide entries starting with .\n" \
1357 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001358 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001359 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001360 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1361 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001362 "\t-i\tlist the i-node for each file\n" \
1363 "\t-l\tuse a long listing format\n" \
1364 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001365 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1366 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1367 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1368 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1369 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001370 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001371 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1372 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1373 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1374 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1375 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001376 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001377 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1378 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001379 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersened0d9582001-02-23 13:23:03 +00001380 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +00001381 "\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001382
1383#define lsmod_trivial_usage \
1384 ""
1385#define lsmod_full_usage \
1386 "List the currently loaded kernel modules."
1387
1388#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001389 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001390#define makedevs_full_usage \
1391 "Creates a range of block or character special files\n\n" \
1392 "TYPEs include:\n" \
1393 "\tb:\tMake a block (buffered) device.\n" \
1394 "\tc or u:\tMake a character (un-buffered) device.\n" \
1395 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1396 "FIRST specifies the number appended to NAME to create the first device.\n" \
1397 "LAST specifies the number of the last item that should be created.\n" \
1398 "If 's' is the last argument, the base device is created as well.\n\n" \
1399 "For example:\n" \
1400 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001401 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001402#define makedevs_example_usage \
1403 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
1404 "[creates ttyS2-ttyS63]\n" \
1405 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
1406 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001407
Eric Andersen7e9276b2001-02-22 01:15:47 +00001408#define md5sum_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001409 "[OPTION] [FILE]...\n" \
1410 "or: md5sum [OPTION] -c [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001411#define md5sum_full_usage \
1412 "Print or check MD5 checksums.\n\n" \
1413 "Options:\n" \
1414 "With no FILE, or when FILE is -, read standard input.\n\n" \
1415 "\t-b\tread files in binary mode\n" \
1416 "\t-c\tcheck MD5 sums against given list\n" \
1417 "\t-t\tread files in text mode (default)\n" \
1418 "\t-g\tread a string\n" \
1419 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001420 "\t-s\tdon't output anything, status code shows success\n" \
1421 "\t-w\twarn about improperly formated MD5 checksum lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001422#define md5sum_example_usage \
1423 "$ md5sum < busybox\n" \
1424 "6fd11e98b98a58f64ff3398d7b324003\n" \
1425 "$ md5sum busybox\n" \
1426 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1427 "$ md5sum -c -\n" \
1428 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1429 "busybox: OK\n" \
1430 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001431
Glenn L McGrath061c9002002-09-16 04:21:46 +00001432#define mesg_trivial_usage \
1433 "mesg [y|n]"
1434#define mesg_full_usage \
1435 "mesg [Y|N], controls write access to your terminal\n" \
1436 "\ty\tAllow write access to your terminal.\n" \
1437 "\tn\tDisallow write access to your terminal.\n"
1438
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001439#define minit_trivial_usage \
1440 "[-spPrRC]"
1441#define minit_full_usage \
1442 "[-spPrRC]"
1443
Eric Andersen7e9276b2001-02-22 01:15:47 +00001444#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001445 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001446#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001447 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001448 "Options:\n" \
1449 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001450 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001451#define mkdir_example_usage \
1452 "$ mkdir /tmp/foo\n" \
1453 "$ mkdir /tmp/foo\n" \
1454 "/tmp/foo: File exists\n" \
1455 "$ mkdir /tmp/foo/bar/baz\n" \
1456 "/tmp/foo/bar/baz: No such file or directory\n" \
1457 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001458
Eric Andersen7e9276b2001-02-22 01:15:47 +00001459#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001460 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001461#define mkfifo_full_usage \
1462 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1463 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001464 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001465
Eric Andersen7e9276b2001-02-22 01:15:47 +00001466#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001467 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001468#define mkfs_minix_full_usage \
1469 "Make a MINIX filesystem.\n\n" \
1470 "Options:\n" \
1471 "\t-c\t\tCheck the device for bad blocks\n" \
1472 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1473 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1474 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001475 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001476
Eric Andersen7e9276b2001-02-22 01:15:47 +00001477#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001478 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001479#define mknod_full_usage \
1480 "Create a special file (block, character, or pipe).\n\n" \
1481 "Options:\n" \
1482 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1483 "TYPEs include:\n" \
1484 "\tb:\tMake a block (buffered) device.\n" \
1485 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001486 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001487#define mknod_example_usage \
1488 "$ mknod /dev/fd0 b 2 0 \n" \
1489 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001490
Eric Andersen7e9276b2001-02-22 01:15:47 +00001491#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001492 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001493#define mkswap_full_usage \
1494 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001495 "Options:\n" \
1496 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001497 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001498 "\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 +00001499 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001500
Eric Andersen7e9276b2001-02-22 01:15:47 +00001501#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001502 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001503#define mktemp_full_usage \
1504 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001505 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001506#define mktemp_example_usage \
1507 "$ mktemp /tmp/temp.XXXXXX\n" \
1508 "/tmp/temp.mWiLjM\n" \
1509 "$ ls -la /tmp/temp.mWiLjM\n" \
1510 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001511
Eric Andersen8d79ce82001-07-22 23:00:15 +00001512#define modprobe_trivial_usage \
1513 "[FILE ...]"
1514#define modprobe_full_usage \
Eric Andersenabc95682002-07-03 02:52:35 +00001515 "Used for high level module loading and unloading."
Eric Andersen8d79ce82001-07-22 23:00:15 +00001516#define modprobe_example_usage \
1517 "$ modprobe cdrom\n"
1518
Eric Andersen7e9276b2001-02-22 01:15:47 +00001519#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001520 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001521#define more_full_usage \
1522 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001523#define more_example_usage \
1524 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001525
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001526#ifdef CONFIG_FEATURE_MOUNT_LOOP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001527 #define USAGE_MOUNT_LOOP(a) a
1528#else
1529 #define USAGE_MOUNT_LOOP(a)
1530#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001531#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001532 #define USAGE_MTAB(a) a
1533#else
1534 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001535#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001536#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001537 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001538#define mount_full_usage \
1539 "Mount a filesystem\n\n" \
1540 "Flags:\n" \
1541 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001542 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001543 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001544 "\t-n:\t\tDon't write a mount table entry.\n" \
1545 ) \
1546 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1547 "\t-r:\t\tMount the filesystem read-only.\n" \
1548 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1549 "\t-w:\t\tMount for reading and writing (default).\n" \
1550 "\n" \
1551 "Options for use with the \"-o\" flag:\n" \
1552 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1553 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1554 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1555 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001556 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001557 "\tloop:\t\tMounts a file via loop device.\n" \
1558 ) \
1559 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001560 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001561 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001562 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001563 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001564 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001565#define mount_example_usage \
1566 "$ mount\n" \
1567 "/dev/hda3 on / type minix (rw)\n" \
1568 "proc on /proc type proc (rw)\n" \
1569 "devpts on /dev/pts type devpts (rw)\n" \
1570 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1571 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001572
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001573#define msvc_trivial_usage \
1574 "-[udorspchaitkx] service"
1575#define msvc_full_usafe \
1576 "[option] service\n" \
1577 "Where option is one of\n" \
1578 "\t-u\tUp. If the service is not running, start it. If the service stops, restart it.\n" \
1579 "\t-d\tDown. If the service is running, stop it, do not restart it.\n" \
1580 "\t-o\tOnce. If the service is not running, start it. Do not restart it if it stops.\n" \
1581 "\t-r\tTell supervise that the service is normally running; this affects status messages.\n" \
1582 "\t-s\tTell supervise that the service is normally stopped; this affects status messages.\n" \
1583 "\t-p\tPause. Send the service a STOP signal.\n" \
1584 "\t-c\tContinue. Send the service a CONT signal.\n" \
1585 "\t-h\tHangup. Send the service a HUP signal.\n" \
1586 "\t-a\tAlarm. Send the service an ALRM signal.\n" \
1587 "\t-i\tInterrupt. Send the service an INT signal.\n" \
1588 "\t-t\tTerminate. Send the service a TERM signal.\n" \
1589 "\t-k\tKill. Send the service a KILL signal.\n" \
1590 "\t-x\tExit. supervise will quit as soon as the service is down.\n"
1591
Eric Andersen7e9276b2001-02-22 01:15:47 +00001592#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001593 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001594#define mt_full_usage \
1595 "Control magnetic tape drive operation\n" \
1596 "\nAvailable Opcodes:\n\n" \
1597 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1598 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
1599 "ras3 reset retension rew rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001600 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001601
Eric Andersen7e9276b2001-02-22 01:15:47 +00001602#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001603 "SOURCE DEST\n" \
1604 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001605#define mv_full_usage \
1606 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001607#define mv_example_usage \
1608 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001609
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001610#define nameif_trivial_usage \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001611 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001612#define nameif_full_usage \
1613 "Nameif renaming network interface while it in the down state.\n\n" \
1614 "Options:\n" \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001615 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001616 "\t-s\t\tUse syslog (LOCAL0 facility).\n" \
1617 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address\n"
1618#define nameif_example_usage \
1619 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
1620 " or\n" \
1621 "$ nameif -c /etc/my_mactab_file\n" \
1622
Eric Andersen7e9276b2001-02-22 01:15:47 +00001623#define nc_trivial_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001624 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001625#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001626 "Netcat opens a pipe to IP:port\n\n" \
1627 "Options:\n" \
1628 "\t-l\t\tlisten mode, for inbound connects\n" \
1629 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00001630 "\t-i SECS\t\tdelay interval for lines sent\n" \
Eric Andersen00a6a752002-04-26 23:53:10 +00001631 "\t-e PROG\t\tprogram to exec after connect (dangerous!)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001632#define nc_example_usage \
1633 "$ nc foobar.somedomain.com 25\n" \
1634 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1635 "help\n" \
1636 "214-Commands supported:\n" \
1637 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1638 "214 NOOP QUIT RSET HELP\n" \
1639 "quit\n" \
1640 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001641
Eric Andersen1552ff72001-10-31 11:07:12 +00001642#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00001643 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00001644#define netstat_full_usage \
1645 "-l display listening server sockets\n" \
1646 "-a display all sockets (default: connected)\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001647 "-e display other/more information\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001648 "-n don't resolve names\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001649 "-r display routing table\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001650 "-t tcp sockets\n" \
1651 "-u udp sockets\n" \
1652 "-w raw sockets\n" \
1653 "-x unix sockets\n"
1654
Eric Andersen7e9276b2001-02-22 01:15:47 +00001655#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001656 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001657#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001658 "Queries the nameserver for the IP address of the given HOST\n" \
1659 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001660#define nslookup_example_usage \
1661 "$ nslookup localhost\n" \
1662 "Server: default\n" \
1663 "Address: default\n" \
1664 "\n" \
1665 "Name: debian\n" \
1666 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001667
Glenn L McGrath60281112001-11-02 11:39:46 +00001668#define od_trivial_usage \
1669 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
1670#define od_full_usage \
1671 "Write an unambiguous representation, octal bytes by default, of FILE\n"\
1672 "to standard output. With no FILE, or when FILE is -, read standard input."
1673
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00001674#define openvt_trivial_usage \
1675 "<vtnum> <COMMAND> [ARGS...]"
1676#define openvt_full_usage \
1677 "Start a command on a new virtual terminal"
1678#define openvt_example_usage \
1679 "openvt 2 /bin/ash\n"
1680
Eric Andersen27f64e12002-06-23 04:24:25 +00001681#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
1682 #define PASSWORD_ALG_TYPES(a) a
1683#else
1684 #define PASSWORD_ALG_TYPES(a)
1685#endif
1686#define passwd_trivial_usage \
1687 "[OPTION] [name]"
1688#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00001689 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00001690 "changes the password for the current user.\n" \
1691 "Options:\n" \
1692 "\t-a\tDefine which algorithm shall be used for the password.\n" \
1693 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001694 PASSWORD_ALG_TYPES(", sha1") \
Eric Andersen27f64e12002-06-23 04:24:25 +00001695 ")\n\t-d\tDelete the password for the specified user account.\n" \
1696 "\t-l\tLocks (disables) the specified user account.\n" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001697 "\t-u\tUnlocks (re-enables) the specified user account."
Eric Andersen27f64e12002-06-23 04:24:25 +00001698
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001699#define pidfilehack_trivial_usage \
1700 "[daemon.pid] [daemon]"
1701#define pidfilehack_full_usage \
1702 "service /var/run/daemon.pid /usr/sbin/daemon args...\n"
1703
Eric Andersen221b2ea2001-07-31 19:06:07 +00001704#define pidof_trivial_usage \
1705 "process-name [process-name ...]"
1706#define pidof_full_usage \
1707 "Lists the PIDs of all processes with names that match the names on the command line"
1708#define pidof_example_usage \
1709 "$ pidof init\n" \
1710 "1\n"
1711
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001712#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001713#define ping_trivial_usage "host"
1714#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1715#else
1716#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001717 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001718#define ping_full_usage \
1719 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1720 "Options:\n" \
1721 "\t-c COUNT\tSend only COUNT pings.\n" \
1722 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1723 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001724 "\t\t\tand when finished."
1725#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001726#define ping_example_usage \
1727 "$ ping localhost\n" \
1728 "PING slag (127.0.0.1): 56 data bytes\n" \
1729 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1730 "\n" \
1731 "--- debian ping statistics ---\n" \
1732 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1733 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001734
Eric Andersen51b8bd62002-07-03 11:46:38 +00001735#ifndef CONFIG_FEATURE_FANCY_PING6
1736#define ping6_trivial_usage "host"
1737#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1738#else
1739#define ping6_trivial_usage \
1740 "[OPTION]... host"
1741#define ping6_full_usage \
1742 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1743 "Options:\n" \
1744 "\t-c COUNT\tSend only COUNT pings.\n" \
1745 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1746 "\t-q\t\tQuiet mode, only displays output at start\n" \
1747 "\t\t\tand when finished."
1748#endif
1749#define ping6_example_usage \
1750 "$ ping6 ip6-localhost\n" \
1751 "PING ip6-localhost (::1): 56 data bytes\n" \
1752 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
1753 "\n" \
1754 "--- ip6-localhost ping statistics ---\n" \
1755 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1756 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
1757
Eric Andersen7e9276b2001-02-22 01:15:47 +00001758#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001759 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001760#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001761 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001762 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001763
Eric Andersen7e9276b2001-02-22 01:15:47 +00001764#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001765 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001766#define poweroff_full_usage \
1767 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001768
Eric Andersen7e9276b2001-02-22 01:15:47 +00001769#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001770 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001771#define printf_full_usage \
1772 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001773 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001774#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001775 "$ printf "Val=%d\\n" 5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001776 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001777
Eric Andersen7e9276b2001-02-22 01:15:47 +00001778#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001779 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001780#define ps_full_usage \
1781 "Report process status\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001782 "\nThis version of ps accepts no options."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001783#define ps_example_usage \
1784 "$ ps\n" \
1785 " PID Uid Gid State Command\n" \
1786 " 1 root root S init\n" \
1787 " 2 root root S [kflushd]\n" \
1788 " 3 root root S [kupdate]\n" \
1789 " 4 root root S [kpiod]\n" \
1790 " 5 root root S [kswapd]\n" \
1791 " 742 andersen andersen S [bash]\n" \
1792 " 743 andersen andersen S -bash\n" \
1793 " 745 root root S [getty]\n" \
1794 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001795
Eric Andersen7e9276b2001-02-22 01:15:47 +00001796#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001797 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001798#define pwd_full_usage \
1799 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001800#define pwd_example_usage \
1801 "$ pwd\n" \
1802 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001803
Eric Andersen7e9276b2001-02-22 01:15:47 +00001804#define rdate_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001805 "[OPTION] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001806#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001807 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001808 "Options:\n" \
1809 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001810 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001811
Eric Andersen7e9276b2001-02-22 01:15:47 +00001812#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001813 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001814#define readlink_full_usage \
1815 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001816
Glenn L McGrath62fae302002-12-10 00:14:33 +00001817#define realpath_trivial_usage \
1818 "pathname ..."
1819#define realpath_full_usage \
1820 "return the canonicalized absolute pathnames of given arguments\n\n"
1821
Eric Andersen7e9276b2001-02-22 01:15:47 +00001822#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001823 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001824#define reboot_full_usage \
1825 "Reboot the system."
1826
1827#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001828 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001829#define renice_full_usage \
1830 "Changes priority of running processes. Allowed priorities range\n" \
1831 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001832 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001833
Eric Andersen7e9276b2001-02-22 01:15:47 +00001834#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001835 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001836#define reset_full_usage \
1837 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001838
Eric Andersen7e9276b2001-02-22 01:15:47 +00001839#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001840 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001841#define rm_full_usage \
1842 "Remove (unlink) the FILE(s). You may use '--' to\n" \
1843 "indicate that all following arguments are non-options.\n\n" \
1844 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001845 "\t-i\t\talways prompt before removing each destination\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001846 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001847 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001848#define rm_example_usage \
1849 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001850
Eric Andersen7e9276b2001-02-22 01:15:47 +00001851#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001852 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001853#define rmdir_full_usage \
1854 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001855#define rmdir_example_usage \
1856 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001857
Eric Andersen7e9276b2001-02-22 01:15:47 +00001858#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001859 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001860#define rmmod_full_usage \
1861 "Unloads the specified kernel modules from the kernel.\n\n" \
1862 "Options:\n" \
Tim Rikercf932742002-12-14 01:58:59 +00001863 "\t-a\tRemove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001864#define rmmod_example_usage \
1865 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001866
Eric Andersen7e9276b2001-02-22 01:15:47 +00001867#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001868 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001869#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00001870 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00001871 "Options:\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001872 "\t-n\tDont resolve names.\n" \
1873 "\t-e\tDisplay other/more information"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001874
Glenn L McGrathb72a7352002-12-10 00:17:22 +00001875#define rpm_trivial_usage \
1876 "-i -q[ildc]p package.rpm"
1877#define rpm_full_usage \
1878 "Manipulates RPM packages" \
Eric Andersendfce3532003-06-15 07:00:54 +00001879 "\n\nOptions:" \
1880 "\n\t-i Install package" \
1881 "\n\t-q Query package" \
1882 "\n\t-p Query uninstalled package" \
1883 "\n\t-i Show information" \
1884 "\n\t-l List contents" \
1885 "\n\t-d List documents" \
1886 "\n\t-c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00001887
Glenn L McGrathf8736d22001-06-26 01:19:34 +00001888#define rpm2cpio_trivial_usage \
1889 "package.rpm"
1890#define rpm2cpio_full_usage \
1891 "Outputs a cpio archive of the rpm file."
1892
Eric Andersen6cf47a72001-10-31 10:24:36 +00001893#define run_parts_trivial_usage \
1894 "[-t] [-a ARG] [-u MASK] DIRECTORY"
1895#define run_parts_full_usage \
1896 "Run a bunch of scripts in a directory.\n\n" \
1897 "Options:\n" \
1898 "\t-t\t\tTest only what file will be executed, without execute them.\n" \
1899 "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \
1900 "\t-u MASK\tSet the umask to MASK before executing every program."
1901
Eric Andersen7e9276b2001-02-22 01:15:47 +00001902#define sed_trivial_usage \
Matt Kraai075228a2001-06-21 14:40:55 +00001903 "[-nef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001904#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001905 "Options:\n" \
1906 "\t-n\t\tsuppress automatic printing of pattern space\n" \
1907 "\t-e script\tadd the script to the commands to be executed\n" \
1908 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001909 "\n" \
1910 "If no -e or -f is given, the first non-option argument is taken as the\n" \
1911 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001912 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001913#define sed_example_usage \
1914 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
1915 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001916
Eric Andersen7e9276b2001-02-22 01:15:47 +00001917#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001918 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001919#define setkeycodes_full_usage \
1920 "Set entries into the kernel's scancode-to-keycode map,\n" \
1921 "allowing unusual keyboards to generate usable keycodes.\n\n" \
1922 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001923 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001924#define setkeycodes_example_usage \
1925 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001926
Matt Kraai2d91deb2001-08-01 17:21:35 +00001927#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001928 "[FILE]...\n" \
1929 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00001930#define lash_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001931 "lash: The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00001932#define lash_notes_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001933"This command does not yet have proper documentation.\n" \
1934"\n" \
1935"Use lash just as you would use any other shell. It properly handles pipes,\n" \
1936"redirects, job control, can be used as the shell for scripts, and has a\n" \
1937"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
1938"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
1939"use ash or bash. If you just need a very simple and extremely small shell,\n" \
1940"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001941
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00001942#define sha1sum_trivial_usage \
1943 "[OPTION] [FILE]"
1944#define sha1sum_full_usage \
1945 "[OPTION] [FILE]"
1946
Manuel Novoa III cad53642003-03-19 09:13:01 +00001947#ifdef CONFIG_FEATURE_FANCY_SLEEP
1948 #define USAGE_FANCY_SLEEP(a) a
1949 #define USAGE_NOT_FANCY_SLEEP(a)
1950#else
1951 #define USAGE_FANCY_SLEEP(a)
1952 #define USAGE_NOT_FANCY_SLEEP(a) a
1953#endif
1954
Eric Andersen7e9276b2001-02-22 01:15:47 +00001955#define sleep_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001956 USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001957#define sleep_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001958 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \
1959 USAGE_FANCY_SLEEP( \
1960"Pause for a time equal to the total of the args given, where each arg can\n" \
1961"have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001962#define sleep_example_usage \
1963 "$ sleep 2\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001964 "[2 second delay results]\n" \
1965 USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \
1966 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001967
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001968#ifdef CONFIG_FEATURE_SORT_UNIQUE
Mark Whitleyfccaa362001-04-17 18:56:18 +00001969 #define USAGE_SORT_UNIQUE(a) a
1970#else
1971 #define USAGE_SORT_UNIQUE(a)
1972#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001973#ifdef CONFIG_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001974 #define USAGE_SORT_REVERSE(a) a
1975#else
1976 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001977#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001978#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001979 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001980#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001981 "Sorts lines of text in the specified files\n\n"\
1982 "Options:\n" \
1983 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
1984 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
1985 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001986#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001987 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001988 "a\n" \
1989 "b\n" \
1990 "c\n" \
1991 "d\n" \
1992 "e\n" \
1993 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001994
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001995#define start_stop_daemon_trivial_usage \
1996 "[OPTIONS]"
1997#define start_stop_daemon_full_usage \
1998 "Program to start and stop services.\n"\
1999 "Options:\n" \
2000 "-S\t\t\tstart\n"\
2001 "-K\t\t\tstop\n"\
Eric Andersenfe5b1a92002-10-22 19:21:48 +00002002 "-b\t\t\tforce process into background (daemonize)\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002003 "-x <executable>\t\tprogram to start/check if it is running\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002004 "-u <username>|<uid>\tstop this user's processes\n"\
2005 "-n <process-name>\tstop processes with this name\n"\
2006 "-s <signal>\t\tsignal to send (default 15)\n"\
2007 "-a <pathname>\t\tprogram to start (default <executable>)\n"
2008
Eric Andersenef5e8f82002-11-07 02:09:37 +00002009#define strings_trivial_usage \
2010 "[-afo] [-n length] [file ... ]"
2011#define strings_full_usage \
2012 "Display printable strings in a binary file." \
2013 "\n\nOptions:" \
2014 "\n\t-f\tPrecede each string with the name of the file where it was found." \
2015 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
2016 "\n\t-o\tEach string is preceded by its decimal offset in the file."
2017
Eric Andersen7e9276b2001-02-22 01:15:47 +00002018#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002019 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002020#define stty_full_usage \
2021 "Without arguments, prints baud rate, line discipline," \
2022 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002023 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00002024 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002025 "\n\t-a\t\tprint all current settings in human-readable form" \
2026 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00002027 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002028
Robert Griebl1fca5582002-06-04 20:45:46 +00002029#define su_trivial_usage \
2030 "[OPTION]... [-] [username]"
2031#define su_full_usage \
2032 "Change user id or become root.\n" \
2033 "Options:\n" \
2034 "\t-p\tPreserve environment"
2035
Eric Andersen27f64e12002-06-23 04:24:25 +00002036#define sulogin_trivial_usage \
2037 "[OPTION]... [tty-device]"
2038#define sulogin_full_usage \
2039 "Single user login\n" \
2040 "Options:\n" \
2041 "\t-f\tDo not authenticate (user already authenticated)\n" \
2042 "\t-h\tName of the remote host for this login.\n" \
2043 "\t-p\tPreserve environment."
2044
Eric Andersen7e9276b2001-02-22 01:15:47 +00002045#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002046 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002047#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002048 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002049 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002050 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002051
Eric Andersen7e9276b2001-02-22 01:15:47 +00002052#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002053 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002054#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002055 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002056 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002057 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002058
Eric Andersen7e9276b2001-02-22 01:15:47 +00002059#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002060 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002061#define sync_full_usage \
2062 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002063
Eric Andersen7e9276b2001-02-22 01:15:47 +00002064
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002065#ifdef CONFIG_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00002066 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002067#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00002068 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002069#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00002070#ifdef CONFIG_FEATURE_IPC_SYSLOG
2071 #define USAGE_IPC_LOG(a) a
2072#else
2073 #define USAGE_IPC_LOG(a)
2074#endif
2075
Eric Andersen7e9276b2001-02-22 01:15:47 +00002076#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002077 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002078#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002079 "Linux system and kernel logging utility.\n" \
2080 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002081 "Options:\n" \
2082 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
2083 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002084 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002085 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00002086 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00002087 "\t-L\t\tLog locally and via network logging (default is network only)") \
2088 USAGE_IPC_LOG( \
2089 "\n\t-C\t\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002090#define syslogd_example_usage \
2091 "$ syslogd -R masterlog:514\n" \
2092 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002093
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002094
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002095#ifndef CONFIG_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00002096 #define USAGE_UNSIMPLE_TAIL(a)
2097#else
2098 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002099#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002100#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002101 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002102#define tail_full_usage \
2103 "Print last 10 lines of each FILE to standard output.\n" \
2104 "With more than one FILE, precede each with a header giving the\n" \
2105 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
2106 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002107 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002108 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
2109 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002110 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002111 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
2112 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002113 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002114 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002115 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
2116#define tail_example_usage \
2117 "$ tail -n 1 /etc/resolv.conf\n" \
2118 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002119
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002120#ifdef CONFIG_FEATURE_TAR_CREATE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002121 #define USAGE_TAR_CREATE(a) a
2122#else
2123 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002124#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002125#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002126 #define USAGE_TAR_EXCLUDE(a) a
2127#else
2128 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002129#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002130#ifdef CONFIG_FEATURE_TAR_GZIP
2131 #define USAGE_TAR_GZIP(a) a
2132#else
2133 #define USAGE_TAR_GZIP(a)
2134#endif
2135#ifdef CONFIG_FEATURE_TAR_BZIP2
2136 #define USAGE_TAR_BZIP2(a) a
2137#else
2138 #define USAGE_TAR_BZIP2(a)
2139#endif
2140
Eric Andersen7e9276b2001-02-22 01:15:47 +00002141#define tar_trivial_usage \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002142 "-[" USAGE_TAR_CREATE("c") USAGE_TAR_GZIP("z") USAGE_TAR_BZIP2("j") "xtvO] " \
Eric Andersen317827d2001-05-21 17:50:53 +00002143 USAGE_TAR_EXCLUDE("[--exclude FILE] [-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00002144 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002145#define tar_full_usage \
2146 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00002147 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002148 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002149 "\tx\t\textract\n" \
2150 "\tt\t\tlist\n" \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002151 "\nArchive format selection:\n" \
2152 USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
2153 USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002154 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002155 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002156 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002157 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002158 "\texclude\t\tfile to exclude\n" \
2159 "\tX\t\tfile with names to exclude\n" \
2160 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00002161 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002162 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002163#define tar_example_usage \
2164 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
2165 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002166
Eric Andersen7e9276b2001-02-22 01:15:47 +00002167#define tee_trivial_usage \
2168 "[OPTION]... [FILE]..."
2169#define tee_full_usage \
2170 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002171 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002172 "\t-a\tappend to the given FILEs, do not overwrite\n" \
2173 "\t-i\tignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002174#define tee_example_usage \
2175 "$ echo "Hello" | tee /tmp/foo\n" \
2176 "$ cat /tmp/foo\n" \
2177 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002178
Eric Andersen7e9276b2001-02-22 01:15:47 +00002179#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002180 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002181#define telnet_full_usage \
2182 "Telnet is used to establish interactive communication with another\n"\
2183 "computer over a network using the TELNET protocol."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002184
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002185#ifdef CONFIG_FEATURE_TELNETD_INETD
2186#define telnetd_trivial_usage \
2187 "(inetd mode) [OPTION]"
2188#define telnetd_full_usage \
2189 "Telnetd uses incoming TELNET connections via inetd.\n"\
2190 "Options:\n" \
2191 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
2192#else
Eric Andersen08a72202002-09-30 20:52:10 +00002193#define telnetd_trivial_usage \
2194 "[OPTION]"
2195#define telnetd_full_usage \
2196 "Telnetd listens for incoming TELNET connections on PORT.\n"\
2197 "Options:\n" \
2198 "\t-p PORT\tlisten for connections on PORT (default 23)\n"\
2199 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002200#endif
Eric Andersen08a72202002-09-30 20:52:10 +00002201
Eric Andersen7e9276b2001-02-22 01:15:47 +00002202#define test_trivial_usage \
2203 "EXPRESSION\n or [ EXPRESSION ]"
2204#define test_full_usage \
2205 "Checks file types and compares values returning an exit\n" \
2206 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002207#define test_example_usage \
2208 "$ test 1 -eq 2\n" \
2209 "$ echo $?\n" \
2210 "1\n" \
2211 "$ test 1 -eq 1\n" \
2212 "$ echo $? \n" \
2213 "0\n" \
2214 "$ [ -d /etc ]\n" \
2215 "$ echo $?\n" \
2216 "0\n" \
2217 "$ [ -d /junk ]\n" \
2218 "$ echo $?\n" \
2219 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002220
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002221#ifdef CONFIG_FEATURE_TFTP_GET
Mark Whitley450736c2001-03-02 19:08:50 +00002222 #define USAGE_TFTP_GET(a) a
2223#else
2224 #define USAGE_TFTP_GET(a)
2225#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002226#ifdef CONFIG_FEATURE_TFTP_PUT
Mark Whitley450736c2001-03-02 19:08:50 +00002227 #define USAGE_TFTP_PUT(a) a
2228#else
2229 #define USAGE_TFTP_PUT(a)
2230#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002231#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Glenn L McGrathad117d82001-10-05 04:40:37 +00002232 #define USAGE_TFTP_BS(a) a
2233#else
2234 #define USAGE_TFTP_BS(a)
2235#endif
Mark Whitley450736c2001-03-02 19:08:50 +00002236
2237#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00002238 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00002239#define tftp_full_usage \
2240 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00002241 "Options:\n" \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002242 "\t-l FILE\tLocal FILE.\n" \
2243 "\t-r FILE\tRemote FILE.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002244 USAGE_TFTP_GET( \
Matt Kraai3be34302001-09-21 14:42:30 +00002245 "\t-g\tGet file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002246 ) \
2247 USAGE_TFTP_PUT( \
Matt Kraai3be34302001-09-21 14:42:30 +00002248 "\t-p\tPut file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002249 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002250 USAGE_TFTP_BS( \
2251 "\t-b SIZE\tTransfer blocks of SIZE octets.\n" \
2252 )
Eric Andersenc3657422001-11-30 07:54:32 +00002253#define time_trivial_usage \
2254 "[OPTION]... COMMAND [ARGS...]"
2255#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00002256 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
2257 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00002258 "Options:\n" \
2259 "\t-v\tDisplays verbose resource usage information."
Mark Whitley450736c2001-03-02 19:08:50 +00002260
Eric Andersen420b2082002-09-17 22:14:58 +00002261#define top_trivial_usage \
2262 "[-d <seconds>]"
2263#define top_full_usage \
2264 "top provides an view of processor activity in real time.\n" \
2265 "This utility reads the status for all processes in /proc each <seconds>\n" \
2266 "and shows the status for however many processes will fit on the screen.\n" \
2267 "This utility will not show processes that are started after program startup,\n" \
2268 "but it will show the EXIT status for and PIDs that exit while it is running."
2269
Eric Andersen7e9276b2001-02-22 01:15:47 +00002270#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002271 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002272#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002273 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002274 "Options:\n" \
2275 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002276#define touch_example_usage \
2277 "$ ls -l /tmp/foo\n" \
2278 "/bin/ls: /tmp/foo: No such file or directory\n" \
2279 "$ touch /tmp/foo\n" \
2280 "$ ls -l /tmp/foo\n" \
2281 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002282
2283#define tr_trivial_usage \
2284 "[-cds] STRING1 [STRING2]"
2285#define tr_full_usage \
2286 "Translate, squeeze, and/or delete characters from\n" \
2287 "standard input, writing to standard output.\n\n" \
2288 "Options:\n" \
2289 "\t-c\ttake complement of STRING1\n" \
2290 "\t-d\tdelete input characters coded STRING1\n" \
2291 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002292#define tr_example_usage \
2293 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
2294 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002295
Eric Andersen5c58d282001-07-10 16:29:00 +00002296#define traceroute_trivial_usage \
2297 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n\
2298 [-s src_addr] [-t tos] [-w wait] host [data size]"
2299#define traceroute_full_usage \
2300 "trace the route ip packets follow going to \"host\"\n" \
2301 "Options:\n" \
2302 "\t-d\tset SO_DEBUG options to socket\n" \
2303 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
2304 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
2305 "\t-v\tVerbose output\n" \
2306 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
2307 "\t-p port#\tSet the base UDP port number used in probes\n" \
2308 "\t\t(default is 33434)\n" \
2309 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
2310 "\t\t(default is 3)\n" \
2311 "\t-s src_addr\tUse the following IP address as the source address\n" \
2312 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
2313 "\t\t(default 0)\n" \
2314 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
2315 "\t\t(default 3 sec.)."
2316
2317
Eric Andersen7e9276b2001-02-22 01:15:47 +00002318#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002319 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002320#define true_full_usage \
2321 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002322#define true_example_usage \
2323 "$ true\n" \
2324 "$ echo $?\n" \
2325 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002326
Eric Andersen7e9276b2001-02-22 01:15:47 +00002327#define tty_trivial_usage \
2328 ""
2329#define tty_full_usage \
2330 "Print the file name of the terminal connected to standard input.\n\n"\
2331 "Options:\n" \
2332 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002333#define tty_example_usage \
2334 "$ tty\n" \
2335 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002336
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002337#define udhcpc_trivial_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00002338 "[-fbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002339#define udhcpc_full_usage \
2340 "\t-c,\t--clientid=CLIENTID\tClient identifier\n" \
2341 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00002342 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002343 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00002344 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated.\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002345 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
2346 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated.\n" \
2347 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
2348 "\t-q,\t--quit\tQuit after obtaining lease\n" \
2349 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
2350 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
2351 "\t-v,\t--version\tDisplay version"
2352
Russ Dill61fb4892002-10-14 21:41:28 +00002353#define udhcpd_trivial_usage \
2354 "[configfile]\n" \
2355
2356#define udhcpd_full_usage \
Glenn L McGrath9130c852002-12-12 12:56:18 +00002357 ""
Russ Dill61fb4892002-10-14 21:41:28 +00002358
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002359#ifdef CONFIG_FEATURE_MOUNT_FORCE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002360 #define USAGE_MOUNT_FORCE(a) a
2361#else
2362 #define USAGE_MOUNT_FORCE(a)
2363#endif
2364#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002365 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002366#define umount_full_usage \
2367 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00002368 "\nFlags:\n" "\t-a\tUnmount all file systems" \
2369 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
2370 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00002371 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00002372 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 +00002373#define umount_example_usage \
2374 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002375
2376#define uname_trivial_usage \
2377 "[OPTION]..."
2378#define uname_full_usage \
2379 "Print certain system information. With no OPTION, same as -s.\n\n" \
2380 "Options:\n" \
2381 "\t-a\tprint all information\n" \
2382 "\t-m\tthe machine (hardware) type\n" \
2383 "\t-n\tprint the machine's network node hostname\n" \
2384 "\t-r\tprint the operating system release\n" \
2385 "\t-s\tprint the operating system name\n" \
2386 "\t-p\tprint the host processor type\n" \
2387 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002388#define uname_example_usage \
2389 "$ uname -a\n" \
2390 "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002391
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00002392#define uncompress_trivial_usage \
2393 "[-c] [-f] [ name ... ]"
2394#define uncompress_full_usage \
2395 "Uncompress .Z file[s]\n" \
2396 "Options:\n" \
2397 "\t-c\textract to stdout\n" \
2398 "\t-f\tforce overwrite an existing file\n"
2399
Eric Andersen7e9276b2001-02-22 01:15:47 +00002400#define uniq_trivial_usage \
2401 "[OPTION]... [INPUT [OUTPUT]]"
2402#define uniq_full_usage \
2403 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00002404 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002405 "Options:\n" \
2406 "\t-c\tprefix lines by the number of occurrences\n" \
2407 "\t-d\tonly print duplicate lines\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002408 "\t-u\tonly print unique lines\n" \
2409 "\t-f N\tskip the first N fields\n" \
2410 "\t-s N\tskip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002411#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002412 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002413 "a\n" \
2414 "b\n" \
2415 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002416
2417#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002418 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002419#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002420 "Converts FILE from unix format to dos format. When no option\n" \
2421 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002422 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002423 "Options:\n" \
2424 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002425 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002426
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002427#define unzip_trivial_usage \
2428 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
2429#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002430 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002431 "Options:\n" \
2432 "\t-l\tlist archive contents (short form)\n" \
2433 "\t-n\tnever overwrite existing files (default)\n" \
2434 "\t-o\toverwrite files without prompting\n" \
2435 "\t-p\tsend output to stdout\n" \
2436 "\t-q\tbe quiet\n" \
2437 "\t-x\texclude these files\n" \
2438 "\t-d\textract files into this directory"
2439
Eric Andersen7e9276b2001-02-22 01:15:47 +00002440#define update_trivial_usage \
2441 "[options]"
2442#define update_full_usage \
2443 "Periodically flushes filesystem buffers.\n\n" \
2444 "Options:\n" \
2445 "\t-S\tforce use of sync(2) instead of flushing\n" \
2446 "\t-s SECS\tcall sync this often (default 30)\n" \
2447 "\t-f SECS\tflush some buffers this often (default 5)"
2448
2449#define uptime_trivial_usage \
2450 ""
2451#define uptime_full_usage \
2452 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002453#define uptime_example_usage \
2454 "$ uptime\n" \
2455 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002456
2457#define usleep_trivial_usage \
2458 "N"
2459#define usleep_full_usage \
2460 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002461#define usleep_example_usage \
2462 "$ usleep 1000000\n" \
2463 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002464
2465#define uudecode_trivial_usage \
2466 "[FILE]..."
2467#define uudecode_full_usage \
2468 "Uudecode a file that is uuencoded.\n\n" \
2469 "Options:\n" \
Eric Andersen704b2c22001-03-16 08:06:30 +00002470 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002471#define uudecode_example_usage \
2472 "$ uudecode -o busybox busybox.uu\n" \
2473 "$ ls -l busybox\n" \
2474 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002475
2476#define uuencode_trivial_usage \
2477 "[OPTION] [INFILE] REMOTEFILE"
2478#define uuencode_full_usage \
2479 "Uuencode a file.\n\n" \
2480 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00002481 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002482#define uuencode_example_usage \
2483 "$ uuencode busybox busybox\n" \
2484 "begin 755 busybox\n" \
2485 "<encoded file snipped>\n" \
2486 "$ uudecode busybox busybox > busybox.uu\n" \
2487 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002488
Eric Andersen853c4942003-01-23 05:59:32 +00002489#define vconfig_trivial_usage \
2490 "COMMAND [OPTIONS] ..."
2491
2492#define vconfig_full_usage \
2493"Usage: add [interface-name] [vlan_id] \n" \
2494" rem [vlan-name] \n" \
2495" set_flag [interface-name] [flag-num] [0 | 1] \n" \
2496" set_egress_map [vlan-name] [skb_priority] [vlan_qos] \n" \
2497" set_ingress_map [vlan-name] [skb_priority] [vlan_qos] \n" \
2498" set_name_type [name-type] \n"
2499
Eric Andersen3f980402001-04-04 17:31:15 +00002500#define vi_trivial_usage \
2501 "[OPTION] [FILE]..."
2502#define vi_full_usage \
2503 "edit FILE.\n\n" \
2504 "Options:\n" \
2505 "\t-R\tRead-only- do not write to the file."
2506
Eric Andersen27f64e12002-06-23 04:24:25 +00002507#define vlock_trivial_usage \
2508 "[OPTIONS]"
2509#define vlock_full_usage \
2510 "Lock a virtual terminal. A password is required to unlock\n" \
2511 "Options:\n" \
2512 "\t-a\tLock all VTs"
2513
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002514#define watch_trivial_usage \
2515 "[-n <seconds>] COMMAND..."
2516#define watch_full_usage \
2517 "Executes a program periodically.\n" \
2518 "Options:\n" \
2519 "\t-n\tLoop period in seconds - default is 2."
2520#define watch_example_usage \
2521 "$ watch date\n" \
2522 "Mon Dec 17 10:31:40 GMT 2000\n" \
2523 "Mon Dec 17 10:31:42 GMT 2000\n" \
2524 "Mon Dec 17 10:31:44 GMT 2000"
2525
Eric Andersen7e9276b2001-02-22 01:15:47 +00002526#define watchdog_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002527 "DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002528#define watchdog_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002529 "Periodically write to watchdog device DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002530
2531#define wc_trivial_usage \
2532 "[OPTION]... [FILE]..."
2533#define wc_full_usage \
2534 "Print line, word, and byte counts for each FILE, and a total line if\n" \
2535 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
2536 "Options:\n" \
2537 "\t-c\tprint the byte counts\n" \
2538 "\t-l\tprint the newline counts\n" \
2539 "\t-L\tprint the length of the longest line\n" \
2540 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002541#define wc_example_usage \
2542 "$ wc /etc/passwd\n" \
2543 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002544
2545#define wget_trivial_usage \
Robert Griebld7760112002-05-14 23:36:45 +00002546 "[-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 +00002547#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00002548 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002549 "Options:\n" \
2550 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00002551 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00002552 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00002553 "\t-O\tsave to filename ('-' for stdout)\n" \
2554 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002555
2556#define which_trivial_usage \
2557 "[COMMAND ...]"
2558#define which_full_usage \
2559 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002560#define which_example_usage \
2561 "$ which login\n" \
2562 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00002563
Eric Andersen00a6a752002-04-26 23:53:10 +00002564#define who_trivial_usage \
2565 " "
2566#define who_full_usage \
2567 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002568
2569#define whoami_trivial_usage \
2570 ""
2571#define whoami_full_usage \
2572 "Prints the user name associated with the current effective user id."
2573
2574#define xargs_trivial_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002575 "[COMMAND] [-prt] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002576#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002577 "Executes COMMAND on every item given by standard input.\n\n" \
2578 "Options:\n" \
2579 "\t-p\tPrompt the user about whether to run each command\n" \
2580 "\t-r\tDo not run command for empty readed lines\n" \
2581 "\t-t\tPrint the command line on stderr before executing it."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002582#define xargs_example_usage \
2583 "$ ls | xargs gzip\n" \
2584 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002585
2586#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002587 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002588#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002589 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002590
Eric Andersen7e9276b2001-02-22 01:15:47 +00002591#define zcat_trivial_usage \
2592 "FILE"
2593#define zcat_full_usage \
2594 "Uncompress to stdout."