blob: 1ee2ab3284f950fa598bca2a3ce56912b1b4c777 [file] [log] [blame]
Mark Whitley6f932772001-03-20 19:18:10 +00001#define adjtimex_trivial_usage \
2 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
3#define adjtimex_full_usage \
4 "Reads and optionally sets system timebase parameters.\n" \
5 "See adjtimex(2).\n\n" \
6 "Options:\n" \
7 "\t-q\t\tquiet mode - do not print\n" \
8 "\t-o offset\ttime offset, microseconds\n" \
9 "\t-f frequency\tfrequency adjust, integer kernel units (65536 is 1ppm)\n" \
10 "\t\t\t(positive values make the system clock run fast)\n" \
11 "\t-t tick\t\tmicroseconds per tick, usually 10000\n" \
12 "\t-p timeconstant\n"
13
Eric Andersen7e9276b2001-02-22 01:15:47 +000014#define ar_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000015 "-[ovR]{ptx} archive filenames"
Eric Andersen7e9276b2001-02-22 01:15:47 +000016#define ar_full_usage \
17 "Extract or list files from an ar archive.\n\n" \
18 "Options:\n" \
19 "\t-o\t\tpreserve original dates\n" \
20 "\t-p\t\textract to stdout\n" \
21 "\t-t\t\tlist\n" \
22 "\t-x\t\textract\n" \
23 "\t-v\t\tverbosely list files processed\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000024 "\t-R\t\trecursive action"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000025
Eric Andersen7e9276b2001-02-22 01:15:47 +000026#define basename_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000027 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000028#define basename_full_usage \
29 "Strips directory path and suffixes from FILE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000030 "If specified, also removes any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000031#define basename_example_usage \
32 "$ basename /usr/local/bin/foo\n" \
33 "foo\n" \
34 "$ basename /usr/local/bin/\n" \
35 "bin\n" \
36 "$ basename /foo/bar.txt .txt\n" \
37 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000038
Eric Andersen7e9276b2001-02-22 01:15:47 +000039#define cat_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000040 "[FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000041#define cat_full_usage \
42 "Concatenates FILE(s) and prints them to stdout."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000043#define cat_example_usage \
44 "$ cat /proc/uptime\n" \
45 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000046
Eric Andersen7e9276b2001-02-22 01:15:47 +000047#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000048 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000049#define chgrp_full_usage \
50 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000051 "\nOptions:\n" \
52 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000053#define chgrp_example_usage \
54 "$ ls -l /tmp/foo\n" \
55 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
56 "$ chgrp root /tmp/foo\n" \
57 "$ ls -l /tmp/foo\n" \
58 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000059
Eric Andersen7e9276b2001-02-22 01:15:47 +000060#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000061 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000062#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000063 "Each MODE is one or more of the letters ugoa, one of the\n" \
64 "symbols +-= and one or more of the letters rwxst.\n\n" \
65 "Options:\n" \
66 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000067#define chmod_example_usage \
68 "$ ls -l /tmp/foo\n" \
69 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
70 "$ chmod u+x /tmp/foo\n" \
71 "$ ls -l /tmp/foo\n" \
72 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
73 "$ chmod 444 /tmp/foo\n" \
74 "$ ls -l /tmp/foo\n" \
75 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000076
Eric Andersen7e9276b2001-02-22 01:15:47 +000077#define chown_trivial_usage \
Eric Andersen4ef37d02001-03-20 01:06:14 +000078 "[OPTION]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000079#define chown_full_usage \
80 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000081 "\nOptions:\n" \
82 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000083#define chown_example_usage \
84 "$ ls -l /tmp/foo\n" \
85 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
86 "$ chown root /tmp/foo\n" \
87 "$ ls -l /tmp/foo\n" \
88 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
89 "$ chown root.root /tmp/foo\n" \
90 "ls -l /tmp/foo\n" \
91 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000092
Eric Andersen7e9276b2001-02-22 01:15:47 +000093#define chroot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000094 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000095#define chroot_full_usage \
96 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000097#define chroot_example_usage \
98 "$ ls -l /bin/ls\n" \
99 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
100 "$ mount /dev/hdc1 /mnt -t minix\n" \
101 "$ chroot /mnt\n" \
102 "$ ls -l /bin/ls\n" \
103 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000104
Eric Andersen7e9276b2001-02-22 01:15:47 +0000105#define chvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000106 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000107#define chvt_full_usage \
108 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000109
Eric Andersen7e9276b2001-02-22 01:15:47 +0000110#define clear_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000111 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000112#define clear_full_usage \
113 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000114
Eric Andersen7e9276b2001-02-22 01:15:47 +0000115#define cmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000116 "FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000117#define cmp_full_usage \
118 "Compare files."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000119
Eric Andersen7e9276b2001-02-22 01:15:47 +0000120#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000121 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000122#define cp_full_usage \
123 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
124 "\n" \
125 "\t-a\tSame as -dpR\n" \
126 "\t-d\tPreserves links\n" \
127 "\t-p\tPreserves file attributes if possible\n" \
128 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000129 "\t-R\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000130
Eric Andersen7e9276b2001-02-22 01:15:47 +0000131#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000132 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000133#define cut_full_usage \
134 "Prints selected fields from each input FILE to standard output.\n\n" \
135 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000136 "\t-b LIST\t\tOutput only bytes from LIST\n" \
137 "\t-c LIST\t\tOutput only characters from LIST\n" \
138 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
139 "\t-s\t\tOutput only the lines containing delimiter\n" \
140 "\t-f N\t\tPrint only these fields\n" \
141 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000142#define cut_example_usage \
143 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
144 "Hello\n" \
145 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
146 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000147
Eric Andersen7e9276b2001-02-22 01:15:47 +0000148#define date_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000149 "[OPTION]... [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000150#define date_full_usage \
151 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000152 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000153 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000154 "\t-d STRING\tdisplay time described by STRING, not `now'\n" \
155 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000156 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000157#define date_example_usage \
158 "$ date\n" \
159 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000160
Eric Andersen7e9276b2001-02-22 01:15:47 +0000161#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000162 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000163#define dc_full_usage \
164 "This is a Tiny RPN calculator that understands the\n" \
165 "following operations: +, -, /, *, and, or, not, eor.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000166 "i.e. 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000167#define dc_example_usage \
168 "$ dc 2 2 +\n" \
169 "4\n" \
170 "$ dc 8 8 \* 2 2 + /\n" \
171 "16\n" \
172 "$ dc 0 1 and\n" \
173 "0\n" \
174 "$ dc 0 1 or\n" \
175 "1\n" \
176 "$ echo 72 9 div 8 mul | dc\n" \
177 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000178
Eric Andersen7e9276b2001-02-22 01:15:47 +0000179#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000180 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000181 "\t [seek=N] [conv=notrunc|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000182#define dd_full_usage \
183 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000184 "\tif=FILE\t\tread from FILE instead of stdin\n" \
185 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
186 "\tbs=N\t\tread and write N bytes at a time\n" \
187 "\tcount=N\t\tcopy only N input blocks\n" \
188 "\tskip=N\t\tskip N input blocks\n" \
189 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000190 "\tconv=notrunc\tdon't truncate output file\n" \
191 "\tconv=sync\tpad blocks with zeros\n" \
192 "\n" \
193 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000194 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000195#define dd_example_usage \
196 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
197 "4+0 records in\n" \
198 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000199
Eric Andersen7e9276b2001-02-22 01:15:47 +0000200#define deallocvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000201 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000202#define deallocvt_full_usage \
203 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000204
Eric Andersen7e9276b2001-02-22 01:15:47 +0000205
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000206#ifdef BB_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000207 #define USAGE_HUMAN_READABLE(a) a
208 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000209#else
Eric Andersened0d9582001-02-23 13:23:03 +0000210 #define USAGE_HUMAN_READABLE(a)
211 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000212#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000213#define df_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +0000214 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [filesystem ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000215#define df_full_usage \
216 "Print the filesystem space used and space available.\n\n" \
217 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000218 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000219 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
220 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000221 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000222 "\n\t-k\tprint sizes in kilobytes(compatability)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000223#define df_example_usage \
224 "$ df\n" \
225 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
226 "/dev/sda3 8690864 8553540 137324 98% /\n" \
227 "/dev/sda1 64216 36364 27852 57% /boot\n" \
228 "$ df /dev/sda3\n" \
229 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
230 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000231
Eric Andersen7e9276b2001-02-22 01:15:47 +0000232#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000233 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000234#define dirname_full_usage \
235 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000236#define dirname_example_usage \
237 "$ dirname /tmp/foo\n" \
238 "/tmp\n" \
239 "$ dirname /tmp/foo/\n" \
240 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000241
Eric Andersen7e9276b2001-02-22 01:15:47 +0000242#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000243 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000244#define dmesg_full_usage \
245 "Prints or controls the kernel ring buffer\n\n" \
246 "Options:\n" \
247 "\t-c\t\tClears the ring buffer's contents after printing\n" \
248 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000249 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000250
Eric Andersen7e9276b2001-02-22 01:15:47 +0000251#define dos2unix_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000252 "[option] [file]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000253#define dos2unix_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000254 "Converts a text file to/from dos format to unix format.\n\n" \
255 "Options:\n" \
256 "\t-u\toutput will be in UNIX format\n" \
257 "\t-d\toutput will be in DOS format\n\n" \
258 "- when no option is given then input format will be automaticaly detected\n" \
259 " and converted to the oposite format on output\n" \
260 "- when no file is given, then stdin is used as input and stdout as output"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000261
Eric Andersen7e9276b2001-02-22 01:15:47 +0000262#define dpkg_trivial_usage \
263 "[-i|-r|--unpack|--configure] my.deb"
264#define dpkg_full_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000265 "WORK IN PROGRESS, only usefull for debian-installer"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000266
Eric Andersen7e9276b2001-02-22 01:15:47 +0000267#define dpkg_deb_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000268 "[-cexX] file directory"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000269#define dpkg_deb_full_usage \
270 "Perform actions on debian packages (.debs)\n\n" \
271 "Options:\n" \
272 "\t-c\tList contents of filesystem tree (verbose)\n" \
273 "\t-l\tList contents of filesystem tree (.list format)\n" \
274 "\t-e\tExtract control files to directory\n" \
275 "\t-x\tExctract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000276 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000277#define dpkg_deb_example_usage \
278 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000279
Eric Andersen7e9276b2001-02-22 01:15:47 +0000280#define du_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +0000281 "[-ls" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000282#define du_full_usage \
283 "Summarizes disk space used for each FILE and/or directory.\n" \
284 "Disk space is printed in units of 1024 bytes.\n\n" \
285 "Options:\n" \
286 "\t-l\tcount sizes many times if hard linked\n" \
287 "\t-s\tdisplay only a total for each argument" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000288 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000289 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
290 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000291 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000292 "\n\t-k\tprint sizes in kilobytes(compatability)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000293#define du_example_usage \
294 "$ du\n" \
295 "16 ./CVS\n" \
296 "12 ./kernel-patches/CVS\n" \
297 "80 ./kernel-patches\n" \
298 "12 ./tests/CVS\n" \
299 "36 ./tests\n" \
300 "12 ./scripts/CVS\n" \
301 "16 ./scripts\n" \
302 "12 ./docs/CVS\n" \
303 "104 ./docs\n" \
304 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000305
Eric Andersen7e9276b2001-02-22 01:15:47 +0000306#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000307 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000308#define dumpkmap_full_usage \
309 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000310#define dumpkmap_example_usage \
311 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000312
Eric Andersen7e9276b2001-02-22 01:15:47 +0000313#define dutmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000314 "[FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000315#define dutmp_full_usage \
316 "Dump utmp file format (pipe delimited) from FILE\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000317 "or stdin to stdout. (i.e. 'dutmp /var/run/utmp')"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000318#define dutmp_example_usage \
319 "$ dutmp /var/run/utmp\n" \
320 "8|7||si|||0|0|0|955637625|760097|0\n" \
321 "2|0|~|~~|reboot||0|0|0|955637625|782235|0\n" \
322 "1|20020|~|~~|runlevel||0|0|0|955637625|800089|0\n" \
323 "8|125||l4|||0|0|0|955637629|998367|0\n" \
324 "6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0\n" \
325 "6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0\n" \
326 "7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000327
Eric Andersen7e9276b2001-02-22 01:15:47 +0000328#define echo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000329 "[-neE] [ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000330#define echo_full_usage \
331 "Prints the specified ARGs to stdout\n\n" \
332 "Options:\n" \
333 "\t-n\tsuppress trailing newline\n" \
334 "\t-e\tinterpret backslash-escaped characters (i.e. \\t=tab etc)\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000335 "\t-E\tdisable interpretation of backslash-escaped characters"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000336#define echo_example_usage \
337 "$ echo "Erik is cool"\n" \
338 "Erik is cool\n" \
339 "$ echo -e "Erik\nis\ncool"\n" \
340 "Erik\n" \
341 "is\n" \
342 "cool\n" \
343 "$ echo "Erik\nis\ncool"\n" \
344 "Erik\nis\ncool\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000345
Eric Andersen84e229c2001-03-29 22:48:33 +0000346#define env_trivial_usage \
347 "[-] [-iu] [name=value ...] [command]"
348#define env_full_usage \
349 "Prints the current environment or runs a program after setting\n" \
350 "up the specified environment.\n\n" \
351 "Options:\n" \
352 "\t-, -i\tstart with an empty environment\n" \
353 "\t-u\tremove variable from the environment\n"
354
Eric Andersen7e9276b2001-02-22 01:15:47 +0000355#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000356 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000357#define expr_full_usage \
358 "Prints the value of EXPRESSION to standard output.\n\n" \
359 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000360 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
361 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
362 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
363 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
364 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
365 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
366 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
367 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
368 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
369 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
370 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
371 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
372 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000373 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
374 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
375 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
376 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
377 "\t or 0\n" \
378 "\tlength STRING length of STRING\n" \
379 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
380 "\t it is a keyword like `match' or an\n" \
381 "\t operator like `/'\n" \
382 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000383 "Beware that many operators need to be escaped or quoted for shells.\n" \
384 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
385 "lexicographical. Pattern matches return the string matched between \n" \
386 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
387 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000388
Eric Andersen7e9276b2001-02-22 01:15:47 +0000389#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000390 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000391#define false_full_usage \
392 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000393#define false_example_usage \
394 "$ false\n" \
395 "$ echo $?\n" \
396 "1\n"
397
398#define fbset_trivial_usage \
399 "[options] [mode]"
400#define fbset_full_usage \
401 "Show and modify frame buffer settings"
402#define fbset_example_usage \
403 "$ fbset\n" \
404 "mode "1024x768-76"\n" \
405 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
406 "\tgeometry 1024 768 1024 768 16\n" \
407 "\ttimings 12714 128 32 16 4 128 4\n" \
408 "\taccel false\n" \
409 "\trgba 5/11,6/5,5/0,0/0\n" \
410 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000411
Eric Andersen7e9276b2001-02-22 01:15:47 +0000412#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000413 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000414#define fdflush_full_usage \
415 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000416
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000417#ifdef BB_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000418 #define USAGE_FIND_TYPE(a) a
419#else
420 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000421#endif
422#ifdef BB_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000423 #define USAGE_FIND_PERM(a) a
424#else
425 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000426#endif
427#ifdef BB_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000428 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000429#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000430 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000431#endif
432
Eric Andersen7e9276b2001-02-22 01:15:47 +0000433#define find_trivial_usage \
434 "[PATH...] [EXPRESSION]"
435#define find_full_usage \
436 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000437 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000438 "\nEXPRESSION may consist of:\n" \
439 "\t-follow\t\tDereference symbolic links.\n" \
440 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN." \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000441 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000442 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000443 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
444) USAGE_FIND_PERM( \
445 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
446) USAGE_FIND_MTIME( \
447 "\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 +0000448#define find_example_usage \
449 "$ find / -name /etc/passwd\n" \
450 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000451
Eric Andersen7e9276b2001-02-22 01:15:47 +0000452#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000453 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000454#define free_full_usage \
455 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000456#define free_example_usage \
457 "$ free\n" \
458 " total used free shared buffers\n" \
459 " Mem: 257628 248724 8904 59644 93124\n" \
460 " Swap: 128516 8404 120112\n" \
461 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000462
Eric Andersen7e9276b2001-02-22 01:15:47 +0000463#define freeramdisk_trivial_usage \
464 "DEVICE"
465#define freeramdisk_full_usage \
466 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000467#define freeramdisk_example_usage \
468 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000469
470#define fsck_minix_trivial_usage \
471 "[-larvsmf] /dev/name"
472#define fsck_minix_full_usage \
473 "Performs a consistency check for MINIX filesystems.\n\n" \
474 "Options:\n" \
475 "\t-l\tLists all filenames\n" \
476 "\t-r\tPerform interactive repairs\n" \
477 "\t-a\tPerform automatic repairs\n" \
478 "\t-v\tverbose\n" \
479 "\t-s\tOutputs super-block information\n" \
480 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
481 "\t-f\tForce file system check."
482
483#define getopt_trivial_usage \
484 "[OPTIONS]..."
485#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000486 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000487 "\t-a, --alternative Allow long options starting with single -\n" \
488 "\t-l, --longoptions=longopts Long options to be recognized\n" \
489 "\t-n, --name=progname The name under which errors are reported\n" \
490 "\t-o, --options=optstring Short options to be recognized\n" \
491 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
492 "\t-Q, --quiet-output No normal output\n" \
493 "\t-s, --shell=shell Set shell quoting conventions\n" \
494 "\t-T, --test Test for getopt(1) version\n" \
495 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000496#define getopt_example_usage \
497 "$ cat getopt.test\n" \
498 "#!/bin/sh\n" \
499 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
500 " -n 'example.busybox' -- "$@"`\n" \
501 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
502 "eval set -- "$GETOPT"\n" \
503 "while true ; do\n" \
504 " case $1 in\n" \
505 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
506 " -b|--b-long) echo \"Option b, argument \`$2'\" ; shift 2 ;;\n" \
507 " -c|--c-long)\n" \
508 " case "$2" in\n" \
509 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
510 " *) echo \"Option c, argument \`$2'\" ; shift 2 ;;\n" \
511 " esac ;;\n" \
512 " --) shift ; break ;;\n" \
513 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
514 " esac\n" \
515 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000516
517#define grep_trivial_usage \
518 "[-ihHnqvs] pattern [files...]"
519#define grep_full_usage \
520 "Search for PATTERN in each FILE or standard input.\n\n" \
521 "Options:\n" \
522 "\t-H\tprefix output lines with filename where match was found\n" \
523 "\t-h\tsuppress the prefixing filename on output\n" \
524 "\t-i\tignore case distinctions\n" \
525 "\t-n\tprint line number with output lines\n" \
526 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
527 "\t-v\tselect non-matching lines\n" \
528 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000529#define grep_example_usage \
530 "$ grep root /etc/passwd\n" \
531 "root:x:0:0:root:/root:/bin/bash\n" \
532 "$ grep ^[rR]oo. /etc/passwd\n" \
533 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000534
Eric Andersen7e9276b2001-02-22 01:15:47 +0000535#define gunzip_trivial_usage \
536 "[OPTION]... FILE"
537#define gunzip_full_usage \
538 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
539 "Options:\n" \
540 "\t-c\tWrite output to standard output\n" \
541 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000542#define gunzip_example_usage \
543 "$ ls -la /tmp/BusyBox*\n" \
544 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
545 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
546 "$ ls -la /tmp/BusyBox*\n" \
547 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000548
549#define gzip_trivial_usage \
550 "[OPTION]... FILE"
551#define gzip_full_usage \
552 "Compress FILE with maximum compression.\n" \
553 "When FILE is '-', reads standard input. Implies -c.\n\n" \
554 "Options:\n" \
555 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
556 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000557#define gzip_example_usage \
558 "$ ls -la /tmp/BusyBox*\n" \
559 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n" \
560 "$ gzip /tmp/BusyBox-0.43.tar\n" \
561 "$ ls -la /tmp/BusyBox*\n" \
562 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/BusyBox-0.43.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000563
564#define halt_trivial_usage \
565 ""
566#define halt_full_usage \
567 "Halt the system."
568
569#define head_trivial_usage \
570 "[OPTION] [FILE]..."
571#define head_full_usage \
572 "Print first 10 lines of each FILE to standard output.\n" \
573 "With more than one FILE, precede each with a header giving the\n" \
574 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000575 "Options:\n" \
576 "\t-n NUM\t\tPrint first NUM lines instead of first 10"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000577#define head_example_usage \
578 "$ head -n 2 /etc/passwd\n" \
579 "root:x:0:0:root:/root:/bin/bash\n" \
580 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000581
582#define hostid_trivial_usage \
583 ""
584#define hostid_full_usage \
585 "Print out a unique 32-bit identifier for the machine."
586
587#define hostname_trivial_usage \
588 "[OPTION] {hostname | -F file}"
589#define hostname_full_usage \
590 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
591 "(or a file with the -F parameter), the host name will be set.\n\n" \
592 "Options:\n" \
593 "\t-s\t\tShort\n" \
594 "\t-i\t\tAddresses for the hostname\n" \
595 "\t-d\t\tDNS domain name\n" \
596 "\t-F, --file FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000597#define hostname_example_usage \
598 "$ hostname\n" \
599 "slag \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000600
601#define id_trivial_usage \
602 "[OPTIONS]... [USERNAME]"
603#define id_full_usage \
604 "Print information for USERNAME or the current user\n\n" \
605 "Options:\n" \
606 "\t-g\tprints only the group ID\n" \
607 "\t-u\tprints only the user ID\n" \
608 "\t-n\tprint a name instead of a number (with for -ug)\n" \
609 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000610#define id_example_usage \
611 "$ id\n" \
612 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000613
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000614#ifdef BB_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +0000615 #define USAGE_SIOCSKEEPALIVE(a) a
616#else
617 #define USAGE_SIOCSKEEPALIVE(a)
618#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000619#ifdef BB_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
620 #define USAGE_IFCONFIG_MII(a) a
621#else
622 #define USAGE_IFCONFIG_MII(a)
623#endif
624#ifdef BB_FEATURE_IFCONFIG_HW
625 #define USAGE_IFCONFIG_HW(a) a
626#else
627 #define USAGE_IFCONFIG_HW(a)
628#endif
629#ifdef BB_FEATURE_IFCONFIG_STATUS
630 #define USAGE_IFCONFIG_OPT_A(a) a
631#else
632 #define USAGE_IFCONFIG_OPT_A(a)
633#endif
634
Eric Andersen7e9276b2001-02-22 01:15:47 +0000635#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000636 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000637#define ifconfig_full_usage \
638 "configure a network interface\n\n" \
639 "Options:\n" \
640 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000641 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000642 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000643 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
644 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000645 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000646 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
647 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000648 "\t[up|down] ..."
649
650#define init_trivial_usage \
651 ""
652#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000653 "Init is the parent of all processes."
654#define init_notes_usage \
655"This version of init is designed to be run only by the kernel.\n" \
656"\n" \
657"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
658"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
659"runlevels, use sysvinit.\n" \
660"\n" \
661"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
662"it has the following default behavior:\n" \
663"\n" \
664" ::sysinit:/etc/init.d/rcS\n" \
665" ::askfirst:/bin/sh\n" \
666"\n" \
667"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
668"\n" \
669" tty2::askfirst:/bin/sh\n" \
670"\n" \
671"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
672"\n" \
673" <id>:<runlevels>:<action>:<process>\n" \
674"\n" \
675" <id>: \n" \
676"\n" \
677" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
678" The id field is used by BusyBox init to specify the controlling tty for\n" \
679" the specified process to run on. The contents of this field are\n" \
680" appended to "/dev/" and used as-is. There is no need for this field to\n" \
681" be unique, although if it isn't you may have strange results. If this\n" \
682" field is left blank, the controlling tty is set to the console. Also\n" \
683" note that if BusyBox detects that a serial console is in use, then only\n" \
684" entries whose controlling tty is either the serial console or /dev/null\n" \
685" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
686" stinkin' utmp.\n" \
687"\n" \
688" <runlevels>: \n" \
689"\n" \
690" The runlevels field is completely ignored.\n" \
691"\n" \
692" <action>: \n" \
693"\n" \
694" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
695" once, and ctrlaltdel.\n" \
696"\n" \
697" The available actions can be classified into two groups: actions\n" \
698" that are run only once, and actions that are re-run when the specified\n" \
699" process exits.\n" \
700"\n" \
701" Run only-once actions:\n" \
702"\n" \
703" 'sysinit' is the first item run on boot. init waits until all\n" \
704" sysinit actions are completed before continuing. Following the\n" \
705" completion of all sysinit actions, all 'wait' actions are run.\n" \
706" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
707" the specified task completes. 'once' actions are asyncronous,\n" \
708" therefore, init does not wait for them to complete. 'ctrlaltdel'\n" \
709" actions are run immediately before init causes the system to reboot\n" \
710" (unmounting filesystems with a 'ctrlaltdel' action is a very good\n" \
711" idea).\n" \
712"\n" \
713" Run repeatedly actions:\n" \
714"\n" \
715" 'respawn' actions are run after the 'once' actions. When a process\n" \
716" started with a 'respawn' action exits, init automatically restarts\n" \
717" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
718" respawning out of control. The 'askfirst' actions acts just like\n" \
719" respawn, except that before running the specified process it\n" \
720" displays the line "Please press Enter to activate this console."\n" \
721" and then waits for the user to press enter before starting the\n" \
722" specified process. \n" \
723"\n" \
724" Unrecognized actions (like initdefault) will cause init to emit an\n" \
725" error message, and then go along with its business. All actions are\n" \
726" run in the reverse order from how they appear in /etc/inittab.\n" \
727"\n" \
728" <process>: \n" \
729"\n" \
730" Specifies the process to be executed and it's command line.\n" \
731"\n" \
732"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +0000733"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000734" # This is run first except when booting in single-user mode.\n" \
735" #\n" \
736" ::sysinit:/etc/init.d/rcS\n" \
737" \n" \
738" # /bin/sh invocations on selected ttys\n" \
739" #\n" \
740" # Start an "askfirst" shell on the console (whatever that may be)\n" \
741" ::askfirst:-/bin/sh\n" \
742" # Start an "askfirst" shell on /dev/tty2-4\n" \
743" tty2::askfirst:-/bin/sh\n" \
744" tty3::askfirst:-/bin/sh\n" \
745" tty4::askfirst:-/bin/sh\n" \
746" \n" \
747" # /sbin/getty invocations for selected ttys\n" \
748" #\n" \
749" tty4::respawn:/sbin/getty 38400 tty5\n" \
750" tty5::respawn:/sbin/getty 38400 tty6\n" \
751" \n" \
752" \n" \
753" # Example of how to put a getty on a serial line (for a terminal)\n" \
754" #\n" \
755" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
756" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
757" #\n" \
758" # Example how to put a getty on a modem line.\n" \
759" #::respawn:/sbin/getty 57600 ttyS2\n" \
760" \n" \
761" # Stuff to do before rebooting\n" \
762" ::ctrlaltdel:/bin/umount -a -r\n" \
763" ::ctrlaltdel:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000764
765#define insmod_trivial_usage \
766 "[OPTION]... MODULE [symbol=value]..."
767#define insmod_full_usage \
768 "Loads the specified kernel modules into the kernel.\n\n" \
769 "Options:\n" \
770 "\t-f\tForce module to load into the wrong kernel version.\n" \
771 "\t-k\tMake module autoclean-able.\n" \
772 "\t-v\tverbose output\n" \
773 "\t-L\tLock to prevent simultaneous loads of a module\n" \
774 "\t-x\tdo not export externs"
775
776#define kill_trivial_usage \
777 "[-signal] process-id [process-id ...]"
778#define kill_full_usage \
779 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +0000780 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000781 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000782#define kill_example_usage \
783 "$ ps | grep apache\n" \
784 "252 root root S [apache]\n" \
785 "263 www-data www-data S [apache]\n" \
786 "264 www-data www-data S [apache]\n" \
787 "265 www-data www-data S [apache]\n" \
788 "266 www-data www-data S [apache]\n" \
789 "267 www-data www-data S [apache]\n" \
790 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000791
792#define killall_trivial_usage \
793 "[-signal] process-name [process-name ...]"
794#define killall_full_usage \
795 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000796 "Options:\n" \
797 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000798#define killall_example_usage \
799 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000800
Mark Whitley6317c4b2001-03-12 22:51:50 +0000801#define klogd_trivial_usage \
802 "-n"
803#define klogd_full_usage \
804 "Kernel logger.\n"\
805 "Options:\n"\
806 "\t-n\tRun as a foreground process."
807
Eric Andersen7e9276b2001-02-22 01:15:47 +0000808#define length_trivial_usage \
809 "STRING"
810#define length_full_usage \
811 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000812#define length_example_usage \
813 "$ length "Hello"\n" \
814 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000815
816#define ln_trivial_usage \
817 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
818#define ln_full_usage \
819 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
820 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
821 "Options:\n" \
822 "\t-s\tmake symbolic links instead of hard links\n" \
823 "\t-f\tremove existing destination files\n" \
824 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000825#define ln_example_usage \
826 "$ ln -s BusyBox /tmp/ls\n" \
827 "$ ls -l /tmp/ls\n" \
828 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000829
830#define loadacm_trivial_usage \
831 "< mapfile"
832#define loadacm_full_usage \
833 "Loads an acm from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000834#define loadacm_example_usage \
835 "$ loadacm < /etc/i18n/acmname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000836
837#define loadfont_trivial_usage \
838 "< font"
839#define loadfont_full_usage \
840 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000841#define loadfont_example_usage \
842 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000843
844#define loadkmap_trivial_usage \
845 "< keymap"
846#define loadkmap_full_usage \
847 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000848#define loadkmap_example_usage \
849 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000850
851#define logger_trivial_usage \
852 "[OPTION]... [MESSAGE]"
853#define logger_full_usage \
854 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
855 "Options:\n" \
856 "\t-s\tLog to stderr as well as the system log.\n" \
857 "\t-t\tLog using the specified tag (defaults to user name).\n" \
858 "\t-p\tEnter the message with the specified priority.\n" \
859 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000860#define logger_example_usage \
861 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000862
863#define logname_trivial_usage \
864 ""
865#define logname_full_usage \
866 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000867#define logname_example_usage \
868 "$ logname\n" \
869 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000870
Mark Whitley6317c4b2001-03-12 22:51:50 +0000871#define logread_trivial_usage \
872 ""
873
874#define logread_full_usage \
875 "Shows the messages from syslogd (using circular buffer)."
876
Eric Andersen7e9276b2001-02-22 01:15:47 +0000877#ifdef BB_FEATURE_LS_TIMESTAMPS
878 #define USAGE_LS_TIMESTAMPS(a) a
879#else
880 #define USAGE_LS_TIMESTAMPS(a)
881#endif
882#ifdef BB_FEATURE_LS_FILETYPES
883 #define USAGE_LS_FILETYPES(a) a
884#else
885 #define USAGE_LS_FILETYPES(a)
886#endif
887#ifdef BB_FEATURE_LS_FOLLOWLINKS
888 #define USAGE_LS_FOLLOWLINKS(a) a
889#else
890 #define USAGE_LS_FOLLOWLINKS(a)
891#endif
892#ifdef BB_FEATURE_LS_RECURSIVE
893 #define USAGE_LS_RECURSIVE(a) a
894#else
895 #define USAGE_LS_RECURSIVE(a)
896#endif
897#ifdef BB_FEATURE_LS_SORTFILES
898 #define USAGE_LS_SORTFILES(a) a
899#else
900 #define USAGE_LS_SORTFILES(a)
901#endif
902#ifdef BB_FEATURE_AUTOWIDTH
903 #define USAGE_AUTOWIDTH(a) a
904#else
905 #define USAGE_AUTOWIDTH(a)
906#endif
907#define ls_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +0000908 "[-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 +0000909#define ls_full_usage \
910 "List directory contents\n\n" \
911 "Options:\n" \
912 "\t-1\tlist files in a single column\n" \
913 "\t-A\tdo not list implied . and ..\n" \
914 "\t-a\tdo not hide entries starting with .\n" \
915 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000916 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000917 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000918 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
919 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000920 "\t-i\tlist the i-node for each file\n" \
921 "\t-l\tuse a long listing format\n" \
922 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000923 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
924 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
925 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
926 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
927 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000928 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000929 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
930 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
931 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
932 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
933 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000934 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000935 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
936 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000937 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000938 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000939 "\t-k\tprint sizes in kilobytes(compatability)")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000940
941#define lsmod_trivial_usage \
942 ""
943#define lsmod_full_usage \
944 "List the currently loaded kernel modules."
945
946#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000947 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000948#define makedevs_full_usage \
949 "Creates a range of block or character special files\n\n" \
950 "TYPEs include:\n" \
951 "\tb:\tMake a block (buffered) device.\n" \
952 "\tc or u:\tMake a character (un-buffered) device.\n" \
953 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
954 "FIRST specifies the number appended to NAME to create the first device.\n" \
955 "LAST specifies the number of the last item that should be created.\n" \
956 "If 's' is the last argument, the base device is created as well.\n\n" \
957 "For example:\n" \
958 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000959 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000960#define makedevs_example_usage \
961 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
962 "[creates ttyS2-ttyS63]\n" \
963 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
964 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000965
Eric Andersen7e9276b2001-02-22 01:15:47 +0000966#define md5sum_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000967 "[OPTION] [FILE]...\n" \
968 "or: md5sum [OPTION] -c [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000969#define md5sum_full_usage \
970 "Print or check MD5 checksums.\n\n" \
971 "Options:\n" \
972 "With no FILE, or when FILE is -, read standard input.\n\n" \
973 "\t-b\tread files in binary mode\n" \
974 "\t-c\tcheck MD5 sums against given list\n" \
975 "\t-t\tread files in text mode (default)\n" \
976 "\t-g\tread a string\n" \
977 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000978 "\t-s\tdon't output anything, status code shows success\n" \
979 "\t-w\twarn about improperly formated MD5 checksum lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000980#define md5sum_example_usage \
981 "$ md5sum < busybox\n" \
982 "6fd11e98b98a58f64ff3398d7b324003\n" \
983 "$ md5sum busybox\n" \
984 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
985 "$ md5sum -c -\n" \
986 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
987 "busybox: OK\n" \
988 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000989
Eric Andersen7e9276b2001-02-22 01:15:47 +0000990#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000991 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000992#define mkdir_full_usage \
993 "Create the DIRECTORY(ies), if they do not already exist\n\n" \
994 "Options:\n" \
995 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000996 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000997#define mkdir_example_usage \
998 "$ mkdir /tmp/foo\n" \
999 "$ mkdir /tmp/foo\n" \
1000 "/tmp/foo: File exists\n" \
1001 "$ mkdir /tmp/foo/bar/baz\n" \
1002 "/tmp/foo/bar/baz: No such file or directory\n" \
1003 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001004
Eric Andersen7e9276b2001-02-22 01:15:47 +00001005#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001006 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001007#define mkfifo_full_usage \
1008 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1009 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001010 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001011
Eric Andersen7e9276b2001-02-22 01:15:47 +00001012#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001013 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001014#define mkfs_minix_full_usage \
1015 "Make a MINIX filesystem.\n\n" \
1016 "Options:\n" \
1017 "\t-c\t\tCheck the device for bad blocks\n" \
1018 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1019 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1020 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001021 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001022
Eric Andersen7e9276b2001-02-22 01:15:47 +00001023#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001024 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001025#define mknod_full_usage \
1026 "Create a special file (block, character, or pipe).\n\n" \
1027 "Options:\n" \
1028 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1029 "TYPEs include:\n" \
1030 "\tb:\tMake a block (buffered) device.\n" \
1031 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001032 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001033#define mknod_example_usage \
1034 "$ mknod /dev/fd0 b 2 0 \n" \
1035 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001036
Eric Andersen7e9276b2001-02-22 01:15:47 +00001037#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001038 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001039#define mkswap_full_usage \
1040 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001041 "Options:\n" \
1042 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001043 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001044 "\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 +00001045 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001046
Eric Andersen7e9276b2001-02-22 01:15:47 +00001047#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001048 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001049#define mktemp_full_usage \
1050 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001051 "TEMPLATE is any name with six `Xs' (i.e. /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001052#define mktemp_example_usage \
1053 "$ mktemp /tmp/temp.XXXXXX\n" \
1054 "/tmp/temp.mWiLjM\n" \
1055 "$ ls -la /tmp/temp.mWiLjM\n" \
1056 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001057
Eric Andersen7e9276b2001-02-22 01:15:47 +00001058#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001059 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001060#define more_full_usage \
1061 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001062#define more_example_usage \
1063 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001064
Eric Andersen7e9276b2001-02-22 01:15:47 +00001065#ifdef BB_FEATURE_MOUNT_LOOP
1066 #define USAGE_MOUNT_LOOP(a) a
1067#else
1068 #define USAGE_MOUNT_LOOP(a)
1069#endif
Eric Andersenc4cef5a2001-04-01 16:01:11 +00001070#ifdef BB_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001071 #define USAGE_MTAB(a) a
1072#else
1073 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001074#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001075#define mount_trivial_usage \
1076 "[flags] device directory [-o options,more-options]"
1077#define mount_full_usage \
1078 "Mount a filesystem\n\n" \
1079 "Flags:\n" \
1080 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001081 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001082 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001083 "\t-n:\t\tDon't write a mount table entry.\n" \
1084 ) \
1085 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1086 "\t-r:\t\tMount the filesystem read-only.\n" \
1087 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1088 "\t-w:\t\tMount for reading and writing (default).\n" \
1089 "\n" \
1090 "Options for use with the \"-o\" flag:\n" \
1091 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1092 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1093 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1094 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001095 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001096 "\tloop:\t\tMounts a file via loop device.\n" \
1097 ) \
1098 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001099 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001100 "\tro/rw:\t\tMount for read-only / read-write.\n" \
1101 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001102 "You'll have to see the written documentation for those."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001103#define mount_example_usage \
1104 "$ mount\n" \
1105 "/dev/hda3 on / type minix (rw)\n" \
1106 "proc on /proc type proc (rw)\n" \
1107 "devpts on /dev/pts type devpts (rw)\n" \
1108 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1109 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001110
Eric Andersen7e9276b2001-02-22 01:15:47 +00001111#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001112 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001113#define mt_full_usage \
1114 "Control magnetic tape drive operation\n" \
1115 "\nAvailable Opcodes:\n\n" \
1116 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1117 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
1118 "ras3 reset retension rew rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001119 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001120
Eric Andersen7e9276b2001-02-22 01:15:47 +00001121#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001122 "SOURCE DEST\n" \
1123 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001124#define mv_full_usage \
1125 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001126#define mv_example_usage \
1127 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001128
Eric Andersen7e9276b2001-02-22 01:15:47 +00001129#define nc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001130 "[IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001131#define nc_full_usage \
1132 "Netcat opens a pipe to IP:port"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001133#define nc_example_usage \
1134 "$ nc foobar.somedomain.com 25\n" \
1135 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1136 "help\n" \
1137 "214-Commands supported:\n" \
1138 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1139 "214 NOOP QUIT RSET HELP\n" \
1140 "quit\n" \
1141 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001142
Eric Andersen7e9276b2001-02-22 01:15:47 +00001143#define nslookup_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001144 "[HOST]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001145#define nslookup_full_usage \
1146 "Queries the nameserver for the IP address of the given HOST"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001147#define nslookup_example_usage \
1148 "$ nslookup localhost\n" \
1149 "Server: default\n" \
1150 "Address: default\n" \
1151 "\n" \
1152 "Name: debian\n" \
1153 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001154
Eric Andersen7e9276b2001-02-22 01:15:47 +00001155#ifdef BB_FEATURE_SIMPLE_PING
1156#define ping_trivial_usage "host"
1157#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1158#else
1159#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001160 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001161#define ping_full_usage \
1162 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1163 "Options:\n" \
1164 "\t-c COUNT\tSend only COUNT pings.\n" \
1165 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1166 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001167 "\t\t\tand when finished."
1168#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001169#define ping_example_usage \
1170 "$ ping localhost\n" \
1171 "PING slag (127.0.0.1): 56 data bytes\n" \
1172 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1173 "\n" \
1174 "--- debian ping statistics ---\n" \
1175 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1176 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001177
Eric Andersen7e9276b2001-02-22 01:15:47 +00001178#define pivot_root_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001179 "new_root put_old"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001180#define pivot_root_full_usage \
1181 "Move the current root file system to put_old and make new_root\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001182 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001183
Eric Andersen7e9276b2001-02-22 01:15:47 +00001184#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001185 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001186#define poweroff_full_usage \
1187 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001188
Eric Andersen7e9276b2001-02-22 01:15:47 +00001189#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001190 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001191#define printf_full_usage \
1192 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001193 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001194#define printf_example_usage \
1195 "$ printf "Val=%d\n" 5\n" \
1196 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001197
Eric Andersen7e9276b2001-02-22 01:15:47 +00001198#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001199 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001200#define ps_full_usage \
1201 "Report process status\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001202 "\nThis version of ps accepts no options."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001203#define ps_example_usage \
1204 "$ ps\n" \
1205 " PID Uid Gid State Command\n" \
1206 " 1 root root S init\n" \
1207 " 2 root root S [kflushd]\n" \
1208 " 3 root root S [kupdate]\n" \
1209 " 4 root root S [kpiod]\n" \
1210 " 5 root root S [kswapd]\n" \
1211 " 742 andersen andersen S [bash]\n" \
1212 " 743 andersen andersen S -bash\n" \
1213 " 745 root root S [getty]\n" \
1214 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001215
Eric Andersen7e9276b2001-02-22 01:15:47 +00001216#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001217 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001218#define pwd_full_usage \
1219 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001220#define pwd_example_usage \
1221 "$ pwd\n" \
1222 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001223
Eric Andersen7e9276b2001-02-22 01:15:47 +00001224#define rdate_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001225 "[OPTION] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001226#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001227 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001228 "Options:\n" \
1229 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001230 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001231
Eric Andersen7e9276b2001-02-22 01:15:47 +00001232#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001233 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001234#define readlink_full_usage \
1235 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001236
Eric Andersen7e9276b2001-02-22 01:15:47 +00001237#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001238 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001239#define reboot_full_usage \
1240 "Reboot the system."
1241
1242#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001243 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001244#define renice_full_usage \
1245 "Changes priority of running processes. Allowed priorities range\n" \
1246 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001247 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001248
Eric Andersen7e9276b2001-02-22 01:15:47 +00001249#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001250 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001251#define reset_full_usage \
1252 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001253
Mark Whitleye0bf91d2001-03-13 00:40:19 +00001254#ifdef BB_FEATURE_RM_INTERACTIVE
1255 #define USAGE_RM_INTERACTIVE(a) a
1256#else
1257 #define USAGE_RM_INTERACTIVE(a)
1258#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001259#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001260 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001261#define rm_full_usage \
1262 "Remove (unlink) the FILE(s). You may use '--' to\n" \
1263 "indicate that all following arguments are non-options.\n\n" \
1264 "Options:\n" \
Mark Whitleye0bf91d2001-03-13 00:40:19 +00001265 USAGE_RM_INTERACTIVE("\t-i\t\talways prompt before removing each destinations\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001266 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001267 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001268#define rm_example_usage \
1269 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001270
Eric Andersen7e9276b2001-02-22 01:15:47 +00001271#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001272 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001273#define rmdir_full_usage \
1274 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001275#define rmdir_example_usage \
1276 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001277
Eric Andersen7e9276b2001-02-22 01:15:47 +00001278#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001279 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001280#define rmmod_full_usage \
1281 "Unloads the specified kernel modules from the kernel.\n\n" \
1282 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001283 "\t-a\tTry to remove all unused kernel modules."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001284#define rmmod_example_usage \
1285 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001286
Eric Andersen7e9276b2001-02-22 01:15:47 +00001287#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001288 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001289#define route_full_usage \
1290 "Edit the kernel's routing tables"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001291
Eric Andersen7e9276b2001-02-22 01:15:47 +00001292#define rpmunpack_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001293 "< package.rpm | gunzip | cpio -idmuv"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001294#define rpmunpack_full_usage \
1295 "Extracts an rpm archive."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001296
Eric Andersen7e9276b2001-02-22 01:15:47 +00001297#define sed_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001298 "[-Vhnef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001299#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001300 "Options:\n" \
1301 "\t-n\t\tsuppress automatic printing of pattern space\n" \
1302 "\t-e script\tadd the script to the commands to be executed\n" \
1303 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
1304 "\t-h\t\tdisplay this help message\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001305 "\n" \
1306 "If no -e or -f is given, the first non-option argument is taken as the\n" \
1307 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001308 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001309#define sed_example_usage \
1310 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
1311 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001312
Eric Andersen7e9276b2001-02-22 01:15:47 +00001313#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001314 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001315#define setkeycodes_full_usage \
1316 "Set entries into the kernel's scancode-to-keycode map,\n" \
1317 "allowing unusual keyboards to generate usable keycodes.\n\n" \
1318 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001319 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001320#define setkeycodes_example_usage \
1321 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001322
Eric Andersen7e9276b2001-02-22 01:15:47 +00001323#define sh_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001324 "[FILE]...\n" \
1325 "or: sh -c command [args]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001326#define sh_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001327 "lash: The BusyBox LAme SHell (command interpreter)"
1328#define sh_notes_usage \
1329"This command does not yet have proper documentation.\n" \
1330"\n" \
1331"Use lash just as you would use any other shell. It properly handles pipes,\n" \
1332"redirects, job control, can be used as the shell for scripts, and has a\n" \
1333"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
1334"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
1335"use ash or bash. If you just need a very simple and extremely small shell,\n" \
1336"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001337
Eric Andersen7e9276b2001-02-22 01:15:47 +00001338#define sleep_trivial_usage \
1339 "N"
1340#define sleep_full_usage \
1341 "Pause for N seconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001342#define sleep_example_usage \
1343 "$ sleep 2\n" \
1344 "[2 second delay results]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001345
Eric Andersen7e9276b2001-02-22 01:15:47 +00001346
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001347#ifdef BB_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001348 #define USAGE_SORT_REVERSE(a) a
1349#else
1350 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001351#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001352#define sort_trivial_usage \
1353 "[-n]" USAGE_SORT_REVERSE(" [-r]") " [FILE]..."
1354#define sort_full_usage \
1355 "Sorts lines of text in the specified files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001356#define sort_example_usage \
1357 "$ echo -e "e\nf\nb\nd\nc\na" | sort\n" \
1358 "a\n" \
1359 "b\n" \
1360 "c\n" \
1361 "d\n" \
1362 "e\n" \
1363 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001364
Eric Andersen7e9276b2001-02-22 01:15:47 +00001365#define stty_trivial_usage \
1366 "[-a|g] [-F device] [SETTING]..."
1367#define stty_full_usage \
1368 "Without arguments, prints baud rate, line discipline," \
1369 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001370 "\n\nOptions:" \
1371 "\n\t-F device\topen device instead of stdin" \
1372 "\n\t-a\t\tprint all current settings in human-readable form" \
1373 "\n\t-g\t\tprint in stty-readable form" \
1374 "\n\t[SETTING]\tsee documentation"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001375
Eric Andersen7e9276b2001-02-22 01:15:47 +00001376#define swapoff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001377 "[OPTION] [device]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001378#define swapoff_full_usage \
1379 "Stop swapping virtual memory pages on the given device.\n\n" \
1380 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001381 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001382
Eric Andersen7e9276b2001-02-22 01:15:47 +00001383#define swapon_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001384 "[OPTION] [device]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001385#define swapon_full_usage \
1386 "Start swapping virtual memory pages on the given device.\n\n" \
1387 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001388 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001389
Eric Andersen7e9276b2001-02-22 01:15:47 +00001390#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001391 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001392#define sync_full_usage \
1393 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001394
Eric Andersen7e9276b2001-02-22 01:15:47 +00001395
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001396#ifdef BB_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00001397 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001398#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00001399 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001400#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001401#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001402 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001403#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00001404 "Linux system and kernel logging utility.\n" \
1405 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001406 "Options:\n" \
1407 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
1408 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001409 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001410 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00001411 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
1412 "\t-L\t\tLog locally and via network logging (default is network only)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001413#define syslogd_example_usage \
1414 "$ syslogd -R masterlog:514\n" \
1415 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001416
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001417
Eric Andersen7e9276b2001-02-22 01:15:47 +00001418#ifdef BB_FEATURE_SIMPLE_TAIL
1419 #define USAGE_UNSIMPLE_TAIL(a)
1420#else
1421 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001422#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001423#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001424 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001425#define tail_full_usage \
1426 "Print last 10 lines of each FILE to standard output.\n" \
1427 "With more than one FILE, precede each with a header giving the\n" \
1428 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
1429 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001430 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001431 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
1432 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001433 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001434 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
1435 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001436 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001437 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001438 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
1439#define tail_example_usage \
1440 "$ tail -n 1 /etc/resolv.conf\n" \
1441 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001442
Eric Andersen7e9276b2001-02-22 01:15:47 +00001443#ifdef BB_FEATURE_TAR_CREATE
1444 #define USAGE_TAR_CREATE(a) a
1445#else
1446 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001447#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001448#ifdef BB_FEATURE_TAR_EXCLUDE
1449 #define USAGE_TAR_EXCLUDE(a) a
1450#else
1451 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001452#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001453#define tar_trivial_usage \
1454 "-[" USAGE_TAR_CREATE("c") "xtvO] " \
1455 USAGE_TAR_EXCLUDE("[--exclude File] [-X File]") \
1456 "[-f tarFile] [FILE(s)] ..."
1457#define tar_full_usage \
1458 "Create, extract, or list files from a tar file.\n\n" \
1459 "Main operation mode:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001460 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001461 "\tx\t\textract\n" \
1462 "\tt\t\tlist\n" \
1463 "\nFile selection:\n" \
1464 "\tf\t\tname of tarfile or \"-\" for stdin\n" \
1465 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001466 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001467 "\texclude\t\tfile to exclude\n" \
1468 "\tX\t\tfile with names to exclude\n" \
1469 ) \
1470 "\nInformative output:\n" \
1471 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001472#define tar_example_usage \
1473 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
1474 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001475
Eric Andersen7e9276b2001-02-22 01:15:47 +00001476#define tee_trivial_usage \
1477 "[OPTION]... [FILE]..."
1478#define tee_full_usage \
1479 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001480 "Options:\n" \
1481 "\t-a\tappend to the given FILEs, do not overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001482#define tee_example_usage \
1483 "$ echo "Hello" | tee /tmp/foo\n" \
1484 "$ cat /tmp/foo\n" \
1485 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001486
Eric Andersen7e9276b2001-02-22 01:15:47 +00001487#define telnet_trivial_usage \
1488 "host [port]"
1489#define telnet_full_usage \
1490 "Telnet is used to establish interactive communication with another\n"\
1491 "computer over a network using the TELNET protocol."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001492
Eric Andersen7e9276b2001-02-22 01:15:47 +00001493#define test_trivial_usage \
1494 "EXPRESSION\n or [ EXPRESSION ]"
1495#define test_full_usage \
1496 "Checks file types and compares values returning an exit\n" \
1497 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001498#define test_example_usage \
1499 "$ test 1 -eq 2\n" \
1500 "$ echo $?\n" \
1501 "1\n" \
1502 "$ test 1 -eq 1\n" \
1503 "$ echo $? \n" \
1504 "0\n" \
1505 "$ [ -d /etc ]\n" \
1506 "$ echo $?\n" \
1507 "0\n" \
1508 "$ [ -d /junk ]\n" \
1509 "$ echo $?\n" \
1510 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001511
Mark Whitley450736c2001-03-02 19:08:50 +00001512#ifdef BB_FEATURE_TFTP_GET
1513 #define USAGE_TFTP_GET(a) a
1514#else
1515 #define USAGE_TFTP_GET(a)
1516#endif
1517#ifdef BB_FEATURE_TFTP_PUT
1518 #define USAGE_TFTP_PUT(a) a
1519#else
1520 #define USAGE_TFTP_PUT(a)
1521#endif
1522
1523#define tftp_trivial_usage \
1524 "command SOURCE DEST"
1525#define tftp_full_usage \
1526 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
1527 "Commands:\n" \
1528 USAGE_TFTP_GET( \
1529 "\tget\tGet file from server SOURCE and store to local DEST.\n" \
1530 ) \
1531 USAGE_TFTP_PUT( \
1532 "\tput\tPut local file SOURCE to server DEST.\n" \
1533 ) \
1534 "\nWhen nameing a server, use the syntax \"server:file\"."
1535
Eric Andersen7e9276b2001-02-22 01:15:47 +00001536#define touch_trivial_usage \
1537 "[-c] file [file ...]"
1538#define touch_full_usage \
1539 "Update the last-modified date on the given file[s].\n\n" \
1540 "Options:\n" \
1541 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001542#define touch_example_usage \
1543 "$ ls -l /tmp/foo\n" \
1544 "/bin/ls: /tmp/foo: No such file or directory\n" \
1545 "$ touch /tmp/foo\n" \
1546 "$ ls -l /tmp/foo\n" \
1547 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001548
1549#define tr_trivial_usage \
1550 "[-cds] STRING1 [STRING2]"
1551#define tr_full_usage \
1552 "Translate, squeeze, and/or delete characters from\n" \
1553 "standard input, writing to standard output.\n\n" \
1554 "Options:\n" \
1555 "\t-c\ttake complement of STRING1\n" \
1556 "\t-d\tdelete input characters coded STRING1\n" \
1557 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001558#define tr_example_usage \
1559 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
1560 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001561
1562#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001563 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001564#define true_full_usage \
1565 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001566#define true_example_usage \
1567 "$ true\n" \
1568 "$ echo $?\n" \
1569 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001570
Eric Andersen7e9276b2001-02-22 01:15:47 +00001571#define tty_trivial_usage \
1572 ""
1573#define tty_full_usage \
1574 "Print the file name of the terminal connected to standard input.\n\n"\
1575 "Options:\n" \
1576 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001577#define tty_example_usage \
1578 "$ tty\n" \
1579 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001580
Eric Andersen7e9276b2001-02-22 01:15:47 +00001581#ifdef BB_FEATURE_MOUNT_FORCE
1582 #define USAGE_MOUNT_FORCE(a) a
1583#else
1584 #define USAGE_MOUNT_FORCE(a)
1585#endif
1586#define umount_trivial_usage \
1587 "[flags] filesystem|directory"
1588#define umount_full_usage \
1589 "Unmount file systems\n" \
1590 "\nFlags:\n" "\t-a:\tUnmount all file systems" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001591 USAGE_MTAB(" in /etc/mtab\n\t-n:\tDon't erase /etc/mtab entries") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001592 "\n\t-r:\tTry to remount devices as read-only if mount is busy" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001593 USAGE_MOUNT_FORCE("\n\t-f:\tForce filesystem umount (i.e. unreachable NFS server)") \
1594 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 +00001595#define umount_example_usage \
1596 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001597
1598#define uname_trivial_usage \
1599 "[OPTION]..."
1600#define uname_full_usage \
1601 "Print certain system information. With no OPTION, same as -s.\n\n" \
1602 "Options:\n" \
1603 "\t-a\tprint all information\n" \
1604 "\t-m\tthe machine (hardware) type\n" \
1605 "\t-n\tprint the machine's network node hostname\n" \
1606 "\t-r\tprint the operating system release\n" \
1607 "\t-s\tprint the operating system name\n" \
1608 "\t-p\tprint the host processor type\n" \
1609 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001610#define uname_example_usage \
1611 "$ uname -a\n" \
1612 "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001613
1614#define uniq_trivial_usage \
1615 "[OPTION]... [INPUT [OUTPUT]]"
1616#define uniq_full_usage \
1617 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001618 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001619 "Options:\n" \
1620 "\t-c\tprefix lines by the number of occurrences\n" \
1621 "\t-d\tonly print duplicate lines\n" \
1622 "\t-u\tonly print unique lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001623#define uniq_example_usage \
1624 "$ echo -e "a\na\nb\nc\nc\na" | sort | uniq\n" \
1625 "a\n" \
1626 "b\n" \
1627 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001628
1629#define unix2dos_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001630 "[option] [file]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001631#define unix2dos_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001632 "See 'dos2unix --help' for help!"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001633
1634#define update_trivial_usage \
1635 "[options]"
1636#define update_full_usage \
1637 "Periodically flushes filesystem buffers.\n\n" \
1638 "Options:\n" \
1639 "\t-S\tforce use of sync(2) instead of flushing\n" \
1640 "\t-s SECS\tcall sync this often (default 30)\n" \
1641 "\t-f SECS\tflush some buffers this often (default 5)"
1642
1643#define uptime_trivial_usage \
1644 ""
1645#define uptime_full_usage \
1646 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001647#define uptime_example_usage \
1648 "$ uptime\n" \
1649 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001650
1651#define usleep_trivial_usage \
1652 "N"
1653#define usleep_full_usage \
1654 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001655#define usleep_example_usage \
1656 "$ usleep 1000000\n" \
1657 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001658
1659#define uudecode_trivial_usage \
1660 "[FILE]..."
1661#define uudecode_full_usage \
1662 "Uudecode a file that is uuencoded.\n\n" \
1663 "Options:\n" \
Eric Andersen704b2c22001-03-16 08:06:30 +00001664 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001665#define uudecode_example_usage \
1666 "$ uudecode -o busybox busybox.uu\n" \
1667 "$ ls -l busybox\n" \
1668 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001669
1670#define uuencode_trivial_usage \
1671 "[OPTION] [INFILE] REMOTEFILE"
1672#define uuencode_full_usage \
1673 "Uuencode a file.\n\n" \
1674 "Options:\n" \
1675 "\t-m\tuse base64 encoding as of RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001676#define uuencode_example_usage \
1677 "$ uuencode busybox busybox\n" \
1678 "begin 755 busybox\n" \
1679 "<encoded file snipped>\n" \
1680 "$ uudecode busybox busybox > busybox.uu\n" \
1681 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001682
1683#define watchdog_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001684 "DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001685#define watchdog_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001686 "Periodically write to watchdog device DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001687
1688#define wc_trivial_usage \
1689 "[OPTION]... [FILE]..."
1690#define wc_full_usage \
1691 "Print line, word, and byte counts for each FILE, and a total line if\n" \
1692 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
1693 "Options:\n" \
1694 "\t-c\tprint the byte counts\n" \
1695 "\t-l\tprint the newline counts\n" \
1696 "\t-L\tprint the length of the longest line\n" \
1697 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001698#define wc_example_usage \
1699 "$ wc /etc/passwd\n" \
1700 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001701
1702#define wget_trivial_usage \
1703 "[-c] [-O file] url"
1704#define wget_full_usage \
1705 "wget retrieves files via HTTP\n\n" \
1706 "Options:\n" \
1707 "\t-c\tcontinue retrieval of aborted transfers\n" \
1708 "\t-O\tsave to filename ('-' for stdout)"
1709
1710#define which_trivial_usage \
1711 "[COMMAND ...]"
1712#define which_full_usage \
1713 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001714#define which_example_usage \
1715 "$ which login\n" \
1716 "/bin/login\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001717
1718#define whoami_trivial_usage \
1719 ""
1720#define whoami_full_usage \
1721 "Prints the user name associated with the current effective user id."
1722
1723#define xargs_trivial_usage \
1724 "[COMMAND] [ARGS...]"
1725#define xargs_full_usage \
1726 "Executes COMMAND on every item given by standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001727#define xargs_example_usage \
1728 "$ ls | xargs gzip\n" \
1729 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001730
1731#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001732 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001733#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001734 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001735
Eric Andersen7e9276b2001-02-22 01:15:47 +00001736#define zcat_trivial_usage \
1737 "FILE"
1738#define zcat_full_usage \
1739 "Uncompress to stdout."