blob: ac980bf8c7a766d581f6f47a1508d1f83953f88d [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
Eric Andersen7e9276b2001-02-22 01:15:47 +000054#define cat_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000055 "[FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000056#define cat_full_usage \
57 "Concatenates FILE(s) and prints them to stdout."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000058#define cat_example_usage \
59 "$ cat /proc/uptime\n" \
60 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000061
Eric Andersen7e9276b2001-02-22 01:15:47 +000062#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000063 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000064#define chgrp_full_usage \
65 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000066 "\nOptions:\n" \
67 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000068#define chgrp_example_usage \
69 "$ ls -l /tmp/foo\n" \
70 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
71 "$ chgrp root /tmp/foo\n" \
72 "$ ls -l /tmp/foo\n" \
73 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000074
Eric Andersen7e9276b2001-02-22 01:15:47 +000075#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000076 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000077#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000078 "Each MODE is one or more of the letters ugoa, one of the\n" \
79 "symbols +-= and one or more of the letters rwxst.\n\n" \
80 "Options:\n" \
81 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000082#define chmod_example_usage \
83 "$ ls -l /tmp/foo\n" \
84 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
85 "$ chmod u+x /tmp/foo\n" \
86 "$ ls -l /tmp/foo\n" \
87 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
88 "$ chmod 444 /tmp/foo\n" \
89 "$ ls -l /tmp/foo\n" \
90 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000091
Eric Andersen7e9276b2001-02-22 01:15:47 +000092#define chown_trivial_usage \
Eric Andersen238da242001-05-11 16:31:46 +000093 "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000094#define chown_full_usage \
95 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000096 "\nOptions:\n" \
Eric Andersen238da242001-05-11 16:31:46 +000097 "\t-R\tChanges files and directories recursively.\n" \
98 "\t-h\tDo not dereference symbolic links."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000099#define chown_example_usage \
100 "$ ls -l /tmp/foo\n" \
101 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
102 "$ chown root /tmp/foo\n" \
103 "$ ls -l /tmp/foo\n" \
104 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
105 "$ chown root.root /tmp/foo\n" \
106 "ls -l /tmp/foo\n" \
107 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000108
Eric Andersen7e9276b2001-02-22 01:15:47 +0000109#define chroot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000110 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000111#define chroot_full_usage \
112 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000113#define chroot_example_usage \
114 "$ ls -l /bin/ls\n" \
115 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
116 "$ mount /dev/hdc1 /mnt -t minix\n" \
117 "$ chroot /mnt\n" \
118 "$ ls -l /bin/ls\n" \
119 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000120
Eric Andersen7e9276b2001-02-22 01:15:47 +0000121#define chvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000122 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000123#define chvt_full_usage \
124 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000125
Eric Andersen7e9276b2001-02-22 01:15:47 +0000126#define clear_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000127 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000128#define clear_full_usage \
129 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000130
Eric Andersen7e9276b2001-02-22 01:15:47 +0000131#define cmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000132 "FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000133#define cmp_full_usage \
Mark Whitley207587a2001-04-25 20:41:02 +0000134 "\t-s\tquiet mode - do not print\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000135 "Compare files."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000136
Eric Andersen7e9276b2001-02-22 01:15:47 +0000137#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000138 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000139#define cp_full_usage \
140 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
141 "\n" \
142 "\t-a\tSame as -dpR\n" \
143 "\t-d\tPreserves links\n" \
144 "\t-p\tPreserves file attributes if possible\n" \
145 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000146 "\t-R\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000147
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000148#define cpio_trivial_usage \
149 "-[dimtuv][F cpiofile]"
150#define cpio_full_usage \
151 "Extract or list files from a cpio archive\n" \
152 "Main operation mode:\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000153 "\td\t\tmake leading directories\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000154 "\ti\t\textract\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000155 "\tm\t\tpreserve mtime\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000156 "\tt\t\tlist\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000157 "\tu\t\tunconditional overwrite\t" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000158 "\tF\t\tinput from file\t"
159
Eric Andersen7e9276b2001-02-22 01:15:47 +0000160#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000161 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000162#define cut_full_usage \
163 "Prints selected fields from each input FILE to standard output.\n\n" \
164 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000165 "\t-b LIST\t\tOutput only bytes from LIST\n" \
166 "\t-c LIST\t\tOutput only characters from LIST\n" \
167 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
168 "\t-s\t\tOutput only the lines containing delimiter\n" \
169 "\t-f N\t\tPrint only these fields\n" \
170 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000171#define cut_example_usage \
172 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
173 "Hello\n" \
174 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
175 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000176
Eric Andersen7e9276b2001-02-22 01:15:47 +0000177#define date_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000178 "[OPTION]... [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000179#define date_full_usage \
180 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000181 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000182 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000183 "\t-d STRING\tdisplay time described by STRING, not `now'\n" \
184 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000185 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000186#define date_example_usage \
187 "$ date\n" \
188 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000189
Eric Andersen7e9276b2001-02-22 01:15:47 +0000190#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000191 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000192#define dc_full_usage \
193 "This is a Tiny RPN calculator that understands the\n" \
194 "following operations: +, -, /, *, and, or, not, eor.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000195 "i.e., 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000196#define dc_example_usage \
197 "$ dc 2 2 +\n" \
198 "4\n" \
199 "$ dc 8 8 \* 2 2 + /\n" \
200 "16\n" \
201 "$ dc 0 1 and\n" \
202 "0\n" \
203 "$ dc 0 1 or\n" \
204 "1\n" \
205 "$ echo 72 9 div 8 mul | dc\n" \
206 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000207
Eric Andersen7e9276b2001-02-22 01:15:47 +0000208#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000209 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000210 "\t [seek=N] [conv=notrunc|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000211#define dd_full_usage \
212 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000213 "\tif=FILE\t\tread from FILE instead of stdin\n" \
214 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
215 "\tbs=N\t\tread and write N bytes at a time\n" \
216 "\tcount=N\t\tcopy only N input blocks\n" \
217 "\tskip=N\t\tskip N input blocks\n" \
218 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000219 "\tconv=notrunc\tdon't truncate output file\n" \
220 "\tconv=sync\tpad blocks with zeros\n" \
221 "\n" \
222 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000223 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000224#define dd_example_usage \
225 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
226 "4+0 records in\n" \
227 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000228
Eric Andersen7e9276b2001-02-22 01:15:47 +0000229#define deallocvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000230 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000231#define deallocvt_full_usage \
232 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000233
Eric Andersenf349e972001-08-21 16:18:59 +0000234#define delgroup_trivial_usage \
235 "GROUP"
236#define delgroup_full_usage \
237 "Deletes group GROUP from the system"
238
239#define deluser_trivial_usage \
240 "USER"
241#define deluser_full_usage \
242 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000243
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000244#ifdef BB_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000245 #define USAGE_HUMAN_READABLE(a) a
246 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000247#else
Eric Andersened0d9582001-02-23 13:23:03 +0000248 #define USAGE_HUMAN_READABLE(a)
249 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000250#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000251#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000252 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000253#define df_full_usage \
254 "Print the filesystem space used and space available.\n\n" \
255 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000256 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000257 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
258 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000259 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000260 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000261#define df_example_usage \
262 "$ df\n" \
263 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
264 "/dev/sda3 8690864 8553540 137324 98% /\n" \
265 "/dev/sda1 64216 36364 27852 57% /boot\n" \
266 "$ df /dev/sda3\n" \
267 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
268 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000269
Eric Andersen7e9276b2001-02-22 01:15:47 +0000270#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000271 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000272#define dirname_full_usage \
273 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000274#define dirname_example_usage \
275 "$ dirname /tmp/foo\n" \
276 "/tmp\n" \
277 "$ dirname /tmp/foo/\n" \
278 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000279
Eric Andersen7e9276b2001-02-22 01:15:47 +0000280#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000281 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000282#define dmesg_full_usage \
283 "Prints or controls the kernel ring buffer\n\n" \
284 "Options:\n" \
285 "\t-c\t\tClears the ring buffer's contents after printing\n" \
286 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000287 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000288
Eric Andersen7e9276b2001-02-22 01:15:47 +0000289#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000290 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000291#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000292 "Converts FILE from dos format to unix format. When no option\n" \
293 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000294 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000295 "Options:\n" \
296 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000297 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000298
Eric Andersen7e9276b2001-02-22 01:15:47 +0000299#define dpkg_trivial_usage \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000300 "-i package_file\n"
301 "[-CPru] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000302#define dpkg_full_usage \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000303 "\t-i\tInstall the package\n" \
304 "\t-C\tConfigure an unpackaged package\n" \
305 "\t-P\tPurge all files of a package\n" \
306 "\t-r\tRemove all but the configuration files for a package\n" \
307 "\t-u\tUnpack a package, but dont configure it\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000308
Eric Andersen7e9276b2001-02-22 01:15:47 +0000309#define dpkg_deb_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000310 "[-cefItxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000311#define dpkg_deb_full_usage \
312 "Perform actions on debian packages (.debs)\n\n" \
313 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000314 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000315 "\t-e\tExtract control files to [argument] directory\n" \
316 "\t-f\tDisplay control field name starting with [argument]\n" \
317 "\t-I\tDisplay the control filenamed [argument]\n" \
318 "\t-t\tExtract filesystem tree to stdout in tar format\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000319 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000320 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000321#define dpkg_deb_example_usage \
322 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000323
Eric Andersen7e9276b2001-02-22 01:15:47 +0000324#define du_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +0000325 "[-ls" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000326#define du_full_usage \
327 "Summarizes disk space used for each FILE and/or directory.\n" \
328 "Disk space is printed in units of 1024 bytes.\n\n" \
329 "Options:\n" \
330 "\t-l\tcount sizes many times if hard linked\n" \
331 "\t-s\tdisplay only a total for each argument" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000332 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000333 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
334 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000335 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000336 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000337#define du_example_usage \
338 "$ du\n" \
339 "16 ./CVS\n" \
340 "12 ./kernel-patches/CVS\n" \
341 "80 ./kernel-patches\n" \
342 "12 ./tests/CVS\n" \
343 "36 ./tests\n" \
344 "12 ./scripts/CVS\n" \
345 "16 ./scripts\n" \
346 "12 ./docs/CVS\n" \
347 "104 ./docs\n" \
348 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000349
Eric Andersen7e9276b2001-02-22 01:15:47 +0000350#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000351 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000352#define dumpkmap_full_usage \
353 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000354#define dumpkmap_example_usage \
355 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000356
Eric Andersen7e9276b2001-02-22 01:15:47 +0000357#define dutmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000358 "[FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000359#define dutmp_full_usage \
360 "Dump utmp file format (pipe delimited) from FILE\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000361 "or stdin to stdout. (i.e., 'dutmp /var/run/utmp')"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000362#define dutmp_example_usage \
363 "$ dutmp /var/run/utmp\n" \
364 "8|7||si|||0|0|0|955637625|760097|0\n" \
365 "2|0|~|~~|reboot||0|0|0|955637625|782235|0\n" \
366 "1|20020|~|~~|runlevel||0|0|0|955637625|800089|0\n" \
367 "8|125||l4|||0|0|0|955637629|998367|0\n" \
368 "6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0\n" \
369 "6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0\n" \
370 "7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000371
Eric Andersen7e9276b2001-02-22 01:15:47 +0000372#define echo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000373 "[-neE] [ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000374#define echo_full_usage \
375 "Prints the specified ARGs to stdout\n\n" \
376 "Options:\n" \
377 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000378 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000379 "\t-E\tdisable interpretation of backslash-escaped characters"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000380#define echo_example_usage \
381 "$ echo "Erik is cool"\n" \
382 "Erik is cool\n" \
John Beppu5d817682001-04-17 17:09:34 +0000383 "$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000384 "Erik\n" \
385 "is\n" \
386 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000387 "$ echo "Erik\\nis\\ncool"\n" \
388 "Erik\\nis\\ncool\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000389
Eric Andersen84e229c2001-03-29 22:48:33 +0000390#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000391 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000392#define env_full_usage \
393 "Prints the current environment or runs a program after setting\n" \
394 "up the specified environment.\n\n" \
395 "Options:\n" \
396 "\t-, -i\tstart with an empty environment\n" \
397 "\t-u\tremove variable from the environment\n"
398
Eric Andersen7e9276b2001-02-22 01:15:47 +0000399#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000400 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000401#define expr_full_usage \
402 "Prints the value of EXPRESSION to standard output.\n\n" \
403 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000404 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
405 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
406 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
407 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
408 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
409 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
410 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
411 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
412 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
413 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
414 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
415 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
416 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000417 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
418 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
419 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
420 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
421 "\t or 0\n" \
422 "\tlength STRING length of STRING\n" \
423 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
424 "\t it is a keyword like `match' or an\n" \
425 "\t operator like `/'\n" \
426 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000427 "Beware that many operators need to be escaped or quoted for shells.\n" \
428 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
429 "lexicographical. Pattern matches return the string matched between \n" \
430 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
431 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000432
Eric Andersen7e9276b2001-02-22 01:15:47 +0000433#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000434 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000435#define false_full_usage \
436 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000437#define false_example_usage \
438 "$ false\n" \
439 "$ echo $?\n" \
440 "1\n"
441
442#define fbset_trivial_usage \
443 "[options] [mode]"
444#define fbset_full_usage \
445 "Show and modify frame buffer settings"
446#define fbset_example_usage \
447 "$ fbset\n" \
448 "mode "1024x768-76"\n" \
449 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
450 "\tgeometry 1024 768 1024 768 16\n" \
451 "\ttimings 12714 128 32 16 4 128 4\n" \
452 "\taccel false\n" \
453 "\trgba 5/11,6/5,5/0,0/0\n" \
454 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000455
Eric Andersen7e9276b2001-02-22 01:15:47 +0000456#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000457 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000458#define fdflush_full_usage \
459 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000460
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000461#ifdef BB_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000462 #define USAGE_FIND_TYPE(a) a
463#else
464 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000465#endif
466#ifdef BB_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000467 #define USAGE_FIND_PERM(a) a
468#else
469 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000470#endif
471#ifdef BB_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000472 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000473#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000474 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000475#endif
476
Eric Andersen7e9276b2001-02-22 01:15:47 +0000477#define find_trivial_usage \
478 "[PATH...] [EXPRESSION]"
479#define find_full_usage \
480 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000481 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000482 "\nEXPRESSION may consist of:\n" \
483 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000484 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000485 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000486 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000487 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
488) USAGE_FIND_PERM( \
489 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
490) USAGE_FIND_MTIME( \
491 "\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 +0000492#define find_example_usage \
493 "$ find / -name /etc/passwd\n" \
494 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000495
Eric Andersen7e9276b2001-02-22 01:15:47 +0000496#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000497 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000498#define free_full_usage \
499 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000500#define free_example_usage \
501 "$ free\n" \
502 " total used free shared buffers\n" \
503 " Mem: 257628 248724 8904 59644 93124\n" \
504 " Swap: 128516 8404 120112\n" \
505 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000506
Eric Andersen7e9276b2001-02-22 01:15:47 +0000507#define freeramdisk_trivial_usage \
508 "DEVICE"
509#define freeramdisk_full_usage \
510 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000511#define freeramdisk_example_usage \
512 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000513
514#define fsck_minix_trivial_usage \
515 "[-larvsmf] /dev/name"
516#define fsck_minix_full_usage \
517 "Performs a consistency check for MINIX filesystems.\n\n" \
518 "Options:\n" \
519 "\t-l\tLists all filenames\n" \
520 "\t-r\tPerform interactive repairs\n" \
521 "\t-a\tPerform automatic repairs\n" \
522 "\t-v\tverbose\n" \
523 "\t-s\tOutputs super-block information\n" \
524 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
525 "\t-f\tForce file system check."
526
527#define getopt_trivial_usage \
528 "[OPTIONS]..."
529#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000530 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000531 "\t-a, --alternative Allow long options starting with single -\n" \
532 "\t-l, --longoptions=longopts Long options to be recognized\n" \
533 "\t-n, --name=progname The name under which errors are reported\n" \
534 "\t-o, --options=optstring Short options to be recognized\n" \
535 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
536 "\t-Q, --quiet-output No normal output\n" \
537 "\t-s, --shell=shell Set shell quoting conventions\n" \
538 "\t-T, --test Test for getopt(1) version\n" \
539 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000540#define getopt_example_usage \
541 "$ cat getopt.test\n" \
542 "#!/bin/sh\n" \
543 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
544 " -n 'example.busybox' -- "$@"`\n" \
545 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
546 "eval set -- "$GETOPT"\n" \
547 "while true ; do\n" \
548 " case $1 in\n" \
549 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
550 " -b|--b-long) echo \"Option b, argument \`$2'\" ; shift 2 ;;\n" \
551 " -c|--c-long)\n" \
552 " case "$2" in\n" \
553 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
554 " *) echo \"Option c, argument \`$2'\" ; shift 2 ;;\n" \
555 " esac ;;\n" \
556 " --) shift ; break ;;\n" \
557 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
558 " esac\n" \
559 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000560
Eric Andersenf349e972001-08-21 16:18:59 +0000561#define getty_trivial_usage \
562 "getty [OPTIONS]... baud_rate,... line [termtype]"
563#define getty_full_usage \
564 "\nOpens a tty, prompts for a login name, then invokes /bin/login\n\n" \
565 "Options:\n" \
566 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
567 "\t-i\t\tDo not display /etc/issue before running login.\n" \
568 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
569 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
570 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
571 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
572 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
573 "\t-I initstring\tSets the init string to send before anything else.\n" \
574 "\t-H login_host\tLog login_host into the utmp file as the hostname."
575
576
Eric Andersen7e9276b2001-02-22 01:15:47 +0000577#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000578 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000579#define grep_full_usage \
580 "Search for PATTERN in each FILE or standard input.\n\n" \
581 "Options:\n" \
582 "\t-H\tprefix output lines with filename where match was found\n" \
583 "\t-h\tsuppress the prefixing filename on output\n" \
584 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000585 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000586 "\t-n\tprint line number with output lines\n" \
587 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
588 "\t-v\tselect non-matching lines\n" \
589 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000590#define grep_example_usage \
591 "$ grep root /etc/passwd\n" \
592 "root:x:0:0:root:/root:/bin/bash\n" \
593 "$ grep ^[rR]oo. /etc/passwd\n" \
594 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000595
Eric Andersen7e9276b2001-02-22 01:15:47 +0000596#define gunzip_trivial_usage \
597 "[OPTION]... FILE"
598#define gunzip_full_usage \
599 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
600 "Options:\n" \
601 "\t-c\tWrite output to standard output\n" \
602 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000603#define gunzip_example_usage \
604 "$ ls -la /tmp/BusyBox*\n" \
605 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
606 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
607 "$ ls -la /tmp/BusyBox*\n" \
608 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000609
610#define gzip_trivial_usage \
611 "[OPTION]... FILE"
612#define gzip_full_usage \
613 "Compress FILE with maximum compression.\n" \
614 "When FILE is '-', reads standard input. Implies -c.\n\n" \
615 "Options:\n" \
616 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
617 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000618#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000619 "$ ls -la /tmp/busybox*\n" \
620 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
621 "$ gzip /tmp/busybox.tar\n" \
622 "$ ls -la /tmp/busybox*\n" \
623 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000624
625#define halt_trivial_usage \
626 ""
627#define halt_full_usage \
628 "Halt the system."
629
630#define head_trivial_usage \
631 "[OPTION] [FILE]..."
632#define head_full_usage \
633 "Print first 10 lines of each FILE to standard output.\n" \
634 "With more than one FILE, precede each with a header giving the\n" \
635 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000636 "Options:\n" \
637 "\t-n NUM\t\tPrint first NUM lines instead of first 10"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000638#define head_example_usage \
639 "$ head -n 2 /etc/passwd\n" \
640 "root:x:0:0:root:/root:/bin/bash\n" \
641 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000642
643#define hostid_trivial_usage \
644 ""
645#define hostid_full_usage \
646 "Print out a unique 32-bit identifier for the machine."
647
648#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000649 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000650#define hostname_full_usage \
651 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000652 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000653 "Options:\n" \
654 "\t-s\t\tShort\n" \
655 "\t-i\t\tAddresses for the hostname\n" \
656 "\t-d\t\tDNS domain name\n" \
657 "\t-F, --file FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000658#define hostname_example_usage \
659 "$ hostname\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000660 "sage \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000661
662#define id_trivial_usage \
663 "[OPTIONS]... [USERNAME]"
664#define id_full_usage \
665 "Print information for USERNAME or the current user\n\n" \
666 "Options:\n" \
667 "\t-g\tprints only the group ID\n" \
668 "\t-u\tprints only the user ID\n" \
669 "\t-n\tprint a name instead of a number (with for -ug)\n" \
670 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000671#define id_example_usage \
672 "$ id\n" \
673 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000674
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000675#ifdef BB_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +0000676 #define USAGE_SIOCSKEEPALIVE(a) a
677#else
678 #define USAGE_SIOCSKEEPALIVE(a)
679#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000680#ifdef BB_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
681 #define USAGE_IFCONFIG_MII(a) a
682#else
683 #define USAGE_IFCONFIG_MII(a)
684#endif
685#ifdef BB_FEATURE_IFCONFIG_HW
686 #define USAGE_IFCONFIG_HW(a) a
687#else
688 #define USAGE_IFCONFIG_HW(a)
689#endif
690#ifdef BB_FEATURE_IFCONFIG_STATUS
691 #define USAGE_IFCONFIG_OPT_A(a) a
692#else
693 #define USAGE_IFCONFIG_OPT_A(a)
694#endif
695
Eric Andersen7e9276b2001-02-22 01:15:47 +0000696#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000697 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000698#define ifconfig_full_usage \
699 "configure a network interface\n\n" \
700 "Options:\n" \
701 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000702 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000703 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000704 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
705 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000706 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000707 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
708 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000709 "\t[up|down] ..."
710
711#define init_trivial_usage \
712 ""
713#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000714 "Init is the parent of all processes."
715#define init_notes_usage \
716"This version of init is designed to be run only by the kernel.\n" \
717"\n" \
718"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
719"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
720"runlevels, use sysvinit.\n" \
721"\n" \
722"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
723"it has the following default behavior:\n" \
724"\n" \
725" ::sysinit:/etc/init.d/rcS\n" \
726" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000727" ::ctrlaltdel:/sbin/reboot\n" \
728" ::shutdown:/sbin/swapoff -a\n" \
729" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000730"\n" \
731"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
732"\n" \
733" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000734" tty3::askfirst:/bin/sh\n" \
735" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000736"\n" \
737"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
738"\n" \
739" <id>:<runlevels>:<action>:<process>\n" \
740"\n" \
741" <id>: \n" \
742"\n" \
743" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
744" The id field is used by BusyBox init to specify the controlling tty for\n" \
745" the specified process to run on. The contents of this field are\n" \
746" appended to "/dev/" and used as-is. There is no need for this field to\n" \
747" be unique, although if it isn't you may have strange results. If this\n" \
748" field is left blank, the controlling tty is set to the console. Also\n" \
749" note that if BusyBox detects that a serial console is in use, then only\n" \
750" entries whose controlling tty is either the serial console or /dev/null\n" \
751" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
752" stinkin' utmp.\n" \
753"\n" \
754" <runlevels>: \n" \
755"\n" \
756" The runlevels field is completely ignored.\n" \
757"\n" \
758" <action>: \n" \
759"\n" \
760" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000761" once, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000762"\n" \
763" The available actions can be classified into two groups: actions\n" \
764" that are run only once, and actions that are re-run when the specified\n" \
765" process exits.\n" \
766"\n" \
767" Run only-once actions:\n" \
768"\n" \
769" 'sysinit' is the first item run on boot. init waits until all\n" \
770" sysinit actions are completed before continuing. Following the\n" \
771" completion of all sysinit actions, all 'wait' actions are run.\n" \
772" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000773" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000774" therefore, init does not wait for them to complete. 'ctrlaltdel'\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000775" actions are run when the system detects that someone on the system\n" \
776" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
777" wants to run 'reboot' at this point to cause the system to reboot.\n" \
778" Finally the 'shutdown' action specifies the actions to taken when\n" \
779" init is told to reboot. Unmounting filesystems and disabling swap\n" \
780" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000781"\n" \
782" Run repeatedly actions:\n" \
783"\n" \
784" 'respawn' actions are run after the 'once' actions. When a process\n" \
785" started with a 'respawn' action exits, init automatically restarts\n" \
786" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
787" respawning out of control. The 'askfirst' actions acts just like\n" \
788" respawn, except that before running the specified process it\n" \
789" displays the line "Please press Enter to activate this console."\n" \
790" and then waits for the user to press enter before starting the\n" \
791" specified process. \n" \
792"\n" \
793" Unrecognized actions (like initdefault) will cause init to emit an\n" \
794" error message, and then go along with its business. All actions are\n" \
795" run in the reverse order from how they appear in /etc/inittab.\n" \
796"\n" \
797" <process>: \n" \
798"\n" \
799" Specifies the process to be executed and it's command line.\n" \
800"\n" \
801"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +0000802"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000803" # This is run first except when booting in single-user mode.\n" \
804" #\n" \
805" ::sysinit:/etc/init.d/rcS\n" \
806" \n" \
807" # /bin/sh invocations on selected ttys\n" \
808" #\n" \
809" # Start an "askfirst" shell on the console (whatever that may be)\n" \
810" ::askfirst:-/bin/sh\n" \
811" # Start an "askfirst" shell on /dev/tty2-4\n" \
812" tty2::askfirst:-/bin/sh\n" \
813" tty3::askfirst:-/bin/sh\n" \
814" tty4::askfirst:-/bin/sh\n" \
815" \n" \
816" # /sbin/getty invocations for selected ttys\n" \
817" #\n" \
818" tty4::respawn:/sbin/getty 38400 tty5\n" \
819" tty5::respawn:/sbin/getty 38400 tty6\n" \
820" \n" \
821" \n" \
822" # Example of how to put a getty on a serial line (for a terminal)\n" \
823" #\n" \
824" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
825" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
826" #\n" \
827" # Example how to put a getty on a modem line.\n" \
828" #::respawn:/sbin/getty 57600 ttyS2\n" \
829" \n" \
830" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000831" ::ctrlaltdel:/sbin/reboot\n" \
832" ::shutdown:/bin/umount -a -r\n" \
833" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000834
835#define insmod_trivial_usage \
836 "[OPTION]... MODULE [symbol=value]..."
837#define insmod_full_usage \
838 "Loads the specified kernel modules into the kernel.\n\n" \
839 "Options:\n" \
840 "\t-f\tForce module to load into the wrong kernel version.\n" \
841 "\t-k\tMake module autoclean-able.\n" \
842 "\t-v\tverbose output\n" \
843 "\t-L\tLock to prevent simultaneous loads of a module\n" \
844 "\t-x\tdo not export externs"
845
846#define kill_trivial_usage \
847 "[-signal] process-id [process-id ...]"
848#define kill_full_usage \
849 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +0000850 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000851 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000852#define kill_example_usage \
853 "$ ps | grep apache\n" \
854 "252 root root S [apache]\n" \
855 "263 www-data www-data S [apache]\n" \
856 "264 www-data www-data S [apache]\n" \
857 "265 www-data www-data S [apache]\n" \
858 "266 www-data www-data S [apache]\n" \
859 "267 www-data www-data S [apache]\n" \
860 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000861
862#define killall_trivial_usage \
863 "[-signal] process-name [process-name ...]"
864#define killall_full_usage \
865 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000866 "Options:\n" \
867 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000868#define killall_example_usage \
869 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000870
Mark Whitley6317c4b2001-03-12 22:51:50 +0000871#define klogd_trivial_usage \
872 "-n"
873#define klogd_full_usage \
874 "Kernel logger.\n"\
875 "Options:\n"\
876 "\t-n\tRun as a foreground process."
877
Eric Andersen7e9276b2001-02-22 01:15:47 +0000878#define length_trivial_usage \
879 "STRING"
880#define length_full_usage \
881 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000882#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +0000883 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000884 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000885
886#define ln_trivial_usage \
887 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
888#define ln_full_usage \
889 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
890 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
891 "Options:\n" \
892 "\t-s\tmake symbolic links instead of hard links\n" \
893 "\t-f\tremove existing destination files\n" \
894 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000895#define ln_example_usage \
896 "$ ln -s BusyBox /tmp/ls\n" \
897 "$ ls -l /tmp/ls\n" \
898 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000899
900#define loadacm_trivial_usage \
901 "< mapfile"
902#define loadacm_full_usage \
903 "Loads an acm from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000904#define loadacm_example_usage \
905 "$ loadacm < /etc/i18n/acmname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000906
907#define loadfont_trivial_usage \
908 "< font"
909#define loadfont_full_usage \
910 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000911#define loadfont_example_usage \
912 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000913
914#define loadkmap_trivial_usage \
915 "< keymap"
916#define loadkmap_full_usage \
917 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000918#define loadkmap_example_usage \
919 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000920
921#define logger_trivial_usage \
922 "[OPTION]... [MESSAGE]"
923#define logger_full_usage \
924 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
925 "Options:\n" \
926 "\t-s\tLog to stderr as well as the system log.\n" \
927 "\t-t\tLog using the specified tag (defaults to user name).\n" \
928 "\t-p\tEnter the message with the specified priority.\n" \
929 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000930#define logger_example_usage \
931 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000932
933#define logname_trivial_usage \
934 ""
935#define logname_full_usage \
936 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000937#define logname_example_usage \
938 "$ logname\n" \
939 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000940
Mark Whitley6317c4b2001-03-12 22:51:50 +0000941#define logread_trivial_usage \
942 ""
943
944#define logread_full_usage \
945 "Shows the messages from syslogd (using circular buffer)."
946
Eric Andersen7e9276b2001-02-22 01:15:47 +0000947#ifdef BB_FEATURE_LS_TIMESTAMPS
948 #define USAGE_LS_TIMESTAMPS(a) a
949#else
950 #define USAGE_LS_TIMESTAMPS(a)
951#endif
952#ifdef BB_FEATURE_LS_FILETYPES
953 #define USAGE_LS_FILETYPES(a) a
954#else
955 #define USAGE_LS_FILETYPES(a)
956#endif
957#ifdef BB_FEATURE_LS_FOLLOWLINKS
958 #define USAGE_LS_FOLLOWLINKS(a) a
959#else
960 #define USAGE_LS_FOLLOWLINKS(a)
961#endif
962#ifdef BB_FEATURE_LS_RECURSIVE
963 #define USAGE_LS_RECURSIVE(a) a
964#else
965 #define USAGE_LS_RECURSIVE(a)
966#endif
967#ifdef BB_FEATURE_LS_SORTFILES
968 #define USAGE_LS_SORTFILES(a) a
969#else
970 #define USAGE_LS_SORTFILES(a)
971#endif
972#ifdef BB_FEATURE_AUTOWIDTH
973 #define USAGE_AUTOWIDTH(a) a
974#else
975 #define USAGE_AUTOWIDTH(a)
976#endif
977#define ls_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +0000978 "[-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 +0000979#define ls_full_usage \
980 "List directory contents\n\n" \
981 "Options:\n" \
982 "\t-1\tlist files in a single column\n" \
983 "\t-A\tdo not list implied . and ..\n" \
984 "\t-a\tdo not hide entries starting with .\n" \
985 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000986 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000987 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000988 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
989 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000990 "\t-i\tlist the i-node for each file\n" \
991 "\t-l\tuse a long listing format\n" \
992 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000993 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
994 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
995 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
996 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
997 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000998 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000999 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1000 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1001 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1002 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1003 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001004 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001005 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1006 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001007 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersened0d9582001-02-23 13:23:03 +00001008 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +00001009 "\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001010
1011#define lsmod_trivial_usage \
1012 ""
1013#define lsmod_full_usage \
1014 "List the currently loaded kernel modules."
1015
1016#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001017 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001018#define makedevs_full_usage \
1019 "Creates a range of block or character special files\n\n" \
1020 "TYPEs include:\n" \
1021 "\tb:\tMake a block (buffered) device.\n" \
1022 "\tc or u:\tMake a character (un-buffered) device.\n" \
1023 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1024 "FIRST specifies the number appended to NAME to create the first device.\n" \
1025 "LAST specifies the number of the last item that should be created.\n" \
1026 "If 's' is the last argument, the base device is created as well.\n\n" \
1027 "For example:\n" \
1028 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001029 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001030#define makedevs_example_usage \
1031 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
1032 "[creates ttyS2-ttyS63]\n" \
1033 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
1034 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001035
Eric Andersen7e9276b2001-02-22 01:15:47 +00001036#define md5sum_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001037 "[OPTION] [FILE]...\n" \
1038 "or: md5sum [OPTION] -c [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001039#define md5sum_full_usage \
1040 "Print or check MD5 checksums.\n\n" \
1041 "Options:\n" \
1042 "With no FILE, or when FILE is -, read standard input.\n\n" \
1043 "\t-b\tread files in binary mode\n" \
1044 "\t-c\tcheck MD5 sums against given list\n" \
1045 "\t-t\tread files in text mode (default)\n" \
1046 "\t-g\tread a string\n" \
1047 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001048 "\t-s\tdon't output anything, status code shows success\n" \
1049 "\t-w\twarn about improperly formated MD5 checksum lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001050#define md5sum_example_usage \
1051 "$ md5sum < busybox\n" \
1052 "6fd11e98b98a58f64ff3398d7b324003\n" \
1053 "$ md5sum busybox\n" \
1054 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1055 "$ md5sum -c -\n" \
1056 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1057 "busybox: OK\n" \
1058 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001059
Eric Andersen7e9276b2001-02-22 01:15:47 +00001060#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001061 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001062#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001063 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001064 "Options:\n" \
1065 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001066 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001067#define mkdir_example_usage \
1068 "$ mkdir /tmp/foo\n" \
1069 "$ mkdir /tmp/foo\n" \
1070 "/tmp/foo: File exists\n" \
1071 "$ mkdir /tmp/foo/bar/baz\n" \
1072 "/tmp/foo/bar/baz: No such file or directory\n" \
1073 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001074
Eric Andersen7e9276b2001-02-22 01:15:47 +00001075#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001076 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001077#define mkfifo_full_usage \
1078 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1079 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001080 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001081
Eric Andersen7e9276b2001-02-22 01:15:47 +00001082#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001083 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001084#define mkfs_minix_full_usage \
1085 "Make a MINIX filesystem.\n\n" \
1086 "Options:\n" \
1087 "\t-c\t\tCheck the device for bad blocks\n" \
1088 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1089 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1090 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001091 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001092
Eric Andersen7e9276b2001-02-22 01:15:47 +00001093#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001094 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001095#define mknod_full_usage \
1096 "Create a special file (block, character, or pipe).\n\n" \
1097 "Options:\n" \
1098 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1099 "TYPEs include:\n" \
1100 "\tb:\tMake a block (buffered) device.\n" \
1101 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001102 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001103#define mknod_example_usage \
1104 "$ mknod /dev/fd0 b 2 0 \n" \
1105 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001106
Eric Andersen7e9276b2001-02-22 01:15:47 +00001107#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001108 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001109#define mkswap_full_usage \
1110 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001111 "Options:\n" \
1112 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001113 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001114 "\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 +00001115 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001116
Eric Andersen7e9276b2001-02-22 01:15:47 +00001117#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001118 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001119#define mktemp_full_usage \
1120 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001121 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001122#define mktemp_example_usage \
1123 "$ mktemp /tmp/temp.XXXXXX\n" \
1124 "/tmp/temp.mWiLjM\n" \
1125 "$ ls -la /tmp/temp.mWiLjM\n" \
1126 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001127
Eric Andersen8d79ce82001-07-22 23:00:15 +00001128#define modprobe_trivial_usage \
1129 "[FILE ...]"
1130#define modprobe_full_usage \
1131 "Used for hight level module loading and unloading."
1132#define modprobe_example_usage \
1133 "$ modprobe cdrom\n"
1134
Eric Andersen7e9276b2001-02-22 01:15:47 +00001135#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001136 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001137#define more_full_usage \
1138 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001139#define more_example_usage \
1140 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001141
Eric Andersen7e9276b2001-02-22 01:15:47 +00001142#ifdef BB_FEATURE_MOUNT_LOOP
1143 #define USAGE_MOUNT_LOOP(a) a
1144#else
1145 #define USAGE_MOUNT_LOOP(a)
1146#endif
Eric Andersenc4cef5a2001-04-01 16:01:11 +00001147#ifdef BB_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001148 #define USAGE_MTAB(a) a
1149#else
1150 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001151#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001152#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001153 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001154#define mount_full_usage \
1155 "Mount a filesystem\n\n" \
1156 "Flags:\n" \
1157 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001158 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001159 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001160 "\t-n:\t\tDon't write a mount table entry.\n" \
1161 ) \
1162 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1163 "\t-r:\t\tMount the filesystem read-only.\n" \
1164 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1165 "\t-w:\t\tMount for reading and writing (default).\n" \
1166 "\n" \
1167 "Options for use with the \"-o\" flag:\n" \
1168 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1169 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1170 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1171 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001172 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001173 "\tloop:\t\tMounts a file via loop device.\n" \
1174 ) \
1175 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001176 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001177 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001178 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001179 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001180 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001181#define mount_example_usage \
1182 "$ mount\n" \
1183 "/dev/hda3 on / type minix (rw)\n" \
1184 "proc on /proc type proc (rw)\n" \
1185 "devpts on /dev/pts type devpts (rw)\n" \
1186 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1187 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001188
Eric Andersen7e9276b2001-02-22 01:15:47 +00001189#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001190 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001191#define mt_full_usage \
1192 "Control magnetic tape drive operation\n" \
1193 "\nAvailable Opcodes:\n\n" \
1194 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1195 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
1196 "ras3 reset retension rew rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001197 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001198
Eric Andersen7e9276b2001-02-22 01:15:47 +00001199#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001200 "SOURCE DEST\n" \
1201 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001202#define mv_full_usage \
1203 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001204#define mv_example_usage \
1205 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001206
Eric Andersen7e9276b2001-02-22 01:15:47 +00001207#define nc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001208 "[IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001209#define nc_full_usage \
1210 "Netcat opens a pipe to IP:port"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001211#define nc_example_usage \
1212 "$ nc foobar.somedomain.com 25\n" \
1213 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1214 "help\n" \
1215 "214-Commands supported:\n" \
1216 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1217 "214 NOOP QUIT RSET HELP\n" \
1218 "quit\n" \
1219 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001220
Eric Andersen7e9276b2001-02-22 01:15:47 +00001221#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001222 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001223#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001224 "Queries the nameserver for the IP address of the given HOST\n" \
1225 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001226#define nslookup_example_usage \
1227 "$ nslookup localhost\n" \
1228 "Server: default\n" \
1229 "Address: default\n" \
1230 "\n" \
1231 "Name: debian\n" \
1232 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001233
Eric Andersen221b2ea2001-07-31 19:06:07 +00001234#define pidof_trivial_usage \
1235 "process-name [process-name ...]"
1236#define pidof_full_usage \
1237 "Lists the PIDs of all processes with names that match the names on the command line"
1238#define pidof_example_usage \
1239 "$ pidof init\n" \
1240 "1\n"
1241
Eric Andersen004015e2001-05-21 20:30:51 +00001242#ifndef BB_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001243#define ping_trivial_usage "host"
1244#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1245#else
1246#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001247 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001248#define ping_full_usage \
1249 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1250 "Options:\n" \
1251 "\t-c COUNT\tSend only COUNT pings.\n" \
1252 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1253 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001254 "\t\t\tand when finished."
1255#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001256#define ping_example_usage \
1257 "$ ping localhost\n" \
1258 "PING slag (127.0.0.1): 56 data bytes\n" \
1259 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1260 "\n" \
1261 "--- debian ping statistics ---\n" \
1262 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1263 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001264
Eric Andersen7e9276b2001-02-22 01:15:47 +00001265#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001266 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001267#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001268 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001269 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001270
Eric Andersen7e9276b2001-02-22 01:15:47 +00001271#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001272 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001273#define poweroff_full_usage \
1274 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001275
Eric Andersen7e9276b2001-02-22 01:15:47 +00001276#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001277 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001278#define printf_full_usage \
1279 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001280 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001281#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001282 "$ printf "Val=%d\\n" 5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001283 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001284
Eric Andersen7e9276b2001-02-22 01:15:47 +00001285#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001286 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001287#define ps_full_usage \
1288 "Report process status\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001289 "\nThis version of ps accepts no options."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001290#define ps_example_usage \
1291 "$ ps\n" \
1292 " PID Uid Gid State Command\n" \
1293 " 1 root root S init\n" \
1294 " 2 root root S [kflushd]\n" \
1295 " 3 root root S [kupdate]\n" \
1296 " 4 root root S [kpiod]\n" \
1297 " 5 root root S [kswapd]\n" \
1298 " 742 andersen andersen S [bash]\n" \
1299 " 743 andersen andersen S -bash\n" \
1300 " 745 root root S [getty]\n" \
1301 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001302
Eric Andersen7e9276b2001-02-22 01:15:47 +00001303#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001304 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001305#define pwd_full_usage \
1306 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001307#define pwd_example_usage \
1308 "$ pwd\n" \
1309 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001310
Eric Andersen7e9276b2001-02-22 01:15:47 +00001311#define rdate_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001312 "[OPTION] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001313#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001314 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001315 "Options:\n" \
1316 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001317 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001318
Eric Andersen7e9276b2001-02-22 01:15:47 +00001319#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001320 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001321#define readlink_full_usage \
1322 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001323
Eric Andersen7e9276b2001-02-22 01:15:47 +00001324#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001325 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001326#define reboot_full_usage \
1327 "Reboot the system."
1328
1329#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001330 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001331#define renice_full_usage \
1332 "Changes priority of running processes. Allowed priorities range\n" \
1333 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001334 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001335
Eric Andersen7e9276b2001-02-22 01:15:47 +00001336#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001337 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001338#define reset_full_usage \
1339 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001340
Eric Andersen7e9276b2001-02-22 01:15:47 +00001341#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001342 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001343#define rm_full_usage \
1344 "Remove (unlink) the FILE(s). You may use '--' to\n" \
1345 "indicate that all following arguments are non-options.\n\n" \
1346 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00001347 "\t-i\t\talways prompt before removing each destination" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001348 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001349 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001350#define rm_example_usage \
1351 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001352
Eric Andersen7e9276b2001-02-22 01:15:47 +00001353#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001354 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001355#define rmdir_full_usage \
1356 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001357#define rmdir_example_usage \
1358 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001359
Eric Andersen7e9276b2001-02-22 01:15:47 +00001360#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001361 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001362#define rmmod_full_usage \
1363 "Unloads the specified kernel modules from the kernel.\n\n" \
1364 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001365 "\t-a\tTry to remove all unused kernel modules."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001366#define rmmod_example_usage \
1367 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001368
Eric Andersen7e9276b2001-02-22 01:15:47 +00001369#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001370 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001371#define route_full_usage \
1372 "Edit the kernel's routing tables"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001373
Glenn L McGrathf8736d22001-06-26 01:19:34 +00001374#define rpm2cpio_trivial_usage \
1375 "package.rpm"
1376#define rpm2cpio_full_usage \
1377 "Outputs a cpio archive of the rpm file."
1378
Eric Andersen7e9276b2001-02-22 01:15:47 +00001379#define rpmunpack_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001380 "< package.rpm | gunzip | cpio -idmuv"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001381#define rpmunpack_full_usage \
1382 "Extracts an rpm archive."
Glenn L McGrathf8736d22001-06-26 01:19:34 +00001383
Eric Andersen7e9276b2001-02-22 01:15:47 +00001384#define sed_trivial_usage \
Matt Kraai075228a2001-06-21 14:40:55 +00001385 "[-nef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001386#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001387 "Options:\n" \
1388 "\t-n\t\tsuppress automatic printing of pattern space\n" \
1389 "\t-e script\tadd the script to the commands to be executed\n" \
1390 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001391 "\n" \
1392 "If no -e or -f is given, the first non-option argument is taken as the\n" \
1393 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001394 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001395#define sed_example_usage \
1396 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
1397 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001398
Eric Andersen7e9276b2001-02-22 01:15:47 +00001399#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001400 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001401#define setkeycodes_full_usage \
1402 "Set entries into the kernel's scancode-to-keycode map,\n" \
1403 "allowing unusual keyboards to generate usable keycodes.\n\n" \
1404 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001405 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001406#define setkeycodes_example_usage \
1407 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001408
Matt Kraai2d91deb2001-08-01 17:21:35 +00001409#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001410 "[FILE]...\n" \
1411 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00001412#define lash_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001413 "lash: The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00001414#define lash_notes_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001415"This command does not yet have proper documentation.\n" \
1416"\n" \
1417"Use lash just as you would use any other shell. It properly handles pipes,\n" \
1418"redirects, job control, can be used as the shell for scripts, and has a\n" \
1419"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
1420"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
1421"use ash or bash. If you just need a very simple and extremely small shell,\n" \
1422"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001423
Eric Andersen7e9276b2001-02-22 01:15:47 +00001424#define sleep_trivial_usage \
1425 "N"
1426#define sleep_full_usage \
1427 "Pause for N seconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001428#define sleep_example_usage \
1429 "$ sleep 2\n" \
1430 "[2 second delay results]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001431
Eric Andersen7e9276b2001-02-22 01:15:47 +00001432
Mark Whitleyfccaa362001-04-17 18:56:18 +00001433#ifdef BB_FEATURE_SORT_UNIQUE
1434 #define USAGE_SORT_UNIQUE(a) a
1435#else
1436 #define USAGE_SORT_UNIQUE(a)
1437#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001438#ifdef BB_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001439 #define USAGE_SORT_REVERSE(a) a
1440#else
1441 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001442#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001443#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001444 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001445#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001446 "Sorts lines of text in the specified files\n\n"\
1447 "Options:\n" \
1448 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
1449 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
1450 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001451#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001452 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001453 "a\n" \
1454 "b\n" \
1455 "c\n" \
1456 "d\n" \
1457 "e\n" \
1458 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001459
Eric Andersen7e9276b2001-02-22 01:15:47 +00001460#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001461 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001462#define stty_full_usage \
1463 "Without arguments, prints baud rate, line discipline," \
1464 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001465 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00001466 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001467 "\n\t-a\t\tprint all current settings in human-readable form" \
1468 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00001469 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001470
Eric Andersen7e9276b2001-02-22 01:15:47 +00001471#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001472 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001473#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001474 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001475 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001476 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001477
Eric Andersen7e9276b2001-02-22 01:15:47 +00001478#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001479 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001480#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001481 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001482 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001483 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001484
Eric Andersen7e9276b2001-02-22 01:15:47 +00001485#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001486 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001487#define sync_full_usage \
1488 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001489
Eric Andersen7e9276b2001-02-22 01:15:47 +00001490
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001491#ifdef BB_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00001492 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001493#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00001494 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001495#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001496#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001497 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001498#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00001499 "Linux system and kernel logging utility.\n" \
1500 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001501 "Options:\n" \
1502 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
1503 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001504 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001505 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00001506 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
1507 "\t-L\t\tLog locally and via network logging (default is network only)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001508#define syslogd_example_usage \
1509 "$ syslogd -R masterlog:514\n" \
1510 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001511
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001512
Eric Andersen004015e2001-05-21 20:30:51 +00001513#ifndef BB_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00001514 #define USAGE_UNSIMPLE_TAIL(a)
1515#else
1516 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001517#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001518#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001519 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001520#define tail_full_usage \
1521 "Print last 10 lines of each FILE to standard output.\n" \
1522 "With more than one FILE, precede each with a header giving the\n" \
1523 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
1524 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001525 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001526 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
1527 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001528 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001529 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
1530 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001531 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001532 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001533 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
1534#define tail_example_usage \
1535 "$ tail -n 1 /etc/resolv.conf\n" \
1536 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001537
Eric Andersen7e9276b2001-02-22 01:15:47 +00001538#ifdef BB_FEATURE_TAR_CREATE
1539 #define USAGE_TAR_CREATE(a) a
1540#else
1541 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001542#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001543#ifdef BB_FEATURE_TAR_EXCLUDE
1544 #define USAGE_TAR_EXCLUDE(a) a
1545#else
1546 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001547#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001548#define tar_trivial_usage \
1549 "-[" USAGE_TAR_CREATE("c") "xtvO] " \
Eric Andersen317827d2001-05-21 17:50:53 +00001550 USAGE_TAR_EXCLUDE("[--exclude FILE] [-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00001551 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001552#define tar_full_usage \
1553 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00001554 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001555 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001556 "\tx\t\textract\n" \
1557 "\tt\t\tlist\n" \
1558 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001559 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001560 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001561 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001562 "\texclude\t\tfile to exclude\n" \
1563 "\tX\t\tfile with names to exclude\n" \
1564 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00001565 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001566 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001567#define tar_example_usage \
1568 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
1569 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001570
Eric Andersen7e9276b2001-02-22 01:15:47 +00001571#define tee_trivial_usage \
1572 "[OPTION]... [FILE]..."
1573#define tee_full_usage \
1574 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001575 "Options:\n" \
1576 "\t-a\tappend to the given FILEs, do not overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001577#define tee_example_usage \
1578 "$ echo "Hello" | tee /tmp/foo\n" \
1579 "$ cat /tmp/foo\n" \
1580 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001581
Eric Andersen7e9276b2001-02-22 01:15:47 +00001582#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001583 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001584#define telnet_full_usage \
1585 "Telnet is used to establish interactive communication with another\n"\
1586 "computer over a network using the TELNET protocol."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001587
Eric Andersen7e9276b2001-02-22 01:15:47 +00001588#define test_trivial_usage \
1589 "EXPRESSION\n or [ EXPRESSION ]"
1590#define test_full_usage \
1591 "Checks file types and compares values returning an exit\n" \
1592 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001593#define test_example_usage \
1594 "$ test 1 -eq 2\n" \
1595 "$ echo $?\n" \
1596 "1\n" \
1597 "$ test 1 -eq 1\n" \
1598 "$ echo $? \n" \
1599 "0\n" \
1600 "$ [ -d /etc ]\n" \
1601 "$ echo $?\n" \
1602 "0\n" \
1603 "$ [ -d /junk ]\n" \
1604 "$ echo $?\n" \
1605 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001606
Mark Whitley450736c2001-03-02 19:08:50 +00001607#ifdef BB_FEATURE_TFTP_GET
1608 #define USAGE_TFTP_GET(a) a
1609#else
1610 #define USAGE_TFTP_GET(a)
1611#endif
1612#ifdef BB_FEATURE_TFTP_PUT
1613 #define USAGE_TFTP_PUT(a) a
1614#else
1615 #define USAGE_TFTP_PUT(a)
1616#endif
1617
1618#define tftp_trivial_usage \
1619 "command SOURCE DEST"
1620#define tftp_full_usage \
1621 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
1622 "Commands:\n" \
1623 USAGE_TFTP_GET( \
1624 "\tget\tGet file from server SOURCE and store to local DEST.\n" \
1625 ) \
1626 USAGE_TFTP_PUT( \
1627 "\tput\tPut local file SOURCE to server DEST.\n" \
1628 ) \
John Beppu5d817682001-04-17 17:09:34 +00001629 "\nWhen naming a server, use the syntax \"server:file\"."
Mark Whitley450736c2001-03-02 19:08:50 +00001630
Eric Andersen7e9276b2001-02-22 01:15:47 +00001631#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001632 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001633#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001634 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001635 "Options:\n" \
1636 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001637#define touch_example_usage \
1638 "$ ls -l /tmp/foo\n" \
1639 "/bin/ls: /tmp/foo: No such file or directory\n" \
1640 "$ touch /tmp/foo\n" \
1641 "$ ls -l /tmp/foo\n" \
1642 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001643
1644#define tr_trivial_usage \
1645 "[-cds] STRING1 [STRING2]"
1646#define tr_full_usage \
1647 "Translate, squeeze, and/or delete characters from\n" \
1648 "standard input, writing to standard output.\n\n" \
1649 "Options:\n" \
1650 "\t-c\ttake complement of STRING1\n" \
1651 "\t-d\tdelete input characters coded STRING1\n" \
1652 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001653#define tr_example_usage \
1654 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
1655 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001656
Eric Andersen5c58d282001-07-10 16:29:00 +00001657#define traceroute_trivial_usage \
1658 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n\
1659 [-s src_addr] [-t tos] [-w wait] host [data size]"
1660#define traceroute_full_usage \
1661 "trace the route ip packets follow going to \"host\"\n" \
1662 "Options:\n" \
1663 "\t-d\tset SO_DEBUG options to socket\n" \
1664 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
1665 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
1666 "\t-v\tVerbose output\n" \
1667 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
1668 "\t-p port#\tSet the base UDP port number used in probes\n" \
1669 "\t\t(default is 33434)\n" \
1670 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
1671 "\t\t(default is 3)\n" \
1672 "\t-s src_addr\tUse the following IP address as the source address\n" \
1673 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
1674 "\t\t(default 0)\n" \
1675 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
1676 "\t\t(default 3 sec.)."
1677
1678
Eric Andersen7e9276b2001-02-22 01:15:47 +00001679#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001680 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001681#define true_full_usage \
1682 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001683#define true_example_usage \
1684 "$ true\n" \
1685 "$ echo $?\n" \
1686 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001687
Eric Andersen7e9276b2001-02-22 01:15:47 +00001688#define tty_trivial_usage \
1689 ""
1690#define tty_full_usage \
1691 "Print the file name of the terminal connected to standard input.\n\n"\
1692 "Options:\n" \
1693 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001694#define tty_example_usage \
1695 "$ tty\n" \
1696 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001697
Eric Andersen7e9276b2001-02-22 01:15:47 +00001698#ifdef BB_FEATURE_MOUNT_FORCE
1699 #define USAGE_MOUNT_FORCE(a) a
1700#else
1701 #define USAGE_MOUNT_FORCE(a)
1702#endif
1703#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001704 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001705#define umount_full_usage \
1706 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00001707 "\nFlags:\n" "\t-a\tUnmount all file systems" \
1708 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
1709 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00001710 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00001711 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 +00001712#define umount_example_usage \
1713 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001714
1715#define uname_trivial_usage \
1716 "[OPTION]..."
1717#define uname_full_usage \
1718 "Print certain system information. With no OPTION, same as -s.\n\n" \
1719 "Options:\n" \
1720 "\t-a\tprint all information\n" \
1721 "\t-m\tthe machine (hardware) type\n" \
1722 "\t-n\tprint the machine's network node hostname\n" \
1723 "\t-r\tprint the operating system release\n" \
1724 "\t-s\tprint the operating system name\n" \
1725 "\t-p\tprint the host processor type\n" \
1726 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001727#define uname_example_usage \
1728 "$ uname -a\n" \
1729 "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001730
1731#define uniq_trivial_usage \
1732 "[OPTION]... [INPUT [OUTPUT]]"
1733#define uniq_full_usage \
1734 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001735 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001736 "Options:\n" \
1737 "\t-c\tprefix lines by the number of occurrences\n" \
1738 "\t-d\tonly print duplicate lines\n" \
1739 "\t-u\tonly print unique lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001740#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001741 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001742 "a\n" \
1743 "b\n" \
1744 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001745
1746#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001747 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001748#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001749 "Converts FILE from unix format to dos format. When no option\n" \
1750 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00001751 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001752 "Options:\n" \
1753 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00001754 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001755
1756#define update_trivial_usage \
1757 "[options]"
1758#define update_full_usage \
1759 "Periodically flushes filesystem buffers.\n\n" \
1760 "Options:\n" \
1761 "\t-S\tforce use of sync(2) instead of flushing\n" \
1762 "\t-s SECS\tcall sync this often (default 30)\n" \
1763 "\t-f SECS\tflush some buffers this often (default 5)"
1764
1765#define uptime_trivial_usage \
1766 ""
1767#define uptime_full_usage \
1768 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001769#define uptime_example_usage \
1770 "$ uptime\n" \
1771 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001772
1773#define usleep_trivial_usage \
1774 "N"
1775#define usleep_full_usage \
1776 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001777#define usleep_example_usage \
1778 "$ usleep 1000000\n" \
1779 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001780
1781#define uudecode_trivial_usage \
1782 "[FILE]..."
1783#define uudecode_full_usage \
1784 "Uudecode a file that is uuencoded.\n\n" \
1785 "Options:\n" \
Eric Andersen704b2c22001-03-16 08:06:30 +00001786 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001787#define uudecode_example_usage \
1788 "$ uudecode -o busybox busybox.uu\n" \
1789 "$ ls -l busybox\n" \
1790 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001791
1792#define uuencode_trivial_usage \
1793 "[OPTION] [INFILE] REMOTEFILE"
1794#define uuencode_full_usage \
1795 "Uuencode a file.\n\n" \
1796 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00001797 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001798#define uuencode_example_usage \
1799 "$ uuencode busybox busybox\n" \
1800 "begin 755 busybox\n" \
1801 "<encoded file snipped>\n" \
1802 "$ uudecode busybox busybox > busybox.uu\n" \
1803 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001804
Eric Andersen3f980402001-04-04 17:31:15 +00001805#define vi_trivial_usage \
1806 "[OPTION] [FILE]..."
1807#define vi_full_usage \
1808 "edit FILE.\n\n" \
1809 "Options:\n" \
1810 "\t-R\tRead-only- do not write to the file."
1811
Eric Andersen7e9276b2001-02-22 01:15:47 +00001812#define watchdog_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001813 "DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001814#define watchdog_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001815 "Periodically write to watchdog device DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001816
1817#define wc_trivial_usage \
1818 "[OPTION]... [FILE]..."
1819#define wc_full_usage \
1820 "Print line, word, and byte counts for each FILE, and a total line if\n" \
1821 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
1822 "Options:\n" \
1823 "\t-c\tprint the byte counts\n" \
1824 "\t-l\tprint the newline counts\n" \
1825 "\t-L\tprint the length of the longest line\n" \
1826 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001827#define wc_example_usage \
1828 "$ wc /etc/passwd\n" \
1829 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001830
1831#define wget_trivial_usage \
Eric Andersen8071c022001-06-21 19:45:06 +00001832 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n\t[--header 'header: value'] [-P DIR] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001833#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00001834 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001835 "Options:\n" \
1836 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00001837 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00001838 "\t-P\tSet directory prefix to DIR\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001839 "\t-O\tsave to filename ('-' for stdout)"
1840
1841#define which_trivial_usage \
1842 "[COMMAND ...]"
1843#define which_full_usage \
1844 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001845#define which_example_usage \
1846 "$ which login\n" \
1847 "/bin/login\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001848
1849#define whoami_trivial_usage \
1850 ""
1851#define whoami_full_usage \
1852 "Prints the user name associated with the current effective user id."
1853
1854#define xargs_trivial_usage \
1855 "[COMMAND] [ARGS...]"
1856#define xargs_full_usage \
1857 "Executes COMMAND on every item given by standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001858#define xargs_example_usage \
1859 "$ ls | xargs gzip\n" \
1860 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001861
1862#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001863 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001864#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001865 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001866
Eric Andersen7e9276b2001-02-22 01:15:47 +00001867#define zcat_trivial_usage \
1868 "FILE"
1869#define zcat_full_usage \
1870 "Uncompress to stdout."