blob: bbed44d0c22276b8f72f7a35bed7bff9f239aa65 [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 \
55 "FILE"
56#define bunzip2_full_usage \
57 "Uncompress FILE to current directory, stripping its .bz2 extension.\n"\
58 " -k is assumed"
59
Eric Andersen7e9276b2001-02-22 01:15:47 +000060#define cat_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000061 "[FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000062#define cat_full_usage \
63 "Concatenates FILE(s) and prints them to stdout."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000064#define cat_example_usage \
65 "$ cat /proc/uptime\n" \
66 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000067
Eric Andersen7e9276b2001-02-22 01:15:47 +000068#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000069 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000070#define chgrp_full_usage \
71 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000072 "\nOptions:\n" \
73 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000074#define chgrp_example_usage \
75 "$ ls -l /tmp/foo\n" \
76 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
77 "$ chgrp root /tmp/foo\n" \
78 "$ ls -l /tmp/foo\n" \
79 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000080
Eric Andersen7e9276b2001-02-22 01:15:47 +000081#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000082 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000083#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000084 "Each MODE is one or more of the letters ugoa, one of the\n" \
85 "symbols +-= and one or more of the letters rwxst.\n\n" \
86 "Options:\n" \
87 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000088#define chmod_example_usage \
89 "$ ls -l /tmp/foo\n" \
90 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
91 "$ chmod u+x /tmp/foo\n" \
92 "$ ls -l /tmp/foo\n" \
93 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
94 "$ chmod 444 /tmp/foo\n" \
95 "$ ls -l /tmp/foo\n" \
96 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000097
Eric Andersen7e9276b2001-02-22 01:15:47 +000098#define chown_trivial_usage \
Eric Andersen238da242001-05-11 16:31:46 +000099 "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000100#define chown_full_usage \
101 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000102 "\nOptions:\n" \
Eric Andersen238da242001-05-11 16:31:46 +0000103 "\t-R\tChanges files and directories recursively.\n" \
104 "\t-h\tDo not dereference symbolic links."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000105#define chown_example_usage \
106 "$ ls -l /tmp/foo\n" \
107 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
108 "$ chown root /tmp/foo\n" \
109 "$ ls -l /tmp/foo\n" \
110 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
111 "$ chown root.root /tmp/foo\n" \
112 "ls -l /tmp/foo\n" \
113 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000114
Eric Andersen7e9276b2001-02-22 01:15:47 +0000115#define chroot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000116 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000117#define chroot_full_usage \
118 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000119#define chroot_example_usage \
120 "$ ls -l /bin/ls\n" \
121 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
122 "$ mount /dev/hdc1 /mnt -t minix\n" \
123 "$ chroot /mnt\n" \
124 "$ ls -l /bin/ls\n" \
125 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000126
Eric Andersen7e9276b2001-02-22 01:15:47 +0000127#define chvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000128 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000129#define chvt_full_usage \
130 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000131
Eric Andersen7e9276b2001-02-22 01:15:47 +0000132#define clear_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000133 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000134#define clear_full_usage \
135 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000136
Eric Andersen7e9276b2001-02-22 01:15:47 +0000137#define cmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000138 "FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000139#define cmp_full_usage \
Mark Whitley207587a2001-04-25 20:41:02 +0000140 "\t-s\tquiet mode - do not print\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000141 "Compare files."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000142
Eric Andersen7e9276b2001-02-22 01:15:47 +0000143#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000144 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000145#define cp_full_usage \
146 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
147 "\n" \
148 "\t-a\tSame as -dpR\n" \
149 "\t-d\tPreserves links\n" \
150 "\t-p\tPreserves file attributes if possible\n" \
151 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000152 "\t-R\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000153
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000154#define cpio_trivial_usage \
155 "-[dimtuv][F cpiofile]"
156#define cpio_full_usage \
157 "Extract or list files from a cpio archive\n" \
158 "Main operation mode:\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000159 "\td\t\tmake leading directories\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000160 "\ti\t\textract\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000161 "\tm\t\tpreserve mtime\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000162 "\tt\t\tlist\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000163 "\tu\t\tunconditional overwrite\t" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000164 "\tF\t\tinput from file\t"
165
Eric Andersen7e9276b2001-02-22 01:15:47 +0000166#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000167 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000168#define cut_full_usage \
169 "Prints selected fields from each input FILE to standard output.\n\n" \
170 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000171 "\t-b LIST\t\tOutput only bytes from LIST\n" \
172 "\t-c LIST\t\tOutput only characters from LIST\n" \
173 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
174 "\t-s\t\tOutput only the lines containing delimiter\n" \
175 "\t-f N\t\tPrint only these fields\n" \
176 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000177#define cut_example_usage \
178 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
179 "Hello\n" \
180 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
181 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000182
Eric Andersen7e9276b2001-02-22 01:15:47 +0000183#define date_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000184 "[OPTION]... [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000185#define date_full_usage \
186 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000187 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000188 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000189 "\t-d STRING\tdisplay time described by STRING, not `now'\n" \
190 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000191 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000192#define date_example_usage \
193 "$ date\n" \
194 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000195
Eric Andersen7e9276b2001-02-22 01:15:47 +0000196#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000197 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000198#define dc_full_usage \
199 "This is a Tiny RPN calculator that understands the\n" \
200 "following operations: +, -, /, *, and, or, not, eor.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000201 "i.e., 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000202#define dc_example_usage \
203 "$ dc 2 2 +\n" \
204 "4\n" \
205 "$ dc 8 8 \* 2 2 + /\n" \
206 "16\n" \
207 "$ dc 0 1 and\n" \
208 "0\n" \
209 "$ dc 0 1 or\n" \
210 "1\n" \
211 "$ echo 72 9 div 8 mul | dc\n" \
212 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000213
Eric Andersen7e9276b2001-02-22 01:15:47 +0000214#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000215 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000216 "\t [seek=N] [conv=notrunc|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000217#define dd_full_usage \
218 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000219 "\tif=FILE\t\tread from FILE instead of stdin\n" \
220 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
221 "\tbs=N\t\tread and write N bytes at a time\n" \
222 "\tcount=N\t\tcopy only N input blocks\n" \
223 "\tskip=N\t\tskip N input blocks\n" \
224 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000225 "\tconv=notrunc\tdon't truncate output file\n" \
226 "\tconv=sync\tpad blocks with zeros\n" \
227 "\n" \
228 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000229 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000230#define dd_example_usage \
231 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
232 "4+0 records in\n" \
233 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000234
Eric Andersen7e9276b2001-02-22 01:15:47 +0000235#define deallocvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000236 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000237#define deallocvt_full_usage \
238 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000239
Eric Andersenf349e972001-08-21 16:18:59 +0000240#define delgroup_trivial_usage \
241 "GROUP"
242#define delgroup_full_usage \
243 "Deletes group GROUP from the system"
244
245#define deluser_trivial_usage \
246 "USER"
247#define deluser_full_usage \
248 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000249
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000250#ifdef CONFIG_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000251 #define USAGE_HUMAN_READABLE(a) a
252 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000253#else
Eric Andersened0d9582001-02-23 13:23:03 +0000254 #define USAGE_HUMAN_READABLE(a)
255 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000256#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000257#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000258 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000259#define df_full_usage \
260 "Print the filesystem space used and space available.\n\n" \
261 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000262 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000263 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
264 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000265 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000266 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000267#define df_example_usage \
268 "$ df\n" \
269 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
270 "/dev/sda3 8690864 8553540 137324 98% /\n" \
271 "/dev/sda1 64216 36364 27852 57% /boot\n" \
272 "$ df /dev/sda3\n" \
273 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
274 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000275
Eric Andersen7e9276b2001-02-22 01:15:47 +0000276#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000277 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000278#define dirname_full_usage \
279 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000280#define dirname_example_usage \
281 "$ dirname /tmp/foo\n" \
282 "/tmp\n" \
283 "$ dirname /tmp/foo/\n" \
284 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000285
Eric Andersen7e9276b2001-02-22 01:15:47 +0000286#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000287 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000288#define dmesg_full_usage \
289 "Prints or controls the kernel ring buffer\n\n" \
290 "Options:\n" \
291 "\t-c\t\tClears the ring buffer's contents after printing\n" \
292 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000293 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000294
Eric Andersen7e9276b2001-02-22 01:15:47 +0000295#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000296 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000297#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000298 "Converts FILE from dos format to unix format. When no option\n" \
299 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000300 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000301 "Options:\n" \
302 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000303 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000304
Eric Andersen7e9276b2001-02-22 01:15:47 +0000305#define dpkg_trivial_usage \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000306 "-i package_file\n"
307 "[-CPru] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000308#define dpkg_full_usage \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000309 "\t-i\tInstall the package\n" \
310 "\t-C\tConfigure an unpackaged package\n" \
311 "\t-P\tPurge all files of a package\n" \
312 "\t-r\tRemove all but the configuration files for a package\n" \
313 "\t-u\tUnpack a package, but dont configure it\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000314
Eric Andersen7e9276b2001-02-22 01:15:47 +0000315#define dpkg_deb_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000316 "[-cefItxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000317#define dpkg_deb_full_usage \
318 "Perform actions on debian packages (.debs)\n\n" \
319 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000320 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000321 "\t-e\tExtract control files to [argument] directory\n" \
322 "\t-f\tDisplay control field name starting with [argument]\n" \
323 "\t-I\tDisplay the control filenamed [argument]\n" \
324 "\t-t\tExtract filesystem tree to stdout in tar format\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000325 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000326 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000327#define dpkg_deb_example_usage \
328 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000329
Eric Andersen7e9276b2001-02-22 01:15:47 +0000330#define du_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +0000331 "[-ls" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000332#define du_full_usage \
333 "Summarizes disk space used for each FILE and/or directory.\n" \
334 "Disk space is printed in units of 1024 bytes.\n\n" \
335 "Options:\n" \
336 "\t-l\tcount sizes many times if hard linked\n" \
337 "\t-s\tdisplay only a total for each argument" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000338 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000339 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
340 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000341 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000342 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000343#define du_example_usage \
344 "$ du\n" \
345 "16 ./CVS\n" \
346 "12 ./kernel-patches/CVS\n" \
347 "80 ./kernel-patches\n" \
348 "12 ./tests/CVS\n" \
349 "36 ./tests\n" \
350 "12 ./scripts/CVS\n" \
351 "16 ./scripts\n" \
352 "12 ./docs/CVS\n" \
353 "104 ./docs\n" \
354 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000355
Eric Andersen7e9276b2001-02-22 01:15:47 +0000356#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000357 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000358#define dumpkmap_full_usage \
359 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000360#define dumpkmap_example_usage \
361 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000362
Eric Andersen7e9276b2001-02-22 01:15:47 +0000363#define dutmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000364 "[FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000365#define dutmp_full_usage \
366 "Dump utmp file format (pipe delimited) from FILE\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000367 "or stdin to stdout. (i.e., 'dutmp /var/run/utmp')"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000368#define dutmp_example_usage \
369 "$ dutmp /var/run/utmp\n" \
370 "8|7||si|||0|0|0|955637625|760097|0\n" \
371 "2|0|~|~~|reboot||0|0|0|955637625|782235|0\n" \
372 "1|20020|~|~~|runlevel||0|0|0|955637625|800089|0\n" \
373 "8|125||l4|||0|0|0|955637629|998367|0\n" \
374 "6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0\n" \
375 "6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0\n" \
376 "7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000377
Eric Andersen7e9276b2001-02-22 01:15:47 +0000378#define echo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000379 "[-neE] [ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000380#define echo_full_usage \
381 "Prints the specified ARGs to stdout\n\n" \
382 "Options:\n" \
383 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000384 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000385 "\t-E\tdisable interpretation of backslash-escaped characters"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000386#define echo_example_usage \
387 "$ echo "Erik is cool"\n" \
388 "Erik is cool\n" \
John Beppu5d817682001-04-17 17:09:34 +0000389 "$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000390 "Erik\n" \
391 "is\n" \
392 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000393 "$ echo "Erik\\nis\\ncool"\n" \
394 "Erik\\nis\\ncool\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000395
Eric Andersen84e229c2001-03-29 22:48:33 +0000396#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000397 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000398#define env_full_usage \
399 "Prints the current environment or runs a program after setting\n" \
400 "up the specified environment.\n\n" \
401 "Options:\n" \
402 "\t-, -i\tstart with an empty environment\n" \
403 "\t-u\tremove variable from the environment\n"
404
Eric Andersen7e9276b2001-02-22 01:15:47 +0000405#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000406 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000407#define expr_full_usage \
408 "Prints the value of EXPRESSION to standard output.\n\n" \
409 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000410 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
411 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
412 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
413 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
414 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
415 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
416 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
417 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
418 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
419 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
420 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
421 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
422 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000423 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
424 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
425 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
426 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
427 "\t or 0\n" \
428 "\tlength STRING length of STRING\n" \
429 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
430 "\t it is a keyword like `match' or an\n" \
431 "\t operator like `/'\n" \
432 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000433 "Beware that many operators need to be escaped or quoted for shells.\n" \
434 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
435 "lexicographical. Pattern matches return the string matched between \n" \
436 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
437 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000438
Eric Andersen7e9276b2001-02-22 01:15:47 +0000439#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000440 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000441#define false_full_usage \
442 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000443#define false_example_usage \
444 "$ false\n" \
445 "$ echo $?\n" \
446 "1\n"
447
448#define fbset_trivial_usage \
449 "[options] [mode]"
450#define fbset_full_usage \
451 "Show and modify frame buffer settings"
452#define fbset_example_usage \
453 "$ fbset\n" \
454 "mode "1024x768-76"\n" \
455 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
456 "\tgeometry 1024 768 1024 768 16\n" \
457 "\ttimings 12714 128 32 16 4 128 4\n" \
458 "\taccel false\n" \
459 "\trgba 5/11,6/5,5/0,0/0\n" \
460 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000461
Eric Andersen7e9276b2001-02-22 01:15:47 +0000462#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000463 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000464#define fdflush_full_usage \
465 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000466
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000467#ifdef CONFIG_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000468 #define USAGE_FIND_TYPE(a) a
469#else
470 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000471#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000472#ifdef CONFIG_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000473 #define USAGE_FIND_PERM(a) a
474#else
475 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000476#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000477#ifdef CONFIG_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000478 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000479#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000480 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000481#endif
482
Eric Andersen7e9276b2001-02-22 01:15:47 +0000483#define find_trivial_usage \
484 "[PATH...] [EXPRESSION]"
485#define find_full_usage \
486 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000487 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000488 "\nEXPRESSION may consist of:\n" \
489 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000490 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000491 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000492 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000493 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
494) USAGE_FIND_PERM( \
495 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
496) USAGE_FIND_MTIME( \
497 "\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 +0000498#define find_example_usage \
499 "$ find / -name /etc/passwd\n" \
500 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000501
Eric Andersen7e9276b2001-02-22 01:15:47 +0000502#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000503 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000504#define free_full_usage \
505 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000506#define free_example_usage \
507 "$ free\n" \
508 " total used free shared buffers\n" \
509 " Mem: 257628 248724 8904 59644 93124\n" \
510 " Swap: 128516 8404 120112\n" \
511 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000512
Eric Andersen7e9276b2001-02-22 01:15:47 +0000513#define freeramdisk_trivial_usage \
514 "DEVICE"
515#define freeramdisk_full_usage \
516 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000517#define freeramdisk_example_usage \
518 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000519
520#define fsck_minix_trivial_usage \
521 "[-larvsmf] /dev/name"
522#define fsck_minix_full_usage \
523 "Performs a consistency check for MINIX filesystems.\n\n" \
524 "Options:\n" \
525 "\t-l\tLists all filenames\n" \
526 "\t-r\tPerform interactive repairs\n" \
527 "\t-a\tPerform automatic repairs\n" \
528 "\t-v\tverbose\n" \
529 "\t-s\tOutputs super-block information\n" \
530 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
531 "\t-f\tForce file system check."
532
533#define getopt_trivial_usage \
534 "[OPTIONS]..."
535#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000536 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000537 "\t-a, --alternative Allow long options starting with single -\n" \
538 "\t-l, --longoptions=longopts Long options to be recognized\n" \
539 "\t-n, --name=progname The name under which errors are reported\n" \
540 "\t-o, --options=optstring Short options to be recognized\n" \
541 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
542 "\t-Q, --quiet-output No normal output\n" \
543 "\t-s, --shell=shell Set shell quoting conventions\n" \
544 "\t-T, --test Test for getopt(1) version\n" \
545 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000546#define getopt_example_usage \
547 "$ cat getopt.test\n" \
548 "#!/bin/sh\n" \
549 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
550 " -n 'example.busybox' -- "$@"`\n" \
551 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
552 "eval set -- "$GETOPT"\n" \
553 "while true ; do\n" \
554 " case $1 in\n" \
555 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
556 " -b|--b-long) echo \"Option b, argument \`$2'\" ; shift 2 ;;\n" \
557 " -c|--c-long)\n" \
558 " case "$2" in\n" \
559 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
560 " *) echo \"Option c, argument \`$2'\" ; shift 2 ;;\n" \
561 " esac ;;\n" \
562 " --) shift ; break ;;\n" \
563 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
564 " esac\n" \
565 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000566
Eric Andersenf349e972001-08-21 16:18:59 +0000567#define getty_trivial_usage \
568 "getty [OPTIONS]... baud_rate,... line [termtype]"
569#define getty_full_usage \
570 "\nOpens a tty, prompts for a login name, then invokes /bin/login\n\n" \
571 "Options:\n" \
572 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
573 "\t-i\t\tDo not display /etc/issue before running login.\n" \
574 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
575 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
576 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
577 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
578 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
579 "\t-I initstring\tSets the init string to send before anything else.\n" \
580 "\t-H login_host\tLog login_host into the utmp file as the hostname."
581
582
Eric Andersen7e9276b2001-02-22 01:15:47 +0000583#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000584 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000585#define grep_full_usage \
586 "Search for PATTERN in each FILE or standard input.\n\n" \
587 "Options:\n" \
588 "\t-H\tprefix output lines with filename where match was found\n" \
589 "\t-h\tsuppress the prefixing filename on output\n" \
590 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000591 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000592 "\t-n\tprint line number with output lines\n" \
593 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
594 "\t-v\tselect non-matching lines\n" \
595 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000596#define grep_example_usage \
597 "$ grep root /etc/passwd\n" \
598 "root:x:0:0:root:/root:/bin/bash\n" \
599 "$ grep ^[rR]oo. /etc/passwd\n" \
600 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000601
Eric Andersen7e9276b2001-02-22 01:15:47 +0000602#define gunzip_trivial_usage \
603 "[OPTION]... FILE"
604#define gunzip_full_usage \
605 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
606 "Options:\n" \
607 "\t-c\tWrite output to standard output\n" \
608 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000609#define gunzip_example_usage \
610 "$ ls -la /tmp/BusyBox*\n" \
611 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
612 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
613 "$ ls -la /tmp/BusyBox*\n" \
614 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000615
616#define gzip_trivial_usage \
617 "[OPTION]... FILE"
618#define gzip_full_usage \
619 "Compress FILE with maximum compression.\n" \
620 "When FILE is '-', reads standard input. Implies -c.\n\n" \
621 "Options:\n" \
622 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
623 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000624#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000625 "$ ls -la /tmp/busybox*\n" \
626 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
627 "$ gzip /tmp/busybox.tar\n" \
628 "$ ls -la /tmp/busybox*\n" \
629 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000630
631#define halt_trivial_usage \
632 ""
633#define halt_full_usage \
634 "Halt the system."
635
636#define head_trivial_usage \
637 "[OPTION] [FILE]..."
638#define head_full_usage \
639 "Print first 10 lines of each FILE to standard output.\n" \
640 "With more than one FILE, precede each with a header giving the\n" \
641 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000642 "Options:\n" \
643 "\t-n NUM\t\tPrint first NUM lines instead of first 10"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000644#define head_example_usage \
645 "$ head -n 2 /etc/passwd\n" \
646 "root:x:0:0:root:/root:/bin/bash\n" \
647 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000648
649#define hostid_trivial_usage \
650 ""
651#define hostid_full_usage \
652 "Print out a unique 32-bit identifier for the machine."
653
654#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000655 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000656#define hostname_full_usage \
657 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000658 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000659 "Options:\n" \
660 "\t-s\t\tShort\n" \
661 "\t-i\t\tAddresses for the hostname\n" \
662 "\t-d\t\tDNS domain name\n" \
Eric Andersen6cf47a72001-10-31 10:24:36 +0000663 "\t-f\t\tFully qualified domain name\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000664 "\t-F, --file FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000665#define hostname_example_usage \
666 "$ hostname\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000667 "sage \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000668
669#define id_trivial_usage \
670 "[OPTIONS]... [USERNAME]"
671#define id_full_usage \
672 "Print information for USERNAME or the current user\n\n" \
673 "Options:\n" \
674 "\t-g\tprints only the group ID\n" \
675 "\t-u\tprints only the user ID\n" \
676 "\t-n\tprint a name instead of a number (with for -ug)\n" \
677 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000678#define id_example_usage \
679 "$ id\n" \
680 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000681
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000682#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +0000683 #define USAGE_SIOCSKEEPALIVE(a) a
684#else
685 #define USAGE_SIOCSKEEPALIVE(a)
686#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000687#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000688 #define USAGE_IFCONFIG_MII(a) a
689#else
690 #define USAGE_IFCONFIG_MII(a)
691#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000692#ifdef CONFIG_FEATURE_IFCONFIG_HW
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000693 #define USAGE_IFCONFIG_HW(a) a
694#else
695 #define USAGE_IFCONFIG_HW(a)
696#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000697#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000698 #define USAGE_IFCONFIG_OPT_A(a) a
699#else
700 #define USAGE_IFCONFIG_OPT_A(a)
701#endif
702
Eric Andersen7e9276b2001-02-22 01:15:47 +0000703#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000704 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000705#define ifconfig_full_usage \
706 "configure a network interface\n\n" \
707 "Options:\n" \
708 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000709 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000710 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000711 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
712 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000713 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000714 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
715 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000716 "\t[up|down] ..."
717
718#define init_trivial_usage \
719 ""
720#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000721 "Init is the parent of all processes."
722#define init_notes_usage \
723"This version of init is designed to be run only by the kernel.\n" \
724"\n" \
725"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
726"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
727"runlevels, use sysvinit.\n" \
728"\n" \
729"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
730"it has the following default behavior:\n" \
731"\n" \
732" ::sysinit:/etc/init.d/rcS\n" \
733" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000734" ::ctrlaltdel:/sbin/reboot\n" \
735" ::shutdown:/sbin/swapoff -a\n" \
736" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000737"\n" \
738"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
739"\n" \
740" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000741" tty3::askfirst:/bin/sh\n" \
742" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000743"\n" \
744"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
745"\n" \
746" <id>:<runlevels>:<action>:<process>\n" \
747"\n" \
748" <id>: \n" \
749"\n" \
750" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
751" The id field is used by BusyBox init to specify the controlling tty for\n" \
752" the specified process to run on. The contents of this field are\n" \
753" appended to "/dev/" and used as-is. There is no need for this field to\n" \
754" be unique, although if it isn't you may have strange results. If this\n" \
755" field is left blank, the controlling tty is set to the console. Also\n" \
756" note that if BusyBox detects that a serial console is in use, then only\n" \
757" entries whose controlling tty is either the serial console or /dev/null\n" \
758" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
759" stinkin' utmp.\n" \
760"\n" \
761" <runlevels>: \n" \
762"\n" \
763" The runlevels field is completely ignored.\n" \
764"\n" \
765" <action>: \n" \
766"\n" \
767" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000768" once, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000769"\n" \
770" The available actions can be classified into two groups: actions\n" \
771" that are run only once, and actions that are re-run when the specified\n" \
772" process exits.\n" \
773"\n" \
774" Run only-once actions:\n" \
775"\n" \
776" 'sysinit' is the first item run on boot. init waits until all\n" \
777" sysinit actions are completed before continuing. Following the\n" \
778" completion of all sysinit actions, all 'wait' actions are run.\n" \
779" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000780" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000781" therefore, init does not wait for them to complete. 'ctrlaltdel'\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000782" actions are run when the system detects that someone on the system\n" \
783" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
784" wants to run 'reboot' at this point to cause the system to reboot.\n" \
785" Finally the 'shutdown' action specifies the actions to taken when\n" \
786" init is told to reboot. Unmounting filesystems and disabling swap\n" \
787" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000788"\n" \
789" Run repeatedly actions:\n" \
790"\n" \
791" 'respawn' actions are run after the 'once' actions. When a process\n" \
792" started with a 'respawn' action exits, init automatically restarts\n" \
793" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
794" respawning out of control. The 'askfirst' actions acts just like\n" \
795" respawn, except that before running the specified process it\n" \
796" displays the line "Please press Enter to activate this console."\n" \
797" and then waits for the user to press enter before starting the\n" \
798" specified process. \n" \
799"\n" \
800" Unrecognized actions (like initdefault) will cause init to emit an\n" \
801" error message, and then go along with its business. All actions are\n" \
802" run in the reverse order from how they appear in /etc/inittab.\n" \
803"\n" \
804" <process>: \n" \
805"\n" \
806" Specifies the process to be executed and it's command line.\n" \
807"\n" \
808"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +0000809"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000810" # This is run first except when booting in single-user mode.\n" \
811" #\n" \
812" ::sysinit:/etc/init.d/rcS\n" \
813" \n" \
814" # /bin/sh invocations on selected ttys\n" \
815" #\n" \
816" # Start an "askfirst" shell on the console (whatever that may be)\n" \
817" ::askfirst:-/bin/sh\n" \
818" # Start an "askfirst" shell on /dev/tty2-4\n" \
819" tty2::askfirst:-/bin/sh\n" \
820" tty3::askfirst:-/bin/sh\n" \
821" tty4::askfirst:-/bin/sh\n" \
822" \n" \
823" # /sbin/getty invocations for selected ttys\n" \
824" #\n" \
825" tty4::respawn:/sbin/getty 38400 tty5\n" \
826" tty5::respawn:/sbin/getty 38400 tty6\n" \
827" \n" \
828" \n" \
829" # Example of how to put a getty on a serial line (for a terminal)\n" \
830" #\n" \
831" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
832" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
833" #\n" \
834" # Example how to put a getty on a modem line.\n" \
835" #::respawn:/sbin/getty 57600 ttyS2\n" \
836" \n" \
837" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000838" ::ctrlaltdel:/sbin/reboot\n" \
839" ::shutdown:/bin/umount -a -r\n" \
840" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000841
842#define insmod_trivial_usage \
843 "[OPTION]... MODULE [symbol=value]..."
844#define insmod_full_usage \
845 "Loads the specified kernel modules into the kernel.\n\n" \
846 "Options:\n" \
847 "\t-f\tForce module to load into the wrong kernel version.\n" \
848 "\t-k\tMake module autoclean-able.\n" \
849 "\t-v\tverbose output\n" \
850 "\t-L\tLock to prevent simultaneous loads of a module\n" \
851 "\t-x\tdo not export externs"
852
853#define kill_trivial_usage \
854 "[-signal] process-id [process-id ...]"
855#define kill_full_usage \
856 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +0000857 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000858 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000859#define kill_example_usage \
860 "$ ps | grep apache\n" \
861 "252 root root S [apache]\n" \
862 "263 www-data www-data S [apache]\n" \
863 "264 www-data www-data S [apache]\n" \
864 "265 www-data www-data S [apache]\n" \
865 "266 www-data www-data S [apache]\n" \
866 "267 www-data www-data S [apache]\n" \
867 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000868
869#define killall_trivial_usage \
870 "[-signal] process-name [process-name ...]"
871#define killall_full_usage \
872 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000873 "Options:\n" \
874 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000875#define killall_example_usage \
876 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000877
Mark Whitley6317c4b2001-03-12 22:51:50 +0000878#define klogd_trivial_usage \
879 "-n"
880#define klogd_full_usage \
881 "Kernel logger.\n"\
882 "Options:\n"\
883 "\t-n\tRun as a foreground process."
884
Eric Andersen7e9276b2001-02-22 01:15:47 +0000885#define length_trivial_usage \
886 "STRING"
887#define length_full_usage \
888 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000889#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +0000890 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000891 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000892
893#define ln_trivial_usage \
894 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
895#define ln_full_usage \
896 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
897 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
898 "Options:\n" \
899 "\t-s\tmake symbolic links instead of hard links\n" \
900 "\t-f\tremove existing destination files\n" \
901 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000902#define ln_example_usage \
903 "$ ln -s BusyBox /tmp/ls\n" \
904 "$ ls -l /tmp/ls\n" \
905 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000906
907#define loadacm_trivial_usage \
908 "< mapfile"
909#define loadacm_full_usage \
910 "Loads an acm from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000911#define loadacm_example_usage \
912 "$ loadacm < /etc/i18n/acmname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000913
914#define loadfont_trivial_usage \
915 "< font"
916#define loadfont_full_usage \
917 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000918#define loadfont_example_usage \
919 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000920
921#define loadkmap_trivial_usage \
922 "< keymap"
923#define loadkmap_full_usage \
924 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000925#define loadkmap_example_usage \
926 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000927
928#define logger_trivial_usage \
929 "[OPTION]... [MESSAGE]"
930#define logger_full_usage \
931 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
932 "Options:\n" \
933 "\t-s\tLog to stderr as well as the system log.\n" \
934 "\t-t\tLog using the specified tag (defaults to user name).\n" \
935 "\t-p\tEnter the message with the specified priority.\n" \
936 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000937#define logger_example_usage \
938 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000939
940#define logname_trivial_usage \
941 ""
942#define logname_full_usage \
943 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000944#define logname_example_usage \
945 "$ logname\n" \
946 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000947
Mark Whitley6317c4b2001-03-12 22:51:50 +0000948#define logread_trivial_usage \
949 ""
950
951#define logread_full_usage \
952 "Shows the messages from syslogd (using circular buffer)."
953
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000954#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Eric Andersen7e9276b2001-02-22 01:15:47 +0000955 #define USAGE_LS_TIMESTAMPS(a) a
956#else
957 #define USAGE_LS_TIMESTAMPS(a)
958#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000959#ifdef CONFIG_FEATURE_LS_FILETYPES
Eric Andersen7e9276b2001-02-22 01:15:47 +0000960 #define USAGE_LS_FILETYPES(a) a
961#else
962 #define USAGE_LS_FILETYPES(a)
963#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000964#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Eric Andersen7e9276b2001-02-22 01:15:47 +0000965 #define USAGE_LS_FOLLOWLINKS(a) a
966#else
967 #define USAGE_LS_FOLLOWLINKS(a)
968#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000969#ifdef CONFIG_FEATURE_LS_RECURSIVE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000970 #define USAGE_LS_RECURSIVE(a) a
971#else
972 #define USAGE_LS_RECURSIVE(a)
973#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000974#ifdef CONFIG_FEATURE_LS_SORTFILES
Eric Andersen7e9276b2001-02-22 01:15:47 +0000975 #define USAGE_LS_SORTFILES(a) a
976#else
977 #define USAGE_LS_SORTFILES(a)
978#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000979#ifdef CONFIG_FEATURE_AUTOWIDTH
Eric Andersen7e9276b2001-02-22 01:15:47 +0000980 #define USAGE_AUTOWIDTH(a) a
981#else
982 #define USAGE_AUTOWIDTH(a)
983#endif
984#define ls_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +0000985 "[-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 +0000986#define ls_full_usage \
987 "List directory contents\n\n" \
988 "Options:\n" \
989 "\t-1\tlist files in a single column\n" \
990 "\t-A\tdo not list implied . and ..\n" \
991 "\t-a\tdo not hide entries starting with .\n" \
992 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000993 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000994 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000995 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
996 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000997 "\t-i\tlist the i-node for each file\n" \
998 "\t-l\tuse a long listing format\n" \
999 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001000 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1001 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1002 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1003 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1004 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001005 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001006 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1007 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1008 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1009 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1010 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001011 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001012 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1013 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001014 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersened0d9582001-02-23 13:23:03 +00001015 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +00001016 "\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001017
1018#define lsmod_trivial_usage \
1019 ""
1020#define lsmod_full_usage \
1021 "List the currently loaded kernel modules."
1022
1023#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001024 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001025#define makedevs_full_usage \
1026 "Creates a range of block or character special files\n\n" \
1027 "TYPEs include:\n" \
1028 "\tb:\tMake a block (buffered) device.\n" \
1029 "\tc or u:\tMake a character (un-buffered) device.\n" \
1030 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1031 "FIRST specifies the number appended to NAME to create the first device.\n" \
1032 "LAST specifies the number of the last item that should be created.\n" \
1033 "If 's' is the last argument, the base device is created as well.\n\n" \
1034 "For example:\n" \
1035 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001036 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001037#define makedevs_example_usage \
1038 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
1039 "[creates ttyS2-ttyS63]\n" \
1040 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
1041 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001042
Eric Andersen7e9276b2001-02-22 01:15:47 +00001043#define md5sum_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001044 "[OPTION] [FILE]...\n" \
1045 "or: md5sum [OPTION] -c [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001046#define md5sum_full_usage \
1047 "Print or check MD5 checksums.\n\n" \
1048 "Options:\n" \
1049 "With no FILE, or when FILE is -, read standard input.\n\n" \
1050 "\t-b\tread files in binary mode\n" \
1051 "\t-c\tcheck MD5 sums against given list\n" \
1052 "\t-t\tread files in text mode (default)\n" \
1053 "\t-g\tread a string\n" \
1054 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001055 "\t-s\tdon't output anything, status code shows success\n" \
1056 "\t-w\twarn about improperly formated MD5 checksum lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001057#define md5sum_example_usage \
1058 "$ md5sum < busybox\n" \
1059 "6fd11e98b98a58f64ff3398d7b324003\n" \
1060 "$ md5sum busybox\n" \
1061 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1062 "$ md5sum -c -\n" \
1063 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1064 "busybox: OK\n" \
1065 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001066
Eric Andersen7e9276b2001-02-22 01:15:47 +00001067#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001068 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001069#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001070 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001071 "Options:\n" \
1072 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001073 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001074#define mkdir_example_usage \
1075 "$ mkdir /tmp/foo\n" \
1076 "$ mkdir /tmp/foo\n" \
1077 "/tmp/foo: File exists\n" \
1078 "$ mkdir /tmp/foo/bar/baz\n" \
1079 "/tmp/foo/bar/baz: No such file or directory\n" \
1080 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001081
Eric Andersen7e9276b2001-02-22 01:15:47 +00001082#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001083 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001084#define mkfifo_full_usage \
1085 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1086 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001087 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001088
Eric Andersen7e9276b2001-02-22 01:15:47 +00001089#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001090 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001091#define mkfs_minix_full_usage \
1092 "Make a MINIX filesystem.\n\n" \
1093 "Options:\n" \
1094 "\t-c\t\tCheck the device for bad blocks\n" \
1095 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1096 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1097 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001098 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001099
Eric Andersen7e9276b2001-02-22 01:15:47 +00001100#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001101 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001102#define mknod_full_usage \
1103 "Create a special file (block, character, or pipe).\n\n" \
1104 "Options:\n" \
1105 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1106 "TYPEs include:\n" \
1107 "\tb:\tMake a block (buffered) device.\n" \
1108 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001109 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001110#define mknod_example_usage \
1111 "$ mknod /dev/fd0 b 2 0 \n" \
1112 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001113
Eric Andersen7e9276b2001-02-22 01:15:47 +00001114#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001115 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001116#define mkswap_full_usage \
1117 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001118 "Options:\n" \
1119 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001120 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001121 "\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 +00001122 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001123
Eric Andersen7e9276b2001-02-22 01:15:47 +00001124#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001125 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001126#define mktemp_full_usage \
1127 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001128 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001129#define mktemp_example_usage \
1130 "$ mktemp /tmp/temp.XXXXXX\n" \
1131 "/tmp/temp.mWiLjM\n" \
1132 "$ ls -la /tmp/temp.mWiLjM\n" \
1133 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001134
Eric Andersen8d79ce82001-07-22 23:00:15 +00001135#define modprobe_trivial_usage \
1136 "[FILE ...]"
1137#define modprobe_full_usage \
1138 "Used for hight level module loading and unloading."
1139#define modprobe_example_usage \
1140 "$ modprobe cdrom\n"
1141
Eric Andersen7e9276b2001-02-22 01:15:47 +00001142#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001143 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001144#define more_full_usage \
1145 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001146#define more_example_usage \
1147 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001148
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001149#ifdef CONFIG_FEATURE_MOUNT_LOOP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001150 #define USAGE_MOUNT_LOOP(a) a
1151#else
1152 #define USAGE_MOUNT_LOOP(a)
1153#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001154#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001155 #define USAGE_MTAB(a) a
1156#else
1157 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001158#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001159#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001160 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001161#define mount_full_usage \
1162 "Mount a filesystem\n\n" \
1163 "Flags:\n" \
1164 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001165 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001166 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001167 "\t-n:\t\tDon't write a mount table entry.\n" \
1168 ) \
1169 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1170 "\t-r:\t\tMount the filesystem read-only.\n" \
1171 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1172 "\t-w:\t\tMount for reading and writing (default).\n" \
1173 "\n" \
1174 "Options for use with the \"-o\" flag:\n" \
1175 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1176 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1177 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1178 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001179 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001180 "\tloop:\t\tMounts a file via loop device.\n" \
1181 ) \
1182 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001183 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001184 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001185 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001186 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001187 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001188#define mount_example_usage \
1189 "$ mount\n" \
1190 "/dev/hda3 on / type minix (rw)\n" \
1191 "proc on /proc type proc (rw)\n" \
1192 "devpts on /dev/pts type devpts (rw)\n" \
1193 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1194 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001195
Eric Andersen7e9276b2001-02-22 01:15:47 +00001196#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001197 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001198#define mt_full_usage \
1199 "Control magnetic tape drive operation\n" \
1200 "\nAvailable Opcodes:\n\n" \
1201 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1202 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
1203 "ras3 reset retension rew rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001204 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001205
Eric Andersen7e9276b2001-02-22 01:15:47 +00001206#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001207 "SOURCE DEST\n" \
1208 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001209#define mv_full_usage \
1210 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001211#define mv_example_usage \
1212 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001213
Eric Andersen7e9276b2001-02-22 01:15:47 +00001214#define nc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001215 "[IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001216#define nc_full_usage \
1217 "Netcat opens a pipe to IP:port"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001218#define nc_example_usage \
1219 "$ nc foobar.somedomain.com 25\n" \
1220 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1221 "help\n" \
1222 "214-Commands supported:\n" \
1223 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1224 "214 NOOP QUIT RSET HELP\n" \
1225 "quit\n" \
1226 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001227
Eric Andersen7e9276b2001-02-22 01:15:47 +00001228#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001229 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001230#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001231 "Queries the nameserver for the IP address of the given HOST\n" \
1232 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001233#define nslookup_example_usage \
1234 "$ nslookup localhost\n" \
1235 "Server: default\n" \
1236 "Address: default\n" \
1237 "\n" \
1238 "Name: debian\n" \
1239 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001240
Eric Andersen221b2ea2001-07-31 19:06:07 +00001241#define pidof_trivial_usage \
1242 "process-name [process-name ...]"
1243#define pidof_full_usage \
1244 "Lists the PIDs of all processes with names that match the names on the command line"
1245#define pidof_example_usage \
1246 "$ pidof init\n" \
1247 "1\n"
1248
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001249#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001250#define ping_trivial_usage "host"
1251#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1252#else
1253#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001254 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001255#define ping_full_usage \
1256 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1257 "Options:\n" \
1258 "\t-c COUNT\tSend only COUNT pings.\n" \
1259 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1260 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001261 "\t\t\tand when finished."
1262#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001263#define ping_example_usage \
1264 "$ ping localhost\n" \
1265 "PING slag (127.0.0.1): 56 data bytes\n" \
1266 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1267 "\n" \
1268 "--- debian ping statistics ---\n" \
1269 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1270 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001271
Eric Andersen7e9276b2001-02-22 01:15:47 +00001272#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001273 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001274#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001275 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001276 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001277
Eric Andersen7e9276b2001-02-22 01:15:47 +00001278#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001279 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001280#define poweroff_full_usage \
1281 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001282
Eric Andersen7e9276b2001-02-22 01:15:47 +00001283#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001284 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001285#define printf_full_usage \
1286 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001287 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001288#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001289 "$ printf "Val=%d\\n" 5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001290 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001291
Eric Andersen7e9276b2001-02-22 01:15:47 +00001292#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001293 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001294#define ps_full_usage \
1295 "Report process status\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001296 "\nThis version of ps accepts no options."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001297#define ps_example_usage \
1298 "$ ps\n" \
1299 " PID Uid Gid State Command\n" \
1300 " 1 root root S init\n" \
1301 " 2 root root S [kflushd]\n" \
1302 " 3 root root S [kupdate]\n" \
1303 " 4 root root S [kpiod]\n" \
1304 " 5 root root S [kswapd]\n" \
1305 " 742 andersen andersen S [bash]\n" \
1306 " 743 andersen andersen S -bash\n" \
1307 " 745 root root S [getty]\n" \
1308 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001309
Eric Andersen7e9276b2001-02-22 01:15:47 +00001310#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001311 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001312#define pwd_full_usage \
1313 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001314#define pwd_example_usage \
1315 "$ pwd\n" \
1316 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001317
Eric Andersen7e9276b2001-02-22 01:15:47 +00001318#define rdate_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001319 "[OPTION] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001320#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001321 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001322 "Options:\n" \
1323 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001324 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001325
Eric Andersen7e9276b2001-02-22 01:15:47 +00001326#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001327 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001328#define readlink_full_usage \
1329 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001330
Eric Andersen7e9276b2001-02-22 01:15:47 +00001331#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001332 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001333#define reboot_full_usage \
1334 "Reboot the system."
1335
1336#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001337 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001338#define renice_full_usage \
1339 "Changes priority of running processes. Allowed priorities range\n" \
1340 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001341 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001342
Eric Andersen7e9276b2001-02-22 01:15:47 +00001343#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001344 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001345#define reset_full_usage \
1346 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001347
Eric Andersen7e9276b2001-02-22 01:15:47 +00001348#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001349 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001350#define rm_full_usage \
1351 "Remove (unlink) the FILE(s). You may use '--' to\n" \
1352 "indicate that all following arguments are non-options.\n\n" \
1353 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00001354 "\t-i\t\talways prompt before removing each destination" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001355 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001356 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001357#define rm_example_usage \
1358 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001359
Eric Andersen7e9276b2001-02-22 01:15:47 +00001360#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001361 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001362#define rmdir_full_usage \
1363 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001364#define rmdir_example_usage \
1365 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001366
Eric Andersen7e9276b2001-02-22 01:15:47 +00001367#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001368 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001369#define rmmod_full_usage \
1370 "Unloads the specified kernel modules from the kernel.\n\n" \
1371 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001372 "\t-a\tTry to remove all unused kernel modules."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001373#define rmmod_example_usage \
1374 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001375
Eric Andersen7e9276b2001-02-22 01:15:47 +00001376#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001377 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001378#define route_full_usage \
1379 "Edit the kernel's routing tables"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001380
Glenn L McGrathf8736d22001-06-26 01:19:34 +00001381#define rpm2cpio_trivial_usage \
1382 "package.rpm"
1383#define rpm2cpio_full_usage \
1384 "Outputs a cpio archive of the rpm file."
1385
Eric Andersen6cf47a72001-10-31 10:24:36 +00001386#define run_parts_trivial_usage \
1387 "[-t] [-a ARG] [-u MASK] DIRECTORY"
1388#define run_parts_full_usage \
1389 "Run a bunch of scripts in a directory.\n\n" \
1390 "Options:\n" \
1391 "\t-t\t\tTest only what file will be executed, without execute them.\n" \
1392 "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \
1393 "\t-u MASK\tSet the umask to MASK before executing every program."
1394
Eric Andersen7e9276b2001-02-22 01:15:47 +00001395#define sed_trivial_usage \
Matt Kraai075228a2001-06-21 14:40:55 +00001396 "[-nef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001397#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001398 "Options:\n" \
1399 "\t-n\t\tsuppress automatic printing of pattern space\n" \
1400 "\t-e script\tadd the script to the commands to be executed\n" \
1401 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001402 "\n" \
1403 "If no -e or -f is given, the first non-option argument is taken as the\n" \
1404 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001405 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001406#define sed_example_usage \
1407 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
1408 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001409
Eric Andersen7e9276b2001-02-22 01:15:47 +00001410#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001411 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001412#define setkeycodes_full_usage \
1413 "Set entries into the kernel's scancode-to-keycode map,\n" \
1414 "allowing unusual keyboards to generate usable keycodes.\n\n" \
1415 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001416 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001417#define setkeycodes_example_usage \
1418 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001419
Matt Kraai2d91deb2001-08-01 17:21:35 +00001420#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001421 "[FILE]...\n" \
1422 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00001423#define lash_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001424 "lash: The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00001425#define lash_notes_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001426"This command does not yet have proper documentation.\n" \
1427"\n" \
1428"Use lash just as you would use any other shell. It properly handles pipes,\n" \
1429"redirects, job control, can be used as the shell for scripts, and has a\n" \
1430"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
1431"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
1432"use ash or bash. If you just need a very simple and extremely small shell,\n" \
1433"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001434
Eric Andersen7e9276b2001-02-22 01:15:47 +00001435#define sleep_trivial_usage \
1436 "N"
1437#define sleep_full_usage \
1438 "Pause for N seconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001439#define sleep_example_usage \
1440 "$ sleep 2\n" \
1441 "[2 second delay results]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001442
Eric Andersen7e9276b2001-02-22 01:15:47 +00001443
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001444#ifdef CONFIG_FEATURE_SORT_UNIQUE
Mark Whitleyfccaa362001-04-17 18:56:18 +00001445 #define USAGE_SORT_UNIQUE(a) a
1446#else
1447 #define USAGE_SORT_UNIQUE(a)
1448#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001449#ifdef CONFIG_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001450 #define USAGE_SORT_REVERSE(a) a
1451#else
1452 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001453#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001454#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001455 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001456#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001457 "Sorts lines of text in the specified files\n\n"\
1458 "Options:\n" \
1459 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
1460 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
1461 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001462#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001463 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001464 "a\n" \
1465 "b\n" \
1466 "c\n" \
1467 "d\n" \
1468 "e\n" \
1469 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001470
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001471#define start_stop_daemon_trivial_usage \
1472 "[OPTIONS]"
1473#define start_stop_daemon_full_usage \
1474 "Program to start and stop services.\n"\
1475 "Options:\n" \
1476 "-S\t\t\tstart\n"\
1477 "-K\t\t\tstop\n"\
1478 "-x <executable>\t\tprogram to start/check if it is running\n"\
1479 "-p <pid-file>\t\tpid file to check\n"\
1480 "-u <username>|<uid>\tstop this user's processes\n"\
1481 "-n <process-name>\tstop processes with this name\n"\
1482 "-s <signal>\t\tsignal to send (default 15)\n"\
1483 "-a <pathname>\t\tprogram to start (default <executable>)\n"
1484
Eric Andersen7e9276b2001-02-22 01:15:47 +00001485#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001486 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001487#define stty_full_usage \
1488 "Without arguments, prints baud rate, line discipline," \
1489 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001490 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00001491 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001492 "\n\t-a\t\tprint all current settings in human-readable form" \
1493 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00001494 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001495
Eric Andersen7e9276b2001-02-22 01:15:47 +00001496#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001497 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001498#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001499 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001500 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001501 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001502
Eric Andersen7e9276b2001-02-22 01:15:47 +00001503#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001504 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001505#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001506 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001507 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001508 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001509
Eric Andersen7e9276b2001-02-22 01:15:47 +00001510#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001511 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001512#define sync_full_usage \
1513 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001514
Eric Andersen7e9276b2001-02-22 01:15:47 +00001515
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001516#ifdef CONFIG_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00001517 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001518#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00001519 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001520#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001521#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001522 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001523#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00001524 "Linux system and kernel logging utility.\n" \
1525 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001526 "Options:\n" \
1527 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
1528 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001529 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001530 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00001531 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
1532 "\t-L\t\tLog locally and via network logging (default is network only)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001533#define syslogd_example_usage \
1534 "$ syslogd -R masterlog:514\n" \
1535 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001536
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001537
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001538#ifndef CONFIG_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00001539 #define USAGE_UNSIMPLE_TAIL(a)
1540#else
1541 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001542#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001543#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001544 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001545#define tail_full_usage \
1546 "Print last 10 lines of each FILE to standard output.\n" \
1547 "With more than one FILE, precede each with a header giving the\n" \
1548 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
1549 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001550 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001551 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
1552 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001553 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001554 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
1555 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001556 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001557 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001558 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
1559#define tail_example_usage \
1560 "$ tail -n 1 /etc/resolv.conf\n" \
1561 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001562
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001563#ifdef CONFIG_FEATURE_TAR_CREATE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001564 #define USAGE_TAR_CREATE(a) a
1565#else
1566 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001567#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001568#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001569 #define USAGE_TAR_EXCLUDE(a) a
1570#else
1571 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001572#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001573#define tar_trivial_usage \
1574 "-[" USAGE_TAR_CREATE("c") "xtvO] " \
Eric Andersen317827d2001-05-21 17:50:53 +00001575 USAGE_TAR_EXCLUDE("[--exclude FILE] [-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00001576 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001577#define tar_full_usage \
1578 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00001579 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001580 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001581 "\tx\t\textract\n" \
1582 "\tt\t\tlist\n" \
1583 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001584 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001585 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001586 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001587 "\texclude\t\tfile to exclude\n" \
1588 "\tX\t\tfile with names to exclude\n" \
1589 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00001590 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001591 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001592#define tar_example_usage \
1593 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
1594 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001595
Eric Andersen7e9276b2001-02-22 01:15:47 +00001596#define tee_trivial_usage \
1597 "[OPTION]... [FILE]..."
1598#define tee_full_usage \
1599 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001600 "Options:\n" \
1601 "\t-a\tappend to the given FILEs, do not overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001602#define tee_example_usage \
1603 "$ echo "Hello" | tee /tmp/foo\n" \
1604 "$ cat /tmp/foo\n" \
1605 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001606
Eric Andersen7e9276b2001-02-22 01:15:47 +00001607#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001608 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001609#define telnet_full_usage \
1610 "Telnet is used to establish interactive communication with another\n"\
1611 "computer over a network using the TELNET protocol."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001612
Eric Andersen7e9276b2001-02-22 01:15:47 +00001613#define test_trivial_usage \
1614 "EXPRESSION\n or [ EXPRESSION ]"
1615#define test_full_usage \
1616 "Checks file types and compares values returning an exit\n" \
1617 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001618#define test_example_usage \
1619 "$ test 1 -eq 2\n" \
1620 "$ echo $?\n" \
1621 "1\n" \
1622 "$ test 1 -eq 1\n" \
1623 "$ echo $? \n" \
1624 "0\n" \
1625 "$ [ -d /etc ]\n" \
1626 "$ echo $?\n" \
1627 "0\n" \
1628 "$ [ -d /junk ]\n" \
1629 "$ echo $?\n" \
1630 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001631
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001632#ifdef CONFIG_FEATURE_TFTP_GET
Mark Whitley450736c2001-03-02 19:08:50 +00001633 #define USAGE_TFTP_GET(a) a
1634#else
1635 #define USAGE_TFTP_GET(a)
1636#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001637#ifdef CONFIG_FEATURE_TFTP_PUT
Mark Whitley450736c2001-03-02 19:08:50 +00001638 #define USAGE_TFTP_PUT(a) a
1639#else
1640 #define USAGE_TFTP_PUT(a)
1641#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001642#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Glenn L McGrathad117d82001-10-05 04:40:37 +00001643 #define USAGE_TFTP_BS(a) a
1644#else
1645 #define USAGE_TFTP_BS(a)
1646#endif
Mark Whitley450736c2001-03-02 19:08:50 +00001647
1648#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00001649 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00001650#define tftp_full_usage \
1651 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00001652 "Options:\n" \
Glenn L McGrathad117d82001-10-05 04:40:37 +00001653 "\t-l FILE\tLocal FILE.\n" \
1654 "\t-r FILE\tRemote FILE.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00001655 USAGE_TFTP_GET( \
Matt Kraai3be34302001-09-21 14:42:30 +00001656 "\t-g\tGet file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00001657 ) \
1658 USAGE_TFTP_PUT( \
Matt Kraai3be34302001-09-21 14:42:30 +00001659 "\t-p\tPut file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00001660 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00001661 USAGE_TFTP_BS( \
1662 "\t-b SIZE\tTransfer blocks of SIZE octets.\n" \
1663 )
Mark Whitley450736c2001-03-02 19:08:50 +00001664
Eric Andersen7e9276b2001-02-22 01:15:47 +00001665#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001666 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001667#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001668 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001669 "Options:\n" \
1670 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001671#define touch_example_usage \
1672 "$ ls -l /tmp/foo\n" \
1673 "/bin/ls: /tmp/foo: No such file or directory\n" \
1674 "$ touch /tmp/foo\n" \
1675 "$ ls -l /tmp/foo\n" \
1676 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001677
1678#define tr_trivial_usage \
1679 "[-cds] STRING1 [STRING2]"
1680#define tr_full_usage \
1681 "Translate, squeeze, and/or delete characters from\n" \
1682 "standard input, writing to standard output.\n\n" \
1683 "Options:\n" \
1684 "\t-c\ttake complement of STRING1\n" \
1685 "\t-d\tdelete input characters coded STRING1\n" \
1686 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001687#define tr_example_usage \
1688 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
1689 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001690
Eric Andersen5c58d282001-07-10 16:29:00 +00001691#define traceroute_trivial_usage \
1692 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n\
1693 [-s src_addr] [-t tos] [-w wait] host [data size]"
1694#define traceroute_full_usage \
1695 "trace the route ip packets follow going to \"host\"\n" \
1696 "Options:\n" \
1697 "\t-d\tset SO_DEBUG options to socket\n" \
1698 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
1699 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
1700 "\t-v\tVerbose output\n" \
1701 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
1702 "\t-p port#\tSet the base UDP port number used in probes\n" \
1703 "\t\t(default is 33434)\n" \
1704 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
1705 "\t\t(default is 3)\n" \
1706 "\t-s src_addr\tUse the following IP address as the source address\n" \
1707 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
1708 "\t\t(default 0)\n" \
1709 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
1710 "\t\t(default 3 sec.)."
1711
1712
Eric Andersen7e9276b2001-02-22 01:15:47 +00001713#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001714 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001715#define true_full_usage \
1716 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001717#define true_example_usage \
1718 "$ true\n" \
1719 "$ echo $?\n" \
1720 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001721
Eric Andersen7e9276b2001-02-22 01:15:47 +00001722#define tty_trivial_usage \
1723 ""
1724#define tty_full_usage \
1725 "Print the file name of the terminal connected to standard input.\n\n"\
1726 "Options:\n" \
1727 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001728#define tty_example_usage \
1729 "$ tty\n" \
1730 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001731
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001732#ifdef CONFIG_FEATURE_MOUNT_FORCE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001733 #define USAGE_MOUNT_FORCE(a) a
1734#else
1735 #define USAGE_MOUNT_FORCE(a)
1736#endif
1737#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001738 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001739#define umount_full_usage \
1740 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00001741 "\nFlags:\n" "\t-a\tUnmount all file systems" \
1742 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
1743 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00001744 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00001745 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 +00001746#define umount_example_usage \
1747 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001748
1749#define uname_trivial_usage \
1750 "[OPTION]..."
1751#define uname_full_usage \
1752 "Print certain system information. With no OPTION, same as -s.\n\n" \
1753 "Options:\n" \
1754 "\t-a\tprint all information\n" \
1755 "\t-m\tthe machine (hardware) type\n" \
1756 "\t-n\tprint the machine's network node hostname\n" \
1757 "\t-r\tprint the operating system release\n" \
1758 "\t-s\tprint the operating system name\n" \
1759 "\t-p\tprint the host processor type\n" \
1760 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001761#define uname_example_usage \
1762 "$ uname -a\n" \
1763 "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001764
1765#define uniq_trivial_usage \
1766 "[OPTION]... [INPUT [OUTPUT]]"
1767#define uniq_full_usage \
1768 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001769 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001770 "Options:\n" \
1771 "\t-c\tprefix lines by the number of occurrences\n" \
1772 "\t-d\tonly print duplicate lines\n" \
1773 "\t-u\tonly print unique lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001774#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001775 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001776 "a\n" \
1777 "b\n" \
1778 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001779
1780#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001781 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001782#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001783 "Converts FILE from unix format to dos format. When no option\n" \
1784 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00001785 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001786 "Options:\n" \
1787 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00001788 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001789
1790#define update_trivial_usage \
1791 "[options]"
1792#define update_full_usage \
1793 "Periodically flushes filesystem buffers.\n\n" \
1794 "Options:\n" \
1795 "\t-S\tforce use of sync(2) instead of flushing\n" \
1796 "\t-s SECS\tcall sync this often (default 30)\n" \
1797 "\t-f SECS\tflush some buffers this often (default 5)"
1798
1799#define uptime_trivial_usage \
1800 ""
1801#define uptime_full_usage \
1802 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001803#define uptime_example_usage \
1804 "$ uptime\n" \
1805 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001806
1807#define usleep_trivial_usage \
1808 "N"
1809#define usleep_full_usage \
1810 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001811#define usleep_example_usage \
1812 "$ usleep 1000000\n" \
1813 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001814
1815#define uudecode_trivial_usage \
1816 "[FILE]..."
1817#define uudecode_full_usage \
1818 "Uudecode a file that is uuencoded.\n\n" \
1819 "Options:\n" \
Eric Andersen704b2c22001-03-16 08:06:30 +00001820 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001821#define uudecode_example_usage \
1822 "$ uudecode -o busybox busybox.uu\n" \
1823 "$ ls -l busybox\n" \
1824 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001825
1826#define uuencode_trivial_usage \
1827 "[OPTION] [INFILE] REMOTEFILE"
1828#define uuencode_full_usage \
1829 "Uuencode a file.\n\n" \
1830 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00001831 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001832#define uuencode_example_usage \
1833 "$ uuencode busybox busybox\n" \
1834 "begin 755 busybox\n" \
1835 "<encoded file snipped>\n" \
1836 "$ uudecode busybox busybox > busybox.uu\n" \
1837 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001838
Eric Andersen3f980402001-04-04 17:31:15 +00001839#define vi_trivial_usage \
1840 "[OPTION] [FILE]..."
1841#define vi_full_usage \
1842 "edit FILE.\n\n" \
1843 "Options:\n" \
1844 "\t-R\tRead-only- do not write to the file."
1845
Eric Andersen7e9276b2001-02-22 01:15:47 +00001846#define watchdog_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001847 "DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001848#define watchdog_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001849 "Periodically write to watchdog device DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001850
1851#define wc_trivial_usage \
1852 "[OPTION]... [FILE]..."
1853#define wc_full_usage \
1854 "Print line, word, and byte counts for each FILE, and a total line if\n" \
1855 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
1856 "Options:\n" \
1857 "\t-c\tprint the byte counts\n" \
1858 "\t-l\tprint the newline counts\n" \
1859 "\t-L\tprint the length of the longest line\n" \
1860 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001861#define wc_example_usage \
1862 "$ wc /etc/passwd\n" \
1863 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001864
1865#define wget_trivial_usage \
Eric Andersen8071c022001-06-21 19:45:06 +00001866 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n\t[--header 'header: value'] [-P DIR] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001867#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00001868 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001869 "Options:\n" \
1870 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00001871 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00001872 "\t-P\tSet directory prefix to DIR\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001873 "\t-O\tsave to filename ('-' for stdout)"
1874
1875#define which_trivial_usage \
1876 "[COMMAND ...]"
1877#define which_full_usage \
1878 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001879#define which_example_usage \
1880 "$ which login\n" \
1881 "/bin/login\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001882
1883#define whoami_trivial_usage \
1884 ""
1885#define whoami_full_usage \
1886 "Prints the user name associated with the current effective user id."
1887
1888#define xargs_trivial_usage \
1889 "[COMMAND] [ARGS...]"
1890#define xargs_full_usage \
1891 "Executes COMMAND on every item given by standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001892#define xargs_example_usage \
1893 "$ ls | xargs gzip\n" \
1894 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001895
1896#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001897 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001898#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001899 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001900
Eric Andersen7e9276b2001-02-22 01:15:47 +00001901#define zcat_trivial_usage \
1902 "FILE"
1903#define zcat_full_usage \
1904 "Uncompress to stdout."