blob: 51a06b9774381563d53df798b5df1aedb7559120 [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 \
Glenn L McGrath62ebe2e2001-06-03 05:41:59 +000015 "-[ov][ptx] ARCHIVE FILES"
Eric Andersen7e9276b2001-02-22 01:15:47 +000016#define ar_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +000017 "Extract or list FILES from an ar archive.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +000018 "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" \
Glenn L McGrathcda5cf12001-06-03 05:15:04 +000023 "\t-v\t\tverbosely list files processed\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000024
Eric Andersen7e9276b2001-02-22 01:15:47 +000025#define basename_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000026 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000027#define basename_full_usage \
28 "Strips directory path and suffixes from FILE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000029 "If specified, also removes any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000030#define basename_example_usage \
31 "$ basename /usr/local/bin/foo\n" \
32 "foo\n" \
33 "$ basename /usr/local/bin/\n" \
34 "bin\n" \
35 "$ basename /foo/bar.txt .txt\n" \
36 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000037
Eric Andersen7e9276b2001-02-22 01:15:47 +000038#define cat_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000039 "[FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000040#define cat_full_usage \
41 "Concatenates FILE(s) and prints them to stdout."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000042#define cat_example_usage \
43 "$ cat /proc/uptime\n" \
44 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000045
Eric Andersen7e9276b2001-02-22 01:15:47 +000046#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000047 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000048#define chgrp_full_usage \
49 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000050 "\nOptions:\n" \
51 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000052#define chgrp_example_usage \
53 "$ ls -l /tmp/foo\n" \
54 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
55 "$ chgrp root /tmp/foo\n" \
56 "$ ls -l /tmp/foo\n" \
57 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000058
Eric Andersen7e9276b2001-02-22 01:15:47 +000059#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000060 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000061#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000062 "Each MODE is one or more of the letters ugoa, one of the\n" \
63 "symbols +-= and one or more of the letters rwxst.\n\n" \
64 "Options:\n" \
65 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000066#define chmod_example_usage \
67 "$ ls -l /tmp/foo\n" \
68 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
69 "$ chmod u+x /tmp/foo\n" \
70 "$ ls -l /tmp/foo\n" \
71 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
72 "$ chmod 444 /tmp/foo\n" \
73 "$ ls -l /tmp/foo\n" \
74 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000075
Eric Andersen7e9276b2001-02-22 01:15:47 +000076#define chown_trivial_usage \
Eric Andersen238da242001-05-11 16:31:46 +000077 "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000078#define chown_full_usage \
79 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000080 "\nOptions:\n" \
Eric Andersen238da242001-05-11 16:31:46 +000081 "\t-R\tChanges files and directories recursively.\n" \
82 "\t-h\tDo not dereference symbolic links."
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 \
Mark Whitley207587a2001-04-25 20:41:02 +0000118 "\t-s\tquiet mode - do not print\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000119 "Compare files."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000120
Eric Andersen7e9276b2001-02-22 01:15:47 +0000121#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000122 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000123#define cp_full_usage \
124 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
125 "\n" \
126 "\t-a\tSame as -dpR\n" \
127 "\t-d\tPreserves links\n" \
128 "\t-p\tPreserves file attributes if possible\n" \
129 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000130 "\t-R\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000131
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000132#define cpio_trivial_usage \
133 "-[dimtuv][F cpiofile]"
134#define cpio_full_usage \
135 "Extract or list files from a cpio archive\n" \
136 "Main operation mode:\n" \
137 "\td\t\tmake directories (assumed)\n" \
138 "\ti\t\textract\n" \
139 "\tm\t\tpreserve time\n" \
140 "\tt\t\tlist\n" \
141 "\tu\t\tunconditional (assumed)\t" \
142 "\tF\t\tinput from file\t"
143
Eric Andersen7e9276b2001-02-22 01:15:47 +0000144#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000145 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000146#define cut_full_usage \
147 "Prints selected fields from each input FILE to standard output.\n\n" \
148 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000149 "\t-b LIST\t\tOutput only bytes from LIST\n" \
150 "\t-c LIST\t\tOutput only characters from LIST\n" \
151 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
152 "\t-s\t\tOutput only the lines containing delimiter\n" \
153 "\t-f N\t\tPrint only these fields\n" \
154 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000155#define cut_example_usage \
156 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
157 "Hello\n" \
158 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
159 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000160
Eric Andersen7e9276b2001-02-22 01:15:47 +0000161#define date_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000162 "[OPTION]... [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000163#define date_full_usage \
164 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000165 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000166 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000167 "\t-d STRING\tdisplay time described by STRING, not `now'\n" \
168 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000169 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000170#define date_example_usage \
171 "$ date\n" \
172 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000173
Eric Andersen7e9276b2001-02-22 01:15:47 +0000174#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000175 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000176#define dc_full_usage \
177 "This is a Tiny RPN calculator that understands the\n" \
178 "following operations: +, -, /, *, and, or, not, eor.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000179 "i.e., 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000180#define dc_example_usage \
181 "$ dc 2 2 +\n" \
182 "4\n" \
183 "$ dc 8 8 \* 2 2 + /\n" \
184 "16\n" \
185 "$ dc 0 1 and\n" \
186 "0\n" \
187 "$ dc 0 1 or\n" \
188 "1\n" \
189 "$ echo 72 9 div 8 mul | dc\n" \
190 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000191
Eric Andersen7e9276b2001-02-22 01:15:47 +0000192#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000193 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000194 "\t [seek=N] [conv=notrunc|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000195#define dd_full_usage \
196 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000197 "\tif=FILE\t\tread from FILE instead of stdin\n" \
198 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
199 "\tbs=N\t\tread and write N bytes at a time\n" \
200 "\tcount=N\t\tcopy only N input blocks\n" \
201 "\tskip=N\t\tskip N input blocks\n" \
202 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000203 "\tconv=notrunc\tdon't truncate output file\n" \
204 "\tconv=sync\tpad blocks with zeros\n" \
205 "\n" \
206 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000207 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000208#define dd_example_usage \
209 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
210 "4+0 records in\n" \
211 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000212
Eric Andersen7e9276b2001-02-22 01:15:47 +0000213#define deallocvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000214 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000215#define deallocvt_full_usage \
216 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000217
Eric Andersen7e9276b2001-02-22 01:15:47 +0000218
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000219#ifdef BB_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000220 #define USAGE_HUMAN_READABLE(a) a
221 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000222#else
Eric Andersened0d9582001-02-23 13:23:03 +0000223 #define USAGE_HUMAN_READABLE(a)
224 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000225#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000226#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000227 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000228#define df_full_usage \
229 "Print the filesystem space used and space available.\n\n" \
230 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000231 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000232 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
233 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000234 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000235 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000236#define df_example_usage \
237 "$ df\n" \
238 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
239 "/dev/sda3 8690864 8553540 137324 98% /\n" \
240 "/dev/sda1 64216 36364 27852 57% /boot\n" \
241 "$ df /dev/sda3\n" \
242 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
243 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000244
Eric Andersen7e9276b2001-02-22 01:15:47 +0000245#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000246 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000247#define dirname_full_usage \
248 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000249#define dirname_example_usage \
250 "$ dirname /tmp/foo\n" \
251 "/tmp\n" \
252 "$ dirname /tmp/foo/\n" \
253 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000254
Eric Andersen7e9276b2001-02-22 01:15:47 +0000255#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000256 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000257#define dmesg_full_usage \
258 "Prints or controls the kernel ring buffer\n\n" \
259 "Options:\n" \
260 "\t-c\t\tClears the ring buffer's contents after printing\n" \
261 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000262 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000263
Eric Andersen7e9276b2001-02-22 01:15:47 +0000264#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000265 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000266#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000267 "Converts FILE from dos format to unix format. When no option\n" \
268 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000269 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000270 "Options:\n" \
271 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000272 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000273
Eric Andersen7e9276b2001-02-22 01:15:47 +0000274#define dpkg_trivial_usage \
275 "[-i|-r|--unpack|--configure] my.deb"
276#define dpkg_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000277 "WORK IN PROGRESS, only useful for debian-installer"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000278
Eric Andersen7e9276b2001-02-22 01:15:47 +0000279#define dpkg_deb_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000280 "[-cefItxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000281#define dpkg_deb_full_usage \
282 "Perform actions on debian packages (.debs)\n\n" \
283 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000284 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000285 "\t-e\tExtract control files to [argument] directory\n" \
286 "\t-f\tDisplay control field name starting with [argument]\n" \
287 "\t-I\tDisplay the control filenamed [argument]\n" \
288 "\t-t\tExtract filesystem tree to stdout in tar format\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000289 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000290 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000291#define dpkg_deb_example_usage \
292 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000293
Eric Andersen7e9276b2001-02-22 01:15:47 +0000294#define du_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +0000295 "[-ls" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000296#define du_full_usage \
297 "Summarizes disk space used for each FILE and/or directory.\n" \
298 "Disk space is printed in units of 1024 bytes.\n\n" \
299 "Options:\n" \
300 "\t-l\tcount sizes many times if hard linked\n" \
301 "\t-s\tdisplay only a total for each argument" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000302 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000303 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
304 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000305 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000306 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000307#define du_example_usage \
308 "$ du\n" \
309 "16 ./CVS\n" \
310 "12 ./kernel-patches/CVS\n" \
311 "80 ./kernel-patches\n" \
312 "12 ./tests/CVS\n" \
313 "36 ./tests\n" \
314 "12 ./scripts/CVS\n" \
315 "16 ./scripts\n" \
316 "12 ./docs/CVS\n" \
317 "104 ./docs\n" \
318 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000319
Eric Andersen7e9276b2001-02-22 01:15:47 +0000320#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000321 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000322#define dumpkmap_full_usage \
323 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000324#define dumpkmap_example_usage \
325 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000326
Eric Andersen7e9276b2001-02-22 01:15:47 +0000327#define dutmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000328 "[FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000329#define dutmp_full_usage \
330 "Dump utmp file format (pipe delimited) from FILE\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000331 "or stdin to stdout. (i.e., 'dutmp /var/run/utmp')"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000332#define dutmp_example_usage \
333 "$ dutmp /var/run/utmp\n" \
334 "8|7||si|||0|0|0|955637625|760097|0\n" \
335 "2|0|~|~~|reboot||0|0|0|955637625|782235|0\n" \
336 "1|20020|~|~~|runlevel||0|0|0|955637625|800089|0\n" \
337 "8|125||l4|||0|0|0|955637629|998367|0\n" \
338 "6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0\n" \
339 "6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0\n" \
340 "7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000341
Eric Andersen7e9276b2001-02-22 01:15:47 +0000342#define echo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000343 "[-neE] [ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000344#define echo_full_usage \
345 "Prints the specified ARGs to stdout\n\n" \
346 "Options:\n" \
347 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000348 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000349 "\t-E\tdisable interpretation of backslash-escaped characters"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000350#define echo_example_usage \
351 "$ echo "Erik is cool"\n" \
352 "Erik is cool\n" \
John Beppu5d817682001-04-17 17:09:34 +0000353 "$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000354 "Erik\n" \
355 "is\n" \
356 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000357 "$ echo "Erik\\nis\\ncool"\n" \
358 "Erik\\nis\\ncool\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000359
Eric Andersen84e229c2001-03-29 22:48:33 +0000360#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000361 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000362#define env_full_usage \
363 "Prints the current environment or runs a program after setting\n" \
364 "up the specified environment.\n\n" \
365 "Options:\n" \
366 "\t-, -i\tstart with an empty environment\n" \
367 "\t-u\tremove variable from the environment\n"
368
Eric Andersen7e9276b2001-02-22 01:15:47 +0000369#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000370 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000371#define expr_full_usage \
372 "Prints the value of EXPRESSION to standard output.\n\n" \
373 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000374 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
375 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
376 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
377 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
378 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
379 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
380 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
381 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
382 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
383 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
384 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
385 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
386 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000387 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
388 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
389 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
390 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
391 "\t or 0\n" \
392 "\tlength STRING length of STRING\n" \
393 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
394 "\t it is a keyword like `match' or an\n" \
395 "\t operator like `/'\n" \
396 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000397 "Beware that many operators need to be escaped or quoted for shells.\n" \
398 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
399 "lexicographical. Pattern matches return the string matched between \n" \
400 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
401 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000402
Eric Andersen7e9276b2001-02-22 01:15:47 +0000403#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000404 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000405#define false_full_usage \
406 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000407#define false_example_usage \
408 "$ false\n" \
409 "$ echo $?\n" \
410 "1\n"
411
412#define fbset_trivial_usage \
413 "[options] [mode]"
414#define fbset_full_usage \
415 "Show and modify frame buffer settings"
416#define fbset_example_usage \
417 "$ fbset\n" \
418 "mode "1024x768-76"\n" \
419 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
420 "\tgeometry 1024 768 1024 768 16\n" \
421 "\ttimings 12714 128 32 16 4 128 4\n" \
422 "\taccel false\n" \
423 "\trgba 5/11,6/5,5/0,0/0\n" \
424 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000425
Eric Andersen7e9276b2001-02-22 01:15:47 +0000426#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000427 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000428#define fdflush_full_usage \
429 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000430
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000431#ifdef BB_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000432 #define USAGE_FIND_TYPE(a) a
433#else
434 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000435#endif
436#ifdef BB_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000437 #define USAGE_FIND_PERM(a) a
438#else
439 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000440#endif
441#ifdef BB_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000442 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000443#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000444 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000445#endif
446
Eric Andersen7e9276b2001-02-22 01:15:47 +0000447#define find_trivial_usage \
448 "[PATH...] [EXPRESSION]"
449#define find_full_usage \
450 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000451 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000452 "\nEXPRESSION may consist of:\n" \
453 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000454 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000455 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000456 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000457 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
458) USAGE_FIND_PERM( \
459 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
460) USAGE_FIND_MTIME( \
461 "\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 +0000462#define find_example_usage \
463 "$ find / -name /etc/passwd\n" \
464 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000465
Eric Andersen7e9276b2001-02-22 01:15:47 +0000466#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000467 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000468#define free_full_usage \
469 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000470#define free_example_usage \
471 "$ free\n" \
472 " total used free shared buffers\n" \
473 " Mem: 257628 248724 8904 59644 93124\n" \
474 " Swap: 128516 8404 120112\n" \
475 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000476
Eric Andersen7e9276b2001-02-22 01:15:47 +0000477#define freeramdisk_trivial_usage \
478 "DEVICE"
479#define freeramdisk_full_usage \
480 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000481#define freeramdisk_example_usage \
482 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000483
484#define fsck_minix_trivial_usage \
485 "[-larvsmf] /dev/name"
486#define fsck_minix_full_usage \
487 "Performs a consistency check for MINIX filesystems.\n\n" \
488 "Options:\n" \
489 "\t-l\tLists all filenames\n" \
490 "\t-r\tPerform interactive repairs\n" \
491 "\t-a\tPerform automatic repairs\n" \
492 "\t-v\tverbose\n" \
493 "\t-s\tOutputs super-block information\n" \
494 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
495 "\t-f\tForce file system check."
496
497#define getopt_trivial_usage \
498 "[OPTIONS]..."
499#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000500 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000501 "\t-a, --alternative Allow long options starting with single -\n" \
502 "\t-l, --longoptions=longopts Long options to be recognized\n" \
503 "\t-n, --name=progname The name under which errors are reported\n" \
504 "\t-o, --options=optstring Short options to be recognized\n" \
505 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
506 "\t-Q, --quiet-output No normal output\n" \
507 "\t-s, --shell=shell Set shell quoting conventions\n" \
508 "\t-T, --test Test for getopt(1) version\n" \
509 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000510#define getopt_example_usage \
511 "$ cat getopt.test\n" \
512 "#!/bin/sh\n" \
513 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
514 " -n 'example.busybox' -- "$@"`\n" \
515 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
516 "eval set -- "$GETOPT"\n" \
517 "while true ; do\n" \
518 " case $1 in\n" \
519 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
520 " -b|--b-long) echo \"Option b, argument \`$2'\" ; shift 2 ;;\n" \
521 " -c|--c-long)\n" \
522 " case "$2" in\n" \
523 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
524 " *) echo \"Option c, argument \`$2'\" ; shift 2 ;;\n" \
525 " esac ;;\n" \
526 " --) shift ; break ;;\n" \
527 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
528 " esac\n" \
529 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000530
531#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000532 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000533#define grep_full_usage \
534 "Search for PATTERN in each FILE or standard input.\n\n" \
535 "Options:\n" \
536 "\t-H\tprefix output lines with filename where match was found\n" \
537 "\t-h\tsuppress the prefixing filename on output\n" \
538 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000539 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000540 "\t-n\tprint line number with output lines\n" \
541 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
542 "\t-v\tselect non-matching lines\n" \
543 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000544#define grep_example_usage \
545 "$ grep root /etc/passwd\n" \
546 "root:x:0:0:root:/root:/bin/bash\n" \
547 "$ grep ^[rR]oo. /etc/passwd\n" \
548 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000549
Eric Andersen7e9276b2001-02-22 01:15:47 +0000550#define gunzip_trivial_usage \
551 "[OPTION]... FILE"
552#define gunzip_full_usage \
553 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
554 "Options:\n" \
555 "\t-c\tWrite output to standard output\n" \
556 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000557#define gunzip_example_usage \
558 "$ ls -la /tmp/BusyBox*\n" \
559 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
560 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
561 "$ ls -la /tmp/BusyBox*\n" \
562 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000563
564#define gzip_trivial_usage \
565 "[OPTION]... FILE"
566#define gzip_full_usage \
567 "Compress FILE with maximum compression.\n" \
568 "When FILE is '-', reads standard input. Implies -c.\n\n" \
569 "Options:\n" \
570 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
571 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000572#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000573 "$ ls -la /tmp/busybox*\n" \
574 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
575 "$ gzip /tmp/busybox.tar\n" \
576 "$ ls -la /tmp/busybox*\n" \
577 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000578
579#define halt_trivial_usage \
580 ""
581#define halt_full_usage \
582 "Halt the system."
583
584#define head_trivial_usage \
585 "[OPTION] [FILE]..."
586#define head_full_usage \
587 "Print first 10 lines of each FILE to standard output.\n" \
588 "With more than one FILE, precede each with a header giving the\n" \
589 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000590 "Options:\n" \
591 "\t-n NUM\t\tPrint first NUM lines instead of first 10"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000592#define head_example_usage \
593 "$ head -n 2 /etc/passwd\n" \
594 "root:x:0:0:root:/root:/bin/bash\n" \
595 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000596
597#define hostid_trivial_usage \
598 ""
599#define hostid_full_usage \
600 "Print out a unique 32-bit identifier for the machine."
601
602#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000603 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000604#define hostname_full_usage \
605 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000606 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000607 "Options:\n" \
608 "\t-s\t\tShort\n" \
609 "\t-i\t\tAddresses for the hostname\n" \
610 "\t-d\t\tDNS domain name\n" \
611 "\t-F, --file FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000612#define hostname_example_usage \
613 "$ hostname\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000614 "sage \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000615
616#define id_trivial_usage \
617 "[OPTIONS]... [USERNAME]"
618#define id_full_usage \
619 "Print information for USERNAME or the current user\n\n" \
620 "Options:\n" \
621 "\t-g\tprints only the group ID\n" \
622 "\t-u\tprints only the user ID\n" \
623 "\t-n\tprint a name instead of a number (with for -ug)\n" \
624 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000625#define id_example_usage \
626 "$ id\n" \
627 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000628
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000629#ifdef BB_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +0000630 #define USAGE_SIOCSKEEPALIVE(a) a
631#else
632 #define USAGE_SIOCSKEEPALIVE(a)
633#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000634#ifdef BB_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
635 #define USAGE_IFCONFIG_MII(a) a
636#else
637 #define USAGE_IFCONFIG_MII(a)
638#endif
639#ifdef BB_FEATURE_IFCONFIG_HW
640 #define USAGE_IFCONFIG_HW(a) a
641#else
642 #define USAGE_IFCONFIG_HW(a)
643#endif
644#ifdef BB_FEATURE_IFCONFIG_STATUS
645 #define USAGE_IFCONFIG_OPT_A(a) a
646#else
647 #define USAGE_IFCONFIG_OPT_A(a)
648#endif
649
Eric Andersen7e9276b2001-02-22 01:15:47 +0000650#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000651 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000652#define ifconfig_full_usage \
653 "configure a network interface\n\n" \
654 "Options:\n" \
655 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000656 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000657 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000658 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
659 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000660 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000661 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
662 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000663 "\t[up|down] ..."
664
665#define init_trivial_usage \
666 ""
667#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000668 "Init is the parent of all processes."
669#define init_notes_usage \
670"This version of init is designed to be run only by the kernel.\n" \
671"\n" \
672"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
673"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
674"runlevels, use sysvinit.\n" \
675"\n" \
676"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
677"it has the following default behavior:\n" \
678"\n" \
679" ::sysinit:/etc/init.d/rcS\n" \
680" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000681" ::ctrlaltdel:/sbin/reboot\n" \
682" ::shutdown:/sbin/swapoff -a\n" \
683" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000684"\n" \
685"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
686"\n" \
687" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000688" tty3::askfirst:/bin/sh\n" \
689" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000690"\n" \
691"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
692"\n" \
693" <id>:<runlevels>:<action>:<process>\n" \
694"\n" \
695" <id>: \n" \
696"\n" \
697" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
698" The id field is used by BusyBox init to specify the controlling tty for\n" \
699" the specified process to run on. The contents of this field are\n" \
700" appended to "/dev/" and used as-is. There is no need for this field to\n" \
701" be unique, although if it isn't you may have strange results. If this\n" \
702" field is left blank, the controlling tty is set to the console. Also\n" \
703" note that if BusyBox detects that a serial console is in use, then only\n" \
704" entries whose controlling tty is either the serial console or /dev/null\n" \
705" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
706" stinkin' utmp.\n" \
707"\n" \
708" <runlevels>: \n" \
709"\n" \
710" The runlevels field is completely ignored.\n" \
711"\n" \
712" <action>: \n" \
713"\n" \
714" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000715" once, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000716"\n" \
717" The available actions can be classified into two groups: actions\n" \
718" that are run only once, and actions that are re-run when the specified\n" \
719" process exits.\n" \
720"\n" \
721" Run only-once actions:\n" \
722"\n" \
723" 'sysinit' is the first item run on boot. init waits until all\n" \
724" sysinit actions are completed before continuing. Following the\n" \
725" completion of all sysinit actions, all 'wait' actions are run.\n" \
726" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000727" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000728" therefore, init does not wait for them to complete. 'ctrlaltdel'\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000729" actions are run when the system detects that someone on the system\n" \
730" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
731" wants to run 'reboot' at this point to cause the system to reboot.\n" \
732" Finally the 'shutdown' action specifies the actions to taken when\n" \
733" init is told to reboot. Unmounting filesystems and disabling swap\n" \
734" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000735"\n" \
736" Run repeatedly actions:\n" \
737"\n" \
738" 'respawn' actions are run after the 'once' actions. When a process\n" \
739" started with a 'respawn' action exits, init automatically restarts\n" \
740" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
741" respawning out of control. The 'askfirst' actions acts just like\n" \
742" respawn, except that before running the specified process it\n" \
743" displays the line "Please press Enter to activate this console."\n" \
744" and then waits for the user to press enter before starting the\n" \
745" specified process. \n" \
746"\n" \
747" Unrecognized actions (like initdefault) will cause init to emit an\n" \
748" error message, and then go along with its business. All actions are\n" \
749" run in the reverse order from how they appear in /etc/inittab.\n" \
750"\n" \
751" <process>: \n" \
752"\n" \
753" Specifies the process to be executed and it's command line.\n" \
754"\n" \
755"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +0000756"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000757" # This is run first except when booting in single-user mode.\n" \
758" #\n" \
759" ::sysinit:/etc/init.d/rcS\n" \
760" \n" \
761" # /bin/sh invocations on selected ttys\n" \
762" #\n" \
763" # Start an "askfirst" shell on the console (whatever that may be)\n" \
764" ::askfirst:-/bin/sh\n" \
765" # Start an "askfirst" shell on /dev/tty2-4\n" \
766" tty2::askfirst:-/bin/sh\n" \
767" tty3::askfirst:-/bin/sh\n" \
768" tty4::askfirst:-/bin/sh\n" \
769" \n" \
770" # /sbin/getty invocations for selected ttys\n" \
771" #\n" \
772" tty4::respawn:/sbin/getty 38400 tty5\n" \
773" tty5::respawn:/sbin/getty 38400 tty6\n" \
774" \n" \
775" \n" \
776" # Example of how to put a getty on a serial line (for a terminal)\n" \
777" #\n" \
778" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
779" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
780" #\n" \
781" # Example how to put a getty on a modem line.\n" \
782" #::respawn:/sbin/getty 57600 ttyS2\n" \
783" \n" \
784" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000785" ::ctrlaltdel:/sbin/reboot\n" \
786" ::shutdown:/bin/umount -a -r\n" \
787" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000788
789#define insmod_trivial_usage \
790 "[OPTION]... MODULE [symbol=value]..."
791#define insmod_full_usage \
792 "Loads the specified kernel modules into the kernel.\n\n" \
793 "Options:\n" \
794 "\t-f\tForce module to load into the wrong kernel version.\n" \
795 "\t-k\tMake module autoclean-able.\n" \
796 "\t-v\tverbose output\n" \
797 "\t-L\tLock to prevent simultaneous loads of a module\n" \
798 "\t-x\tdo not export externs"
799
800#define kill_trivial_usage \
801 "[-signal] process-id [process-id ...]"
802#define kill_full_usage \
803 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +0000804 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000805 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000806#define kill_example_usage \
807 "$ ps | grep apache\n" \
808 "252 root root S [apache]\n" \
809 "263 www-data www-data S [apache]\n" \
810 "264 www-data www-data S [apache]\n" \
811 "265 www-data www-data S [apache]\n" \
812 "266 www-data www-data S [apache]\n" \
813 "267 www-data www-data S [apache]\n" \
814 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000815
816#define killall_trivial_usage \
817 "[-signal] process-name [process-name ...]"
818#define killall_full_usage \
819 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000820 "Options:\n" \
821 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000822#define killall_example_usage \
823 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000824
Mark Whitley6317c4b2001-03-12 22:51:50 +0000825#define klogd_trivial_usage \
826 "-n"
827#define klogd_full_usage \
828 "Kernel logger.\n"\
829 "Options:\n"\
830 "\t-n\tRun as a foreground process."
831
Eric Andersen7e9276b2001-02-22 01:15:47 +0000832#define length_trivial_usage \
833 "STRING"
834#define length_full_usage \
835 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000836#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +0000837 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000838 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000839
840#define ln_trivial_usage \
841 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
842#define ln_full_usage \
843 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
844 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
845 "Options:\n" \
846 "\t-s\tmake symbolic links instead of hard links\n" \
847 "\t-f\tremove existing destination files\n" \
848 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000849#define ln_example_usage \
850 "$ ln -s BusyBox /tmp/ls\n" \
851 "$ ls -l /tmp/ls\n" \
852 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000853
854#define loadacm_trivial_usage \
855 "< mapfile"
856#define loadacm_full_usage \
857 "Loads an acm from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000858#define loadacm_example_usage \
859 "$ loadacm < /etc/i18n/acmname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000860
861#define loadfont_trivial_usage \
862 "< font"
863#define loadfont_full_usage \
864 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000865#define loadfont_example_usage \
866 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000867
868#define loadkmap_trivial_usage \
869 "< keymap"
870#define loadkmap_full_usage \
871 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000872#define loadkmap_example_usage \
873 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000874
875#define logger_trivial_usage \
876 "[OPTION]... [MESSAGE]"
877#define logger_full_usage \
878 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
879 "Options:\n" \
880 "\t-s\tLog to stderr as well as the system log.\n" \
881 "\t-t\tLog using the specified tag (defaults to user name).\n" \
882 "\t-p\tEnter the message with the specified priority.\n" \
883 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000884#define logger_example_usage \
885 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000886
887#define logname_trivial_usage \
888 ""
889#define logname_full_usage \
890 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000891#define logname_example_usage \
892 "$ logname\n" \
893 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000894
Mark Whitley6317c4b2001-03-12 22:51:50 +0000895#define logread_trivial_usage \
896 ""
897
898#define logread_full_usage \
899 "Shows the messages from syslogd (using circular buffer)."
900
Eric Andersen7e9276b2001-02-22 01:15:47 +0000901#ifdef BB_FEATURE_LS_TIMESTAMPS
902 #define USAGE_LS_TIMESTAMPS(a) a
903#else
904 #define USAGE_LS_TIMESTAMPS(a)
905#endif
906#ifdef BB_FEATURE_LS_FILETYPES
907 #define USAGE_LS_FILETYPES(a) a
908#else
909 #define USAGE_LS_FILETYPES(a)
910#endif
911#ifdef BB_FEATURE_LS_FOLLOWLINKS
912 #define USAGE_LS_FOLLOWLINKS(a) a
913#else
914 #define USAGE_LS_FOLLOWLINKS(a)
915#endif
916#ifdef BB_FEATURE_LS_RECURSIVE
917 #define USAGE_LS_RECURSIVE(a) a
918#else
919 #define USAGE_LS_RECURSIVE(a)
920#endif
921#ifdef BB_FEATURE_LS_SORTFILES
922 #define USAGE_LS_SORTFILES(a) a
923#else
924 #define USAGE_LS_SORTFILES(a)
925#endif
926#ifdef BB_FEATURE_AUTOWIDTH
927 #define USAGE_AUTOWIDTH(a) a
928#else
929 #define USAGE_AUTOWIDTH(a)
930#endif
931#define ls_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +0000932 "[-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 +0000933#define ls_full_usage \
934 "List directory contents\n\n" \
935 "Options:\n" \
936 "\t-1\tlist files in a single column\n" \
937 "\t-A\tdo not list implied . and ..\n" \
938 "\t-a\tdo not hide entries starting with .\n" \
939 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000940 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000941 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000942 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
943 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000944 "\t-i\tlist the i-node for each file\n" \
945 "\t-l\tuse a long listing format\n" \
946 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000947 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
948 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
949 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
950 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
951 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000952 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000953 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
954 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
955 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
956 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
957 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000958 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000959 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
960 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000961 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000962 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000963 "\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000964
965#define lsmod_trivial_usage \
966 ""
967#define lsmod_full_usage \
968 "List the currently loaded kernel modules."
969
970#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000971 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000972#define makedevs_full_usage \
973 "Creates a range of block or character special files\n\n" \
974 "TYPEs include:\n" \
975 "\tb:\tMake a block (buffered) device.\n" \
976 "\tc or u:\tMake a character (un-buffered) device.\n" \
977 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
978 "FIRST specifies the number appended to NAME to create the first device.\n" \
979 "LAST specifies the number of the last item that should be created.\n" \
980 "If 's' is the last argument, the base device is created as well.\n\n" \
981 "For example:\n" \
982 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000983 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000984#define makedevs_example_usage \
985 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
986 "[creates ttyS2-ttyS63]\n" \
987 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
988 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000989
Eric Andersen7e9276b2001-02-22 01:15:47 +0000990#define md5sum_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000991 "[OPTION] [FILE]...\n" \
992 "or: md5sum [OPTION] -c [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000993#define md5sum_full_usage \
994 "Print or check MD5 checksums.\n\n" \
995 "Options:\n" \
996 "With no FILE, or when FILE is -, read standard input.\n\n" \
997 "\t-b\tread files in binary mode\n" \
998 "\t-c\tcheck MD5 sums against given list\n" \
999 "\t-t\tread files in text mode (default)\n" \
1000 "\t-g\tread a string\n" \
1001 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001002 "\t-s\tdon't output anything, status code shows success\n" \
1003 "\t-w\twarn about improperly formated MD5 checksum lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001004#define md5sum_example_usage \
1005 "$ md5sum < busybox\n" \
1006 "6fd11e98b98a58f64ff3398d7b324003\n" \
1007 "$ md5sum busybox\n" \
1008 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1009 "$ md5sum -c -\n" \
1010 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1011 "busybox: OK\n" \
1012 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001013
Eric Andersen7e9276b2001-02-22 01:15:47 +00001014#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001015 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001016#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001017 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001018 "Options:\n" \
1019 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001020 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001021#define mkdir_example_usage \
1022 "$ mkdir /tmp/foo\n" \
1023 "$ mkdir /tmp/foo\n" \
1024 "/tmp/foo: File exists\n" \
1025 "$ mkdir /tmp/foo/bar/baz\n" \
1026 "/tmp/foo/bar/baz: No such file or directory\n" \
1027 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001028
Eric Andersen7e9276b2001-02-22 01:15:47 +00001029#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001030 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001031#define mkfifo_full_usage \
1032 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1033 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001034 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001035
Eric Andersen7e9276b2001-02-22 01:15:47 +00001036#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001037 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001038#define mkfs_minix_full_usage \
1039 "Make a MINIX filesystem.\n\n" \
1040 "Options:\n" \
1041 "\t-c\t\tCheck the device for bad blocks\n" \
1042 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1043 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1044 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001045 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001046
Eric Andersen7e9276b2001-02-22 01:15:47 +00001047#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001048 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001049#define mknod_full_usage \
1050 "Create a special file (block, character, or pipe).\n\n" \
1051 "Options:\n" \
1052 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1053 "TYPEs include:\n" \
1054 "\tb:\tMake a block (buffered) device.\n" \
1055 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001056 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001057#define mknod_example_usage \
1058 "$ mknod /dev/fd0 b 2 0 \n" \
1059 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001060
Eric Andersen7e9276b2001-02-22 01:15:47 +00001061#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001062 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001063#define mkswap_full_usage \
1064 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001065 "Options:\n" \
1066 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001067 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001068 "\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 +00001069 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001070
Eric Andersen7e9276b2001-02-22 01:15:47 +00001071#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001072 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001073#define mktemp_full_usage \
1074 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001075 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001076#define mktemp_example_usage \
1077 "$ mktemp /tmp/temp.XXXXXX\n" \
1078 "/tmp/temp.mWiLjM\n" \
1079 "$ ls -la /tmp/temp.mWiLjM\n" \
1080 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001081
Eric Andersen7e9276b2001-02-22 01:15:47 +00001082#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001083 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001084#define more_full_usage \
1085 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001086#define more_example_usage \
1087 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001088
Eric Andersen7e9276b2001-02-22 01:15:47 +00001089#ifdef BB_FEATURE_MOUNT_LOOP
1090 #define USAGE_MOUNT_LOOP(a) a
1091#else
1092 #define USAGE_MOUNT_LOOP(a)
1093#endif
Eric Andersenc4cef5a2001-04-01 16:01:11 +00001094#ifdef BB_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001095 #define USAGE_MTAB(a) a
1096#else
1097 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001098#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001099#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001100 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001101#define mount_full_usage \
1102 "Mount a filesystem\n\n" \
1103 "Flags:\n" \
1104 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001105 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001106 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001107 "\t-n:\t\tDon't write a mount table entry.\n" \
1108 ) \
1109 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1110 "\t-r:\t\tMount the filesystem read-only.\n" \
1111 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1112 "\t-w:\t\tMount for reading and writing (default).\n" \
1113 "\n" \
1114 "Options for use with the \"-o\" flag:\n" \
1115 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1116 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1117 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1118 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001119 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001120 "\tloop:\t\tMounts a file via loop device.\n" \
1121 ) \
1122 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001123 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001124 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001125 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001126 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001127 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001128#define mount_example_usage \
1129 "$ mount\n" \
1130 "/dev/hda3 on / type minix (rw)\n" \
1131 "proc on /proc type proc (rw)\n" \
1132 "devpts on /dev/pts type devpts (rw)\n" \
1133 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1134 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001135
Eric Andersen7e9276b2001-02-22 01:15:47 +00001136#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001137 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001138#define mt_full_usage \
1139 "Control magnetic tape drive operation\n" \
1140 "\nAvailable Opcodes:\n\n" \
1141 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1142 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
1143 "ras3 reset retension rew rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001144 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001145
Eric Andersen7e9276b2001-02-22 01:15:47 +00001146#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001147 "SOURCE DEST\n" \
1148 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001149#define mv_full_usage \
1150 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001151#define mv_example_usage \
1152 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001153
Eric Andersen7e9276b2001-02-22 01:15:47 +00001154#define nc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001155 "[IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001156#define nc_full_usage \
1157 "Netcat opens a pipe to IP:port"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001158#define nc_example_usage \
1159 "$ nc foobar.somedomain.com 25\n" \
1160 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1161 "help\n" \
1162 "214-Commands supported:\n" \
1163 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1164 "214 NOOP QUIT RSET HELP\n" \
1165 "quit\n" \
1166 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001167
Eric Andersen7e9276b2001-02-22 01:15:47 +00001168#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001169 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001170#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001171 "Queries the nameserver for the IP address of the given HOST\n" \
1172 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001173#define nslookup_example_usage \
1174 "$ nslookup localhost\n" \
1175 "Server: default\n" \
1176 "Address: default\n" \
1177 "\n" \
1178 "Name: debian\n" \
1179 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001180
Eric Andersen004015e2001-05-21 20:30:51 +00001181#ifndef BB_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001182#define ping_trivial_usage "host"
1183#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1184#else
1185#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001186 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001187#define ping_full_usage \
1188 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1189 "Options:\n" \
1190 "\t-c COUNT\tSend only COUNT pings.\n" \
1191 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1192 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001193 "\t\t\tand when finished."
1194#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001195#define ping_example_usage \
1196 "$ ping localhost\n" \
1197 "PING slag (127.0.0.1): 56 data bytes\n" \
1198 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1199 "\n" \
1200 "--- debian ping statistics ---\n" \
1201 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1202 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001203
Eric Andersen7e9276b2001-02-22 01:15:47 +00001204#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001205 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001206#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001207 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001208 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001209
Eric Andersen7e9276b2001-02-22 01:15:47 +00001210#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001211 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001212#define poweroff_full_usage \
1213 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001214
Eric Andersen7e9276b2001-02-22 01:15:47 +00001215#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001216 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001217#define printf_full_usage \
1218 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001219 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001220#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001221 "$ printf "Val=%d\\n" 5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001222 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001223
Eric Andersen7e9276b2001-02-22 01:15:47 +00001224#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001225 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001226#define ps_full_usage \
1227 "Report process status\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001228 "\nThis version of ps accepts no options."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001229#define ps_example_usage \
1230 "$ ps\n" \
1231 " PID Uid Gid State Command\n" \
1232 " 1 root root S init\n" \
1233 " 2 root root S [kflushd]\n" \
1234 " 3 root root S [kupdate]\n" \
1235 " 4 root root S [kpiod]\n" \
1236 " 5 root root S [kswapd]\n" \
1237 " 742 andersen andersen S [bash]\n" \
1238 " 743 andersen andersen S -bash\n" \
1239 " 745 root root S [getty]\n" \
1240 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001241
Eric Andersen7e9276b2001-02-22 01:15:47 +00001242#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001243 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001244#define pwd_full_usage \
1245 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001246#define pwd_example_usage \
1247 "$ pwd\n" \
1248 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001249
Eric Andersen7e9276b2001-02-22 01:15:47 +00001250#define rdate_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001251 "[OPTION] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001252#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001253 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001254 "Options:\n" \
1255 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001256 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001257
Eric Andersen7e9276b2001-02-22 01:15:47 +00001258#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001259 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001260#define readlink_full_usage \
1261 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001262
Eric Andersen7e9276b2001-02-22 01:15:47 +00001263#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001264 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001265#define reboot_full_usage \
1266 "Reboot the system."
1267
1268#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001269 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001270#define renice_full_usage \
1271 "Changes priority of running processes. Allowed priorities range\n" \
1272 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001273 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001274
Eric Andersen7e9276b2001-02-22 01:15:47 +00001275#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001276 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001277#define reset_full_usage \
1278 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001279
Eric Andersen7e9276b2001-02-22 01:15:47 +00001280#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001281 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001282#define rm_full_usage \
1283 "Remove (unlink) the FILE(s). You may use '--' to\n" \
1284 "indicate that all following arguments are non-options.\n\n" \
1285 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00001286 "\t-i\t\talways prompt before removing each destination" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001287 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001288 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001289#define rm_example_usage \
1290 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001291
Eric Andersen7e9276b2001-02-22 01:15:47 +00001292#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001293 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001294#define rmdir_full_usage \
1295 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001296#define rmdir_example_usage \
1297 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001298
Eric Andersen7e9276b2001-02-22 01:15:47 +00001299#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001300 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001301#define rmmod_full_usage \
1302 "Unloads the specified kernel modules from the kernel.\n\n" \
1303 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001304 "\t-a\tTry to remove all unused kernel modules."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001305#define rmmod_example_usage \
1306 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001307
Eric Andersen7e9276b2001-02-22 01:15:47 +00001308#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001309 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001310#define route_full_usage \
1311 "Edit the kernel's routing tables"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001312
Eric Andersen7e9276b2001-02-22 01:15:47 +00001313#define rpmunpack_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001314 "< package.rpm | gunzip | cpio -idmuv"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001315#define rpmunpack_full_usage \
1316 "Extracts an rpm archive."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001317
Eric Andersen7e9276b2001-02-22 01:15:47 +00001318#define sed_trivial_usage \
Matt Kraai075228a2001-06-21 14:40:55 +00001319 "[-nef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001320#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001321 "Options:\n" \
1322 "\t-n\t\tsuppress automatic printing of pattern space\n" \
1323 "\t-e script\tadd the script to the commands to be executed\n" \
1324 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001325 "\n" \
1326 "If no -e or -f is given, the first non-option argument is taken as the\n" \
1327 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001328 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001329#define sed_example_usage \
1330 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
1331 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001332
Eric Andersen7e9276b2001-02-22 01:15:47 +00001333#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001334 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001335#define setkeycodes_full_usage \
1336 "Set entries into the kernel's scancode-to-keycode map,\n" \
1337 "allowing unusual keyboards to generate usable keycodes.\n\n" \
1338 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001339 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001340#define setkeycodes_example_usage \
1341 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001342
Eric Andersen7e9276b2001-02-22 01:15:47 +00001343#define sh_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001344 "[FILE]...\n" \
1345 "or: sh -c command [args]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001346#define sh_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001347 "lash: The BusyBox LAme SHell (command interpreter)"
1348#define sh_notes_usage \
1349"This command does not yet have proper documentation.\n" \
1350"\n" \
1351"Use lash just as you would use any other shell. It properly handles pipes,\n" \
1352"redirects, job control, can be used as the shell for scripts, and has a\n" \
1353"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
1354"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
1355"use ash or bash. If you just need a very simple and extremely small shell,\n" \
1356"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001357
Eric Andersen7e9276b2001-02-22 01:15:47 +00001358#define sleep_trivial_usage \
1359 "N"
1360#define sleep_full_usage \
1361 "Pause for N seconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001362#define sleep_example_usage \
1363 "$ sleep 2\n" \
1364 "[2 second delay results]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001365
Eric Andersen7e9276b2001-02-22 01:15:47 +00001366
Mark Whitleyfccaa362001-04-17 18:56:18 +00001367#ifdef BB_FEATURE_SORT_UNIQUE
1368 #define USAGE_SORT_UNIQUE(a) a
1369#else
1370 #define USAGE_SORT_UNIQUE(a)
1371#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001372#ifdef BB_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001373 #define USAGE_SORT_REVERSE(a) a
1374#else
1375 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001376#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001377#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001378 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001379#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001380 "Sorts lines of text in the specified files\n\n"\
1381 "Options:\n" \
1382 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
1383 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
1384 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001385#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001386 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001387 "a\n" \
1388 "b\n" \
1389 "c\n" \
1390 "d\n" \
1391 "e\n" \
1392 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001393
Eric Andersen7e9276b2001-02-22 01:15:47 +00001394#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001395 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001396#define stty_full_usage \
1397 "Without arguments, prints baud rate, line discipline," \
1398 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001399 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00001400 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001401 "\n\t-a\t\tprint all current settings in human-readable form" \
1402 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00001403 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001404
Eric Andersen7e9276b2001-02-22 01:15:47 +00001405#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001406 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001407#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001408 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001409 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001410 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001411
Eric Andersen7e9276b2001-02-22 01:15:47 +00001412#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001413 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001414#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001415 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001416 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001417 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001418
Eric Andersen7e9276b2001-02-22 01:15:47 +00001419#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001420 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001421#define sync_full_usage \
1422 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001423
Eric Andersen7e9276b2001-02-22 01:15:47 +00001424
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001425#ifdef BB_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00001426 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001427#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00001428 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001429#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001430#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001431 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001432#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00001433 "Linux system and kernel logging utility.\n" \
1434 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001435 "Options:\n" \
1436 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
1437 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001438 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001439 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00001440 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
1441 "\t-L\t\tLog locally and via network logging (default is network only)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001442#define syslogd_example_usage \
1443 "$ syslogd -R masterlog:514\n" \
1444 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001445
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001446
Eric Andersen004015e2001-05-21 20:30:51 +00001447#ifndef BB_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00001448 #define USAGE_UNSIMPLE_TAIL(a)
1449#else
1450 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001451#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001452#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001453 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001454#define tail_full_usage \
1455 "Print last 10 lines of each FILE to standard output.\n" \
1456 "With more than one FILE, precede each with a header giving the\n" \
1457 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
1458 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001459 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001460 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
1461 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001462 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001463 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
1464 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001465 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001466 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001467 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
1468#define tail_example_usage \
1469 "$ tail -n 1 /etc/resolv.conf\n" \
1470 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001471
Eric Andersen7e9276b2001-02-22 01:15:47 +00001472#ifdef BB_FEATURE_TAR_CREATE
1473 #define USAGE_TAR_CREATE(a) a
1474#else
1475 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001476#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001477#ifdef BB_FEATURE_TAR_EXCLUDE
1478 #define USAGE_TAR_EXCLUDE(a) a
1479#else
1480 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001481#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001482#define tar_trivial_usage \
1483 "-[" USAGE_TAR_CREATE("c") "xtvO] " \
Eric Andersen317827d2001-05-21 17:50:53 +00001484 USAGE_TAR_EXCLUDE("[--exclude FILE] [-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00001485 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001486#define tar_full_usage \
1487 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00001488 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001489 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001490 "\tx\t\textract\n" \
1491 "\tt\t\tlist\n" \
1492 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001493 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001494 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001495 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001496 "\texclude\t\tfile to exclude\n" \
1497 "\tX\t\tfile with names to exclude\n" \
1498 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00001499 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001500 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001501#define tar_example_usage \
1502 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
1503 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001504
Eric Andersen7e9276b2001-02-22 01:15:47 +00001505#define tee_trivial_usage \
1506 "[OPTION]... [FILE]..."
1507#define tee_full_usage \
1508 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001509 "Options:\n" \
1510 "\t-a\tappend to the given FILEs, do not overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001511#define tee_example_usage \
1512 "$ echo "Hello" | tee /tmp/foo\n" \
1513 "$ cat /tmp/foo\n" \
1514 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001515
Eric Andersen7e9276b2001-02-22 01:15:47 +00001516#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001517 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001518#define telnet_full_usage \
1519 "Telnet is used to establish interactive communication with another\n"\
1520 "computer over a network using the TELNET protocol."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001521
Eric Andersen7e9276b2001-02-22 01:15:47 +00001522#define test_trivial_usage \
1523 "EXPRESSION\n or [ EXPRESSION ]"
1524#define test_full_usage \
1525 "Checks file types and compares values returning an exit\n" \
1526 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001527#define test_example_usage \
1528 "$ test 1 -eq 2\n" \
1529 "$ echo $?\n" \
1530 "1\n" \
1531 "$ test 1 -eq 1\n" \
1532 "$ echo $? \n" \
1533 "0\n" \
1534 "$ [ -d /etc ]\n" \
1535 "$ echo $?\n" \
1536 "0\n" \
1537 "$ [ -d /junk ]\n" \
1538 "$ echo $?\n" \
1539 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001540
Mark Whitley450736c2001-03-02 19:08:50 +00001541#ifdef BB_FEATURE_TFTP_GET
1542 #define USAGE_TFTP_GET(a) a
1543#else
1544 #define USAGE_TFTP_GET(a)
1545#endif
1546#ifdef BB_FEATURE_TFTP_PUT
1547 #define USAGE_TFTP_PUT(a) a
1548#else
1549 #define USAGE_TFTP_PUT(a)
1550#endif
1551
1552#define tftp_trivial_usage \
1553 "command SOURCE DEST"
1554#define tftp_full_usage \
1555 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
1556 "Commands:\n" \
1557 USAGE_TFTP_GET( \
1558 "\tget\tGet file from server SOURCE and store to local DEST.\n" \
1559 ) \
1560 USAGE_TFTP_PUT( \
1561 "\tput\tPut local file SOURCE to server DEST.\n" \
1562 ) \
John Beppu5d817682001-04-17 17:09:34 +00001563 "\nWhen naming a server, use the syntax \"server:file\"."
Mark Whitley450736c2001-03-02 19:08:50 +00001564
Eric Andersen7e9276b2001-02-22 01:15:47 +00001565#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001566 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001567#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001568 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001569 "Options:\n" \
1570 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001571#define touch_example_usage \
1572 "$ ls -l /tmp/foo\n" \
1573 "/bin/ls: /tmp/foo: No such file or directory\n" \
1574 "$ touch /tmp/foo\n" \
1575 "$ ls -l /tmp/foo\n" \
1576 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001577
1578#define tr_trivial_usage \
1579 "[-cds] STRING1 [STRING2]"
1580#define tr_full_usage \
1581 "Translate, squeeze, and/or delete characters from\n" \
1582 "standard input, writing to standard output.\n\n" \
1583 "Options:\n" \
1584 "\t-c\ttake complement of STRING1\n" \
1585 "\t-d\tdelete input characters coded STRING1\n" \
1586 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001587#define tr_example_usage \
1588 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
1589 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001590
1591#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001592 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001593#define true_full_usage \
1594 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001595#define true_example_usage \
1596 "$ true\n" \
1597 "$ echo $?\n" \
1598 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001599
Eric Andersen7e9276b2001-02-22 01:15:47 +00001600#define tty_trivial_usage \
1601 ""
1602#define tty_full_usage \
1603 "Print the file name of the terminal connected to standard input.\n\n"\
1604 "Options:\n" \
1605 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001606#define tty_example_usage \
1607 "$ tty\n" \
1608 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001609
Eric Andersen7e9276b2001-02-22 01:15:47 +00001610#ifdef BB_FEATURE_MOUNT_FORCE
1611 #define USAGE_MOUNT_FORCE(a) a
1612#else
1613 #define USAGE_MOUNT_FORCE(a)
1614#endif
1615#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001616 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001617#define umount_full_usage \
1618 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00001619 "\nFlags:\n" "\t-a\tUnmount all file systems" \
1620 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
1621 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00001622 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00001623 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 +00001624#define umount_example_usage \
1625 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001626
1627#define uname_trivial_usage \
1628 "[OPTION]..."
1629#define uname_full_usage \
1630 "Print certain system information. With no OPTION, same as -s.\n\n" \
1631 "Options:\n" \
1632 "\t-a\tprint all information\n" \
1633 "\t-m\tthe machine (hardware) type\n" \
1634 "\t-n\tprint the machine's network node hostname\n" \
1635 "\t-r\tprint the operating system release\n" \
1636 "\t-s\tprint the operating system name\n" \
1637 "\t-p\tprint the host processor type\n" \
1638 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001639#define uname_example_usage \
1640 "$ uname -a\n" \
1641 "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001642
1643#define uniq_trivial_usage \
1644 "[OPTION]... [INPUT [OUTPUT]]"
1645#define uniq_full_usage \
1646 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001647 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001648 "Options:\n" \
1649 "\t-c\tprefix lines by the number of occurrences\n" \
1650 "\t-d\tonly print duplicate lines\n" \
1651 "\t-u\tonly print unique lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001652#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001653 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001654 "a\n" \
1655 "b\n" \
1656 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001657
1658#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001659 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001660#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001661 "Converts FILE from unix format to dos format. When no option\n" \
1662 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00001663 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001664 "Options:\n" \
1665 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00001666 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001667
1668#define update_trivial_usage \
1669 "[options]"
1670#define update_full_usage \
1671 "Periodically flushes filesystem buffers.\n\n" \
1672 "Options:\n" \
1673 "\t-S\tforce use of sync(2) instead of flushing\n" \
1674 "\t-s SECS\tcall sync this often (default 30)\n" \
1675 "\t-f SECS\tflush some buffers this often (default 5)"
1676
1677#define uptime_trivial_usage \
1678 ""
1679#define uptime_full_usage \
1680 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001681#define uptime_example_usage \
1682 "$ uptime\n" \
1683 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001684
1685#define usleep_trivial_usage \
1686 "N"
1687#define usleep_full_usage \
1688 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001689#define usleep_example_usage \
1690 "$ usleep 1000000\n" \
1691 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001692
1693#define uudecode_trivial_usage \
1694 "[FILE]..."
1695#define uudecode_full_usage \
1696 "Uudecode a file that is uuencoded.\n\n" \
1697 "Options:\n" \
Eric Andersen704b2c22001-03-16 08:06:30 +00001698 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001699#define uudecode_example_usage \
1700 "$ uudecode -o busybox busybox.uu\n" \
1701 "$ ls -l busybox\n" \
1702 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001703
1704#define uuencode_trivial_usage \
1705 "[OPTION] [INFILE] REMOTEFILE"
1706#define uuencode_full_usage \
1707 "Uuencode a file.\n\n" \
1708 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00001709 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001710#define uuencode_example_usage \
1711 "$ uuencode busybox busybox\n" \
1712 "begin 755 busybox\n" \
1713 "<encoded file snipped>\n" \
1714 "$ uudecode busybox busybox > busybox.uu\n" \
1715 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001716
Eric Andersen3f980402001-04-04 17:31:15 +00001717#define vi_trivial_usage \
1718 "[OPTION] [FILE]..."
1719#define vi_full_usage \
1720 "edit FILE.\n\n" \
1721 "Options:\n" \
1722 "\t-R\tRead-only- do not write to the file."
1723
Eric Andersen7e9276b2001-02-22 01:15:47 +00001724#define watchdog_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001725 "DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001726#define watchdog_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001727 "Periodically write to watchdog device DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001728
1729#define wc_trivial_usage \
1730 "[OPTION]... [FILE]..."
1731#define wc_full_usage \
1732 "Print line, word, and byte counts for each FILE, and a total line if\n" \
1733 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
1734 "Options:\n" \
1735 "\t-c\tprint the byte counts\n" \
1736 "\t-l\tprint the newline counts\n" \
1737 "\t-L\tprint the length of the longest line\n" \
1738 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001739#define wc_example_usage \
1740 "$ wc /etc/passwd\n" \
1741 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001742
1743#define wget_trivial_usage \
Eric Andersen8071c022001-06-21 19:45:06 +00001744 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n\t[--header 'header: value'] [-P DIR] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001745#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00001746 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001747 "Options:\n" \
1748 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00001749 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00001750 "\t-P\tSet directory prefix to DIR\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001751 "\t-O\tsave to filename ('-' for stdout)"
1752
1753#define which_trivial_usage \
1754 "[COMMAND ...]"
1755#define which_full_usage \
1756 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001757#define which_example_usage \
1758 "$ which login\n" \
1759 "/bin/login\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001760
1761#define whoami_trivial_usage \
1762 ""
1763#define whoami_full_usage \
1764 "Prints the user name associated with the current effective user id."
1765
1766#define xargs_trivial_usage \
1767 "[COMMAND] [ARGS...]"
1768#define xargs_full_usage \
1769 "Executes COMMAND on every item given by standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001770#define xargs_example_usage \
1771 "$ ls | xargs gzip\n" \
1772 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001773
1774#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001775 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001776#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001777 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001778
Eric Andersen7e9276b2001-02-22 01:15:47 +00001779#define zcat_trivial_usage \
1780 "FILE"
1781#define zcat_full_usage \
1782 "Uncompress to stdout."