blob: d0f3dfc99b856b144bf00e24a9f5056e4d76ac1f [file] [log] [blame]
Eric Andersenf349e972001-08-21 16:18:59 +00001#define addgroup_trivial_usage \
2 "[OPTIONS] <group_name>"
3#define addgroup_full_usage \
4 "Adds a group to the system" \
5 "Options:\n" \
6 "\t-g\t\tspecify gid\n"
7
8#define adduser_trivial_usage \
9 "[OPTIONS] <user_name>"
10#define adduser_full_usage \
11 "Adds a user to the system" \
12 "Options:\n" \
13 "\t-h\t\thome directory\n" \
14 "\t-s\t\tshell\n" \
15 "\t-g\t\tGECOS string\n"
16
Mark Whitley6f932772001-03-20 19:18:10 +000017#define adjtimex_trivial_usage \
18 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
19#define adjtimex_full_usage \
20 "Reads and optionally sets system timebase parameters.\n" \
21 "See adjtimex(2).\n\n" \
22 "Options:\n" \
23 "\t-q\t\tquiet mode - do not print\n" \
24 "\t-o offset\ttime offset, microseconds\n" \
25 "\t-f frequency\tfrequency adjust, integer kernel units (65536 is 1ppm)\n" \
26 "\t\t\t(positive values make the system clock run fast)\n" \
27 "\t-t tick\t\tmicroseconds per tick, usually 10000\n" \
28 "\t-p timeconstant\n"
29
Eric Andersen7e9276b2001-02-22 01:15:47 +000030#define ar_trivial_usage \
Glenn L McGrath62ebe2e2001-06-03 05:41:59 +000031 "-[ov][ptx] ARCHIVE FILES"
Eric Andersen7e9276b2001-02-22 01:15:47 +000032#define ar_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +000033 "Extract or list FILES from an ar archive.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +000034 "Options:\n" \
35 "\t-o\t\tpreserve original dates\n" \
36 "\t-p\t\textract to stdout\n" \
37 "\t-t\t\tlist\n" \
38 "\t-x\t\textract\n" \
Glenn L McGrathcda5cf12001-06-03 05:15:04 +000039 "\t-v\t\tverbosely list files processed\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000040
Eric Andersen7e9276b2001-02-22 01:15:47 +000041#define basename_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000042 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000043#define basename_full_usage \
44 "Strips directory path and suffixes from FILE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000045 "If specified, also removes any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000046#define basename_example_usage \
47 "$ basename /usr/local/bin/foo\n" \
48 "foo\n" \
49 "$ basename /usr/local/bin/\n" \
50 "bin\n" \
51 "$ basename /foo/bar.txt .txt\n" \
52 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000053
Glenn L McGrath24e28332001-10-05 03:48:57 +000054#define bunzip2_trivial_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000055 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +000056#define bunzip2_full_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000057 "Uncompress FILE (or standard input if FILE is '-' or omitted).\n\n" \
58 "Options:\n" \
59 "\t-c\tWrite output to standard output\n" \
60 "\t-f\tForce"
Glenn L McGrath24e28332001-10-05 03:48:57 +000061
Glenn L McGrathfff11f12001-11-18 14:20:25 +000062#define bzcat_trivial_usage \
63 "FILE"
64#define bzcat_full_usage \
65 "Uncompress to stdout."
66
Eric Andersenc98c0622001-12-06 15:16:43 +000067#define cal_trivial_usage \
68 "[-jy] [[month] year]"
69#define cal_full_usage \
70 "Display a calendar.\n" \
71 "\nOptions:\n" \
72 "\t-j\tUse julian dates.\n" \
73 "\t-y\tDisplay the entire year."
74
Eric Andersen7e9276b2001-02-22 01:15:47 +000075#define cat_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000076 "[FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000077#define cat_full_usage \
78 "Concatenates FILE(s) and prints them to stdout."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000079#define cat_example_usage \
80 "$ cat /proc/uptime\n" \
81 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000082
Eric Andersen7e9276b2001-02-22 01:15:47 +000083#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000084 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000085#define chgrp_full_usage \
86 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000087 "\nOptions:\n" \
88 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000089#define chgrp_example_usage \
90 "$ ls -l /tmp/foo\n" \
91 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
92 "$ chgrp root /tmp/foo\n" \
93 "$ ls -l /tmp/foo\n" \
94 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000095
Eric Andersen7e9276b2001-02-22 01:15:47 +000096#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000097 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000098#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000099 "Each MODE is one or more of the letters ugoa, one of the\n" \
100 "symbols +-= and one or more of the letters rwxst.\n\n" \
101 "Options:\n" \
102 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000103#define chmod_example_usage \
104 "$ ls -l /tmp/foo\n" \
105 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
106 "$ chmod u+x /tmp/foo\n" \
107 "$ ls -l /tmp/foo\n" \
108 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
109 "$ chmod 444 /tmp/foo\n" \
110 "$ ls -l /tmp/foo\n" \
111 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000112
Eric Andersen7e9276b2001-02-22 01:15:47 +0000113#define chown_trivial_usage \
Eric Andersen238da242001-05-11 16:31:46 +0000114 "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000115#define chown_full_usage \
116 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000117 "\nOptions:\n" \
Eric Andersen238da242001-05-11 16:31:46 +0000118 "\t-R\tChanges files and directories recursively.\n" \
119 "\t-h\tDo not dereference symbolic links."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000120#define chown_example_usage \
121 "$ ls -l /tmp/foo\n" \
122 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
123 "$ chown root /tmp/foo\n" \
124 "$ ls -l /tmp/foo\n" \
125 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
126 "$ chown root.root /tmp/foo\n" \
127 "ls -l /tmp/foo\n" \
128 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000129
Eric Andersen7e9276b2001-02-22 01:15:47 +0000130#define chroot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000131 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000132#define chroot_full_usage \
133 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000134#define chroot_example_usage \
135 "$ ls -l /bin/ls\n" \
136 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
137 "$ mount /dev/hdc1 /mnt -t minix\n" \
138 "$ chroot /mnt\n" \
139 "$ ls -l /bin/ls\n" \
140 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000141
Eric Andersen7e9276b2001-02-22 01:15:47 +0000142#define chvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000143 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000144#define chvt_full_usage \
145 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000146
Eric Andersen7e9276b2001-02-22 01:15:47 +0000147#define clear_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000148 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000149#define clear_full_usage \
150 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000151
Eric Andersen7e9276b2001-02-22 01:15:47 +0000152#define cmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000153 "FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000154#define cmp_full_usage \
Mark Whitley207587a2001-04-25 20:41:02 +0000155 "\t-s\tquiet mode - do not print\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000156 "Compare files."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000157
Eric Andersen7e9276b2001-02-22 01:15:47 +0000158#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000159 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000160#define cp_full_usage \
161 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
162 "\n" \
163 "\t-a\tSame as -dpR\n" \
164 "\t-d\tPreserves links\n" \
165 "\t-p\tPreserves file attributes if possible\n" \
166 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000167 "\t-R\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000168
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000169#define cpio_trivial_usage \
170 "-[dimtuv][F cpiofile]"
171#define cpio_full_usage \
172 "Extract or list files from a cpio archive\n" \
173 "Main operation mode:\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000174 "\td\t\tmake leading directories\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000175 "\ti\t\textract\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000176 "\tm\t\tpreserve mtime\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000177 "\tt\t\tlist\n" \
Eric Andersen6925d502001-12-16 09:23:09 +0000178 "\tu\t\tunconditional overwrite\n" \
179 "\tF\t\tinput from file"
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000180
Eric Andersen7e9276b2001-02-22 01:15:47 +0000181#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000182 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000183#define cut_full_usage \
184 "Prints selected fields from each input FILE to standard output.\n\n" \
185 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000186 "\t-b LIST\t\tOutput only bytes from LIST\n" \
187 "\t-c LIST\t\tOutput only characters from LIST\n" \
188 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
189 "\t-s\t\tOutput only the lines containing delimiter\n" \
190 "\t-f N\t\tPrint only these fields\n" \
191 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000192#define cut_example_usage \
193 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
194 "Hello\n" \
195 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
196 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000197
Eric Andersen7e9276b2001-02-22 01:15:47 +0000198#define date_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000199 "[OPTION]... [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000200#define date_full_usage \
201 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000202 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000203 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000204 "\t-d STRING\tdisplay time described by STRING, not `now'\n" \
205 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000206 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000207#define date_example_usage \
208 "$ date\n" \
209 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000210
Eric Andersen7e9276b2001-02-22 01:15:47 +0000211#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000212 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000213#define dc_full_usage \
214 "This is a Tiny RPN calculator that understands the\n" \
215 "following operations: +, -, /, *, and, or, not, eor.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000216 "i.e., 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000217#define dc_example_usage \
218 "$ dc 2 2 +\n" \
219 "4\n" \
220 "$ dc 8 8 \* 2 2 + /\n" \
221 "16\n" \
222 "$ dc 0 1 and\n" \
223 "0\n" \
224 "$ dc 0 1 or\n" \
225 "1\n" \
226 "$ echo 72 9 div 8 mul | dc\n" \
227 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000228
Eric Andersen7e9276b2001-02-22 01:15:47 +0000229#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000230 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000231 "\t [seek=N] [conv=notrunc|noerror|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000232#define dd_full_usage \
233 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000234 "\tif=FILE\t\tread from FILE instead of stdin\n" \
235 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
236 "\tbs=N\t\tread and write N bytes at a time\n" \
237 "\tcount=N\t\tcopy only N input blocks\n" \
238 "\tskip=N\t\tskip N input blocks\n" \
239 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000240 "\tconv=notrunc\tdon't truncate output file\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000241 "\tconv=noerror\tcontinue after read errors\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000242 "\tconv=sync\tpad blocks with zeros\n" \
243 "\n" \
244 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000245 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000246#define dd_example_usage \
247 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
248 "4+0 records in\n" \
249 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000250
Eric Andersen7e9276b2001-02-22 01:15:47 +0000251#define deallocvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000252 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000253#define deallocvt_full_usage \
254 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000255
Eric Andersenf349e972001-08-21 16:18:59 +0000256#define delgroup_trivial_usage \
257 "GROUP"
258#define delgroup_full_usage \
259 "Deletes group GROUP from the system"
260
261#define deluser_trivial_usage \
262 "USER"
263#define deluser_full_usage \
264 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000265
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000266#ifdef CONFIG_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000267 #define USAGE_HUMAN_READABLE(a) a
268 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000269#else
Eric Andersened0d9582001-02-23 13:23:03 +0000270 #define USAGE_HUMAN_READABLE(a)
271 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000272#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000273#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000274 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000275#define df_full_usage \
276 "Print the filesystem space used and space available.\n\n" \
277 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000278 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000279 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
280 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000281 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000282 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000283#define df_example_usage \
284 "$ df\n" \
285 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
286 "/dev/sda3 8690864 8553540 137324 98% /\n" \
287 "/dev/sda1 64216 36364 27852 57% /boot\n" \
288 "$ df /dev/sda3\n" \
289 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
290 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000291
Eric Andersen7e9276b2001-02-22 01:15:47 +0000292#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000293 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000294#define dirname_full_usage \
295 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000296#define dirname_example_usage \
297 "$ dirname /tmp/foo\n" \
298 "/tmp\n" \
299 "$ dirname /tmp/foo/\n" \
300 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000301
Eric Andersen7e9276b2001-02-22 01:15:47 +0000302#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000303 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000304#define dmesg_full_usage \
305 "Prints or controls the kernel ring buffer\n\n" \
306 "Options:\n" \
307 "\t-c\t\tClears the ring buffer's contents after printing\n" \
308 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000309 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000310
Eric Andersen7e9276b2001-02-22 01:15:47 +0000311#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000312 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000313#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000314 "Converts FILE from dos format to unix format. When no option\n" \
315 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000316 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000317 "Options:\n" \
318 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000319 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000320
Eric Andersen7e9276b2001-02-22 01:15:47 +0000321#define dpkg_trivial_usage \
Eric Andersen9fe5f982002-04-13 14:48:51 +0000322 "-i package_file\n" \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000323 "[-CPru] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000324#define dpkg_full_usage \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000325 "\t-i\tInstall the package\n" \
326 "\t-C\tConfigure an unpackaged package\n" \
327 "\t-P\tPurge all files of a package\n" \
328 "\t-r\tRemove all but the configuration files for a package\n" \
329 "\t-u\tUnpack a package, but dont configure it\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000330
Eric Andersen7e9276b2001-02-22 01:15:47 +0000331#define dpkg_deb_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000332 "[-cefItxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000333#define dpkg_deb_full_usage \
334 "Perform actions on debian packages (.debs)\n\n" \
335 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000336 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000337 "\t-e\tExtract control files to [argument] directory\n" \
338 "\t-f\tDisplay control field name starting with [argument]\n" \
339 "\t-I\tDisplay the control filenamed [argument]\n" \
340 "\t-t\tExtract filesystem tree to stdout in tar format\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000341 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000342 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000343#define dpkg_deb_example_usage \
344 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000345
Eric Andersen7e9276b2001-02-22 01:15:47 +0000346#define du_trivial_usage \
Eric Andersen265d2292002-04-06 23:16:44 +0000347 "[-lsx" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000348#define du_full_usage \
349 "Summarizes disk space used for each FILE and/or directory.\n" \
350 "Disk space is printed in units of 1024 bytes.\n\n" \
351 "Options:\n" \
352 "\t-l\tcount sizes many times if hard linked\n" \
353 "\t-s\tdisplay only a total for each argument" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000354 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000355 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
356 "\t-m\tprint sizes in megabytes\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000357 "\t-x\tskip directories on different filesystems\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000358 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000359 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000360#define du_example_usage \
361 "$ du\n" \
362 "16 ./CVS\n" \
363 "12 ./kernel-patches/CVS\n" \
364 "80 ./kernel-patches\n" \
365 "12 ./tests/CVS\n" \
366 "36 ./tests\n" \
367 "12 ./scripts/CVS\n" \
368 "16 ./scripts\n" \
369 "12 ./docs/CVS\n" \
370 "104 ./docs\n" \
371 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000372
Eric Andersen7e9276b2001-02-22 01:15:47 +0000373#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000374 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000375#define dumpkmap_full_usage \
376 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000377#define dumpkmap_example_usage \
378 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000379
Eric Andersen7e9276b2001-02-22 01:15:47 +0000380#define dutmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000381 "[FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000382#define dutmp_full_usage \
383 "Dump utmp file format (pipe delimited) from FILE\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000384 "or stdin to stdout. (i.e., 'dutmp /var/run/utmp')"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000385#define dutmp_example_usage \
386 "$ dutmp /var/run/utmp\n" \
387 "8|7||si|||0|0|0|955637625|760097|0\n" \
388 "2|0|~|~~|reboot||0|0|0|955637625|782235|0\n" \
389 "1|20020|~|~~|runlevel||0|0|0|955637625|800089|0\n" \
390 "8|125||l4|||0|0|0|955637629|998367|0\n" \
391 "6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0\n" \
392 "6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0\n" \
393 "7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000394
Eric Andersen7e9276b2001-02-22 01:15:47 +0000395#define echo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000396 "[-neE] [ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000397#define echo_full_usage \
398 "Prints the specified ARGs to stdout\n\n" \
399 "Options:\n" \
400 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000401 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000402 "\t-E\tdisable interpretation of backslash-escaped characters"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000403#define echo_example_usage \
404 "$ echo "Erik is cool"\n" \
405 "Erik is cool\n" \
John Beppu5d817682001-04-17 17:09:34 +0000406 "$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000407 "Erik\n" \
408 "is\n" \
409 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000410 "$ echo "Erik\\nis\\ncool"\n" \
411 "Erik\\nis\\ncool\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000412
Eric Andersen84e229c2001-03-29 22:48:33 +0000413#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000414 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000415#define env_full_usage \
416 "Prints the current environment or runs a program after setting\n" \
417 "up the specified environment.\n\n" \
418 "Options:\n" \
419 "\t-, -i\tstart with an empty environment\n" \
420 "\t-u\tremove variable from the environment\n"
421
Eric Andersen7e9276b2001-02-22 01:15:47 +0000422#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000423 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000424#define expr_full_usage \
425 "Prints the value of EXPRESSION to standard output.\n\n" \
426 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000427 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
428 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
429 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
430 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
431 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
432 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
433 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
434 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
435 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
436 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
437 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
438 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
439 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000440 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
441 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
442 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
443 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
444 "\t or 0\n" \
445 "\tlength STRING length of STRING\n" \
446 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
447 "\t it is a keyword like `match' or an\n" \
448 "\t operator like `/'\n" \
449 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000450 "Beware that many operators need to be escaped or quoted for shells.\n" \
451 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
452 "lexicographical. Pattern matches return the string matched between \n" \
453 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
454 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000455
Eric Andersen7e9276b2001-02-22 01:15:47 +0000456#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000457 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000458#define false_full_usage \
459 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000460#define false_example_usage \
461 "$ false\n" \
462 "$ echo $?\n" \
463 "1\n"
464
465#define fbset_trivial_usage \
466 "[options] [mode]"
467#define fbset_full_usage \
468 "Show and modify frame buffer settings"
469#define fbset_example_usage \
470 "$ fbset\n" \
471 "mode "1024x768-76"\n" \
472 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
473 "\tgeometry 1024 768 1024 768 16\n" \
474 "\ttimings 12714 128 32 16 4 128 4\n" \
475 "\taccel false\n" \
476 "\trgba 5/11,6/5,5/0,0/0\n" \
477 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000478
Eric Andersen7e9276b2001-02-22 01:15:47 +0000479#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000480 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000481#define fdflush_full_usage \
482 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000483
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000484#ifdef CONFIG_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000485 #define USAGE_FIND_TYPE(a) a
486#else
487 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000488#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000489#ifdef CONFIG_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000490 #define USAGE_FIND_PERM(a) a
491#else
492 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000493#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000494#ifdef CONFIG_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000495 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000496#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000497 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000498#endif
499
Eric Andersen7e9276b2001-02-22 01:15:47 +0000500#define find_trivial_usage \
501 "[PATH...] [EXPRESSION]"
502#define find_full_usage \
503 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000504 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000505 "\nEXPRESSION may consist of:\n" \
506 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000507 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000508 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000509 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000510 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
511) USAGE_FIND_PERM( \
512 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
513) USAGE_FIND_MTIME( \
514 "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000515#define find_example_usage \
516 "$ find / -name /etc/passwd\n" \
517 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000518
Eric Andersen7e9276b2001-02-22 01:15:47 +0000519#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000520 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000521#define free_full_usage \
522 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000523#define free_example_usage \
524 "$ free\n" \
525 " total used free shared buffers\n" \
526 " Mem: 257628 248724 8904 59644 93124\n" \
527 " Swap: 128516 8404 120112\n" \
528 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000529
Eric Andersen7e9276b2001-02-22 01:15:47 +0000530#define freeramdisk_trivial_usage \
531 "DEVICE"
532#define freeramdisk_full_usage \
533 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000534#define freeramdisk_example_usage \
535 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000536
537#define fsck_minix_trivial_usage \
538 "[-larvsmf] /dev/name"
539#define fsck_minix_full_usage \
540 "Performs a consistency check for MINIX filesystems.\n\n" \
541 "Options:\n" \
542 "\t-l\tLists all filenames\n" \
543 "\t-r\tPerform interactive repairs\n" \
544 "\t-a\tPerform automatic repairs\n" \
545 "\t-v\tverbose\n" \
546 "\t-s\tOutputs super-block information\n" \
547 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
548 "\t-f\tForce file system check."
549
550#define getopt_trivial_usage \
551 "[OPTIONS]..."
552#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000553 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000554 "\t-a, --alternative Allow long options starting with single -\n" \
555 "\t-l, --longoptions=longopts Long options to be recognized\n" \
556 "\t-n, --name=progname The name under which errors are reported\n" \
557 "\t-o, --options=optstring Short options to be recognized\n" \
558 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
559 "\t-Q, --quiet-output No normal output\n" \
560 "\t-s, --shell=shell Set shell quoting conventions\n" \
561 "\t-T, --test Test for getopt(1) version\n" \
562 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000563#define getopt_example_usage \
564 "$ cat getopt.test\n" \
565 "#!/bin/sh\n" \
566 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
567 " -n 'example.busybox' -- "$@"`\n" \
568 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
569 "eval set -- "$GETOPT"\n" \
570 "while true ; do\n" \
571 " case $1 in\n" \
572 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
573 " -b|--b-long) echo \"Option b, argument \`$2'\" ; shift 2 ;;\n" \
574 " -c|--c-long)\n" \
575 " case "$2" in\n" \
576 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
577 " *) echo \"Option c, argument \`$2'\" ; shift 2 ;;\n" \
578 " esac ;;\n" \
579 " --) shift ; break ;;\n" \
580 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
581 " esac\n" \
582 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000583
Eric Andersenf349e972001-08-21 16:18:59 +0000584#define getty_trivial_usage \
585 "getty [OPTIONS]... baud_rate,... line [termtype]"
586#define getty_full_usage \
587 "\nOpens a tty, prompts for a login name, then invokes /bin/login\n\n" \
588 "Options:\n" \
589 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
590 "\t-i\t\tDo not display /etc/issue before running login.\n" \
591 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
592 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
593 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
594 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
595 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
596 "\t-I initstring\tSets the init string to send before anything else.\n" \
597 "\t-H login_host\tLog login_host into the utmp file as the hostname."
598
599
Eric Andersen7e9276b2001-02-22 01:15:47 +0000600#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000601 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000602#define grep_full_usage \
603 "Search for PATTERN in each FILE or standard input.\n\n" \
604 "Options:\n" \
605 "\t-H\tprefix output lines with filename where match was found\n" \
606 "\t-h\tsuppress the prefixing filename on output\n" \
607 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000608 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000609 "\t-n\tprint line number with output lines\n" \
610 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
611 "\t-v\tselect non-matching lines\n" \
612 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000613#define grep_example_usage \
614 "$ grep root /etc/passwd\n" \
615 "root:x:0:0:root:/root:/bin/bash\n" \
616 "$ grep ^[rR]oo. /etc/passwd\n" \
617 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000618
Eric Andersen7e9276b2001-02-22 01:15:47 +0000619#define gunzip_trivial_usage \
620 "[OPTION]... FILE"
621#define gunzip_full_usage \
622 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
623 "Options:\n" \
624 "\t-c\tWrite output to standard output\n" \
625 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000626#define gunzip_example_usage \
627 "$ ls -la /tmp/BusyBox*\n" \
628 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
629 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
630 "$ ls -la /tmp/BusyBox*\n" \
631 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000632
633#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000634 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000635#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000636 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000637 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000638 "Options:\n" \
639 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
640 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000641#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000642 "$ ls -la /tmp/busybox*\n" \
643 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
644 "$ gzip /tmp/busybox.tar\n" \
645 "$ ls -la /tmp/busybox*\n" \
646 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000647
648#define halt_trivial_usage \
649 ""
650#define halt_full_usage \
651 "Halt the system."
652
653#define head_trivial_usage \
654 "[OPTION] [FILE]..."
655#define head_full_usage \
656 "Print first 10 lines of each FILE to standard output.\n" \
657 "With more than one FILE, precede each with a header giving the\n" \
658 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000659 "Options:\n" \
660 "\t-n NUM\t\tPrint first NUM lines instead of first 10"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000661#define head_example_usage \
662 "$ head -n 2 /etc/passwd\n" \
663 "root:x:0:0:root:/root:/bin/bash\n" \
664 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000665
Glenn L McGrath60281112001-11-02 11:39:46 +0000666#define hexdump_trivial_usage \
667 "[-[bcdefnosvx]] [OPTION] FILE"
668#define hexdump_full_usage \
669 "The hexdump utility is a filter which displays the specified files,\n" \
670 "or the standard input, if no files are specified, in a user specified\n"\
671 "format\n" \
672 "\t-b\t\tOne-byte octal display\n" \
673 "\t-c\t\tOne-byte character display\n" \
674 "\t-d\t\tTwo-byte decimal display\n" \
675 "\t-e FORMAT STRING\n" \
676 "\t-f FORMAT FILE\n" \
677 "\t-n LENGTH\tInterpret only length bytes of input\n" \
678 "\t-o\t\tTwo-byte octal display\n" \
679 "\t-s OFFSET\tSkip offset byte\n" \
680 "\t-v\t\tdisplay all input data\n" \
681 "\t-x\t\tTwo-byte hexadecimal display\n"
682
Eric Andersen7e9276b2001-02-22 01:15:47 +0000683#define hostid_trivial_usage \
684 ""
685#define hostid_full_usage \
686 "Print out a unique 32-bit identifier for the machine."
687
688#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000689 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000690#define hostname_full_usage \
691 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000692 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000693 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +0000694 "\t-s\tShort\n" \
695 "\t-i\tAddresses for the hostname\n" \
696 "\t-d\tDNS domain name\n" \
697 "\t-f\tFully qualified domain name\n" \
698 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000699#define hostname_example_usage \
700 "$ hostname\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000701 "sage \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000702
703#define id_trivial_usage \
704 "[OPTIONS]... [USERNAME]"
705#define id_full_usage \
706 "Print information for USERNAME or the current user\n\n" \
707 "Options:\n" \
708 "\t-g\tprints only the group ID\n" \
709 "\t-u\tprints only the user ID\n" \
710 "\t-n\tprint a name instead of a number (with for -ug)\n" \
711 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000712#define id_example_usage \
713 "$ id\n" \
714 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000715
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000716#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +0000717 #define USAGE_SIOCSKEEPALIVE(a) a
718#else
719 #define USAGE_SIOCSKEEPALIVE(a)
720#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000721#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000722 #define USAGE_IFCONFIG_MII(a) a
723#else
724 #define USAGE_IFCONFIG_MII(a)
725#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000726#ifdef CONFIG_FEATURE_IFCONFIG_HW
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000727 #define USAGE_IFCONFIG_HW(a) a
728#else
729 #define USAGE_IFCONFIG_HW(a)
730#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000731#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000732 #define USAGE_IFCONFIG_OPT_A(a) a
733#else
734 #define USAGE_IFCONFIG_OPT_A(a)
735#endif
736
Eric Andersen7e9276b2001-02-22 01:15:47 +0000737#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000738 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000739#define ifconfig_full_usage \
740 "configure a network interface\n\n" \
741 "Options:\n" \
742 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000743 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000744 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000745 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
746 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000747 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000748 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
749 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000750 "\t[up|down] ..."
751
752#define init_trivial_usage \
753 ""
754#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000755 "Init is the parent of all processes."
756#define init_notes_usage \
757"This version of init is designed to be run only by the kernel.\n" \
758"\n" \
759"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
760"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
761"runlevels, use sysvinit.\n" \
762"\n" \
763"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
764"it has the following default behavior:\n" \
765"\n" \
766" ::sysinit:/etc/init.d/rcS\n" \
767" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000768" ::ctrlaltdel:/sbin/reboot\n" \
769" ::shutdown:/sbin/swapoff -a\n" \
770" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000771" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000772"\n" \
773"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
774"\n" \
775" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000776" tty3::askfirst:/bin/sh\n" \
777" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000778"\n" \
779"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
780"\n" \
781" <id>:<runlevels>:<action>:<process>\n" \
782"\n" \
783" <id>: \n" \
784"\n" \
785" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
786" The id field is used by BusyBox init to specify the controlling tty for\n" \
787" the specified process to run on. The contents of this field are\n" \
788" appended to "/dev/" and used as-is. There is no need for this field to\n" \
789" be unique, although if it isn't you may have strange results. If this\n" \
790" field is left blank, the controlling tty is set to the console. Also\n" \
791" note that if BusyBox detects that a serial console is in use, then only\n" \
792" entries whose controlling tty is either the serial console or /dev/null\n" \
793" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
794" stinkin' utmp.\n" \
795"\n" \
796" <runlevels>: \n" \
797"\n" \
798" The runlevels field is completely ignored.\n" \
799"\n" \
800" <action>: \n" \
801"\n" \
802" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000803" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000804"\n" \
805" The available actions can be classified into two groups: actions\n" \
806" that are run only once, and actions that are re-run when the specified\n" \
807" process exits.\n" \
808"\n" \
809" Run only-once actions:\n" \
810"\n" \
811" 'sysinit' is the first item run on boot. init waits until all\n" \
812" sysinit actions are completed before continuing. Following the\n" \
813" completion of all sysinit actions, all 'wait' actions are run.\n" \
814" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000815" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000816" therefore, init does not wait for them to complete. 'restart' is\n" \
817" the action taken to restart the init process. By default this should\n" \
818" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
819" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000820" actions are run when the system detects that someone on the system\n" \
821" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
822" wants to run 'reboot' at this point to cause the system to reboot.\n" \
823" Finally the 'shutdown' action specifies the actions to taken when\n" \
824" init is told to reboot. Unmounting filesystems and disabling swap\n" \
825" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000826"\n" \
827" Run repeatedly actions:\n" \
828"\n" \
829" 'respawn' actions are run after the 'once' actions. When a process\n" \
830" started with a 'respawn' action exits, init automatically restarts\n" \
831" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
832" respawning out of control. The 'askfirst' actions acts just like\n" \
833" respawn, except that before running the specified process it\n" \
834" displays the line "Please press Enter to activate this console."\n" \
835" and then waits for the user to press enter before starting the\n" \
836" specified process. \n" \
837"\n" \
838" Unrecognized actions (like initdefault) will cause init to emit an\n" \
839" error message, and then go along with its business. All actions are\n" \
840" run in the reverse order from how they appear in /etc/inittab.\n" \
841"\n" \
842" <process>: \n" \
843"\n" \
844" Specifies the process to be executed and it's command line.\n" \
845"\n" \
846"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +0000847"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000848" # This is run first except when booting in single-user mode.\n" \
849" #\n" \
850" ::sysinit:/etc/init.d/rcS\n" \
851" \n" \
852" # /bin/sh invocations on selected ttys\n" \
853" #\n" \
854" # Start an "askfirst" shell on the console (whatever that may be)\n" \
855" ::askfirst:-/bin/sh\n" \
856" # Start an "askfirst" shell on /dev/tty2-4\n" \
857" tty2::askfirst:-/bin/sh\n" \
858" tty3::askfirst:-/bin/sh\n" \
859" tty4::askfirst:-/bin/sh\n" \
860" \n" \
861" # /sbin/getty invocations for selected ttys\n" \
862" #\n" \
863" tty4::respawn:/sbin/getty 38400 tty5\n" \
864" tty5::respawn:/sbin/getty 38400 tty6\n" \
865" \n" \
866" \n" \
867" # Example of how to put a getty on a serial line (for a terminal)\n" \
868" #\n" \
869" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
870" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
871" #\n" \
872" # Example how to put a getty on a modem line.\n" \
873" #::respawn:/sbin/getty 57600 ttyS2\n" \
874" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000875" # Stuff to do when restarting the init process\n" \
876" ::restart:/sbin/init\n" \
877" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000878" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000879" ::ctrlaltdel:/sbin/reboot\n" \
880" ::shutdown:/bin/umount -a -r\n" \
881" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000882
883#define insmod_trivial_usage \
884 "[OPTION]... MODULE [symbol=value]..."
885#define insmod_full_usage \
886 "Loads the specified kernel modules into the kernel.\n\n" \
887 "Options:\n" \
888 "\t-f\tForce module to load into the wrong kernel version.\n" \
889 "\t-k\tMake module autoclean-able.\n" \
890 "\t-v\tverbose output\n" \
891 "\t-L\tLock to prevent simultaneous loads of a module\n" \
892 "\t-x\tdo not export externs"
893
894#define kill_trivial_usage \
895 "[-signal] process-id [process-id ...]"
896#define kill_full_usage \
897 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +0000898 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000899 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000900#define kill_example_usage \
901 "$ ps | grep apache\n" \
902 "252 root root S [apache]\n" \
903 "263 www-data www-data S [apache]\n" \
904 "264 www-data www-data S [apache]\n" \
905 "265 www-data www-data S [apache]\n" \
906 "266 www-data www-data S [apache]\n" \
907 "267 www-data www-data S [apache]\n" \
908 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000909
910#define killall_trivial_usage \
911 "[-signal] process-name [process-name ...]"
912#define killall_full_usage \
913 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000914 "Options:\n" \
915 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000916#define killall_example_usage \
917 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000918
Mark Whitley6317c4b2001-03-12 22:51:50 +0000919#define klogd_trivial_usage \
920 "-n"
921#define klogd_full_usage \
922 "Kernel logger.\n"\
923 "Options:\n"\
924 "\t-n\tRun as a foreground process."
925
Eric Andersen7e9276b2001-02-22 01:15:47 +0000926#define length_trivial_usage \
927 "STRING"
928#define length_full_usage \
929 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000930#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +0000931 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000932 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000933
934#define ln_trivial_usage \
935 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
936#define ln_full_usage \
937 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
938 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
939 "Options:\n" \
940 "\t-s\tmake symbolic links instead of hard links\n" \
941 "\t-f\tremove existing destination files\n" \
942 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000943#define ln_example_usage \
944 "$ ln -s BusyBox /tmp/ls\n" \
945 "$ ls -l /tmp/ls\n" \
946 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000947
948#define loadacm_trivial_usage \
949 "< mapfile"
950#define loadacm_full_usage \
951 "Loads an acm from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000952#define loadacm_example_usage \
953 "$ loadacm < /etc/i18n/acmname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000954
955#define loadfont_trivial_usage \
956 "< font"
957#define loadfont_full_usage \
958 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000959#define loadfont_example_usage \
960 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000961
962#define loadkmap_trivial_usage \
963 "< keymap"
964#define loadkmap_full_usage \
965 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000966#define loadkmap_example_usage \
967 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000968
969#define logger_trivial_usage \
970 "[OPTION]... [MESSAGE]"
971#define logger_full_usage \
972 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
973 "Options:\n" \
974 "\t-s\tLog to stderr as well as the system log.\n" \
975 "\t-t\tLog using the specified tag (defaults to user name).\n" \
976 "\t-p\tEnter the message with the specified priority.\n" \
977 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000978#define logger_example_usage \
979 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000980
981#define logname_trivial_usage \
982 ""
983#define logname_full_usage \
984 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000985#define logname_example_usage \
986 "$ logname\n" \
987 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000988
Mark Whitley6317c4b2001-03-12 22:51:50 +0000989#define logread_trivial_usage \
990 ""
991
992#define logread_full_usage \
993 "Shows the messages from syslogd (using circular buffer)."
994
Matt Kraai83788da2002-03-20 17:38:37 +0000995#define losetup_trivial_usage \
996 "[OPTION]... LOOPDEVICE FILE\n" \
997 "or: losetup [OPTION]... -d LOOPDEVICE"
998#define losetup_full_usage \
999 "Associate LOOPDEVICE with FILE.\n\n" \
1000 "Options:\n" \
1001 "\t-d\t\tDisassociate LOOPDEVICE.\n" \
1002 "\t-o OFFSET\tStart OFFSET bytes into FILE.\n"
1003
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001004#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001005 #define USAGE_LS_TIMESTAMPS(a) a
1006#else
1007 #define USAGE_LS_TIMESTAMPS(a)
1008#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001009#ifdef CONFIG_FEATURE_LS_FILETYPES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001010 #define USAGE_LS_FILETYPES(a) a
1011#else
1012 #define USAGE_LS_FILETYPES(a)
1013#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001014#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001015 #define USAGE_LS_FOLLOWLINKS(a) a
1016#else
1017 #define USAGE_LS_FOLLOWLINKS(a)
1018#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001019#ifdef CONFIG_FEATURE_LS_RECURSIVE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001020 #define USAGE_LS_RECURSIVE(a) a
1021#else
1022 #define USAGE_LS_RECURSIVE(a)
1023#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001024#ifdef CONFIG_FEATURE_LS_SORTFILES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001025 #define USAGE_LS_SORTFILES(a) a
1026#else
1027 #define USAGE_LS_SORTFILES(a)
1028#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001029#ifdef CONFIG_FEATURE_AUTOWIDTH
Eric Andersen7e9276b2001-02-22 01:15:47 +00001030 #define USAGE_AUTOWIDTH(a) a
1031#else
1032 #define USAGE_AUTOWIDTH(a)
1033#endif
1034#define ls_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +00001035 "[-1Aa" USAGE_LS_TIMESTAMPS("c") "Cd" USAGE_LS_TIMESTAMPS("e") USAGE_LS_FILETYPES("F") "iln" USAGE_LS_FILETYPES("p") USAGE_LS_FOLLOWLINKS("L") USAGE_LS_RECURSIVE("R") USAGE_LS_SORTFILES("rS") "s" USAGE_AUTOWIDTH("T") USAGE_LS_TIMESTAMPS("tu") USAGE_LS_SORTFILES("v") USAGE_AUTOWIDTH("w") "x" USAGE_LS_SORTFILES("X") USAGE_HUMAN_READABLE("h") USAGE_NOT_HUMAN_READABLE("") "k] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001036#define ls_full_usage \
1037 "List directory contents\n\n" \
1038 "Options:\n" \
1039 "\t-1\tlist files in a single column\n" \
1040 "\t-A\tdo not list implied . and ..\n" \
1041 "\t-a\tdo not hide entries starting with .\n" \
1042 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001043 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001044 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001045 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1046 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001047 "\t-i\tlist the i-node for each file\n" \
1048 "\t-l\tuse a long listing format\n" \
1049 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001050 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1051 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1052 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1053 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1054 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001055 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001056 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1057 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1058 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1059 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1060 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001061 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001062 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1063 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001064 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersened0d9582001-02-23 13:23:03 +00001065 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +00001066 "\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001067
1068#define lsmod_trivial_usage \
1069 ""
1070#define lsmod_full_usage \
1071 "List the currently loaded kernel modules."
1072
1073#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001074 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001075#define makedevs_full_usage \
1076 "Creates a range of block or character special files\n\n" \
1077 "TYPEs include:\n" \
1078 "\tb:\tMake a block (buffered) device.\n" \
1079 "\tc or u:\tMake a character (un-buffered) device.\n" \
1080 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1081 "FIRST specifies the number appended to NAME to create the first device.\n" \
1082 "LAST specifies the number of the last item that should be created.\n" \
1083 "If 's' is the last argument, the base device is created as well.\n\n" \
1084 "For example:\n" \
1085 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001086 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001087#define makedevs_example_usage \
1088 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
1089 "[creates ttyS2-ttyS63]\n" \
1090 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
1091 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001092
Eric Andersen7e9276b2001-02-22 01:15:47 +00001093#define md5sum_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001094 "[OPTION] [FILE]...\n" \
1095 "or: md5sum [OPTION] -c [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001096#define md5sum_full_usage \
1097 "Print or check MD5 checksums.\n\n" \
1098 "Options:\n" \
1099 "With no FILE, or when FILE is -, read standard input.\n\n" \
1100 "\t-b\tread files in binary mode\n" \
1101 "\t-c\tcheck MD5 sums against given list\n" \
1102 "\t-t\tread files in text mode (default)\n" \
1103 "\t-g\tread a string\n" \
1104 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001105 "\t-s\tdon't output anything, status code shows success\n" \
1106 "\t-w\twarn about improperly formated MD5 checksum lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001107#define md5sum_example_usage \
1108 "$ md5sum < busybox\n" \
1109 "6fd11e98b98a58f64ff3398d7b324003\n" \
1110 "$ md5sum busybox\n" \
1111 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1112 "$ md5sum -c -\n" \
1113 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1114 "busybox: OK\n" \
1115 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001116
Eric Andersen7e9276b2001-02-22 01:15:47 +00001117#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001118 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001119#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001120 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001121 "Options:\n" \
1122 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001123 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001124#define mkdir_example_usage \
1125 "$ mkdir /tmp/foo\n" \
1126 "$ mkdir /tmp/foo\n" \
1127 "/tmp/foo: File exists\n" \
1128 "$ mkdir /tmp/foo/bar/baz\n" \
1129 "/tmp/foo/bar/baz: No such file or directory\n" \
1130 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001131
Eric Andersen7e9276b2001-02-22 01:15:47 +00001132#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001133 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001134#define mkfifo_full_usage \
1135 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1136 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001137 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001138
Eric Andersen7e9276b2001-02-22 01:15:47 +00001139#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001140 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001141#define mkfs_minix_full_usage \
1142 "Make a MINIX filesystem.\n\n" \
1143 "Options:\n" \
1144 "\t-c\t\tCheck the device for bad blocks\n" \
1145 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1146 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1147 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001148 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001149
Eric Andersen7e9276b2001-02-22 01:15:47 +00001150#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001151 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001152#define mknod_full_usage \
1153 "Create a special file (block, character, or pipe).\n\n" \
1154 "Options:\n" \
1155 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1156 "TYPEs include:\n" \
1157 "\tb:\tMake a block (buffered) device.\n" \
1158 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001159 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001160#define mknod_example_usage \
1161 "$ mknod /dev/fd0 b 2 0 \n" \
1162 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001163
Eric Andersen7e9276b2001-02-22 01:15:47 +00001164#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001165 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001166#define mkswap_full_usage \
1167 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001168 "Options:\n" \
1169 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001170 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001171 "\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 +00001172 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001173
Eric Andersen7e9276b2001-02-22 01:15:47 +00001174#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001175 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001176#define mktemp_full_usage \
1177 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001178 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001179#define mktemp_example_usage \
1180 "$ mktemp /tmp/temp.XXXXXX\n" \
1181 "/tmp/temp.mWiLjM\n" \
1182 "$ ls -la /tmp/temp.mWiLjM\n" \
1183 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001184
Eric Andersen8d79ce82001-07-22 23:00:15 +00001185#define modprobe_trivial_usage \
1186 "[FILE ...]"
1187#define modprobe_full_usage \
1188 "Used for hight level module loading and unloading."
1189#define modprobe_example_usage \
1190 "$ modprobe cdrom\n"
1191
Eric Andersen7e9276b2001-02-22 01:15:47 +00001192#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001193 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001194#define more_full_usage \
1195 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001196#define more_example_usage \
1197 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001198
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001199#ifdef CONFIG_FEATURE_MOUNT_LOOP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001200 #define USAGE_MOUNT_LOOP(a) a
1201#else
1202 #define USAGE_MOUNT_LOOP(a)
1203#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001204#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001205 #define USAGE_MTAB(a) a
1206#else
1207 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001208#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001209#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001210 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001211#define mount_full_usage \
1212 "Mount a filesystem\n\n" \
1213 "Flags:\n" \
1214 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001215 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001216 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001217 "\t-n:\t\tDon't write a mount table entry.\n" \
1218 ) \
1219 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1220 "\t-r:\t\tMount the filesystem read-only.\n" \
1221 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1222 "\t-w:\t\tMount for reading and writing (default).\n" \
1223 "\n" \
1224 "Options for use with the \"-o\" flag:\n" \
1225 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1226 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1227 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1228 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001229 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001230 "\tloop:\t\tMounts a file via loop device.\n" \
1231 ) \
1232 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001233 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001234 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001235 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001236 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001237 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001238#define mount_example_usage \
1239 "$ mount\n" \
1240 "/dev/hda3 on / type minix (rw)\n" \
1241 "proc on /proc type proc (rw)\n" \
1242 "devpts on /dev/pts type devpts (rw)\n" \
1243 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1244 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001245
Eric Andersen7e9276b2001-02-22 01:15:47 +00001246#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001247 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001248#define mt_full_usage \
1249 "Control magnetic tape drive operation\n" \
1250 "\nAvailable Opcodes:\n\n" \
1251 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1252 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
1253 "ras3 reset retension rew rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001254 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001255
Eric Andersen7e9276b2001-02-22 01:15:47 +00001256#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001257 "SOURCE DEST\n" \
1258 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001259#define mv_full_usage \
1260 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001261#define mv_example_usage \
1262 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001263
Eric Andersen7e9276b2001-02-22 01:15:47 +00001264#define nc_trivial_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001265 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001266#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001267 "Netcat opens a pipe to IP:port\n\n" \
1268 "Options:\n" \
1269 "\t-l\t\tlisten mode, for inbound connects\n" \
1270 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00001271 "\t-i SECS\t\tdelay interval for lines sent\n" \
Eric Andersen00a6a752002-04-26 23:53:10 +00001272 "\t-e PROG\t\tprogram to exec after connect (dangerous!)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001273#define nc_example_usage \
1274 "$ nc foobar.somedomain.com 25\n" \
1275 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1276 "help\n" \
1277 "214-Commands supported:\n" \
1278 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1279 "214 NOOP QUIT RSET HELP\n" \
1280 "quit\n" \
1281 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001282
Eric Andersen1552ff72001-10-31 11:07:12 +00001283#define netstat_trivial_usage \
1284 "[-lantuwx]"
1285#define netstat_full_usage \
1286 "-l display listening server sockets\n" \
1287 "-a display all sockets (default: connected)\n" \
1288 "-n don't resolve names\n" \
1289 "-t tcp sockets\n" \
1290 "-u udp sockets\n" \
1291 "-w raw sockets\n" \
1292 "-x unix sockets\n"
1293
Eric Andersen7e9276b2001-02-22 01:15:47 +00001294#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001295 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001296#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001297 "Queries the nameserver for the IP address of the given HOST\n" \
1298 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001299#define nslookup_example_usage \
1300 "$ nslookup localhost\n" \
1301 "Server: default\n" \
1302 "Address: default\n" \
1303 "\n" \
1304 "Name: debian\n" \
1305 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001306
Glenn L McGrath60281112001-11-02 11:39:46 +00001307#define od_trivial_usage \
1308 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
1309#define od_full_usage \
1310 "Write an unambiguous representation, octal bytes by default, of FILE\n"\
1311 "to standard output. With no FILE, or when FILE is -, read standard input."
1312
Eric Andersen221b2ea2001-07-31 19:06:07 +00001313#define pidof_trivial_usage \
1314 "process-name [process-name ...]"
1315#define pidof_full_usage \
1316 "Lists the PIDs of all processes with names that match the names on the command line"
1317#define pidof_example_usage \
1318 "$ pidof init\n" \
1319 "1\n"
1320
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001321#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001322#define ping_trivial_usage "host"
1323#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1324#else
1325#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001326 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001327#define ping_full_usage \
1328 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1329 "Options:\n" \
1330 "\t-c COUNT\tSend only COUNT pings.\n" \
1331 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1332 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001333 "\t\t\tand when finished."
1334#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001335#define ping_example_usage \
1336 "$ ping localhost\n" \
1337 "PING slag (127.0.0.1): 56 data bytes\n" \
1338 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1339 "\n" \
1340 "--- debian ping statistics ---\n" \
1341 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1342 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001343
Eric Andersen7e9276b2001-02-22 01:15:47 +00001344#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001345 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001346#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001347 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001348 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001349
Eric Andersen7e9276b2001-02-22 01:15:47 +00001350#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001351 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001352#define poweroff_full_usage \
1353 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001354
Eric Andersen7e9276b2001-02-22 01:15:47 +00001355#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001356 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001357#define printf_full_usage \
1358 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001359 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001360#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001361 "$ printf "Val=%d\\n" 5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001362 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001363
Eric Andersen7e9276b2001-02-22 01:15:47 +00001364#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001365 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001366#define ps_full_usage \
1367 "Report process status\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001368 "\nThis version of ps accepts no options."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001369#define ps_example_usage \
1370 "$ ps\n" \
1371 " PID Uid Gid State Command\n" \
1372 " 1 root root S init\n" \
1373 " 2 root root S [kflushd]\n" \
1374 " 3 root root S [kupdate]\n" \
1375 " 4 root root S [kpiod]\n" \
1376 " 5 root root S [kswapd]\n" \
1377 " 742 andersen andersen S [bash]\n" \
1378 " 743 andersen andersen S -bash\n" \
1379 " 745 root root S [getty]\n" \
1380 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001381
Eric Andersen7e9276b2001-02-22 01:15:47 +00001382#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001383 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001384#define pwd_full_usage \
1385 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001386#define pwd_example_usage \
1387 "$ pwd\n" \
1388 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001389
Eric Andersen7e9276b2001-02-22 01:15:47 +00001390#define rdate_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001391 "[OPTION] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001392#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001393 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001394 "Options:\n" \
1395 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001396 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001397
Eric Andersen7e9276b2001-02-22 01:15:47 +00001398#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001399 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001400#define readlink_full_usage \
1401 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001402
Eric Andersen7e9276b2001-02-22 01:15:47 +00001403#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001404 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001405#define reboot_full_usage \
1406 "Reboot the system."
1407
1408#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001409 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001410#define renice_full_usage \
1411 "Changes priority of running processes. Allowed priorities range\n" \
1412 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001413 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001414
Eric Andersen7e9276b2001-02-22 01:15:47 +00001415#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001416 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001417#define reset_full_usage \
1418 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001419
Eric Andersen7e9276b2001-02-22 01:15:47 +00001420#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001421 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001422#define rm_full_usage \
1423 "Remove (unlink) the FILE(s). You may use '--' to\n" \
1424 "indicate that all following arguments are non-options.\n\n" \
1425 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00001426 "\t-i\t\talways prompt before removing each destination" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001427 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001428 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001429#define rm_example_usage \
1430 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001431
Eric Andersen7e9276b2001-02-22 01:15:47 +00001432#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001433 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001434#define rmdir_full_usage \
1435 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001436#define rmdir_example_usage \
1437 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001438
Eric Andersen7e9276b2001-02-22 01:15:47 +00001439#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001440 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001441#define rmmod_full_usage \
1442 "Unloads the specified kernel modules from the kernel.\n\n" \
1443 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001444 "\t-a\tTry to remove all unused kernel modules."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001445#define rmmod_example_usage \
1446 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001447
Eric Andersen7e9276b2001-02-22 01:15:47 +00001448#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001449 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001450#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00001451 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00001452 "Options:\n" \
1453 "\t-n\tDont resolve names."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001454
Glenn L McGrathf8736d22001-06-26 01:19:34 +00001455#define rpm2cpio_trivial_usage \
1456 "package.rpm"
1457#define rpm2cpio_full_usage \
1458 "Outputs a cpio archive of the rpm file."
1459
Eric Andersen6cf47a72001-10-31 10:24:36 +00001460#define run_parts_trivial_usage \
1461 "[-t] [-a ARG] [-u MASK] DIRECTORY"
1462#define run_parts_full_usage \
1463 "Run a bunch of scripts in a directory.\n\n" \
1464 "Options:\n" \
1465 "\t-t\t\tTest only what file will be executed, without execute them.\n" \
1466 "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \
1467 "\t-u MASK\tSet the umask to MASK before executing every program."
1468
Eric Andersen7e9276b2001-02-22 01:15:47 +00001469#define sed_trivial_usage \
Matt Kraai075228a2001-06-21 14:40:55 +00001470 "[-nef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001471#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001472 "Options:\n" \
1473 "\t-n\t\tsuppress automatic printing of pattern space\n" \
1474 "\t-e script\tadd the script to the commands to be executed\n" \
1475 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001476 "\n" \
1477 "If no -e or -f is given, the first non-option argument is taken as the\n" \
1478 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001479 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001480#define sed_example_usage \
1481 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
1482 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001483
Eric Andersen7e9276b2001-02-22 01:15:47 +00001484#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001485 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001486#define setkeycodes_full_usage \
1487 "Set entries into the kernel's scancode-to-keycode map,\n" \
1488 "allowing unusual keyboards to generate usable keycodes.\n\n" \
1489 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001490 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001491#define setkeycodes_example_usage \
1492 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001493
Matt Kraai2d91deb2001-08-01 17:21:35 +00001494#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001495 "[FILE]...\n" \
1496 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00001497#define lash_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001498 "lash: The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00001499#define lash_notes_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001500"This command does not yet have proper documentation.\n" \
1501"\n" \
1502"Use lash just as you would use any other shell. It properly handles pipes,\n" \
1503"redirects, job control, can be used as the shell for scripts, and has a\n" \
1504"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
1505"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
1506"use ash or bash. If you just need a very simple and extremely small shell,\n" \
1507"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001508
Eric Andersen7e9276b2001-02-22 01:15:47 +00001509#define sleep_trivial_usage \
1510 "N"
1511#define sleep_full_usage \
1512 "Pause for N seconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001513#define sleep_example_usage \
1514 "$ sleep 2\n" \
1515 "[2 second delay results]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001516
Eric Andersen7e9276b2001-02-22 01:15:47 +00001517
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001518#ifdef CONFIG_FEATURE_SORT_UNIQUE
Mark Whitleyfccaa362001-04-17 18:56:18 +00001519 #define USAGE_SORT_UNIQUE(a) a
1520#else
1521 #define USAGE_SORT_UNIQUE(a)
1522#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001523#ifdef CONFIG_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001524 #define USAGE_SORT_REVERSE(a) a
1525#else
1526 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001527#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001528#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001529 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001530#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001531 "Sorts lines of text in the specified files\n\n"\
1532 "Options:\n" \
1533 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
1534 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
1535 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001536#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001537 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001538 "a\n" \
1539 "b\n" \
1540 "c\n" \
1541 "d\n" \
1542 "e\n" \
1543 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001544
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001545#define start_stop_daemon_trivial_usage \
1546 "[OPTIONS]"
1547#define start_stop_daemon_full_usage \
1548 "Program to start and stop services.\n"\
1549 "Options:\n" \
1550 "-S\t\t\tstart\n"\
1551 "-K\t\t\tstop\n"\
1552 "-x <executable>\t\tprogram to start/check if it is running\n"\
1553 "-p <pid-file>\t\tpid file to check\n"\
1554 "-u <username>|<uid>\tstop this user's processes\n"\
1555 "-n <process-name>\tstop processes with this name\n"\
1556 "-s <signal>\t\tsignal to send (default 15)\n"\
1557 "-a <pathname>\t\tprogram to start (default <executable>)\n"
1558
Eric Andersen7e9276b2001-02-22 01:15:47 +00001559#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001560 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001561#define stty_full_usage \
1562 "Without arguments, prints baud rate, line discipline," \
1563 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001564 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00001565 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001566 "\n\t-a\t\tprint all current settings in human-readable form" \
1567 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00001568 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001569
Eric Andersen7e9276b2001-02-22 01:15:47 +00001570#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001571 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001572#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001573 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001574 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001575 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001576
Eric Andersen7e9276b2001-02-22 01:15:47 +00001577#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001578 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001579#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001580 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001581 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001582 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001583
Eric Andersen7e9276b2001-02-22 01:15:47 +00001584#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001585 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001586#define sync_full_usage \
1587 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001588
Eric Andersen7e9276b2001-02-22 01:15:47 +00001589
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001590#ifdef CONFIG_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00001591 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001592#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00001593 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001594#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001595#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001596 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001597#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00001598 "Linux system and kernel logging utility.\n" \
1599 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001600 "Options:\n" \
1601 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
1602 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001603 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001604 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00001605 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
1606 "\t-L\t\tLog locally and via network logging (default is network only)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001607#define syslogd_example_usage \
1608 "$ syslogd -R masterlog:514\n" \
1609 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001610
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001611
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001612#ifndef CONFIG_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00001613 #define USAGE_UNSIMPLE_TAIL(a)
1614#else
1615 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001616#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001617#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001618 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001619#define tail_full_usage \
1620 "Print last 10 lines of each FILE to standard output.\n" \
1621 "With more than one FILE, precede each with a header giving the\n" \
1622 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
1623 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001624 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001625 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
1626 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001627 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001628 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
1629 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001630 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001631 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001632 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
1633#define tail_example_usage \
1634 "$ tail -n 1 /etc/resolv.conf\n" \
1635 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001636
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001637#ifdef CONFIG_FEATURE_TAR_CREATE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001638 #define USAGE_TAR_CREATE(a) a
1639#else
1640 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001641#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001642#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001643 #define USAGE_TAR_EXCLUDE(a) a
1644#else
1645 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001646#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001647#define tar_trivial_usage \
1648 "-[" USAGE_TAR_CREATE("c") "xtvO] " \
Eric Andersen317827d2001-05-21 17:50:53 +00001649 USAGE_TAR_EXCLUDE("[--exclude FILE] [-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00001650 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001651#define tar_full_usage \
1652 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00001653 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001654 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001655 "\tx\t\textract\n" \
1656 "\tt\t\tlist\n" \
1657 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001658 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001659 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001660 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001661 "\texclude\t\tfile to exclude\n" \
1662 "\tX\t\tfile with names to exclude\n" \
1663 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00001664 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001665 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001666#define tar_example_usage \
1667 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
1668 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001669
Eric Andersen7e9276b2001-02-22 01:15:47 +00001670#define tee_trivial_usage \
1671 "[OPTION]... [FILE]..."
1672#define tee_full_usage \
1673 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001674 "Options:\n" \
1675 "\t-a\tappend to the given FILEs, do not overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001676#define tee_example_usage \
1677 "$ echo "Hello" | tee /tmp/foo\n" \
1678 "$ cat /tmp/foo\n" \
1679 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001680
Eric Andersen7e9276b2001-02-22 01:15:47 +00001681#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001682 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001683#define telnet_full_usage \
1684 "Telnet is used to establish interactive communication with another\n"\
1685 "computer over a network using the TELNET protocol."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001686
Eric Andersen7e9276b2001-02-22 01:15:47 +00001687#define test_trivial_usage \
1688 "EXPRESSION\n or [ EXPRESSION ]"
1689#define test_full_usage \
1690 "Checks file types and compares values returning an exit\n" \
1691 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001692#define test_example_usage \
1693 "$ test 1 -eq 2\n" \
1694 "$ echo $?\n" \
1695 "1\n" \
1696 "$ test 1 -eq 1\n" \
1697 "$ echo $? \n" \
1698 "0\n" \
1699 "$ [ -d /etc ]\n" \
1700 "$ echo $?\n" \
1701 "0\n" \
1702 "$ [ -d /junk ]\n" \
1703 "$ echo $?\n" \
1704 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001705
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001706#ifdef CONFIG_FEATURE_TFTP_GET
Mark Whitley450736c2001-03-02 19:08:50 +00001707 #define USAGE_TFTP_GET(a) a
1708#else
1709 #define USAGE_TFTP_GET(a)
1710#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001711#ifdef CONFIG_FEATURE_TFTP_PUT
Mark Whitley450736c2001-03-02 19:08:50 +00001712 #define USAGE_TFTP_PUT(a) a
1713#else
1714 #define USAGE_TFTP_PUT(a)
1715#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001716#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Glenn L McGrathad117d82001-10-05 04:40:37 +00001717 #define USAGE_TFTP_BS(a) a
1718#else
1719 #define USAGE_TFTP_BS(a)
1720#endif
Mark Whitley450736c2001-03-02 19:08:50 +00001721
1722#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00001723 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00001724#define tftp_full_usage \
1725 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00001726 "Options:\n" \
Glenn L McGrathad117d82001-10-05 04:40:37 +00001727 "\t-l FILE\tLocal FILE.\n" \
1728 "\t-r FILE\tRemote FILE.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00001729 USAGE_TFTP_GET( \
Matt Kraai3be34302001-09-21 14:42:30 +00001730 "\t-g\tGet file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00001731 ) \
1732 USAGE_TFTP_PUT( \
Matt Kraai3be34302001-09-21 14:42:30 +00001733 "\t-p\tPut file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00001734 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00001735 USAGE_TFTP_BS( \
1736 "\t-b SIZE\tTransfer blocks of SIZE octets.\n" \
1737 )
Eric Andersenc3657422001-11-30 07:54:32 +00001738#define time_trivial_usage \
1739 "[OPTION]... COMMAND [ARGS...]"
1740#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00001741 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
1742 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00001743 "Options:\n" \
1744 "\t-v\tDisplays verbose resource usage information."
Mark Whitley450736c2001-03-02 19:08:50 +00001745
Eric Andersen7e9276b2001-02-22 01:15:47 +00001746#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001747 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001748#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001749 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001750 "Options:\n" \
1751 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001752#define touch_example_usage \
1753 "$ ls -l /tmp/foo\n" \
1754 "/bin/ls: /tmp/foo: No such file or directory\n" \
1755 "$ touch /tmp/foo\n" \
1756 "$ ls -l /tmp/foo\n" \
1757 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001758
1759#define tr_trivial_usage \
1760 "[-cds] STRING1 [STRING2]"
1761#define tr_full_usage \
1762 "Translate, squeeze, and/or delete characters from\n" \
1763 "standard input, writing to standard output.\n\n" \
1764 "Options:\n" \
1765 "\t-c\ttake complement of STRING1\n" \
1766 "\t-d\tdelete input characters coded STRING1\n" \
1767 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001768#define tr_example_usage \
1769 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
1770 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001771
Eric Andersen5c58d282001-07-10 16:29:00 +00001772#define traceroute_trivial_usage \
1773 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n\
1774 [-s src_addr] [-t tos] [-w wait] host [data size]"
1775#define traceroute_full_usage \
1776 "trace the route ip packets follow going to \"host\"\n" \
1777 "Options:\n" \
1778 "\t-d\tset SO_DEBUG options to socket\n" \
1779 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
1780 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
1781 "\t-v\tVerbose output\n" \
1782 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
1783 "\t-p port#\tSet the base UDP port number used in probes\n" \
1784 "\t\t(default is 33434)\n" \
1785 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
1786 "\t\t(default is 3)\n" \
1787 "\t-s src_addr\tUse the following IP address as the source address\n" \
1788 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
1789 "\t\t(default 0)\n" \
1790 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
1791 "\t\t(default 3 sec.)."
1792
1793
Eric Andersen7e9276b2001-02-22 01:15:47 +00001794#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001795 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001796#define true_full_usage \
1797 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001798#define true_example_usage \
1799 "$ true\n" \
1800 "$ echo $?\n" \
1801 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001802
Eric Andersen7e9276b2001-02-22 01:15:47 +00001803#define tty_trivial_usage \
1804 ""
1805#define tty_full_usage \
1806 "Print the file name of the terminal connected to standard input.\n\n"\
1807 "Options:\n" \
1808 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001809#define tty_example_usage \
1810 "$ tty\n" \
1811 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001812
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001813#ifdef CONFIG_FEATURE_MOUNT_FORCE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001814 #define USAGE_MOUNT_FORCE(a) a
1815#else
1816 #define USAGE_MOUNT_FORCE(a)
1817#endif
1818#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001819 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001820#define umount_full_usage \
1821 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00001822 "\nFlags:\n" "\t-a\tUnmount all file systems" \
1823 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
1824 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00001825 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00001826 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 +00001827#define umount_example_usage \
1828 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001829
1830#define uname_trivial_usage \
1831 "[OPTION]..."
1832#define uname_full_usage \
1833 "Print certain system information. With no OPTION, same as -s.\n\n" \
1834 "Options:\n" \
1835 "\t-a\tprint all information\n" \
1836 "\t-m\tthe machine (hardware) type\n" \
1837 "\t-n\tprint the machine's network node hostname\n" \
1838 "\t-r\tprint the operating system release\n" \
1839 "\t-s\tprint the operating system name\n" \
1840 "\t-p\tprint the host processor type\n" \
1841 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001842#define uname_example_usage \
1843 "$ uname -a\n" \
1844 "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001845
1846#define uniq_trivial_usage \
1847 "[OPTION]... [INPUT [OUTPUT]]"
1848#define uniq_full_usage \
1849 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001850 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001851 "Options:\n" \
1852 "\t-c\tprefix lines by the number of occurrences\n" \
1853 "\t-d\tonly print duplicate lines\n" \
1854 "\t-u\tonly print unique lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001855#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001856 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001857 "a\n" \
1858 "b\n" \
1859 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001860
1861#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001862 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001863#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001864 "Converts FILE from unix format to dos format. When no option\n" \
1865 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00001866 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001867 "Options:\n" \
1868 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00001869 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001870
Glenn L McGrath87ac7022002-01-02 13:52:26 +00001871#define unzip_trivial_usage \
1872 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
1873#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00001874 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00001875 "Options:\n" \
1876 "\t-l\tlist archive contents (short form)\n" \
1877 "\t-n\tnever overwrite existing files (default)\n" \
1878 "\t-o\toverwrite files without prompting\n" \
1879 "\t-p\tsend output to stdout\n" \
1880 "\t-q\tbe quiet\n" \
1881 "\t-x\texclude these files\n" \
1882 "\t-d\textract files into this directory"
1883
Eric Andersen7e9276b2001-02-22 01:15:47 +00001884#define update_trivial_usage \
1885 "[options]"
1886#define update_full_usage \
1887 "Periodically flushes filesystem buffers.\n\n" \
1888 "Options:\n" \
1889 "\t-S\tforce use of sync(2) instead of flushing\n" \
1890 "\t-s SECS\tcall sync this often (default 30)\n" \
1891 "\t-f SECS\tflush some buffers this often (default 5)"
1892
1893#define uptime_trivial_usage \
1894 ""
1895#define uptime_full_usage \
1896 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001897#define uptime_example_usage \
1898 "$ uptime\n" \
1899 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001900
1901#define usleep_trivial_usage \
1902 "N"
1903#define usleep_full_usage \
1904 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001905#define usleep_example_usage \
1906 "$ usleep 1000000\n" \
1907 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001908
1909#define uudecode_trivial_usage \
1910 "[FILE]..."
1911#define uudecode_full_usage \
1912 "Uudecode a file that is uuencoded.\n\n" \
1913 "Options:\n" \
Eric Andersen704b2c22001-03-16 08:06:30 +00001914 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001915#define uudecode_example_usage \
1916 "$ uudecode -o busybox busybox.uu\n" \
1917 "$ ls -l busybox\n" \
1918 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001919
1920#define uuencode_trivial_usage \
1921 "[OPTION] [INFILE] REMOTEFILE"
1922#define uuencode_full_usage \
1923 "Uuencode a file.\n\n" \
1924 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00001925 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001926#define uuencode_example_usage \
1927 "$ uuencode busybox busybox\n" \
1928 "begin 755 busybox\n" \
1929 "<encoded file snipped>\n" \
1930 "$ uudecode busybox busybox > busybox.uu\n" \
1931 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001932
Eric Andersen3f980402001-04-04 17:31:15 +00001933#define vi_trivial_usage \
1934 "[OPTION] [FILE]..."
1935#define vi_full_usage \
1936 "edit FILE.\n\n" \
1937 "Options:\n" \
1938 "\t-R\tRead-only- do not write to the file."
1939
Eric Andersen7e9276b2001-02-22 01:15:47 +00001940#define watchdog_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001941 "DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001942#define watchdog_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001943 "Periodically write to watchdog device DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001944
1945#define wc_trivial_usage \
1946 "[OPTION]... [FILE]..."
1947#define wc_full_usage \
1948 "Print line, word, and byte counts for each FILE, and a total line if\n" \
1949 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
1950 "Options:\n" \
1951 "\t-c\tprint the byte counts\n" \
1952 "\t-l\tprint the newline counts\n" \
1953 "\t-L\tprint the length of the longest line\n" \
1954 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001955#define wc_example_usage \
1956 "$ wc /etc/passwd\n" \
1957 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001958
1959#define wget_trivial_usage \
Eric Andersen8071c022001-06-21 19:45:06 +00001960 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n\t[--header 'header: value'] [-P DIR] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001961#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00001962 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001963 "Options:\n" \
1964 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00001965 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00001966 "\t-P\tSet directory prefix to DIR\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001967 "\t-O\tsave to filename ('-' for stdout)"
1968
1969#define which_trivial_usage \
1970 "[COMMAND ...]"
1971#define which_full_usage \
1972 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001973#define which_example_usage \
1974 "$ which login\n" \
1975 "/bin/login\n"
Eric Andersen00a6a752002-04-26 23:53:10 +00001976#define who_trivial_usage \
1977 " "
1978#define who_full_usage \
1979 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001980
1981#define whoami_trivial_usage \
1982 ""
1983#define whoami_full_usage \
1984 "Prints the user name associated with the current effective user id."
1985
1986#define xargs_trivial_usage \
1987 "[COMMAND] [ARGS...]"
1988#define xargs_full_usage \
1989 "Executes COMMAND on every item given by standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001990#define xargs_example_usage \
1991 "$ ls | xargs gzip\n" \
1992 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001993
1994#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001995 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001996#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001997 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001998
Eric Andersen7e9276b2001-02-22 01:15:47 +00001999#define zcat_trivial_usage \
2000 "FILE"
2001#define zcat_full_usage \
2002 "Uncompress to stdout."