blob: dd100332c993374bb0fe6bc5f4c9d0ca58f6ff8a [file] [log] [blame]
Mark Whitley6f932772001-03-20 19:18:10 +00001#define adjtimex_trivial_usage \
2 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
3#define adjtimex_full_usage \
4 "Reads and optionally sets system timebase parameters.\n" \
5 "See adjtimex(2).\n\n" \
6 "Options:\n" \
7 "\t-q\t\tquiet mode - do not print\n" \
8 "\t-o offset\ttime offset, microseconds\n" \
9 "\t-f frequency\tfrequency adjust, integer kernel units (65536 is 1ppm)\n" \
10 "\t\t\t(positive values make the system clock run fast)\n" \
11 "\t-t tick\t\tmicroseconds per tick, usually 10000\n" \
12 "\t-p timeconstant\n"
13
Eric Andersen7e9276b2001-02-22 01:15:47 +000014#define ar_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000015 "-[ovR]{ptx} archive filenames"
Eric Andersen7e9276b2001-02-22 01:15:47 +000016#define ar_full_usage \
17 "Extract or list files from an ar archive.\n\n" \
18 "Options:\n" \
19 "\t-o\t\tpreserve original dates\n" \
20 "\t-p\t\textract to stdout\n" \
21 "\t-t\t\tlist\n" \
22 "\t-x\t\textract\n" \
23 "\t-v\t\tverbosely list files processed\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000024 "\t-R\t\trecursive action"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000025
Eric Andersen7e9276b2001-02-22 01:15:47 +000026#define basename_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000027 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000028#define basename_full_usage \
29 "Strips directory path and suffixes from FILE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000030 "If specified, also removes any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000031#define basename_example_usage \
32 "$ basename /usr/local/bin/foo\n" \
33 "foo\n" \
34 "$ basename /usr/local/bin/\n" \
35 "bin\n" \
36 "$ basename /foo/bar.txt .txt\n" \
37 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000038
Eric Andersen7e9276b2001-02-22 01:15:47 +000039#define cat_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000040 "[FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000041#define cat_full_usage \
42 "Concatenates FILE(s) and prints them to stdout."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000043#define cat_example_usage \
44 "$ cat /proc/uptime\n" \
45 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000046
Eric Andersen7e9276b2001-02-22 01:15:47 +000047#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000048 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000049#define chgrp_full_usage \
50 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000051 "\nOptions:\n" \
52 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000053#define chgrp_example_usage \
54 "$ ls -l /tmp/foo\n" \
55 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
56 "$ chgrp root /tmp/foo\n" \
57 "$ ls -l /tmp/foo\n" \
58 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000059
Eric Andersen7e9276b2001-02-22 01:15:47 +000060#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000061 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000062#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000063 "Each MODE is one or more of the letters ugoa, one of the\n" \
64 "symbols +-= and one or more of the letters rwxst.\n\n" \
65 "Options:\n" \
66 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000067#define chmod_example_usage \
68 "$ ls -l /tmp/foo\n" \
69 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
70 "$ chmod u+x /tmp/foo\n" \
71 "$ ls -l /tmp/foo\n" \
72 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
73 "$ chmod 444 /tmp/foo\n" \
74 "$ ls -l /tmp/foo\n" \
75 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000076
Eric Andersen7e9276b2001-02-22 01:15:47 +000077#define chown_trivial_usage \
Eric Andersen238da242001-05-11 16:31:46 +000078 "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000079#define chown_full_usage \
80 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000081 "\nOptions:\n" \
Eric Andersen238da242001-05-11 16:31:46 +000082 "\t-R\tChanges files and directories recursively.\n" \
83 "\t-h\tDo not dereference symbolic links."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000084#define chown_example_usage \
85 "$ ls -l /tmp/foo\n" \
86 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
87 "$ chown root /tmp/foo\n" \
88 "$ ls -l /tmp/foo\n" \
89 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
90 "$ chown root.root /tmp/foo\n" \
91 "ls -l /tmp/foo\n" \
92 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000093
Eric Andersen7e9276b2001-02-22 01:15:47 +000094#define chroot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000095 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000096#define chroot_full_usage \
97 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000098#define chroot_example_usage \
99 "$ ls -l /bin/ls\n" \
100 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
101 "$ mount /dev/hdc1 /mnt -t minix\n" \
102 "$ chroot /mnt\n" \
103 "$ ls -l /bin/ls\n" \
104 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000105
Eric Andersen7e9276b2001-02-22 01:15:47 +0000106#define chvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000107 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000108#define chvt_full_usage \
109 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000110
Eric Andersen7e9276b2001-02-22 01:15:47 +0000111#define clear_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000112 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000113#define clear_full_usage \
114 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000115
Eric Andersen7e9276b2001-02-22 01:15:47 +0000116#define cmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000117 "FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000118#define cmp_full_usage \
Mark Whitley207587a2001-04-25 20:41:02 +0000119 "\t-s\tquiet mode - do not print\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000120 "Compare files."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000121
Eric Andersen7e9276b2001-02-22 01:15:47 +0000122#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000123 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000124#define cp_full_usage \
125 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
126 "\n" \
127 "\t-a\tSame as -dpR\n" \
128 "\t-d\tPreserves links\n" \
129 "\t-p\tPreserves file attributes if possible\n" \
130 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000131 "\t-R\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000132
Eric Andersen7e9276b2001-02-22 01:15:47 +0000133#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000134 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000135#define cut_full_usage \
136 "Prints selected fields from each input FILE to standard output.\n\n" \
137 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000138 "\t-b LIST\t\tOutput only bytes from LIST\n" \
139 "\t-c LIST\t\tOutput only characters from LIST\n" \
140 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
141 "\t-s\t\tOutput only the lines containing delimiter\n" \
142 "\t-f N\t\tPrint only these fields\n" \
143 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000144#define cut_example_usage \
145 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
146 "Hello\n" \
147 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
148 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000149
Eric Andersen7e9276b2001-02-22 01:15:47 +0000150#define date_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000151 "[OPTION]... [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000152#define date_full_usage \
153 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000154 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000155 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000156 "\t-d STRING\tdisplay time described by STRING, not `now'\n" \
157 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000158 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000159#define date_example_usage \
160 "$ date\n" \
161 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000162
Eric Andersen7e9276b2001-02-22 01:15:47 +0000163#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000164 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000165#define dc_full_usage \
166 "This is a Tiny RPN calculator that understands the\n" \
167 "following operations: +, -, /, *, and, or, not, eor.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000168 "i.e. 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000169#define dc_example_usage \
170 "$ dc 2 2 +\n" \
171 "4\n" \
172 "$ dc 8 8 \* 2 2 + /\n" \
173 "16\n" \
174 "$ dc 0 1 and\n" \
175 "0\n" \
176 "$ dc 0 1 or\n" \
177 "1\n" \
178 "$ echo 72 9 div 8 mul | dc\n" \
179 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000180
Eric Andersen7e9276b2001-02-22 01:15:47 +0000181#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000182 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000183 "\t [seek=N] [conv=notrunc|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000184#define dd_full_usage \
185 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000186 "\tif=FILE\t\tread from FILE instead of stdin\n" \
187 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
188 "\tbs=N\t\tread and write N bytes at a time\n" \
189 "\tcount=N\t\tcopy only N input blocks\n" \
190 "\tskip=N\t\tskip N input blocks\n" \
191 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000192 "\tconv=notrunc\tdon't truncate output file\n" \
193 "\tconv=sync\tpad blocks with zeros\n" \
194 "\n" \
195 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000196 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000197#define dd_example_usage \
198 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
199 "4+0 records in\n" \
200 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000201
Eric Andersen7e9276b2001-02-22 01:15:47 +0000202#define deallocvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000203 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000204#define deallocvt_full_usage \
205 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000206
Eric Andersen7e9276b2001-02-22 01:15:47 +0000207
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000208#ifdef BB_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000209 #define USAGE_HUMAN_READABLE(a) a
210 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000211#else
Eric Andersened0d9582001-02-23 13:23:03 +0000212 #define USAGE_HUMAN_READABLE(a)
213 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000214#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000215#define df_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +0000216 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [filesystem ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000217#define df_full_usage \
218 "Print the filesystem space used and space available.\n\n" \
219 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000220 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000221 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
222 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000223 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000224 "\n\t-k\tprint sizes in kilobytes(compatability)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000225#define df_example_usage \
226 "$ df\n" \
227 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
228 "/dev/sda3 8690864 8553540 137324 98% /\n" \
229 "/dev/sda1 64216 36364 27852 57% /boot\n" \
230 "$ df /dev/sda3\n" \
231 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
232 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000233
Eric Andersen7e9276b2001-02-22 01:15:47 +0000234#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000235 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000236#define dirname_full_usage \
237 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000238#define dirname_example_usage \
239 "$ dirname /tmp/foo\n" \
240 "/tmp\n" \
241 "$ dirname /tmp/foo/\n" \
242 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000243
Eric Andersen7e9276b2001-02-22 01:15:47 +0000244#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000245 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000246#define dmesg_full_usage \
247 "Prints or controls the kernel ring buffer\n\n" \
248 "Options:\n" \
249 "\t-c\t\tClears the ring buffer's contents after printing\n" \
250 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000251 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000252
Eric Andersen7e9276b2001-02-22 01:15:47 +0000253#define dos2unix_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000254 "[option] [file]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000255#define dos2unix_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000256 "Converts a text file to/from dos format to unix format.\n\n" \
257 "Options:\n" \
258 "\t-u\toutput will be in UNIX format\n" \
259 "\t-d\toutput will be in DOS format\n\n" \
260 "- when no option is given then input format will be automaticaly detected\n" \
261 " and converted to the oposite format on output\n" \
262 "- when no file is given, then stdin is used as input and stdout as output"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000263
Eric Andersen7e9276b2001-02-22 01:15:47 +0000264#define dpkg_trivial_usage \
265 "[-i|-r|--unpack|--configure] my.deb"
266#define dpkg_full_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000267 "WORK IN PROGRESS, only usefull for debian-installer"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000268
Eric Andersen7e9276b2001-02-22 01:15:47 +0000269#define dpkg_deb_trivial_usage \
Glenn L McGrath31369042001-04-15 12:53:24 +0000270 "[-cefItxX] file [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000271#define dpkg_deb_full_usage \
272 "Perform actions on debian packages (.debs)\n\n" \
273 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000274 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000275 "\t-e\tExtract control files to [argument] directory\n" \
276 "\t-f\tDisplay control field name starting with [argument]\n" \
277 "\t-I\tDisplay the control filenamed [argument]\n" \
278 "\t-t\tExtract filesystem tree to stdout in tar format\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000279 "\t-x\tExctract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000280 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000281#define dpkg_deb_example_usage \
282 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000283
Eric Andersen7e9276b2001-02-22 01:15:47 +0000284#define du_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +0000285 "[-ls" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000286#define du_full_usage \
287 "Summarizes disk space used for each FILE and/or directory.\n" \
288 "Disk space is printed in units of 1024 bytes.\n\n" \
289 "Options:\n" \
290 "\t-l\tcount sizes many times if hard linked\n" \
291 "\t-s\tdisplay only a total for each argument" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000292 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000293 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
294 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000295 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000296 "\n\t-k\tprint sizes in kilobytes(compatability)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000297#define du_example_usage \
298 "$ du\n" \
299 "16 ./CVS\n" \
300 "12 ./kernel-patches/CVS\n" \
301 "80 ./kernel-patches\n" \
302 "12 ./tests/CVS\n" \
303 "36 ./tests\n" \
304 "12 ./scripts/CVS\n" \
305 "16 ./scripts\n" \
306 "12 ./docs/CVS\n" \
307 "104 ./docs\n" \
308 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000309
Eric Andersen7e9276b2001-02-22 01:15:47 +0000310#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000311 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000312#define dumpkmap_full_usage \
313 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000314#define dumpkmap_example_usage \
315 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000316
Eric Andersen7e9276b2001-02-22 01:15:47 +0000317#define dutmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000318 "[FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000319#define dutmp_full_usage \
320 "Dump utmp file format (pipe delimited) from FILE\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000321 "or stdin to stdout. (i.e. 'dutmp /var/run/utmp')"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000322#define dutmp_example_usage \
323 "$ dutmp /var/run/utmp\n" \
324 "8|7||si|||0|0|0|955637625|760097|0\n" \
325 "2|0|~|~~|reboot||0|0|0|955637625|782235|0\n" \
326 "1|20020|~|~~|runlevel||0|0|0|955637625|800089|0\n" \
327 "8|125||l4|||0|0|0|955637629|998367|0\n" \
328 "6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0\n" \
329 "6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0\n" \
330 "7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000331
Eric Andersen7e9276b2001-02-22 01:15:47 +0000332#define echo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000333 "[-neE] [ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000334#define echo_full_usage \
335 "Prints the specified ARGs to stdout\n\n" \
336 "Options:\n" \
337 "\t-n\tsuppress trailing newline\n" \
338 "\t-e\tinterpret backslash-escaped characters (i.e. \\t=tab etc)\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000339 "\t-E\tdisable interpretation of backslash-escaped characters"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000340#define echo_example_usage \
341 "$ echo "Erik is cool"\n" \
342 "Erik is cool\n" \
John Beppu5d817682001-04-17 17:09:34 +0000343 "$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000344 "Erik\n" \
345 "is\n" \
346 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000347 "$ echo "Erik\\nis\\ncool"\n" \
348 "Erik\\nis\\ncool\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000349
Eric Andersen84e229c2001-03-29 22:48:33 +0000350#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000351 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000352#define env_full_usage \
353 "Prints the current environment or runs a program after setting\n" \
354 "up the specified environment.\n\n" \
355 "Options:\n" \
356 "\t-, -i\tstart with an empty environment\n" \
357 "\t-u\tremove variable from the environment\n"
358
Eric Andersen7e9276b2001-02-22 01:15:47 +0000359#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000360 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000361#define expr_full_usage \
362 "Prints the value of EXPRESSION to standard output.\n\n" \
363 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000364 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
365 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
366 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
367 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
368 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
369 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
370 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
371 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
372 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
373 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
374 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
375 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
376 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000377 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
378 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
379 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
380 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
381 "\t or 0\n" \
382 "\tlength STRING length of STRING\n" \
383 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
384 "\t it is a keyword like `match' or an\n" \
385 "\t operator like `/'\n" \
386 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000387 "Beware that many operators need to be escaped or quoted for shells.\n" \
388 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
389 "lexicographical. Pattern matches return the string matched between \n" \
390 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
391 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000392
Eric Andersen7e9276b2001-02-22 01:15:47 +0000393#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000394 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000395#define false_full_usage \
396 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000397#define false_example_usage \
398 "$ false\n" \
399 "$ echo $?\n" \
400 "1\n"
401
402#define fbset_trivial_usage \
403 "[options] [mode]"
404#define fbset_full_usage \
405 "Show and modify frame buffer settings"
406#define fbset_example_usage \
407 "$ fbset\n" \
408 "mode "1024x768-76"\n" \
409 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
410 "\tgeometry 1024 768 1024 768 16\n" \
411 "\ttimings 12714 128 32 16 4 128 4\n" \
412 "\taccel false\n" \
413 "\trgba 5/11,6/5,5/0,0/0\n" \
414 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000415
Eric Andersen7e9276b2001-02-22 01:15:47 +0000416#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000417 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000418#define fdflush_full_usage \
419 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000420
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000421#ifdef BB_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000422 #define USAGE_FIND_TYPE(a) a
423#else
424 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000425#endif
426#ifdef BB_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000427 #define USAGE_FIND_PERM(a) a
428#else
429 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000430#endif
431#ifdef BB_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000432 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000433#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000434 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000435#endif
436
Eric Andersen7e9276b2001-02-22 01:15:47 +0000437#define find_trivial_usage \
438 "[PATH...] [EXPRESSION]"
439#define find_full_usage \
440 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000441 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000442 "\nEXPRESSION may consist of:\n" \
443 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000444 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000445 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000446 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000447 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
448) USAGE_FIND_PERM( \
449 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
450) USAGE_FIND_MTIME( \
451 "\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 +0000452#define find_example_usage \
453 "$ find / -name /etc/passwd\n" \
454 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000455
Eric Andersen7e9276b2001-02-22 01:15:47 +0000456#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000457 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000458#define free_full_usage \
459 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000460#define free_example_usage \
461 "$ free\n" \
462 " total used free shared buffers\n" \
463 " Mem: 257628 248724 8904 59644 93124\n" \
464 " Swap: 128516 8404 120112\n" \
465 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000466
Eric Andersen7e9276b2001-02-22 01:15:47 +0000467#define freeramdisk_trivial_usage \
468 "DEVICE"
469#define freeramdisk_full_usage \
470 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000471#define freeramdisk_example_usage \
472 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000473
474#define fsck_minix_trivial_usage \
475 "[-larvsmf] /dev/name"
476#define fsck_minix_full_usage \
477 "Performs a consistency check for MINIX filesystems.\n\n" \
478 "Options:\n" \
479 "\t-l\tLists all filenames\n" \
480 "\t-r\tPerform interactive repairs\n" \
481 "\t-a\tPerform automatic repairs\n" \
482 "\t-v\tverbose\n" \
483 "\t-s\tOutputs super-block information\n" \
484 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
485 "\t-f\tForce file system check."
486
487#define getopt_trivial_usage \
488 "[OPTIONS]..."
489#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000490 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000491 "\t-a, --alternative Allow long options starting with single -\n" \
492 "\t-l, --longoptions=longopts Long options to be recognized\n" \
493 "\t-n, --name=progname The name under which errors are reported\n" \
494 "\t-o, --options=optstring Short options to be recognized\n" \
495 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
496 "\t-Q, --quiet-output No normal output\n" \
497 "\t-s, --shell=shell Set shell quoting conventions\n" \
498 "\t-T, --test Test for getopt(1) version\n" \
499 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000500#define getopt_example_usage \
501 "$ cat getopt.test\n" \
502 "#!/bin/sh\n" \
503 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
504 " -n 'example.busybox' -- "$@"`\n" \
505 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
506 "eval set -- "$GETOPT"\n" \
507 "while true ; do\n" \
508 " case $1 in\n" \
509 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
510 " -b|--b-long) echo \"Option b, argument \`$2'\" ; shift 2 ;;\n" \
511 " -c|--c-long)\n" \
512 " case "$2" in\n" \
513 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
514 " *) echo \"Option c, argument \`$2'\" ; shift 2 ;;\n" \
515 " esac ;;\n" \
516 " --) shift ; break ;;\n" \
517 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
518 " esac\n" \
519 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000520
521#define grep_trivial_usage \
522 "[-ihHnqvs] pattern [files...]"
523#define grep_full_usage \
524 "Search for PATTERN in each FILE or standard input.\n\n" \
525 "Options:\n" \
526 "\t-H\tprefix output lines with filename where match was found\n" \
527 "\t-h\tsuppress the prefixing filename on output\n" \
528 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000529 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000530 "\t-n\tprint line number with output lines\n" \
531 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
532 "\t-v\tselect non-matching lines\n" \
533 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000534#define grep_example_usage \
535 "$ grep root /etc/passwd\n" \
536 "root:x:0:0:root:/root:/bin/bash\n" \
537 "$ grep ^[rR]oo. /etc/passwd\n" \
538 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000539
Eric Andersen7e9276b2001-02-22 01:15:47 +0000540#define gunzip_trivial_usage \
541 "[OPTION]... FILE"
542#define gunzip_full_usage \
543 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
544 "Options:\n" \
545 "\t-c\tWrite output to standard output\n" \
546 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000547#define gunzip_example_usage \
548 "$ ls -la /tmp/BusyBox*\n" \
549 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
550 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
551 "$ ls -la /tmp/BusyBox*\n" \
552 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000553
554#define gzip_trivial_usage \
555 "[OPTION]... FILE"
556#define gzip_full_usage \
557 "Compress FILE with maximum compression.\n" \
558 "When FILE is '-', reads standard input. Implies -c.\n\n" \
559 "Options:\n" \
560 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
561 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000562#define gzip_example_usage \
563 "$ ls -la /tmp/BusyBox*\n" \
564 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n" \
565 "$ gzip /tmp/BusyBox-0.43.tar\n" \
566 "$ ls -la /tmp/BusyBox*\n" \
567 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/BusyBox-0.43.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000568
569#define halt_trivial_usage \
570 ""
571#define halt_full_usage \
572 "Halt the system."
573
574#define head_trivial_usage \
575 "[OPTION] [FILE]..."
576#define head_full_usage \
577 "Print first 10 lines of each FILE to standard output.\n" \
578 "With more than one FILE, precede each with a header giving the\n" \
579 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000580 "Options:\n" \
581 "\t-n NUM\t\tPrint first NUM lines instead of first 10"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000582#define head_example_usage \
583 "$ head -n 2 /etc/passwd\n" \
584 "root:x:0:0:root:/root:/bin/bash\n" \
585 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000586
587#define hostid_trivial_usage \
588 ""
589#define hostid_full_usage \
590 "Print out a unique 32-bit identifier for the machine."
591
592#define hostname_trivial_usage \
593 "[OPTION] {hostname | -F file}"
594#define hostname_full_usage \
595 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
596 "(or a file with the -F parameter), the host name will be set.\n\n" \
597 "Options:\n" \
598 "\t-s\t\tShort\n" \
599 "\t-i\t\tAddresses for the hostname\n" \
600 "\t-d\t\tDNS domain name\n" \
601 "\t-F, --file FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000602#define hostname_example_usage \
603 "$ hostname\n" \
604 "slag \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000605
606#define id_trivial_usage \
607 "[OPTIONS]... [USERNAME]"
608#define id_full_usage \
609 "Print information for USERNAME or the current user\n\n" \
610 "Options:\n" \
611 "\t-g\tprints only the group ID\n" \
612 "\t-u\tprints only the user ID\n" \
613 "\t-n\tprint a name instead of a number (with for -ug)\n" \
614 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000615#define id_example_usage \
616 "$ id\n" \
617 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000618
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000619#ifdef BB_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +0000620 #define USAGE_SIOCSKEEPALIVE(a) a
621#else
622 #define USAGE_SIOCSKEEPALIVE(a)
623#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000624#ifdef BB_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
625 #define USAGE_IFCONFIG_MII(a) a
626#else
627 #define USAGE_IFCONFIG_MII(a)
628#endif
629#ifdef BB_FEATURE_IFCONFIG_HW
630 #define USAGE_IFCONFIG_HW(a) a
631#else
632 #define USAGE_IFCONFIG_HW(a)
633#endif
634#ifdef BB_FEATURE_IFCONFIG_STATUS
635 #define USAGE_IFCONFIG_OPT_A(a) a
636#else
637 #define USAGE_IFCONFIG_OPT_A(a)
638#endif
639
Eric Andersen7e9276b2001-02-22 01:15:47 +0000640#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000641 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000642#define ifconfig_full_usage \
643 "configure a network interface\n\n" \
644 "Options:\n" \
645 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000646 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000647 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000648 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
649 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000650 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000651 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
652 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000653 "\t[up|down] ..."
654
655#define init_trivial_usage \
656 ""
657#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000658 "Init is the parent of all processes."
659#define init_notes_usage \
660"This version of init is designed to be run only by the kernel.\n" \
661"\n" \
662"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
663"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
664"runlevels, use sysvinit.\n" \
665"\n" \
666"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
667"it has the following default behavior:\n" \
668"\n" \
669" ::sysinit:/etc/init.d/rcS\n" \
670" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000671" ::ctrlaltdel:/sbin/reboot\n" \
672" ::shutdown:/sbin/swapoff -a\n" \
673" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000674"\n" \
675"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
676"\n" \
677" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000678" tty3::askfirst:/bin/sh\n" \
679" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000680"\n" \
681"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
682"\n" \
683" <id>:<runlevels>:<action>:<process>\n" \
684"\n" \
685" <id>: \n" \
686"\n" \
687" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
688" The id field is used by BusyBox init to specify the controlling tty for\n" \
689" the specified process to run on. The contents of this field are\n" \
690" appended to "/dev/" and used as-is. There is no need for this field to\n" \
691" be unique, although if it isn't you may have strange results. If this\n" \
692" field is left blank, the controlling tty is set to the console. Also\n" \
693" note that if BusyBox detects that a serial console is in use, then only\n" \
694" entries whose controlling tty is either the serial console or /dev/null\n" \
695" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
696" stinkin' utmp.\n" \
697"\n" \
698" <runlevels>: \n" \
699"\n" \
700" The runlevels field is completely ignored.\n" \
701"\n" \
702" <action>: \n" \
703"\n" \
704" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000705" once, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000706"\n" \
707" The available actions can be classified into two groups: actions\n" \
708" that are run only once, and actions that are re-run when the specified\n" \
709" process exits.\n" \
710"\n" \
711" Run only-once actions:\n" \
712"\n" \
713" 'sysinit' is the first item run on boot. init waits until all\n" \
714" sysinit actions are completed before continuing. Following the\n" \
715" completion of all sysinit actions, all 'wait' actions are run.\n" \
716" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
717" the specified task completes. 'once' actions are asyncronous,\n" \
718" therefore, init does not wait for them to complete. 'ctrlaltdel'\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000719" actions are run when the system detects that someone on the system\n" \
720" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
721" wants to run 'reboot' at this point to cause the system to reboot.\n" \
722" Finally the 'shutdown' action specifies the actions to taken when\n" \
723" init is told to reboot. Unmounting filesystems and disabling swap\n" \
724" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000725"\n" \
726" Run repeatedly actions:\n" \
727"\n" \
728" 'respawn' actions are run after the 'once' actions. When a process\n" \
729" started with a 'respawn' action exits, init automatically restarts\n" \
730" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
731" respawning out of control. The 'askfirst' actions acts just like\n" \
732" respawn, except that before running the specified process it\n" \
733" displays the line "Please press Enter to activate this console."\n" \
734" and then waits for the user to press enter before starting the\n" \
735" specified process. \n" \
736"\n" \
737" Unrecognized actions (like initdefault) will cause init to emit an\n" \
738" error message, and then go along with its business. All actions are\n" \
739" run in the reverse order from how they appear in /etc/inittab.\n" \
740"\n" \
741" <process>: \n" \
742"\n" \
743" Specifies the process to be executed and it's command line.\n" \
744"\n" \
745"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +0000746"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000747" # This is run first except when booting in single-user mode.\n" \
748" #\n" \
749" ::sysinit:/etc/init.d/rcS\n" \
750" \n" \
751" # /bin/sh invocations on selected ttys\n" \
752" #\n" \
753" # Start an "askfirst" shell on the console (whatever that may be)\n" \
754" ::askfirst:-/bin/sh\n" \
755" # Start an "askfirst" shell on /dev/tty2-4\n" \
756" tty2::askfirst:-/bin/sh\n" \
757" tty3::askfirst:-/bin/sh\n" \
758" tty4::askfirst:-/bin/sh\n" \
759" \n" \
760" # /sbin/getty invocations for selected ttys\n" \
761" #\n" \
762" tty4::respawn:/sbin/getty 38400 tty5\n" \
763" tty5::respawn:/sbin/getty 38400 tty6\n" \
764" \n" \
765" \n" \
766" # Example of how to put a getty on a serial line (for a terminal)\n" \
767" #\n" \
768" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
769" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
770" #\n" \
771" # Example how to put a getty on a modem line.\n" \
772" #::respawn:/sbin/getty 57600 ttyS2\n" \
773" \n" \
774" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000775" ::ctrlaltdel:/sbin/reboot\n" \
776" ::shutdown:/bin/umount -a -r\n" \
777" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000778
779#define insmod_trivial_usage \
780 "[OPTION]... MODULE [symbol=value]..."
781#define insmod_full_usage \
782 "Loads the specified kernel modules into the kernel.\n\n" \
783 "Options:\n" \
784 "\t-f\tForce module to load into the wrong kernel version.\n" \
785 "\t-k\tMake module autoclean-able.\n" \
786 "\t-v\tverbose output\n" \
787 "\t-L\tLock to prevent simultaneous loads of a module\n" \
788 "\t-x\tdo not export externs"
789
790#define kill_trivial_usage \
791 "[-signal] process-id [process-id ...]"
792#define kill_full_usage \
793 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +0000794 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000795 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000796#define kill_example_usage \
797 "$ ps | grep apache\n" \
798 "252 root root S [apache]\n" \
799 "263 www-data www-data S [apache]\n" \
800 "264 www-data www-data S [apache]\n" \
801 "265 www-data www-data S [apache]\n" \
802 "266 www-data www-data S [apache]\n" \
803 "267 www-data www-data S [apache]\n" \
804 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000805
806#define killall_trivial_usage \
807 "[-signal] process-name [process-name ...]"
808#define killall_full_usage \
809 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000810 "Options:\n" \
811 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000812#define killall_example_usage \
813 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000814
Mark Whitley6317c4b2001-03-12 22:51:50 +0000815#define klogd_trivial_usage \
816 "-n"
817#define klogd_full_usage \
818 "Kernel logger.\n"\
819 "Options:\n"\
820 "\t-n\tRun as a foreground process."
821
Eric Andersen7e9276b2001-02-22 01:15:47 +0000822#define length_trivial_usage \
823 "STRING"
824#define length_full_usage \
825 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000826#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +0000827 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000828 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000829
830#define ln_trivial_usage \
831 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
832#define ln_full_usage \
833 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
834 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
835 "Options:\n" \
836 "\t-s\tmake symbolic links instead of hard links\n" \
837 "\t-f\tremove existing destination files\n" \
838 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000839#define ln_example_usage \
840 "$ ln -s BusyBox /tmp/ls\n" \
841 "$ ls -l /tmp/ls\n" \
842 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000843
844#define loadacm_trivial_usage \
845 "< mapfile"
846#define loadacm_full_usage \
847 "Loads an acm from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000848#define loadacm_example_usage \
849 "$ loadacm < /etc/i18n/acmname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000850
851#define loadfont_trivial_usage \
852 "< font"
853#define loadfont_full_usage \
854 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000855#define loadfont_example_usage \
856 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000857
858#define loadkmap_trivial_usage \
859 "< keymap"
860#define loadkmap_full_usage \
861 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000862#define loadkmap_example_usage \
863 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000864
865#define logger_trivial_usage \
866 "[OPTION]... [MESSAGE]"
867#define logger_full_usage \
868 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
869 "Options:\n" \
870 "\t-s\tLog to stderr as well as the system log.\n" \
871 "\t-t\tLog using the specified tag (defaults to user name).\n" \
872 "\t-p\tEnter the message with the specified priority.\n" \
873 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000874#define logger_example_usage \
875 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000876
877#define logname_trivial_usage \
878 ""
879#define logname_full_usage \
880 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000881#define logname_example_usage \
882 "$ logname\n" \
883 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000884
Mark Whitley6317c4b2001-03-12 22:51:50 +0000885#define logread_trivial_usage \
886 ""
887
888#define logread_full_usage \
889 "Shows the messages from syslogd (using circular buffer)."
890
Eric Andersen7e9276b2001-02-22 01:15:47 +0000891#ifdef BB_FEATURE_LS_TIMESTAMPS
892 #define USAGE_LS_TIMESTAMPS(a) a
893#else
894 #define USAGE_LS_TIMESTAMPS(a)
895#endif
896#ifdef BB_FEATURE_LS_FILETYPES
897 #define USAGE_LS_FILETYPES(a) a
898#else
899 #define USAGE_LS_FILETYPES(a)
900#endif
901#ifdef BB_FEATURE_LS_FOLLOWLINKS
902 #define USAGE_LS_FOLLOWLINKS(a) a
903#else
904 #define USAGE_LS_FOLLOWLINKS(a)
905#endif
906#ifdef BB_FEATURE_LS_RECURSIVE
907 #define USAGE_LS_RECURSIVE(a) a
908#else
909 #define USAGE_LS_RECURSIVE(a)
910#endif
911#ifdef BB_FEATURE_LS_SORTFILES
912 #define USAGE_LS_SORTFILES(a) a
913#else
914 #define USAGE_LS_SORTFILES(a)
915#endif
916#ifdef BB_FEATURE_AUTOWIDTH
917 #define USAGE_AUTOWIDTH(a) a
918#else
919 #define USAGE_AUTOWIDTH(a)
920#endif
921#define ls_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +0000922 "[-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 +0000923#define ls_full_usage \
924 "List directory contents\n\n" \
925 "Options:\n" \
926 "\t-1\tlist files in a single column\n" \
927 "\t-A\tdo not list implied . and ..\n" \
928 "\t-a\tdo not hide entries starting with .\n" \
929 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000930 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000931 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000932 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
933 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000934 "\t-i\tlist the i-node for each file\n" \
935 "\t-l\tuse a long listing format\n" \
936 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000937 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
938 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
939 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
940 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
941 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000942 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000943 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
944 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
945 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
946 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
947 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000948 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000949 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
950 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000951 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000952 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000953 "\t-k\tprint sizes in kilobytes(compatability)")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000954
955#define lsmod_trivial_usage \
956 ""
957#define lsmod_full_usage \
958 "List the currently loaded kernel modules."
959
960#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000961 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000962#define makedevs_full_usage \
963 "Creates a range of block or character special files\n\n" \
964 "TYPEs include:\n" \
965 "\tb:\tMake a block (buffered) device.\n" \
966 "\tc or u:\tMake a character (un-buffered) device.\n" \
967 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
968 "FIRST specifies the number appended to NAME to create the first device.\n" \
969 "LAST specifies the number of the last item that should be created.\n" \
970 "If 's' is the last argument, the base device is created as well.\n\n" \
971 "For example:\n" \
972 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000973 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000974#define makedevs_example_usage \
975 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
976 "[creates ttyS2-ttyS63]\n" \
977 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
978 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000979
Eric Andersen7e9276b2001-02-22 01:15:47 +0000980#define md5sum_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000981 "[OPTION] [FILE]...\n" \
982 "or: md5sum [OPTION] -c [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000983#define md5sum_full_usage \
984 "Print or check MD5 checksums.\n\n" \
985 "Options:\n" \
986 "With no FILE, or when FILE is -, read standard input.\n\n" \
987 "\t-b\tread files in binary mode\n" \
988 "\t-c\tcheck MD5 sums against given list\n" \
989 "\t-t\tread files in text mode (default)\n" \
990 "\t-g\tread a string\n" \
991 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000992 "\t-s\tdon't output anything, status code shows success\n" \
993 "\t-w\twarn about improperly formated MD5 checksum lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000994#define md5sum_example_usage \
995 "$ md5sum < busybox\n" \
996 "6fd11e98b98a58f64ff3398d7b324003\n" \
997 "$ md5sum busybox\n" \
998 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
999 "$ md5sum -c -\n" \
1000 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1001 "busybox: OK\n" \
1002 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001003
Eric Andersen7e9276b2001-02-22 01:15:47 +00001004#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001005 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001006#define mkdir_full_usage \
1007 "Create the DIRECTORY(ies), if they do not already exist\n\n" \
1008 "Options:\n" \
1009 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001010 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001011#define mkdir_example_usage \
1012 "$ mkdir /tmp/foo\n" \
1013 "$ mkdir /tmp/foo\n" \
1014 "/tmp/foo: File exists\n" \
1015 "$ mkdir /tmp/foo/bar/baz\n" \
1016 "/tmp/foo/bar/baz: No such file or directory\n" \
1017 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001018
Eric Andersen7e9276b2001-02-22 01:15:47 +00001019#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001020 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001021#define mkfifo_full_usage \
1022 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1023 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001024 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001025
Eric Andersen7e9276b2001-02-22 01:15:47 +00001026#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001027 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001028#define mkfs_minix_full_usage \
1029 "Make a MINIX filesystem.\n\n" \
1030 "Options:\n" \
1031 "\t-c\t\tCheck the device for bad blocks\n" \
1032 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1033 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1034 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001035 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001036
Eric Andersen7e9276b2001-02-22 01:15:47 +00001037#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001038 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001039#define mknod_full_usage \
1040 "Create a special file (block, character, or pipe).\n\n" \
1041 "Options:\n" \
1042 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1043 "TYPEs include:\n" \
1044 "\tb:\tMake a block (buffered) device.\n" \
1045 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001046 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001047#define mknod_example_usage \
1048 "$ mknod /dev/fd0 b 2 0 \n" \
1049 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001050
Eric Andersen7e9276b2001-02-22 01:15:47 +00001051#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001052 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001053#define mkswap_full_usage \
1054 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001055 "Options:\n" \
1056 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001057 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001058 "\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 +00001059 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001060
Eric Andersen7e9276b2001-02-22 01:15:47 +00001061#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001062 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001063#define mktemp_full_usage \
1064 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001065 "TEMPLATE is any name with six `Xs' (i.e. /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001066#define mktemp_example_usage \
1067 "$ mktemp /tmp/temp.XXXXXX\n" \
1068 "/tmp/temp.mWiLjM\n" \
1069 "$ ls -la /tmp/temp.mWiLjM\n" \
1070 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001071
Eric Andersen7e9276b2001-02-22 01:15:47 +00001072#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001073 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001074#define more_full_usage \
1075 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001076#define more_example_usage \
1077 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001078
Eric Andersen7e9276b2001-02-22 01:15:47 +00001079#ifdef BB_FEATURE_MOUNT_LOOP
1080 #define USAGE_MOUNT_LOOP(a) a
1081#else
1082 #define USAGE_MOUNT_LOOP(a)
1083#endif
Eric Andersenc4cef5a2001-04-01 16:01:11 +00001084#ifdef BB_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001085 #define USAGE_MTAB(a) a
1086#else
1087 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001088#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001089#define mount_trivial_usage \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001090 "[flags] device node [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001091#define mount_full_usage \
1092 "Mount a filesystem\n\n" \
1093 "Flags:\n" \
1094 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001095 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001096 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001097 "\t-n:\t\tDon't write a mount table entry.\n" \
1098 ) \
1099 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1100 "\t-r:\t\tMount the filesystem read-only.\n" \
1101 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1102 "\t-w:\t\tMount for reading and writing (default).\n" \
1103 "\n" \
1104 "Options for use with the \"-o\" flag:\n" \
1105 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1106 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1107 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1108 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001109 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001110 "\tloop:\t\tMounts a file via loop device.\n" \
1111 ) \
1112 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001113 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001114 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001115 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001116 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001117 "You'll have to see the written documentation for those."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001118#define mount_example_usage \
1119 "$ mount\n" \
1120 "/dev/hda3 on / type minix (rw)\n" \
1121 "proc on /proc type proc (rw)\n" \
1122 "devpts on /dev/pts type devpts (rw)\n" \
1123 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1124 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001125
Eric Andersen7e9276b2001-02-22 01:15:47 +00001126#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001127 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001128#define mt_full_usage \
1129 "Control magnetic tape drive operation\n" \
1130 "\nAvailable Opcodes:\n\n" \
1131 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1132 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
1133 "ras3 reset retension rew rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001134 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001135
Eric Andersen7e9276b2001-02-22 01:15:47 +00001136#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001137 "SOURCE DEST\n" \
1138 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001139#define mv_full_usage \
1140 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001141#define mv_example_usage \
1142 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001143
Eric Andersen7e9276b2001-02-22 01:15:47 +00001144#define nc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001145 "[IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001146#define nc_full_usage \
1147 "Netcat opens a pipe to IP:port"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001148#define nc_example_usage \
1149 "$ nc foobar.somedomain.com 25\n" \
1150 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1151 "help\n" \
1152 "214-Commands supported:\n" \
1153 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1154 "214 NOOP QUIT RSET HELP\n" \
1155 "quit\n" \
1156 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001157
Eric Andersen7e9276b2001-02-22 01:15:47 +00001158#define nslookup_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001159 "[HOST]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001160#define nslookup_full_usage \
1161 "Queries the nameserver for the IP address of the given HOST"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001162#define nslookup_example_usage \
1163 "$ nslookup localhost\n" \
1164 "Server: default\n" \
1165 "Address: default\n" \
1166 "\n" \
1167 "Name: debian\n" \
1168 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001169
Eric Andersen7e9276b2001-02-22 01:15:47 +00001170#ifdef BB_FEATURE_SIMPLE_PING
1171#define ping_trivial_usage "host"
1172#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1173#else
1174#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001175 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001176#define ping_full_usage \
1177 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1178 "Options:\n" \
1179 "\t-c COUNT\tSend only COUNT pings.\n" \
1180 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1181 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001182 "\t\t\tand when finished."
1183#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001184#define ping_example_usage \
1185 "$ ping localhost\n" \
1186 "PING slag (127.0.0.1): 56 data bytes\n" \
1187 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1188 "\n" \
1189 "--- debian ping statistics ---\n" \
1190 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1191 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001192
Eric Andersen7e9276b2001-02-22 01:15:47 +00001193#define pivot_root_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001194 "new_root put_old"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001195#define pivot_root_full_usage \
1196 "Move the current root file system to put_old and make new_root\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001197 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001198
Eric Andersen7e9276b2001-02-22 01:15:47 +00001199#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001200 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001201#define poweroff_full_usage \
1202 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001203
Eric Andersen7e9276b2001-02-22 01:15:47 +00001204#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001205 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001206#define printf_full_usage \
1207 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001208 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001209#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001210 "$ printf "Val=%d\\n" 5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001211 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001212
Eric Andersen7e9276b2001-02-22 01:15:47 +00001213#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001214 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001215#define ps_full_usage \
1216 "Report process status\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001217 "\nThis version of ps accepts no options."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001218#define ps_example_usage \
1219 "$ ps\n" \
1220 " PID Uid Gid State Command\n" \
1221 " 1 root root S init\n" \
1222 " 2 root root S [kflushd]\n" \
1223 " 3 root root S [kupdate]\n" \
1224 " 4 root root S [kpiod]\n" \
1225 " 5 root root S [kswapd]\n" \
1226 " 742 andersen andersen S [bash]\n" \
1227 " 743 andersen andersen S -bash\n" \
1228 " 745 root root S [getty]\n" \
1229 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001230
Eric Andersen7e9276b2001-02-22 01:15:47 +00001231#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001232 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001233#define pwd_full_usage \
1234 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001235#define pwd_example_usage \
1236 "$ pwd\n" \
1237 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001238
Eric Andersen7e9276b2001-02-22 01:15:47 +00001239#define rdate_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001240 "[OPTION] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001241#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001242 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001243 "Options:\n" \
1244 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001245 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001246
Eric Andersen7e9276b2001-02-22 01:15:47 +00001247#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001248 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001249#define readlink_full_usage \
1250 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001251
Eric Andersen7e9276b2001-02-22 01:15:47 +00001252#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001253 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001254#define reboot_full_usage \
1255 "Reboot the system."
1256
1257#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001258 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001259#define renice_full_usage \
1260 "Changes priority of running processes. Allowed priorities range\n" \
1261 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001262 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001263
Eric Andersen7e9276b2001-02-22 01:15:47 +00001264#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001265 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001266#define reset_full_usage \
1267 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001268
Eric Andersen7e9276b2001-02-22 01:15:47 +00001269#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001270 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001271#define rm_full_usage \
1272 "Remove (unlink) the FILE(s). You may use '--' to\n" \
1273 "indicate that all following arguments are non-options.\n\n" \
1274 "Options:\n" \
Mark Whitley27899062001-04-25 22:08:56 +00001275 "\t-i\t\talways prompt before removing each destinations\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001276 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001277 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001278#define rm_example_usage \
1279 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001280
Eric Andersen7e9276b2001-02-22 01:15:47 +00001281#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001282 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001283#define rmdir_full_usage \
1284 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001285#define rmdir_example_usage \
1286 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001287
Eric Andersen7e9276b2001-02-22 01:15:47 +00001288#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001289 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001290#define rmmod_full_usage \
1291 "Unloads the specified kernel modules from the kernel.\n\n" \
1292 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001293 "\t-a\tTry to remove all unused kernel modules."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001294#define rmmod_example_usage \
1295 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001296
Eric Andersen7e9276b2001-02-22 01:15:47 +00001297#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001298 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001299#define route_full_usage \
1300 "Edit the kernel's routing tables"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001301
Eric Andersen7e9276b2001-02-22 01:15:47 +00001302#define rpmunpack_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001303 "< package.rpm | gunzip | cpio -idmuv"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001304#define rpmunpack_full_usage \
1305 "Extracts an rpm archive."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001306
Eric Andersen7e9276b2001-02-22 01:15:47 +00001307#define sed_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001308 "[-Vhnef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001309#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001310 "Options:\n" \
1311 "\t-n\t\tsuppress automatic printing of pattern space\n" \
1312 "\t-e script\tadd the script to the commands to be executed\n" \
1313 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
1314 "\t-h\t\tdisplay this help message\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001315 "\n" \
1316 "If no -e or -f is given, the first non-option argument is taken as the\n" \
1317 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001318 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001319#define sed_example_usage \
1320 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
1321 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001322
Eric Andersen7e9276b2001-02-22 01:15:47 +00001323#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001324 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001325#define setkeycodes_full_usage \
1326 "Set entries into the kernel's scancode-to-keycode map,\n" \
1327 "allowing unusual keyboards to generate usable keycodes.\n\n" \
1328 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001329 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001330#define setkeycodes_example_usage \
1331 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001332
Eric Andersen7e9276b2001-02-22 01:15:47 +00001333#define sh_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001334 "[FILE]...\n" \
1335 "or: sh -c command [args]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001336#define sh_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001337 "lash: The BusyBox LAme SHell (command interpreter)"
1338#define sh_notes_usage \
1339"This command does not yet have proper documentation.\n" \
1340"\n" \
1341"Use lash just as you would use any other shell. It properly handles pipes,\n" \
1342"redirects, job control, can be used as the shell for scripts, and has a\n" \
1343"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
1344"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
1345"use ash or bash. If you just need a very simple and extremely small shell,\n" \
1346"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001347
Eric Andersen7e9276b2001-02-22 01:15:47 +00001348#define sleep_trivial_usage \
1349 "N"
1350#define sleep_full_usage \
1351 "Pause for N seconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001352#define sleep_example_usage \
1353 "$ sleep 2\n" \
1354 "[2 second delay results]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001355
Eric Andersen7e9276b2001-02-22 01:15:47 +00001356
Mark Whitleyfccaa362001-04-17 18:56:18 +00001357#ifdef BB_FEATURE_SORT_UNIQUE
1358 #define USAGE_SORT_UNIQUE(a) a
1359#else
1360 #define USAGE_SORT_UNIQUE(a)
1361#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001362#ifdef BB_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001363 #define USAGE_SORT_REVERSE(a) a
1364#else
1365 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001366#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001367#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001368 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001369#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001370 "Sorts lines of text in the specified files\n\n"\
1371 "Options:\n" \
1372 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
1373 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
1374 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001375#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001376 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001377 "a\n" \
1378 "b\n" \
1379 "c\n" \
1380 "d\n" \
1381 "e\n" \
1382 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001383
Eric Andersen7e9276b2001-02-22 01:15:47 +00001384#define stty_trivial_usage \
1385 "[-a|g] [-F device] [SETTING]..."
1386#define stty_full_usage \
1387 "Without arguments, prints baud rate, line discipline," \
1388 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001389 "\n\nOptions:" \
1390 "\n\t-F device\topen device instead of stdin" \
1391 "\n\t-a\t\tprint all current settings in human-readable form" \
1392 "\n\t-g\t\tprint in stty-readable form" \
1393 "\n\t[SETTING]\tsee documentation"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001394
Eric Andersen7e9276b2001-02-22 01:15:47 +00001395#define swapoff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001396 "[OPTION] [device]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001397#define swapoff_full_usage \
1398 "Stop swapping virtual memory pages on the given device.\n\n" \
1399 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001400 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001401
Eric Andersen7e9276b2001-02-22 01:15:47 +00001402#define swapon_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001403 "[OPTION] [device]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001404#define swapon_full_usage \
1405 "Start swapping virtual memory pages on the given device.\n\n" \
1406 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001407 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001408
Eric Andersen7e9276b2001-02-22 01:15:47 +00001409#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001410 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001411#define sync_full_usage \
1412 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001413
Eric Andersen7e9276b2001-02-22 01:15:47 +00001414
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001415#ifdef BB_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00001416 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001417#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00001418 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001419#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001420#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001421 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001422#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00001423 "Linux system and kernel logging utility.\n" \
1424 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001425 "Options:\n" \
1426 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
1427 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001428 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001429 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00001430 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
1431 "\t-L\t\tLog locally and via network logging (default is network only)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001432#define syslogd_example_usage \
1433 "$ syslogd -R masterlog:514\n" \
1434 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001435
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001436
Eric Andersen7e9276b2001-02-22 01:15:47 +00001437#ifdef BB_FEATURE_SIMPLE_TAIL
1438 #define USAGE_UNSIMPLE_TAIL(a)
1439#else
1440 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001441#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001442#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001443 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001444#define tail_full_usage \
1445 "Print last 10 lines of each FILE to standard output.\n" \
1446 "With more than one FILE, precede each with a header giving the\n" \
1447 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
1448 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001449 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001450 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
1451 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001452 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001453 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
1454 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001455 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001456 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001457 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
1458#define tail_example_usage \
1459 "$ tail -n 1 /etc/resolv.conf\n" \
1460 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001461
Eric Andersen7e9276b2001-02-22 01:15:47 +00001462#ifdef BB_FEATURE_TAR_CREATE
1463 #define USAGE_TAR_CREATE(a) a
1464#else
1465 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001466#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001467#ifdef BB_FEATURE_TAR_EXCLUDE
1468 #define USAGE_TAR_EXCLUDE(a) a
1469#else
1470 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001471#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001472#define tar_trivial_usage \
1473 "-[" USAGE_TAR_CREATE("c") "xtvO] " \
1474 USAGE_TAR_EXCLUDE("[--exclude File] [-X File]") \
1475 "[-f tarFile] [FILE(s)] ..."
1476#define tar_full_usage \
1477 "Create, extract, or list files from a tar file.\n\n" \
1478 "Main operation mode:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001479 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001480 "\tx\t\textract\n" \
1481 "\tt\t\tlist\n" \
1482 "\nFile selection:\n" \
1483 "\tf\t\tname of tarfile or \"-\" for stdin\n" \
1484 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001485 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001486 "\texclude\t\tfile to exclude\n" \
1487 "\tX\t\tfile with names to exclude\n" \
1488 ) \
1489 "\nInformative output:\n" \
1490 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001491#define tar_example_usage \
1492 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
1493 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001494
Eric Andersen7e9276b2001-02-22 01:15:47 +00001495#define tee_trivial_usage \
1496 "[OPTION]... [FILE]..."
1497#define tee_full_usage \
1498 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001499 "Options:\n" \
1500 "\t-a\tappend to the given FILEs, do not overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001501#define tee_example_usage \
1502 "$ echo "Hello" | tee /tmp/foo\n" \
1503 "$ cat /tmp/foo\n" \
1504 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001505
Eric Andersen7e9276b2001-02-22 01:15:47 +00001506#define telnet_trivial_usage \
1507 "host [port]"
1508#define telnet_full_usage \
1509 "Telnet is used to establish interactive communication with another\n"\
1510 "computer over a network using the TELNET protocol."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001511
Eric Andersen7e9276b2001-02-22 01:15:47 +00001512#define test_trivial_usage \
1513 "EXPRESSION\n or [ EXPRESSION ]"
1514#define test_full_usage \
1515 "Checks file types and compares values returning an exit\n" \
1516 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001517#define test_example_usage \
1518 "$ test 1 -eq 2\n" \
1519 "$ echo $?\n" \
1520 "1\n" \
1521 "$ test 1 -eq 1\n" \
1522 "$ echo $? \n" \
1523 "0\n" \
1524 "$ [ -d /etc ]\n" \
1525 "$ echo $?\n" \
1526 "0\n" \
1527 "$ [ -d /junk ]\n" \
1528 "$ echo $?\n" \
1529 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001530
Mark Whitley450736c2001-03-02 19:08:50 +00001531#ifdef BB_FEATURE_TFTP_GET
1532 #define USAGE_TFTP_GET(a) a
1533#else
1534 #define USAGE_TFTP_GET(a)
1535#endif
1536#ifdef BB_FEATURE_TFTP_PUT
1537 #define USAGE_TFTP_PUT(a) a
1538#else
1539 #define USAGE_TFTP_PUT(a)
1540#endif
1541
1542#define tftp_trivial_usage \
1543 "command SOURCE DEST"
1544#define tftp_full_usage \
1545 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
1546 "Commands:\n" \
1547 USAGE_TFTP_GET( \
1548 "\tget\tGet file from server SOURCE and store to local DEST.\n" \
1549 ) \
1550 USAGE_TFTP_PUT( \
1551 "\tput\tPut local file SOURCE to server DEST.\n" \
1552 ) \
John Beppu5d817682001-04-17 17:09:34 +00001553 "\nWhen naming a server, use the syntax \"server:file\"."
Mark Whitley450736c2001-03-02 19:08:50 +00001554
Eric Andersen7e9276b2001-02-22 01:15:47 +00001555#define touch_trivial_usage \
1556 "[-c] file [file ...]"
1557#define touch_full_usage \
1558 "Update the last-modified date on the given file[s].\n\n" \
1559 "Options:\n" \
1560 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001561#define touch_example_usage \
1562 "$ ls -l /tmp/foo\n" \
1563 "/bin/ls: /tmp/foo: No such file or directory\n" \
1564 "$ touch /tmp/foo\n" \
1565 "$ ls -l /tmp/foo\n" \
1566 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001567
1568#define tr_trivial_usage \
1569 "[-cds] STRING1 [STRING2]"
1570#define tr_full_usage \
1571 "Translate, squeeze, and/or delete characters from\n" \
1572 "standard input, writing to standard output.\n\n" \
1573 "Options:\n" \
1574 "\t-c\ttake complement of STRING1\n" \
1575 "\t-d\tdelete input characters coded STRING1\n" \
1576 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001577#define tr_example_usage \
1578 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
1579 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001580
1581#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001582 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001583#define true_full_usage \
1584 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001585#define true_example_usage \
1586 "$ true\n" \
1587 "$ echo $?\n" \
1588 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001589
Eric Andersen7e9276b2001-02-22 01:15:47 +00001590#define tty_trivial_usage \
1591 ""
1592#define tty_full_usage \
1593 "Print the file name of the terminal connected to standard input.\n\n"\
1594 "Options:\n" \
1595 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001596#define tty_example_usage \
1597 "$ tty\n" \
1598 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001599
Eric Andersen7e9276b2001-02-22 01:15:47 +00001600#ifdef BB_FEATURE_MOUNT_FORCE
1601 #define USAGE_MOUNT_FORCE(a) a
1602#else
1603 #define USAGE_MOUNT_FORCE(a)
1604#endif
1605#define umount_trivial_usage \
1606 "[flags] filesystem|directory"
1607#define umount_full_usage \
1608 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00001609 "\nFlags:\n" "\t-a\tUnmount all file systems" \
1610 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
1611 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
1612 USAGE_MOUNT_FORCE("\n\t-f\tForce filesystem umount (i.e. unreachable NFS server)") \
1613 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 +00001614#define umount_example_usage \
1615 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001616
1617#define uname_trivial_usage \
1618 "[OPTION]..."
1619#define uname_full_usage \
1620 "Print certain system information. With no OPTION, same as -s.\n\n" \
1621 "Options:\n" \
1622 "\t-a\tprint all information\n" \
1623 "\t-m\tthe machine (hardware) type\n" \
1624 "\t-n\tprint the machine's network node hostname\n" \
1625 "\t-r\tprint the operating system release\n" \
1626 "\t-s\tprint the operating system name\n" \
1627 "\t-p\tprint the host processor type\n" \
1628 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001629#define uname_example_usage \
1630 "$ uname -a\n" \
1631 "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001632
1633#define uniq_trivial_usage \
1634 "[OPTION]... [INPUT [OUTPUT]]"
1635#define uniq_full_usage \
1636 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001637 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001638 "Options:\n" \
1639 "\t-c\tprefix lines by the number of occurrences\n" \
1640 "\t-d\tonly print duplicate lines\n" \
1641 "\t-u\tonly print unique lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001642#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001643 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001644 "a\n" \
1645 "b\n" \
1646 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001647
1648#define unix2dos_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001649 "[option] [file]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001650#define unix2dos_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001651 "See 'dos2unix --help' for help!"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001652
1653#define update_trivial_usage \
1654 "[options]"
1655#define update_full_usage \
1656 "Periodically flushes filesystem buffers.\n\n" \
1657 "Options:\n" \
1658 "\t-S\tforce use of sync(2) instead of flushing\n" \
1659 "\t-s SECS\tcall sync this often (default 30)\n" \
1660 "\t-f SECS\tflush some buffers this often (default 5)"
1661
1662#define uptime_trivial_usage \
1663 ""
1664#define uptime_full_usage \
1665 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001666#define uptime_example_usage \
1667 "$ uptime\n" \
1668 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001669
1670#define usleep_trivial_usage \
1671 "N"
1672#define usleep_full_usage \
1673 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001674#define usleep_example_usage \
1675 "$ usleep 1000000\n" \
1676 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001677
1678#define uudecode_trivial_usage \
1679 "[FILE]..."
1680#define uudecode_full_usage \
1681 "Uudecode a file that is uuencoded.\n\n" \
1682 "Options:\n" \
Eric Andersen704b2c22001-03-16 08:06:30 +00001683 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001684#define uudecode_example_usage \
1685 "$ uudecode -o busybox busybox.uu\n" \
1686 "$ ls -l busybox\n" \
1687 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001688
1689#define uuencode_trivial_usage \
1690 "[OPTION] [INFILE] REMOTEFILE"
1691#define uuencode_full_usage \
1692 "Uuencode a file.\n\n" \
1693 "Options:\n" \
1694 "\t-m\tuse base64 encoding as of RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001695#define uuencode_example_usage \
1696 "$ uuencode busybox busybox\n" \
1697 "begin 755 busybox\n" \
1698 "<encoded file snipped>\n" \
1699 "$ uudecode busybox busybox > busybox.uu\n" \
1700 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001701
Eric Andersen3f980402001-04-04 17:31:15 +00001702#define vi_trivial_usage \
1703 "[OPTION] [FILE]..."
1704#define vi_full_usage \
1705 "edit FILE.\n\n" \
1706 "Options:\n" \
1707 "\t-R\tRead-only- do not write to the file."
1708
Eric Andersen7e9276b2001-02-22 01:15:47 +00001709#define watchdog_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001710 "DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001711#define watchdog_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001712 "Periodically write to watchdog device DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001713
1714#define wc_trivial_usage \
1715 "[OPTION]... [FILE]..."
1716#define wc_full_usage \
1717 "Print line, word, and byte counts for each FILE, and a total line if\n" \
1718 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
1719 "Options:\n" \
1720 "\t-c\tprint the byte counts\n" \
1721 "\t-l\tprint the newline counts\n" \
1722 "\t-L\tprint the length of the longest line\n" \
1723 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001724#define wc_example_usage \
1725 "$ wc /etc/passwd\n" \
1726 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001727
1728#define wget_trivial_usage \
Eric Andersen50ae3102001-05-15 17:51:37 +00001729 "[-c|--continue] [-q|--quiet] [-O|--output-document file] [--header 'header: value'] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001730#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00001731 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001732 "Options:\n" \
1733 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00001734 "\t-q\tquiet mode - do not print\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001735 "\t-O\tsave to filename ('-' for stdout)"
1736
1737#define which_trivial_usage \
1738 "[COMMAND ...]"
1739#define which_full_usage \
1740 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001741#define which_example_usage \
1742 "$ which login\n" \
1743 "/bin/login\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001744
1745#define whoami_trivial_usage \
1746 ""
1747#define whoami_full_usage \
1748 "Prints the user name associated with the current effective user id."
1749
1750#define xargs_trivial_usage \
1751 "[COMMAND] [ARGS...]"
1752#define xargs_full_usage \
1753 "Executes COMMAND on every item given by standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001754#define xargs_example_usage \
1755 "$ ls | xargs gzip\n" \
1756 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001757
1758#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001759 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001760#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001761 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001762
Eric Andersen7e9276b2001-02-22 01:15:47 +00001763#define zcat_trivial_usage \
1764 "FILE"
1765#define zcat_full_usage \
1766 "Uncompress to stdout."