blob: c53ead0c7eb64e3f3b3b35bd01c04add81d7f9f4 [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 \
Eric Andersen192c35f2004-09-02 22:22:17 +00007 "Adds a group to the system\n\n" \
Eric Andersenf349e972001-08-21 16:18:59 +00008 "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 \
Eric Andersen192c35f2004-09-02 22:22:17 +000014 "Adds a user to the system\n\n" \
Eric Andersenf349e972001-08-21 16:18:59 +000015 "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" \
Mike Frysinger6077d902005-01-07 00:56:47 +0000207 "\t-d,-P\tPreserves links\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000208 "\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" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000222 "\tv\t\tverbose\n" \
Eric Andersen6925d502001-12-16 09:23:09 +0000223 "\tu\t\tunconditional overwrite\n" \
224 "\tF\t\tinput from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000225
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000226#define crond_trivial_usage \
227 "-d[#] -c <crondir> -f -b"
228#define crond_full_usage \
229 "\t-d [#] -l [#] -S -L logfile -f -b -c dir\n" \
230 "\t-d num\tdebug level\n" \
231 "\t-l num\tlog level (8 - default)\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +0000232 "\t-S\tlog to syslogd (default)\n" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000233 "\t-L file\tlog to file\n" \
234 "\t-f\trun in fordeground\n" \
235 "\t-b\trun in background (default)\n" \
236 "\t-c dir\tworking dir"
237
238#define crontab_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000239 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000240#define crontab_full_usage \
241 "\tfile <opts> replace crontab from file\n" \
242 "\t- <opts> replace crontab from stdin\n" \
243 "\t-u user specify user\n" \
244 "\t-l [user] list crontab for user\n" \
245 "\t-e [user] edit crontab for user\n" \
246 "\t-d [user] delete crontab for user\n" \
247 "\t-c dir specify crontab directory"
248
249
Eric Andersen7e9276b2001-02-22 01:15:47 +0000250#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000251 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000252#define cut_full_usage \
253 "Prints selected fields from each input FILE to standard output.\n\n" \
254 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000255 "\t-b LIST\t\tOutput only bytes from LIST\n" \
256 "\t-c LIST\t\tOutput only characters from LIST\n" \
257 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
258 "\t-s\t\tOutput only the lines containing delimiter\n" \
259 "\t-f N\t\tPrint only these fields\n" \
260 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000261#define cut_example_usage \
262 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
263 "Hello\n" \
264 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
265 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000266
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000267#ifdef CONFIG_FEATURE_DATE_ISOFMT
268#define USAGE_DATE_ISOFMT(a) a
269#else
270#define USAGE_DATE_ISOFMT(a)
271#endif
272
Eric Andersen7e9276b2001-02-22 01:15:47 +0000273#define date_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +0000274 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000275#define date_full_usage \
276 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000277 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000278 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000279 "\t-d STRING\tDisplays time described by STRING, not `now'\n" \
280 USAGE_DATE_ISOFMT("\t-I[TIMESPEC]\tOutputs an ISO-8601 compliant date/time string.\n" \
281 "\t\t\tTIMESPEC=`date' (or missing) for date only,\n" \
282 "\t\t\t`hours', `minutes', or `seconds' for date and,\n" \
283 "\t\t\ttime to the indicated precision.\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000284 "\t-s\t\tSets time described by STRING\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000285 "\t-r FILE\t\tDisplays the last modification time of FILE\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000286 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000287#define date_example_usage \
288 "$ date\n" \
289 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000290
Eric Andersen7e9276b2001-02-22 01:15:47 +0000291#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000292 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000293#define dc_full_usage \
294 "This is a Tiny RPN calculator that understands the\n" \
Eric Andersena9287742003-10-22 11:24:39 +0000295 "following operations: +, add, -, sub, *, mul, /, div, %, mod, "\
296 "**, exp, and, or, not, eor.\n" \
297 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16.\n" \
298 "\nOptions:\n" \
Glenn L McGrath6d074322002-12-12 10:31:53 +0000299 "p - Prints the value on the top of the stack, without altering the stack.\n" \
300 "f - Prints the entire contents of the stack without altering anything.\n" \
301 "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 +0000302 " Only 10 and 16 are supported."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000303#define dc_example_usage \
Eric Andersen9ab46572004-08-18 17:57:16 +0000304 "$ dc 2 2 + p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000305 "4\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000306 "$ dc 8 8 \\* 2 2 + / p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000307 "16\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000308 "$ dc 0 1 and p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000309 "0\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000310 "$ dc 0 1 or p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000311 "1\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000312 "$ echo 72 9 div 8 mul p | dc\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000313 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000314
Eric Andersen7e9276b2001-02-22 01:15:47 +0000315#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000316 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000317 "\t [seek=N] [conv=notrunc|noerror|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000318#define dd_full_usage \
319 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000320 "\tif=FILE\t\tread from FILE instead of stdin\n" \
321 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
322 "\tbs=N\t\tread and write N bytes at a time\n" \
323 "\tcount=N\t\tcopy only N input blocks\n" \
324 "\tskip=N\t\tskip N input blocks\n" \
325 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000326 "\tconv=notrunc\tdon't truncate output file\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000327 "\tconv=noerror\tcontinue after read errors\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000328 "\tconv=sync\tpad blocks with zeros\n" \
329 "\n" \
330 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000331 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000332#define dd_example_usage \
333 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
334 "4+0 records in\n" \
335 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000336
Eric Andersen7e9276b2001-02-22 01:15:47 +0000337#define deallocvt_trivial_usage \
Glenn L McGrath17b4a202004-01-15 11:50:19 +0000338 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000339#define deallocvt_full_usage \
340 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000341
Eric Andersenf349e972001-08-21 16:18:59 +0000342#define delgroup_trivial_usage \
343 "GROUP"
344#define delgroup_full_usage \
345 "Deletes group GROUP from the system"
346
347#define deluser_trivial_usage \
348 "USER"
349#define deluser_full_usage \
350 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000351
Eric Andersenf18bd892003-12-19 11:07:59 +0000352#ifdef CONFIG_DEVFSD_FG_NP
353 #define USAGE_DEVFSD_FG_NP(a) a
354#else
355 #define USAGE_DEVFSD_FG_NP(a)
356#endif
357
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000358#define devfsd_trivial_usage \
Eric Andersenf18bd892003-12-19 11:07:59 +0000359 "mntpnt [-v]"\
360 USAGE_DEVFSD_FG_NP("[-fg][-np]" )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000361#define devfsd_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000362 "Optional daemon for managing devfs permissions and old device name symlinks.\n" \
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000363 "\nOptions:\n" \
364 "\tmntpnt\tThe mount point where devfs is mounted.\n\n" \
365 "\t-v\tPrint the protocol version numbers for devfsd\n" \
Eric Andersenf18bd892003-12-19 11:07:59 +0000366 "\t\tand the kernel-side protocol version and exits." \
367 USAGE_DEVFSD_FG_NP( "\n\n\t-fg\tRun the daemon in the foreground.\n\n" \
368 "\t-np\tExit after parsing the configuration file\n" \
369 "\t\tand processing synthetic REGISTER events.\n" \
370 "\t\tDo not poll for events.")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000371
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000372#ifdef CONFIG_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000373 #define USAGE_HUMAN_READABLE(a) a
374 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000375#else
Tim Riker7b253f82003-12-28 05:02:40 +0000376 #define USAGE_HUMAN_READABLE(a)
Eric Andersened0d9582001-02-23 13:23:03 +0000377 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000378#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000379#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000380 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000381#define df_full_usage \
382 "Print the filesystem space used and space available.\n\n" \
383 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000384 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000385 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
386 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000387 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000388 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000389#define df_example_usage \
390 "$ df\n" \
391 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
392 "/dev/sda3 8690864 8553540 137324 98% /\n" \
393 "/dev/sda1 64216 36364 27852 57% /boot\n" \
394 "$ df /dev/sda3\n" \
395 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
396 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000397
Eric Andersen7e9276b2001-02-22 01:15:47 +0000398#define dirname_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000399 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000400#define dirname_full_usage \
401 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000402#define dirname_example_usage \
403 "$ dirname /tmp/foo\n" \
404 "/tmp\n" \
405 "$ dirname /tmp/foo/\n" \
406 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000407
Eric Andersen7e9276b2001-02-22 01:15:47 +0000408#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000409 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000410#define dmesg_full_usage \
411 "Prints or controls the kernel ring buffer\n\n" \
412 "Options:\n" \
413 "\t-c\t\tClears the ring buffer's contents after printing\n" \
414 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000415 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000416
Eric Andersen7e9276b2001-02-22 01:15:47 +0000417#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000418 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000419#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000420 "Converts FILE from dos format to unix format. When no option\n" \
421 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000422 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000423 "Options:\n" \
424 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000425 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000426
Eric Andersen7e9276b2001-02-22 01:15:47 +0000427#define dpkg_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000428 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000429#define dpkg_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000430 "dpkg is a utility to install, remove and manage Debian packages.\n\n" \
431 "Options:\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000432 "\t-i\t\tInstall the package\n" \
433 "\t-l\t\tList of installed packages\n" \
434 "\t-C\t\tConfigure an unpackaged package\n" \
435 "\t-F depends\tIgnore depency problems\n" \
436 "\t-P\t\tPurge all files of a package\n" \
437 "\t-r\t\tRemove all but the configuration files for a package\n" \
438 "\t-u\t\tUnpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000439
Eric Andersen7e9276b2001-02-22 01:15:47 +0000440#define dpkg_deb_trivial_usage \
Glenn L McGrathcbc453c2004-05-02 03:01:08 +0000441 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000442#define dpkg_deb_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000443 "Perform actions on Debian packages (.debs)\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000444 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000445 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000446 "\t-e\tExtract control files to [argument] directory\n" \
447 "\t-f\tDisplay control field name starting with [argument]\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000448 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000449 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000450#define dpkg_deb_example_usage \
451 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000452
Manuel Novoa III cad53642003-03-19 09:13:01 +0000453#ifdef CONFIG_FEATURE_DU_DEFALT_BLOCKSIZE_1K
454#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a) a
455#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a)
456#else
457#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a)
458#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a) a
459#endif
460
Eric Andersen7e9276b2001-02-22 01:15:47 +0000461#define du_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000462 "[-aHLdclsx" USAGE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000463#define du_full_usage \
464 "Summarizes disk space used for each FILE and/or directory.\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000465 "Disk space is printed in units of " \
466 USAGE_DU_DEFALT_BLOCKSIZE_1k("1024") USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k("512") \
467 " bytes.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000468 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000469 "\t-a\tshow sizes of files in addition to directories\n" \
470 "\t-H\tfollow symbolic links that are FILE command line args\n" \
471 "\t-L\tfollow all symbolic links encountered\n" \
472 "\t-d N\tlimit output to directories (and files with -a) of depth < N\n" \
473 "\t-c\toutput a grand total\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000474 "\t-l\tcount sizes many times if hard linked\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000475 "\t-s\tdisplay only a total for each argument\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000476 "\t-x\tskip directories on different filesystems\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000477 USAGE_HUMAN_READABLE( \
478 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
479 "\t-m\tprint sizes in megabytes\n" ) \
480 "\t-k\tprint sizes in kilobytes" USAGE_DU_DEFALT_BLOCKSIZE_1k("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000481#define du_example_usage \
482 "$ du\n" \
483 "16 ./CVS\n" \
484 "12 ./kernel-patches/CVS\n" \
485 "80 ./kernel-patches\n" \
486 "12 ./tests/CVS\n" \
487 "36 ./tests\n" \
488 "12 ./scripts/CVS\n" \
489 "16 ./scripts\n" \
490 "12 ./docs/CVS\n" \
491 "104 ./docs\n" \
492 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000493
Eric Andersen7e9276b2001-02-22 01:15:47 +0000494#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000495 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000496#define dumpkmap_full_usage \
497 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000498#define dumpkmap_example_usage \
499 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000500
Russ Dill61fb4892002-10-14 21:41:28 +0000501#define dumpleases_trivial_usage \
502 "[-r|-a] [-f LEASEFILE]"
503#define dumpleases_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000504 "Displays the DHCP leases granted by udhcpd.\n\n" \
505 "Options:\n" \
Russ Dill61fb4892002-10-14 21:41:28 +0000506 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +0000507 "\t-r,\t--remaining\tInterpret lease times as time remaing\n" \
508 "\t-a,\t--absolute\tInterpret lease times as expire time"
Russ Dill61fb4892002-10-14 21:41:28 +0000509
Manuel Novoa III cad53642003-03-19 09:13:01 +0000510#ifdef CONFIG_FEATURE_FANCY_ECHO
511 #define USAGE_FANCY_ECHO(a) a
512#else
Tim Riker7b253f82003-12-28 05:02:40 +0000513 #define USAGE_FANCY_ECHO(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +0000514#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000515
Eric Andersen7e9276b2001-02-22 01:15:47 +0000516#define echo_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000517 USAGE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000518#define echo_full_usage \
519 "Prints the specified ARGs to stdout\n\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000520 USAGE_FANCY_ECHO("Options:\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000521 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000522 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000523 "\t-E\tdisable interpretation of backslash-escaped characters")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000524#define echo_example_usage \
525 "$ echo "Erik is cool"\n" \
526 "Erik is cool\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000527 USAGE_FANCY_ECHO("$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000528 "Erik\n" \
529 "is\n" \
530 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000531 "$ echo "Erik\\nis\\ncool"\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000532 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000533
Eric Andersen84e229c2001-03-29 22:48:33 +0000534#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000535 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000536#define env_full_usage \
537 "Prints the current environment or runs a program after setting\n" \
538 "up the specified environment.\n\n" \
539 "Options:\n" \
540 "\t-, -i\tstart with an empty environment\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000541 "\t-u\tremove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000542
Eric Andersen7e9276b2001-02-22 01:15:47 +0000543#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000544 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000545#define expr_full_usage \
546 "Prints the value of EXPRESSION to standard output.\n\n" \
547 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000548 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
549 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
550 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
551 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
552 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
553 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
554 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
555 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
556 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
557 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
558 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
559 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
560 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000561 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
562 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
563 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
564 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
565 "\t or 0\n" \
566 "\tlength STRING length of STRING\n" \
567 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
568 "\t it is a keyword like `match' or an\n" \
569 "\t operator like `/'\n" \
570 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000571 "Beware that many operators need to be escaped or quoted for shells.\n" \
572 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
573 "lexicographical. Pattern matches return the string matched between \n" \
574 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
575 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000576
Eric Andersen7e9276b2001-02-22 01:15:47 +0000577#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000578 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000579#define false_full_usage \
580 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000581#define false_example_usage \
582 "$ false\n" \
583 "$ echo $?\n" \
584 "1\n"
585
586#define fbset_trivial_usage \
587 "[options] [mode]"
588#define fbset_full_usage \
589 "Show and modify frame buffer settings"
590#define fbset_example_usage \
591 "$ fbset\n" \
592 "mode "1024x768-76"\n" \
593 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
594 "\tgeometry 1024 768 1024 768 16\n" \
595 "\ttimings 12714 128 32 16 4 128 4\n" \
596 "\taccel false\n" \
597 "\trgba 5/11,6/5,5/0,0/0\n" \
598 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000599
Eric Andersen7e9276b2001-02-22 01:15:47 +0000600#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000601 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000602#define fdflush_full_usage \
603 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000604
Eric Andersen01c3d402003-07-05 07:51:31 +0000605#define fdformat_trivial_usage \
606 "[-n] DEVICE"
607#define fdformat_full_usage \
608 "Low-level formats a floppy disk\n\n" \
609 "Options:\n" \
610 "\t-n\tDon't verify after format"
611
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000612#define fdisk_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000613 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000614#define fdisk_full_usage \
615 "Change partition table\n" \
616 "Options:\n" \
Eric Andersena151d192004-04-06 17:16:36 +0000617 "\t-l List partition table(s)\n" \
618 "\t-u Give Start and End in sector (instead of cylinder) units\n" \
619 "\t-s PARTITION Give partition size(s) in blocks\n" \
620 "\t-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000621 "\t-C CYLINDERS Set the number of cylinders\n" \
622 "\t-H HEADS Set the number of heads\n" \
623 "\t-S SECTORS Set the number of sectors\n" \
Eric Andersena151d192004-04-06 17:16:36 +0000624 "\t-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000625
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000626#ifdef CONFIG_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000627 #define USAGE_FIND_TYPE(a) a
628#else
629 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000630#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000631#ifdef CONFIG_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000632 #define USAGE_FIND_PERM(a) a
633#else
634 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000635#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000636#ifdef CONFIG_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000637 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000638#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000639 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000640#endif
Eric Andersen97d86f22003-01-23 05:27:42 +0000641#ifdef CONFIG_FEATURE_FIND_NEWER
642 #define USAGE_FIND_NEWER(a) a
643#else
644 #define USAGE_FIND_NEWER(a)
645#endif
646#ifdef CONFIG_FEATURE_FIND_INUM
647 #define USAGE_FIND_INUM(a) a
648#else
649 #define USAGE_FIND_INUM(a)
650#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000651
Eric Andersen7e9276b2001-02-22 01:15:47 +0000652#define find_trivial_usage \
653 "[PATH...] [EXPRESSION]"
654#define find_full_usage \
655 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000656 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000657 "\nEXPRESSION may consist of:\n" \
658 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000659 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000660 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000661 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000662 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
663) USAGE_FIND_PERM( \
664 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
665) USAGE_FIND_MTIME( \
Eric Andersen97d86f22003-01-23 05:27:42 +0000666 "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \
667) USAGE_FIND_NEWER( \
668 "\n\t-newer FILE\tModified time is more recent than FILE's" \
669) USAGE_FIND_INUM( \
670 "\n\t-inum N\t\tFile has inode number N")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000671#define find_example_usage \
Eric Andersen75eb90f2004-03-29 08:20:08 +0000672 "$ find / -name passwd\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000673 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000674
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000675#define fold_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +0000676 "[-bsw] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000677#define fold_full_usage \
678 "Wrap input lines in each FILE (standard input by default), writing to\n" \
679 "standard output.\n\n" \
680 "Options:\n" \
681 "\t-b\tcount bytes rather than columns\n" \
682 "\t-s\tbreak at spaces\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000683 "\t-w\tuse WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000684
Eric Andersen7e9276b2001-02-22 01:15:47 +0000685#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000686 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000687#define free_full_usage \
688 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000689#define free_example_usage \
690 "$ free\n" \
691 " total used free shared buffers\n" \
692 " Mem: 257628 248724 8904 59644 93124\n" \
693 " Swap: 128516 8404 120112\n" \
694 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000695
Eric Andersen7e9276b2001-02-22 01:15:47 +0000696#define freeramdisk_trivial_usage \
697 "DEVICE"
698#define freeramdisk_full_usage \
699 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000700#define freeramdisk_example_usage \
701 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000702
703#define fsck_minix_trivial_usage \
704 "[-larvsmf] /dev/name"
705#define fsck_minix_full_usage \
706 "Performs a consistency check for MINIX filesystems.\n\n" \
707 "Options:\n" \
708 "\t-l\tLists all filenames\n" \
709 "\t-r\tPerform interactive repairs\n" \
710 "\t-a\tPerform automatic repairs\n" \
711 "\t-v\tverbose\n" \
712 "\t-s\tOutputs super-block information\n" \
713 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
714 "\t-f\tForce file system check."
715
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000716#define ftpget_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000717 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000718#define ftpget_full_usage \
719 "Retrieve a remote file via FTP.\n\n" \
720 "Options:\n" \
721 "\t-c, --continue Continue a previous transfer\n" \
722 "\t-v, --verbose Verbose\n" \
723 "\t-u, --username Username to be used\n" \
724 "\t-p, --password Password to be used\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000725 "\t-P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000726
727#define ftpput_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000728 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000729#define ftpput_full_usage \
730 "Store a local file on a remote machine via FTP.\n\n" \
731 "Options:\n" \
732 "\t-v, --verbose Verbose\n" \
733 "\t-u, --username Username to be used\n" \
734 "\t-p, --password Password to be used\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000735 "\t-P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000736
Eric Andersen7e9276b2001-02-22 01:15:47 +0000737#define getopt_trivial_usage \
738 "[OPTIONS]..."
739#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000740 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000741 "\t-a, --alternative Allow long options starting with single -\n" \
742 "\t-l, --longoptions=longopts Long options to be recognized\n" \
743 "\t-n, --name=progname The name under which errors are reported\n" \
744 "\t-o, --options=optstring Short options to be recognized\n" \
745 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
746 "\t-Q, --quiet-output No normal output\n" \
747 "\t-s, --shell=shell Set shell quoting conventions\n" \
748 "\t-T, --test Test for getopt(1) version\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000749 "\t-u, --unquoted Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000750#define getopt_example_usage \
751 "$ cat getopt.test\n" \
752 "#!/bin/sh\n" \
753 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
754 " -n 'example.busybox' -- "$@"`\n" \
755 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
756 "eval set -- "$GETOPT"\n" \
757 "while true ; do\n" \
758 " case $1 in\n" \
759 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000760 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000761 " -c|--c-long)\n" \
762 " case "$2" in\n" \
763 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000764 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000765 " esac ;;\n" \
766 " --) shift ; break ;;\n" \
767 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
768 " esac\n" \
769 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000770
Eric Andersenf349e972001-08-21 16:18:59 +0000771#define getty_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000772 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +0000773#define getty_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +0000774 "Opens a tty, prompts for a login name, then invokes /bin/login\n\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000775 "Options:\n" \
776 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
777 "\t-i\t\tDo not display /etc/issue before running login.\n" \
778 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
779 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
780 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
Glenn L McGrath49e74ef2003-05-13 14:59:07 +0000781 "\t-n\t\tDo not prompt the user for a login name.\n" \
782 "\t-f issue_file\tDisplay issue_file instead of /etc/issue.\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000783 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
784 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
785 "\t-I initstring\tSets the init string to send before anything else.\n" \
786 "\t-H login_host\tLog login_host into the utmp file as the hostname."
787
788
Eric Andersen7e9276b2001-02-22 01:15:47 +0000789#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000790 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000791#define grep_full_usage \
792 "Search for PATTERN in each FILE or standard input.\n\n" \
793 "Options:\n" \
794 "\t-H\tprefix output lines with filename where match was found\n" \
795 "\t-h\tsuppress the prefixing filename on output\n" \
796 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000797 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000798 "\t-n\tprint line number with output lines\n" \
799 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
800 "\t-v\tselect non-matching lines\n" \
801 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000802#define grep_example_usage \
803 "$ grep root /etc/passwd\n" \
804 "root:x:0:0:root:/root:/bin/bash\n" \
805 "$ grep ^[rR]oo. /etc/passwd\n" \
806 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000807
Eric Andersen7e9276b2001-02-22 01:15:47 +0000808#define gunzip_trivial_usage \
809 "[OPTION]... FILE"
810#define gunzip_full_usage \
811 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
812 "Options:\n" \
813 "\t-c\tWrite output to standard output\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000814 "\t-f\tForce read when source is a terminal\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000815 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000816#define gunzip_example_usage \
817 "$ ls -la /tmp/BusyBox*\n" \
818 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
819 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
820 "$ ls -la /tmp/BusyBox*\n" \
821 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000822
823#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000824 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000825#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000826 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000827 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000828 "Options:\n" \
829 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000830 "\t-d\tDecompress\n" \
831 "\t-f\tForce write when destination is a terminal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000832#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000833 "$ ls -la /tmp/busybox*\n" \
834 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
835 "$ gzip /tmp/busybox.tar\n" \
836 "$ ls -la /tmp/busybox*\n" \
837 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000838
839#define halt_trivial_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +0000840 "[-d<delay>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000841#define halt_full_usage \
Glenn L McGrathd2501672004-07-23 05:16:17 +0000842 "Halt the system.\n" \
843 "Options:\n" \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +0000844 "\t-d\t\tdelay interval for halting."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000845
Eric Andersen3443bd72003-07-22 07:30:36 +0000846#ifdef CONFIG_FEATURE_HDPARM_GET_IDENTITY
847#define USAGE_HDPARM_IDENT(a) a
848#else
849#define USAGE_HDPARM_IDENT(a)
850#endif
851
852#ifdef CONFIG_FEATURE_HDPARM_HDIO_SCAN_HWIF
853#define USAGE_SCAN_HWIF(a) a
854#else
855#define USAGE_SCAN_HWIF(a)
856#endif
857
858#ifdef CONFIG_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF
859#define USAGE_UNREGISTER_HWIF(a) a
860#else
861#define USAGE_UNREGISTER_HWIF(a)
862#endif
863
864#ifdef CONFIG_FEATURE_HDPARM_HDIO_DRIVE_RESET
865#define USAGE_DRIVE_RESET(a) a
866#else
867#define USAGE_DRIVE_RESET(a)
868#endif
869
870#ifdef CONFIG_FEATURE_HDPARM_HDIO_TRISTATE_HWIF
871#define USAGE_TRISTATE_HWIF(a) a
872#else
873#define USAGE_TRISTATE_HWIF(a)
874#endif
875
Eric Andersen0a57a792003-08-06 08:57:35 +0000876#ifdef CONFIG_FEATURE_HDPARM_HDIO_GETSET_DMA
877#define USAGE_GETSET_DMA(a) a
878#else
879#define USAGE_GETSET_DMA(a)
880#endif
881
Eric Andersen3443bd72003-07-22 07:30:36 +0000882#define hdparm_trivial_usage \
883 "[options] [device] .."
884#define hdparm_full_usage \
885 "Options:" \
Eric Andersen15c03c32004-04-06 17:52:02 +0000886 "\t-a get/set fs readahead\n" \
887 "\t-A set drive read-lookahead flag (0/1)\n" \
888 "\t-b get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
889 "\t-B set Advanced Power Management setting (1-255)\n" \
890 "\t-c get/set IDE 32-bit IO setting\n" \
891 "\t-C check IDE power mode status\n" \
892 USAGE_GETSET_DMA("\t-d get/set using_dma flag\n") \
893 "\t-D enable/disable drive defect-mgmt\n" \
894 "\t-f flush buffer cache for device on exit\n" \
895 "\t-g display drive geometry\n" \
896 "\t-h display terse usage information\n" \
897 "\t-i display drive identification\n" \
898 USAGE_HDPARM_IDENT("\t-I detailed/current information directly from drive\n") \
899 USAGE_HDPARM_IDENT("\t-Istdin similar to -I, but wants /proc/ide/" "*" "/hd?/identify as input\n") \
900 "\t-k get/set keep_settings_over_reset flag (0/1)\n" \
901 "\t-K set drive keep_features_over_reset flag (0/1)\n" \
902 "\t-L set drive doorlock (0/1) (removable harddisks only)\n" \
903 "\t-m get/set multiple sector count\n" \
904 "\t-n get/set ignore-write-errors flag (0/1)\n" \
905 "\t-p set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
906 "\t-P set drive prefetch count\n" \
907 "\t-q change next setting quietly\n" \
908 "\t-Q get/set DMA tagged-queuing depth (if supported)\n" \
909 "\t-r get/set readonly flag (DANGEROUS to set)\n" \
910 USAGE_SCAN_HWIF("\t-R register an IDE interface (DANGEROUS)\n") \
911 "\t-S set standby (spindown) timeout\n" \
912 "\t-t perform device read timings\n" \
913 "\t-T perform cache read timings\n" \
914 "\t-u get/set unmaskirq flag (0/1)\n" \
915 USAGE_UNREGISTER_HWIF("\t-U un-register an IDE interface (DANGEROUS)\n") \
916 "\t-v defaults; same as -mcudkrag for IDE drives\n" \
917 "\t-V display program version and exit immediately\n" \
918 USAGE_DRIVE_RESET("\t-w perform device reset (DANGEROUS)\n") \
919 "\t-W set drive write-caching flag (0/1) (DANGEROUS)\n" \
920 USAGE_TRISTATE_HWIF("\t-x tristate device for hotswap (0/1) (DANGEROUS)\n") \
921 "\t-X set IDE xfer mode (DANGEROUS)\n" \
922 "\t-y put IDE drive in standby mode\n" \
923 "\t-Y put IDE drive to sleep\n" \
924 "\t-Z disable Seagate auto-powersaving mode\n" \
925 "\t-z re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +0000926
Manuel Novoa III cad53642003-03-19 09:13:01 +0000927#ifdef CONFIG_FEATURE_FANCY_HEAD
928#define USAGE_FANCY_HEAD(a) a
929#else
930#define USAGE_FANCY_HEAD(a)
931#endif
932
Eric Andersen7e9276b2001-02-22 01:15:47 +0000933#define head_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000934 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000935#define head_full_usage \
936 "Print first 10 lines of each FILE to standard output.\n" \
937 "With more than one FILE, precede each with a header giving the\n" \
938 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000939 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000940 "\t-n NUM\t\tPrint first NUM lines instead of first 10" \
941 USAGE_FANCY_HEAD( \
942 "\n\t-c NUM\t\toutput the first NUM bytes\n" \
943 "\t-q\t\tnever output headers giving file names\n" \
944 "\t-v\t\talways output headers giving file names" )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000945#define head_example_usage \
946 "$ head -n 2 /etc/passwd\n" \
947 "root:x:0:0:root:/root:/bin/bash\n" \
948 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000949
Glenn L McGrath60281112001-11-02 11:39:46 +0000950#define hexdump_trivial_usage \
951 "[-[bcdefnosvx]] [OPTION] FILE"
952#define hexdump_full_usage \
953 "The hexdump utility is a filter which displays the specified files,\n" \
954 "or the standard input, if no files are specified, in a user specified\n"\
955 "format\n" \
956 "\t-b\t\tOne-byte octal display\n" \
957 "\t-c\t\tOne-byte character display\n" \
958 "\t-d\t\tTwo-byte decimal display\n" \
959 "\t-e FORMAT STRING\n" \
960 "\t-f FORMAT FILE\n" \
961 "\t-n LENGTH\tInterpret only length bytes of input\n" \
962 "\t-o\t\tTwo-byte octal display\n" \
963 "\t-s OFFSET\tSkip offset byte\n" \
964 "\t-v\t\tdisplay all input data\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000965 "\t-x\t\tTwo-byte hexadecimal display"
Glenn L McGrath60281112001-11-02 11:39:46 +0000966
Eric Andersen7e9276b2001-02-22 01:15:47 +0000967#define hostid_trivial_usage \
968 ""
969#define hostid_full_usage \
970 "Print out a unique 32-bit identifier for the machine."
971
972#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000973 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000974#define hostname_full_usage \
975 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000976 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000977 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +0000978 "\t-s\tShort\n" \
979 "\t-i\tAddresses for the hostname\n" \
980 "\t-d\tDNS domain name\n" \
981 "\t-f\tFully qualified domain name\n" \
982 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000983#define hostname_example_usage \
984 "$ hostname\n" \
Eric Andersen08f59e32004-03-12 22:07:10 +0000985 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +0000986
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000987#ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH
988 #define USAGE_HTTPD_BASIC_AUTH(a) a
Eric Andersen40520512003-07-28 09:59:05 +0000989 #ifdef CONFIG_FEATURE_HTTPD_AUTH_MD5
990 #define USAGE_HTTPD_AUTH_MD5(a) a
991 #else
992 #define USAGE_HTTPD_AUTH_MD5(a)
993 #endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +0000994#else
995 #define USAGE_HTTPD_BASIC_AUTH(a)
Eric Andersen40520512003-07-28 09:59:05 +0000996 #define USAGE_HTTPD_AUTH_MD5(a)
997#endif
998#ifdef CONFIG_FEATURE_HTTPD_USAGE_FROM_INETD_ONLY
999 #define USAGE_HTTPD_STANDALONE(a)
1000 #define USAGE_HTTPD_SETUID(a)
1001#else
1002 #define USAGE_HTTPD_STANDALONE(a) a
1003 #ifdef CONFIG_FEATURE_HTTPD_SETUID
1004 #define USAGE_HTTPD_SETUID(a) a
1005 #else
1006 #define USAGE_HTTPD_SETUID(a)
1007 #endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001008#endif
1009#define httpd_trivial_usage \
Eric Andersen40520512003-07-28 09:59:05 +00001010 "[-c <conf file>]" \
1011 USAGE_HTTPD_STANDALONE(" [-p <port>]") \
1012 USAGE_HTTPD_SETUID(" [-u user]") \
1013 USAGE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
1014 USAGE_HTTPD_AUTH_MD5(" [-m pass]") \
Eric Andersen73afd892004-04-14 17:59:21 +00001015 " [-h home]" \
Eric Andersen40520512003-07-28 09:59:05 +00001016 " [-d/-e <string>]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001017#define httpd_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001018 "Listens for incoming http server requests.\n\n"\
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001019 "Options:\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001020 "\t-c FILE\t\tSpecifies configuration file. (default httpd.conf)\n" \
Eric Andersen40520512003-07-28 09:59:05 +00001021 USAGE_HTTPD_STANDALONE("\t-p PORT\tServer port (default 80)\n") \
Eric Andersenaff114c2004-04-14 17:51:38 +00001022 USAGE_HTTPD_SETUID("\t-u USER\tSet uid to USER after listening privileges port\n") \
Eric Andersen40520512003-07-28 09:59:05 +00001023 USAGE_HTTPD_BASIC_AUTH("\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
Eric Andersena151d192004-04-06 17:16:36 +00001024 USAGE_HTTPD_AUTH_MD5("\t-m PASS\t\tCrypt PASS with md5 algorithm\n") \
Eric Andersen73afd892004-04-14 17:59:21 +00001025 "\t-h HOME \tSpecifies http HOME directory (default ./)\n" \
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001026 "\t-e STRING\tHtml encode STRING\n" \
Eric Andersen40520512003-07-28 09:59:05 +00001027 "\t-d STRING\tURL decode STRING"
1028
Robert Griebl1cd04452002-07-21 16:50:49 +00001029#define hwclock_trivial_usage \
1030 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
1031#define hwclock_full_usage \
1032 "Query and set the hardware clock (RTC)\n\n" \
1033 "Options:\n" \
1034 "\t-r\tread hardware clock and print result\n" \
1035 "\t-s\tset the system time from the hardware clock\n" \
1036 "\t-w\tset the hardware clock to the current system time\n" \
1037 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
1038 "\t-l\tthe hardware clock is kept in local time"
1039
Eric Andersen9e480452003-07-03 10:07:04 +00001040#ifdef CONFIG_SELINUX
Eric Andersen15c03c32004-04-06 17:52:02 +00001041 #define USAGE_SELINUX(a) a
Eric Andersen9e480452003-07-03 10:07:04 +00001042#else
Eric Andersen15c03c32004-04-06 17:52:02 +00001043 #define USAGE_SELINUX(a)
Eric Andersen9e480452003-07-03 10:07:04 +00001044#endif
1045
Eric Andersen7e9276b2001-02-22 01:15:47 +00001046#define id_trivial_usage \
1047 "[OPTIONS]... [USERNAME]"
1048#define id_full_usage \
1049 "Print information for USERNAME or the current user\n\n" \
1050 "Options:\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001051 USAGE_SELINUX("\t-c\tprints only the security context\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001052 "\t-g\tprints only the group ID\n" \
1053 "\t-u\tprints only the user ID\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001054 "\t-n\tprint a name instead of a number\n" \
1055 "\t-r\tprints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001056#define id_example_usage \
1057 "$ id\n" \
1058 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001059
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001060#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001061 #define USAGE_SIOCSKEEPALIVE(a) a
1062#else
1063 #define USAGE_SIOCSKEEPALIVE(a)
1064#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001065#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001066 #define USAGE_IFCONFIG_MII(a) a
1067#else
1068 #define USAGE_IFCONFIG_MII(a)
1069#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001070#ifdef CONFIG_FEATURE_IFCONFIG_HW
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001071 #define USAGE_IFCONFIG_HW(a) a
1072#else
1073 #define USAGE_IFCONFIG_HW(a)
1074#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001075#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001076 #define USAGE_IFCONFIG_OPT_A(a) a
1077#else
1078 #define USAGE_IFCONFIG_OPT_A(a)
1079#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +00001080#ifdef CONFIG_FEATURE_IPV6
1081 #define USAGE_IPV6(a) a
1082#else
1083 #define USAGE_IPV6(a)
1084#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001085
Eric Andersen7e9276b2001-02-22 01:15:47 +00001086#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001087 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001088#define ifconfig_full_usage \
1089 "configure a network interface\n\n" \
1090 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +00001091 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
1092 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001093 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001094 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001095 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001096 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
1097 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001098 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001099 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
1100 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001101 "\t[up|down] ..."
1102
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001103#define ifup_trivial_usage \
1104 "<-ahinv> <ifaces...>"
1105#define ifup_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001106 "ifup <options> <ifaces...>\n\n" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001107 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001108 "\t-h\tthis help\n" \
1109 "\t-a\tde/configure all interfaces automatically\n" \
1110 "\t-i FILE\tuse FILE for interface definitions\n" \
1111 "\t-n\tprint out what would happen, but don't do it\n" \
1112 "\t\t\t(note that this option doesn't disable mappings)\n" \
1113 "\t-v\tprint out what would happen before doing it\n" \
1114 "\t-m\tdon't run any mappings\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001115 "\t-f\tforce de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001116
1117#define ifdown_trivial_usage \
1118 "<-ahinv> <ifaces...>"
1119#define ifdown_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001120 "ifdown <options> <ifaces...>\n\n" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001121 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001122 "\t-h\tthis help\n" \
1123 "\t-a\tde/configure all interfaces automatically\n" \
1124 "\t-i FILE\tuse FILE for interface definitions\n" \
1125 "\t-n\tprint out what would happen, but don't do it\n" \
1126 "\t\t(note that this option doesn't disable mappings)\n" \
1127 "\t-v\tprint out what would happen before doing it\n" \
1128 "\t-m\tdon't run any mappings\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001129 "\t-f\tforce de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001130
Glenn L McGrath06e95652003-02-09 06:51:14 +00001131#define inetd_trivial_usage \
1132 "[-q len] [conf]"
1133#define inetd_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001134 "Listens for network connections and launches programs\n\n" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001135 "Option:\n" \
1136 "\t-q\tSets the size of the socket listen queue to\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001137 "\t\tthe specified value. Default is 128."
Glenn L McGrath06e95652003-02-09 06:51:14 +00001138
Eric Andersen7e9276b2001-02-22 01:15:47 +00001139#define init_trivial_usage \
1140 ""
1141#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001142 "Init is the parent of all processes."
1143#define init_notes_usage \
1144"This version of init is designed to be run only by the kernel.\n" \
1145"\n" \
1146"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
1147"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
1148"runlevels, use sysvinit.\n" \
1149"\n" \
1150"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
1151"it has the following default behavior:\n" \
1152"\n" \
1153" ::sysinit:/etc/init.d/rcS\n" \
1154" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001155" ::ctrlaltdel:/sbin/reboot\n" \
1156" ::shutdown:/sbin/swapoff -a\n" \
1157" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001158" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001159"\n" \
1160"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1161"\n" \
1162" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001163" tty3::askfirst:/bin/sh\n" \
1164" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001165"\n" \
1166"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1167"\n" \
1168" <id>:<runlevels>:<action>:<process>\n" \
1169"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001170" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001171"\n" \
1172" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1173" The id field is used by BusyBox init to specify the controlling tty for\n" \
1174" the specified process to run on. The contents of this field are\n" \
1175" appended to "/dev/" and used as-is. There is no need for this field to\n" \
1176" be unique, although if it isn't you may have strange results. If this\n" \
1177" field is left blank, the controlling tty is set to the console. Also\n" \
1178" note that if BusyBox detects that a serial console is in use, then only\n" \
1179" entries whose controlling tty is either the serial console or /dev/null\n" \
1180" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1181" stinkin' utmp.\n" \
1182"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001183" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001184"\n" \
1185" The runlevels field is completely ignored.\n" \
1186"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001187" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001188"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001189" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001190" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001191"\n" \
1192" The available actions can be classified into two groups: actions\n" \
1193" that are run only once, and actions that are re-run when the specified\n" \
1194" process exits.\n" \
1195"\n" \
1196" Run only-once actions:\n" \
1197"\n" \
1198" 'sysinit' is the first item run on boot. init waits until all\n" \
1199" sysinit actions are completed before continuing. Following the\n" \
1200" completion of all sysinit actions, all 'wait' actions are run.\n" \
1201" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001202" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001203" therefore, init does not wait for them to complete. 'restart' is\n" \
1204" the action taken to restart the init process. By default this should\n" \
1205" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1206" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001207" actions are run when the system detects that someone on the system\n" \
1208" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1209" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1210" Finally the 'shutdown' action specifies the actions to taken when\n" \
1211" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1212" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001213"\n" \
1214" Run repeatedly actions:\n" \
1215"\n" \
1216" 'respawn' actions are run after the 'once' actions. When a process\n" \
1217" started with a 'respawn' action exits, init automatically restarts\n" \
1218" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1219" respawning out of control. The 'askfirst' actions acts just like\n" \
1220" respawn, except that before running the specified process it\n" \
1221" displays the line "Please press Enter to activate this console."\n" \
1222" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001223" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001224"\n" \
1225" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1226" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001227" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001228"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001229" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001230"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001231" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001232"\n" \
1233"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001234"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001235" # This is run first except when booting in single-user mode.\n" \
1236" #\n" \
1237" ::sysinit:/etc/init.d/rcS\n" \
1238" \n" \
1239" # /bin/sh invocations on selected ttys\n" \
1240" #\n" \
1241" # Start an "askfirst" shell on the console (whatever that may be)\n" \
1242" ::askfirst:-/bin/sh\n" \
1243" # Start an "askfirst" shell on /dev/tty2-4\n" \
1244" tty2::askfirst:-/bin/sh\n" \
1245" tty3::askfirst:-/bin/sh\n" \
1246" tty4::askfirst:-/bin/sh\n" \
1247" \n" \
1248" # /sbin/getty invocations for selected ttys\n" \
1249" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001250" tty4::respawn:/sbin/getty 38400 tty4\n" \
1251" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001252" \n" \
1253" \n" \
1254" # Example of how to put a getty on a serial line (for a terminal)\n" \
1255" #\n" \
1256" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1257" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1258" #\n" \
1259" # Example how to put a getty on a modem line.\n" \
1260" #::respawn:/sbin/getty 57600 ttyS2\n" \
1261" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001262" # Stuff to do when restarting the init process\n" \
1263" ::restart:/sbin/init\n" \
1264" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001265" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001266" ::ctrlaltdel:/sbin/reboot\n" \
1267" ::shutdown:/bin/umount -a -r\n" \
1268" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001269
Eric Andersenbe65c352003-01-23 04:57:35 +00001270#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
1271 #define USAGE_INSMOD_MAP(a) a
1272#else
1273 #define USAGE_INSMOD_MAP(a)
1274#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001275#define insmod_trivial_usage \
1276 "[OPTION]... MODULE [symbol=value]..."
1277#define insmod_full_usage \
1278 "Loads the specified kernel modules into the kernel.\n\n" \
1279 "Options:\n" \
1280 "\t-f\tForce module to load into the wrong kernel version.\n" \
1281 "\t-k\tMake module autoclean-able.\n" \
1282 "\t-v\tverbose output\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001283 "\t-q\tquiet output\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001284 "\t-L\tLock to prevent simultaneous loads of a module\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001285 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout\n") \
Eric Andersen957879a2004-04-07 15:07:55 +00001286 "\t-o NAME\tSet internal module name to NAME\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001287 "\t-x\tdo not export externs"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001288
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001289#define install_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001290 "[-cgmops] [sources] <dest|directory>"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001291#define install_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001292 "Copies files and set attributes\n\n" \
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001293 "Options:\n" \
1294 "\t-c\tcopy the file, default\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001295 "\t-d\tcreate directories\n" \
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001296 "\t-g\tset group ownership\n" \
1297 "\t-m\tset permission modes\n" \
1298 "\t-o\tset ownership\n" \
1299 "\t-p\tpreserve date\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001300 "\t-s\tstrip symbol tables"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001301
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001302#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001303 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001304#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001305 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1306 "where OBJECT := { link | addr | route | tunnel }\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001307 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001308
1309#define ipaddr_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001310 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
1311 "\t\t[ dev STRING ] [ to PREFIX ] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001312#define ipaddr_full_usage \
1313 "ipaddr {add|del} IFADDR dev STRING\n" \
1314 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001315 "\t\t\t[ to PREFIX ] [ label PATTERN ]\n" \
1316 "\t\t\tIFADDR := PREFIX | ADDR peer PREFIX\n" \
1317 "\t\t\t[ broadcast ADDR ] [ anycast ADDR ]\n" \
1318 "\t\t\t[ label STRING ] [ scope SCOPE-ID ]\n" \
1319 "\t\t\tSCOPE-ID := [ host | link | global | NUMBER ]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001320
Eric Andersen3561b012004-04-13 19:27:20 +00001321#ifdef CONFIG_FEATURE_IPCALC_FANCY
1322 #define XUSAGE_IPCALC_FANCY(a) a
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001323#else
Eric Andersen3561b012004-04-13 19:27:20 +00001324 #define XUSAGE_IPCALC_FANCY(a)
1325#endif
Eric Andersende4f07e2003-12-11 01:18:07 +00001326#define ipcalc_trivial_usage \
Eric Andersen3561b012004-04-13 19:27:20 +00001327 "[OPTION]... <ADDRESS>[[/]<NETMASK>] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001328#define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001329 "Calculate IP network settings from a IP address\n\n" \
1330 "Options:\n" \
1331 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
Eric Andersen3561b012004-04-13 19:27:20 +00001332 "\t-n\t--network\tDisplay calculated network address.\n" \
1333 "\t-m\t--netmask\tDisplay default netmask for IP." \
1334 XUSAGE_IPCALC_FANCY(\
1335 "\n\t-p\t--prefix\tDisplay the prefix for IP/NETMASK." \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001336 "\t-h\t--hostname\tDisplay first resolved host name.\n" \
Eric Andersen3561b012004-04-13 19:27:20 +00001337 "\t-s\t--silent\tDon't ever display error messages.")
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001338
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001339#define iplink_trivial_usage \
1340 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1341#define iplink_full_usage \
1342 "iplink set DEVICE { up | down | arp { on | off } |\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001343 "\t\t\tdynamic { on | off } |\n" \
1344 "\t\t\tmtu MTU }\n" \
1345 "\tiplink show [ DEVICE ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001346
1347#define iproute_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001348 "{ list | flush | { add | del | change | append |\n" \
1349 "\t\treplace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001350#define iproute_full_usage \
1351 "iproute { list | flush } SELECTOR\n" \
1352 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001353 "\t\t\t[ oif STRING ] [ tos TOS ]\n" \
1354 "\tiproute { add | del | change | append | replace | monitor } ROUTE\n" \
1355 "\t\t\tSELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1356 "\t\t\tROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001357
1358#define iptunnel_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001359 "{ add | change | del | show } [ NAME ]\n" \
1360 "\t\t[ mode { ipip | gre | sit } ]\n" \
1361 "\t\t[ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001362#define iptunnel_full_usage \
1363 "iptunnel { add | change | del | show } [ NAME ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001364 "\t\t\t[ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1365 "\t\t\t[ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1366 "\t\t\t[ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001367
Eric Andersen7e9276b2001-02-22 01:15:47 +00001368#define kill_trivial_usage \
1369 "[-signal] process-id [process-id ...]"
1370#define kill_full_usage \
1371 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +00001372 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001373 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001374#define kill_example_usage \
1375 "$ ps | grep apache\n" \
1376 "252 root root S [apache]\n" \
1377 "263 www-data www-data S [apache]\n" \
1378 "264 www-data www-data S [apache]\n" \
1379 "265 www-data www-data S [apache]\n" \
1380 "266 www-data www-data S [apache]\n" \
1381 "267 www-data www-data S [apache]\n" \
1382 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001383
1384#define killall_trivial_usage \
Eric Andersenb131db42004-08-19 18:25:02 +00001385 "[-q] [-signal] process-name [process-name ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001386#define killall_full_usage \
1387 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001388 "Options:\n" \
Eric Andersenb131db42004-08-19 18:25:02 +00001389 "\t-l\tList all signal names and numbers.\n"\
1390 "\t-q\tDo not complain if no processes were killed."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001391#define killall_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001392 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001393
Mark Whitley6317c4b2001-03-12 22:51:50 +00001394#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001395 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001396#define klogd_full_usage \
1397 "Kernel logger.\n"\
1398 "Options:\n"\
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001399 "\t-c n\tSets the default log level of console messages to n.\n"\
Mark Whitley6317c4b2001-03-12 22:51:50 +00001400 "\t-n\tRun as a foreground process."
1401
Eric Andersen7e9276b2001-02-22 01:15:47 +00001402#define length_trivial_usage \
1403 "STRING"
1404#define length_full_usage \
1405 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001406#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001407 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001408 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001409
1410#define ln_trivial_usage \
1411 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1412#define ln_full_usage \
1413 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
1414 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1415 "Options:\n" \
1416 "\t-s\tmake symbolic links instead of hard links\n" \
1417 "\t-f\tremove existing destination files\n" \
1418 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001419#define ln_example_usage \
1420 "$ ln -s BusyBox /tmp/ls\n" \
1421 "$ ls -l /tmp/ls\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001422 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001423
Eric Andersen7e9276b2001-02-22 01:15:47 +00001424#define loadfont_trivial_usage \
1425 "< font"
1426#define loadfont_full_usage \
1427 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001428#define loadfont_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001429 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001430
1431#define loadkmap_trivial_usage \
1432 "< keymap"
1433#define loadkmap_full_usage \
1434 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001435#define loadkmap_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001436 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001437
1438#define logger_trivial_usage \
1439 "[OPTION]... [MESSAGE]"
1440#define logger_full_usage \
1441 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1442 "Options:\n" \
1443 "\t-s\tLog to stderr as well as the system log.\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001444 "\t-t TAG\tLog using the specified tag (defaults to user name).\n" \
1445 "\t-p PRIORITY\tEnter the message with the specified priority.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001446 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001447#define logger_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001448 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001449
Robert Griebl1fca5582002-06-04 20:45:46 +00001450#define login_trivial_usage \
1451 "[OPTION]... [username] [ENV=VAR ...]"
1452#define login_full_usage \
1453 "Begin a new session on the system\n\n" \
1454 "Options:\n" \
1455 "\t-f\tDo not authenticate (user already authenticated)\n" \
1456 "\t-h\tName of the remote host for this login.\n" \
1457 "\t-p\tPreserve environment."
1458
Eric Andersen7e9276b2001-02-22 01:15:47 +00001459#define logname_trivial_usage \
1460 ""
1461#define logname_full_usage \
1462 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001463#define logname_example_usage \
1464 "$ logname\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001465 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001466
Mark Whitley6317c4b2001-03-12 22:51:50 +00001467#define logread_trivial_usage \
Eric Andersend4a5e252003-12-19 11:32:14 +00001468 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001469#define logread_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001470 "Shows the messages from syslogd (using circular buffer).\n\n" \
Eric Andersend4a5e252003-12-19 11:32:14 +00001471 "Options:\n" \
1472 "\t-f\t\toutput data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001473
Matt Kraai83788da2002-03-20 17:38:37 +00001474#define losetup_trivial_usage \
1475 "[OPTION]... LOOPDEVICE FILE\n" \
1476 "or: losetup [OPTION]... -d LOOPDEVICE"
1477#define losetup_full_usage \
1478 "Associate LOOPDEVICE with FILE.\n\n" \
1479 "Options:\n" \
1480 "\t-d\t\tDisassociate LOOPDEVICE.\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001481 "\t-o OFFSET\tStart OFFSET bytes into FILE."
Matt Kraai83788da2002-03-20 17:38:37 +00001482
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001483#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001484 #define USAGE_LS_TIMESTAMPS(a) a
1485#else
1486 #define USAGE_LS_TIMESTAMPS(a)
1487#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001488#ifdef CONFIG_FEATURE_LS_FILETYPES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001489 #define USAGE_LS_FILETYPES(a) a
1490#else
1491 #define USAGE_LS_FILETYPES(a)
1492#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001493#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001494 #define USAGE_LS_FOLLOWLINKS(a) a
1495#else
1496 #define USAGE_LS_FOLLOWLINKS(a)
1497#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001498#ifdef CONFIG_FEATURE_LS_RECURSIVE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001499 #define USAGE_LS_RECURSIVE(a) a
1500#else
1501 #define USAGE_LS_RECURSIVE(a)
1502#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001503#ifdef CONFIG_FEATURE_LS_SORTFILES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001504 #define USAGE_LS_SORTFILES(a) a
1505#else
1506 #define USAGE_LS_SORTFILES(a)
1507#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001508#ifdef CONFIG_FEATURE_AUTOWIDTH
Eric Andersen7e9276b2001-02-22 01:15:47 +00001509 #define USAGE_AUTOWIDTH(a) a
1510#else
1511 #define USAGE_AUTOWIDTH(a)
1512#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00001513
Eric Andersen7e9276b2001-02-22 01:15:47 +00001514#define ls_trivial_usage \
Eric Andersen15c03c32004-04-06 17:52:02 +00001515 "[-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 +00001516#define ls_full_usage \
1517 "List directory contents\n\n" \
1518 "Options:\n" \
1519 "\t-1\tlist files in a single column\n" \
1520 "\t-A\tdo not list implied . and ..\n" \
1521 "\t-a\tdo not hide entries starting with .\n" \
1522 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001523 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001524 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001525 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1526 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001527 "\t-i\tlist the i-node for each file\n" \
1528 "\t-l\tuse a long listing format\n" \
1529 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001530 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1531 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1532 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1533 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1534 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001535 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001536 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1537 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1538 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1539 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1540 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001541 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001542 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1543 USAGE_HUMAN_READABLE( \
Eric Andersen15c03c32004-04-06 17:52:02 +00001544 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n") \
1545 USAGE_SELINUX("\t-k\tprint security context\n") \
1546 USAGE_SELINUX("\t-K\tprint security context in long format\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001547
1548#define lsmod_trivial_usage \
1549 ""
1550#define lsmod_full_usage \
1551 "List the currently loaded kernel modules."
1552
1553#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001554 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001555#define makedevs_full_usage \
1556 "Creates a range of block or character special files\n\n" \
1557 "TYPEs include:\n" \
1558 "\tb:\tMake a block (buffered) device.\n" \
1559 "\tc or u:\tMake a character (un-buffered) device.\n" \
1560 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1561 "FIRST specifies the number appended to NAME to create the first device.\n" \
1562 "LAST specifies the number of the last item that should be created.\n" \
1563 "If 's' is the last argument, the base device is created as well.\n\n" \
1564 "For example:\n" \
1565 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001566 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001567#define makedevs_example_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001568 "# makedevs /dev/ttyS c 4 66 2 63\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001569 "[creates ttyS2-ttyS63]\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001570 "# makedevs /dev/hda b 3 0 0 8 s\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001571 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001572
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001573#ifdef CONFIG_FEATURE_MD5_SHA1_SUM_CHECK
1574#define USAGE_MD5_SHA1_SUM_CHECK(a) a
1575#else
1576#define USAGE_MD5_SHA1_SUM_CHECK(a)
1577#endif
1578
Eric Andersen7e9276b2001-02-22 01:15:47 +00001579#define md5sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001580 "[OPTION] [FILEs...]" \
1581 USAGE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001582#define md5sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001583 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001584 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001585 "With no FILE, or when FILE is -, read standard input." \
1586 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
1587 "\t-c\tcheck MD5 sums against given list\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001588 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001589 "\t-s\tdon't output anything, status code shows success\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001590 "\t-w\twarn about improperly formated MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001591#define md5sum_example_usage \
1592 "$ md5sum < busybox\n" \
1593 "6fd11e98b98a58f64ff3398d7b324003\n" \
1594 "$ md5sum busybox\n" \
1595 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1596 "$ md5sum -c -\n" \
1597 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1598 "busybox: OK\n" \
1599 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001600
Glenn L McGrath061c9002002-09-16 04:21:46 +00001601#define mesg_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001602 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001603#define mesg_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001604 "mesg controls write access to your terminal\n" \
Glenn L McGrath061c9002002-09-16 04:21:46 +00001605 "\ty\tAllow write access to your terminal.\n" \
1606 "\tn\tDisallow write access to your terminal.\n"
1607
Eric Andersen7e9276b2001-02-22 01:15:47 +00001608#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001609 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001610#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001611 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001612 "Options:\n" \
1613 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001614 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001615#define mkdir_example_usage \
1616 "$ mkdir /tmp/foo\n" \
1617 "$ mkdir /tmp/foo\n" \
1618 "/tmp/foo: File exists\n" \
1619 "$ mkdir /tmp/foo/bar/baz\n" \
1620 "/tmp/foo/bar/baz: No such file or directory\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001621 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001622
Eric Andersen7e9276b2001-02-22 01:15:47 +00001623#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001624 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001625#define mkfifo_full_usage \
1626 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1627 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001628 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001629
Eric Andersen7e9276b2001-02-22 01:15:47 +00001630#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001631 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001632#define mkfs_minix_full_usage \
1633 "Make a MINIX filesystem.\n\n" \
1634 "Options:\n" \
1635 "\t-c\t\tCheck the device for bad blocks\n" \
1636 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1637 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1638 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001639 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001640
Eric Andersen7e9276b2001-02-22 01:15:47 +00001641#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001642 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001643#define mknod_full_usage \
1644 "Create a special file (block, character, or pipe).\n\n" \
1645 "Options:\n" \
1646 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1647 "TYPEs include:\n" \
1648 "\tb:\tMake a block (buffered) device.\n" \
1649 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001650 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001651#define mknod_example_usage \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001652 "$ mknod /dev/fd0 b 2 0\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001653 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001654
Eric Andersen7e9276b2001-02-22 01:15:47 +00001655#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001656 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001657#define mkswap_full_usage \
1658 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001659 "Options:\n" \
1660 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001661 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001662 "\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 +00001663 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001664
Eric Andersen7e9276b2001-02-22 01:15:47 +00001665#define mktemp_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001666 "[-dq] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001667#define mktemp_full_usage \
1668 "Creates a temporary file with its name based on TEMPLATE.\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001669 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX).\n\n" \
1670 "Options:\n" \
1671 "\t-d\t\tMake a directory instead of a file\n" \
1672 "\t-q\t\tFail silently if an error occurs"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001673#define mktemp_example_usage \
1674 "$ mktemp /tmp/temp.XXXXXX\n" \
1675 "/tmp/temp.mWiLjM\n" \
1676 "$ ls -la /tmp/temp.mWiLjM\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001677 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001678
Eric Andersen8d79ce82001-07-22 23:00:15 +00001679#define modprobe_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001680 "[-knqrsv] [MODULE ...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00001681#define modprobe_full_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001682 "Used for high level module loading and unloading.\n\n" \
1683 "Options:\n" \
1684 "\t-k\tMake module autoclean-able.\n" \
1685 "\t-n\tJust show what would be done.\n" \
1686 "\t-q\tQuiet output.\n" \
1687 "\t-r\tRemove module (stacks) or do autoclean.\n" \
1688 "\t-s\tReport via syslog instead of stderr.\n" \
1689 "\t-v\tVerbose output."
Eric Andersen8d79ce82001-07-22 23:00:15 +00001690#define modprobe_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001691 "$ modprobe cdrom\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00001692
Eric Andersen7e9276b2001-02-22 01:15:47 +00001693#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001694 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001695#define more_full_usage \
1696 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001697#define more_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001698 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001699
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001700#ifdef CONFIG_FEATURE_MOUNT_LOOP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001701 #define USAGE_MOUNT_LOOP(a) a
1702#else
1703 #define USAGE_MOUNT_LOOP(a)
1704#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001705#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001706 #define USAGE_MTAB(a) a
1707#else
1708 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001709#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001710#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001711 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001712#define mount_full_usage \
Eric Andersen2715fa12004-03-09 21:32:57 +00001713 "Mount a filesystem. Autodetection of filesystem type requires the\n" \
1714 "/proc filesystem be already mounted.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001715 "Flags:\n" \
1716 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001717 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001718 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001719 "\t-n:\t\tDon't write a mount table entry.\n" \
1720 ) \
1721 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1722 "\t-r:\t\tMount the filesystem read-only.\n" \
1723 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1724 "\t-w:\t\tMount for reading and writing (default).\n" \
1725 "\n" \
1726 "Options for use with the \"-o\" flag:\n" \
1727 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1728 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1729 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1730 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001731 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001732 "\tloop:\t\tMounts a file via loop device.\n" \
1733 ) \
1734 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001735 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001736 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001737 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001738 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001739 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001740#define mount_example_usage \
1741 "$ mount\n" \
1742 "/dev/hda3 on / type minix (rw)\n" \
1743 "proc on /proc type proc (rw)\n" \
1744 "devpts on /dev/pts type devpts (rw)\n" \
1745 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001746 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +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 \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001759 "[OPTION]... SOURCE DEST\n" \
1760 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001761#define mv_full_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001762 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY.\n\n" \
1763 "Options:\n" \
1764 "\t-f\tdon't prompt before overwriting\n" \
1765 "\t-i\tinteractive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001766#define mv_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001767 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001768
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001769#define nameif_trivial_usage \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001770 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001771#define nameif_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00001772 "Nameif renaming network interface while it in the down state.\n\n" \
1773 "Options:\n" \
1774 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
1775 "\t-s\t\tUse syslog (LOCAL0 facility).\n" \
1776 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001777#define nameif_example_usage \
Eric Andersen178de172004-04-06 16:36:20 +00001778 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
1779 " or\n" \
1780 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001781
Eric Andersen7e9276b2001-02-22 01:15:47 +00001782#define nc_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001783 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001784#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001785 "Netcat opens a pipe to IP:port\n\n" \
1786 "Options:\n" \
1787 "\t-l\t\tlisten mode, for inbound connects\n" \
1788 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00001789 "\t-i SECS\t\tdelay interval for lines sent\n" \
Eric Andersen00a6a752002-04-26 23:53:10 +00001790 "\t-e PROG\t\tprogram to exec after connect (dangerous!)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001791#define nc_example_usage \
1792 "$ nc foobar.somedomain.com 25\n" \
1793 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1794 "help\n" \
1795 "214-Commands supported:\n" \
1796 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1797 "214 NOOP QUIT RSET HELP\n" \
1798 "quit\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001799 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001800
Eric Andersen1552ff72001-10-31 11:07:12 +00001801#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00001802 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00001803#define netstat_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001804 "Netstat displays Linux networking information.\n\n" \
1805 "Options:\n" \
1806 "\t-l display listening server sockets\n" \
1807 "\t-a display all sockets (default: connected)\n" \
1808 "\t-e display other/more information\n" \
1809 "\t-n don't resolve names\n" \
1810 "\t-r display routing table\n" \
1811 "\t-t tcp sockets\n" \
1812 "\t-u udp sockets\n" \
1813 "\t-w raw sockets\n" \
1814 "\t-x unix sockets"
Eric Andersen1552ff72001-10-31 11:07:12 +00001815
Eric Andersen7e9276b2001-02-22 01:15:47 +00001816#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001817 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001818#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001819 "Queries the nameserver for the IP address of the given HOST\n" \
1820 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001821#define nslookup_example_usage \
1822 "$ nslookup localhost\n" \
1823 "Server: default\n" \
1824 "Address: default\n" \
1825 "\n" \
1826 "Name: debian\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001827 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001828
Glenn L McGrath60281112001-11-02 11:39:46 +00001829#define od_trivial_usage \
1830 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
1831#define od_full_usage \
1832 "Write an unambiguous representation, octal bytes by default, of FILE\n"\
1833 "to standard output. With no FILE, or when FILE is -, read standard input."
1834
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00001835#define openvt_trivial_usage \
1836 "<vtnum> <COMMAND> [ARGS...]"
1837#define openvt_full_usage \
1838 "Start a command on a new virtual terminal"
1839#define openvt_example_usage \
1840 "openvt 2 /bin/ash\n"
1841
Eric Andersen27f64e12002-06-23 04:24:25 +00001842#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
1843 #define PASSWORD_ALG_TYPES(a) a
Tim Riker7b253f82003-12-28 05:02:40 +00001844#else
Eric Andersen27f64e12002-06-23 04:24:25 +00001845 #define PASSWORD_ALG_TYPES(a)
1846#endif
1847#define passwd_trivial_usage \
1848 "[OPTION] [name]"
1849#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00001850 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00001851 "changes the password for the current user.\n" \
1852 "Options:\n" \
1853 "\t-a\tDefine which algorithm shall be used for the password.\n" \
1854 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001855 PASSWORD_ALG_TYPES(", sha1") \
Eric Andersen27f64e12002-06-23 04:24:25 +00001856 ")\n\t-d\tDelete the password for the specified user account.\n" \
1857 "\t-l\tLocks (disables) the specified user account.\n" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001858 "\t-u\tUnlocks (re-enables) the specified user account."
Eric Andersen27f64e12002-06-23 04:24:25 +00001859
Glenn L McGrath655d8142003-06-22 15:32:41 +00001860#define patch_trivial_usage \
1861 "[-p<num>]"
1862#define patch_full_usage \
1863 "[-p<num>]"
1864#define patch_example_usage \
1865 "$ patch -p1 <example.diff"
1866
Eric Andersen221b2ea2001-07-31 19:06:07 +00001867#define pidof_trivial_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00001868 "process-name [OPTION] [process-name ...]"
Eric Andersen221b2ea2001-07-31 19:06:07 +00001869#define pidof_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00001870 "Lists the PIDs of all processes with names that match the\n" \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00001871 "names on the command line.\n" \
1872 "Options:\n" \
1873 "\t-s\t\tdisplay only a single PID."
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 \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00001931 "[-d<delay>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001932#define poweroff_full_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00001933 "Halt the system and request that the kernel shut off the power.\n" \
1934 "Options:\n" \
1935 "\t-d\t\tdelay interval for shutting off."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001936
Eric Andersen7e9276b2001-02-22 01:15:47 +00001937#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001938 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001939#define printf_full_usage \
1940 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001941 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001942#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001943 "$ printf "Val=%d\\n" 5\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001944 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001945
Eric Andersen15c03c32004-04-06 17:52:02 +00001946#ifdef CONFIG_SELINUX
1947#define USAGE_NONSELINUX(a)
1948#else
1949#define USAGE_NONSELINUX(a) a
1950#endif
1951
Eric Andersen7e9276b2001-02-22 01:15:47 +00001952#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001953 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001954#define ps_full_usage \
1955 "Report process status\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001956 USAGE_NONSELINUX("\n\tThis version of ps accepts no options.") \
1957 USAGE_SELINUX("\nOptions:\n\t-c\tshow SE Linux context")
Tim Riker7b253f82003-12-28 05:02:40 +00001958
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001959#define ps_example_usage \
1960 "$ ps\n" \
1961 " PID Uid Gid State Command\n" \
1962 " 1 root root S init\n" \
1963 " 2 root root S [kflushd]\n" \
1964 " 3 root root S [kupdate]\n" \
1965 " 4 root root S [kpiod]\n" \
1966 " 5 root root S [kswapd]\n" \
1967 " 742 andersen andersen S [bash]\n" \
1968 " 743 andersen andersen S -bash\n" \
1969 " 745 root root S [getty]\n" \
1970 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001971
Eric Andersen7e9276b2001-02-22 01:15:47 +00001972#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001973 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001974#define pwd_full_usage \
1975 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001976#define pwd_example_usage \
1977 "$ pwd\n" \
1978 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001979
Eric Andersen7e9276b2001-02-22 01:15:47 +00001980#define rdate_trivial_usage \
Eric Andersen725db192003-07-22 08:26:05 +00001981 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001982#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001983 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001984 "Options:\n" \
1985 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001986 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001987
Ned Luddc6fbed52004-12-08 16:47:28 +00001988#ifdef CONFIG_FEATURE_READLINK_FOLLOW
1989#define USAGE_READLINK_FOLLOW(a) a
1990#else
1991#define USAGE_READLINK_FOLLOW(a)
1992#endif
1993
Eric Andersen7e9276b2001-02-22 01:15:47 +00001994#define readlink_trivial_usage \
Ned Luddc6fbed52004-12-08 16:47:28 +00001995 USAGE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001996#define readlink_full_usage \
Ned Luddc6fbed52004-12-08 16:47:28 +00001997 "Displays the value of a symbolic link." \
1998 USAGE_READLINK_FOLLOW("\n\nOptions:\n" \
1999 "\t-f\tcanonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002000
Glenn L McGrath62fae302002-12-10 00:14:33 +00002001#define realpath_trivial_usage \
2002 "pathname ..."
2003#define realpath_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002004 "Returns the absolute pathnames of given argument."
Tim Riker7b253f82003-12-28 05:02:40 +00002005
Eric Andersen7e9276b2001-02-22 01:15:47 +00002006#define reboot_trivial_usage \
Glenn L McGrath72b14a82004-07-23 03:33:38 +00002007 "[-d<delay>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002008#define reboot_full_usage \
Glenn L McGrath72b14a82004-07-23 03:33:38 +00002009 "Reboot the system.\n" \
2010 "Options:\n" \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002011 "\t-d\t\tdelay interval for rebooting."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002012
2013#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002014 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002015#define renice_full_usage \
2016 "Changes priority of running processes. Allowed priorities range\n" \
2017 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002018 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002019
Eric Andersen7e9276b2001-02-22 01:15:47 +00002020#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002021 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002022#define reset_full_usage \
2023 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002024
Eric Andersen7e9276b2001-02-22 01:15:47 +00002025#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002026 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002027#define rm_full_usage \
2028 "Remove (unlink) the FILE(s). You may use '--' to\n" \
2029 "indicate that all following arguments are non-options.\n\n" \
2030 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002031 "\t-i\t\talways prompt before removing each destination\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002032 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002033 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002034#define rm_example_usage \
2035 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002036
Eric Andersen7e9276b2001-02-22 01:15:47 +00002037#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002038 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002039#define rmdir_full_usage \
2040 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002041#define rmdir_example_usage \
2042 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002043
Eric Andersen7e9276b2001-02-22 01:15:47 +00002044#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002045 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002046#define rmmod_full_usage \
2047 "Unloads the specified kernel modules from the kernel.\n\n" \
2048 "Options:\n" \
Tim Rikercf932742002-12-14 01:58:59 +00002049 "\t-a\tRemove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002050#define rmmod_example_usage \
2051 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002052
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002053#ifdef CONFIG_FEATURE_IPV6
2054 #define USAGE_ROUTE_IPV6(a) a
2055#else
2056 #define USAGE_ROUTE_IPV6(a) "\t"
2057#endif
2058
2059
Eric Andersen7e9276b2001-02-22 01:15:47 +00002060#define route_trivial_usage \
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002061 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002062#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002063 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00002064 "Options:\n" \
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002065 "\t-n\t\tDont resolve names.\n" \
2066 "\t-e\t\tDisplay other/more information.\n" \
2067 "\t-A inet" USAGE_ROUTE_IPV6("{6}") "\tSelect address family."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002068
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002069#define rpm_trivial_usage \
2070 "-i -q[ildc]p package.rpm"
2071#define rpm_full_usage \
2072 "Manipulates RPM packages" \
Eric Andersendfce3532003-06-15 07:00:54 +00002073 "\n\nOptions:" \
2074 "\n\t-i Install package" \
2075 "\n\t-q Query package" \
2076 "\n\t-p Query uninstalled package" \
2077 "\n\t-i Show information" \
2078 "\n\t-l List contents" \
2079 "\n\t-d List documents" \
2080 "\n\t-c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002081
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002082#define rpm2cpio_trivial_usage \
2083 "package.rpm"
2084#define rpm2cpio_full_usage \
2085 "Outputs a cpio archive of the rpm file."
2086
Eric Andersen6cf47a72001-10-31 10:24:36 +00002087#define run_parts_trivial_usage \
2088 "[-t] [-a ARG] [-u MASK] DIRECTORY"
2089#define run_parts_full_usage \
2090 "Run a bunch of scripts in a directory.\n\n" \
2091 "Options:\n" \
Eric Andersena151d192004-04-06 17:16:36 +00002092 "\t-t\tPrints what would be run, but does not actually run anything.\n" \
Eric Andersen6cf47a72001-10-31 10:24:36 +00002093 "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \
2094 "\t-u MASK\tSet the umask to MASK before executing every program."
2095
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002096#define rx_trivial_usage \
2097 "FILE"
2098#define rx_full_usage \
2099 "Receive a file using the xmodem protocol."
2100#define rx_example_usage \
2101 "$ rx /tmp/foo\n"
2102
Eric Andersen7e9276b2001-02-22 01:15:47 +00002103#define sed_trivial_usage \
Rob Landley1ce59682004-05-26 21:59:31 +00002104 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002105#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002106 "Options:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002107 "\t-e script\tadd the script to the commands to be executed\n" \
Eric Andersenf802ff72004-04-12 15:12:06 +00002108 "\t-f scriptfile\tadd script-file contents to the\n" \
2109 "\t\t\tcommands to be executed\n" \
Rob Landley1ce59682004-05-26 21:59:31 +00002110 "\t-i\t\tedit files in-place\n" \
2111 "\t-n\t\tsuppress automatic printing of pattern space\n" \
Rob Landley58b118a2004-05-26 22:09:37 +00002112 "\t-r\t\tuse extended regular expression syntax\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002113 "\n" \
Eric Andersenf802ff72004-04-12 15:12:06 +00002114 "If no -e or -f is given, the first non-option argument is taken as the sed\n"\
2115 "script to interpret. All remaining arguments are names of input files; if no\n"\
2116 "input files are specified, then the standard input is read. Source files\n" \
2117 "will not be modified unless -i option is given."
2118
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002119#define sed_example_usage \
2120 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
2121 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002122
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002123#define seq_trivial_usage \
2124 "[first [increment]] last"
2125#define seq_full_usage \
2126 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
2127 "FIRST, INCREMENT default to 1\n" \
2128 "Arguments:\n" \
2129 "\tLAST\n" \
2130 "\tFIRST\tLAST\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002131 "\tFIRST\tINCREMENT\tLAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002132
Eric Andersen7e9276b2001-02-22 01:15:47 +00002133#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002134 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002135#define setkeycodes_full_usage \
2136 "Set entries into the kernel's scancode-to-keycode map,\n" \
2137 "allowing unusual keyboards to generate usable keycodes.\n\n" \
2138 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002139 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002140#define setkeycodes_example_usage \
2141 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002142
Matt Kraai2d91deb2001-08-01 17:21:35 +00002143#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002144 "[FILE]...\n" \
2145 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00002146#define lash_full_usage \
Eric Andersen2e9c2572003-08-08 22:26:06 +00002147 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00002148#define lash_notes_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002149 "This command does not yet have proper documentation.\n\n" \
2150 "Use lash just as you would use any other shell. It properly handles pipes,\n" \
2151 "redirects, job control, can be used as the shell for scripts, and has a\n" \
2152 "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
2153 "Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
2154 "use ash or bash. If you just need a very simple and extremely small shell,\n" \
2155 "this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002156
Eric Andersen2e9c2572003-08-08 22:26:06 +00002157#define last_trivial_usage \
2158 ""
2159#define last_full_usage \
2160 "Shows listing of the last users that logged into the system"
2161
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002162#define sha1sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002163 "[OPTION] [FILEs...]" \
2164 USAGE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002165#define sha1sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002166 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n\n" \
2167 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002168 "With no FILE, or when FILE is -, read standard input." \
2169 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
2170 "\t-c\tcheck SHA1 sums against given list\n" \
2171 "\nThe following two options are useful only when verifying checksums:\n" \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002172 "\t-s\tdon't output anything, status code shows success\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002173 "\t-w\twarn about improperly formated SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002174
Manuel Novoa III cad53642003-03-19 09:13:01 +00002175#ifdef CONFIG_FEATURE_FANCY_SLEEP
2176 #define USAGE_FANCY_SLEEP(a) a
2177 #define USAGE_NOT_FANCY_SLEEP(a)
2178#else
Tim Riker7b253f82003-12-28 05:02:40 +00002179 #define USAGE_FANCY_SLEEP(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +00002180 #define USAGE_NOT_FANCY_SLEEP(a) a
2181#endif
2182
Eric Andersen7e9276b2001-02-22 01:15:47 +00002183#define sleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002184 USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002185#define sleep_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002186 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \
2187 USAGE_FANCY_SLEEP( \
Eric Andersen178de172004-04-06 16:36:20 +00002188 "Pause for a time equal to the total of the args given, where each arg can\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00002189 "\t\thave an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002190#define sleep_example_usage \
2191 "$ sleep 2\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002192 "[2 second delay results]\n" \
2193 USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \
2194 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002195
Rob Landleyc0dedd02005-01-24 07:00:02 +00002196#ifdef CONFIG_SORT_BIG
2197 #define USAGE_SORT_BIG(a) a
Mark Whitleyfccaa362001-04-17 18:56:18 +00002198#else
Rob Landleyc0dedd02005-01-24 07:00:02 +00002199 #define USAGE_SORT_BIG(a)
Mark Whitleyfccaa362001-04-17 18:56:18 +00002200#endif
Rob Landleyc0dedd02005-01-24 07:00:02 +00002201
2202
Eric Andersen7e9276b2001-02-22 01:15:47 +00002203#define sort_trivial_usage \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002204 "[-nru" USAGE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002205#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002206 "Sorts lines of text in the specified files\n\n"\
2207 "Options:\n" \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002208 USAGE_SORT_BIG( \
2209 "\t-b\tignore leading blanks\n" \
2210 "\t-c\tcheck whether input is sorted\n" \
2211 "\t-d\tdictionary order (blank or alphanumeric only)\n" \
2212 "\t-f\tignore case\n" \
2213 "\t-g\tgeneral numerical sort\n" \
2214 "\t-i\tignore unprintable characters\n" \
2215 "\t-k\tspecify sort key\n" \
2216 "\t-M\tsort month\n" \
2217 ) \
2218 "\t-n\tsort numbers\n" \
2219 USAGE_SORT_BIG( \
2220 "\t-o\toutput to file\n" \
2221 "\t-k\tsort by key\n" \
2222 "\t-t\tuse key separator other than whitespace\n" \
2223 ) \
2224 "\t-r\treverse sort order\n" \
2225 USAGE_SORT_BIG("\t-s\tstable (don't sort ties alphabetically)\n") \
2226 "\t-u\tsuppress duplicate lines" \
2227 USAGE_SORT_BIG("\n\t-z\tinput terminated by nulls, not newlines\n") \
2228 USAGE_SORT_BIG("\t-mST\tignored for GNU compatability") \
2229 ""
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002230#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002231 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002232 "a\n" \
2233 "b\n" \
2234 "c\n" \
2235 "d\n" \
2236 "e\n" \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002237 "f\n" \
2238 USAGE_SORT_BIG( \
2239 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
2240 "d 2\n" \
2241 "b 2\n" \
2242 "c 3\n" \
2243 ) \
2244 ""
2245
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002246
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002247#define start_stop_daemon_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00002248 "[OPTIONS] [--start|--stop] ... [-- arguments...]\n"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002249#define start_stop_daemon_full_usage \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002250 "Program to start and stop services."\
2251 "\n\nOptions:"\
2252 "\n\t-S|--start\t\t\tstart"\
2253 "\n\t-K|--stop\t\t\tstop"\
Eric Andersena151d192004-04-06 17:16:36 +00002254 "\n\t-a|--startas <pathname>\t\tstarts process specified by pathname"\
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002255 "\n\t-b|--background\t\t\tforce process into background"\
2256 "\n\t-u|--user <username>|<uid>\tstop this user's processes"\
Eric Andersena151d192004-04-06 17:16:36 +00002257 "\n\t-x|--exec <executable>\t\tprogram to either start or check"\
Eric Andersen625da9d2004-04-13 18:28:46 +00002258 "\n\t-m|--make-pidfile <filename>\tcreate the -p file and enter pid in it"\
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002259 "\n\t-n|--name <process-name>\tstop processes with this name"\
2260 "\n\t-p|--pidfile <pid-file>\t\tsave or load pid using a pid-file"\
2261 "\n\t-q|--quiet\t\t\tbe quiet" \
Eric Andersen178de172004-04-06 16:36:20 +00002262 "\n\t-s|--signal <signal>\t\tsignal to send (default TERM)"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002263
Eric Andersenef5e8f82002-11-07 02:09:37 +00002264#define strings_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002265 "[-afo] [-n length] [file ... ]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002266#define strings_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002267 "Display printable strings in a binary file." \
2268 "\n\nOptions:" \
Glenn L McGrath85396672004-07-21 12:25:55 +00002269 "\n\t-a\tScan the whole files (this is the default)."\
Eric Andersen178de172004-04-06 16:36:20 +00002270 "\n\t-f\tPrecede each string with the name of the file where it was found." \
2271 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
2272 "\n\t-o\tEach string is preceded by its decimal offset in the file."
Eric Andersenef5e8f82002-11-07 02:09:37 +00002273
Eric Andersen7e9276b2001-02-22 01:15:47 +00002274#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002275 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002276#define stty_full_usage \
2277 "Without arguments, prints baud rate, line discipline," \
2278 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002279 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00002280 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002281 "\n\t-a\t\tprint all current settings in human-readable form" \
2282 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00002283 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002284
Robert Griebl1fca5582002-06-04 20:45:46 +00002285#define su_trivial_usage \
2286 "[OPTION]... [-] [username]"
2287#define su_full_usage \
2288 "Change user id or become root.\n" \
2289 "Options:\n" \
2290 "\t-p\tPreserve environment"
2291
Eric Andersen27f64e12002-06-23 04:24:25 +00002292#define sulogin_trivial_usage \
2293 "[OPTION]... [tty-device]"
2294#define sulogin_full_usage \
2295 "Single user login\n" \
2296 "Options:\n" \
2297 "\t-f\tDo not authenticate (user already authenticated)\n" \
2298 "\t-h\tName of the remote host for this login.\n" \
2299 "\t-p\tPreserve environment."
2300
Eric Andersen7e9276b2001-02-22 01:15:47 +00002301#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002302 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002303#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002304 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002305 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002306 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002307
Eric Andersen7e9276b2001-02-22 01:15:47 +00002308#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002309 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002310#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002311 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002312 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002313 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002314
Eric Andersen7e9276b2001-02-22 01:15:47 +00002315#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002316 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002317#define sync_full_usage \
2318 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002319
Eric Andersen7e9276b2001-02-22 01:15:47 +00002320
Eric Andersen29c77f72003-10-09 09:43:18 +00002321#ifdef CONFIG_FEATURE_ROTATE_LOGFILE
2322 #define USAGE_ROTATE_LOGFILE(a) a
2323#else
Tim Riker7b253f82003-12-28 05:02:40 +00002324 #define USAGE_ROTATE_LOGFILE(a)
Eric Andersen29c77f72003-10-09 09:43:18 +00002325#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002326#ifdef CONFIG_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00002327 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002328#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00002329 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002330#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00002331#ifdef CONFIG_FEATURE_IPC_SYSLOG
2332 #define USAGE_IPC_LOG(a) a
2333#else
2334 #define USAGE_IPC_LOG(a)
2335#endif
2336
Eric Andersenb9050282003-12-24 06:02:11 +00002337#ifdef CONFIG_SYSCTL
2338#define sysctl_trivial_usage \
2339 "[OPTIONS]... [VALUE]...\n"
2340#define sysctl_full_usage
2341 "sysctl - configure kernel parameters at runtime\n\n" \
2342 "Options:\n" \
2343 "\t-n\tUse this option to disable printing of the key name when printing values.\n" \
Eric Andersenb9050282003-12-24 06:02:11 +00002344 "\t-w\tUse this option when you want to change a sysctl setting.\n" \
2345 "\t-p\tLoad in sysctl settings from the file specified or /etc/sysctl.conf if none given.\n" \
2346 "\t-a\tDisplay all values currently available.\n" \
2347 "\t-A\tDisplay all values currently available in table form."
Eric Andersenb9050282003-12-24 06:02:11 +00002348#define sysctl_example_usage
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002349 "sysctl [-n] variable ...\n" \
2350 "sysctl [-n] -w variable=value ...\n" \
2351 "sysctl [-n] -a\n" \
2352 "sysctl [-n] -p <file>\t(default /etc/sysctl.conf)\n" \
2353 "sysctl [-n] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00002354#endif
2355
Eric Andersen7e9276b2001-02-22 01:15:47 +00002356#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002357 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002358#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002359 "Linux system and kernel logging utility.\n" \
2360 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002361 "Options:\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002362 "\t-m MIN\t\tMinutes between MARK lines (default=20, 0=off)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002363 "\t-n\t\tRun as a foreground process\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002364 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)\n" \
2365 "\t-S\t\tMake logging output smaller." \
Eric Andersen29c77f72003-10-09 09:43:18 +00002366 USAGE_ROTATE_LOGFILE( \
Eric Andersen178de172004-04-06 16:36:20 +00002367 "\n\t-s SIZE\t\tMax size (KB) before rotate (default=200KB, 0=off)\n" \
2368 "\t-b NUM\t\tNumber of rotated logs to keep (default=1, max=99, 0=purge)") \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002369 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00002370 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00002371 "\t-L\t\tLog locally and via network logging (default is network only)") \
2372 USAGE_IPC_LOG( \
Eric Andersend4a5e252003-12-19 11:32:14 +00002373 "\n\t-C [size(KiB)]\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002374#define syslogd_example_usage \
2375 "$ syslogd -R masterlog:514\n" \
2376 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002377
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002378
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002379#ifndef CONFIG_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00002380 #define USAGE_UNSIMPLE_TAIL(a)
2381#else
2382 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002383#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002384#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002385 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002386#define tail_full_usage \
2387 "Print last 10 lines of each FILE to standard output.\n" \
2388 "With more than one FILE, precede each with a header giving the\n" \
2389 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
2390 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002391 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002392 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
2393 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002394 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002395 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
2396 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002397 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002398 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002399 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
2400#define tail_example_usage \
2401 "$ tail -n 1 /etc/resolv.conf\n" \
2402 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002403
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002404#ifdef CONFIG_FEATURE_TAR_CREATE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002405 #define USAGE_TAR_CREATE(a) a
2406#else
2407 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002408#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002409#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002410 #define USAGE_TAR_EXCLUDE(a) a
2411#else
2412 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002413#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002414#ifdef CONFIG_FEATURE_TAR_GZIP
2415 #define USAGE_TAR_GZIP(a) a
2416#else
2417 #define USAGE_TAR_GZIP(a)
2418#endif
2419#ifdef CONFIG_FEATURE_TAR_BZIP2
2420 #define USAGE_TAR_BZIP2(a) a
2421#else
2422 #define USAGE_TAR_BZIP2(a)
2423#endif
Glenn L McGrath7370f622003-11-18 21:49:23 +00002424#ifdef CONFIG_FEATURE_TAR_COMPRESS
2425 #define USAGE_TAR_COMPRESS(a) a
2426#else
2427 #define USAGE_TAR_COMPRESS(a)
2428#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002429
Eric Andersen7e9276b2001-02-22 01:15:47 +00002430#define tar_trivial_usage \
Glenn L McGrath7370f622003-11-18 21:49:23 +00002431 "-[" 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 +00002432 USAGE_TAR_EXCLUDE("[-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00002433 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002434#define tar_full_usage \
2435 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00002436 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002437 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002438 "\tx\t\textract\n" \
2439 "\tt\t\tlist\n" \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002440 "\nArchive format selection:\n" \
2441 USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
2442 USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
Glenn L McGrath0c5d9c22003-11-18 23:27:49 +00002443 USAGE_TAR_COMPRESS("\tZ\t\tFilter the archive through compress\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002444 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002445 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002446 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002447 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002448 "\texclude\t\tfile to exclude\n" \
2449 "\tX\t\tfile with names to exclude\n" \
2450 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00002451 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002452 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002453#define tar_example_usage \
2454 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
2455 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002456
Eric Andersen7e9276b2001-02-22 01:15:47 +00002457#define tee_trivial_usage \
2458 "[OPTION]... [FILE]..."
2459#define tee_full_usage \
2460 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002461 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002462 "\t-a\tappend to the given FILEs, do not overwrite\n" \
2463 "\t-i\tignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002464#define tee_example_usage \
2465 "$ echo "Hello" | tee /tmp/foo\n" \
2466 "$ cat /tmp/foo\n" \
2467 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002468
Eric Andersen539ffc92004-02-22 12:25:47 +00002469#ifdef CONFIG_FEATURE_TELNET_AUTOLOGIN
2470#define telnet_trivial_usage \
2471 "[-a] [-l USER] HOST [PORT]"
2472#define telnet_full_usage \
2473 "Telnet is used to establish interactive communication with another\n" \
2474 "computer over a network using the TELNET protocol.\n\n" \
2475 "Options:\n" \
2476 "\t-a\t\tAttempt an automatic login with the USER variable.\n" \
2477 "\t-l USER\t\tAttempt an automatic login with the USER argument.\n" \
2478 "\tHOST\t\tThe official name, alias or the IP address of the\n" \
2479 "\t\t\tremote host.\n" \
2480 "\tPORT\t\tThe remote port number to connect to. If it is not\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002481 "\t\t\tspecified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00002482#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00002483#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002484 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002485#define telnet_full_usage \
2486 "Telnet is used to establish interactive communication with another\n"\
2487 "computer over a network using the TELNET protocol."
Eric Andersen539ffc92004-02-22 12:25:47 +00002488#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002489
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002490#ifdef CONFIG_FEATURE_TELNETD_INETD
2491#define telnetd_trivial_usage \
2492 "(inetd mode) [OPTION]"
2493#define telnetd_full_usage \
2494 "Telnetd uses incoming TELNET connections via inetd.\n"\
2495 "Options:\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002496 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)\n" \
2497 "\t-f issue_file\tDisplay issue_file instead of /etc/issue."
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002498#else
Eric Andersen08a72202002-09-30 20:52:10 +00002499#define telnetd_trivial_usage \
2500 "[OPTION]"
2501#define telnetd_full_usage \
2502 "Telnetd listens for incoming TELNET connections on PORT.\n"\
2503 "Options:\n" \
2504 "\t-p PORT\tlisten for connections on PORT (default 23)\n"\
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002505 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)\n"\
2506 "\t-f issue_file\tDisplay issue_file instead of /etc/issue."
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002507#endif
Eric Andersen08a72202002-09-30 20:52:10 +00002508
Eric Andersen7e9276b2001-02-22 01:15:47 +00002509#define test_trivial_usage \
2510 "EXPRESSION\n or [ EXPRESSION ]"
2511#define test_full_usage \
2512 "Checks file types and compares values returning an exit\n" \
2513 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002514#define test_example_usage \
2515 "$ test 1 -eq 2\n" \
2516 "$ echo $?\n" \
2517 "1\n" \
2518 "$ test 1 -eq 1\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002519 "$ echo $?\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002520 "0\n" \
2521 "$ [ -d /etc ]\n" \
2522 "$ echo $?\n" \
2523 "0\n" \
2524 "$ [ -d /junk ]\n" \
2525 "$ echo $?\n" \
2526 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002527
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002528#ifdef CONFIG_FEATURE_TFTP_GET
Mark Whitley450736c2001-03-02 19:08:50 +00002529 #define USAGE_TFTP_GET(a) a
2530#else
2531 #define USAGE_TFTP_GET(a)
2532#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002533#ifdef CONFIG_FEATURE_TFTP_PUT
Mark Whitley450736c2001-03-02 19:08:50 +00002534 #define USAGE_TFTP_PUT(a) a
2535#else
2536 #define USAGE_TFTP_PUT(a)
2537#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002538#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Glenn L McGrathad117d82001-10-05 04:40:37 +00002539 #define USAGE_TFTP_BS(a) a
2540#else
2541 #define USAGE_TFTP_BS(a)
2542#endif
Mark Whitley450736c2001-03-02 19:08:50 +00002543
2544#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00002545 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00002546#define tftp_full_usage \
2547 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00002548 "Options:\n" \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002549 "\t-l FILE\tLocal FILE.\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002550 "\t-r FILE\tRemote FILE." \
Mark Whitley450736c2001-03-02 19:08:50 +00002551 USAGE_TFTP_GET( \
Eric Andersen178de172004-04-06 16:36:20 +00002552 "\n\t-g\tGet file." \
Mark Whitley450736c2001-03-02 19:08:50 +00002553 ) \
2554 USAGE_TFTP_PUT( \
Eric Andersen178de172004-04-06 16:36:20 +00002555 "\n\t-p\tPut file." \
Mark Whitley450736c2001-03-02 19:08:50 +00002556 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002557 USAGE_TFTP_BS( \
Eric Andersen178de172004-04-06 16:36:20 +00002558 "\n\t-b SIZE\tTransfer blocks of SIZE octets." \
Tim Riker7b253f82003-12-28 05:02:40 +00002559 )
Eric Andersenc3657422001-11-30 07:54:32 +00002560#define time_trivial_usage \
2561 "[OPTION]... COMMAND [ARGS...]"
2562#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00002563 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
2564 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00002565 "Options:\n" \
2566 "\t-v\tDisplays verbose resource usage information."
Mark Whitley450736c2001-03-02 19:08:50 +00002567
Eric Andersen420b2082002-09-17 22:14:58 +00002568#define top_trivial_usage \
2569 "[-d <seconds>]"
2570#define top_full_usage \
2571 "top provides an view of processor activity in real time.\n" \
2572 "This utility reads the status for all processes in /proc each <seconds>\n" \
2573 "and shows the status for however many processes will fit on the screen.\n" \
2574 "This utility will not show processes that are started after program startup,\n" \
2575 "but it will show the EXIT status for and PIDs that exit while it is running."
2576
Eric Andersen7e9276b2001-02-22 01:15:47 +00002577#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002578 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002579#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002580 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002581 "Options:\n" \
2582 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002583#define touch_example_usage \
2584 "$ ls -l /tmp/foo\n" \
2585 "/bin/ls: /tmp/foo: No such file or directory\n" \
2586 "$ touch /tmp/foo\n" \
2587 "$ ls -l /tmp/foo\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002588 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002589
2590#define tr_trivial_usage \
2591 "[-cds] STRING1 [STRING2]"
2592#define tr_full_usage \
2593 "Translate, squeeze, and/or delete characters from\n" \
2594 "standard input, writing to standard output.\n\n" \
2595 "Options:\n" \
2596 "\t-c\ttake complement of STRING1\n" \
2597 "\t-d\tdelete input characters coded STRING1\n" \
2598 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002599#define tr_example_usage \
2600 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002601 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002602
Eric Andersen5c58d282001-07-10 16:29:00 +00002603#define traceroute_trivial_usage \
Eric Andersen15c03c32004-04-06 17:52:02 +00002604 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n"\
2605 "\t[-s src_addr] [-t tos] [-w wait] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00002606#define traceroute_full_usage \
2607 "trace the route ip packets follow going to \"host\"\n" \
2608 "Options:\n" \
2609 "\t-d\tset SO_DEBUG options to socket\n" \
2610 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
2611 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
2612 "\t-v\tVerbose output\n" \
2613 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
2614 "\t-p port#\tSet the base UDP port number used in probes\n" \
2615 "\t\t(default is 33434)\n" \
2616 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
2617 "\t\t(default is 3)\n" \
2618 "\t-s src_addr\tUse the following IP address as the source address\n" \
2619 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
2620 "\t\t(default 0)\n" \
2621 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
2622 "\t\t(default 3 sec.)."
2623
2624
Eric Andersen7e9276b2001-02-22 01:15:47 +00002625#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002626 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002627#define true_full_usage \
2628 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002629#define true_example_usage \
2630 "$ true\n" \
2631 "$ echo $?\n" \
2632 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002633
Eric Andersen7e9276b2001-02-22 01:15:47 +00002634#define tty_trivial_usage \
2635 ""
2636#define tty_full_usage \
2637 "Print the file name of the terminal connected to standard input.\n\n"\
2638 "Options:\n" \
2639 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002640#define tty_example_usage \
2641 "$ tty\n" \
2642 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002643
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002644#define udhcpc_trivial_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00002645 "[-fbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002646#define udhcpc_full_usage \
2647 "\t-c,\t--clientid=CLIENTID\tClient identifier\n" \
2648 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00002649 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002650 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00002651 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated.\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002652 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
2653 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated.\n" \
2654 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
2655 "\t-q,\t--quit\tQuit after obtaining lease\n" \
2656 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
2657 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
2658 "\t-v,\t--version\tDisplay version"
2659
Russ Dill61fb4892002-10-14 21:41:28 +00002660#define udhcpd_trivial_usage \
2661 "[configfile]\n" \
2662
2663#define udhcpd_full_usage \
Glenn L McGrath9130c852002-12-12 12:56:18 +00002664 ""
Russ Dill61fb4892002-10-14 21:41:28 +00002665
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002666#ifdef CONFIG_FEATURE_MOUNT_FORCE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002667 #define USAGE_MOUNT_FORCE(a) a
2668#else
2669 #define USAGE_MOUNT_FORCE(a)
2670#endif
2671#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002672 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002673#define umount_full_usage \
2674 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00002675 "\nFlags:\n" "\t-a\tUnmount all file systems" \
2676 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
2677 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00002678 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00002679 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 +00002680#define umount_example_usage \
2681 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002682
2683#define uname_trivial_usage \
2684 "[OPTION]..."
2685#define uname_full_usage \
2686 "Print certain system information. With no OPTION, same as -s.\n\n" \
2687 "Options:\n" \
2688 "\t-a\tprint all information\n" \
2689 "\t-m\tthe machine (hardware) type\n" \
2690 "\t-n\tprint the machine's network node hostname\n" \
2691 "\t-r\tprint the operating system release\n" \
2692 "\t-s\tprint the operating system name\n" \
2693 "\t-p\tprint the host processor type\n" \
2694 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002695#define uname_example_usage \
2696 "$ uname -a\n" \
Eric Andersen7f48a952003-12-28 05:06:56 +00002697 "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 +00002698
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00002699#define uncompress_trivial_usage \
2700 "[-c] [-f] [ name ... ]"
2701#define uncompress_full_usage \
2702 "Uncompress .Z file[s]\n" \
2703 "Options:\n" \
2704 "\t-c\textract to stdout\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002705 "\t-f\tforce overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00002706
Eric Andersen7e9276b2001-02-22 01:15:47 +00002707#define uniq_trivial_usage \
2708 "[OPTION]... [INPUT [OUTPUT]]"
2709#define uniq_full_usage \
2710 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00002711 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002712 "Options:\n" \
2713 "\t-c\tprefix lines by the number of occurrences\n" \
2714 "\t-d\tonly print duplicate lines\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002715 "\t-u\tonly print unique lines\n" \
2716 "\t-f N\tskip the first N fields\n" \
2717 "\t-s N\tskip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002718#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002719 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002720 "a\n" \
2721 "b\n" \
2722 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002723
2724#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002725 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002726#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002727 "Converts FILE from unix format to dos format. When no option\n" \
2728 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002729 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002730 "Options:\n" \
2731 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002732 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002733
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002734#define unzip_trivial_usage \
2735 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
2736#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002737 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002738 "Options:\n" \
2739 "\t-l\tlist archive contents (short form)\n" \
2740 "\t-n\tnever overwrite existing files (default)\n" \
2741 "\t-o\toverwrite files without prompting\n" \
2742 "\t-p\tsend output to stdout\n" \
2743 "\t-q\tbe quiet\n" \
2744 "\t-x\texclude these files\n" \
2745 "\t-d\textract files into this directory"
2746
Eric Andersen7e9276b2001-02-22 01:15:47 +00002747#define uptime_trivial_usage \
2748 ""
2749#define uptime_full_usage \
2750 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002751#define uptime_example_usage \
2752 "$ uptime\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002753 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002754
2755#define usleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002756 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002757#define usleep_full_usage \
2758 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002759#define usleep_example_usage \
2760 "$ usleep 1000000\n" \
2761 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002762
2763#define uudecode_trivial_usage \
2764 "[FILE]..."
2765#define uudecode_full_usage \
2766 "Uudecode a file that is uuencoded.\n\n" \
2767 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002768 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002769#define uudecode_example_usage \
2770 "$ uudecode -o busybox busybox.uu\n" \
2771 "$ ls -l busybox\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002772 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002773
2774#define uuencode_trivial_usage \
2775 "[OPTION] [INFILE] REMOTEFILE"
2776#define uuencode_full_usage \
2777 "Uuencode a file.\n\n" \
2778 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00002779 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002780#define uuencode_example_usage \
2781 "$ uuencode busybox busybox\n" \
2782 "begin 755 busybox\n" \
2783 "<encoded file snipped>\n" \
2784 "$ uudecode busybox busybox > busybox.uu\n" \
2785 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002786
Eric Andersen853c4942003-01-23 05:59:32 +00002787#define vconfig_trivial_usage \
2788 "COMMAND [OPTIONS] ..."
Eric Andersen853c4942003-01-23 05:59:32 +00002789#define vconfig_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002790 "vconfig lets you create and remove virtual ethernet devices.\n\n" \
2791 "Options:\n" \
2792 "\tadd [interface-name] [vlan_id]\n" \
2793 "\trem [vlan-name]\n" \
2794 "\tset_flag [interface-name] [flag-num] [0 | 1]\n" \
2795 "\tset_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
2796 "\tset_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
2797 "\tset_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00002798
Eric Andersen3f980402001-04-04 17:31:15 +00002799#define vi_trivial_usage \
2800 "[OPTION] [FILE]..."
2801#define vi_full_usage \
2802 "edit FILE.\n\n" \
2803 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002804 "\t-R\tRead-only- do not write to the file."
Eric Andersen3f980402001-04-04 17:31:15 +00002805
Eric Andersen27f64e12002-06-23 04:24:25 +00002806#define vlock_trivial_usage \
2807 "[OPTIONS]"
2808#define vlock_full_usage \
2809 "Lock a virtual terminal. A password is required to unlock\n" \
2810 "Options:\n" \
2811 "\t-a\tLock all VTs"
2812
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002813#define watch_trivial_usage \
2814 "[-n <seconds>] COMMAND..."
2815#define watch_full_usage \
2816 "Executes a program periodically.\n" \
2817 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002818 "\t-n\tLoop period in seconds - default is 2."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002819#define watch_example_usage \
2820 "$ watch date\n" \
2821 "Mon Dec 17 10:31:40 GMT 2000\n" \
2822 "Mon Dec 17 10:31:42 GMT 2000\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002823 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002824
Eric Andersen7e9276b2001-02-22 01:15:47 +00002825#define watchdog_trivial_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00002826 "[-t <seconds>] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002827#define watchdog_full_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00002828 "Periodically write to watchdog device DEV.\n" \
2829 "Options:\n" \
2830 "\t-t\tTimer period in seconds - default is 30."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002831
2832#define wc_trivial_usage \
2833 "[OPTION]... [FILE]..."
2834#define wc_full_usage \
2835 "Print line, word, and byte counts for each FILE, and a total line if\n" \
2836 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
2837 "Options:\n" \
2838 "\t-c\tprint the byte counts\n" \
2839 "\t-l\tprint the newline counts\n" \
2840 "\t-L\tprint the length of the longest line\n" \
2841 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002842#define wc_example_usage \
2843 "$ wc /etc/passwd\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002844 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002845
2846#define wget_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002847 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00002848 "\t\t[--header 'header: value'] [-Y|--proxy on/off] [-P DIR] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002849#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00002850 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002851 "Options:\n" \
2852 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00002853 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00002854 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00002855 "\t-O\tsave to filename ('-' for stdout)\n" \
2856 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002857
2858#define which_trivial_usage \
2859 "[COMMAND ...]"
2860#define which_full_usage \
2861 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002862#define which_example_usage \
2863 "$ which login\n" \
2864 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00002865
Eric Andersen00a6a752002-04-26 23:53:10 +00002866#define who_trivial_usage \
2867 " "
2868#define who_full_usage \
2869 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002870
2871#define whoami_trivial_usage \
2872 ""
2873#define whoami_full_usage \
2874 "Prints the user name associated with the current effective user id."
2875
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002876#ifdef CONFIG_FEATURE_XARGS_SUPPORT_CONFIRMATION
2877#define USAGE_XARGS_CONFIRMATION(a) a
2878#else
2879#define USAGE_XARGS_CONFIRMATION(a)
2880#endif
2881#ifdef CONFIG_FEATURE_XARGS_SUPPORT_TERMOPT
2882#define USAGE_XARGS_TERMOPT(a) a
2883#else
2884#define USAGE_XARGS_TERMOPT(a)
2885#endif
2886#ifdef CONFIG_FEATURE_XARGS_SUPPORT_ZERO_TERM
2887#define USAGE_XARGS_ZERO_TERM(a) a
2888#else
2889#define USAGE_XARGS_ZERO_TERM(a)
2890#endif
2891
2892
Eric Andersen7e9276b2001-02-22 01:15:47 +00002893#define xargs_trivial_usage \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002894 "[COMMAND] [OPTIONS] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002895#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002896 "Executes COMMAND on every item given by standard input.\n\n" \
2897 "Options:\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002898 USAGE_XARGS_CONFIRMATION("\t-p\tPrompt the user about whether to run each command\n") \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002899 "\t-r\tDo not run command for empty readed lines\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002900 USAGE_XARGS_TERMOPT("\t-x\tExit if the size is exceeded\n") \
2901 USAGE_XARGS_ZERO_TERM("\t-0\tInput filenames are terminated by a null character\n") \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002902 "\t-t\tPrint the command line on stderr before executing it."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002903#define xargs_example_usage \
2904 "$ ls | xargs gzip\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002905 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002906
2907#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002908 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002909#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002910 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002911
Eric Andersen7e9276b2001-02-22 01:15:47 +00002912#define zcat_trivial_usage \
2913 "FILE"
2914#define zcat_full_usage \
2915 "Uncompress to stdout."
Eric Andersen178de172004-04-06 16:36:20 +00002916
2917#endif /* __BB_USAGE_H__ */