blob: 3d4752cd274d28df01c2f45351676df7f6333443 [file] [log] [blame]
Eric Andersen7e9276b2001-02-22 01:15:47 +00001#define ar_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002 "-[ovR]{ptx} archive filenames"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003#define ar_full_usage \
4 "Extract or list files from an ar archive.\n\n" \
5 "Options:\n" \
6 "\t-o\t\tpreserve original dates\n" \
7 "\t-p\t\textract to stdout\n" \
8 "\t-t\t\tlist\n" \
9 "\t-x\t\textract\n" \
10 "\t-v\t\tverbosely list files processed\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000011 "\t-R\t\trecursive action"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000012
Eric Andersen7e9276b2001-02-22 01:15:47 +000013#define basename_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000014 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000015#define basename_full_usage \
16 "Strips directory path and suffixes from FILE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000017 "If specified, also removes any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000018#define basename_example_usage \
19 "$ basename /usr/local/bin/foo\n" \
20 "foo\n" \
21 "$ basename /usr/local/bin/\n" \
22 "bin\n" \
23 "$ basename /foo/bar.txt .txt\n" \
24 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000025
Eric Andersen7e9276b2001-02-22 01:15:47 +000026#define cat_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000027 "[FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000028#define cat_full_usage \
29 "Concatenates FILE(s) and prints them to stdout."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000030#define cat_example_usage \
31 "$ cat /proc/uptime\n" \
32 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000033
Eric Andersen7e9276b2001-02-22 01:15:47 +000034#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000035 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000036#define chgrp_full_usage \
37 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000038 "\nOptions:\n" \
39 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000040#define chgrp_example_usage \
41 "$ ls -l /tmp/foo\n" \
42 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
43 "$ chgrp root /tmp/foo\n" \
44 "$ ls -l /tmp/foo\n" \
45 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000046
Eric Andersen7e9276b2001-02-22 01:15:47 +000047#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000048 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000049#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000050 "Each MODE is one or more of the letters ugoa, one of the\n" \
51 "symbols +-= and one or more of the letters rwxst.\n\n" \
52 "Options:\n" \
53 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000054#define chmod_example_usage \
55 "$ ls -l /tmp/foo\n" \
56 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
57 "$ chmod u+x /tmp/foo\n" \
58 "$ ls -l /tmp/foo\n" \
59 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
60 "$ chmod 444 /tmp/foo\n" \
61 "$ ls -l /tmp/foo\n" \
62 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000063
Eric Andersen7e9276b2001-02-22 01:15:47 +000064#define chown_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000065 "[OPTION]... OWNER[<.|:>[GROUP] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000066#define chown_full_usage \
67 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000068 "\nOptions:\n" \
69 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000070#define chown_example_usage \
71 "$ ls -l /tmp/foo\n" \
72 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
73 "$ chown root /tmp/foo\n" \
74 "$ ls -l /tmp/foo\n" \
75 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
76 "$ chown root.root /tmp/foo\n" \
77 "ls -l /tmp/foo\n" \
78 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000079
Eric Andersen7e9276b2001-02-22 01:15:47 +000080#define chroot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000081 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000082#define chroot_full_usage \
83 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000084#define chroot_example_usage \
85 "$ ls -l /bin/ls\n" \
86 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
87 "$ mount /dev/hdc1 /mnt -t minix\n" \
88 "$ chroot /mnt\n" \
89 "$ ls -l /bin/ls\n" \
90 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000091
Eric Andersen7e9276b2001-02-22 01:15:47 +000092#define chvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000093 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +000094#define chvt_full_usage \
95 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000096
Eric Andersen7e9276b2001-02-22 01:15:47 +000097#define clear_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000098 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +000099#define clear_full_usage \
100 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000101
Eric Andersen7e9276b2001-02-22 01:15:47 +0000102#define cmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000103 "FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000104#define cmp_full_usage \
105 "Compare files."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000106
Eric Andersen7e9276b2001-02-22 01:15:47 +0000107#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000108 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000109#define cp_full_usage \
110 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
111 "\n" \
112 "\t-a\tSame as -dpR\n" \
113 "\t-d\tPreserves links\n" \
114 "\t-p\tPreserves file attributes if possible\n" \
115 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000116 "\t-R\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000117
Eric Andersen7e9276b2001-02-22 01:15:47 +0000118#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000119 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000120#define cut_full_usage \
121 "Prints selected fields from each input FILE to standard output.\n\n" \
122 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000123 "\t-b LIST\t\tOutput only bytes from LIST\n" \
124 "\t-c LIST\t\tOutput only characters from LIST\n" \
125 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
126 "\t-s\t\tOutput only the lines containing delimiter\n" \
127 "\t-f N\t\tPrint only these fields\n" \
128 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000129#define cut_example_usage \
130 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
131 "Hello\n" \
132 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
133 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000134
Eric Andersen7e9276b2001-02-22 01:15:47 +0000135#define date_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000136 "[OPTION]... [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000137#define date_full_usage \
138 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000139 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000140 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000141 "\t-d STRING\tdisplay time described by STRING, not `now'\n" \
142 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000143 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000144#define date_example_usage \
145 "$ date\n" \
146 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000147
Eric Andersen7e9276b2001-02-22 01:15:47 +0000148#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000149 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000150#define dc_full_usage \
151 "This is a Tiny RPN calculator that understands the\n" \
152 "following operations: +, -, /, *, and, or, not, eor.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000153 "i.e. 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000154#define dc_example_usage \
155 "$ dc 2 2 +\n" \
156 "4\n" \
157 "$ dc 8 8 \* 2 2 + /\n" \
158 "16\n" \
159 "$ dc 0 1 and\n" \
160 "0\n" \
161 "$ dc 0 1 or\n" \
162 "1\n" \
163 "$ echo 72 9 div 8 mul | dc\n" \
164 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000165
Eric Andersen7e9276b2001-02-22 01:15:47 +0000166#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000167 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000168 "\t [seek=N] [conv=notrunc|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000169#define dd_full_usage \
170 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000171 "\tif=FILE\t\tread from FILE instead of stdin\n" \
172 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
173 "\tbs=N\t\tread and write N bytes at a time\n" \
174 "\tcount=N\t\tcopy only N input blocks\n" \
175 "\tskip=N\t\tskip N input blocks\n" \
176 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000177 "\tconv=notrunc\tdon't truncate output file\n" \
178 "\tconv=sync\tpad blocks with zeros\n" \
179 "\n" \
180 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000181 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000182#define dd_example_usage \
183 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
184 "4+0 records in\n" \
185 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000186
Eric Andersen7e9276b2001-02-22 01:15:47 +0000187#define deallocvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000188 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000189#define deallocvt_full_usage \
190 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000191
Eric Andersen7e9276b2001-02-22 01:15:47 +0000192
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000193#ifdef BB_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000194 #define USAGE_HUMAN_READABLE(a) a
195 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000196#else
Eric Andersened0d9582001-02-23 13:23:03 +0000197 #define USAGE_HUMAN_READABLE(a)
198 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000199#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000200#define df_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +0000201 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [filesystem ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000202#define df_full_usage \
203 "Print the filesystem space used and space available.\n\n" \
204 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000205 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000206 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
207 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000208 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000209 "\n\t-k\tprint sizes in kilobytes(compatability)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000210#define df_example_usage \
211 "$ df\n" \
212 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
213 "/dev/sda3 8690864 8553540 137324 98% /\n" \
214 "/dev/sda1 64216 36364 27852 57% /boot\n" \
215 "$ df /dev/sda3\n" \
216 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
217 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000218
Eric Andersen7e9276b2001-02-22 01:15:47 +0000219#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000220 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000221#define dirname_full_usage \
222 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000223#define dirname_example_usage \
224 "$ dirname /tmp/foo\n" \
225 "/tmp\n" \
226 "$ dirname /tmp/foo/\n" \
227 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000228
Eric Andersen7e9276b2001-02-22 01:15:47 +0000229#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000230 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000231#define dmesg_full_usage \
232 "Prints or controls the kernel ring buffer\n\n" \
233 "Options:\n" \
234 "\t-c\t\tClears the ring buffer's contents after printing\n" \
235 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000236 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000237
Eric Andersen7e9276b2001-02-22 01:15:47 +0000238#define dos2unix_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000239 "[option] [file]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000240#define dos2unix_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000241 "Converts a text file to/from dos format to unix format.\n\n" \
242 "Options:\n" \
243 "\t-u\toutput will be in UNIX format\n" \
244 "\t-d\toutput will be in DOS format\n\n" \
245 "- when no option is given then input format will be automaticaly detected\n" \
246 " and converted to the oposite format on output\n" \
247 "- when no file is given, then stdin is used as input and stdout as output"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000248
Eric Andersen7e9276b2001-02-22 01:15:47 +0000249#define dpkg_trivial_usage \
250 "[-i|-r|--unpack|--configure] my.deb"
251#define dpkg_full_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000252 "WORK IN PROGRESS, only usefull for debian-installer"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000253
Eric Andersen7e9276b2001-02-22 01:15:47 +0000254#define dpkg_deb_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000255 "[-cexX] file directory"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000256#define dpkg_deb_full_usage \
257 "Perform actions on debian packages (.debs)\n\n" \
258 "Options:\n" \
259 "\t-c\tList contents of filesystem tree (verbose)\n" \
260 "\t-l\tList contents of filesystem tree (.list format)\n" \
261 "\t-e\tExtract control files to directory\n" \
262 "\t-x\tExctract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000263 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000264#define dpkg_deb_example_usage \
265 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000266
Eric Andersen7e9276b2001-02-22 01:15:47 +0000267#define du_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +0000268 "[-ls" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000269#define du_full_usage \
270 "Summarizes disk space used for each FILE and/or directory.\n" \
271 "Disk space is printed in units of 1024 bytes.\n\n" \
272 "Options:\n" \
273 "\t-l\tcount sizes many times if hard linked\n" \
274 "\t-s\tdisplay only a total for each argument" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000275 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000276 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
277 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000278 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000279 "\n\t-k\tprint sizes in kilobytes(compatability)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000280#define du_example_usage \
281 "$ du\n" \
282 "16 ./CVS\n" \
283 "12 ./kernel-patches/CVS\n" \
284 "80 ./kernel-patches\n" \
285 "12 ./tests/CVS\n" \
286 "36 ./tests\n" \
287 "12 ./scripts/CVS\n" \
288 "16 ./scripts\n" \
289 "12 ./docs/CVS\n" \
290 "104 ./docs\n" \
291 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000292
Eric Andersen7e9276b2001-02-22 01:15:47 +0000293#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000294 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000295#define dumpkmap_full_usage \
296 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000297#define dumpkmap_example_usage \
298 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000299
Eric Andersen7e9276b2001-02-22 01:15:47 +0000300#define dutmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000301 "[FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000302#define dutmp_full_usage \
303 "Dump utmp file format (pipe delimited) from FILE\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000304 "or stdin to stdout. (i.e. 'dutmp /var/run/utmp')"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000305#define dutmp_example_usage \
306 "$ dutmp /var/run/utmp\n" \
307 "8|7||si|||0|0|0|955637625|760097|0\n" \
308 "2|0|~|~~|reboot||0|0|0|955637625|782235|0\n" \
309 "1|20020|~|~~|runlevel||0|0|0|955637625|800089|0\n" \
310 "8|125||l4|||0|0|0|955637629|998367|0\n" \
311 "6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0\n" \
312 "6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0\n" \
313 "7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000314
Eric Andersen7e9276b2001-02-22 01:15:47 +0000315#define echo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000316 "[-neE] [ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000317#define echo_full_usage \
318 "Prints the specified ARGs to stdout\n\n" \
319 "Options:\n" \
320 "\t-n\tsuppress trailing newline\n" \
321 "\t-e\tinterpret backslash-escaped characters (i.e. \\t=tab etc)\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000322 "\t-E\tdisable interpretation of backslash-escaped characters"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000323#define echo_example_usage \
324 "$ echo "Erik is cool"\n" \
325 "Erik is cool\n" \
326 "$ echo -e "Erik\nis\ncool"\n" \
327 "Erik\n" \
328 "is\n" \
329 "cool\n" \
330 "$ echo "Erik\nis\ncool"\n" \
331 "Erik\nis\ncool\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000332
Eric Andersen7e9276b2001-02-22 01:15:47 +0000333#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000334 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000335#define expr_full_usage \
336 "Prints the value of EXPRESSION to standard output.\n\n" \
337 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000338 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
339 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
340 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
341 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
342 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
343 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
344 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
345 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
346 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
347 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
348 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
349 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
350 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000351 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
352 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
353 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
354 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
355 "\t or 0\n" \
356 "\tlength STRING length of STRING\n" \
357 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
358 "\t it is a keyword like `match' or an\n" \
359 "\t operator like `/'\n" \
360 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000361 "Beware that many operators need to be escaped or quoted for shells.\n" \
362 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
363 "lexicographical. Pattern matches return the string matched between \n" \
364 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
365 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000366
Eric Andersen7e9276b2001-02-22 01:15:47 +0000367#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000368 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000369#define false_full_usage \
370 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000371#define false_example_usage \
372 "$ false\n" \
373 "$ echo $?\n" \
374 "1\n"
375
376#define fbset_trivial_usage \
377 "[options] [mode]"
378#define fbset_full_usage \
379 "Show and modify frame buffer settings"
380#define fbset_example_usage \
381 "$ fbset\n" \
382 "mode "1024x768-76"\n" \
383 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
384 "\tgeometry 1024 768 1024 768 16\n" \
385 "\ttimings 12714 128 32 16 4 128 4\n" \
386 "\taccel false\n" \
387 "\trgba 5/11,6/5,5/0,0/0\n" \
388 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000389
Eric Andersen7e9276b2001-02-22 01:15:47 +0000390#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000391 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000392#define fdflush_full_usage \
393 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000394
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000395#ifdef BB_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000396 #define USAGE_FIND_TYPE(a) a
397#else
398 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000399#endif
400#ifdef BB_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000401 #define USAGE_FIND_PERM(a) a
402#else
403 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000404#endif
405#ifdef BB_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000406 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000407#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000408 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000409#endif
410
Eric Andersen7e9276b2001-02-22 01:15:47 +0000411#define find_trivial_usage \
412 "[PATH...] [EXPRESSION]"
413#define find_full_usage \
414 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000415 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000416 "\nEXPRESSION may consist of:\n" \
417 "\t-follow\t\tDereference symbolic links.\n" \
418 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN." \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000419 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000420 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
421) USAGE_FIND_PERM( \
422 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
423) USAGE_FIND_MTIME( \
424 "\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 +0000425#define find_example_usage \
426 "$ find / -name /etc/passwd\n" \
427 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000428
Eric Andersen7e9276b2001-02-22 01:15:47 +0000429#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000430 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000431#define free_full_usage \
432 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000433#define free_example_usage \
434 "$ free\n" \
435 " total used free shared buffers\n" \
436 " Mem: 257628 248724 8904 59644 93124\n" \
437 " Swap: 128516 8404 120112\n" \
438 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000439
Eric Andersen7e9276b2001-02-22 01:15:47 +0000440#define freeramdisk_trivial_usage \
441 "DEVICE"
442#define freeramdisk_full_usage \
443 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000444#define freeramdisk_example_usage \
445 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000446
447#define fsck_minix_trivial_usage \
448 "[-larvsmf] /dev/name"
449#define fsck_minix_full_usage \
450 "Performs a consistency check for MINIX filesystems.\n\n" \
451 "Options:\n" \
452 "\t-l\tLists all filenames\n" \
453 "\t-r\tPerform interactive repairs\n" \
454 "\t-a\tPerform automatic repairs\n" \
455 "\t-v\tverbose\n" \
456 "\t-s\tOutputs super-block information\n" \
457 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
458 "\t-f\tForce file system check."
459
460#define getopt_trivial_usage \
461 "[OPTIONS]..."
462#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000463 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000464 "\t-a, --alternative Allow long options starting with single -\n" \
465 "\t-l, --longoptions=longopts Long options to be recognized\n" \
466 "\t-n, --name=progname The name under which errors are reported\n" \
467 "\t-o, --options=optstring Short options to be recognized\n" \
468 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
469 "\t-Q, --quiet-output No normal output\n" \
470 "\t-s, --shell=shell Set shell quoting conventions\n" \
471 "\t-T, --test Test for getopt(1) version\n" \
472 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000473#define getopt_example_usage \
474 "$ cat getopt.test\n" \
475 "#!/bin/sh\n" \
476 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
477 " -n 'example.busybox' -- "$@"`\n" \
478 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
479 "eval set -- "$GETOPT"\n" \
480 "while true ; do\n" \
481 " case $1 in\n" \
482 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
483 " -b|--b-long) echo \"Option b, argument \`$2'\" ; shift 2 ;;\n" \
484 " -c|--c-long)\n" \
485 " case "$2" in\n" \
486 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
487 " *) echo \"Option c, argument \`$2'\" ; shift 2 ;;\n" \
488 " esac ;;\n" \
489 " --) shift ; break ;;\n" \
490 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
491 " esac\n" \
492 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000493
494#define grep_trivial_usage \
495 "[-ihHnqvs] pattern [files...]"
496#define grep_full_usage \
497 "Search for PATTERN in each FILE or standard input.\n\n" \
498 "Options:\n" \
499 "\t-H\tprefix output lines with filename where match was found\n" \
500 "\t-h\tsuppress the prefixing filename on output\n" \
501 "\t-i\tignore case distinctions\n" \
502 "\t-n\tprint line number with output lines\n" \
503 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
504 "\t-v\tselect non-matching lines\n" \
505 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000506#define grep_example_usage \
507 "$ grep root /etc/passwd\n" \
508 "root:x:0:0:root:/root:/bin/bash\n" \
509 "$ grep ^[rR]oo. /etc/passwd\n" \
510 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000511
Eric Andersen7e9276b2001-02-22 01:15:47 +0000512#define gunzip_trivial_usage \
513 "[OPTION]... FILE"
514#define gunzip_full_usage \
515 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
516 "Options:\n" \
517 "\t-c\tWrite output to standard output\n" \
518 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000519#define gunzip_example_usage \
520 "$ ls -la /tmp/BusyBox*\n" \
521 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
522 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
523 "$ ls -la /tmp/BusyBox*\n" \
524 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000525
526#define gzip_trivial_usage \
527 "[OPTION]... FILE"
528#define gzip_full_usage \
529 "Compress FILE with maximum compression.\n" \
530 "When FILE is '-', reads standard input. Implies -c.\n\n" \
531 "Options:\n" \
532 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
533 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000534#define gzip_example_usage \
535 "$ ls -la /tmp/BusyBox*\n" \
536 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n" \
537 "$ gzip /tmp/BusyBox-0.43.tar\n" \
538 "$ ls -la /tmp/BusyBox*\n" \
539 "-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 +0000540
541#define halt_trivial_usage \
542 ""
543#define halt_full_usage \
544 "Halt the system."
545
546#define head_trivial_usage \
547 "[OPTION] [FILE]..."
548#define head_full_usage \
549 "Print first 10 lines of each FILE to standard output.\n" \
550 "With more than one FILE, precede each with a header giving the\n" \
551 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000552 "Options:\n" \
553 "\t-n NUM\t\tPrint first NUM lines instead of first 10"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000554#define head_example_usage \
555 "$ head -n 2 /etc/passwd\n" \
556 "root:x:0:0:root:/root:/bin/bash\n" \
557 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000558
559#define hostid_trivial_usage \
560 ""
561#define hostid_full_usage \
562 "Print out a unique 32-bit identifier for the machine."
563
564#define hostname_trivial_usage \
565 "[OPTION] {hostname | -F file}"
566#define hostname_full_usage \
567 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
568 "(or a file with the -F parameter), the host name will be set.\n\n" \
569 "Options:\n" \
570 "\t-s\t\tShort\n" \
571 "\t-i\t\tAddresses for the hostname\n" \
572 "\t-d\t\tDNS domain name\n" \
573 "\t-F, --file FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000574#define hostname_example_usage \
575 "$ hostname\n" \
576 "slag \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000577
578#define id_trivial_usage \
579 "[OPTIONS]... [USERNAME]"
580#define id_full_usage \
581 "Print information for USERNAME or the current user\n\n" \
582 "Options:\n" \
583 "\t-g\tprints only the group ID\n" \
584 "\t-u\tprints only the user ID\n" \
585 "\t-n\tprint a name instead of a number (with for -ug)\n" \
586 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000587#define id_example_usage \
588 "$ id\n" \
589 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000590
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000591#ifdef BB_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +0000592 #define USAGE_SIOCSKEEPALIVE(a) a
593#else
594 #define USAGE_SIOCSKEEPALIVE(a)
595#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000596#ifdef BB_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
597 #define USAGE_IFCONFIG_MII(a) a
598#else
599 #define USAGE_IFCONFIG_MII(a)
600#endif
601#ifdef BB_FEATURE_IFCONFIG_HW
602 #define USAGE_IFCONFIG_HW(a) a
603#else
604 #define USAGE_IFCONFIG_HW(a)
605#endif
606#ifdef BB_FEATURE_IFCONFIG_STATUS
607 #define USAGE_IFCONFIG_OPT_A(a) a
608#else
609 #define USAGE_IFCONFIG_OPT_A(a)
610#endif
611
Eric Andersen7e9276b2001-02-22 01:15:47 +0000612#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000613 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000614#define ifconfig_full_usage \
615 "configure a network interface\n\n" \
616 "Options:\n" \
617 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000618 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000619 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000620 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
621 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000622 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000623 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
624 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000625 "\t[up|down] ..."
626
627#define init_trivial_usage \
628 ""
629#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000630 "Init is the parent of all processes."
631#define init_notes_usage \
632"This version of init is designed to be run only by the kernel.\n" \
633"\n" \
634"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
635"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
636"runlevels, use sysvinit.\n" \
637"\n" \
638"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
639"it has the following default behavior:\n" \
640"\n" \
641" ::sysinit:/etc/init.d/rcS\n" \
642" ::askfirst:/bin/sh\n" \
643"\n" \
644"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
645"\n" \
646" tty2::askfirst:/bin/sh\n" \
647"\n" \
648"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
649"\n" \
650" <id>:<runlevels>:<action>:<process>\n" \
651"\n" \
652" <id>: \n" \
653"\n" \
654" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
655" The id field is used by BusyBox init to specify the controlling tty for\n" \
656" the specified process to run on. The contents of this field are\n" \
657" appended to "/dev/" and used as-is. There is no need for this field to\n" \
658" be unique, although if it isn't you may have strange results. If this\n" \
659" field is left blank, the controlling tty is set to the console. Also\n" \
660" note that if BusyBox detects that a serial console is in use, then only\n" \
661" entries whose controlling tty is either the serial console or /dev/null\n" \
662" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
663" stinkin' utmp.\n" \
664"\n" \
665" <runlevels>: \n" \
666"\n" \
667" The runlevels field is completely ignored.\n" \
668"\n" \
669" <action>: \n" \
670"\n" \
671" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
672" once, and ctrlaltdel.\n" \
673"\n" \
674" The available actions can be classified into two groups: actions\n" \
675" that are run only once, and actions that are re-run when the specified\n" \
676" process exits.\n" \
677"\n" \
678" Run only-once actions:\n" \
679"\n" \
680" 'sysinit' is the first item run on boot. init waits until all\n" \
681" sysinit actions are completed before continuing. Following the\n" \
682" completion of all sysinit actions, all 'wait' actions are run.\n" \
683" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
684" the specified task completes. 'once' actions are asyncronous,\n" \
685" therefore, init does not wait for them to complete. 'ctrlaltdel'\n" \
686" actions are run immediately before init causes the system to reboot\n" \
687" (unmounting filesystems with a 'ctrlaltdel' action is a very good\n" \
688" idea).\n" \
689"\n" \
690" Run repeatedly actions:\n" \
691"\n" \
692" 'respawn' actions are run after the 'once' actions. When a process\n" \
693" started with a 'respawn' action exits, init automatically restarts\n" \
694" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
695" respawning out of control. The 'askfirst' actions acts just like\n" \
696" respawn, except that before running the specified process it\n" \
697" displays the line "Please press Enter to activate this console."\n" \
698" and then waits for the user to press enter before starting the\n" \
699" specified process. \n" \
700"\n" \
701" Unrecognized actions (like initdefault) will cause init to emit an\n" \
702" error message, and then go along with its business. All actions are\n" \
703" run in the reverse order from how they appear in /etc/inittab.\n" \
704"\n" \
705" <process>: \n" \
706"\n" \
707" Specifies the process to be executed and it's command line.\n" \
708"\n" \
709"Example /etc/inittab file:\n" \
710" # This is run first except when booting in single-user mode.\n" \
711" #\n" \
712" ::sysinit:/etc/init.d/rcS\n" \
713" \n" \
714" # /bin/sh invocations on selected ttys\n" \
715" #\n" \
716" # Start an "askfirst" shell on the console (whatever that may be)\n" \
717" ::askfirst:-/bin/sh\n" \
718" # Start an "askfirst" shell on /dev/tty2-4\n" \
719" tty2::askfirst:-/bin/sh\n" \
720" tty3::askfirst:-/bin/sh\n" \
721" tty4::askfirst:-/bin/sh\n" \
722" \n" \
723" # /sbin/getty invocations for selected ttys\n" \
724" #\n" \
725" tty4::respawn:/sbin/getty 38400 tty5\n" \
726" tty5::respawn:/sbin/getty 38400 tty6\n" \
727" \n" \
728" \n" \
729" # Example of how to put a getty on a serial line (for a terminal)\n" \
730" #\n" \
731" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
732" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
733" #\n" \
734" # Example how to put a getty on a modem line.\n" \
735" #::respawn:/sbin/getty 57600 ttyS2\n" \
736" \n" \
737" # Stuff to do before rebooting\n" \
738" ::ctrlaltdel:/bin/umount -a -r\n" \
739" ::ctrlaltdel:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000740
741#define insmod_trivial_usage \
742 "[OPTION]... MODULE [symbol=value]..."
743#define insmod_full_usage \
744 "Loads the specified kernel modules into the kernel.\n\n" \
745 "Options:\n" \
746 "\t-f\tForce module to load into the wrong kernel version.\n" \
747 "\t-k\tMake module autoclean-able.\n" \
748 "\t-v\tverbose output\n" \
749 "\t-L\tLock to prevent simultaneous loads of a module\n" \
750 "\t-x\tdo not export externs"
751
752#define kill_trivial_usage \
753 "[-signal] process-id [process-id ...]"
754#define kill_full_usage \
755 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +0000756 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000757 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000758#define kill_example_usage \
759 "$ ps | grep apache\n" \
760 "252 root root S [apache]\n" \
761 "263 www-data www-data S [apache]\n" \
762 "264 www-data www-data S [apache]\n" \
763 "265 www-data www-data S [apache]\n" \
764 "266 www-data www-data S [apache]\n" \
765 "267 www-data www-data S [apache]\n" \
766 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000767
768#define killall_trivial_usage \
769 "[-signal] process-name [process-name ...]"
770#define killall_full_usage \
771 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000772 "Options:\n" \
773 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000774#define killall_example_usage \
775 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000776
Mark Whitley6317c4b2001-03-12 22:51:50 +0000777#define klogd_trivial_usage \
778 "-n"
779#define klogd_full_usage \
780 "Kernel logger.\n"\
781 "Options:\n"\
782 "\t-n\tRun as a foreground process."
783
Eric Andersen7e9276b2001-02-22 01:15:47 +0000784#define length_trivial_usage \
785 "STRING"
786#define length_full_usage \
787 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000788#define length_example_usage \
789 "$ length "Hello"\n" \
790 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000791
792#define ln_trivial_usage \
793 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
794#define ln_full_usage \
795 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
796 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
797 "Options:\n" \
798 "\t-s\tmake symbolic links instead of hard links\n" \
799 "\t-f\tremove existing destination files\n" \
800 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000801#define ln_example_usage \
802 "$ ln -s BusyBox /tmp/ls\n" \
803 "$ ls -l /tmp/ls\n" \
804 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000805
806#define loadacm_trivial_usage \
807 "< mapfile"
808#define loadacm_full_usage \
809 "Loads an acm from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000810#define loadacm_example_usage \
811 "$ loadacm < /etc/i18n/acmname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000812
813#define loadfont_trivial_usage \
814 "< font"
815#define loadfont_full_usage \
816 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000817#define loadfont_example_usage \
818 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000819
820#define loadkmap_trivial_usage \
821 "< keymap"
822#define loadkmap_full_usage \
823 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000824#define loadkmap_example_usage \
825 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000826
827#define logger_trivial_usage \
828 "[OPTION]... [MESSAGE]"
829#define logger_full_usage \
830 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
831 "Options:\n" \
832 "\t-s\tLog to stderr as well as the system log.\n" \
833 "\t-t\tLog using the specified tag (defaults to user name).\n" \
834 "\t-p\tEnter the message with the specified priority.\n" \
835 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000836#define logger_example_usage \
837 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000838
839#define logname_trivial_usage \
840 ""
841#define logname_full_usage \
842 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000843#define logname_example_usage \
844 "$ logname\n" \
845 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000846
Mark Whitley6317c4b2001-03-12 22:51:50 +0000847#define logread_trivial_usage \
848 ""
849
850#define logread_full_usage \
851 "Shows the messages from syslogd (using circular buffer)."
852
Eric Andersen7e9276b2001-02-22 01:15:47 +0000853#ifdef BB_FEATURE_LS_TIMESTAMPS
854 #define USAGE_LS_TIMESTAMPS(a) a
855#else
856 #define USAGE_LS_TIMESTAMPS(a)
857#endif
858#ifdef BB_FEATURE_LS_FILETYPES
859 #define USAGE_LS_FILETYPES(a) a
860#else
861 #define USAGE_LS_FILETYPES(a)
862#endif
863#ifdef BB_FEATURE_LS_FOLLOWLINKS
864 #define USAGE_LS_FOLLOWLINKS(a) a
865#else
866 #define USAGE_LS_FOLLOWLINKS(a)
867#endif
868#ifdef BB_FEATURE_LS_RECURSIVE
869 #define USAGE_LS_RECURSIVE(a) a
870#else
871 #define USAGE_LS_RECURSIVE(a)
872#endif
873#ifdef BB_FEATURE_LS_SORTFILES
874 #define USAGE_LS_SORTFILES(a) a
875#else
876 #define USAGE_LS_SORTFILES(a)
877#endif
878#ifdef BB_FEATURE_AUTOWIDTH
879 #define USAGE_AUTOWIDTH(a) a
880#else
881 #define USAGE_AUTOWIDTH(a)
882#endif
883#define ls_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +0000884 "[-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 +0000885#define ls_full_usage \
886 "List directory contents\n\n" \
887 "Options:\n" \
888 "\t-1\tlist files in a single column\n" \
889 "\t-A\tdo not list implied . and ..\n" \
890 "\t-a\tdo not hide entries starting with .\n" \
891 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000892 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000893 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000894 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
895 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000896 "\t-i\tlist the i-node for each file\n" \
897 "\t-l\tuse a long listing format\n" \
898 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000899 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
900 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
901 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
902 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
903 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000904 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000905 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
906 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
907 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
908 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
909 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000910 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000911 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
912 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000913 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000914 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000915 "\t-k\tprint sizes in kilobytes(compatability)")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000916
917#define lsmod_trivial_usage \
918 ""
919#define lsmod_full_usage \
920 "List the currently loaded kernel modules."
921
922#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000923 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000924#define makedevs_full_usage \
925 "Creates a range of block or character special files\n\n" \
926 "TYPEs include:\n" \
927 "\tb:\tMake a block (buffered) device.\n" \
928 "\tc or u:\tMake a character (un-buffered) device.\n" \
929 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
930 "FIRST specifies the number appended to NAME to create the first device.\n" \
931 "LAST specifies the number of the last item that should be created.\n" \
932 "If 's' is the last argument, the base device is created as well.\n\n" \
933 "For example:\n" \
934 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000935 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000936#define makedevs_example_usage \
937 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
938 "[creates ttyS2-ttyS63]\n" \
939 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
940 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000941
Eric Andersen7e9276b2001-02-22 01:15:47 +0000942#define md5sum_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000943 "[OPTION] [FILE]...\n" \
944 "or: md5sum [OPTION] -c [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000945#define md5sum_full_usage \
946 "Print or check MD5 checksums.\n\n" \
947 "Options:\n" \
948 "With no FILE, or when FILE is -, read standard input.\n\n" \
949 "\t-b\tread files in binary mode\n" \
950 "\t-c\tcheck MD5 sums against given list\n" \
951 "\t-t\tread files in text mode (default)\n" \
952 "\t-g\tread a string\n" \
953 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000954 "\t-s\tdon't output anything, status code shows success\n" \
955 "\t-w\twarn about improperly formated MD5 checksum lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000956#define md5sum_example_usage \
957 "$ md5sum < busybox\n" \
958 "6fd11e98b98a58f64ff3398d7b324003\n" \
959 "$ md5sum busybox\n" \
960 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
961 "$ md5sum -c -\n" \
962 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
963 "busybox: OK\n" \
964 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000965
Eric Andersen7e9276b2001-02-22 01:15:47 +0000966#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000967 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000968#define mkdir_full_usage \
969 "Create the DIRECTORY(ies), if they do not already exist\n\n" \
970 "Options:\n" \
971 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000972 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000973#define mkdir_example_usage \
974 "$ mkdir /tmp/foo\n" \
975 "$ mkdir /tmp/foo\n" \
976 "/tmp/foo: File exists\n" \
977 "$ mkdir /tmp/foo/bar/baz\n" \
978 "/tmp/foo/bar/baz: No such file or directory\n" \
979 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000980
Eric Andersen7e9276b2001-02-22 01:15:47 +0000981#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000982 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000983#define mkfifo_full_usage \
984 "Creates a named pipe (identical to 'mknod name p')\n\n" \
985 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000986 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000987
Eric Andersen7e9276b2001-02-22 01:15:47 +0000988#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000989 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000990#define mkfs_minix_full_usage \
991 "Make a MINIX filesystem.\n\n" \
992 "Options:\n" \
993 "\t-c\t\tCheck the device for bad blocks\n" \
994 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
995 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
996 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000997 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000998
Eric Andersen7e9276b2001-02-22 01:15:47 +0000999#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001000 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001001#define mknod_full_usage \
1002 "Create a special file (block, character, or pipe).\n\n" \
1003 "Options:\n" \
1004 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1005 "TYPEs include:\n" \
1006 "\tb:\tMake a block (buffered) device.\n" \
1007 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001008 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001009#define mknod_example_usage \
1010 "$ mknod /dev/fd0 b 2 0 \n" \
1011 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001012
Eric Andersen7e9276b2001-02-22 01:15:47 +00001013#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001014 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001015#define mkswap_full_usage \
1016 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001017 "Options:\n" \
1018 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001019 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001020 "\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 +00001021 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001022
Eric Andersen7e9276b2001-02-22 01:15:47 +00001023#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001024 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001025#define mktemp_full_usage \
1026 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001027 "TEMPLATE is any name with six `Xs' (i.e. /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001028#define mktemp_example_usage \
1029 "$ mktemp /tmp/temp.XXXXXX\n" \
1030 "/tmp/temp.mWiLjM\n" \
1031 "$ ls -la /tmp/temp.mWiLjM\n" \
1032 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001033
Eric Andersen7e9276b2001-02-22 01:15:47 +00001034#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001035 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001036#define more_full_usage \
1037 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001038#define more_example_usage \
1039 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001040
Eric Andersen7e9276b2001-02-22 01:15:47 +00001041#ifdef BB_FEATURE_MOUNT_LOOP
1042 #define USAGE_MOUNT_LOOP(a) a
1043#else
1044 #define USAGE_MOUNT_LOOP(a)
1045#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001046#ifdef BB_MTAB
Eric Andersen7e9276b2001-02-22 01:15:47 +00001047 #define USAGE_MTAB(a) a
1048#else
1049 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001050#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001051#define mount_trivial_usage \
1052 "[flags] device directory [-o options,more-options]"
1053#define mount_full_usage \
1054 "Mount a filesystem\n\n" \
1055 "Flags:\n" \
1056 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001057 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001058 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001059 "\t-n:\t\tDon't write a mount table entry.\n" \
1060 ) \
1061 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1062 "\t-r:\t\tMount the filesystem read-only.\n" \
1063 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1064 "\t-w:\t\tMount for reading and writing (default).\n" \
1065 "\n" \
1066 "Options for use with the \"-o\" flag:\n" \
1067 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1068 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1069 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1070 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001071 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001072 "\tloop:\t\tMounts a file via loop device.\n" \
1073 ) \
1074 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001075 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001076 "\tro/rw:\t\tMount for read-only / read-write.\n" \
1077 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001078 "You'll have to see the written documentation for those."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001079#define mount_example_usage \
1080 "$ mount\n" \
1081 "/dev/hda3 on / type minix (rw)\n" \
1082 "proc on /proc type proc (rw)\n" \
1083 "devpts on /dev/pts type devpts (rw)\n" \
1084 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1085 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001086
Eric Andersen7e9276b2001-02-22 01:15:47 +00001087#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001088 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001089#define mt_full_usage \
1090 "Control magnetic tape drive operation\n" \
1091 "\nAvailable Opcodes:\n\n" \
1092 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1093 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
1094 "ras3 reset retension rew rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001095 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001096
Eric Andersen7e9276b2001-02-22 01:15:47 +00001097#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001098 "SOURCE DEST\n" \
1099 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001100#define mv_full_usage \
1101 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001102#define mv_example_usage \
1103 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001104
Eric Andersen7e9276b2001-02-22 01:15:47 +00001105#define nc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001106 "[IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001107#define nc_full_usage \
1108 "Netcat opens a pipe to IP:port"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001109#define nc_example_usage \
1110 "$ nc foobar.somedomain.com 25\n" \
1111 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1112 "help\n" \
1113 "214-Commands supported:\n" \
1114 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1115 "214 NOOP QUIT RSET HELP\n" \
1116 "quit\n" \
1117 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001118
Eric Andersen7e9276b2001-02-22 01:15:47 +00001119#define nslookup_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001120 "[HOST]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001121#define nslookup_full_usage \
1122 "Queries the nameserver for the IP address of the given HOST"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001123#define nslookup_example_usage \
1124 "$ nslookup localhost\n" \
1125 "Server: default\n" \
1126 "Address: default\n" \
1127 "\n" \
1128 "Name: debian\n" \
1129 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001130
Eric Andersen7e9276b2001-02-22 01:15:47 +00001131#ifdef BB_FEATURE_SIMPLE_PING
1132#define ping_trivial_usage "host"
1133#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1134#else
1135#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001136 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001137#define ping_full_usage \
1138 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1139 "Options:\n" \
1140 "\t-c COUNT\tSend only COUNT pings.\n" \
1141 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1142 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001143 "\t\t\tand when finished."
1144#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001145#define ping_example_usage \
1146 "$ ping localhost\n" \
1147 "PING slag (127.0.0.1): 56 data bytes\n" \
1148 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1149 "\n" \
1150 "--- debian ping statistics ---\n" \
1151 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1152 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001153
Eric Andersen7e9276b2001-02-22 01:15:47 +00001154#define pivot_root_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001155 "new_root put_old"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001156#define pivot_root_full_usage \
1157 "Move the current root file system to put_old and make new_root\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001158 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001159
Eric Andersen7e9276b2001-02-22 01:15:47 +00001160#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001161 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001162#define poweroff_full_usage \
1163 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001164
Eric Andersen7e9276b2001-02-22 01:15:47 +00001165#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001166 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001167#define printf_full_usage \
1168 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001169 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001170#define printf_example_usage \
1171 "$ printf "Val=%d\n" 5\n" \
1172 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001173
Eric Andersen7e9276b2001-02-22 01:15:47 +00001174#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001175 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001176#define ps_full_usage \
1177 "Report process status\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001178 "\nThis version of ps accepts no options."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001179#define ps_example_usage \
1180 "$ ps\n" \
1181 " PID Uid Gid State Command\n" \
1182 " 1 root root S init\n" \
1183 " 2 root root S [kflushd]\n" \
1184 " 3 root root S [kupdate]\n" \
1185 " 4 root root S [kpiod]\n" \
1186 " 5 root root S [kswapd]\n" \
1187 " 742 andersen andersen S [bash]\n" \
1188 " 743 andersen andersen S -bash\n" \
1189 " 745 root root S [getty]\n" \
1190 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001191
Eric Andersen7e9276b2001-02-22 01:15:47 +00001192#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001193 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001194#define pwd_full_usage \
1195 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001196#define pwd_example_usage \
1197 "$ pwd\n" \
1198 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001199
Eric Andersen7e9276b2001-02-22 01:15:47 +00001200#define rdate_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001201 "[OPTION] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001202#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001203 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001204 "Options:\n" \
1205 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001206 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001207
Eric Andersen7e9276b2001-02-22 01:15:47 +00001208#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001209 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001210#define readlink_full_usage \
1211 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001212
Eric Andersen7e9276b2001-02-22 01:15:47 +00001213#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001214 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001215#define reboot_full_usage \
1216 "Reboot the system."
1217
1218#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001219 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001220#define renice_full_usage \
1221 "Changes priority of running processes. Allowed priorities range\n" \
1222 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001223 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001224
Eric Andersen7e9276b2001-02-22 01:15:47 +00001225#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001226 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001227#define reset_full_usage \
1228 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001229
Mark Whitleye0bf91d2001-03-13 00:40:19 +00001230#ifdef BB_FEATURE_RM_INTERACTIVE
1231 #define USAGE_RM_INTERACTIVE(a) a
1232#else
1233 #define USAGE_RM_INTERACTIVE(a)
1234#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001235#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001236 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001237#define rm_full_usage \
1238 "Remove (unlink) the FILE(s). You may use '--' to\n" \
1239 "indicate that all following arguments are non-options.\n\n" \
1240 "Options:\n" \
Mark Whitleye0bf91d2001-03-13 00:40:19 +00001241 USAGE_RM_INTERACTIVE("\t-i\t\talways prompt before removing each destinations\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001242 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001243 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001244#define rm_example_usage \
1245 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001246
Eric Andersen7e9276b2001-02-22 01:15:47 +00001247#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001248 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001249#define rmdir_full_usage \
1250 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001251#define rmdir_example_usage \
1252 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001253
Eric Andersen7e9276b2001-02-22 01:15:47 +00001254#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001255 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001256#define rmmod_full_usage \
1257 "Unloads the specified kernel modules from the kernel.\n\n" \
1258 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001259 "\t-a\tTry to remove all unused kernel modules."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001260#define rmmod_example_usage \
1261 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001262
Eric Andersen7e9276b2001-02-22 01:15:47 +00001263#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001264 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001265#define route_full_usage \
1266 "Edit the kernel's routing tables"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001267
Eric Andersen7e9276b2001-02-22 01:15:47 +00001268#define rpmunpack_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001269 "< package.rpm | gunzip | cpio -idmuv"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001270#define rpmunpack_full_usage \
1271 "Extracts an rpm archive."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001272
Eric Andersen7e9276b2001-02-22 01:15:47 +00001273#define sed_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001274 "[-Vhnef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001275#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001276 "Options:\n" \
1277 "\t-n\t\tsuppress automatic printing of pattern space\n" \
1278 "\t-e script\tadd the script to the commands to be executed\n" \
1279 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
1280 "\t-h\t\tdisplay this help message\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001281 "\n" \
1282 "If no -e or -f is given, the first non-option argument is taken as the\n" \
1283 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001284 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001285#define sed_example_usage \
1286 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
1287 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001288
Eric Andersen7e9276b2001-02-22 01:15:47 +00001289#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001290 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001291#define setkeycodes_full_usage \
1292 "Set entries into the kernel's scancode-to-keycode map,\n" \
1293 "allowing unusual keyboards to generate usable keycodes.\n\n" \
1294 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001295 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001296#define setkeycodes_example_usage \
1297 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001298
Eric Andersen7e9276b2001-02-22 01:15:47 +00001299#define sh_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001300 "[FILE]...\n" \
1301 "or: sh -c command [args]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001302#define sh_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001303 "lash: The BusyBox LAme SHell (command interpreter)"
1304#define sh_notes_usage \
1305"This command does not yet have proper documentation.\n" \
1306"\n" \
1307"Use lash just as you would use any other shell. It properly handles pipes,\n" \
1308"redirects, job control, can be used as the shell for scripts, and has a\n" \
1309"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
1310"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
1311"use ash or bash. If you just need a very simple and extremely small shell,\n" \
1312"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001313
Eric Andersen7e9276b2001-02-22 01:15:47 +00001314#define sleep_trivial_usage \
1315 "N"
1316#define sleep_full_usage \
1317 "Pause for N seconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001318#define sleep_example_usage \
1319 "$ sleep 2\n" \
1320 "[2 second delay results]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001321
Eric Andersen7e9276b2001-02-22 01:15:47 +00001322
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001323#ifdef BB_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001324 #define USAGE_SORT_REVERSE(a) a
1325#else
1326 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001327#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001328#define sort_trivial_usage \
1329 "[-n]" USAGE_SORT_REVERSE(" [-r]") " [FILE]..."
1330#define sort_full_usage \
1331 "Sorts lines of text in the specified files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001332#define sort_example_usage \
1333 "$ echo -e "e\nf\nb\nd\nc\na" | sort\n" \
1334 "a\n" \
1335 "b\n" \
1336 "c\n" \
1337 "d\n" \
1338 "e\n" \
1339 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001340
Eric Andersen7e9276b2001-02-22 01:15:47 +00001341#define stty_trivial_usage \
1342 "[-a|g] [-F device] [SETTING]..."
1343#define stty_full_usage \
1344 "Without arguments, prints baud rate, line discipline," \
1345 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001346 "\n\nOptions:" \
1347 "\n\t-F device\topen device instead of stdin" \
1348 "\n\t-a\t\tprint all current settings in human-readable form" \
1349 "\n\t-g\t\tprint in stty-readable form" \
1350 "\n\t[SETTING]\tsee documentation"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001351
Eric Andersen7e9276b2001-02-22 01:15:47 +00001352#define swapoff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001353 "[OPTION] [device]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001354#define swapoff_full_usage \
1355 "Stop swapping virtual memory pages on the given device.\n\n" \
1356 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001357 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001358
Eric Andersen7e9276b2001-02-22 01:15:47 +00001359#define swapon_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001360 "[OPTION] [device]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001361#define swapon_full_usage \
1362 "Start swapping virtual memory pages on the given device.\n\n" \
1363 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001364 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001365
Eric Andersen7e9276b2001-02-22 01:15:47 +00001366#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001367 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001368#define sync_full_usage \
1369 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001370
Eric Andersen7e9276b2001-02-22 01:15:47 +00001371
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001372#ifdef BB_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00001373 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001374#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00001375 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001376#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001377#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001378 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001379#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00001380 "Linux system and kernel logging utility.\n" \
1381 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001382 "Options:\n" \
1383 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
1384 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001385 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001386 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00001387 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
1388 "\t-L\t\tLog locally and via network logging (default is network only)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001389#define syslogd_example_usage \
1390 "$ syslogd -R masterlog:514\n" \
1391 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001392
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001393
Eric Andersen7e9276b2001-02-22 01:15:47 +00001394#ifdef BB_FEATURE_SIMPLE_TAIL
1395 #define USAGE_UNSIMPLE_TAIL(a)
1396#else
1397 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001398#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001399#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001400 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001401#define tail_full_usage \
1402 "Print last 10 lines of each FILE to standard output.\n" \
1403 "With more than one FILE, precede each with a header giving the\n" \
1404 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
1405 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001406 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001407 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
1408 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001409 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001410 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
1411 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001412 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001413 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001414 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
1415#define tail_example_usage \
1416 "$ tail -n 1 /etc/resolv.conf\n" \
1417 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001418
Eric Andersen7e9276b2001-02-22 01:15:47 +00001419#ifdef BB_FEATURE_TAR_CREATE
1420 #define USAGE_TAR_CREATE(a) a
1421#else
1422 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001423#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001424#ifdef BB_FEATURE_TAR_EXCLUDE
1425 #define USAGE_TAR_EXCLUDE(a) a
1426#else
1427 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001428#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001429#define tar_trivial_usage \
1430 "-[" USAGE_TAR_CREATE("c") "xtvO] " \
1431 USAGE_TAR_EXCLUDE("[--exclude File] [-X File]") \
1432 "[-f tarFile] [FILE(s)] ..."
1433#define tar_full_usage \
1434 "Create, extract, or list files from a tar file.\n\n" \
1435 "Main operation mode:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001436 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001437 "\tx\t\textract\n" \
1438 "\tt\t\tlist\n" \
1439 "\nFile selection:\n" \
1440 "\tf\t\tname of tarfile or \"-\" for stdin\n" \
1441 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001442 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001443 "\texclude\t\tfile to exclude\n" \
1444 "\tX\t\tfile with names to exclude\n" \
1445 ) \
1446 "\nInformative output:\n" \
1447 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001448#define tar_example_usage \
1449 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
1450 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001451
Eric Andersen7e9276b2001-02-22 01:15:47 +00001452#define tee_trivial_usage \
1453 "[OPTION]... [FILE]..."
1454#define tee_full_usage \
1455 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001456 "Options:\n" \
1457 "\t-a\tappend to the given FILEs, do not overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001458#define tee_example_usage \
1459 "$ echo "Hello" | tee /tmp/foo\n" \
1460 "$ cat /tmp/foo\n" \
1461 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001462
Eric Andersen7e9276b2001-02-22 01:15:47 +00001463#define telnet_trivial_usage \
1464 "host [port]"
1465#define telnet_full_usage \
1466 "Telnet is used to establish interactive communication with another\n"\
1467 "computer over a network using the TELNET protocol."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001468
Eric Andersen7e9276b2001-02-22 01:15:47 +00001469#define test_trivial_usage \
1470 "EXPRESSION\n or [ EXPRESSION ]"
1471#define test_full_usage \
1472 "Checks file types and compares values returning an exit\n" \
1473 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001474#define test_example_usage \
1475 "$ test 1 -eq 2\n" \
1476 "$ echo $?\n" \
1477 "1\n" \
1478 "$ test 1 -eq 1\n" \
1479 "$ echo $? \n" \
1480 "0\n" \
1481 "$ [ -d /etc ]\n" \
1482 "$ echo $?\n" \
1483 "0\n" \
1484 "$ [ -d /junk ]\n" \
1485 "$ echo $?\n" \
1486 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001487
Mark Whitley450736c2001-03-02 19:08:50 +00001488#ifdef BB_FEATURE_TFTP_GET
1489 #define USAGE_TFTP_GET(a) a
1490#else
1491 #define USAGE_TFTP_GET(a)
1492#endif
1493#ifdef BB_FEATURE_TFTP_PUT
1494 #define USAGE_TFTP_PUT(a) a
1495#else
1496 #define USAGE_TFTP_PUT(a)
1497#endif
1498
1499#define tftp_trivial_usage \
1500 "command SOURCE DEST"
1501#define tftp_full_usage \
1502 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
1503 "Commands:\n" \
1504 USAGE_TFTP_GET( \
1505 "\tget\tGet file from server SOURCE and store to local DEST.\n" \
1506 ) \
1507 USAGE_TFTP_PUT( \
1508 "\tput\tPut local file SOURCE to server DEST.\n" \
1509 ) \
1510 "\nWhen nameing a server, use the syntax \"server:file\"."
1511
Eric Andersen7e9276b2001-02-22 01:15:47 +00001512#define touch_trivial_usage \
1513 "[-c] file [file ...]"
1514#define touch_full_usage \
1515 "Update the last-modified date on the given file[s].\n\n" \
1516 "Options:\n" \
1517 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001518#define touch_example_usage \
1519 "$ ls -l /tmp/foo\n" \
1520 "/bin/ls: /tmp/foo: No such file or directory\n" \
1521 "$ touch /tmp/foo\n" \
1522 "$ ls -l /tmp/foo\n" \
1523 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001524
1525#define tr_trivial_usage \
1526 "[-cds] STRING1 [STRING2]"
1527#define tr_full_usage \
1528 "Translate, squeeze, and/or delete characters from\n" \
1529 "standard input, writing to standard output.\n\n" \
1530 "Options:\n" \
1531 "\t-c\ttake complement of STRING1\n" \
1532 "\t-d\tdelete input characters coded STRING1\n" \
1533 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001534#define tr_example_usage \
1535 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
1536 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001537
1538#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001539 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001540#define true_full_usage \
1541 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001542#define true_example_usage \
1543 "$ true\n" \
1544 "$ echo $?\n" \
1545 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001546
Eric Andersen7e9276b2001-02-22 01:15:47 +00001547#define tty_trivial_usage \
1548 ""
1549#define tty_full_usage \
1550 "Print the file name of the terminal connected to standard input.\n\n"\
1551 "Options:\n" \
1552 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001553#define tty_example_usage \
1554 "$ tty\n" \
1555 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001556
Eric Andersen7e9276b2001-02-22 01:15:47 +00001557#ifdef BB_FEATURE_MOUNT_FORCE
1558 #define USAGE_MOUNT_FORCE(a) a
1559#else
1560 #define USAGE_MOUNT_FORCE(a)
1561#endif
1562#define umount_trivial_usage \
1563 "[flags] filesystem|directory"
1564#define umount_full_usage \
1565 "Unmount file systems\n" \
1566 "\nFlags:\n" "\t-a:\tUnmount all file systems" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001567 USAGE_MTAB(" in /etc/mtab\n\t-n:\tDon't erase /etc/mtab entries") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001568 "\n\t-r:\tTry to remount devices as read-only if mount is busy" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001569 USAGE_MOUNT_FORCE("\n\t-f:\tForce filesystem umount (i.e. unreachable NFS server)") \
1570 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 +00001571#define umount_example_usage \
1572 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001573
1574#define uname_trivial_usage \
1575 "[OPTION]..."
1576#define uname_full_usage \
1577 "Print certain system information. With no OPTION, same as -s.\n\n" \
1578 "Options:\n" \
1579 "\t-a\tprint all information\n" \
1580 "\t-m\tthe machine (hardware) type\n" \
1581 "\t-n\tprint the machine's network node hostname\n" \
1582 "\t-r\tprint the operating system release\n" \
1583 "\t-s\tprint the operating system name\n" \
1584 "\t-p\tprint the host processor type\n" \
1585 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001586#define uname_example_usage \
1587 "$ uname -a\n" \
1588 "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001589
1590#define uniq_trivial_usage \
1591 "[OPTION]... [INPUT [OUTPUT]]"
1592#define uniq_full_usage \
1593 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001594 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001595 "Options:\n" \
1596 "\t-c\tprefix lines by the number of occurrences\n" \
1597 "\t-d\tonly print duplicate lines\n" \
1598 "\t-u\tonly print unique lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001599#define uniq_example_usage \
1600 "$ echo -e "a\na\nb\nc\nc\na" | sort | uniq\n" \
1601 "a\n" \
1602 "b\n" \
1603 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001604
1605#define unix2dos_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001606 "[option] [file]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001607#define unix2dos_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001608 "See 'dos2unix --help' for help!"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001609
1610#define update_trivial_usage \
1611 "[options]"
1612#define update_full_usage \
1613 "Periodically flushes filesystem buffers.\n\n" \
1614 "Options:\n" \
1615 "\t-S\tforce use of sync(2) instead of flushing\n" \
1616 "\t-s SECS\tcall sync this often (default 30)\n" \
1617 "\t-f SECS\tflush some buffers this often (default 5)"
1618
1619#define uptime_trivial_usage \
1620 ""
1621#define uptime_full_usage \
1622 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001623#define uptime_example_usage \
1624 "$ uptime\n" \
1625 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001626
1627#define usleep_trivial_usage \
1628 "N"
1629#define usleep_full_usage \
1630 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001631#define usleep_example_usage \
1632 "$ usleep 1000000\n" \
1633 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001634
1635#define uudecode_trivial_usage \
1636 "[FILE]..."
1637#define uudecode_full_usage \
1638 "Uudecode a file that is uuencoded.\n\n" \
1639 "Options:\n" \
1640 "\t-o FILE\tdirect output to FILE" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001641#define uudecode_example_usage \
1642 "$ uudecode -o busybox busybox.uu\n" \
1643 "$ ls -l busybox\n" \
1644 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001645
1646#define uuencode_trivial_usage \
1647 "[OPTION] [INFILE] REMOTEFILE"
1648#define uuencode_full_usage \
1649 "Uuencode a file.\n\n" \
1650 "Options:\n" \
1651 "\t-m\tuse base64 encoding as of RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001652#define uuencode_example_usage \
1653 "$ uuencode busybox busybox\n" \
1654 "begin 755 busybox\n" \
1655 "<encoded file snipped>\n" \
1656 "$ uudecode busybox busybox > busybox.uu\n" \
1657 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001658
1659#define watchdog_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001660 "DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001661#define watchdog_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001662 "Periodically write to watchdog device DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001663
1664#define wc_trivial_usage \
1665 "[OPTION]... [FILE]..."
1666#define wc_full_usage \
1667 "Print line, word, and byte counts for each FILE, and a total line if\n" \
1668 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
1669 "Options:\n" \
1670 "\t-c\tprint the byte counts\n" \
1671 "\t-l\tprint the newline counts\n" \
1672 "\t-L\tprint the length of the longest line\n" \
1673 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001674#define wc_example_usage \
1675 "$ wc /etc/passwd\n" \
1676 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001677
1678#define wget_trivial_usage \
1679 "[-c] [-O file] url"
1680#define wget_full_usage \
1681 "wget retrieves files via HTTP\n\n" \
1682 "Options:\n" \
1683 "\t-c\tcontinue retrieval of aborted transfers\n" \
1684 "\t-O\tsave to filename ('-' for stdout)"
1685
1686#define which_trivial_usage \
1687 "[COMMAND ...]"
1688#define which_full_usage \
1689 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001690#define which_example_usage \
1691 "$ which login\n" \
1692 "/bin/login\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001693
1694#define whoami_trivial_usage \
1695 ""
1696#define whoami_full_usage \
1697 "Prints the user name associated with the current effective user id."
1698
1699#define xargs_trivial_usage \
1700 "[COMMAND] [ARGS...]"
1701#define xargs_full_usage \
1702 "Executes COMMAND on every item given by standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001703#define xargs_example_usage \
1704 "$ ls | xargs gzip\n" \
1705 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001706
1707#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001708 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001709#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001710 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001711
Eric Andersen7e9276b2001-02-22 01:15:47 +00001712#define zcat_trivial_usage \
1713 "FILE"
1714#define zcat_full_usage \
1715 "Uncompress to stdout."