blob: 462d09eee4e4a7289a238d3dab145647523730f2 [file] [log] [blame]
Eric Andersen178de172004-04-06 16:36:20 +00001#ifndef __BB_USAGE_H__
2#define __BB_USAGE_H__
3
Eric Andersenf349e972001-08-21 16:18:59 +00004#define addgroup_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00005 "[-g GID] group_name [user_name]"
Eric Andersenf349e972001-08-21 16:18:59 +00006#define addgroup_full_usage \
7 "Adds a group to the system" \
8 "Options:\n" \
Eric Andersen178de172004-04-06 16:36:20 +00009 "\t-g GID\t\tspecify gid"
Eric Andersenf349e972001-08-21 16:18:59 +000010
11#define adduser_trivial_usage \
Eric Andersene0716ba2003-01-14 06:42:56 +000012 "[OPTIONS] user_name"
Eric Andersenf349e972001-08-21 16:18:59 +000013#define adduser_full_usage \
14 "Adds a user to the system" \
15 "Options:\n" \
Eric Andersen178de172004-04-06 16:36:20 +000016 "\t-h DIR\t\tAssign home directory DIR\n" \
17 "\t-g GECOS\tAssign gecos field GECOS\n" \
18 "\t-s SHELL\tAssign login shell SHELL\n" \
19 "\t-G\t\tAdd the user to existing group GROUP\n" \
20 "\t-S\t\tcreate a system user (ignored)\n" \
21 "\t-D\t\tDo not assign a password (logins still possible via ssh)\n" \
22 "\t-H\t\tDo not create the home directory"
Eric Andersenf349e972001-08-21 16:18:59 +000023
Mark Whitley6f932772001-03-20 19:18:10 +000024#define adjtimex_trivial_usage \
25 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
26#define adjtimex_full_usage \
27 "Reads and optionally sets system timebase parameters.\n" \
28 "See adjtimex(2).\n\n" \
29 "Options:\n" \
30 "\t-q\t\tquiet mode - do not print\n" \
31 "\t-o offset\ttime offset, microseconds\n" \
32 "\t-f frequency\tfrequency adjust, integer kernel units (65536 is 1ppm)\n" \
33 "\t\t\t(positive values make the system clock run fast)\n" \
34 "\t-t tick\t\tmicroseconds per tick, usually 10000\n" \
Eric Andersen178de172004-04-06 16:36:20 +000035 "\t-p timeconstant"
Mark Whitley6f932772001-03-20 19:18:10 +000036
Eric Andersen7e9276b2001-02-22 01:15:47 +000037#define ar_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +000038 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Eric Andersen7e9276b2001-02-22 01:15:47 +000039#define ar_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +000040 "Extract or list FILES from an ar archive.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +000041 "Options:\n" \
42 "\t-o\t\tpreserve original dates\n" \
43 "\t-p\t\textract to stdout\n" \
44 "\t-t\t\tlist\n" \
45 "\t-x\t\textract\n" \
Eric Andersen178de172004-04-06 16:36:20 +000046 "\t-v\t\tverbosely list files processed"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000047
Glenn L McGrath9e598412003-01-09 10:06:01 +000048#define arping_trivial_usage \
49 "[-fqbDUA] [-c count] [-w timeout] [-I device] [-s sender] target\n"
50#define arping_full_usage \
51 "Ping hosts by ARP requests/replies.\n\n" \
52 "Options:\n" \
53 "\t-f\t\tQuit on first ARP reply\n" \
54 "\t-q\t\tBe quiet\n" \
55 "\t-b\t\tKeep broadcasting, don't go unicast\n" \
56 "\t-D\t\tDuplicated address detection mode\n" \
57 "\t-U\t\tUnsolicited ARP mode, update your neighbours\n" \
58 "\t-A\t\tARP answer mode, update your neighbours\n" \
59 "\t-c count\tStop after sending count ARP request packets\n" \
60 "\t-w timeout\tTime to wait for ARP reply, in seconds\n" \
61 "\t-I device\tOutgoing interface name, default is eth0\n" \
62 "\t-s sender\tSet specific sender IP address\n" \
Eric Andersen178de172004-04-06 16:36:20 +000063 "\ttarget\t\tTarget IP address of ARP request"
Glenn L McGrath9e598412003-01-09 10:06:01 +000064
Eric Andersen08f59e32004-03-12 22:07:10 +000065#define ash_trivial_usage \
66 "[FILE]...\n" \
67 "or: ash -c command [args]...\n"
68#define ash_full_usage \
69 "The ash shell (command interpreter)"
70
71#define awk_trivial_usage \
72 "[OPTION]... [program-text] [FILE ...]"
73#define awk_full_usage \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000074 "Options:\n" \
Eric Andersen08f59e32004-03-12 22:07:10 +000075 "\t-v var=val\t\tassign value 'val' to variable 'var'\n" \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000076 "\t-F sep\t\tuse 'sep' as field separator\n" \
Eric Andersen178de172004-04-06 16:36:20 +000077 "\t-f progname\t\tread program source from file 'progname'"
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000078
Eric Andersen7e9276b2001-02-22 01:15:47 +000079#define basename_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000080 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000081#define basename_full_usage \
82 "Strips directory path and suffixes from FILE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000083 "If specified, also removes any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000084#define basename_example_usage \
85 "$ basename /usr/local/bin/foo\n" \
86 "foo\n" \
87 "$ basename /usr/local/bin/\n" \
88 "bin\n" \
89 "$ basename /foo/bar.txt .txt\n" \
90 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000091
Glenn L McGrath24e28332001-10-05 03:48:57 +000092#define bunzip2_trivial_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000093 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +000094#define bunzip2_full_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000095 "Uncompress FILE (or standard input if FILE is '-' or omitted).\n\n" \
96 "Options:\n" \
97 "\t-c\tWrite output to standard output\n" \
98 "\t-f\tForce"
Glenn L McGrath24e28332001-10-05 03:48:57 +000099
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000100#define bzcat_trivial_usage \
101 "FILE"
102#define bzcat_full_usage \
103 "Uncompress to stdout."
104
Eric Andersenc98c0622001-12-06 15:16:43 +0000105#define cal_trivial_usage \
106 "[-jy] [[month] year]"
107#define cal_full_usage \
108 "Display a calendar.\n" \
109 "\nOptions:\n" \
110 "\t-j\tUse julian dates.\n" \
111 "\t-y\tDisplay the entire year."
112
Eric Andersen7e9276b2001-02-22 01:15:47 +0000113#define cat_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000114 "[-u] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000115#define cat_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000116 "Concatenates FILE(s) and prints them to stdout.\n\n" \
117 "Options:\n" \
118 "\t-u\tignored since unbuffered i/o is always used"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000119#define cat_example_usage \
120 "$ cat /proc/uptime\n" \
121 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000122
Eric Andersen7e9276b2001-02-22 01:15:47 +0000123#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000124 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000125#define chgrp_full_usage \
126 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000127 "\nOptions:\n" \
128 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000129#define chgrp_example_usage \
130 "$ ls -l /tmp/foo\n" \
131 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
132 "$ chgrp root /tmp/foo\n" \
133 "$ ls -l /tmp/foo\n" \
134 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000135
Eric Andersen7e9276b2001-02-22 01:15:47 +0000136#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000137 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000138#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000139 "Each MODE is one or more of the letters ugoa, one of the\n" \
140 "symbols +-= and one or more of the letters rwxst.\n\n" \
141 "Options:\n" \
142 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000143#define chmod_example_usage \
144 "$ ls -l /tmp/foo\n" \
145 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
146 "$ chmod u+x /tmp/foo\n" \
147 "$ ls -l /tmp/foo\n" \
148 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
149 "$ chmod 444 /tmp/foo\n" \
150 "$ ls -l /tmp/foo\n" \
151 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000152
Eric Andersen7e9276b2001-02-22 01:15:47 +0000153#define chown_trivial_usage \
Eric Andersen238da242001-05-11 16:31:46 +0000154 "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000155#define chown_full_usage \
156 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000157 "\nOptions:\n" \
Eric Andersen238da242001-05-11 16:31:46 +0000158 "\t-R\tChanges files and directories recursively.\n" \
159 "\t-h\tDo not dereference symbolic links."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000160#define chown_example_usage \
161 "$ ls -l /tmp/foo\n" \
162 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
163 "$ chown root /tmp/foo\n" \
164 "$ ls -l /tmp/foo\n" \
165 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
166 "$ chown root.root /tmp/foo\n" \
167 "ls -l /tmp/foo\n" \
168 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000169
Eric Andersen7e9276b2001-02-22 01:15:47 +0000170#define chroot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000171 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000172#define chroot_full_usage \
173 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000174#define chroot_example_usage \
175 "$ ls -l /bin/ls\n" \
176 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000177 "# mount /dev/hdc1 /mnt -t minix\n" \
178 "# chroot /mnt\n" \
179 "# ls -l /bin/ls\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000180 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000181
Eric Andersen7e9276b2001-02-22 01:15:47 +0000182#define chvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000183 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000184#define chvt_full_usage \
185 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000186
Eric Andersen7e9276b2001-02-22 01:15:47 +0000187#define clear_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000188 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000189#define clear_full_usage \
190 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000191
Eric Andersen7e9276b2001-02-22 01:15:47 +0000192#define cmp_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000193 "[-l] [-s] FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000194#define cmp_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000195 "Compare files. Compares FILE1 vs stdin if FILE2 is not specified.\n\n" \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000196 "Options:\n" \
197 "\t-l\tWrite the byte numbers (decimal) and values (octal)\n" \
198 "\t\t for all differing bytes.\n" \
199 "\t-s\tquiet mode - do not print"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000200
Eric Andersen7e9276b2001-02-22 01:15:47 +0000201#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000202 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000203#define cp_full_usage \
204 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
205 "\n" \
206 "\t-a\tSame as -dpR\n" \
207 "\t-d\tPreserves links\n" \
208 "\t-p\tPreserves file attributes if possible\n" \
209 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersenced97052004-02-20 09:55:37 +0000210 "\t-i\tinteractive, prompt before overwrite\n" \
211 "\t-R,-r\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000212
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000213#define cpio_trivial_usage \
214 "-[dimtuv][F cpiofile]"
215#define cpio_full_usage \
216 "Extract or list files from a cpio archive\n" \
217 "Main operation mode:\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000218 "\td\t\tmake leading directories\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000219 "\ti\t\textract\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000220 "\tm\t\tpreserve mtime\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000221 "\tt\t\tlist\n" \
Eric Andersen6925d502001-12-16 09:23:09 +0000222 "\tu\t\tunconditional overwrite\n" \
223 "\tF\t\tinput from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000224
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000225#define crond_trivial_usage \
226 "-d[#] -c <crondir> -f -b"
227#define crond_full_usage \
228 "\t-d [#] -l [#] -S -L logfile -f -b -c dir\n" \
229 "\t-d num\tdebug level\n" \
230 "\t-l num\tlog level (8 - default)\n" \
Glenn L McGrath2af30442003-09-12 10:58:54 +0000231 "\t-S\tlog to syslod (default)\n" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000232 "\t-L file\tlog to file\n" \
233 "\t-f\trun in fordeground\n" \
234 "\t-b\trun in background (default)\n" \
235 "\t-c dir\tworking dir"
236
237#define crontab_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000238 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000239#define crontab_full_usage \
240 "\tfile <opts> replace crontab from file\n" \
241 "\t- <opts> replace crontab from stdin\n" \
242 "\t-u user specify user\n" \
243 "\t-l [user] list crontab for user\n" \
244 "\t-e [user] edit crontab for user\n" \
245 "\t-d [user] delete crontab for user\n" \
246 "\t-c dir specify crontab directory"
247
248
Eric Andersen7e9276b2001-02-22 01:15:47 +0000249#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000250 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000251#define cut_full_usage \
252 "Prints selected fields from each input FILE to standard output.\n\n" \
253 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000254 "\t-b LIST\t\tOutput only bytes from LIST\n" \
255 "\t-c LIST\t\tOutput only characters from LIST\n" \
256 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
257 "\t-s\t\tOutput only the lines containing delimiter\n" \
258 "\t-f N\t\tPrint only these fields\n" \
259 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000260#define cut_example_usage \
261 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
262 "Hello\n" \
263 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
264 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000265
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000266#ifdef CONFIG_FEATURE_DATE_ISOFMT
267#define USAGE_DATE_ISOFMT(a) a
268#else
269#define USAGE_DATE_ISOFMT(a)
270#endif
271
Eric Andersen7e9276b2001-02-22 01:15:47 +0000272#define date_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +0000273 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000274#define date_full_usage \
275 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000276 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000277 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000278 "\t-d STRING\tDisplays time described by STRING, not `now'\n" \
279 USAGE_DATE_ISOFMT("\t-I[TIMESPEC]\tOutputs an ISO-8601 compliant date/time string.\n" \
280 "\t\t\tTIMESPEC=`date' (or missing) for date only,\n" \
281 "\t\t\t`hours', `minutes', or `seconds' for date and,\n" \
282 "\t\t\ttime to the indicated precision.\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000283 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000284 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000285#define date_example_usage \
286 "$ date\n" \
287 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000288
Eric Andersen7e9276b2001-02-22 01:15:47 +0000289#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000290 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000291#define dc_full_usage \
292 "This is a Tiny RPN calculator that understands the\n" \
Eric Andersena9287742003-10-22 11:24:39 +0000293 "following operations: +, add, -, sub, *, mul, /, div, %, mod, "\
294 "**, exp, and, or, not, eor.\n" \
295 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16.\n" \
296 "\nOptions:\n" \
Glenn L McGrath6d074322002-12-12 10:31:53 +0000297 "p - Prints the value on the top of the stack, without altering the stack.\n" \
298 "f - Prints the entire contents of the stack without altering anything.\n" \
299 "o - Pops the value off the top of the stack and uses it to set the output radix.\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000300 " Only 10 and 16 are supported."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000301#define dc_example_usage \
302 "$ dc 2 2 +\n" \
303 "4\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000304 "$ dc 8 8 * 2 2 + /\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000305 "16\n" \
306 "$ dc 0 1 and\n" \
307 "0\n" \
308 "$ dc 0 1 or\n" \
309 "1\n" \
310 "$ echo 72 9 div 8 mul | dc\n" \
311 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000312
Eric Andersen7e9276b2001-02-22 01:15:47 +0000313#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000314 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000315 "\t [seek=N] [conv=notrunc|noerror|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000316#define dd_full_usage \
317 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000318 "\tif=FILE\t\tread from FILE instead of stdin\n" \
319 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
320 "\tbs=N\t\tread and write N bytes at a time\n" \
321 "\tcount=N\t\tcopy only N input blocks\n" \
322 "\tskip=N\t\tskip N input blocks\n" \
323 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000324 "\tconv=notrunc\tdon't truncate output file\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000325 "\tconv=noerror\tcontinue after read errors\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000326 "\tconv=sync\tpad blocks with zeros\n" \
327 "\n" \
328 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000329 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000330#define dd_example_usage \
331 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
332 "4+0 records in\n" \
333 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000334
Eric Andersen7e9276b2001-02-22 01:15:47 +0000335#define deallocvt_trivial_usage \
Glenn L McGrath17b4a202004-01-15 11:50:19 +0000336 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000337#define deallocvt_full_usage \
338 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000339
Eric Andersenf349e972001-08-21 16:18:59 +0000340#define delgroup_trivial_usage \
341 "GROUP"
342#define delgroup_full_usage \
343 "Deletes group GROUP from the system"
344
345#define deluser_trivial_usage \
346 "USER"
347#define deluser_full_usage \
348 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000349
Eric Andersenf18bd892003-12-19 11:07:59 +0000350#ifdef CONFIG_DEVFSD_FG_NP
351 #define USAGE_DEVFSD_FG_NP(a) a
352#else
353 #define USAGE_DEVFSD_FG_NP(a)
354#endif
355
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000356#define devfsd_trivial_usage \
Eric Andersenf18bd892003-12-19 11:07:59 +0000357 "mntpnt [-v]"\
358 USAGE_DEVFSD_FG_NP("[-fg][-np]" )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000359#define devfsd_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000360 "Optional daemon for managing devfs permissions and old device name symlinks.\n" \
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000361 "\nOptions:\n" \
362 "\tmntpnt\tThe mount point where devfs is mounted.\n\n" \
363 "\t-v\tPrint the protocol version numbers for devfsd\n" \
Eric Andersenf18bd892003-12-19 11:07:59 +0000364 "\t\tand the kernel-side protocol version and exits." \
365 USAGE_DEVFSD_FG_NP( "\n\n\t-fg\tRun the daemon in the foreground.\n\n" \
366 "\t-np\tExit after parsing the configuration file\n" \
367 "\t\tand processing synthetic REGISTER events.\n" \
368 "\t\tDo not poll for events.")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000369
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000370#ifdef CONFIG_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000371 #define USAGE_HUMAN_READABLE(a) a
372 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000373#else
Tim Riker7b253f82003-12-28 05:02:40 +0000374 #define USAGE_HUMAN_READABLE(a)
Eric Andersened0d9582001-02-23 13:23:03 +0000375 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000376#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000377#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000378 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000379#define df_full_usage \
380 "Print the filesystem space used and space available.\n\n" \
381 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000382 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000383 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
384 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000385 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000386 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000387#define df_example_usage \
388 "$ df\n" \
389 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
390 "/dev/sda3 8690864 8553540 137324 98% /\n" \
391 "/dev/sda1 64216 36364 27852 57% /boot\n" \
392 "$ df /dev/sda3\n" \
393 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
394 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000395
Eric Andersen7e9276b2001-02-22 01:15:47 +0000396#define dirname_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000397 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000398#define dirname_full_usage \
399 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000400#define dirname_example_usage \
401 "$ dirname /tmp/foo\n" \
402 "/tmp\n" \
403 "$ dirname /tmp/foo/\n" \
404 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000405
Eric Andersen7e9276b2001-02-22 01:15:47 +0000406#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000407 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000408#define dmesg_full_usage \
409 "Prints or controls the kernel ring buffer\n\n" \
410 "Options:\n" \
411 "\t-c\t\tClears the ring buffer's contents after printing\n" \
412 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000413 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000414
Eric Andersen7e9276b2001-02-22 01:15:47 +0000415#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000416 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000417#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000418 "Converts FILE from dos format to unix format. When no option\n" \
419 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000420 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000421 "Options:\n" \
422 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000423 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000424
Eric Andersen7e9276b2001-02-22 01:15:47 +0000425#define dpkg_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000426 "[-iCPru] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000427#define dpkg_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000428 "dpkg is a utility to install, remove and manage Debian packages.\n\n" \
429 "Options:\n" \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000430 "\t-i\tInstall the package\n" \
431 "\t-C\tConfigure an unpackaged package\n" \
432 "\t-P\tPurge all files of a package\n" \
433 "\t-r\tRemove all but the configuration files for a package\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000434 "\t-u\tUnpack a package, but dont configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000435
Eric Andersen7e9276b2001-02-22 01:15:47 +0000436#define dpkg_deb_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000437 "[-cefItxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000438#define dpkg_deb_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000439 "Perform actions on Debian packages (.debs)\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000440 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000441 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000442 "\t-e\tExtract control files to [argument] directory\n" \
443 "\t-f\tDisplay control field name starting with [argument]\n" \
444 "\t-I\tDisplay the control filenamed [argument]\n" \
445 "\t-t\tExtract filesystem tree to stdout in tar format\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000446 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000447 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000448#define dpkg_deb_example_usage \
449 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000450
Manuel Novoa III cad53642003-03-19 09:13:01 +0000451#ifdef CONFIG_FEATURE_DU_DEFALT_BLOCKSIZE_1K
452#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a) a
453#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a)
454#else
455#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a)
456#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a) a
457#endif
458
Eric Andersen7e9276b2001-02-22 01:15:47 +0000459#define du_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000460 "[-aHLdclsx" USAGE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000461#define du_full_usage \
462 "Summarizes disk space used for each FILE and/or directory.\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000463 "Disk space is printed in units of " \
464 USAGE_DU_DEFALT_BLOCKSIZE_1k("1024") USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k("512") \
465 " bytes.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000466 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000467 "\t-a\tshow sizes of files in addition to directories\n" \
468 "\t-H\tfollow symbolic links that are FILE command line args\n" \
469 "\t-L\tfollow all symbolic links encountered\n" \
470 "\t-d N\tlimit output to directories (and files with -a) of depth < N\n" \
471 "\t-c\toutput a grand total\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000472 "\t-l\tcount sizes many times if hard linked\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000473 "\t-s\tdisplay only a total for each argument\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000474 "\t-x\tskip directories on different filesystems\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000475 USAGE_HUMAN_READABLE( \
476 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
477 "\t-m\tprint sizes in megabytes\n" ) \
478 "\t-k\tprint sizes in kilobytes" USAGE_DU_DEFALT_BLOCKSIZE_1k("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000479#define du_example_usage \
480 "$ du\n" \
481 "16 ./CVS\n" \
482 "12 ./kernel-patches/CVS\n" \
483 "80 ./kernel-patches\n" \
484 "12 ./tests/CVS\n" \
485 "36 ./tests\n" \
486 "12 ./scripts/CVS\n" \
487 "16 ./scripts\n" \
488 "12 ./docs/CVS\n" \
489 "104 ./docs\n" \
490 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000491
Eric Andersen7e9276b2001-02-22 01:15:47 +0000492#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000493 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000494#define dumpkmap_full_usage \
495 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000496#define dumpkmap_example_usage \
497 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000498
Russ Dill61fb4892002-10-14 21:41:28 +0000499#define dumpleases_trivial_usage \
500 "[-r|-a] [-f LEASEFILE]"
501#define dumpleases_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000502 "Displays the DHCP leases granted by udhcpd.\n\n" \
503 "Options:\n" \
Russ Dill61fb4892002-10-14 21:41:28 +0000504 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
505 "\t-r,\t--remaining\tInterepret lease times as time remaing\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000506 "\t-a,\t--absolute\tInterepret lease times as expire time"
Russ Dill61fb4892002-10-14 21:41:28 +0000507
Manuel Novoa III cad53642003-03-19 09:13:01 +0000508#ifdef CONFIG_FEATURE_FANCY_ECHO
509 #define USAGE_FANCY_ECHO(a) a
510#else
Tim Riker7b253f82003-12-28 05:02:40 +0000511 #define USAGE_FANCY_ECHO(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +0000512#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000513
Eric Andersen7e9276b2001-02-22 01:15:47 +0000514#define echo_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000515 USAGE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000516#define echo_full_usage \
517 "Prints the specified ARGs to stdout\n\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000518 USAGE_FANCY_ECHO("Options:\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000519 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000520 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000521 "\t-E\tdisable interpretation of backslash-escaped characters")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000522#define echo_example_usage \
523 "$ echo "Erik is cool"\n" \
524 "Erik is cool\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000525 USAGE_FANCY_ECHO("$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000526 "Erik\n" \
527 "is\n" \
528 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000529 "$ echo "Erik\\nis\\ncool"\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000530 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000531
Eric Andersen84e229c2001-03-29 22:48:33 +0000532#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000533 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000534#define env_full_usage \
535 "Prints the current environment or runs a program after setting\n" \
536 "up the specified environment.\n\n" \
537 "Options:\n" \
538 "\t-, -i\tstart with an empty environment\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000539 "\t-u\tremove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000540
Eric Andersen7e9276b2001-02-22 01:15:47 +0000541#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000542 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000543#define expr_full_usage \
544 "Prints the value of EXPRESSION to standard output.\n\n" \
545 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000546 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
547 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
548 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
549 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
550 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
551 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
552 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
553 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
554 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
555 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
556 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
557 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
558 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000559 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
560 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
561 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
562 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
563 "\t or 0\n" \
564 "\tlength STRING length of STRING\n" \
565 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
566 "\t it is a keyword like `match' or an\n" \
567 "\t operator like `/'\n" \
568 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000569 "Beware that many operators need to be escaped or quoted for shells.\n" \
570 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
571 "lexicographical. Pattern matches return the string matched between \n" \
572 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
573 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000574
Eric Andersen7e9276b2001-02-22 01:15:47 +0000575#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000576 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000577#define false_full_usage \
578 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000579#define false_example_usage \
580 "$ false\n" \
581 "$ echo $?\n" \
582 "1\n"
583
584#define fbset_trivial_usage \
585 "[options] [mode]"
586#define fbset_full_usage \
587 "Show and modify frame buffer settings"
588#define fbset_example_usage \
589 "$ fbset\n" \
590 "mode "1024x768-76"\n" \
591 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
592 "\tgeometry 1024 768 1024 768 16\n" \
593 "\ttimings 12714 128 32 16 4 128 4\n" \
594 "\taccel false\n" \
595 "\trgba 5/11,6/5,5/0,0/0\n" \
596 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000597
Eric Andersen7e9276b2001-02-22 01:15:47 +0000598#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000599 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000600#define fdflush_full_usage \
601 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000602
Eric Andersen01c3d402003-07-05 07:51:31 +0000603#define fdformat_trivial_usage \
604 "[-n] DEVICE"
605#define fdformat_full_usage \
606 "Low-level formats a floppy disk\n\n" \
607 "Options:\n" \
608 "\t-n\tDon't verify after format"
609
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000610#define fdisk_trivial_usage \
611 "[-l] [-v] [-b SSZ] [-u] DISK"
612#define fdisk_full_usage \
613 "Change partition table\n" \
614 "Options:\n" \
Eric Andersena151d192004-04-06 17:16:36 +0000615 "\t-l List partition table(s)\n" \
616 "\t-u Give Start and End in sector (instead of cylinder) units\n" \
617 "\t-s PARTITION Give partition size(s) in blocks\n" \
618 "\t-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
619 "\t-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000620
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000621#ifdef CONFIG_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000622 #define USAGE_FIND_TYPE(a) a
623#else
624 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000625#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000626#ifdef CONFIG_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000627 #define USAGE_FIND_PERM(a) a
628#else
629 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000630#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000631#ifdef CONFIG_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000632 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000633#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000634 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000635#endif
Eric Andersen97d86f22003-01-23 05:27:42 +0000636#ifdef CONFIG_FEATURE_FIND_NEWER
637 #define USAGE_FIND_NEWER(a) a
638#else
639 #define USAGE_FIND_NEWER(a)
640#endif
641#ifdef CONFIG_FEATURE_FIND_INUM
642 #define USAGE_FIND_INUM(a) a
643#else
644 #define USAGE_FIND_INUM(a)
645#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000646
Eric Andersen7e9276b2001-02-22 01:15:47 +0000647#define find_trivial_usage \
648 "[PATH...] [EXPRESSION]"
649#define find_full_usage \
650 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000651 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000652 "\nEXPRESSION may consist of:\n" \
653 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000654 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000655 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000656 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000657 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
658) USAGE_FIND_PERM( \
659 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
660) USAGE_FIND_MTIME( \
Eric Andersen97d86f22003-01-23 05:27:42 +0000661 "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \
662) USAGE_FIND_NEWER( \
663 "\n\t-newer FILE\tModified time is more recent than FILE's" \
664) USAGE_FIND_INUM( \
665 "\n\t-inum N\t\tFile has inode number N")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000666#define find_example_usage \
Eric Andersen75eb90f2004-03-29 08:20:08 +0000667 "$ find / -name passwd\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000668 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000669
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000670#define fold_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +0000671 "[-bsw] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000672#define fold_full_usage \
673 "Wrap input lines in each FILE (standard input by default), writing to\n" \
674 "standard output.\n\n" \
675 "Options:\n" \
676 "\t-b\tcount bytes rather than columns\n" \
677 "\t-s\tbreak at spaces\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000678 "\t-w\tuse WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000679
Eric Andersen7e9276b2001-02-22 01:15:47 +0000680#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000681 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000682#define free_full_usage \
683 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000684#define free_example_usage \
685 "$ free\n" \
686 " total used free shared buffers\n" \
687 " Mem: 257628 248724 8904 59644 93124\n" \
688 " Swap: 128516 8404 120112\n" \
689 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000690
Eric Andersen7e9276b2001-02-22 01:15:47 +0000691#define freeramdisk_trivial_usage \
692 "DEVICE"
693#define freeramdisk_full_usage \
694 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000695#define freeramdisk_example_usage \
696 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000697
698#define fsck_minix_trivial_usage \
699 "[-larvsmf] /dev/name"
700#define fsck_minix_full_usage \
701 "Performs a consistency check for MINIX filesystems.\n\n" \
702 "Options:\n" \
703 "\t-l\tLists all filenames\n" \
704 "\t-r\tPerform interactive repairs\n" \
705 "\t-a\tPerform automatic repairs\n" \
706 "\t-v\tverbose\n" \
707 "\t-s\tOutputs super-block information\n" \
708 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
709 "\t-f\tForce file system check."
710
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000711#define ftpget_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000712 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000713#define ftpget_full_usage \
714 "Retrieve a remote file via FTP.\n\n" \
715 "Options:\n" \
716 "\t-c, --continue Continue a previous transfer\n" \
717 "\t-v, --verbose Verbose\n" \
718 "\t-u, --username Username to be used\n" \
719 "\t-p, --password Password to be used\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000720 "\t-P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000721
722#define ftpput_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000723 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000724#define ftpput_full_usage \
725 "Store a local file on a remote machine via FTP.\n\n" \
726 "Options:\n" \
727 "\t-v, --verbose Verbose\n" \
728 "\t-u, --username Username to be used\n" \
729 "\t-p, --password Password to be used\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000730 "\t-P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000731
Eric Andersen7e9276b2001-02-22 01:15:47 +0000732#define getopt_trivial_usage \
733 "[OPTIONS]..."
734#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000735 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000736 "\t-a, --alternative Allow long options starting with single -\n" \
737 "\t-l, --longoptions=longopts Long options to be recognized\n" \
738 "\t-n, --name=progname The name under which errors are reported\n" \
739 "\t-o, --options=optstring Short options to be recognized\n" \
740 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
741 "\t-Q, --quiet-output No normal output\n" \
742 "\t-s, --shell=shell Set shell quoting conventions\n" \
743 "\t-T, --test Test for getopt(1) version\n" \
744 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000745#define getopt_example_usage \
746 "$ cat getopt.test\n" \
747 "#!/bin/sh\n" \
748 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
749 " -n 'example.busybox' -- "$@"`\n" \
750 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
751 "eval set -- "$GETOPT"\n" \
752 "while true ; do\n" \
753 " case $1 in\n" \
754 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000755 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000756 " -c|--c-long)\n" \
757 " case "$2" in\n" \
758 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000759 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000760 " esac ;;\n" \
761 " --) shift ; break ;;\n" \
762 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
763 " esac\n" \
764 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000765
Eric Andersenf349e972001-08-21 16:18:59 +0000766#define getty_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000767 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +0000768#define getty_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +0000769 "Opens a tty, prompts for a login name, then invokes /bin/login\n\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000770 "Options:\n" \
771 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
772 "\t-i\t\tDo not display /etc/issue before running login.\n" \
773 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
774 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
775 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
Glenn L McGrath49e74ef2003-05-13 14:59:07 +0000776 "\t-n\t\tDo not prompt the user for a login name.\n" \
777 "\t-f issue_file\tDisplay issue_file instead of /etc/issue.\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000778 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
779 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
780 "\t-I initstring\tSets the init string to send before anything else.\n" \
781 "\t-H login_host\tLog login_host into the utmp file as the hostname."
782
783
Eric Andersen7e9276b2001-02-22 01:15:47 +0000784#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000785 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000786#define grep_full_usage \
787 "Search for PATTERN in each FILE or standard input.\n\n" \
788 "Options:\n" \
789 "\t-H\tprefix output lines with filename where match was found\n" \
790 "\t-h\tsuppress the prefixing filename on output\n" \
791 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000792 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000793 "\t-n\tprint line number with output lines\n" \
794 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
795 "\t-v\tselect non-matching lines\n" \
796 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000797#define grep_example_usage \
798 "$ grep root /etc/passwd\n" \
799 "root:x:0:0:root:/root:/bin/bash\n" \
800 "$ grep ^[rR]oo. /etc/passwd\n" \
801 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000802
Eric Andersen7e9276b2001-02-22 01:15:47 +0000803#define gunzip_trivial_usage \
804 "[OPTION]... FILE"
805#define gunzip_full_usage \
806 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
807 "Options:\n" \
808 "\t-c\tWrite output to standard output\n" \
809 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000810#define gunzip_example_usage \
811 "$ ls -la /tmp/BusyBox*\n" \
812 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
813 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
814 "$ ls -la /tmp/BusyBox*\n" \
815 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000816
817#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000818 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000819#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000820 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000821 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000822 "Options:\n" \
823 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
824 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000825#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000826 "$ ls -la /tmp/busybox*\n" \
827 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
828 "$ gzip /tmp/busybox.tar\n" \
829 "$ ls -la /tmp/busybox*\n" \
830 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000831
832#define halt_trivial_usage \
833 ""
834#define halt_full_usage \
835 "Halt the system."
836
Eric Andersen3443bd72003-07-22 07:30:36 +0000837#ifdef CONFIG_FEATURE_HDPARM_GET_IDENTITY
838#define USAGE_HDPARM_IDENT(a) a
839#else
840#define USAGE_HDPARM_IDENT(a)
841#endif
842
843#ifdef CONFIG_FEATURE_HDPARM_HDIO_SCAN_HWIF
844#define USAGE_SCAN_HWIF(a) a
845#else
846#define USAGE_SCAN_HWIF(a)
847#endif
848
849#ifdef CONFIG_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF
850#define USAGE_UNREGISTER_HWIF(a) a
851#else
852#define USAGE_UNREGISTER_HWIF(a)
853#endif
854
855#ifdef CONFIG_FEATURE_HDPARM_HDIO_DRIVE_RESET
856#define USAGE_DRIVE_RESET(a) a
857#else
858#define USAGE_DRIVE_RESET(a)
859#endif
860
861#ifdef CONFIG_FEATURE_HDPARM_HDIO_TRISTATE_HWIF
862#define USAGE_TRISTATE_HWIF(a) a
863#else
864#define USAGE_TRISTATE_HWIF(a)
865#endif
866
Eric Andersen0a57a792003-08-06 08:57:35 +0000867#ifdef CONFIG_FEATURE_HDPARM_HDIO_GETSET_DMA
868#define USAGE_GETSET_DMA(a) a
869#else
870#define USAGE_GETSET_DMA(a)
871#endif
872
Eric Andersen3443bd72003-07-22 07:30:36 +0000873#define hdparm_trivial_usage \
874 "[options] [device] .."
875#define hdparm_full_usage \
876 "Options:" \
Eric Andersen15c03c32004-04-06 17:52:02 +0000877 "\t-a get/set fs readahead\n" \
878 "\t-A set drive read-lookahead flag (0/1)\n" \
879 "\t-b get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
880 "\t-B set Advanced Power Management setting (1-255)\n" \
881 "\t-c get/set IDE 32-bit IO setting\n" \
882 "\t-C check IDE power mode status\n" \
883 USAGE_GETSET_DMA("\t-d get/set using_dma flag\n") \
884 "\t-D enable/disable drive defect-mgmt\n" \
885 "\t-f flush buffer cache for device on exit\n" \
886 "\t-g display drive geometry\n" \
887 "\t-h display terse usage information\n" \
888 "\t-i display drive identification\n" \
889 USAGE_HDPARM_IDENT("\t-I detailed/current information directly from drive\n") \
890 USAGE_HDPARM_IDENT("\t-Istdin similar to -I, but wants /proc/ide/" "*" "/hd?/identify as input\n") \
891 "\t-k get/set keep_settings_over_reset flag (0/1)\n" \
892 "\t-K set drive keep_features_over_reset flag (0/1)\n" \
893 "\t-L set drive doorlock (0/1) (removable harddisks only)\n" \
894 "\t-m get/set multiple sector count\n" \
895 "\t-n get/set ignore-write-errors flag (0/1)\n" \
896 "\t-p set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
897 "\t-P set drive prefetch count\n" \
898 "\t-q change next setting quietly\n" \
899 "\t-Q get/set DMA tagged-queuing depth (if supported)\n" \
900 "\t-r get/set readonly flag (DANGEROUS to set)\n" \
901 USAGE_SCAN_HWIF("\t-R register an IDE interface (DANGEROUS)\n") \
902 "\t-S set standby (spindown) timeout\n" \
903 "\t-t perform device read timings\n" \
904 "\t-T perform cache read timings\n" \
905 "\t-u get/set unmaskirq flag (0/1)\n" \
906 USAGE_UNREGISTER_HWIF("\t-U un-register an IDE interface (DANGEROUS)\n") \
907 "\t-v defaults; same as -mcudkrag for IDE drives\n" \
908 "\t-V display program version and exit immediately\n" \
909 USAGE_DRIVE_RESET("\t-w perform device reset (DANGEROUS)\n") \
910 "\t-W set drive write-caching flag (0/1) (DANGEROUS)\n" \
911 USAGE_TRISTATE_HWIF("\t-x tristate device for hotswap (0/1) (DANGEROUS)\n") \
912 "\t-X set IDE xfer mode (DANGEROUS)\n" \
913 "\t-y put IDE drive in standby mode\n" \
914 "\t-Y put IDE drive to sleep\n" \
915 "\t-Z disable Seagate auto-powersaving mode\n" \
916 "\t-z re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +0000917
Manuel Novoa III cad53642003-03-19 09:13:01 +0000918#ifdef CONFIG_FEATURE_FANCY_HEAD
919#define USAGE_FANCY_HEAD(a) a
920#else
921#define USAGE_FANCY_HEAD(a)
922#endif
923
Eric Andersen7e9276b2001-02-22 01:15:47 +0000924#define head_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000925 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000926#define head_full_usage \
927 "Print first 10 lines of each FILE to standard output.\n" \
928 "With more than one FILE, precede each with a header giving the\n" \
929 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000930 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000931 "\t-n NUM\t\tPrint first NUM lines instead of first 10" \
932 USAGE_FANCY_HEAD( \
933 "\n\t-c NUM\t\toutput the first NUM bytes\n" \
934 "\t-q\t\tnever output headers giving file names\n" \
935 "\t-v\t\talways output headers giving file names" )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000936#define head_example_usage \
937 "$ head -n 2 /etc/passwd\n" \
938 "root:x:0:0:root:/root:/bin/bash\n" \
939 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000940
Glenn L McGrath60281112001-11-02 11:39:46 +0000941#define hexdump_trivial_usage \
942 "[-[bcdefnosvx]] [OPTION] FILE"
943#define hexdump_full_usage \
944 "The hexdump utility is a filter which displays the specified files,\n" \
945 "or the standard input, if no files are specified, in a user specified\n"\
946 "format\n" \
947 "\t-b\t\tOne-byte octal display\n" \
948 "\t-c\t\tOne-byte character display\n" \
949 "\t-d\t\tTwo-byte decimal display\n" \
950 "\t-e FORMAT STRING\n" \
951 "\t-f FORMAT FILE\n" \
952 "\t-n LENGTH\tInterpret only length bytes of input\n" \
953 "\t-o\t\tTwo-byte octal display\n" \
954 "\t-s OFFSET\tSkip offset byte\n" \
955 "\t-v\t\tdisplay all input data\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000956 "\t-x\t\tTwo-byte hexadecimal display"
Glenn L McGrath60281112001-11-02 11:39:46 +0000957
Eric Andersen7e9276b2001-02-22 01:15:47 +0000958#define hostid_trivial_usage \
959 ""
960#define hostid_full_usage \
961 "Print out a unique 32-bit identifier for the machine."
962
963#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000964 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000965#define hostname_full_usage \
966 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000967 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000968 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +0000969 "\t-s\tShort\n" \
970 "\t-i\tAddresses for the hostname\n" \
971 "\t-d\tDNS domain name\n" \
972 "\t-f\tFully qualified domain name\n" \
973 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000974#define hostname_example_usage \
975 "$ hostname\n" \
Eric Andersen08f59e32004-03-12 22:07:10 +0000976 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +0000977
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000978#ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH
979 #define USAGE_HTTPD_BASIC_AUTH(a) a
Eric Andersen40520512003-07-28 09:59:05 +0000980 #ifdef CONFIG_FEATURE_HTTPD_AUTH_MD5
981 #define USAGE_HTTPD_AUTH_MD5(a) a
982 #else
983 #define USAGE_HTTPD_AUTH_MD5(a)
984 #endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000985#else
986 #define USAGE_HTTPD_BASIC_AUTH(a)
Eric Andersen40520512003-07-28 09:59:05 +0000987 #define USAGE_HTTPD_AUTH_MD5(a)
988#endif
989#ifdef CONFIG_FEATURE_HTTPD_USAGE_FROM_INETD_ONLY
990 #define USAGE_HTTPD_STANDALONE(a)
991 #define USAGE_HTTPD_SETUID(a)
992#else
993 #define USAGE_HTTPD_STANDALONE(a) a
994 #ifdef CONFIG_FEATURE_HTTPD_SETUID
995 #define USAGE_HTTPD_SETUID(a) a
996 #else
997 #define USAGE_HTTPD_SETUID(a)
998 #endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000999#endif
1000#define httpd_trivial_usage \
Eric Andersen40520512003-07-28 09:59:05 +00001001 "[-c <conf file>]" \
1002 USAGE_HTTPD_STANDALONE(" [-p <port>]") \
1003 USAGE_HTTPD_SETUID(" [-u user]") \
1004 USAGE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
1005 USAGE_HTTPD_AUTH_MD5(" [-m pass]") \
1006 " [-d/-e <string>]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001007#define httpd_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001008 "Listens for incoming http server requests.\n\n"\
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001009 "Options:\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001010 "\t-c FILE\t\tSpecifies configuration file. (default httpd.conf)\n" \
Eric Andersen40520512003-07-28 09:59:05 +00001011 USAGE_HTTPD_STANDALONE("\t-p PORT\tServer port (default 80)\n") \
1012 USAGE_HTTPD_SETUID("\t-u USER\tSet uid to USER after listening privilegies port\n") \
1013 USAGE_HTTPD_BASIC_AUTH("\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
Eric Andersena151d192004-04-06 17:16:36 +00001014 USAGE_HTTPD_AUTH_MD5("\t-m PASS\t\tCrypt PASS with md5 algorithm\n") \
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001015 "\t-e STRING\tHtml encode STRING\n" \
Eric Andersen40520512003-07-28 09:59:05 +00001016 "\t-d STRING\tURL decode STRING"
1017
Robert Griebl1cd04452002-07-21 16:50:49 +00001018#define hwclock_trivial_usage \
1019 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
1020#define hwclock_full_usage \
1021 "Query and set the hardware clock (RTC)\n\n" \
1022 "Options:\n" \
1023 "\t-r\tread hardware clock and print result\n" \
1024 "\t-s\tset the system time from the hardware clock\n" \
1025 "\t-w\tset the hardware clock to the current system time\n" \
1026 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
1027 "\t-l\tthe hardware clock is kept in local time"
1028
Eric Andersen9e480452003-07-03 10:07:04 +00001029#ifdef CONFIG_SELINUX
Eric Andersen15c03c32004-04-06 17:52:02 +00001030 #define USAGE_SELINUX(a) a
Eric Andersen9e480452003-07-03 10:07:04 +00001031#else
Eric Andersen15c03c32004-04-06 17:52:02 +00001032 #define USAGE_SELINUX(a)
Eric Andersen9e480452003-07-03 10:07:04 +00001033#endif
1034
Eric Andersen7e9276b2001-02-22 01:15:47 +00001035#define id_trivial_usage \
1036 "[OPTIONS]... [USERNAME]"
1037#define id_full_usage \
1038 "Print information for USERNAME or the current user\n\n" \
1039 "Options:\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001040 USAGE_SELINUX("\t-c\tprints only the security context\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001041 "\t-g\tprints only the group ID\n" \
1042 "\t-u\tprints only the user ID\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001043 "\t-n\tprint a name instead of a number\n" \
1044 "\t-r\tprints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001045#define id_example_usage \
1046 "$ id\n" \
1047 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001048
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001049#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001050 #define USAGE_SIOCSKEEPALIVE(a) a
1051#else
1052 #define USAGE_SIOCSKEEPALIVE(a)
1053#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001054#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001055 #define USAGE_IFCONFIG_MII(a) a
1056#else
1057 #define USAGE_IFCONFIG_MII(a)
1058#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001059#ifdef CONFIG_FEATURE_IFCONFIG_HW
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001060 #define USAGE_IFCONFIG_HW(a) a
1061#else
1062 #define USAGE_IFCONFIG_HW(a)
1063#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001064#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001065 #define USAGE_IFCONFIG_OPT_A(a) a
1066#else
1067 #define USAGE_IFCONFIG_OPT_A(a)
1068#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +00001069#ifdef CONFIG_FEATURE_IPV6
1070 #define USAGE_IPV6(a) a
1071#else
1072 #define USAGE_IPV6(a)
1073#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001074
Eric Andersen7e9276b2001-02-22 01:15:47 +00001075#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001076 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001077#define ifconfig_full_usage \
1078 "configure a network interface\n\n" \
1079 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +00001080 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
1081 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001082 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001083 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001084 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001085 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
1086 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001087 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001088 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
1089 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001090 "\t[up|down] ..."
1091
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001092#define ifup_trivial_usage \
1093 "<-ahinv> <ifaces...>"
1094#define ifup_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001095 "ifup <options> <ifaces...>\n\n" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001096 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001097 "\t-h\tthis help\n" \
1098 "\t-a\tde/configure all interfaces automatically\n" \
1099 "\t-i FILE\tuse FILE for interface definitions\n" \
1100 "\t-n\tprint out what would happen, but don't do it\n" \
1101 "\t\t\t(note that this option doesn't disable mappings)\n" \
1102 "\t-v\tprint out what would happen before doing it\n" \
1103 "\t-m\tdon't run any mappings\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001104 "\t-f\tforce de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001105
1106#define ifdown_trivial_usage \
1107 "<-ahinv> <ifaces...>"
1108#define ifdown_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001109 "ifdown <options> <ifaces...>\n\n" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001110 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001111 "\t-h\tthis help\n" \
1112 "\t-a\tde/configure all interfaces automatically\n" \
1113 "\t-i FILE\tuse FILE for interface definitions\n" \
1114 "\t-n\tprint out what would happen, but don't do it\n" \
1115 "\t\t(note that this option doesn't disable mappings)\n" \
1116 "\t-v\tprint out what would happen before doing it\n" \
1117 "\t-m\tdon't run any mappings\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001118 "\t-f\tforce de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001119
Glenn L McGrath06e95652003-02-09 06:51:14 +00001120#define inetd_trivial_usage \
1121 "[-q len] [conf]"
1122#define inetd_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001123 "Listens for network connections and launches programs\n\n" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001124 "Option:\n" \
1125 "\t-q\tSets the size of the socket listen queue to\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001126 "\t\tthe specified value. Default is 128."
Glenn L McGrath06e95652003-02-09 06:51:14 +00001127
Eric Andersen7e9276b2001-02-22 01:15:47 +00001128#define init_trivial_usage \
1129 ""
1130#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001131 "Init is the parent of all processes."
1132#define init_notes_usage \
1133"This version of init is designed to be run only by the kernel.\n" \
1134"\n" \
1135"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
1136"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
1137"runlevels, use sysvinit.\n" \
1138"\n" \
1139"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
1140"it has the following default behavior:\n" \
1141"\n" \
1142" ::sysinit:/etc/init.d/rcS\n" \
1143" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001144" ::ctrlaltdel:/sbin/reboot\n" \
1145" ::shutdown:/sbin/swapoff -a\n" \
1146" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001147" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001148"\n" \
1149"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1150"\n" \
1151" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001152" tty3::askfirst:/bin/sh\n" \
1153" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001154"\n" \
1155"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1156"\n" \
1157" <id>:<runlevels>:<action>:<process>\n" \
1158"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001159" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001160"\n" \
1161" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1162" The id field is used by BusyBox init to specify the controlling tty for\n" \
1163" the specified process to run on. The contents of this field are\n" \
1164" appended to "/dev/" and used as-is. There is no need for this field to\n" \
1165" be unique, although if it isn't you may have strange results. If this\n" \
1166" field is left blank, the controlling tty is set to the console. Also\n" \
1167" note that if BusyBox detects that a serial console is in use, then only\n" \
1168" entries whose controlling tty is either the serial console or /dev/null\n" \
1169" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1170" stinkin' utmp.\n" \
1171"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001172" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001173"\n" \
1174" The runlevels field is completely ignored.\n" \
1175"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001176" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001177"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001178" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001179" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001180"\n" \
1181" The available actions can be classified into two groups: actions\n" \
1182" that are run only once, and actions that are re-run when the specified\n" \
1183" process exits.\n" \
1184"\n" \
1185" Run only-once actions:\n" \
1186"\n" \
1187" 'sysinit' is the first item run on boot. init waits until all\n" \
1188" sysinit actions are completed before continuing. Following the\n" \
1189" completion of all sysinit actions, all 'wait' actions are run.\n" \
1190" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001191" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001192" therefore, init does not wait for them to complete. 'restart' is\n" \
1193" the action taken to restart the init process. By default this should\n" \
1194" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1195" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001196" actions are run when the system detects that someone on the system\n" \
1197" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1198" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1199" Finally the 'shutdown' action specifies the actions to taken when\n" \
1200" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1201" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001202"\n" \
1203" Run repeatedly actions:\n" \
1204"\n" \
1205" 'respawn' actions are run after the 'once' actions. When a process\n" \
1206" started with a 'respawn' action exits, init automatically restarts\n" \
1207" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1208" respawning out of control. The 'askfirst' actions acts just like\n" \
1209" respawn, except that before running the specified process it\n" \
1210" displays the line "Please press Enter to activate this console."\n" \
1211" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001212" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001213"\n" \
1214" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1215" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001216" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001217"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001218" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001219"\n" \
1220" Specifies the process to be executed and it's command line.\n" \
1221"\n" \
1222"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001223"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001224" # This is run first except when booting in single-user mode.\n" \
1225" #\n" \
1226" ::sysinit:/etc/init.d/rcS\n" \
1227" \n" \
1228" # /bin/sh invocations on selected ttys\n" \
1229" #\n" \
1230" # Start an "askfirst" shell on the console (whatever that may be)\n" \
1231" ::askfirst:-/bin/sh\n" \
1232" # Start an "askfirst" shell on /dev/tty2-4\n" \
1233" tty2::askfirst:-/bin/sh\n" \
1234" tty3::askfirst:-/bin/sh\n" \
1235" tty4::askfirst:-/bin/sh\n" \
1236" \n" \
1237" # /sbin/getty invocations for selected ttys\n" \
1238" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001239" tty4::respawn:/sbin/getty 38400 tty4\n" \
1240" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001241" \n" \
1242" \n" \
1243" # Example of how to put a getty on a serial line (for a terminal)\n" \
1244" #\n" \
1245" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1246" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1247" #\n" \
1248" # Example how to put a getty on a modem line.\n" \
1249" #::respawn:/sbin/getty 57600 ttyS2\n" \
1250" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001251" # Stuff to do when restarting the init process\n" \
1252" ::restart:/sbin/init\n" \
1253" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001254" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001255" ::ctrlaltdel:/sbin/reboot\n" \
1256" ::shutdown:/bin/umount -a -r\n" \
1257" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001258
Eric Andersenbe65c352003-01-23 04:57:35 +00001259#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
1260 #define USAGE_INSMOD_MAP(a) a
1261#else
1262 #define USAGE_INSMOD_MAP(a)
1263#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001264#define insmod_trivial_usage \
1265 "[OPTION]... MODULE [symbol=value]..."
1266#define insmod_full_usage \
1267 "Loads the specified kernel modules into the kernel.\n\n" \
1268 "Options:\n" \
1269 "\t-f\tForce module to load into the wrong kernel version.\n" \
1270 "\t-k\tMake module autoclean-able.\n" \
1271 "\t-v\tverbose output\n" \
1272 "\t-L\tLock to prevent simultaneous loads of a module\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001273 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout\n") \
Eric Andersen957879a2004-04-07 15:07:55 +00001274 "\t-o NAME\tSet internal module name to NAME\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001275 "\t-x\tdo not export externs"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001276
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001277#define install_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001278 "[-cgmops] [sources] <dest|directory>"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001279#define install_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001280 "Copies files and set attributes\n\n" \
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001281 "Options:\n" \
1282 "\t-c\tcopy the file, default\n" \
1283 "\t-g\tset group ownership\n" \
1284 "\t-m\tset permission modes\n" \
1285 "\t-o\tset ownership\n" \
1286 "\t-p\tpreserve date\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001287 "\t-s\tstrip symbol tables"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001288
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001289#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001290 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001291#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001292 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1293 "where OBJECT := { link | addr | route | tunnel }\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001294 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001295
1296#define ipaddr_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001297 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
1298 "\t\t[ dev STRING ] [ to PREFIX ] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001299#define ipaddr_full_usage \
1300 "ipaddr {add|del} IFADDR dev STRING\n" \
1301 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001302 "\t\t\t[ to PREFIX ] [ label PATTERN ]\n" \
1303 "\t\t\tIFADDR := PREFIX | ADDR peer PREFIX\n" \
1304 "\t\t\t[ broadcast ADDR ] [ anycast ADDR ]\n" \
1305 "\t\t\t[ label STRING ] [ scope SCOPE-ID ]\n" \
1306 "\t\t\tSCOPE-ID := [ host | link | global | NUMBER ]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001307
Eric Andersen3561b012004-04-13 19:27:20 +00001308#ifdef CONFIG_FEATURE_IPCALC_FANCY
1309 #define XUSAGE_IPCALC_FANCY(a) a
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001310#else
Eric Andersen3561b012004-04-13 19:27:20 +00001311 #define XUSAGE_IPCALC_FANCY(a)
1312#endif
Eric Andersende4f07e2003-12-11 01:18:07 +00001313#define ipcalc_trivial_usage \
Eric Andersen3561b012004-04-13 19:27:20 +00001314 "[OPTION]... <ADDRESS>[[/]<NETMASK>] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001315#define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001316 "Calculate IP network settings from a IP address\n\n" \
1317 "Options:\n" \
1318 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
Eric Andersen3561b012004-04-13 19:27:20 +00001319 "\t-n\t--network\tDisplay calculated network address.\n" \
1320 "\t-m\t--netmask\tDisplay default netmask for IP." \
1321 XUSAGE_IPCALC_FANCY(\
1322 "\n\t-p\t--prefix\tDisplay the prefix for IP/NETMASK." \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001323 "\t-h\t--hostname\tDisplay first resolved host name.\n" \
Eric Andersen3561b012004-04-13 19:27:20 +00001324 "\t-s\t--silent\tDon't ever display error messages.")
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001325
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001326#define iplink_trivial_usage \
1327 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1328#define iplink_full_usage \
1329 "iplink set DEVICE { up | down | arp { on | off } |\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001330 "\t\t\tdynamic { on | off } |\n" \
1331 "\t\t\tmtu MTU }\n" \
1332 "\tiplink show [ DEVICE ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001333
1334#define iproute_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001335 "{ list | flush | { add | del | change | append |\n" \
1336 "\t\treplace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001337#define iproute_full_usage \
1338 "iproute { list | flush } SELECTOR\n" \
1339 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001340 "\t\t\t[ oif STRING ] [ tos TOS ]\n" \
1341 "\tiproute { add | del | change | append | replace | monitor } ROUTE\n" \
1342 "\t\t\tSELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1343 "\t\t\tROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001344
1345#define iptunnel_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001346 "{ add | change | del | show } [ NAME ]\n" \
1347 "\t\t[ mode { ipip | gre | sit } ]\n" \
1348 "\t\t[ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001349#define iptunnel_full_usage \
1350 "iptunnel { add | change | del | show } [ NAME ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001351 "\t\t\t[ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1352 "\t\t\t[ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1353 "\t\t\t[ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001354
Eric Andersen7e9276b2001-02-22 01:15:47 +00001355#define kill_trivial_usage \
1356 "[-signal] process-id [process-id ...]"
1357#define kill_full_usage \
1358 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +00001359 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001360 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001361#define kill_example_usage \
1362 "$ ps | grep apache\n" \
1363 "252 root root S [apache]\n" \
1364 "263 www-data www-data S [apache]\n" \
1365 "264 www-data www-data S [apache]\n" \
1366 "265 www-data www-data S [apache]\n" \
1367 "266 www-data www-data S [apache]\n" \
1368 "267 www-data www-data S [apache]\n" \
1369 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001370
1371#define killall_trivial_usage \
1372 "[-signal] process-name [process-name ...]"
1373#define killall_full_usage \
1374 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001375 "Options:\n" \
1376 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001377#define killall_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001378 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001379
Mark Whitley6317c4b2001-03-12 22:51:50 +00001380#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001381 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001382#define klogd_full_usage \
1383 "Kernel logger.\n"\
1384 "Options:\n"\
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001385 "\t-c n\tSets the default log level of console messages to n.\n"\
Mark Whitley6317c4b2001-03-12 22:51:50 +00001386 "\t-n\tRun as a foreground process."
1387
Eric Andersen7e9276b2001-02-22 01:15:47 +00001388#define length_trivial_usage \
1389 "STRING"
1390#define length_full_usage \
1391 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001392#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001393 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001394 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001395
1396#define ln_trivial_usage \
1397 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1398#define ln_full_usage \
1399 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
1400 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1401 "Options:\n" \
1402 "\t-s\tmake symbolic links instead of hard links\n" \
1403 "\t-f\tremove existing destination files\n" \
1404 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001405#define ln_example_usage \
1406 "$ ln -s BusyBox /tmp/ls\n" \
1407 "$ ls -l /tmp/ls\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001408 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001409
Eric Andersen7e9276b2001-02-22 01:15:47 +00001410#define loadfont_trivial_usage \
1411 "< font"
1412#define loadfont_full_usage \
1413 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001414#define loadfont_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001415 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001416
1417#define loadkmap_trivial_usage \
1418 "< keymap"
1419#define loadkmap_full_usage \
1420 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001421#define loadkmap_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001422 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001423
1424#define logger_trivial_usage \
1425 "[OPTION]... [MESSAGE]"
1426#define logger_full_usage \
1427 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1428 "Options:\n" \
1429 "\t-s\tLog to stderr as well as the system log.\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001430 "\t-t TAG\tLog using the specified tag (defaults to user name).\n" \
1431 "\t-p PRIORITY\tEnter the message with the specified priority.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001432 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001433#define logger_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001434 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001435
Robert Griebl1fca5582002-06-04 20:45:46 +00001436#define login_trivial_usage \
1437 "[OPTION]... [username] [ENV=VAR ...]"
1438#define login_full_usage \
1439 "Begin a new session on the system\n\n" \
1440 "Options:\n" \
1441 "\t-f\tDo not authenticate (user already authenticated)\n" \
1442 "\t-h\tName of the remote host for this login.\n" \
1443 "\t-p\tPreserve environment."
1444
Eric Andersen7e9276b2001-02-22 01:15:47 +00001445#define logname_trivial_usage \
1446 ""
1447#define logname_full_usage \
1448 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001449#define logname_example_usage \
1450 "$ logname\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001451 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001452
Mark Whitley6317c4b2001-03-12 22:51:50 +00001453#define logread_trivial_usage \
Eric Andersend4a5e252003-12-19 11:32:14 +00001454 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001455#define logread_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001456 "Shows the messages from syslogd (using circular buffer).\n\n" \
Eric Andersend4a5e252003-12-19 11:32:14 +00001457 "Options:\n" \
1458 "\t-f\t\toutput data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001459
Matt Kraai83788da2002-03-20 17:38:37 +00001460#define losetup_trivial_usage \
1461 "[OPTION]... LOOPDEVICE FILE\n" \
1462 "or: losetup [OPTION]... -d LOOPDEVICE"
1463#define losetup_full_usage \
1464 "Associate LOOPDEVICE with FILE.\n\n" \
1465 "Options:\n" \
1466 "\t-d\t\tDisassociate LOOPDEVICE.\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001467 "\t-o OFFSET\tStart OFFSET bytes into FILE."
Matt Kraai83788da2002-03-20 17:38:37 +00001468
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001469#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001470 #define USAGE_LS_TIMESTAMPS(a) a
1471#else
1472 #define USAGE_LS_TIMESTAMPS(a)
1473#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001474#ifdef CONFIG_FEATURE_LS_FILETYPES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001475 #define USAGE_LS_FILETYPES(a) a
1476#else
1477 #define USAGE_LS_FILETYPES(a)
1478#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001479#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001480 #define USAGE_LS_FOLLOWLINKS(a) a
1481#else
1482 #define USAGE_LS_FOLLOWLINKS(a)
1483#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001484#ifdef CONFIG_FEATURE_LS_RECURSIVE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001485 #define USAGE_LS_RECURSIVE(a) a
1486#else
1487 #define USAGE_LS_RECURSIVE(a)
1488#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001489#ifdef CONFIG_FEATURE_LS_SORTFILES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001490 #define USAGE_LS_SORTFILES(a) a
1491#else
1492 #define USAGE_LS_SORTFILES(a)
1493#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001494#ifdef CONFIG_FEATURE_AUTOWIDTH
Eric Andersen7e9276b2001-02-22 01:15:47 +00001495 #define USAGE_AUTOWIDTH(a) a
1496#else
1497 #define USAGE_AUTOWIDTH(a)
1498#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00001499
Eric Andersen7e9276b2001-02-22 01:15:47 +00001500#define ls_trivial_usage \
Eric Andersen15c03c32004-04-06 17:52:02 +00001501 "[-1Aa" USAGE_LS_TIMESTAMPS("c") "Cd" USAGE_LS_TIMESTAMPS("e") USAGE_LS_FILETYPES("F") "iln" USAGE_LS_FILETYPES("p") USAGE_LS_FOLLOWLINKS("L") USAGE_LS_RECURSIVE("R") USAGE_LS_SORTFILES("rS") "s" USAGE_AUTOWIDTH("T") USAGE_LS_TIMESTAMPS("tu") USAGE_LS_SORTFILES("v") USAGE_AUTOWIDTH("w") "x" USAGE_LS_SORTFILES("X") USAGE_HUMAN_READABLE("h") USAGE_NOT_HUMAN_READABLE("") "k" USAGE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001502#define ls_full_usage \
1503 "List directory contents\n\n" \
1504 "Options:\n" \
1505 "\t-1\tlist files in a single column\n" \
1506 "\t-A\tdo not list implied . and ..\n" \
1507 "\t-a\tdo not hide entries starting with .\n" \
1508 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001509 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001510 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001511 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1512 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001513 "\t-i\tlist the i-node for each file\n" \
1514 "\t-l\tuse a long listing format\n" \
1515 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001516 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1517 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1518 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1519 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1520 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001521 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001522 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1523 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1524 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1525 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1526 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001527 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001528 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1529 USAGE_HUMAN_READABLE( \
Eric Andersen15c03c32004-04-06 17:52:02 +00001530 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n") \
1531 USAGE_SELINUX("\t-k\tprint security context\n") \
1532 USAGE_SELINUX("\t-K\tprint security context in long format\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001533
1534#define lsmod_trivial_usage \
1535 ""
1536#define lsmod_full_usage \
1537 "List the currently loaded kernel modules."
1538
1539#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001540 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001541#define makedevs_full_usage \
1542 "Creates a range of block or character special files\n\n" \
1543 "TYPEs include:\n" \
1544 "\tb:\tMake a block (buffered) device.\n" \
1545 "\tc or u:\tMake a character (un-buffered) device.\n" \
1546 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1547 "FIRST specifies the number appended to NAME to create the first device.\n" \
1548 "LAST specifies the number of the last item that should be created.\n" \
1549 "If 's' is the last argument, the base device is created as well.\n\n" \
1550 "For example:\n" \
1551 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001552 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001553#define makedevs_example_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001554 "# makedevs /dev/ttyS c 4 66 2 63\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001555 "[creates ttyS2-ttyS63]\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001556 "# makedevs /dev/hda b 3 0 0 8 s\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001557 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001558
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001559#ifdef CONFIG_FEATURE_MD5_SHA1_SUM_CHECK
1560#define USAGE_MD5_SHA1_SUM_CHECK(a) a
1561#else
1562#define USAGE_MD5_SHA1_SUM_CHECK(a)
1563#endif
1564
Eric Andersen7e9276b2001-02-22 01:15:47 +00001565#define md5sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001566 "[OPTION] [FILEs...]" \
1567 USAGE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001568#define md5sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001569 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001570 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001571 "With no FILE, or when FILE is -, read standard input." \
1572 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
1573 "\t-c\tcheck MD5 sums against given list\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001574 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001575 "\t-s\tdon't output anything, status code shows success\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001576 "\t-w\twarn about improperly formated MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001577#define md5sum_example_usage \
1578 "$ md5sum < busybox\n" \
1579 "6fd11e98b98a58f64ff3398d7b324003\n" \
1580 "$ md5sum busybox\n" \
1581 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1582 "$ md5sum -c -\n" \
1583 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1584 "busybox: OK\n" \
1585 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001586
Glenn L McGrath061c9002002-09-16 04:21:46 +00001587#define mesg_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001588 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001589#define mesg_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001590 "mesg controls write access to your terminal\n" \
Glenn L McGrath061c9002002-09-16 04:21:46 +00001591 "\ty\tAllow write access to your terminal.\n" \
1592 "\tn\tDisallow write access to your terminal.\n"
1593
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001594#define minit_trivial_usage \
1595 "[-spPrRC]"
1596#define minit_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001597 "A small replacement for SysV init"
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001598
Eric Andersen7e9276b2001-02-22 01:15:47 +00001599#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001600 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001601#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001602 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001603 "Options:\n" \
1604 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001605 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001606#define mkdir_example_usage \
1607 "$ mkdir /tmp/foo\n" \
1608 "$ mkdir /tmp/foo\n" \
1609 "/tmp/foo: File exists\n" \
1610 "$ mkdir /tmp/foo/bar/baz\n" \
1611 "/tmp/foo/bar/baz: No such file or directory\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001612 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001613
Eric Andersen7e9276b2001-02-22 01:15:47 +00001614#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001615 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001616#define mkfifo_full_usage \
1617 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1618 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001619 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001620
Eric Andersen7e9276b2001-02-22 01:15:47 +00001621#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001622 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001623#define mkfs_minix_full_usage \
1624 "Make a MINIX filesystem.\n\n" \
1625 "Options:\n" \
1626 "\t-c\t\tCheck the device for bad blocks\n" \
1627 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1628 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1629 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001630 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001631
Eric Andersen7e9276b2001-02-22 01:15:47 +00001632#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001633 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001634#define mknod_full_usage \
1635 "Create a special file (block, character, or pipe).\n\n" \
1636 "Options:\n" \
1637 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1638 "TYPEs include:\n" \
1639 "\tb:\tMake a block (buffered) device.\n" \
1640 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001641 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001642#define mknod_example_usage \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001643 "$ mknod /dev/fd0 b 2 0\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001644 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001645
Eric Andersen7e9276b2001-02-22 01:15:47 +00001646#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001647 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001648#define mkswap_full_usage \
1649 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001650 "Options:\n" \
1651 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001652 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001653 "\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 +00001654 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001655
Eric Andersen7e9276b2001-02-22 01:15:47 +00001656#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001657 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001658#define mktemp_full_usage \
1659 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001660 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001661#define mktemp_example_usage \
1662 "$ mktemp /tmp/temp.XXXXXX\n" \
1663 "/tmp/temp.mWiLjM\n" \
1664 "$ ls -la /tmp/temp.mWiLjM\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001665 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001666
Eric Andersen8d79ce82001-07-22 23:00:15 +00001667#define modprobe_trivial_usage \
1668 "[FILE ...]"
1669#define modprobe_full_usage \
Eric Andersenabc95682002-07-03 02:52:35 +00001670 "Used for high level module loading and unloading."
Eric Andersen8d79ce82001-07-22 23:00:15 +00001671#define modprobe_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001672 "$ modprobe cdrom\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00001673
Eric Andersen7e9276b2001-02-22 01:15:47 +00001674#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001675 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001676#define more_full_usage \
1677 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001678#define more_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001679 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001680
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001681#ifdef CONFIG_FEATURE_MOUNT_LOOP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001682 #define USAGE_MOUNT_LOOP(a) a
1683#else
1684 #define USAGE_MOUNT_LOOP(a)
1685#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001686#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001687 #define USAGE_MTAB(a) a
1688#else
1689 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001690#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001691#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001692 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001693#define mount_full_usage \
Eric Andersen2715fa12004-03-09 21:32:57 +00001694 "Mount a filesystem. Autodetection of filesystem type requires the\n" \
1695 "/proc filesystem be already mounted.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001696 "Flags:\n" \
1697 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001698 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001699 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001700 "\t-n:\t\tDon't write a mount table entry.\n" \
1701 ) \
1702 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1703 "\t-r:\t\tMount the filesystem read-only.\n" \
1704 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1705 "\t-w:\t\tMount for reading and writing (default).\n" \
1706 "\n" \
1707 "Options for use with the \"-o\" flag:\n" \
1708 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1709 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1710 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1711 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001712 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001713 "\tloop:\t\tMounts a file via loop device.\n" \
1714 ) \
1715 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001716 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001717 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001718 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001719 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001720 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001721#define mount_example_usage \
1722 "$ mount\n" \
1723 "/dev/hda3 on / type minix (rw)\n" \
1724 "proc on /proc type proc (rw)\n" \
1725 "devpts on /dev/pts type devpts (rw)\n" \
1726 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001727 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001728
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001729#define msvc_trivial_usage \
1730 "-[udorspchaitkx] service"
Eric Andersen335816b2003-07-14 22:14:49 +00001731#define msvc_full_usage \
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001732 "[option] service\n" \
1733 "Where option is one of\n" \
1734 "\t-u\tUp. If the service is not running, start it. If the service stops, restart it.\n" \
1735 "\t-d\tDown. If the service is running, stop it, do not restart it.\n" \
1736 "\t-o\tOnce. If the service is not running, start it. Do not restart it if it stops.\n" \
1737 "\t-r\tTell supervise that the service is normally running; this affects status messages.\n" \
1738 "\t-s\tTell supervise that the service is normally stopped; this affects status messages.\n" \
1739 "\t-p\tPause. Send the service a STOP signal.\n" \
1740 "\t-c\tContinue. Send the service a CONT signal.\n" \
1741 "\t-h\tHangup. Send the service a HUP signal.\n" \
1742 "\t-a\tAlarm. Send the service an ALRM signal.\n" \
1743 "\t-i\tInterrupt. Send the service an INT signal.\n" \
1744 "\t-t\tTerminate. Send the service a TERM signal.\n" \
1745 "\t-k\tKill. Send the service a KILL signal.\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001746 "\t-x\tExit. supervise will quit as soon as the service is down."
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001747
Eric Andersen7e9276b2001-02-22 01:15:47 +00001748#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001749 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001750#define mt_full_usage \
1751 "Control magnetic tape drive operation\n" \
1752 "\nAvailable Opcodes:\n\n" \
1753 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1754 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
Eric Andersen92fb9392003-08-08 20:09:03 +00001755 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001756 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001757
Eric Andersen7e9276b2001-02-22 01:15:47 +00001758#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001759 "SOURCE DEST\n" \
1760 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001761#define mv_full_usage \
1762 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001763#define mv_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001764 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001765
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001766#define nameif_trivial_usage \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001767 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001768#define nameif_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00001769 "Nameif renaming network interface while it in the down state.\n\n" \
1770 "Options:\n" \
1771 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
1772 "\t-s\t\tUse syslog (LOCAL0 facility).\n" \
1773 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001774#define nameif_example_usage \
Eric Andersen178de172004-04-06 16:36:20 +00001775 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
1776 " or\n" \
1777 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001778
Eric Andersen7e9276b2001-02-22 01:15:47 +00001779#define nc_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001780 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001781#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001782 "Netcat opens a pipe to IP:port\n\n" \
1783 "Options:\n" \
1784 "\t-l\t\tlisten mode, for inbound connects\n" \
1785 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00001786 "\t-i SECS\t\tdelay interval for lines sent\n" \
Eric Andersen00a6a752002-04-26 23:53:10 +00001787 "\t-e PROG\t\tprogram to exec after connect (dangerous!)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001788#define nc_example_usage \
1789 "$ nc foobar.somedomain.com 25\n" \
1790 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1791 "help\n" \
1792 "214-Commands supported:\n" \
1793 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1794 "214 NOOP QUIT RSET HELP\n" \
1795 "quit\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001796 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001797
Eric Andersen1552ff72001-10-31 11:07:12 +00001798#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00001799 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00001800#define netstat_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001801 "Netstat displays Linux networking information.\n\n" \
1802 "Options:\n" \
1803 "\t-l display listening server sockets\n" \
1804 "\t-a display all sockets (default: connected)\n" \
1805 "\t-e display other/more information\n" \
1806 "\t-n don't resolve names\n" \
1807 "\t-r display routing table\n" \
1808 "\t-t tcp sockets\n" \
1809 "\t-u udp sockets\n" \
1810 "\t-w raw sockets\n" \
1811 "\t-x unix sockets"
Eric Andersen1552ff72001-10-31 11:07:12 +00001812
Eric Andersen7e9276b2001-02-22 01:15:47 +00001813#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001814 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001815#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001816 "Queries the nameserver for the IP address of the given HOST\n" \
1817 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001818#define nslookup_example_usage \
1819 "$ nslookup localhost\n" \
1820 "Server: default\n" \
1821 "Address: default\n" \
1822 "\n" \
1823 "Name: debian\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001824 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001825
Glenn L McGrath60281112001-11-02 11:39:46 +00001826#define od_trivial_usage \
1827 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
1828#define od_full_usage \
1829 "Write an unambiguous representation, octal bytes by default, of FILE\n"\
1830 "to standard output. With no FILE, or when FILE is -, read standard input."
1831
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00001832#define openvt_trivial_usage \
1833 "<vtnum> <COMMAND> [ARGS...]"
1834#define openvt_full_usage \
1835 "Start a command on a new virtual terminal"
1836#define openvt_example_usage \
1837 "openvt 2 /bin/ash\n"
1838
Eric Andersen27f64e12002-06-23 04:24:25 +00001839#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
1840 #define PASSWORD_ALG_TYPES(a) a
Tim Riker7b253f82003-12-28 05:02:40 +00001841#else
Eric Andersen27f64e12002-06-23 04:24:25 +00001842 #define PASSWORD_ALG_TYPES(a)
1843#endif
1844#define passwd_trivial_usage \
1845 "[OPTION] [name]"
1846#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00001847 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00001848 "changes the password for the current user.\n" \
1849 "Options:\n" \
1850 "\t-a\tDefine which algorithm shall be used for the password.\n" \
1851 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001852 PASSWORD_ALG_TYPES(", sha1") \
Eric Andersen27f64e12002-06-23 04:24:25 +00001853 ")\n\t-d\tDelete the password for the specified user account.\n" \
1854 "\t-l\tLocks (disables) the specified user account.\n" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001855 "\t-u\tUnlocks (re-enables) the specified user account."
Eric Andersen27f64e12002-06-23 04:24:25 +00001856
Glenn L McGrath655d8142003-06-22 15:32:41 +00001857#define patch_trivial_usage \
1858 "[-p<num>]"
1859#define patch_full_usage \
1860 "[-p<num>]"
1861#define patch_example_usage \
1862 "$ patch -p1 <example.diff"
1863
Glenn L McGrath1e11c342003-05-11 14:52:39 +00001864#define pidfilehack_trivial_usage \
1865 "[daemon.pid] [daemon]"
1866#define pidfilehack_full_usage \
1867 "service /var/run/daemon.pid /usr/sbin/daemon args...\n"
1868
Eric Andersen221b2ea2001-07-31 19:06:07 +00001869#define pidof_trivial_usage \
1870 "process-name [process-name ...]"
1871#define pidof_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00001872 "Lists the PIDs of all processes with names that match the\n" \
1873 "names on the command line"
Eric Andersen221b2ea2001-07-31 19:06:07 +00001874#define pidof_example_usage \
1875 "$ pidof init\n" \
1876 "1\n"
1877
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001878#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001879#define ping_trivial_usage "host"
1880#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1881#else
1882#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001883 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001884#define ping_full_usage \
1885 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1886 "Options:\n" \
1887 "\t-c COUNT\tSend only COUNT pings.\n" \
1888 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1889 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001890 "\t\t\tand when finished."
1891#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001892#define ping_example_usage \
1893 "$ ping localhost\n" \
1894 "PING slag (127.0.0.1): 56 data bytes\n" \
1895 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1896 "\n" \
1897 "--- debian ping statistics ---\n" \
1898 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001899 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001900
Eric Andersen51b8bd62002-07-03 11:46:38 +00001901#ifndef CONFIG_FEATURE_FANCY_PING6
1902#define ping6_trivial_usage "host"
1903#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1904#else
1905#define ping6_trivial_usage \
1906 "[OPTION]... host"
1907#define ping6_full_usage \
1908 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1909 "Options:\n" \
1910 "\t-c COUNT\tSend only COUNT pings.\n" \
1911 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1912 "\t-q\t\tQuiet mode, only displays output at start\n" \
1913 "\t\t\tand when finished."
1914#endif
1915#define ping6_example_usage \
1916 "$ ping6 ip6-localhost\n" \
1917 "PING ip6-localhost (::1): 56 data bytes\n" \
1918 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
1919 "\n" \
1920 "--- ip6-localhost ping statistics ---\n" \
1921 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001922 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00001923
Eric Andersen7e9276b2001-02-22 01:15:47 +00001924#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001925 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001926#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001927 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001928 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001929
Eric Andersen7e9276b2001-02-22 01:15:47 +00001930#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001931 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001932#define poweroff_full_usage \
1933 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001934
Eric Andersen7e9276b2001-02-22 01:15:47 +00001935#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001936 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001937#define printf_full_usage \
1938 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001939 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001940#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001941 "$ printf "Val=%d\\n" 5\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001942 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001943
Eric Andersen15c03c32004-04-06 17:52:02 +00001944#ifdef CONFIG_SELINUX
1945#define USAGE_NONSELINUX(a)
1946#else
1947#define USAGE_NONSELINUX(a) a
1948#endif
1949
Eric Andersen7e9276b2001-02-22 01:15:47 +00001950#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001951 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001952#define ps_full_usage \
1953 "Report process status\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001954 USAGE_NONSELINUX("\n\tThis version of ps accepts no options.") \
1955 USAGE_SELINUX("\nOptions:\n\t-c\tshow SE Linux context")
Tim Riker7b253f82003-12-28 05:02:40 +00001956
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001957#define ps_example_usage \
1958 "$ ps\n" \
1959 " PID Uid Gid State Command\n" \
1960 " 1 root root S init\n" \
1961 " 2 root root S [kflushd]\n" \
1962 " 3 root root S [kupdate]\n" \
1963 " 4 root root S [kpiod]\n" \
1964 " 5 root root S [kswapd]\n" \
1965 " 742 andersen andersen S [bash]\n" \
1966 " 743 andersen andersen S -bash\n" \
1967 " 745 root root S [getty]\n" \
1968 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001969
Eric Andersen7e9276b2001-02-22 01:15:47 +00001970#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001971 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001972#define pwd_full_usage \
1973 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001974#define pwd_example_usage \
1975 "$ pwd\n" \
1976 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001977
Eric Andersen92fb9392003-08-08 20:09:03 +00001978#define raid_start_trivial_usage \
1979 "MD_DEVICE DISK_DEVICE"
1980#define raid_start_full_usage \
1981 "Start MD_DEVICE, taking superblock from DISK_DEVICE.\n" \
1982 "Example: raid_start /dev/md0 /dev/sdb"
Tim Riker7b253f82003-12-28 05:02:40 +00001983
Eric Andersen7e9276b2001-02-22 01:15:47 +00001984#define rdate_trivial_usage \
Eric Andersen725db192003-07-22 08:26:05 +00001985 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001986#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001987 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001988 "Options:\n" \
1989 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001990 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001991
Eric Andersen7e9276b2001-02-22 01:15:47 +00001992#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001993 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001994#define readlink_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001995 "Displays the value of a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001996
Glenn L McGrath62fae302002-12-10 00:14:33 +00001997#define realpath_trivial_usage \
1998 "pathname ..."
1999#define realpath_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002000 "Returns the absolute pathnames of given argument."
Tim Riker7b253f82003-12-28 05:02:40 +00002001
Eric Andersen7e9276b2001-02-22 01:15:47 +00002002#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002003 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002004#define reboot_full_usage \
2005 "Reboot the system."
2006
2007#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002008 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002009#define renice_full_usage \
2010 "Changes priority of running processes. Allowed priorities range\n" \
2011 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002012 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002013
Eric Andersen7e9276b2001-02-22 01:15:47 +00002014#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002015 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002016#define reset_full_usage \
2017 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002018
Eric Andersen7e9276b2001-02-22 01:15:47 +00002019#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002020 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002021#define rm_full_usage \
2022 "Remove (unlink) the FILE(s). You may use '--' to\n" \
2023 "indicate that all following arguments are non-options.\n\n" \
2024 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002025 "\t-i\t\talways prompt before removing each destination\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002026 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002027 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002028#define rm_example_usage \
2029 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002030
Eric Andersen7e9276b2001-02-22 01:15:47 +00002031#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002032 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002033#define rmdir_full_usage \
2034 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002035#define rmdir_example_usage \
2036 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002037
Eric Andersen7e9276b2001-02-22 01:15:47 +00002038#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002039 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002040#define rmmod_full_usage \
2041 "Unloads the specified kernel modules from the kernel.\n\n" \
2042 "Options:\n" \
Tim Rikercf932742002-12-14 01:58:59 +00002043 "\t-a\tRemove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002044#define rmmod_example_usage \
2045 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002046
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002047#ifdef CONFIG_FEATURE_IPV6
2048 #define USAGE_ROUTE_IPV6(a) a
2049#else
2050 #define USAGE_ROUTE_IPV6(a) "\t"
2051#endif
2052
2053
Eric Andersen7e9276b2001-02-22 01:15:47 +00002054#define route_trivial_usage \
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002055 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002056#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002057 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00002058 "Options:\n" \
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002059 "\t-n\t\tDont resolve names.\n" \
2060 "\t-e\t\tDisplay other/more information.\n" \
2061 "\t-A inet" USAGE_ROUTE_IPV6("{6}") "\tSelect address family."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002062
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002063#define rpm_trivial_usage \
2064 "-i -q[ildc]p package.rpm"
2065#define rpm_full_usage \
2066 "Manipulates RPM packages" \
Eric Andersendfce3532003-06-15 07:00:54 +00002067 "\n\nOptions:" \
2068 "\n\t-i Install package" \
2069 "\n\t-q Query package" \
2070 "\n\t-p Query uninstalled package" \
2071 "\n\t-i Show information" \
2072 "\n\t-l List contents" \
2073 "\n\t-d List documents" \
2074 "\n\t-c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002075
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002076#define rpm2cpio_trivial_usage \
2077 "package.rpm"
2078#define rpm2cpio_full_usage \
2079 "Outputs a cpio archive of the rpm file."
2080
Eric Andersen6cf47a72001-10-31 10:24:36 +00002081#define run_parts_trivial_usage \
2082 "[-t] [-a ARG] [-u MASK] DIRECTORY"
2083#define run_parts_full_usage \
2084 "Run a bunch of scripts in a directory.\n\n" \
2085 "Options:\n" \
Eric Andersena151d192004-04-06 17:16:36 +00002086 "\t-t\tPrints what would be run, but does not actually run anything.\n" \
Eric Andersen6cf47a72001-10-31 10:24:36 +00002087 "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \
2088 "\t-u MASK\tSet the umask to MASK before executing every program."
2089
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002090#define rx_trivial_usage \
2091 "FILE"
2092#define rx_full_usage \
2093 "Receive a file using the xmodem protocol."
2094#define rx_example_usage \
2095 "$ rx /tmp/foo\n"
2096
Eric Andersen7e9276b2001-02-22 01:15:47 +00002097#define sed_trivial_usage \
Matt Kraai075228a2001-06-21 14:40:55 +00002098 "[-nef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002099#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002100 "Options:\n" \
2101 "\t-n\t\tsuppress automatic printing of pattern space\n" \
2102 "\t-e script\tadd the script to the commands to be executed\n" \
Eric Andersenf802ff72004-04-12 15:12:06 +00002103 "\t-f scriptfile\tadd script-file contents to the\n" \
2104 "\t\t\tcommands to be executed\n" \
2105 "\t-i\t\tEdit files in-place\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002106 "\n" \
Eric Andersenf802ff72004-04-12 15:12:06 +00002107 "If no -e or -f is given, the first non-option argument is taken as the sed\n"\
2108 "script to interpret. All remaining arguments are names of input files; if no\n"\
2109 "input files are specified, then the standard input is read. Source files\n" \
2110 "will not be modified unless -i option is given."
2111
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002112#define sed_example_usage \
2113 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
2114 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002115
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002116#define seq_trivial_usage \
2117 "[first [increment]] last"
2118#define seq_full_usage \
2119 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
2120 "FIRST, INCREMENT default to 1\n" \
2121 "Arguments:\n" \
2122 "\tLAST\n" \
2123 "\tFIRST\tLAST\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002124 "\tFIRST\tINCREMENT\tLAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002125
Eric Andersen7e9276b2001-02-22 01:15:47 +00002126#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002127 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002128#define setkeycodes_full_usage \
2129 "Set entries into the kernel's scancode-to-keycode map,\n" \
2130 "allowing unusual keyboards to generate usable keycodes.\n\n" \
2131 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002132 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002133#define setkeycodes_example_usage \
2134 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002135
Matt Kraai2d91deb2001-08-01 17:21:35 +00002136#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002137 "[FILE]...\n" \
2138 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00002139#define lash_full_usage \
Eric Andersen2e9c2572003-08-08 22:26:06 +00002140 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00002141#define lash_notes_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002142 "This command does not yet have proper documentation.\n\n" \
2143 "Use lash just as you would use any other shell. It properly handles pipes,\n" \
2144 "redirects, job control, can be used as the shell for scripts, and has a\n" \
2145 "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
2146 "Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
2147 "use ash or bash. If you just need a very simple and extremely small shell,\n" \
2148 "this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002149
Eric Andersen2e9c2572003-08-08 22:26:06 +00002150#define last_trivial_usage \
2151 ""
2152#define last_full_usage \
2153 "Shows listing of the last users that logged into the system"
2154
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002155#define sha1sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002156 "[OPTION] [FILEs...]" \
2157 USAGE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002158#define sha1sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002159 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n\n" \
2160 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002161 "With no FILE, or when FILE is -, read standard input." \
2162 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
2163 "\t-c\tcheck SHA1 sums against given list\n" \
2164 "\nThe following two options are useful only when verifying checksums:\n" \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002165 "\t-s\tdon't output anything, status code shows success\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002166 "\t-w\twarn about improperly formated SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002167
Manuel Novoa III cad53642003-03-19 09:13:01 +00002168#ifdef CONFIG_FEATURE_FANCY_SLEEP
2169 #define USAGE_FANCY_SLEEP(a) a
2170 #define USAGE_NOT_FANCY_SLEEP(a)
2171#else
Tim Riker7b253f82003-12-28 05:02:40 +00002172 #define USAGE_FANCY_SLEEP(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +00002173 #define USAGE_NOT_FANCY_SLEEP(a) a
2174#endif
2175
Eric Andersen7e9276b2001-02-22 01:15:47 +00002176#define sleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002177 USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002178#define sleep_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002179 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \
2180 USAGE_FANCY_SLEEP( \
Eric Andersen178de172004-04-06 16:36:20 +00002181 "Pause for a time equal to the total of the args given, where each arg can\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00002182 "\t\thave an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002183#define sleep_example_usage \
2184 "$ sleep 2\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002185 "[2 second delay results]\n" \
2186 USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \
2187 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002188
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002189#ifdef CONFIG_FEATURE_SORT_UNIQUE
Mark Whitleyfccaa362001-04-17 18:56:18 +00002190 #define USAGE_SORT_UNIQUE(a) a
2191#else
2192 #define USAGE_SORT_UNIQUE(a)
2193#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002194#ifdef CONFIG_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002195 #define USAGE_SORT_REVERSE(a) a
2196#else
2197 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002198#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002199#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002200 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002201#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002202 "Sorts lines of text in the specified files\n\n"\
2203 "Options:\n" \
2204 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
2205 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
2206 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002207#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002208 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002209 "a\n" \
2210 "b\n" \
2211 "c\n" \
2212 "d\n" \
2213 "e\n" \
2214 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002215
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002216#define start_stop_daemon_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00002217 "[OPTIONS] [--start|--stop] ... [-- arguments...]\n"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002218#define start_stop_daemon_full_usage \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002219 "Program to start and stop services."\
2220 "\n\nOptions:"\
2221 "\n\t-S|--start\t\t\tstart"\
2222 "\n\t-K|--stop\t\t\tstop"\
Eric Andersena151d192004-04-06 17:16:36 +00002223 "\n\t-a|--startas <pathname>\t\tstarts process specified by pathname"\
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002224 "\n\t-b|--background\t\t\tforce process into background"\
2225 "\n\t-u|--user <username>|<uid>\tstop this user's processes"\
Eric Andersena151d192004-04-06 17:16:36 +00002226 "\n\t-x|--exec <executable>\t\tprogram to either start or check"\
Eric Andersen625da9d2004-04-13 18:28:46 +00002227 "\n\t-m|--make-pidfile <filename>\tcreate the -p file and enter pid in it"\
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002228 "\n\t-n|--name <process-name>\tstop processes with this name"\
2229 "\n\t-p|--pidfile <pid-file>\t\tsave or load pid using a pid-file"\
2230 "\n\t-q|--quiet\t\t\tbe quiet" \
Eric Andersen178de172004-04-06 16:36:20 +00002231 "\n\t-s|--signal <signal>\t\tsignal to send (default TERM)"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002232
Eric Andersenef5e8f82002-11-07 02:09:37 +00002233#define strings_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002234 "[-afo] [-n length] [file ... ]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002235#define strings_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002236 "Display printable strings in a binary file." \
2237 "\n\nOptions:" \
2238 "\n\t-f\tPrecede each string with the name of the file where it was found." \
2239 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
2240 "\n\t-o\tEach string is preceded by its decimal offset in the file."
Eric Andersenef5e8f82002-11-07 02:09:37 +00002241
Eric Andersen7e9276b2001-02-22 01:15:47 +00002242#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002243 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002244#define stty_full_usage \
2245 "Without arguments, prints baud rate, line discipline," \
2246 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002247 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00002248 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002249 "\n\t-a\t\tprint all current settings in human-readable form" \
2250 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00002251 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002252
Robert Griebl1fca5582002-06-04 20:45:46 +00002253#define su_trivial_usage \
2254 "[OPTION]... [-] [username]"
2255#define su_full_usage \
2256 "Change user id or become root.\n" \
2257 "Options:\n" \
2258 "\t-p\tPreserve environment"
2259
Eric Andersen27f64e12002-06-23 04:24:25 +00002260#define sulogin_trivial_usage \
2261 "[OPTION]... [tty-device]"
2262#define sulogin_full_usage \
2263 "Single user login\n" \
2264 "Options:\n" \
2265 "\t-f\tDo not authenticate (user already authenticated)\n" \
2266 "\t-h\tName of the remote host for this login.\n" \
2267 "\t-p\tPreserve environment."
2268
Eric Andersen7e9276b2001-02-22 01:15:47 +00002269#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002270 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002271#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002272 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002273 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002274 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002275
Eric Andersen7e9276b2001-02-22 01:15:47 +00002276#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002277 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002278#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002279 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002280 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002281 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002282
Eric Andersen7e9276b2001-02-22 01:15:47 +00002283#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002284 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002285#define sync_full_usage \
2286 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002287
Eric Andersen7e9276b2001-02-22 01:15:47 +00002288
Eric Andersen29c77f72003-10-09 09:43:18 +00002289#ifdef CONFIG_FEATURE_ROTATE_LOGFILE
2290 #define USAGE_ROTATE_LOGFILE(a) a
2291#else
Tim Riker7b253f82003-12-28 05:02:40 +00002292 #define USAGE_ROTATE_LOGFILE(a)
Eric Andersen29c77f72003-10-09 09:43:18 +00002293#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002294#ifdef CONFIG_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00002295 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002296#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00002297 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002298#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00002299#ifdef CONFIG_FEATURE_IPC_SYSLOG
2300 #define USAGE_IPC_LOG(a) a
2301#else
2302 #define USAGE_IPC_LOG(a)
2303#endif
2304
Eric Andersenb9050282003-12-24 06:02:11 +00002305#ifdef CONFIG_SYSCTL
2306#define sysctl_trivial_usage \
2307 "[OPTIONS]... [VALUE]...\n"
2308#define sysctl_full_usage
2309 "sysctl - configure kernel parameters at runtime\n\n" \
2310 "Options:\n" \
2311 "\t-n\tUse this option to disable printing of the key name when printing values.\n" \
2312 "\t-e\tUse this option to ignore errors about unknown keys.\n" \
2313 "\t-w\tUse this option when you want to change a sysctl setting.\n" \
2314 "\t-p\tLoad in sysctl settings from the file specified or /etc/sysctl.conf if none given.\n" \
2315 "\t-a\tDisplay all values currently available.\n" \
2316 "\t-A\tDisplay all values currently available in table form."
Eric Andersenb9050282003-12-24 06:02:11 +00002317#define sysctl_example_usage
2318 "sysctl [-n] [-e] variable ...\n" \
2319 "sysctl [-n] [-e] -w variable=value ...\n" \
2320 "sysctl [-n] [-e] -a\n" \
2321 "sysctl [-n] [-e] -p <file>\t(default /etc/sysctl.conf)\n" \
2322 "sysctl [-n] [-e] -A\n"
2323#endif
2324
Eric Andersen7e9276b2001-02-22 01:15:47 +00002325#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002326 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002327#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002328 "Linux system and kernel logging utility.\n" \
2329 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002330 "Options:\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002331 "\t-m MIN\t\tMinutes between MARK lines (default=20, 0=off)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002332 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002333 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen29c77f72003-10-09 09:43:18 +00002334 USAGE_ROTATE_LOGFILE( \
Eric Andersen178de172004-04-06 16:36:20 +00002335 "\n\t-s SIZE\t\tMax size (KB) before rotate (default=200KB, 0=off)\n" \
2336 "\t-b NUM\t\tNumber of rotated logs to keep (default=1, max=99, 0=purge)") \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002337 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00002338 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00002339 "\t-L\t\tLog locally and via network logging (default is network only)") \
2340 USAGE_IPC_LOG( \
Eric Andersend4a5e252003-12-19 11:32:14 +00002341 "\n\t-C [size(KiB)]\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002342#define syslogd_example_usage \
2343 "$ syslogd -R masterlog:514\n" \
2344 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002345
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002346
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002347#ifndef CONFIG_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00002348 #define USAGE_UNSIMPLE_TAIL(a)
2349#else
2350 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002351#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002352#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002353 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002354#define tail_full_usage \
2355 "Print last 10 lines of each FILE to standard output.\n" \
2356 "With more than one FILE, precede each with a header giving the\n" \
2357 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
2358 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002359 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002360 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
2361 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002362 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002363 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
2364 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002365 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002366 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002367 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
2368#define tail_example_usage \
2369 "$ tail -n 1 /etc/resolv.conf\n" \
2370 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002371
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002372#ifdef CONFIG_FEATURE_TAR_CREATE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002373 #define USAGE_TAR_CREATE(a) a
2374#else
2375 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002376#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002377#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002378 #define USAGE_TAR_EXCLUDE(a) a
2379#else
2380 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002381#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002382#ifdef CONFIG_FEATURE_TAR_GZIP
2383 #define USAGE_TAR_GZIP(a) a
2384#else
2385 #define USAGE_TAR_GZIP(a)
2386#endif
2387#ifdef CONFIG_FEATURE_TAR_BZIP2
2388 #define USAGE_TAR_BZIP2(a) a
2389#else
2390 #define USAGE_TAR_BZIP2(a)
2391#endif
Glenn L McGrath7370f622003-11-18 21:49:23 +00002392#ifdef CONFIG_FEATURE_TAR_COMPRESS
2393 #define USAGE_TAR_COMPRESS(a) a
2394#else
2395 #define USAGE_TAR_COMPRESS(a)
2396#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002397
Eric Andersen7e9276b2001-02-22 01:15:47 +00002398#define tar_trivial_usage \
Glenn L McGrath7370f622003-11-18 21:49:23 +00002399 "-[" USAGE_TAR_CREATE("c") USAGE_TAR_GZIP("z") USAGE_TAR_BZIP2("j") USAGE_TAR_COMPRESS("Z") "xtvO] " \
Glenn L McGrathce91c8a2003-12-26 14:01:37 +00002400 USAGE_TAR_EXCLUDE("[-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00002401 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002402#define tar_full_usage \
2403 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00002404 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002405 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002406 "\tx\t\textract\n" \
2407 "\tt\t\tlist\n" \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002408 "\nArchive format selection:\n" \
2409 USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
2410 USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
Glenn L McGrath0c5d9c22003-11-18 23:27:49 +00002411 USAGE_TAR_COMPRESS("\tZ\t\tFilter the archive through compress\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002412 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002413 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002414 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002415 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002416 "\texclude\t\tfile to exclude\n" \
2417 "\tX\t\tfile with names to exclude\n" \
2418 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00002419 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002420 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002421#define tar_example_usage \
2422 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
2423 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002424
Eric Andersen7e9276b2001-02-22 01:15:47 +00002425#define tee_trivial_usage \
2426 "[OPTION]... [FILE]..."
2427#define tee_full_usage \
2428 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002429 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002430 "\t-a\tappend to the given FILEs, do not overwrite\n" \
2431 "\t-i\tignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002432#define tee_example_usage \
2433 "$ echo "Hello" | tee /tmp/foo\n" \
2434 "$ cat /tmp/foo\n" \
2435 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002436
Eric Andersen539ffc92004-02-22 12:25:47 +00002437#ifdef CONFIG_FEATURE_TELNET_AUTOLOGIN
2438#define telnet_trivial_usage \
2439 "[-a] [-l USER] HOST [PORT]"
2440#define telnet_full_usage \
2441 "Telnet is used to establish interactive communication with another\n" \
2442 "computer over a network using the TELNET protocol.\n\n" \
2443 "Options:\n" \
2444 "\t-a\t\tAttempt an automatic login with the USER variable.\n" \
2445 "\t-l USER\t\tAttempt an automatic login with the USER argument.\n" \
2446 "\tHOST\t\tThe official name, alias or the IP address of the\n" \
2447 "\t\t\tremote host.\n" \
2448 "\tPORT\t\tThe remote port number to connect to. If it is not\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002449 "\t\t\tspecified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00002450#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00002451#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002452 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002453#define telnet_full_usage \
2454 "Telnet is used to establish interactive communication with another\n"\
2455 "computer over a network using the TELNET protocol."
Eric Andersen539ffc92004-02-22 12:25:47 +00002456#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002457
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002458#ifdef CONFIG_FEATURE_TELNETD_INETD
2459#define telnetd_trivial_usage \
2460 "(inetd mode) [OPTION]"
2461#define telnetd_full_usage \
2462 "Telnetd uses incoming TELNET connections via inetd.\n"\
2463 "Options:\n" \
2464 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
2465#else
Eric Andersen08a72202002-09-30 20:52:10 +00002466#define telnetd_trivial_usage \
2467 "[OPTION]"
2468#define telnetd_full_usage \
2469 "Telnetd listens for incoming TELNET connections on PORT.\n"\
2470 "Options:\n" \
2471 "\t-p PORT\tlisten for connections on PORT (default 23)\n"\
2472 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002473#endif
Eric Andersen08a72202002-09-30 20:52:10 +00002474
Eric Andersen7e9276b2001-02-22 01:15:47 +00002475#define test_trivial_usage \
2476 "EXPRESSION\n or [ EXPRESSION ]"
2477#define test_full_usage \
2478 "Checks file types and compares values returning an exit\n" \
2479 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002480#define test_example_usage \
2481 "$ test 1 -eq 2\n" \
2482 "$ echo $?\n" \
2483 "1\n" \
2484 "$ test 1 -eq 1\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002485 "$ echo $?\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002486 "0\n" \
2487 "$ [ -d /etc ]\n" \
2488 "$ echo $?\n" \
2489 "0\n" \
2490 "$ [ -d /junk ]\n" \
2491 "$ echo $?\n" \
2492 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002493
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002494#ifdef CONFIG_FEATURE_TFTP_GET
Mark Whitley450736c2001-03-02 19:08:50 +00002495 #define USAGE_TFTP_GET(a) a
2496#else
2497 #define USAGE_TFTP_GET(a)
2498#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002499#ifdef CONFIG_FEATURE_TFTP_PUT
Mark Whitley450736c2001-03-02 19:08:50 +00002500 #define USAGE_TFTP_PUT(a) a
2501#else
2502 #define USAGE_TFTP_PUT(a)
2503#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002504#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Glenn L McGrathad117d82001-10-05 04:40:37 +00002505 #define USAGE_TFTP_BS(a) a
2506#else
2507 #define USAGE_TFTP_BS(a)
2508#endif
Mark Whitley450736c2001-03-02 19:08:50 +00002509
2510#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00002511 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00002512#define tftp_full_usage \
2513 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00002514 "Options:\n" \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002515 "\t-l FILE\tLocal FILE.\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002516 "\t-r FILE\tRemote FILE." \
Mark Whitley450736c2001-03-02 19:08:50 +00002517 USAGE_TFTP_GET( \
Eric Andersen178de172004-04-06 16:36:20 +00002518 "\n\t-g\tGet file." \
Mark Whitley450736c2001-03-02 19:08:50 +00002519 ) \
2520 USAGE_TFTP_PUT( \
Eric Andersen178de172004-04-06 16:36:20 +00002521 "\n\t-p\tPut file." \
Mark Whitley450736c2001-03-02 19:08:50 +00002522 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002523 USAGE_TFTP_BS( \
Eric Andersen178de172004-04-06 16:36:20 +00002524 "\n\t-b SIZE\tTransfer blocks of SIZE octets." \
Tim Riker7b253f82003-12-28 05:02:40 +00002525 )
Eric Andersenc3657422001-11-30 07:54:32 +00002526#define time_trivial_usage \
2527 "[OPTION]... COMMAND [ARGS...]"
2528#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00002529 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
2530 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00002531 "Options:\n" \
2532 "\t-v\tDisplays verbose resource usage information."
Mark Whitley450736c2001-03-02 19:08:50 +00002533
Eric Andersen420b2082002-09-17 22:14:58 +00002534#define top_trivial_usage \
2535 "[-d <seconds>]"
2536#define top_full_usage \
2537 "top provides an view of processor activity in real time.\n" \
2538 "This utility reads the status for all processes in /proc each <seconds>\n" \
2539 "and shows the status for however many processes will fit on the screen.\n" \
2540 "This utility will not show processes that are started after program startup,\n" \
2541 "but it will show the EXIT status for and PIDs that exit while it is running."
2542
Eric Andersen7e9276b2001-02-22 01:15:47 +00002543#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002544 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002545#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002546 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002547 "Options:\n" \
2548 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002549#define touch_example_usage \
2550 "$ ls -l /tmp/foo\n" \
2551 "/bin/ls: /tmp/foo: No such file or directory\n" \
2552 "$ touch /tmp/foo\n" \
2553 "$ ls -l /tmp/foo\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002554 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002555
2556#define tr_trivial_usage \
2557 "[-cds] STRING1 [STRING2]"
2558#define tr_full_usage \
2559 "Translate, squeeze, and/or delete characters from\n" \
2560 "standard input, writing to standard output.\n\n" \
2561 "Options:\n" \
2562 "\t-c\ttake complement of STRING1\n" \
2563 "\t-d\tdelete input characters coded STRING1\n" \
2564 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002565#define tr_example_usage \
2566 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002567 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002568
Eric Andersen5c58d282001-07-10 16:29:00 +00002569#define traceroute_trivial_usage \
Eric Andersen15c03c32004-04-06 17:52:02 +00002570 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n"\
2571 "\t[-s src_addr] [-t tos] [-w wait] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00002572#define traceroute_full_usage \
2573 "trace the route ip packets follow going to \"host\"\n" \
2574 "Options:\n" \
2575 "\t-d\tset SO_DEBUG options to socket\n" \
2576 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
2577 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
2578 "\t-v\tVerbose output\n" \
2579 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
2580 "\t-p port#\tSet the base UDP port number used in probes\n" \
2581 "\t\t(default is 33434)\n" \
2582 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
2583 "\t\t(default is 3)\n" \
2584 "\t-s src_addr\tUse the following IP address as the source address\n" \
2585 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
2586 "\t\t(default 0)\n" \
2587 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
2588 "\t\t(default 3 sec.)."
2589
2590
Eric Andersen7e9276b2001-02-22 01:15:47 +00002591#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002592 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002593#define true_full_usage \
2594 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002595#define true_example_usage \
2596 "$ true\n" \
2597 "$ echo $?\n" \
2598 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002599
Eric Andersen7e9276b2001-02-22 01:15:47 +00002600#define tty_trivial_usage \
2601 ""
2602#define tty_full_usage \
2603 "Print the file name of the terminal connected to standard input.\n\n"\
2604 "Options:\n" \
2605 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002606#define tty_example_usage \
2607 "$ tty\n" \
2608 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002609
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002610#define udhcpc_trivial_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00002611 "[-fbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002612#define udhcpc_full_usage \
2613 "\t-c,\t--clientid=CLIENTID\tClient identifier\n" \
2614 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00002615 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002616 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00002617 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated.\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002618 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
2619 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated.\n" \
2620 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
2621 "\t-q,\t--quit\tQuit after obtaining lease\n" \
2622 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
2623 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
2624 "\t-v,\t--version\tDisplay version"
2625
Russ Dill61fb4892002-10-14 21:41:28 +00002626#define udhcpd_trivial_usage \
2627 "[configfile]\n" \
2628
2629#define udhcpd_full_usage \
Glenn L McGrath9130c852002-12-12 12:56:18 +00002630 ""
Russ Dill61fb4892002-10-14 21:41:28 +00002631
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002632#ifdef CONFIG_FEATURE_MOUNT_FORCE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002633 #define USAGE_MOUNT_FORCE(a) a
2634#else
2635 #define USAGE_MOUNT_FORCE(a)
2636#endif
2637#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002638 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002639#define umount_full_usage \
2640 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00002641 "\nFlags:\n" "\t-a\tUnmount all file systems" \
2642 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
2643 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00002644 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00002645 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 +00002646#define umount_example_usage \
2647 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002648
2649#define uname_trivial_usage \
2650 "[OPTION]..."
2651#define uname_full_usage \
2652 "Print certain system information. With no OPTION, same as -s.\n\n" \
2653 "Options:\n" \
2654 "\t-a\tprint all information\n" \
2655 "\t-m\tthe machine (hardware) type\n" \
2656 "\t-n\tprint the machine's network node hostname\n" \
2657 "\t-r\tprint the operating system release\n" \
2658 "\t-s\tprint the operating system name\n" \
2659 "\t-p\tprint the host processor type\n" \
2660 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002661#define uname_example_usage \
2662 "$ uname -a\n" \
Eric Andersen7f48a952003-12-28 05:06:56 +00002663 "Linux debian 2.4.23 #2 Tue Dec 23 17:09:10 MST 2003 i686 GNU/Linux\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002664
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00002665#define uncompress_trivial_usage \
2666 "[-c] [-f] [ name ... ]"
2667#define uncompress_full_usage \
2668 "Uncompress .Z file[s]\n" \
2669 "Options:\n" \
2670 "\t-c\textract to stdout\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002671 "\t-f\tforce overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00002672
Eric Andersen7e9276b2001-02-22 01:15:47 +00002673#define uniq_trivial_usage \
2674 "[OPTION]... [INPUT [OUTPUT]]"
2675#define uniq_full_usage \
2676 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00002677 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002678 "Options:\n" \
2679 "\t-c\tprefix lines by the number of occurrences\n" \
2680 "\t-d\tonly print duplicate lines\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002681 "\t-u\tonly print unique lines\n" \
2682 "\t-f N\tskip the first N fields\n" \
2683 "\t-s N\tskip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002684#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002685 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002686 "a\n" \
2687 "b\n" \
2688 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002689
2690#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002691 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002692#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002693 "Converts FILE from unix format to dos format. When no option\n" \
2694 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002695 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002696 "Options:\n" \
2697 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002698 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002699
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002700#define unzip_trivial_usage \
2701 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
2702#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002703 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002704 "Options:\n" \
2705 "\t-l\tlist archive contents (short form)\n" \
2706 "\t-n\tnever overwrite existing files (default)\n" \
2707 "\t-o\toverwrite files without prompting\n" \
2708 "\t-p\tsend output to stdout\n" \
2709 "\t-q\tbe quiet\n" \
2710 "\t-x\texclude these files\n" \
2711 "\t-d\textract files into this directory"
2712
Eric Andersen7e9276b2001-02-22 01:15:47 +00002713#define uptime_trivial_usage \
2714 ""
2715#define uptime_full_usage \
2716 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002717#define uptime_example_usage \
2718 "$ uptime\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002719 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002720
2721#define usleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002722 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002723#define usleep_full_usage \
2724 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002725#define usleep_example_usage \
2726 "$ usleep 1000000\n" \
2727 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002728
2729#define uudecode_trivial_usage \
2730 "[FILE]..."
2731#define uudecode_full_usage \
2732 "Uudecode a file that is uuencoded.\n\n" \
2733 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002734 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002735#define uudecode_example_usage \
2736 "$ uudecode -o busybox busybox.uu\n" \
2737 "$ ls -l busybox\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002738 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002739
2740#define uuencode_trivial_usage \
2741 "[OPTION] [INFILE] REMOTEFILE"
2742#define uuencode_full_usage \
2743 "Uuencode a file.\n\n" \
2744 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00002745 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002746#define uuencode_example_usage \
2747 "$ uuencode busybox busybox\n" \
2748 "begin 755 busybox\n" \
2749 "<encoded file snipped>\n" \
2750 "$ uudecode busybox busybox > busybox.uu\n" \
2751 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002752
Eric Andersen853c4942003-01-23 05:59:32 +00002753#define vconfig_trivial_usage \
2754 "COMMAND [OPTIONS] ..."
Eric Andersen853c4942003-01-23 05:59:32 +00002755#define vconfig_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002756 "vconfig lets you create and remove virtual ethernet devices.\n\n" \
2757 "Options:\n" \
2758 "\tadd [interface-name] [vlan_id]\n" \
2759 "\trem [vlan-name]\n" \
2760 "\tset_flag [interface-name] [flag-num] [0 | 1]\n" \
2761 "\tset_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
2762 "\tset_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
2763 "\tset_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00002764
Eric Andersen3f980402001-04-04 17:31:15 +00002765#define vi_trivial_usage \
2766 "[OPTION] [FILE]..."
2767#define vi_full_usage \
2768 "edit FILE.\n\n" \
2769 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002770 "\t-R\tRead-only- do not write to the file."
Eric Andersen3f980402001-04-04 17:31:15 +00002771
Eric Andersen27f64e12002-06-23 04:24:25 +00002772#define vlock_trivial_usage \
2773 "[OPTIONS]"
2774#define vlock_full_usage \
2775 "Lock a virtual terminal. A password is required to unlock\n" \
2776 "Options:\n" \
2777 "\t-a\tLock all VTs"
2778
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002779#define watch_trivial_usage \
2780 "[-n <seconds>] COMMAND..."
2781#define watch_full_usage \
2782 "Executes a program periodically.\n" \
2783 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002784 "\t-n\tLoop period in seconds - default is 2."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002785#define watch_example_usage \
2786 "$ watch date\n" \
2787 "Mon Dec 17 10:31:40 GMT 2000\n" \
2788 "Mon Dec 17 10:31:42 GMT 2000\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002789 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002790
Eric Andersen7e9276b2001-02-22 01:15:47 +00002791#define watchdog_trivial_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00002792 "[-t <seconds>] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002793#define watchdog_full_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00002794 "Periodically write to watchdog device DEV.\n" \
2795 "Options:\n" \
2796 "\t-t\tTimer period in seconds - default is 30."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002797
2798#define wc_trivial_usage \
2799 "[OPTION]... [FILE]..."
2800#define wc_full_usage \
2801 "Print line, word, and byte counts for each FILE, and a total line if\n" \
2802 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
2803 "Options:\n" \
2804 "\t-c\tprint the byte counts\n" \
2805 "\t-l\tprint the newline counts\n" \
2806 "\t-L\tprint the length of the longest line\n" \
2807 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002808#define wc_example_usage \
2809 "$ wc /etc/passwd\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002810 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002811
2812#define wget_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002813 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00002814 "\t\t[--header 'header: value'] [-Y|--proxy on/off] [-P DIR] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002815#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00002816 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002817 "Options:\n" \
2818 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00002819 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00002820 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00002821 "\t-O\tsave to filename ('-' for stdout)\n" \
2822 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002823
2824#define which_trivial_usage \
2825 "[COMMAND ...]"
2826#define which_full_usage \
2827 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002828#define which_example_usage \
2829 "$ which login\n" \
2830 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00002831
Eric Andersen00a6a752002-04-26 23:53:10 +00002832#define who_trivial_usage \
2833 " "
2834#define who_full_usage \
2835 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002836
2837#define whoami_trivial_usage \
2838 ""
2839#define whoami_full_usage \
2840 "Prints the user name associated with the current effective user id."
2841
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002842#ifdef CONFIG_FEATURE_XARGS_SUPPORT_CONFIRMATION
2843#define USAGE_XARGS_CONFIRMATION(a) a
2844#else
2845#define USAGE_XARGS_CONFIRMATION(a)
2846#endif
2847#ifdef CONFIG_FEATURE_XARGS_SUPPORT_TERMOPT
2848#define USAGE_XARGS_TERMOPT(a) a
2849#else
2850#define USAGE_XARGS_TERMOPT(a)
2851#endif
2852#ifdef CONFIG_FEATURE_XARGS_SUPPORT_ZERO_TERM
2853#define USAGE_XARGS_ZERO_TERM(a) a
2854#else
2855#define USAGE_XARGS_ZERO_TERM(a)
2856#endif
2857
2858
Eric Andersen7e9276b2001-02-22 01:15:47 +00002859#define xargs_trivial_usage \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002860 "[COMMAND] [OPTIONS] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002861#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002862 "Executes COMMAND on every item given by standard input.\n\n" \
2863 "Options:\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002864 USAGE_XARGS_CONFIRMATION("\t-p\tPrompt the user about whether to run each command\n") \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002865 "\t-r\tDo not run command for empty readed lines\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002866 USAGE_XARGS_TERMOPT("\t-x\tExit if the size is exceeded\n") \
2867 USAGE_XARGS_ZERO_TERM("\t-0\tInput filenames are terminated by a null character\n") \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002868 "\t-t\tPrint the command line on stderr before executing it."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002869#define xargs_example_usage \
2870 "$ ls | xargs gzip\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002871 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002872
2873#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002874 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002875#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002876 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002877
Eric Andersen7e9276b2001-02-22 01:15:47 +00002878#define zcat_trivial_usage \
2879 "FILE"
2880#define zcat_full_usage \
2881 "Uncompress to stdout."
Eric Andersen178de172004-04-06 16:36:20 +00002882
2883#endif /* __BB_USAGE_H__ */