blob: 8fc12f1515bd11b2d5dc0b1bd344c3407fd74505 [file] [log] [blame]
Eric Andersenf349e972001-08-21 16:18:59 +00001#define addgroup_trivial_usage \
Eric Andersene0716ba2003-01-14 06:42:56 +00002 "[OPTIONS] group_name [user_name]"
Eric Andersenf349e972001-08-21 16:18:59 +00003#define addgroup_full_usage \
4 "Adds a group to the system" \
5 "Options:\n" \
6 "\t-g\t\tspecify gid\n"
7
8#define adduser_trivial_usage \
Eric Andersene0716ba2003-01-14 06:42:56 +00009 "[OPTIONS] user_name"
Eric Andersenf349e972001-08-21 16:18:59 +000010#define adduser_full_usage \
11 "Adds a user to the system" \
12 "Options:\n" \
13 "\t-h\t\thome directory\n" \
14 "\t-s\t\tshell\n" \
15 "\t-g\t\tGECOS string\n"
16
Mark Whitley6f932772001-03-20 19:18:10 +000017#define adjtimex_trivial_usage \
18 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
19#define adjtimex_full_usage \
20 "Reads and optionally sets system timebase parameters.\n" \
21 "See adjtimex(2).\n\n" \
22 "Options:\n" \
23 "\t-q\t\tquiet mode - do not print\n" \
24 "\t-o offset\ttime offset, microseconds\n" \
25 "\t-f frequency\tfrequency adjust, integer kernel units (65536 is 1ppm)\n" \
26 "\t\t\t(positive values make the system clock run fast)\n" \
27 "\t-t tick\t\tmicroseconds per tick, usually 10000\n" \
28 "\t-p timeconstant\n"
29
Eric Andersen7e9276b2001-02-22 01:15:47 +000030#define ar_trivial_usage \
Glenn L McGrath62ebe2e2001-06-03 05:41:59 +000031 "-[ov][ptx] ARCHIVE FILES"
Eric Andersen7e9276b2001-02-22 01:15:47 +000032#define ar_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +000033 "Extract or list FILES from an ar archive.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +000034 "Options:\n" \
35 "\t-o\t\tpreserve original dates\n" \
36 "\t-p\t\textract to stdout\n" \
37 "\t-t\t\tlist\n" \
38 "\t-x\t\textract\n" \
Glenn L McGrathcda5cf12001-06-03 05:15:04 +000039 "\t-v\t\tverbosely list files processed\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000040
Glenn L McGrath9e598412003-01-09 10:06:01 +000041#define arping_trivial_usage \
42 "[-fqbDUA] [-c count] [-w timeout] [-I device] [-s sender] target\n"
43#define arping_full_usage \
44 "Ping hosts by ARP requests/replies.\n\n" \
45 "Options:\n" \
46 "\t-f\t\tQuit on first ARP reply\n" \
47 "\t-q\t\tBe quiet\n" \
48 "\t-b\t\tKeep broadcasting, don't go unicast\n" \
49 "\t-D\t\tDuplicated address detection mode\n" \
50 "\t-U\t\tUnsolicited ARP mode, update your neighbours\n" \
51 "\t-A\t\tARP answer mode, update your neighbours\n" \
52 "\t-c count\tStop after sending count ARP request packets\n" \
53 "\t-w timeout\tTime to wait for ARP reply, in seconds\n" \
54 "\t-I device\tOutgoing interface name, default is eth0\n" \
55 "\t-s sender\tSet specific sender IP address\n" \
56 "\ttarget\t\tTarget IP address of ARP request\n"
57
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000058#define awk_trivial_usage \
59 "[-v var=val][-F sep] { -f progname | 'programtext' } [FILE ...]"
60#define awk_full_usage \
61 "Options:\n" \
62 "\t-v var=val\tassign value 'val' to variable 'var'\n" \
63 "\t-F sep\t\tuse 'sep' as field separator\n" \
64 "\t-f progname\tread program source from file 'progname'\n"
65
Eric Andersen7e9276b2001-02-22 01:15:47 +000066#define basename_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000067 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000068#define basename_full_usage \
69 "Strips directory path and suffixes from FILE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000070 "If specified, also removes any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000071#define basename_example_usage \
72 "$ basename /usr/local/bin/foo\n" \
73 "foo\n" \
74 "$ basename /usr/local/bin/\n" \
75 "bin\n" \
76 "$ basename /foo/bar.txt .txt\n" \
77 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000078
Glenn L McGrath24e28332001-10-05 03:48:57 +000079#define bunzip2_trivial_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000080 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +000081#define bunzip2_full_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000082 "Uncompress FILE (or standard input if FILE is '-' or omitted).\n\n" \
83 "Options:\n" \
84 "\t-c\tWrite output to standard output\n" \
85 "\t-f\tForce"
Glenn L McGrath24e28332001-10-05 03:48:57 +000086
Glenn L McGrathfff11f12001-11-18 14:20:25 +000087#define bzcat_trivial_usage \
88 "FILE"
89#define bzcat_full_usage \
90 "Uncompress to stdout."
91
Eric Andersenc98c0622001-12-06 15:16:43 +000092#define cal_trivial_usage \
93 "[-jy] [[month] year]"
94#define cal_full_usage \
95 "Display a calendar.\n" \
96 "\nOptions:\n" \
97 "\t-j\tUse julian dates.\n" \
98 "\t-y\tDisplay the entire year."
99
Eric Andersen7e9276b2001-02-22 01:15:47 +0000100#define cat_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000101 "[FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000102#define cat_full_usage \
103 "Concatenates FILE(s) and prints them to stdout."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000104#define cat_example_usage \
105 "$ cat /proc/uptime\n" \
106 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000107
Eric Andersen7e9276b2001-02-22 01:15:47 +0000108#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000109 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000110#define chgrp_full_usage \
111 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000112 "\nOptions:\n" \
113 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000114#define chgrp_example_usage \
115 "$ ls -l /tmp/foo\n" \
116 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
117 "$ chgrp root /tmp/foo\n" \
118 "$ ls -l /tmp/foo\n" \
119 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000120
Eric Andersen7e9276b2001-02-22 01:15:47 +0000121#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000122 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000123#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000124 "Each MODE is one or more of the letters ugoa, one of the\n" \
125 "symbols +-= and one or more of the letters rwxst.\n\n" \
126 "Options:\n" \
127 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000128#define chmod_example_usage \
129 "$ ls -l /tmp/foo\n" \
130 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
131 "$ chmod u+x /tmp/foo\n" \
132 "$ ls -l /tmp/foo\n" \
133 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
134 "$ chmod 444 /tmp/foo\n" \
135 "$ ls -l /tmp/foo\n" \
136 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000137
Eric Andersen7e9276b2001-02-22 01:15:47 +0000138#define chown_trivial_usage \
Eric Andersen238da242001-05-11 16:31:46 +0000139 "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000140#define chown_full_usage \
141 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000142 "\nOptions:\n" \
Eric Andersen238da242001-05-11 16:31:46 +0000143 "\t-R\tChanges files and directories recursively.\n" \
144 "\t-h\tDo not dereference symbolic links."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000145#define chown_example_usage \
146 "$ ls -l /tmp/foo\n" \
147 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
148 "$ chown root /tmp/foo\n" \
149 "$ ls -l /tmp/foo\n" \
150 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
151 "$ chown root.root /tmp/foo\n" \
152 "ls -l /tmp/foo\n" \
153 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000154
Eric Andersen7e9276b2001-02-22 01:15:47 +0000155#define chroot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000156 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000157#define chroot_full_usage \
158 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000159#define chroot_example_usage \
160 "$ ls -l /bin/ls\n" \
161 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
162 "$ mount /dev/hdc1 /mnt -t minix\n" \
163 "$ chroot /mnt\n" \
164 "$ ls -l /bin/ls\n" \
165 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000166
Eric Andersen7e9276b2001-02-22 01:15:47 +0000167#define chvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000168 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000169#define chvt_full_usage \
170 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000171
Eric Andersen7e9276b2001-02-22 01:15:47 +0000172#define clear_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000173 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000174#define clear_full_usage \
175 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000176
Eric Andersen7e9276b2001-02-22 01:15:47 +0000177#define cmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000178 "FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000179#define cmp_full_usage \
Mark Whitley207587a2001-04-25 20:41:02 +0000180 "\t-s\tquiet mode - do not print\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000181 "Compare files."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000182
Eric Andersen7e9276b2001-02-22 01:15:47 +0000183#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000184 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000185#define cp_full_usage \
186 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
187 "\n" \
188 "\t-a\tSame as -dpR\n" \
189 "\t-d\tPreserves links\n" \
190 "\t-p\tPreserves file attributes if possible\n" \
191 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000192 "\t-R\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000193
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000194#define cpio_trivial_usage \
195 "-[dimtuv][F cpiofile]"
196#define cpio_full_usage \
197 "Extract or list files from a cpio archive\n" \
198 "Main operation mode:\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000199 "\td\t\tmake leading directories\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000200 "\ti\t\textract\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000201 "\tm\t\tpreserve mtime\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000202 "\tt\t\tlist\n" \
Eric Andersen6925d502001-12-16 09:23:09 +0000203 "\tu\t\tunconditional overwrite\n" \
204 "\tF\t\tinput from file"
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000205
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000206#define crond_trivial_usage \
207 "-d[#] -c <crondir> -f -b"
208#define crond_full_usage \
209 "\t-d [#] -l [#] -S -L logfile -f -b -c dir\n" \
210 "\t-d num\tdebug level\n" \
211 "\t-l num\tlog level (8 - default)\n" \
212 "\t-S\tlog to syslod (defualt)\n" \
213 "\t-L file\tlog to file\n" \
214 "\t-f\trun in fordeground\n" \
215 "\t-b\trun in background (default)\n" \
216 "\t-c dir\tworking dir"
217
218#define crontab_trivial_usage \
219 "crontab [-c dir] {file|-}|[-u|-l|-e|-d user]"
220#define crontab_full_usage \
221 "\tfile <opts> replace crontab from file\n" \
222 "\t- <opts> replace crontab from stdin\n" \
223 "\t-u user specify user\n" \
224 "\t-l [user] list crontab for user\n" \
225 "\t-e [user] edit crontab for user\n" \
226 "\t-d [user] delete crontab for user\n" \
227 "\t-c dir specify crontab directory"
228
229
Eric Andersen7e9276b2001-02-22 01:15:47 +0000230#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000231 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000232#define cut_full_usage \
233 "Prints selected fields from each input FILE to standard output.\n\n" \
234 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000235 "\t-b LIST\t\tOutput only bytes from LIST\n" \
236 "\t-c LIST\t\tOutput only characters from LIST\n" \
237 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
238 "\t-s\t\tOutput only the lines containing delimiter\n" \
239 "\t-f N\t\tPrint only these fields\n" \
240 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000241#define cut_example_usage \
242 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
243 "Hello\n" \
244 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
245 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000246
Eric Andersen7e9276b2001-02-22 01:15:47 +0000247#define date_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000248 "[OPTION]... [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000249#define date_full_usage \
250 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000251 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000252 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000253 "\t-d STRING\tdisplay time described by STRING, not `now'\n" \
254 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000255 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000256#define date_example_usage \
257 "$ date\n" \
258 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000259
Eric Andersen7e9276b2001-02-22 01:15:47 +0000260#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000261 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000262#define dc_full_usage \
263 "This is a Tiny RPN calculator that understands the\n" \
264 "following operations: +, -, /, *, and, or, not, eor.\n" \
Glenn L McGrath6d074322002-12-12 10:31:53 +0000265 "i.e., 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16" \
266 "p - Prints the value on the top of the stack, without altering the stack.\n" \
267 "f - Prints the entire contents of the stack without altering anything.\n" \
268 "o - Pops the value off the top of the stack and uses it to set the output radix.\n" \
269 " Only 10 and 16 are supported.\n"
270
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000271#define dc_example_usage \
272 "$ dc 2 2 +\n" \
273 "4\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000274 "$ dc 8 8 * 2 2 + /\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000275 "16\n" \
276 "$ dc 0 1 and\n" \
277 "0\n" \
278 "$ dc 0 1 or\n" \
279 "1\n" \
280 "$ echo 72 9 div 8 mul | dc\n" \
281 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000282
Eric Andersen7e9276b2001-02-22 01:15:47 +0000283#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000284 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000285 "\t [seek=N] [conv=notrunc|noerror|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000286#define dd_full_usage \
287 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000288 "\tif=FILE\t\tread from FILE instead of stdin\n" \
289 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
290 "\tbs=N\t\tread and write N bytes at a time\n" \
291 "\tcount=N\t\tcopy only N input blocks\n" \
292 "\tskip=N\t\tskip N input blocks\n" \
293 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000294 "\tconv=notrunc\tdon't truncate output file\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000295 "\tconv=noerror\tcontinue after read errors\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000296 "\tconv=sync\tpad blocks with zeros\n" \
297 "\n" \
298 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000299 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000300#define dd_example_usage \
301 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
302 "4+0 records in\n" \
303 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000304
Eric Andersen7e9276b2001-02-22 01:15:47 +0000305#define deallocvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000306 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000307#define deallocvt_full_usage \
308 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000309
Eric Andersenf349e972001-08-21 16:18:59 +0000310#define delgroup_trivial_usage \
311 "GROUP"
312#define delgroup_full_usage \
313 "Deletes group GROUP from the system"
314
315#define deluser_trivial_usage \
316 "USER"
317#define deluser_full_usage \
318 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000319
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000320#ifdef CONFIG_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000321 #define USAGE_HUMAN_READABLE(a) a
322 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000323#else
Eric Andersened0d9582001-02-23 13:23:03 +0000324 #define USAGE_HUMAN_READABLE(a)
325 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000326#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000327#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000328 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000329#define df_full_usage \
330 "Print the filesystem space used and space available.\n\n" \
331 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000332 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000333 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
334 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000335 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000336 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000337#define df_example_usage \
338 "$ df\n" \
339 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
340 "/dev/sda3 8690864 8553540 137324 98% /\n" \
341 "/dev/sda1 64216 36364 27852 57% /boot\n" \
342 "$ df /dev/sda3\n" \
343 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
344 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000345
Eric Andersen7e9276b2001-02-22 01:15:47 +0000346#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000347 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000348#define dirname_full_usage \
349 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000350#define dirname_example_usage \
351 "$ dirname /tmp/foo\n" \
352 "/tmp\n" \
353 "$ dirname /tmp/foo/\n" \
354 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000355
Eric Andersen7e9276b2001-02-22 01:15:47 +0000356#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000357 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000358#define dmesg_full_usage \
359 "Prints or controls the kernel ring buffer\n\n" \
360 "Options:\n" \
361 "\t-c\t\tClears the ring buffer's contents after printing\n" \
362 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000363 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000364
Eric Andersen7e9276b2001-02-22 01:15:47 +0000365#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000366 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000367#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000368 "Converts FILE from dos format to unix format. When no option\n" \
369 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000370 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000371 "Options:\n" \
372 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000373 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000374
Eric Andersen7e9276b2001-02-22 01:15:47 +0000375#define dpkg_trivial_usage \
Eric Andersen9fe5f982002-04-13 14:48:51 +0000376 "-i package_file\n" \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000377 "[-CPru] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000378#define dpkg_full_usage \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000379 "\t-i\tInstall the package\n" \
380 "\t-C\tConfigure an unpackaged package\n" \
381 "\t-P\tPurge all files of a package\n" \
382 "\t-r\tRemove all but the configuration files for a package\n" \
383 "\t-u\tUnpack a package, but dont configure it\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000384
Eric Andersen7e9276b2001-02-22 01:15:47 +0000385#define dpkg_deb_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000386 "[-cefItxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000387#define dpkg_deb_full_usage \
388 "Perform actions on debian packages (.debs)\n\n" \
389 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000390 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000391 "\t-e\tExtract control files to [argument] directory\n" \
392 "\t-f\tDisplay control field name starting with [argument]\n" \
393 "\t-I\tDisplay the control filenamed [argument]\n" \
394 "\t-t\tExtract filesystem tree to stdout in tar format\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000395 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000396 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000397#define dpkg_deb_example_usage \
398 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000399
Eric Andersen7e9276b2001-02-22 01:15:47 +0000400#define du_trivial_usage \
Eric Andersen265d2292002-04-06 23:16:44 +0000401 "[-lsx" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000402#define du_full_usage \
403 "Summarizes disk space used for each FILE and/or directory.\n" \
404 "Disk space is printed in units of 1024 bytes.\n\n" \
405 "Options:\n" \
406 "\t-l\tcount sizes many times if hard linked\n" \
407 "\t-s\tdisplay only a total for each argument" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000408 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000409 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
410 "\t-m\tprint sizes in megabytes\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000411 "\t-x\tskip directories on different filesystems\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000412 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000413 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000414#define du_example_usage \
415 "$ du\n" \
416 "16 ./CVS\n" \
417 "12 ./kernel-patches/CVS\n" \
418 "80 ./kernel-patches\n" \
419 "12 ./tests/CVS\n" \
420 "36 ./tests\n" \
421 "12 ./scripts/CVS\n" \
422 "16 ./scripts\n" \
423 "12 ./docs/CVS\n" \
424 "104 ./docs\n" \
425 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000426
Eric Andersen7e9276b2001-02-22 01:15:47 +0000427#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000428 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000429#define dumpkmap_full_usage \
430 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000431#define dumpkmap_example_usage \
432 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000433
Russ Dill61fb4892002-10-14 21:41:28 +0000434#define dumpleases_trivial_usage \
435 "[-r|-a] [-f LEASEFILE]"
436#define dumpleases_full_usage \
Russ Dill61fb4892002-10-14 21:41:28 +0000437 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
438 "\t-r,\t--remaining\tInterepret lease times as time remaing\n" \
439 "\t-a,\t--absolute\tInterepret lease times as expire time\n"
440
Eric Andersen7e9276b2001-02-22 01:15:47 +0000441#define dutmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000442 "[FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000443#define dutmp_full_usage \
444 "Dump utmp file format (pipe delimited) from FILE\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000445 "or stdin to stdout. (i.e., 'dutmp /var/run/utmp')"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000446#define dutmp_example_usage \
447 "$ dutmp /var/run/utmp\n" \
448 "8|7||si|||0|0|0|955637625|760097|0\n" \
449 "2|0|~|~~|reboot||0|0|0|955637625|782235|0\n" \
450 "1|20020|~|~~|runlevel||0|0|0|955637625|800089|0\n" \
451 "8|125||l4|||0|0|0|955637629|998367|0\n" \
452 "6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0\n" \
453 "6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0\n" \
454 "7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000455
Eric Andersen7e9276b2001-02-22 01:15:47 +0000456#define echo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000457 "[-neE] [ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000458#define echo_full_usage \
459 "Prints the specified ARGs to stdout\n\n" \
460 "Options:\n" \
461 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000462 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000463 "\t-E\tdisable interpretation of backslash-escaped characters"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000464#define echo_example_usage \
465 "$ echo "Erik is cool"\n" \
466 "Erik is cool\n" \
John Beppu5d817682001-04-17 17:09:34 +0000467 "$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000468 "Erik\n" \
469 "is\n" \
470 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000471 "$ echo "Erik\\nis\\ncool"\n" \
472 "Erik\\nis\\ncool\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000473
Eric Andersen84e229c2001-03-29 22:48:33 +0000474#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000475 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000476#define env_full_usage \
477 "Prints the current environment or runs a program after setting\n" \
478 "up the specified environment.\n\n" \
479 "Options:\n" \
480 "\t-, -i\tstart with an empty environment\n" \
481 "\t-u\tremove variable from the environment\n"
482
Eric Andersen7e9276b2001-02-22 01:15:47 +0000483#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000484 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000485#define expr_full_usage \
486 "Prints the value of EXPRESSION to standard output.\n\n" \
487 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000488 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
489 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
490 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
491 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
492 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
493 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
494 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
495 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
496 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
497 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
498 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
499 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
500 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000501 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
502 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
503 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
504 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
505 "\t or 0\n" \
506 "\tlength STRING length of STRING\n" \
507 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
508 "\t it is a keyword like `match' or an\n" \
509 "\t operator like `/'\n" \
510 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000511 "Beware that many operators need to be escaped or quoted for shells.\n" \
512 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
513 "lexicographical. Pattern matches return the string matched between \n" \
514 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
515 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000516
Eric Andersen7e9276b2001-02-22 01:15:47 +0000517#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000518 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000519#define false_full_usage \
520 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000521#define false_example_usage \
522 "$ false\n" \
523 "$ echo $?\n" \
524 "1\n"
525
526#define fbset_trivial_usage \
527 "[options] [mode]"
528#define fbset_full_usage \
529 "Show and modify frame buffer settings"
530#define fbset_example_usage \
531 "$ fbset\n" \
532 "mode "1024x768-76"\n" \
533 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
534 "\tgeometry 1024 768 1024 768 16\n" \
535 "\ttimings 12714 128 32 16 4 128 4\n" \
536 "\taccel false\n" \
537 "\trgba 5/11,6/5,5/0,0/0\n" \
538 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000539
Eric Andersen7e9276b2001-02-22 01:15:47 +0000540#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000541 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000542#define fdflush_full_usage \
543 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000544
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000545#define fdisk_trivial_usage \
546 "[-l] [-v] [-b SSZ] [-u] DISK"
547#define fdisk_full_usage \
548 "Change partition table\n" \
549 "Options:\n" \
550 "-l List partition table(s)\n" \
551 "-u Give Start and End in sector (instead of cylinder) units\n" \
552 "-s PARTITION Give partition size(s) in blocks\n" \
553 "-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
Glenn L McGrath062c74f2002-11-27 09:29:49 +0000554 "-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000555
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000556#ifdef CONFIG_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000557 #define USAGE_FIND_TYPE(a) a
558#else
559 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000560#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000561#ifdef CONFIG_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000562 #define USAGE_FIND_PERM(a) a
563#else
564 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000565#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000566#ifdef CONFIG_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000567 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000568#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000569 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000570#endif
Eric Andersen97d86f22003-01-23 05:27:42 +0000571#ifdef CONFIG_FEATURE_FIND_NEWER
572 #define USAGE_FIND_NEWER(a) a
573#else
574 #define USAGE_FIND_NEWER(a)
575#endif
576#ifdef CONFIG_FEATURE_FIND_INUM
577 #define USAGE_FIND_INUM(a) a
578#else
579 #define USAGE_FIND_INUM(a)
580#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000581
Eric Andersen7e9276b2001-02-22 01:15:47 +0000582#define find_trivial_usage \
583 "[PATH...] [EXPRESSION]"
584#define find_full_usage \
585 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000586 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000587 "\nEXPRESSION may consist of:\n" \
588 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000589 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000590 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000591 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000592 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
593) USAGE_FIND_PERM( \
594 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
595) USAGE_FIND_MTIME( \
Eric Andersen97d86f22003-01-23 05:27:42 +0000596 "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \
597) USAGE_FIND_NEWER( \
598 "\n\t-newer FILE\tModified time is more recent than FILE's" \
599) USAGE_FIND_INUM( \
600 "\n\t-inum N\t\tFile has inode number N")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000601#define find_example_usage \
602 "$ find / -name /etc/passwd\n" \
603 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000604
Eric Andersen7e9276b2001-02-22 01:15:47 +0000605#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000606 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000607#define free_full_usage \
608 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000609#define free_example_usage \
610 "$ free\n" \
611 " total used free shared buffers\n" \
612 " Mem: 257628 248724 8904 59644 93124\n" \
613 " Swap: 128516 8404 120112\n" \
614 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000615
Eric Andersen7e9276b2001-02-22 01:15:47 +0000616#define freeramdisk_trivial_usage \
617 "DEVICE"
618#define freeramdisk_full_usage \
619 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000620#define freeramdisk_example_usage \
621 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000622
623#define fsck_minix_trivial_usage \
624 "[-larvsmf] /dev/name"
625#define fsck_minix_full_usage \
626 "Performs a consistency check for MINIX filesystems.\n\n" \
627 "Options:\n" \
628 "\t-l\tLists all filenames\n" \
629 "\t-r\tPerform interactive repairs\n" \
630 "\t-a\tPerform automatic repairs\n" \
631 "\t-v\tverbose\n" \
632 "\t-s\tOutputs super-block information\n" \
633 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
634 "\t-f\tForce file system check."
635
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000636#define ftpget_trivial_usage \
637 "[options] remote-host local-directory remote-file"
638#define ftpget_full_usage \
639 "Retrieve a remote file via FTP.\n\n" \
640 "Options:\n" \
641 "\t-c, --continue Continue a previous transfer\n" \
642 "\t-v, --verbose Verbose\n" \
643 "\t-u, --username Username to be used\n" \
644 "\t-p, --password Password to be used\n" \
645 "\t-P, --port Port number to be used\n"
646
647#define ftpput_trivial_usage \
648 "[options] remote-host remote-directory local-file"
649#define ftpput_full_usage \
650 "Store a local file on a remote machine via FTP.\n\n" \
651 "Options:\n" \
652 "\t-v, --verbose Verbose\n" \
653 "\t-u, --username Username to be used\n" \
654 "\t-p, --password Password to be used\n" \
655 "\t-P, --port Port number to be used\n"
656
Eric Andersen7e9276b2001-02-22 01:15:47 +0000657#define getopt_trivial_usage \
658 "[OPTIONS]..."
659#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000660 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000661 "\t-a, --alternative Allow long options starting with single -\n" \
662 "\t-l, --longoptions=longopts Long options to be recognized\n" \
663 "\t-n, --name=progname The name under which errors are reported\n" \
664 "\t-o, --options=optstring Short options to be recognized\n" \
665 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
666 "\t-Q, --quiet-output No normal output\n" \
667 "\t-s, --shell=shell Set shell quoting conventions\n" \
668 "\t-T, --test Test for getopt(1) version\n" \
669 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000670#define getopt_example_usage \
671 "$ cat getopt.test\n" \
672 "#!/bin/sh\n" \
673 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
674 " -n 'example.busybox' -- "$@"`\n" \
675 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
676 "eval set -- "$GETOPT"\n" \
677 "while true ; do\n" \
678 " case $1 in\n" \
679 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000680 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000681 " -c|--c-long)\n" \
682 " case "$2" in\n" \
683 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000684 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000685 " esac ;;\n" \
686 " --) shift ; break ;;\n" \
687 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
688 " esac\n" \
689 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000690
Eric Andersenf349e972001-08-21 16:18:59 +0000691#define getty_trivial_usage \
692 "getty [OPTIONS]... baud_rate,... line [termtype]"
693#define getty_full_usage \
694 "\nOpens a tty, prompts for a login name, then invokes /bin/login\n\n" \
695 "Options:\n" \
696 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
697 "\t-i\t\tDo not display /etc/issue before running login.\n" \
698 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
699 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
700 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
701 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
702 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
703 "\t-I initstring\tSets the init string to send before anything else.\n" \
704 "\t-H login_host\tLog login_host into the utmp file as the hostname."
705
706
Eric Andersen7e9276b2001-02-22 01:15:47 +0000707#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000708 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000709#define grep_full_usage \
710 "Search for PATTERN in each FILE or standard input.\n\n" \
711 "Options:\n" \
712 "\t-H\tprefix output lines with filename where match was found\n" \
713 "\t-h\tsuppress the prefixing filename on output\n" \
714 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000715 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000716 "\t-n\tprint line number with output lines\n" \
717 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
718 "\t-v\tselect non-matching lines\n" \
719 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000720#define grep_example_usage \
721 "$ grep root /etc/passwd\n" \
722 "root:x:0:0:root:/root:/bin/bash\n" \
723 "$ grep ^[rR]oo. /etc/passwd\n" \
724 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000725
Eric Andersen7e9276b2001-02-22 01:15:47 +0000726#define gunzip_trivial_usage \
727 "[OPTION]... FILE"
728#define gunzip_full_usage \
729 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
730 "Options:\n" \
731 "\t-c\tWrite output to standard output\n" \
732 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000733#define gunzip_example_usage \
734 "$ ls -la /tmp/BusyBox*\n" \
735 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
736 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
737 "$ ls -la /tmp/BusyBox*\n" \
738 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000739
740#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000741 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000742#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000743 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000744 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000745 "Options:\n" \
746 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
747 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000748#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000749 "$ ls -la /tmp/busybox*\n" \
750 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
751 "$ gzip /tmp/busybox.tar\n" \
752 "$ ls -la /tmp/busybox*\n" \
753 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000754
755#define halt_trivial_usage \
756 ""
757#define halt_full_usage \
758 "Halt the system."
759
760#define head_trivial_usage \
761 "[OPTION] [FILE]..."
762#define head_full_usage \
763 "Print first 10 lines of each FILE to standard output.\n" \
764 "With more than one FILE, precede each with a header giving the\n" \
765 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000766 "Options:\n" \
767 "\t-n NUM\t\tPrint first NUM lines instead of first 10"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000768#define head_example_usage \
769 "$ head -n 2 /etc/passwd\n" \
770 "root:x:0:0:root:/root:/bin/bash\n" \
771 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000772
Glenn L McGrath60281112001-11-02 11:39:46 +0000773#define hexdump_trivial_usage \
774 "[-[bcdefnosvx]] [OPTION] FILE"
775#define hexdump_full_usage \
776 "The hexdump utility is a filter which displays the specified files,\n" \
777 "or the standard input, if no files are specified, in a user specified\n"\
778 "format\n" \
779 "\t-b\t\tOne-byte octal display\n" \
780 "\t-c\t\tOne-byte character display\n" \
781 "\t-d\t\tTwo-byte decimal display\n" \
782 "\t-e FORMAT STRING\n" \
783 "\t-f FORMAT FILE\n" \
784 "\t-n LENGTH\tInterpret only length bytes of input\n" \
785 "\t-o\t\tTwo-byte octal display\n" \
786 "\t-s OFFSET\tSkip offset byte\n" \
787 "\t-v\t\tdisplay all input data\n" \
788 "\t-x\t\tTwo-byte hexadecimal display\n"
789
Eric Andersen7e9276b2001-02-22 01:15:47 +0000790#define hostid_trivial_usage \
791 ""
792#define hostid_full_usage \
793 "Print out a unique 32-bit identifier for the machine."
794
795#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000796 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000797#define hostname_full_usage \
798 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000799 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000800 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +0000801 "\t-s\tShort\n" \
802 "\t-i\tAddresses for the hostname\n" \
803 "\t-d\tDNS domain name\n" \
804 "\t-f\tFully qualified domain name\n" \
805 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000806#define hostname_example_usage \
807 "$ hostname\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000808 "sage \n"
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000809#ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH
810 #define USAGE_HTTPD_BASIC_AUTH(a) a
811#else
812 #define USAGE_HTTPD_BASIC_AUTH(a)
813#endif
814#define httpd_trivial_usage \
815 "[-p <port>] [-d/-e <string>]" USAGE_HTTPD_BASIC_AUTH(" [-c <conf file>] [-r <realm>]")
816#define httpd_full_usage \
817 "Listens for incoming http server requests.\n"\
818 "Options:\n" \
819 "\t-p PORT\tServer port (default 80).\n" \
820 USAGE_HTTPD_BASIC_AUTH("\t-c FILE\tSpecifies configuration file. (default httpd.conf)\n\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
821 "\t-e STRING\tHtml encode STRING\n" \
822 "\t-d STRING\tURL decode STRING\n"
Robert Griebl1cd04452002-07-21 16:50:49 +0000823#define hwclock_trivial_usage \
824 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
825#define hwclock_full_usage \
826 "Query and set the hardware clock (RTC)\n\n" \
827 "Options:\n" \
828 "\t-r\tread hardware clock and print result\n" \
829 "\t-s\tset the system time from the hardware clock\n" \
830 "\t-w\tset the hardware clock to the current system time\n" \
831 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
832 "\t-l\tthe hardware clock is kept in local time"
833
Eric Andersen7e9276b2001-02-22 01:15:47 +0000834#define id_trivial_usage \
835 "[OPTIONS]... [USERNAME]"
836#define id_full_usage \
837 "Print information for USERNAME or the current user\n\n" \
838 "Options:\n" \
839 "\t-g\tprints only the group ID\n" \
840 "\t-u\tprints only the user ID\n" \
841 "\t-n\tprint a name instead of a number (with for -ug)\n" \
842 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000843#define id_example_usage \
844 "$ id\n" \
845 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000846
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000847#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +0000848 #define USAGE_SIOCSKEEPALIVE(a) a
849#else
850 #define USAGE_SIOCSKEEPALIVE(a)
851#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000852#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000853 #define USAGE_IFCONFIG_MII(a) a
854#else
855 #define USAGE_IFCONFIG_MII(a)
856#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000857#ifdef CONFIG_FEATURE_IFCONFIG_HW
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000858 #define USAGE_IFCONFIG_HW(a) a
859#else
860 #define USAGE_IFCONFIG_HW(a)
861#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000862#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000863 #define USAGE_IFCONFIG_OPT_A(a) a
864#else
865 #define USAGE_IFCONFIG_OPT_A(a)
866#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +0000867#ifdef CONFIG_FEATURE_IPV6
868 #define USAGE_IPV6(a) a
869#else
870 #define USAGE_IPV6(a)
871#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000872
Eric Andersen7e9276b2001-02-22 01:15:47 +0000873#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000874 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000875#define ifconfig_full_usage \
876 "configure a network interface\n\n" \
877 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +0000878 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
879 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000880 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000881 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000882 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000883 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
884 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000885 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000886 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
887 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000888 "\t[up|down] ..."
889
Glenn L McGrath021fa7d2002-11-09 09:34:15 +0000890#define ifup_trivial_usage \
891 "<-ahinv> <ifaces...>"
892#define ifup_full_usage \
893 "Usage: ifup <options> <ifaces...>\n\n" \
894 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +0000895 "\t-h\tthis help\n" \
896 "\t-a\tde/configure all interfaces automatically\n" \
897 "\t-i FILE\tuse FILE for interface definitions\n" \
898 "\t-n\tprint out what would happen, but don't do it\n" \
899 "\t\t\t(note that this option doesn't disable mappings)\n" \
900 "\t-v\tprint out what would happen before doing it\n" \
901 "\t-m\tdon't run any mappings\n" \
902 "\t-f\tforce de/configuration\n"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +0000903
904#define ifdown_trivial_usage \
905 "<-ahinv> <ifaces...>"
906#define ifdown_full_usage \
907 "Usage: ifdown <options> <ifaces...>\n\n" \
908 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +0000909 "\t-h\tthis help\n" \
910 "\t-a\tde/configure all interfaces automatically\n" \
911 "\t-i FILE\tuse FILE for interface definitions\n" \
912 "\t-n\tprint out what would happen, but don't do it\n" \
913 "\t\t(note that this option doesn't disable mappings)\n" \
914 "\t-v\tprint out what would happen before doing it\n" \
915 "\t-m\tdon't run any mappings\n" \
916 "\t-f\tforce de/configuration\n"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +0000917
Glenn L McGrath06e95652003-02-09 06:51:14 +0000918#define inetd_trivial_usage \
919 "[-q len] [conf]"
920#define inetd_full_usage \
921 "Usage: [-q len] [conf]\n\n" \
922 "Option:\n" \
923 "\t-q\tSets the size of the socket listen queue to\n" \
924 "the specified value. Default is 128."
925
Eric Andersen7e9276b2001-02-22 01:15:47 +0000926#define init_trivial_usage \
927 ""
928#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000929 "Init is the parent of all processes."
930#define init_notes_usage \
931"This version of init is designed to be run only by the kernel.\n" \
932"\n" \
933"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
934"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
935"runlevels, use sysvinit.\n" \
936"\n" \
937"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
938"it has the following default behavior:\n" \
939"\n" \
940" ::sysinit:/etc/init.d/rcS\n" \
941" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000942" ::ctrlaltdel:/sbin/reboot\n" \
943" ::shutdown:/sbin/swapoff -a\n" \
944" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000945" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000946"\n" \
947"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
948"\n" \
949" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000950" tty3::askfirst:/bin/sh\n" \
951" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000952"\n" \
953"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
954"\n" \
955" <id>:<runlevels>:<action>:<process>\n" \
956"\n" \
957" <id>: \n" \
958"\n" \
959" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
960" The id field is used by BusyBox init to specify the controlling tty for\n" \
961" the specified process to run on. The contents of this field are\n" \
962" appended to "/dev/" and used as-is. There is no need for this field to\n" \
963" be unique, although if it isn't you may have strange results. If this\n" \
964" field is left blank, the controlling tty is set to the console. Also\n" \
965" note that if BusyBox detects that a serial console is in use, then only\n" \
966" entries whose controlling tty is either the serial console or /dev/null\n" \
967" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
968" stinkin' utmp.\n" \
969"\n" \
970" <runlevels>: \n" \
971"\n" \
972" The runlevels field is completely ignored.\n" \
973"\n" \
974" <action>: \n" \
975"\n" \
976" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000977" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000978"\n" \
979" The available actions can be classified into two groups: actions\n" \
980" that are run only once, and actions that are re-run when the specified\n" \
981" process exits.\n" \
982"\n" \
983" Run only-once actions:\n" \
984"\n" \
985" 'sysinit' is the first item run on boot. init waits until all\n" \
986" sysinit actions are completed before continuing. Following the\n" \
987" completion of all sysinit actions, all 'wait' actions are run.\n" \
988" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000989" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000990" therefore, init does not wait for them to complete. 'restart' is\n" \
991" the action taken to restart the init process. By default this should\n" \
992" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
993" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000994" actions are run when the system detects that someone on the system\n" \
995" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
996" wants to run 'reboot' at this point to cause the system to reboot.\n" \
997" Finally the 'shutdown' action specifies the actions to taken when\n" \
998" init is told to reboot. Unmounting filesystems and disabling swap\n" \
999" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001000"\n" \
1001" Run repeatedly actions:\n" \
1002"\n" \
1003" 'respawn' actions are run after the 'once' actions. When a process\n" \
1004" started with a 'respawn' action exits, init automatically restarts\n" \
1005" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1006" respawning out of control. The 'askfirst' actions acts just like\n" \
1007" respawn, except that before running the specified process it\n" \
1008" displays the line "Please press Enter to activate this console."\n" \
1009" and then waits for the user to press enter before starting the\n" \
1010" specified process. \n" \
1011"\n" \
1012" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1013" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001014" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001015"\n" \
1016" <process>: \n" \
1017"\n" \
1018" Specifies the process to be executed and it's command line.\n" \
1019"\n" \
1020"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001021"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001022" # This is run first except when booting in single-user mode.\n" \
1023" #\n" \
1024" ::sysinit:/etc/init.d/rcS\n" \
1025" \n" \
1026" # /bin/sh invocations on selected ttys\n" \
1027" #\n" \
1028" # Start an "askfirst" shell on the console (whatever that may be)\n" \
1029" ::askfirst:-/bin/sh\n" \
1030" # Start an "askfirst" shell on /dev/tty2-4\n" \
1031" tty2::askfirst:-/bin/sh\n" \
1032" tty3::askfirst:-/bin/sh\n" \
1033" tty4::askfirst:-/bin/sh\n" \
1034" \n" \
1035" # /sbin/getty invocations for selected ttys\n" \
1036" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001037" tty4::respawn:/sbin/getty 38400 tty4\n" \
1038" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001039" \n" \
1040" \n" \
1041" # Example of how to put a getty on a serial line (for a terminal)\n" \
1042" #\n" \
1043" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1044" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1045" #\n" \
1046" # Example how to put a getty on a modem line.\n" \
1047" #::respawn:/sbin/getty 57600 ttyS2\n" \
1048" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001049" # Stuff to do when restarting the init process\n" \
1050" ::restart:/sbin/init\n" \
1051" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001052" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001053" ::ctrlaltdel:/sbin/reboot\n" \
1054" ::shutdown:/bin/umount -a -r\n" \
1055" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001056
Eric Andersenbe65c352003-01-23 04:57:35 +00001057#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
1058 #define USAGE_INSMOD_MAP(a) a
1059#else
1060 #define USAGE_INSMOD_MAP(a)
1061#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001062#define insmod_trivial_usage \
1063 "[OPTION]... MODULE [symbol=value]..."
1064#define insmod_full_usage \
1065 "Loads the specified kernel modules into the kernel.\n\n" \
1066 "Options:\n" \
1067 "\t-f\tForce module to load into the wrong kernel version.\n" \
1068 "\t-k\tMake module autoclean-able.\n" \
1069 "\t-v\tverbose output\n" \
1070 "\t-L\tLock to prevent simultaneous loads of a module\n" \
Eric Andersenbe65c352003-01-23 04:57:35 +00001071 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout") \
1072 "\t-x\tdo not export externs\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001073
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001074#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001075 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001076#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001077 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1078 "where OBJECT := { link | addr | route | tunnel }\n" \
1079 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }\n"
1080
1081#define ipaddr_trivial_usage \
1082 "{ {add|del} IFADDR dev STRING | {show|flush} [ dev STRING ] [ to PREFIX ] }"
1083#define ipaddr_full_usage \
1084 "ipaddr {add|del} IFADDR dev STRING\n" \
1085 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
1086 " [ to PREFIX ] [ label PATTERN ]\n" \
1087 "IFADDR := PREFIX | ADDR peer PREFIX\n" \
1088 " [ broadcast ADDR ] [ anycast ADDR ]\n" \
1089 " [ label STRING ] [ scope SCOPE-ID ]\n" \
1090 "SCOPE-ID := [ host | link | global | NUMBER ]\n"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001091
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001092#ifndef CONFIG_FEATURE_IPCALC_FANCY
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001093# define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001094 "[--broadcast] [--netmask] [--network] ipaddr <netmask>"
1095
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001096# define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001097 "Calculate IP network settings from a IP address\n\n" \
1098 "Options:\n" \
1099 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1100 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
1101 "\t-w\t--network\tDisplay calculated network address."
1102#else
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001103# define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001104 "[OPTION]... ipaddr <netmask>"
1105
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001106# define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001107 "Calculate IP network settings from a IP address\n\n" \
1108 "Options:\n" \
1109 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1110 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
1111 "\t-w\t--network\tDisplay calculated network address.\n" \
1112 "\t-h\t--hostname\tDisplay first resolved host name.\n" \
1113 "\t-s\t--silent\tDon't ever display error messages."
1114#endif
1115
1116#define ipcalc_notes_usage \
1117 "ipcalc provides a simple way to calculate IP information for\n" \
1118 "a host. The various options specify what information ipcalc\n" \
1119 "should display on standard out. Multiple options may be\n" \
1120 "specified.\n"
1121
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001122#define iplink_trivial_usage \
1123 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1124#define iplink_full_usage \
1125 "iplink set DEVICE { up | down | arp { on | off } |\n" \
1126 " dynamic { on | off } |\n" \
1127 " mtu MTU }\n" \
1128 "iplink show [ DEVICE ]\n"
1129
1130#define iproute_trivial_usage \
1131 "{ list | flush | { add | del | change | append | replace | monitor } ROUTE }"
1132#define iproute_full_usage \
1133 "iproute { list | flush } SELECTOR\n" \
1134 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
1135 " [ oif STRING ] [ tos TOS ]\n" \
1136 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
1137 "SELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1138 "ROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]\n"
1139
1140#define iptunnel_trivial_usage \
1141 "{ add | change | del | show } [ NAME ] [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
1142#define iptunnel_full_usage \
1143 "iptunnel { add | change | del | show } [ NAME ]\n" \
1144 " [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1145 " [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1146 " [ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]\n"
1147
Eric Andersen7e9276b2001-02-22 01:15:47 +00001148#define kill_trivial_usage \
1149 "[-signal] process-id [process-id ...]"
1150#define kill_full_usage \
1151 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +00001152 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001153 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001154#define kill_example_usage \
1155 "$ ps | grep apache\n" \
1156 "252 root root S [apache]\n" \
1157 "263 www-data www-data S [apache]\n" \
1158 "264 www-data www-data S [apache]\n" \
1159 "265 www-data www-data S [apache]\n" \
1160 "266 www-data www-data S [apache]\n" \
1161 "267 www-data www-data S [apache]\n" \
1162 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001163
1164#define killall_trivial_usage \
1165 "[-signal] process-name [process-name ...]"
1166#define killall_full_usage \
1167 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001168 "Options:\n" \
1169 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001170#define killall_example_usage \
1171 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001172
Mark Whitley6317c4b2001-03-12 22:51:50 +00001173#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001174 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001175#define klogd_full_usage \
1176 "Kernel logger.\n"\
1177 "Options:\n"\
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001178 "\t-c n\tSets the default log level of console messages to n.\n"\
Mark Whitley6317c4b2001-03-12 22:51:50 +00001179 "\t-n\tRun as a foreground process."
1180
Eric Andersen7e9276b2001-02-22 01:15:47 +00001181#define length_trivial_usage \
1182 "STRING"
1183#define length_full_usage \
1184 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001185#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001186 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001187 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001188
1189#define ln_trivial_usage \
1190 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1191#define ln_full_usage \
1192 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
1193 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1194 "Options:\n" \
1195 "\t-s\tmake symbolic links instead of hard links\n" \
1196 "\t-f\tremove existing destination files\n" \
1197 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001198#define ln_example_usage \
1199 "$ ln -s BusyBox /tmp/ls\n" \
1200 "$ ls -l /tmp/ls\n" \
1201 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001202
1203#define loadacm_trivial_usage \
1204 "< mapfile"
1205#define loadacm_full_usage \
1206 "Loads an acm from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001207#define loadacm_example_usage \
1208 "$ loadacm < /etc/i18n/acmname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001209
1210#define loadfont_trivial_usage \
1211 "< font"
1212#define loadfont_full_usage \
1213 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001214#define loadfont_example_usage \
1215 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001216
1217#define loadkmap_trivial_usage \
1218 "< keymap"
1219#define loadkmap_full_usage \
1220 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001221#define loadkmap_example_usage \
1222 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001223
1224#define logger_trivial_usage \
1225 "[OPTION]... [MESSAGE]"
1226#define logger_full_usage \
1227 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1228 "Options:\n" \
1229 "\t-s\tLog to stderr as well as the system log.\n" \
1230 "\t-t\tLog using the specified tag (defaults to user name).\n" \
1231 "\t-p\tEnter the message with the specified priority.\n" \
1232 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001233#define logger_example_usage \
1234 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001235
Robert Griebl1fca5582002-06-04 20:45:46 +00001236#define login_trivial_usage \
1237 "[OPTION]... [username] [ENV=VAR ...]"
1238#define login_full_usage \
1239 "Begin a new session on the system\n\n" \
1240 "Options:\n" \
1241 "\t-f\tDo not authenticate (user already authenticated)\n" \
1242 "\t-h\tName of the remote host for this login.\n" \
1243 "\t-p\tPreserve environment."
1244
Eric Andersen7e9276b2001-02-22 01:15:47 +00001245#define logname_trivial_usage \
1246 ""
1247#define logname_full_usage \
1248 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001249#define logname_example_usage \
1250 "$ logname\n" \
1251 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001252
Mark Whitley6317c4b2001-03-12 22:51:50 +00001253#define logread_trivial_usage \
1254 ""
1255
1256#define logread_full_usage \
1257 "Shows the messages from syslogd (using circular buffer)."
1258
Matt Kraai83788da2002-03-20 17:38:37 +00001259#define losetup_trivial_usage \
1260 "[OPTION]... LOOPDEVICE FILE\n" \
1261 "or: losetup [OPTION]... -d LOOPDEVICE"
1262#define losetup_full_usage \
1263 "Associate LOOPDEVICE with FILE.\n\n" \
1264 "Options:\n" \
1265 "\t-d\t\tDisassociate LOOPDEVICE.\n" \
1266 "\t-o OFFSET\tStart OFFSET bytes into FILE.\n"
1267
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001268#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001269 #define USAGE_LS_TIMESTAMPS(a) a
1270#else
1271 #define USAGE_LS_TIMESTAMPS(a)
1272#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001273#ifdef CONFIG_FEATURE_LS_FILETYPES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001274 #define USAGE_LS_FILETYPES(a) a
1275#else
1276 #define USAGE_LS_FILETYPES(a)
1277#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001278#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001279 #define USAGE_LS_FOLLOWLINKS(a) a
1280#else
1281 #define USAGE_LS_FOLLOWLINKS(a)
1282#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001283#ifdef CONFIG_FEATURE_LS_RECURSIVE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001284 #define USAGE_LS_RECURSIVE(a) a
1285#else
1286 #define USAGE_LS_RECURSIVE(a)
1287#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001288#ifdef CONFIG_FEATURE_LS_SORTFILES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001289 #define USAGE_LS_SORTFILES(a) a
1290#else
1291 #define USAGE_LS_SORTFILES(a)
1292#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001293#ifdef CONFIG_FEATURE_AUTOWIDTH
Eric Andersen7e9276b2001-02-22 01:15:47 +00001294 #define USAGE_AUTOWIDTH(a) a
1295#else
1296 #define USAGE_AUTOWIDTH(a)
1297#endif
1298#define ls_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +00001299 "[-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 +00001300#define ls_full_usage \
1301 "List directory contents\n\n" \
1302 "Options:\n" \
1303 "\t-1\tlist files in a single column\n" \
1304 "\t-A\tdo not list implied . and ..\n" \
1305 "\t-a\tdo not hide entries starting with .\n" \
1306 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001307 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001308 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001309 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1310 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001311 "\t-i\tlist the i-node for each file\n" \
1312 "\t-l\tuse a long listing format\n" \
1313 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001314 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1315 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1316 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1317 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1318 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001319 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001320 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1321 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1322 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1323 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1324 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001325 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001326 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1327 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001328 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersened0d9582001-02-23 13:23:03 +00001329 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +00001330 "\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001331
1332#define lsmod_trivial_usage \
1333 ""
1334#define lsmod_full_usage \
1335 "List the currently loaded kernel modules."
1336
1337#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001338 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001339#define makedevs_full_usage \
1340 "Creates a range of block or character special files\n\n" \
1341 "TYPEs include:\n" \
1342 "\tb:\tMake a block (buffered) device.\n" \
1343 "\tc or u:\tMake a character (un-buffered) device.\n" \
1344 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1345 "FIRST specifies the number appended to NAME to create the first device.\n" \
1346 "LAST specifies the number of the last item that should be created.\n" \
1347 "If 's' is the last argument, the base device is created as well.\n\n" \
1348 "For example:\n" \
1349 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001350 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001351#define makedevs_example_usage \
1352 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
1353 "[creates ttyS2-ttyS63]\n" \
1354 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
1355 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001356
Eric Andersen7e9276b2001-02-22 01:15:47 +00001357#define md5sum_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001358 "[OPTION] [FILE]...\n" \
1359 "or: md5sum [OPTION] -c [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001360#define md5sum_full_usage \
1361 "Print or check MD5 checksums.\n\n" \
1362 "Options:\n" \
1363 "With no FILE, or when FILE is -, read standard input.\n\n" \
1364 "\t-b\tread files in binary mode\n" \
1365 "\t-c\tcheck MD5 sums against given list\n" \
1366 "\t-t\tread files in text mode (default)\n" \
1367 "\t-g\tread a string\n" \
1368 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001369 "\t-s\tdon't output anything, status code shows success\n" \
1370 "\t-w\twarn about improperly formated MD5 checksum lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001371#define md5sum_example_usage \
1372 "$ md5sum < busybox\n" \
1373 "6fd11e98b98a58f64ff3398d7b324003\n" \
1374 "$ md5sum busybox\n" \
1375 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1376 "$ md5sum -c -\n" \
1377 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1378 "busybox: OK\n" \
1379 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001380
Glenn L McGrath061c9002002-09-16 04:21:46 +00001381#define mesg_trivial_usage \
1382 "mesg [y|n]"
1383#define mesg_full_usage \
1384 "mesg [Y|N], controls write access to your terminal\n" \
1385 "\ty\tAllow write access to your terminal.\n" \
1386 "\tn\tDisallow write access to your terminal.\n"
1387
Eric Andersen7e9276b2001-02-22 01:15:47 +00001388#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001389 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001390#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001391 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001392 "Options:\n" \
1393 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001394 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001395#define mkdir_example_usage \
1396 "$ mkdir /tmp/foo\n" \
1397 "$ mkdir /tmp/foo\n" \
1398 "/tmp/foo: File exists\n" \
1399 "$ mkdir /tmp/foo/bar/baz\n" \
1400 "/tmp/foo/bar/baz: No such file or directory\n" \
1401 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001402
Eric Andersen7e9276b2001-02-22 01:15:47 +00001403#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001404 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001405#define mkfifo_full_usage \
1406 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1407 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001408 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001409
Eric Andersen7e9276b2001-02-22 01:15:47 +00001410#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001411 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001412#define mkfs_minix_full_usage \
1413 "Make a MINIX filesystem.\n\n" \
1414 "Options:\n" \
1415 "\t-c\t\tCheck the device for bad blocks\n" \
1416 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1417 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1418 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001419 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001420
Eric Andersen7e9276b2001-02-22 01:15:47 +00001421#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001422 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001423#define mknod_full_usage \
1424 "Create a special file (block, character, or pipe).\n\n" \
1425 "Options:\n" \
1426 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1427 "TYPEs include:\n" \
1428 "\tb:\tMake a block (buffered) device.\n" \
1429 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001430 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001431#define mknod_example_usage \
1432 "$ mknod /dev/fd0 b 2 0 \n" \
1433 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001434
Eric Andersen7e9276b2001-02-22 01:15:47 +00001435#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001436 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001437#define mkswap_full_usage \
1438 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001439 "Options:\n" \
1440 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001441 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001442 "\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 +00001443 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001444
Eric Andersen7e9276b2001-02-22 01:15:47 +00001445#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001446 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001447#define mktemp_full_usage \
1448 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001449 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001450#define mktemp_example_usage \
1451 "$ mktemp /tmp/temp.XXXXXX\n" \
1452 "/tmp/temp.mWiLjM\n" \
1453 "$ ls -la /tmp/temp.mWiLjM\n" \
1454 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001455
Eric Andersen8d79ce82001-07-22 23:00:15 +00001456#define modprobe_trivial_usage \
1457 "[FILE ...]"
1458#define modprobe_full_usage \
Eric Andersenabc95682002-07-03 02:52:35 +00001459 "Used for high level module loading and unloading."
Eric Andersen8d79ce82001-07-22 23:00:15 +00001460#define modprobe_example_usage \
1461 "$ modprobe cdrom\n"
1462
Eric Andersen7e9276b2001-02-22 01:15:47 +00001463#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001464 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001465#define more_full_usage \
1466 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001467#define more_example_usage \
1468 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001469
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001470#ifdef CONFIG_FEATURE_MOUNT_LOOP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001471 #define USAGE_MOUNT_LOOP(a) a
1472#else
1473 #define USAGE_MOUNT_LOOP(a)
1474#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001475#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001476 #define USAGE_MTAB(a) a
1477#else
1478 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001479#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001480#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001481 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001482#define mount_full_usage \
1483 "Mount a filesystem\n\n" \
1484 "Flags:\n" \
1485 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001486 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001487 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001488 "\t-n:\t\tDon't write a mount table entry.\n" \
1489 ) \
1490 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1491 "\t-r:\t\tMount the filesystem read-only.\n" \
1492 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1493 "\t-w:\t\tMount for reading and writing (default).\n" \
1494 "\n" \
1495 "Options for use with the \"-o\" flag:\n" \
1496 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1497 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1498 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1499 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001500 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001501 "\tloop:\t\tMounts a file via loop device.\n" \
1502 ) \
1503 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001504 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001505 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001506 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001507 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001508 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001509#define mount_example_usage \
1510 "$ mount\n" \
1511 "/dev/hda3 on / type minix (rw)\n" \
1512 "proc on /proc type proc (rw)\n" \
1513 "devpts on /dev/pts type devpts (rw)\n" \
1514 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1515 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001516
Eric Andersen7e9276b2001-02-22 01:15:47 +00001517#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001518 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001519#define mt_full_usage \
1520 "Control magnetic tape drive operation\n" \
1521 "\nAvailable Opcodes:\n\n" \
1522 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1523 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
1524 "ras3 reset retension rew rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001525 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001526
Eric Andersen7e9276b2001-02-22 01:15:47 +00001527#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001528 "SOURCE DEST\n" \
1529 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001530#define mv_full_usage \
1531 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001532#define mv_example_usage \
1533 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001534
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001535#define nameif_trivial_usage \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001536 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001537#define nameif_full_usage \
1538 "Nameif renaming network interface while it in the down state.\n\n" \
1539 "Options:\n" \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001540 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001541 "\t-s\t\tUse syslog (LOCAL0 facility).\n" \
1542 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address\n"
1543#define nameif_example_usage \
1544 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
1545 " or\n" \
1546 "$ nameif -c /etc/my_mactab_file\n" \
1547
Eric Andersen7e9276b2001-02-22 01:15:47 +00001548#define nc_trivial_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001549 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001550#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001551 "Netcat opens a pipe to IP:port\n\n" \
1552 "Options:\n" \
1553 "\t-l\t\tlisten mode, for inbound connects\n" \
1554 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00001555 "\t-i SECS\t\tdelay interval for lines sent\n" \
Eric Andersen00a6a752002-04-26 23:53:10 +00001556 "\t-e PROG\t\tprogram to exec after connect (dangerous!)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001557#define nc_example_usage \
1558 "$ nc foobar.somedomain.com 25\n" \
1559 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1560 "help\n" \
1561 "214-Commands supported:\n" \
1562 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1563 "214 NOOP QUIT RSET HELP\n" \
1564 "quit\n" \
1565 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001566
Eric Andersen1552ff72001-10-31 11:07:12 +00001567#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00001568 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00001569#define netstat_full_usage \
1570 "-l display listening server sockets\n" \
1571 "-a display all sockets (default: connected)\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001572 "-e display other/more information\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001573 "-n don't resolve names\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001574 "-r display routing table\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001575 "-t tcp sockets\n" \
1576 "-u udp sockets\n" \
1577 "-w raw sockets\n" \
1578 "-x unix sockets\n"
1579
Eric Andersen7e9276b2001-02-22 01:15:47 +00001580#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001581 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001582#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001583 "Queries the nameserver for the IP address of the given HOST\n" \
1584 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001585#define nslookup_example_usage \
1586 "$ nslookup localhost\n" \
1587 "Server: default\n" \
1588 "Address: default\n" \
1589 "\n" \
1590 "Name: debian\n" \
1591 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001592
Glenn L McGrath60281112001-11-02 11:39:46 +00001593#define od_trivial_usage \
1594 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
1595#define od_full_usage \
1596 "Write an unambiguous representation, octal bytes by default, of FILE\n"\
1597 "to standard output. With no FILE, or when FILE is -, read standard input."
1598
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00001599#define openvt_trivial_usage \
1600 "<vtnum> <COMMAND> [ARGS...]"
1601#define openvt_full_usage \
1602 "Start a command on a new virtual terminal"
1603#define openvt_example_usage \
1604 "openvt 2 /bin/ash\n"
1605
Eric Andersen27f64e12002-06-23 04:24:25 +00001606#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
1607 #define PASSWORD_ALG_TYPES(a) a
1608#else
1609 #define PASSWORD_ALG_TYPES(a)
1610#endif
1611#define passwd_trivial_usage \
1612 "[OPTION] [name]"
1613#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00001614 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00001615 "changes the password for the current user.\n" \
1616 "Options:\n" \
1617 "\t-a\tDefine which algorithm shall be used for the password.\n" \
1618 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001619 PASSWORD_ALG_TYPES(", sha1") \
Eric Andersen27f64e12002-06-23 04:24:25 +00001620 ")\n\t-d\tDelete the password for the specified user account.\n" \
1621 "\t-l\tLocks (disables) the specified user account.\n" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001622 "\t-u\tUnlocks (re-enables) the specified user account."
Eric Andersen27f64e12002-06-23 04:24:25 +00001623
Eric Andersen221b2ea2001-07-31 19:06:07 +00001624#define pidof_trivial_usage \
1625 "process-name [process-name ...]"
1626#define pidof_full_usage \
1627 "Lists the PIDs of all processes with names that match the names on the command line"
1628#define pidof_example_usage \
1629 "$ pidof init\n" \
1630 "1\n"
1631
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001632#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001633#define ping_trivial_usage "host"
1634#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1635#else
1636#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001637 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001638#define ping_full_usage \
1639 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1640 "Options:\n" \
1641 "\t-c COUNT\tSend only COUNT pings.\n" \
1642 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1643 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001644 "\t\t\tand when finished."
1645#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001646#define ping_example_usage \
1647 "$ ping localhost\n" \
1648 "PING slag (127.0.0.1): 56 data bytes\n" \
1649 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1650 "\n" \
1651 "--- debian ping statistics ---\n" \
1652 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1653 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001654
Eric Andersen51b8bd62002-07-03 11:46:38 +00001655#ifndef CONFIG_FEATURE_FANCY_PING6
1656#define ping6_trivial_usage "host"
1657#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1658#else
1659#define ping6_trivial_usage \
1660 "[OPTION]... host"
1661#define ping6_full_usage \
1662 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1663 "Options:\n" \
1664 "\t-c COUNT\tSend only COUNT pings.\n" \
1665 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1666 "\t-q\t\tQuiet mode, only displays output at start\n" \
1667 "\t\t\tand when finished."
1668#endif
1669#define ping6_example_usage \
1670 "$ ping6 ip6-localhost\n" \
1671 "PING ip6-localhost (::1): 56 data bytes\n" \
1672 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
1673 "\n" \
1674 "--- ip6-localhost ping statistics ---\n" \
1675 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1676 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
1677
Eric Andersen7e9276b2001-02-22 01:15:47 +00001678#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001679 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001680#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001681 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001682 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001683
Eric Andersen7e9276b2001-02-22 01:15:47 +00001684#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001685 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001686#define poweroff_full_usage \
1687 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001688
Eric Andersen7e9276b2001-02-22 01:15:47 +00001689#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001690 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001691#define printf_full_usage \
1692 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001693 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001694#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001695 "$ printf "Val=%d\\n" 5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001696 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001697
Eric Andersen7e9276b2001-02-22 01:15:47 +00001698#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001699 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001700#define ps_full_usage \
1701 "Report process status\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001702 "\nThis version of ps accepts no options."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001703#define ps_example_usage \
1704 "$ ps\n" \
1705 " PID Uid Gid State Command\n" \
1706 " 1 root root S init\n" \
1707 " 2 root root S [kflushd]\n" \
1708 " 3 root root S [kupdate]\n" \
1709 " 4 root root S [kpiod]\n" \
1710 " 5 root root S [kswapd]\n" \
1711 " 742 andersen andersen S [bash]\n" \
1712 " 743 andersen andersen S -bash\n" \
1713 " 745 root root S [getty]\n" \
1714 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001715
Eric Andersen7e9276b2001-02-22 01:15:47 +00001716#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001717 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001718#define pwd_full_usage \
1719 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001720#define pwd_example_usage \
1721 "$ pwd\n" \
1722 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001723
Eric Andersen7e9276b2001-02-22 01:15:47 +00001724#define rdate_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001725 "[OPTION] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001726#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001727 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001728 "Options:\n" \
1729 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001730 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001731
Eric Andersen7e9276b2001-02-22 01:15:47 +00001732#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001733 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001734#define readlink_full_usage \
1735 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001736
Glenn L McGrath62fae302002-12-10 00:14:33 +00001737#define realpath_trivial_usage \
1738 "pathname ..."
1739#define realpath_full_usage \
1740 "return the canonicalized absolute pathnames of given arguments\n\n"
1741
Eric Andersen7e9276b2001-02-22 01:15:47 +00001742#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001743 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001744#define reboot_full_usage \
1745 "Reboot the system."
1746
1747#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001748 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001749#define renice_full_usage \
1750 "Changes priority of running processes. Allowed priorities range\n" \
1751 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001752 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001753
Eric Andersen7e9276b2001-02-22 01:15:47 +00001754#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001755 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001756#define reset_full_usage \
1757 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001758
Eric Andersen7e9276b2001-02-22 01:15:47 +00001759#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001760 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001761#define rm_full_usage \
1762 "Remove (unlink) the FILE(s). You may use '--' to\n" \
1763 "indicate that all following arguments are non-options.\n\n" \
1764 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00001765 "\t-i\t\talways prompt before removing each destination" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001766 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001767 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001768#define rm_example_usage \
1769 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001770
Eric Andersen7e9276b2001-02-22 01:15:47 +00001771#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001772 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001773#define rmdir_full_usage \
1774 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001775#define rmdir_example_usage \
1776 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001777
Eric Andersen7e9276b2001-02-22 01:15:47 +00001778#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001779 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001780#define rmmod_full_usage \
1781 "Unloads the specified kernel modules from the kernel.\n\n" \
1782 "Options:\n" \
Tim Rikercf932742002-12-14 01:58:59 +00001783 "\t-a\tRemove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001784#define rmmod_example_usage \
1785 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001786
Eric Andersen7e9276b2001-02-22 01:15:47 +00001787#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001788 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001789#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00001790 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00001791 "Options:\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001792 "\t-n\tDont resolve names.\n" \
1793 "\t-e\tDisplay other/more information"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001794
Glenn L McGrathb72a7352002-12-10 00:17:22 +00001795#define rpm_trivial_usage \
1796 "-i -q[ildc]p package.rpm"
1797#define rpm_full_usage \
1798 "Manipulates RPM packages" \
1799 "Options:" \
1800 "\t-i Install package" \
1801 "\t-q Query package" \
1802 "\t\t-p Query uninstalled package" \
1803 "\t\t-i Show information" \
1804 "\t\t-l List contents" \
1805 "\t\t-d List documents" \
1806 "\t\t-c List config files"
1807
Glenn L McGrathf8736d22001-06-26 01:19:34 +00001808#define rpm2cpio_trivial_usage \
1809 "package.rpm"
1810#define rpm2cpio_full_usage \
1811 "Outputs a cpio archive of the rpm file."
1812
Eric Andersen6cf47a72001-10-31 10:24:36 +00001813#define run_parts_trivial_usage \
1814 "[-t] [-a ARG] [-u MASK] DIRECTORY"
1815#define run_parts_full_usage \
1816 "Run a bunch of scripts in a directory.\n\n" \
1817 "Options:\n" \
1818 "\t-t\t\tTest only what file will be executed, without execute them.\n" \
1819 "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \
1820 "\t-u MASK\tSet the umask to MASK before executing every program."
1821
Eric Andersen7e9276b2001-02-22 01:15:47 +00001822#define sed_trivial_usage \
Matt Kraai075228a2001-06-21 14:40:55 +00001823 "[-nef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001824#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001825 "Options:\n" \
1826 "\t-n\t\tsuppress automatic printing of pattern space\n" \
1827 "\t-e script\tadd the script to the commands to be executed\n" \
1828 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001829 "\n" \
1830 "If no -e or -f is given, the first non-option argument is taken as the\n" \
1831 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001832 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001833#define sed_example_usage \
1834 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
1835 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001836
Eric Andersen7e9276b2001-02-22 01:15:47 +00001837#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001838 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001839#define setkeycodes_full_usage \
1840 "Set entries into the kernel's scancode-to-keycode map,\n" \
1841 "allowing unusual keyboards to generate usable keycodes.\n\n" \
1842 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001843 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001844#define setkeycodes_example_usage \
1845 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001846
Matt Kraai2d91deb2001-08-01 17:21:35 +00001847#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001848 "[FILE]...\n" \
1849 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00001850#define lash_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001851 "lash: The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00001852#define lash_notes_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001853"This command does not yet have proper documentation.\n" \
1854"\n" \
1855"Use lash just as you would use any other shell. It properly handles pipes,\n" \
1856"redirects, job control, can be used as the shell for scripts, and has a\n" \
1857"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
1858"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
1859"use ash or bash. If you just need a very simple and extremely small shell,\n" \
1860"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001861
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00001862#define sha1sum_trivial_usage \
1863 "[OPTION] [FILE]"
1864#define sha1sum_full_usage \
1865 "[OPTION] [FILE]"
1866
Eric Andersen7e9276b2001-02-22 01:15:47 +00001867#define sleep_trivial_usage \
1868 "N"
1869#define sleep_full_usage \
1870 "Pause for N seconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001871#define sleep_example_usage \
1872 "$ sleep 2\n" \
1873 "[2 second delay results]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001874
Eric Andersen7e9276b2001-02-22 01:15:47 +00001875
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001876#ifdef CONFIG_FEATURE_SORT_UNIQUE
Mark Whitleyfccaa362001-04-17 18:56:18 +00001877 #define USAGE_SORT_UNIQUE(a) a
1878#else
1879 #define USAGE_SORT_UNIQUE(a)
1880#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001881#ifdef CONFIG_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001882 #define USAGE_SORT_REVERSE(a) a
1883#else
1884 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001885#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001886#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001887 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001888#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001889 "Sorts lines of text in the specified files\n\n"\
1890 "Options:\n" \
1891 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
1892 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
1893 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001894#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001895 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001896 "a\n" \
1897 "b\n" \
1898 "c\n" \
1899 "d\n" \
1900 "e\n" \
1901 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001902
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001903#define start_stop_daemon_trivial_usage \
1904 "[OPTIONS]"
1905#define start_stop_daemon_full_usage \
1906 "Program to start and stop services.\n"\
1907 "Options:\n" \
1908 "-S\t\t\tstart\n"\
1909 "-K\t\t\tstop\n"\
Eric Andersenfe5b1a92002-10-22 19:21:48 +00001910 "-b\t\t\tforce process into background (daemonize)\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001911 "-x <executable>\t\tprogram to start/check if it is running\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001912 "-u <username>|<uid>\tstop this user's processes\n"\
1913 "-n <process-name>\tstop processes with this name\n"\
1914 "-s <signal>\t\tsignal to send (default 15)\n"\
1915 "-a <pathname>\t\tprogram to start (default <executable>)\n"
1916
Eric Andersenef5e8f82002-11-07 02:09:37 +00001917#define strings_trivial_usage \
1918 "[-afo] [-n length] [file ... ]"
1919#define strings_full_usage \
1920 "Display printable strings in a binary file." \
1921 "\n\nOptions:" \
1922 "\n\t-f\tPrecede each string with the name of the file where it was found." \
1923 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
1924 "\n\t-o\tEach string is preceded by its decimal offset in the file."
1925
Eric Andersen7e9276b2001-02-22 01:15:47 +00001926#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001927 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001928#define stty_full_usage \
1929 "Without arguments, prints baud rate, line discipline," \
1930 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001931 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00001932 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001933 "\n\t-a\t\tprint all current settings in human-readable form" \
1934 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00001935 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001936
Robert Griebl1fca5582002-06-04 20:45:46 +00001937#define su_trivial_usage \
1938 "[OPTION]... [-] [username]"
1939#define su_full_usage \
1940 "Change user id or become root.\n" \
1941 "Options:\n" \
1942 "\t-p\tPreserve environment"
1943
Eric Andersen27f64e12002-06-23 04:24:25 +00001944#define sulogin_trivial_usage \
1945 "[OPTION]... [tty-device]"
1946#define sulogin_full_usage \
1947 "Single user login\n" \
1948 "Options:\n" \
1949 "\t-f\tDo not authenticate (user already authenticated)\n" \
1950 "\t-h\tName of the remote host for this login.\n" \
1951 "\t-p\tPreserve environment."
1952
Eric Andersen7e9276b2001-02-22 01:15:47 +00001953#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001954 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001955#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001956 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001957 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001958 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001959
Eric Andersen7e9276b2001-02-22 01:15:47 +00001960#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001961 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001962#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001963 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001964 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001965 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001966
Eric Andersen7e9276b2001-02-22 01:15:47 +00001967#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001968 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001969#define sync_full_usage \
1970 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001971
Eric Andersen7e9276b2001-02-22 01:15:47 +00001972
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001973#ifdef CONFIG_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00001974 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001975#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00001976 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001977#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00001978#ifdef CONFIG_FEATURE_IPC_SYSLOG
1979 #define USAGE_IPC_LOG(a) a
1980#else
1981 #define USAGE_IPC_LOG(a)
1982#endif
1983
Eric Andersen7e9276b2001-02-22 01:15:47 +00001984#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001985 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001986#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00001987 "Linux system and kernel logging utility.\n" \
1988 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001989 "Options:\n" \
1990 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
1991 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001992 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001993 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00001994 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00001995 "\t-L\t\tLog locally and via network logging (default is network only)") \
1996 USAGE_IPC_LOG( \
1997 "\n\t-C\t\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001998#define syslogd_example_usage \
1999 "$ syslogd -R masterlog:514\n" \
2000 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002001
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002002
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002003#ifndef CONFIG_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00002004 #define USAGE_UNSIMPLE_TAIL(a)
2005#else
2006 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002007#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002008#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002009 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002010#define tail_full_usage \
2011 "Print last 10 lines of each FILE to standard output.\n" \
2012 "With more than one FILE, precede each with a header giving the\n" \
2013 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
2014 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002015 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002016 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
2017 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002018 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002019 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
2020 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002021 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002022 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002023 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
2024#define tail_example_usage \
2025 "$ tail -n 1 /etc/resolv.conf\n" \
2026 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002027
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002028#ifdef CONFIG_FEATURE_TAR_CREATE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002029 #define USAGE_TAR_CREATE(a) a
2030#else
2031 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002032#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002033#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002034 #define USAGE_TAR_EXCLUDE(a) a
2035#else
2036 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002037#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002038#ifdef CONFIG_FEATURE_TAR_GZIP
2039 #define USAGE_TAR_GZIP(a) a
2040#else
2041 #define USAGE_TAR_GZIP(a)
2042#endif
2043#ifdef CONFIG_FEATURE_TAR_BZIP2
2044 #define USAGE_TAR_BZIP2(a) a
2045#else
2046 #define USAGE_TAR_BZIP2(a)
2047#endif
2048
Eric Andersen7e9276b2001-02-22 01:15:47 +00002049#define tar_trivial_usage \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002050 "-[" USAGE_TAR_CREATE("c") USAGE_TAR_GZIP("z") USAGE_TAR_BZIP2("j") "xtvO] " \
Eric Andersen317827d2001-05-21 17:50:53 +00002051 USAGE_TAR_EXCLUDE("[--exclude FILE] [-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00002052 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002053#define tar_full_usage \
2054 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00002055 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002056 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002057 "\tx\t\textract\n" \
2058 "\tt\t\tlist\n" \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002059 "\nArchive format selection:\n" \
2060 USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
2061 USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002062 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002063 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002064 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002065 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002066 "\texclude\t\tfile to exclude\n" \
2067 "\tX\t\tfile with names to exclude\n" \
2068 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00002069 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002070 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002071#define tar_example_usage \
2072 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
2073 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002074
Eric Andersen7e9276b2001-02-22 01:15:47 +00002075#define tee_trivial_usage \
2076 "[OPTION]... [FILE]..."
2077#define tee_full_usage \
2078 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002079 "Options:\n" \
2080 "\t-a\tappend to the given FILEs, do not overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002081#define tee_example_usage \
2082 "$ echo "Hello" | tee /tmp/foo\n" \
2083 "$ cat /tmp/foo\n" \
2084 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002085
Eric Andersen7e9276b2001-02-22 01:15:47 +00002086#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002087 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002088#define telnet_full_usage \
2089 "Telnet is used to establish interactive communication with another\n"\
2090 "computer over a network using the TELNET protocol."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002091
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002092#ifdef CONFIG_FEATURE_TELNETD_INETD
2093#define telnetd_trivial_usage \
2094 "(inetd mode) [OPTION]"
2095#define telnetd_full_usage \
2096 "Telnetd uses incoming TELNET connections via inetd.\n"\
2097 "Options:\n" \
2098 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
2099#else
Eric Andersen08a72202002-09-30 20:52:10 +00002100#define telnetd_trivial_usage \
2101 "[OPTION]"
2102#define telnetd_full_usage \
2103 "Telnetd listens for incoming TELNET connections on PORT.\n"\
2104 "Options:\n" \
2105 "\t-p PORT\tlisten for connections on PORT (default 23)\n"\
2106 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002107#endif
Eric Andersen08a72202002-09-30 20:52:10 +00002108
Eric Andersen7e9276b2001-02-22 01:15:47 +00002109#define test_trivial_usage \
2110 "EXPRESSION\n or [ EXPRESSION ]"
2111#define test_full_usage \
2112 "Checks file types and compares values returning an exit\n" \
2113 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002114#define test_example_usage \
2115 "$ test 1 -eq 2\n" \
2116 "$ echo $?\n" \
2117 "1\n" \
2118 "$ test 1 -eq 1\n" \
2119 "$ echo $? \n" \
2120 "0\n" \
2121 "$ [ -d /etc ]\n" \
2122 "$ echo $?\n" \
2123 "0\n" \
2124 "$ [ -d /junk ]\n" \
2125 "$ echo $?\n" \
2126 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002127
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002128#ifdef CONFIG_FEATURE_TFTP_GET
Mark Whitley450736c2001-03-02 19:08:50 +00002129 #define USAGE_TFTP_GET(a) a
2130#else
2131 #define USAGE_TFTP_GET(a)
2132#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002133#ifdef CONFIG_FEATURE_TFTP_PUT
Mark Whitley450736c2001-03-02 19:08:50 +00002134 #define USAGE_TFTP_PUT(a) a
2135#else
2136 #define USAGE_TFTP_PUT(a)
2137#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002138#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Glenn L McGrathad117d82001-10-05 04:40:37 +00002139 #define USAGE_TFTP_BS(a) a
2140#else
2141 #define USAGE_TFTP_BS(a)
2142#endif
Mark Whitley450736c2001-03-02 19:08:50 +00002143
2144#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00002145 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00002146#define tftp_full_usage \
2147 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00002148 "Options:\n" \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002149 "\t-l FILE\tLocal FILE.\n" \
2150 "\t-r FILE\tRemote FILE.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002151 USAGE_TFTP_GET( \
Matt Kraai3be34302001-09-21 14:42:30 +00002152 "\t-g\tGet file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002153 ) \
2154 USAGE_TFTP_PUT( \
Matt Kraai3be34302001-09-21 14:42:30 +00002155 "\t-p\tPut file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002156 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002157 USAGE_TFTP_BS( \
2158 "\t-b SIZE\tTransfer blocks of SIZE octets.\n" \
2159 )
Eric Andersenc3657422001-11-30 07:54:32 +00002160#define time_trivial_usage \
2161 "[OPTION]... COMMAND [ARGS...]"
2162#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00002163 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
2164 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00002165 "Options:\n" \
2166 "\t-v\tDisplays verbose resource usage information."
Mark Whitley450736c2001-03-02 19:08:50 +00002167
Eric Andersen420b2082002-09-17 22:14:58 +00002168#define top_trivial_usage \
2169 "[-d <seconds>]"
2170#define top_full_usage \
2171 "top provides an view of processor activity in real time.\n" \
2172 "This utility reads the status for all processes in /proc each <seconds>\n" \
2173 "and shows the status for however many processes will fit on the screen.\n" \
2174 "This utility will not show processes that are started after program startup,\n" \
2175 "but it will show the EXIT status for and PIDs that exit while it is running."
2176
Eric Andersen7e9276b2001-02-22 01:15:47 +00002177#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002178 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002179#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002180 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002181 "Options:\n" \
2182 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002183#define touch_example_usage \
2184 "$ ls -l /tmp/foo\n" \
2185 "/bin/ls: /tmp/foo: No such file or directory\n" \
2186 "$ touch /tmp/foo\n" \
2187 "$ ls -l /tmp/foo\n" \
2188 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002189
2190#define tr_trivial_usage \
2191 "[-cds] STRING1 [STRING2]"
2192#define tr_full_usage \
2193 "Translate, squeeze, and/or delete characters from\n" \
2194 "standard input, writing to standard output.\n\n" \
2195 "Options:\n" \
2196 "\t-c\ttake complement of STRING1\n" \
2197 "\t-d\tdelete input characters coded STRING1\n" \
2198 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002199#define tr_example_usage \
2200 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
2201 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002202
Eric Andersen5c58d282001-07-10 16:29:00 +00002203#define traceroute_trivial_usage \
2204 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n\
2205 [-s src_addr] [-t tos] [-w wait] host [data size]"
2206#define traceroute_full_usage \
2207 "trace the route ip packets follow going to \"host\"\n" \
2208 "Options:\n" \
2209 "\t-d\tset SO_DEBUG options to socket\n" \
2210 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
2211 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
2212 "\t-v\tVerbose output\n" \
2213 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
2214 "\t-p port#\tSet the base UDP port number used in probes\n" \
2215 "\t\t(default is 33434)\n" \
2216 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
2217 "\t\t(default is 3)\n" \
2218 "\t-s src_addr\tUse the following IP address as the source address\n" \
2219 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
2220 "\t\t(default 0)\n" \
2221 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
2222 "\t\t(default 3 sec.)."
2223
2224
Eric Andersen7e9276b2001-02-22 01:15:47 +00002225#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002226 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002227#define true_full_usage \
2228 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002229#define true_example_usage \
2230 "$ true\n" \
2231 "$ echo $?\n" \
2232 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002233
Eric Andersen7e9276b2001-02-22 01:15:47 +00002234#define tty_trivial_usage \
2235 ""
2236#define tty_full_usage \
2237 "Print the file name of the terminal connected to standard input.\n\n"\
2238 "Options:\n" \
2239 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002240#define tty_example_usage \
2241 "$ tty\n" \
2242 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002243
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002244#define udhcpc_trivial_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00002245 "[-fbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002246#define udhcpc_full_usage \
2247 "\t-c,\t--clientid=CLIENTID\tClient identifier\n" \
2248 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00002249 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002250 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00002251 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated.\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002252 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
2253 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated.\n" \
2254 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
2255 "\t-q,\t--quit\tQuit after obtaining lease\n" \
2256 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
2257 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
2258 "\t-v,\t--version\tDisplay version"
2259
Russ Dill61fb4892002-10-14 21:41:28 +00002260#define udhcpd_trivial_usage \
2261 "[configfile]\n" \
2262
2263#define udhcpd_full_usage \
Glenn L McGrath9130c852002-12-12 12:56:18 +00002264 ""
Russ Dill61fb4892002-10-14 21:41:28 +00002265
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002266#ifdef CONFIG_FEATURE_MOUNT_FORCE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002267 #define USAGE_MOUNT_FORCE(a) a
2268#else
2269 #define USAGE_MOUNT_FORCE(a)
2270#endif
2271#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002272 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002273#define umount_full_usage \
2274 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00002275 "\nFlags:\n" "\t-a\tUnmount all file systems" \
2276 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
2277 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00002278 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00002279 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 +00002280#define umount_example_usage \
2281 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002282
2283#define uname_trivial_usage \
2284 "[OPTION]..."
2285#define uname_full_usage \
2286 "Print certain system information. With no OPTION, same as -s.\n\n" \
2287 "Options:\n" \
2288 "\t-a\tprint all information\n" \
2289 "\t-m\tthe machine (hardware) type\n" \
2290 "\t-n\tprint the machine's network node hostname\n" \
2291 "\t-r\tprint the operating system release\n" \
2292 "\t-s\tprint the operating system name\n" \
2293 "\t-p\tprint the host processor type\n" \
2294 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002295#define uname_example_usage \
2296 "$ uname -a\n" \
2297 "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002298
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00002299#define uncompress_trivial_usage \
2300 "[-c] [-f] [ name ... ]"
2301#define uncompress_full_usage \
2302 "Uncompress .Z file[s]\n" \
2303 "Options:\n" \
2304 "\t-c\textract to stdout\n" \
2305 "\t-f\tforce overwrite an existing file\n"
2306
Eric Andersen7e9276b2001-02-22 01:15:47 +00002307#define uniq_trivial_usage \
2308 "[OPTION]... [INPUT [OUTPUT]]"
2309#define uniq_full_usage \
2310 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00002311 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002312 "Options:\n" \
2313 "\t-c\tprefix lines by the number of occurrences\n" \
2314 "\t-d\tonly print duplicate lines\n" \
2315 "\t-u\tonly print unique lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002316#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002317 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002318 "a\n" \
2319 "b\n" \
2320 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002321
2322#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002323 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002324#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002325 "Converts FILE from unix format to dos format. When no option\n" \
2326 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002327 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002328 "Options:\n" \
2329 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002330 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002331
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002332#define unzip_trivial_usage \
2333 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
2334#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002335 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002336 "Options:\n" \
2337 "\t-l\tlist archive contents (short form)\n" \
2338 "\t-n\tnever overwrite existing files (default)\n" \
2339 "\t-o\toverwrite files without prompting\n" \
2340 "\t-p\tsend output to stdout\n" \
2341 "\t-q\tbe quiet\n" \
2342 "\t-x\texclude these files\n" \
2343 "\t-d\textract files into this directory"
2344
Eric Andersen7e9276b2001-02-22 01:15:47 +00002345#define update_trivial_usage \
2346 "[options]"
2347#define update_full_usage \
2348 "Periodically flushes filesystem buffers.\n\n" \
2349 "Options:\n" \
2350 "\t-S\tforce use of sync(2) instead of flushing\n" \
2351 "\t-s SECS\tcall sync this often (default 30)\n" \
2352 "\t-f SECS\tflush some buffers this often (default 5)"
2353
2354#define uptime_trivial_usage \
2355 ""
2356#define uptime_full_usage \
2357 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002358#define uptime_example_usage \
2359 "$ uptime\n" \
2360 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002361
2362#define usleep_trivial_usage \
2363 "N"
2364#define usleep_full_usage \
2365 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002366#define usleep_example_usage \
2367 "$ usleep 1000000\n" \
2368 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002369
2370#define uudecode_trivial_usage \
2371 "[FILE]..."
2372#define uudecode_full_usage \
2373 "Uudecode a file that is uuencoded.\n\n" \
2374 "Options:\n" \
Eric Andersen704b2c22001-03-16 08:06:30 +00002375 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002376#define uudecode_example_usage \
2377 "$ uudecode -o busybox busybox.uu\n" \
2378 "$ ls -l busybox\n" \
2379 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002380
2381#define uuencode_trivial_usage \
2382 "[OPTION] [INFILE] REMOTEFILE"
2383#define uuencode_full_usage \
2384 "Uuencode a file.\n\n" \
2385 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00002386 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002387#define uuencode_example_usage \
2388 "$ uuencode busybox busybox\n" \
2389 "begin 755 busybox\n" \
2390 "<encoded file snipped>\n" \
2391 "$ uudecode busybox busybox > busybox.uu\n" \
2392 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002393
Eric Andersen853c4942003-01-23 05:59:32 +00002394#define vconfig_trivial_usage \
2395 "COMMAND [OPTIONS] ..."
2396
2397#define vconfig_full_usage \
2398"Usage: add [interface-name] [vlan_id] \n" \
2399" rem [vlan-name] \n" \
2400" set_flag [interface-name] [flag-num] [0 | 1] \n" \
2401" set_egress_map [vlan-name] [skb_priority] [vlan_qos] \n" \
2402" set_ingress_map [vlan-name] [skb_priority] [vlan_qos] \n" \
2403" set_name_type [name-type] \n"
2404
Eric Andersen3f980402001-04-04 17:31:15 +00002405#define vi_trivial_usage \
2406 "[OPTION] [FILE]..."
2407#define vi_full_usage \
2408 "edit FILE.\n\n" \
2409 "Options:\n" \
2410 "\t-R\tRead-only- do not write to the file."
2411
Eric Andersen27f64e12002-06-23 04:24:25 +00002412#define vlock_trivial_usage \
2413 "[OPTIONS]"
2414#define vlock_full_usage \
2415 "Lock a virtual terminal. A password is required to unlock\n" \
2416 "Options:\n" \
2417 "\t-a\tLock all VTs"
2418
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002419#define watch_trivial_usage \
2420 "[-n <seconds>] COMMAND..."
2421#define watch_full_usage \
2422 "Executes a program periodically.\n" \
2423 "Options:\n" \
2424 "\t-n\tLoop period in seconds - default is 2."
2425#define watch_example_usage \
2426 "$ watch date\n" \
2427 "Mon Dec 17 10:31:40 GMT 2000\n" \
2428 "Mon Dec 17 10:31:42 GMT 2000\n" \
2429 "Mon Dec 17 10:31:44 GMT 2000"
2430
Eric Andersen7e9276b2001-02-22 01:15:47 +00002431#define watchdog_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002432 "DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002433#define watchdog_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002434 "Periodically write to watchdog device DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002435
2436#define wc_trivial_usage \
2437 "[OPTION]... [FILE]..."
2438#define wc_full_usage \
2439 "Print line, word, and byte counts for each FILE, and a total line if\n" \
2440 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
2441 "Options:\n" \
2442 "\t-c\tprint the byte counts\n" \
2443 "\t-l\tprint the newline counts\n" \
2444 "\t-L\tprint the length of the longest line\n" \
2445 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002446#define wc_example_usage \
2447 "$ wc /etc/passwd\n" \
2448 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002449
2450#define wget_trivial_usage \
Robert Griebld7760112002-05-14 23:36:45 +00002451 "[-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 +00002452#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00002453 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002454 "Options:\n" \
2455 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00002456 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00002457 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00002458 "\t-O\tsave to filename ('-' for stdout)\n" \
2459 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002460
2461#define which_trivial_usage \
2462 "[COMMAND ...]"
2463#define which_full_usage \
2464 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002465#define which_example_usage \
2466 "$ which login\n" \
2467 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00002468
Eric Andersen00a6a752002-04-26 23:53:10 +00002469#define who_trivial_usage \
2470 " "
2471#define who_full_usage \
2472 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002473
2474#define whoami_trivial_usage \
2475 ""
2476#define whoami_full_usage \
2477 "Prints the user name associated with the current effective user id."
2478
2479#define xargs_trivial_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002480 "[COMMAND] [-prt] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002481#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002482 "Executes COMMAND on every item given by standard input.\n\n" \
2483 "Options:\n" \
2484 "\t-p\tPrompt the user about whether to run each command\n" \
2485 "\t-r\tDo not run command for empty readed lines\n" \
2486 "\t-t\tPrint the command line on stderr before executing it."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002487#define xargs_example_usage \
2488 "$ ls | xargs gzip\n" \
2489 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002490
2491#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002492 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002493#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002494 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002495
Eric Andersen7e9276b2001-02-22 01:15:47 +00002496#define zcat_trivial_usage \
2497 "FILE"
2498#define zcat_full_usage \
2499 "Uncompress to stdout."