blob: 3243415246c35e47f661d60791bdc9f6fe8a1237 [file] [log] [blame]
Eric Andersenf349e972001-08-21 16:18:59 +00001#define addgroup_trivial_usage \
2 "[OPTIONS] <group_name>"
3#define addgroup_full_usage \
4 "Adds a group to the system" \
5 "Options:\n" \
6 "\t-g\t\tspecify gid\n"
7
8#define adduser_trivial_usage \
9 "[OPTIONS] <user_name>"
10#define adduser_full_usage \
11 "Adds a user to the system" \
12 "Options:\n" \
13 "\t-h\t\thome directory\n" \
14 "\t-s\t\tshell\n" \
15 "\t-g\t\tGECOS string\n"
16
Mark Whitley6f932772001-03-20 19:18:10 +000017#define adjtimex_trivial_usage \
18 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
19#define adjtimex_full_usage \
20 "Reads and optionally sets system timebase parameters.\n" \
21 "See adjtimex(2).\n\n" \
22 "Options:\n" \
23 "\t-q\t\tquiet mode - do not print\n" \
24 "\t-o offset\ttime offset, microseconds\n" \
25 "\t-f frequency\tfrequency adjust, integer kernel units (65536 is 1ppm)\n" \
26 "\t\t\t(positive values make the system clock run fast)\n" \
27 "\t-t tick\t\tmicroseconds per tick, usually 10000\n" \
28 "\t-p timeconstant\n"
29
Eric Andersen7e9276b2001-02-22 01:15:47 +000030#define ar_trivial_usage \
Glenn L McGrath62ebe2e2001-06-03 05:41:59 +000031 "-[ov][ptx] ARCHIVE FILES"
Eric Andersen7e9276b2001-02-22 01:15:47 +000032#define ar_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +000033 "Extract or list FILES from an ar archive.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +000034 "Options:\n" \
35 "\t-o\t\tpreserve original dates\n" \
36 "\t-p\t\textract to stdout\n" \
37 "\t-t\t\tlist\n" \
38 "\t-x\t\textract\n" \
Glenn L McGrathcda5cf12001-06-03 05:15:04 +000039 "\t-v\t\tverbosely list files processed\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000040
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000041#define awk_trivial_usage \
42 "[-v var=val][-F sep] { -f progname | 'programtext' } [FILE ...]"
43#define awk_full_usage \
44 "Options:\n" \
45 "\t-v var=val\tassign value 'val' to variable 'var'\n" \
46 "\t-F sep\t\tuse 'sep' as field separator\n" \
47 "\t-f progname\tread program source from file 'progname'\n"
48
Eric Andersen7e9276b2001-02-22 01:15:47 +000049#define basename_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000050 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000051#define basename_full_usage \
52 "Strips directory path and suffixes from FILE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000053 "If specified, also removes any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000054#define basename_example_usage \
55 "$ basename /usr/local/bin/foo\n" \
56 "foo\n" \
57 "$ basename /usr/local/bin/\n" \
58 "bin\n" \
59 "$ basename /foo/bar.txt .txt\n" \
60 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000061
Glenn L McGrath24e28332001-10-05 03:48:57 +000062#define bunzip2_trivial_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000063 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +000064#define bunzip2_full_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000065 "Uncompress FILE (or standard input if FILE is '-' or omitted).\n\n" \
66 "Options:\n" \
67 "\t-c\tWrite output to standard output\n" \
68 "\t-f\tForce"
Glenn L McGrath24e28332001-10-05 03:48:57 +000069
Glenn L McGrathfff11f12001-11-18 14:20:25 +000070#define bzcat_trivial_usage \
71 "FILE"
72#define bzcat_full_usage \
73 "Uncompress to stdout."
74
Eric Andersenc98c0622001-12-06 15:16:43 +000075#define cal_trivial_usage \
76 "[-jy] [[month] year]"
77#define cal_full_usage \
78 "Display a calendar.\n" \
79 "\nOptions:\n" \
80 "\t-j\tUse julian dates.\n" \
81 "\t-y\tDisplay the entire year."
82
Eric Andersen7e9276b2001-02-22 01:15:47 +000083#define cat_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000084 "[FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000085#define cat_full_usage \
86 "Concatenates FILE(s) and prints them to stdout."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000087#define cat_example_usage \
88 "$ cat /proc/uptime\n" \
89 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000090
Eric Andersen7e9276b2001-02-22 01:15:47 +000091#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000092 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +000093#define chgrp_full_usage \
94 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +000095 "\nOptions:\n" \
96 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000097#define chgrp_example_usage \
98 "$ ls -l /tmp/foo\n" \
99 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
100 "$ chgrp root /tmp/foo\n" \
101 "$ ls -l /tmp/foo\n" \
102 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000103
Eric Andersen7e9276b2001-02-22 01:15:47 +0000104#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000105 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000106#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000107 "Each MODE is one or more of the letters ugoa, one of the\n" \
108 "symbols +-= and one or more of the letters rwxst.\n\n" \
109 "Options:\n" \
110 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000111#define chmod_example_usage \
112 "$ ls -l /tmp/foo\n" \
113 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
114 "$ chmod u+x /tmp/foo\n" \
115 "$ ls -l /tmp/foo\n" \
116 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
117 "$ chmod 444 /tmp/foo\n" \
118 "$ ls -l /tmp/foo\n" \
119 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000120
Eric Andersen7e9276b2001-02-22 01:15:47 +0000121#define chown_trivial_usage \
Eric Andersen238da242001-05-11 16:31:46 +0000122 "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000123#define chown_full_usage \
124 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000125 "\nOptions:\n" \
Eric Andersen238da242001-05-11 16:31:46 +0000126 "\t-R\tChanges files and directories recursively.\n" \
127 "\t-h\tDo not dereference symbolic links."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000128#define chown_example_usage \
129 "$ ls -l /tmp/foo\n" \
130 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
131 "$ chown root /tmp/foo\n" \
132 "$ ls -l /tmp/foo\n" \
133 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
134 "$ chown root.root /tmp/foo\n" \
135 "ls -l /tmp/foo\n" \
136 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000137
Eric Andersen7e9276b2001-02-22 01:15:47 +0000138#define chroot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000139 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000140#define chroot_full_usage \
141 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000142#define chroot_example_usage \
143 "$ ls -l /bin/ls\n" \
144 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
145 "$ mount /dev/hdc1 /mnt -t minix\n" \
146 "$ chroot /mnt\n" \
147 "$ ls -l /bin/ls\n" \
148 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000149
Eric Andersen7e9276b2001-02-22 01:15:47 +0000150#define chvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000151 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000152#define chvt_full_usage \
153 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000154
Eric Andersen7e9276b2001-02-22 01:15:47 +0000155#define clear_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000156 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000157#define clear_full_usage \
158 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000159
Eric Andersen7e9276b2001-02-22 01:15:47 +0000160#define cmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000161 "FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000162#define cmp_full_usage \
Mark Whitley207587a2001-04-25 20:41:02 +0000163 "\t-s\tquiet mode - do not print\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000164 "Compare files."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000165
Eric Andersen7e9276b2001-02-22 01:15:47 +0000166#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000167 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000168#define cp_full_usage \
169 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
170 "\n" \
171 "\t-a\tSame as -dpR\n" \
172 "\t-d\tPreserves links\n" \
173 "\t-p\tPreserves file attributes if possible\n" \
174 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000175 "\t-R\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000176
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000177#define cpio_trivial_usage \
178 "-[dimtuv][F cpiofile]"
179#define cpio_full_usage \
180 "Extract or list files from a cpio archive\n" \
181 "Main operation mode:\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000182 "\td\t\tmake leading directories\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000183 "\ti\t\textract\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000184 "\tm\t\tpreserve mtime\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000185 "\tt\t\tlist\n" \
Eric Andersen6925d502001-12-16 09:23:09 +0000186 "\tu\t\tunconditional overwrite\n" \
187 "\tF\t\tinput from file"
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000188
Eric Andersen7e9276b2001-02-22 01:15:47 +0000189#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000190 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000191#define cut_full_usage \
192 "Prints selected fields from each input FILE to standard output.\n\n" \
193 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000194 "\t-b LIST\t\tOutput only bytes from LIST\n" \
195 "\t-c LIST\t\tOutput only characters from LIST\n" \
196 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
197 "\t-s\t\tOutput only the lines containing delimiter\n" \
198 "\t-f N\t\tPrint only these fields\n" \
199 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000200#define cut_example_usage \
201 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
202 "Hello\n" \
203 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
204 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000205
Eric Andersen7e9276b2001-02-22 01:15:47 +0000206#define date_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000207 "[OPTION]... [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000208#define date_full_usage \
209 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000210 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000211 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000212 "\t-d STRING\tdisplay time described by STRING, not `now'\n" \
213 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000214 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000215#define date_example_usage \
216 "$ date\n" \
217 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000218
Eric Andersen7e9276b2001-02-22 01:15:47 +0000219#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000220 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000221#define dc_full_usage \
222 "This is a Tiny RPN calculator that understands the\n" \
223 "following operations: +, -, /, *, and, or, not, eor.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000224 "i.e., 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000225#define dc_example_usage \
226 "$ dc 2 2 +\n" \
227 "4\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000228 "$ dc 8 8 * 2 2 + /\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000229 "16\n" \
230 "$ dc 0 1 and\n" \
231 "0\n" \
232 "$ dc 0 1 or\n" \
233 "1\n" \
234 "$ echo 72 9 div 8 mul | dc\n" \
235 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000236
Eric Andersen7e9276b2001-02-22 01:15:47 +0000237#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000238 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000239 "\t [seek=N] [conv=notrunc|noerror|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000240#define dd_full_usage \
241 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000242 "\tif=FILE\t\tread from FILE instead of stdin\n" \
243 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
244 "\tbs=N\t\tread and write N bytes at a time\n" \
245 "\tcount=N\t\tcopy only N input blocks\n" \
246 "\tskip=N\t\tskip N input blocks\n" \
247 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000248 "\tconv=notrunc\tdon't truncate output file\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000249 "\tconv=noerror\tcontinue after read errors\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000250 "\tconv=sync\tpad blocks with zeros\n" \
251 "\n" \
252 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000253 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000254#define dd_example_usage \
255 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
256 "4+0 records in\n" \
257 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000258
Eric Andersen7e9276b2001-02-22 01:15:47 +0000259#define deallocvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000260 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000261#define deallocvt_full_usage \
262 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000263
Eric Andersenf349e972001-08-21 16:18:59 +0000264#define delgroup_trivial_usage \
265 "GROUP"
266#define delgroup_full_usage \
267 "Deletes group GROUP from the system"
268
269#define deluser_trivial_usage \
270 "USER"
271#define deluser_full_usage \
272 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000273
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000274#ifdef CONFIG_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000275 #define USAGE_HUMAN_READABLE(a) a
276 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000277#else
Eric Andersened0d9582001-02-23 13:23:03 +0000278 #define USAGE_HUMAN_READABLE(a)
279 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000280#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000281#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000282 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000283#define df_full_usage \
284 "Print the filesystem space used and space available.\n\n" \
285 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000286 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000287 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
288 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000289 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000290 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000291#define df_example_usage \
292 "$ df\n" \
293 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
294 "/dev/sda3 8690864 8553540 137324 98% /\n" \
295 "/dev/sda1 64216 36364 27852 57% /boot\n" \
296 "$ df /dev/sda3\n" \
297 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
298 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000299
Eric Andersen7e9276b2001-02-22 01:15:47 +0000300#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000301 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000302#define dirname_full_usage \
303 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000304#define dirname_example_usage \
305 "$ dirname /tmp/foo\n" \
306 "/tmp\n" \
307 "$ dirname /tmp/foo/\n" \
308 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000309
Eric Andersen7e9276b2001-02-22 01:15:47 +0000310#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000311 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000312#define dmesg_full_usage \
313 "Prints or controls the kernel ring buffer\n\n" \
314 "Options:\n" \
315 "\t-c\t\tClears the ring buffer's contents after printing\n" \
316 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000317 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000318
Eric Andersen7e9276b2001-02-22 01:15:47 +0000319#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000320 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000321#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000322 "Converts FILE from dos format to unix format. When no option\n" \
323 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000324 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000325 "Options:\n" \
326 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000327 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000328
Eric Andersen7e9276b2001-02-22 01:15:47 +0000329#define dpkg_trivial_usage \
Eric Andersen9fe5f982002-04-13 14:48:51 +0000330 "-i package_file\n" \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000331 "[-CPru] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000332#define dpkg_full_usage \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000333 "\t-i\tInstall the package\n" \
334 "\t-C\tConfigure an unpackaged package\n" \
335 "\t-P\tPurge all files of a package\n" \
336 "\t-r\tRemove all but the configuration files for a package\n" \
337 "\t-u\tUnpack a package, but dont configure it\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000338
Eric Andersen7e9276b2001-02-22 01:15:47 +0000339#define dpkg_deb_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000340 "[-cefItxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000341#define dpkg_deb_full_usage \
342 "Perform actions on debian packages (.debs)\n\n" \
343 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000344 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000345 "\t-e\tExtract control files to [argument] directory\n" \
346 "\t-f\tDisplay control field name starting with [argument]\n" \
347 "\t-I\tDisplay the control filenamed [argument]\n" \
348 "\t-t\tExtract filesystem tree to stdout in tar format\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000349 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000350 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000351#define dpkg_deb_example_usage \
352 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000353
Eric Andersen7e9276b2001-02-22 01:15:47 +0000354#define du_trivial_usage \
Eric Andersen265d2292002-04-06 23:16:44 +0000355 "[-lsx" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000356#define du_full_usage \
357 "Summarizes disk space used for each FILE and/or directory.\n" \
358 "Disk space is printed in units of 1024 bytes.\n\n" \
359 "Options:\n" \
360 "\t-l\tcount sizes many times if hard linked\n" \
361 "\t-s\tdisplay only a total for each argument" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000362 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000363 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
364 "\t-m\tprint sizes in megabytes\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000365 "\t-x\tskip directories on different filesystems\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000366 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000367 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000368#define du_example_usage \
369 "$ du\n" \
370 "16 ./CVS\n" \
371 "12 ./kernel-patches/CVS\n" \
372 "80 ./kernel-patches\n" \
373 "12 ./tests/CVS\n" \
374 "36 ./tests\n" \
375 "12 ./scripts/CVS\n" \
376 "16 ./scripts\n" \
377 "12 ./docs/CVS\n" \
378 "104 ./docs\n" \
379 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000380
Eric Andersen7e9276b2001-02-22 01:15:47 +0000381#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000382 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000383#define dumpkmap_full_usage \
384 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000385#define dumpkmap_example_usage \
386 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000387
Russ Dill61fb4892002-10-14 21:41:28 +0000388#define dumpleases_trivial_usage \
389 "[-r|-a] [-f LEASEFILE]"
390#define dumpleases_full_usage \
391 "Usage: dumpleases -f <file> -[r|a]\n" \
392 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
393 "\t-r,\t--remaining\tInterepret lease times as time remaing\n" \
394 "\t-a,\t--absolute\tInterepret lease times as expire time\n"
395
Eric Andersen7e9276b2001-02-22 01:15:47 +0000396#define dutmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000397 "[FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000398#define dutmp_full_usage \
399 "Dump utmp file format (pipe delimited) from FILE\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000400 "or stdin to stdout. (i.e., 'dutmp /var/run/utmp')"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000401#define dutmp_example_usage \
402 "$ dutmp /var/run/utmp\n" \
403 "8|7||si|||0|0|0|955637625|760097|0\n" \
404 "2|0|~|~~|reboot||0|0|0|955637625|782235|0\n" \
405 "1|20020|~|~~|runlevel||0|0|0|955637625|800089|0\n" \
406 "8|125||l4|||0|0|0|955637629|998367|0\n" \
407 "6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0\n" \
408 "6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0\n" \
409 "7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000410
Eric Andersen7e9276b2001-02-22 01:15:47 +0000411#define echo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000412 "[-neE] [ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000413#define echo_full_usage \
414 "Prints the specified ARGs to stdout\n\n" \
415 "Options:\n" \
416 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000417 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000418 "\t-E\tdisable interpretation of backslash-escaped characters"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000419#define echo_example_usage \
420 "$ echo "Erik is cool"\n" \
421 "Erik is cool\n" \
John Beppu5d817682001-04-17 17:09:34 +0000422 "$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000423 "Erik\n" \
424 "is\n" \
425 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000426 "$ echo "Erik\\nis\\ncool"\n" \
427 "Erik\\nis\\ncool\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000428
Eric Andersen84e229c2001-03-29 22:48:33 +0000429#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000430 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000431#define env_full_usage \
432 "Prints the current environment or runs a program after setting\n" \
433 "up the specified environment.\n\n" \
434 "Options:\n" \
435 "\t-, -i\tstart with an empty environment\n" \
436 "\t-u\tremove variable from the environment\n"
437
Eric Andersen7e9276b2001-02-22 01:15:47 +0000438#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000439 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000440#define expr_full_usage \
441 "Prints the value of EXPRESSION to standard output.\n\n" \
442 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000443 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
444 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
445 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
446 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
447 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
448 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
449 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
450 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
451 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
452 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
453 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
454 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
455 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000456 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
457 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
458 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
459 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
460 "\t or 0\n" \
461 "\tlength STRING length of STRING\n" \
462 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
463 "\t it is a keyword like `match' or an\n" \
464 "\t operator like `/'\n" \
465 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000466 "Beware that many operators need to be escaped or quoted for shells.\n" \
467 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
468 "lexicographical. Pattern matches return the string matched between \n" \
469 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
470 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000471
Eric Andersen7e9276b2001-02-22 01:15:47 +0000472#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000473 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000474#define false_full_usage \
475 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000476#define false_example_usage \
477 "$ false\n" \
478 "$ echo $?\n" \
479 "1\n"
480
481#define fbset_trivial_usage \
482 "[options] [mode]"
483#define fbset_full_usage \
484 "Show and modify frame buffer settings"
485#define fbset_example_usage \
486 "$ fbset\n" \
487 "mode "1024x768-76"\n" \
488 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
489 "\tgeometry 1024 768 1024 768 16\n" \
490 "\ttimings 12714 128 32 16 4 128 4\n" \
491 "\taccel false\n" \
492 "\trgba 5/11,6/5,5/0,0/0\n" \
493 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000494
Eric Andersen7e9276b2001-02-22 01:15:47 +0000495#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000496 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000497#define fdflush_full_usage \
498 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000499
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000500#ifdef CONFIG_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000501 #define USAGE_FIND_TYPE(a) a
502#else
503 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000504#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000505#ifdef CONFIG_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000506 #define USAGE_FIND_PERM(a) a
507#else
508 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000509#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000510#ifdef CONFIG_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000511 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000512#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000513 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000514#endif
515
Eric Andersen7e9276b2001-02-22 01:15:47 +0000516#define find_trivial_usage \
517 "[PATH...] [EXPRESSION]"
518#define find_full_usage \
519 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000520 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000521 "\nEXPRESSION may consist of:\n" \
522 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000523 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000524 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000525 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000526 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
527) USAGE_FIND_PERM( \
528 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
529) USAGE_FIND_MTIME( \
530 "\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 +0000531#define find_example_usage \
532 "$ find / -name /etc/passwd\n" \
533 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000534
Eric Andersen7e9276b2001-02-22 01:15:47 +0000535#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000536 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000537#define free_full_usage \
538 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000539#define free_example_usage \
540 "$ free\n" \
541 " total used free shared buffers\n" \
542 " Mem: 257628 248724 8904 59644 93124\n" \
543 " Swap: 128516 8404 120112\n" \
544 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000545
Eric Andersen7e9276b2001-02-22 01:15:47 +0000546#define freeramdisk_trivial_usage \
547 "DEVICE"
548#define freeramdisk_full_usage \
549 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000550#define freeramdisk_example_usage \
551 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000552
553#define fsck_minix_trivial_usage \
554 "[-larvsmf] /dev/name"
555#define fsck_minix_full_usage \
556 "Performs a consistency check for MINIX filesystems.\n\n" \
557 "Options:\n" \
558 "\t-l\tLists all filenames\n" \
559 "\t-r\tPerform interactive repairs\n" \
560 "\t-a\tPerform automatic repairs\n" \
561 "\t-v\tverbose\n" \
562 "\t-s\tOutputs super-block information\n" \
563 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
564 "\t-f\tForce file system check."
565
566#define getopt_trivial_usage \
567 "[OPTIONS]..."
568#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000569 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000570 "\t-a, --alternative Allow long options starting with single -\n" \
571 "\t-l, --longoptions=longopts Long options to be recognized\n" \
572 "\t-n, --name=progname The name under which errors are reported\n" \
573 "\t-o, --options=optstring Short options to be recognized\n" \
574 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
575 "\t-Q, --quiet-output No normal output\n" \
576 "\t-s, --shell=shell Set shell quoting conventions\n" \
577 "\t-T, --test Test for getopt(1) version\n" \
578 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000579#define getopt_example_usage \
580 "$ cat getopt.test\n" \
581 "#!/bin/sh\n" \
582 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
583 " -n 'example.busybox' -- "$@"`\n" \
584 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
585 "eval set -- "$GETOPT"\n" \
586 "while true ; do\n" \
587 " case $1 in\n" \
588 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000589 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000590 " -c|--c-long)\n" \
591 " case "$2" in\n" \
592 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000593 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000594 " esac ;;\n" \
595 " --) shift ; break ;;\n" \
596 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
597 " esac\n" \
598 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000599
Eric Andersenf349e972001-08-21 16:18:59 +0000600#define getty_trivial_usage \
601 "getty [OPTIONS]... baud_rate,... line [termtype]"
602#define getty_full_usage \
603 "\nOpens a tty, prompts for a login name, then invokes /bin/login\n\n" \
604 "Options:\n" \
605 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
606 "\t-i\t\tDo not display /etc/issue before running login.\n" \
607 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
608 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
609 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
610 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
611 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
612 "\t-I initstring\tSets the init string to send before anything else.\n" \
613 "\t-H login_host\tLog login_host into the utmp file as the hostname."
614
615
Eric Andersen7e9276b2001-02-22 01:15:47 +0000616#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000617 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000618#define grep_full_usage \
619 "Search for PATTERN in each FILE or standard input.\n\n" \
620 "Options:\n" \
621 "\t-H\tprefix output lines with filename where match was found\n" \
622 "\t-h\tsuppress the prefixing filename on output\n" \
623 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000624 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000625 "\t-n\tprint line number with output lines\n" \
626 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
627 "\t-v\tselect non-matching lines\n" \
628 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000629#define grep_example_usage \
630 "$ grep root /etc/passwd\n" \
631 "root:x:0:0:root:/root:/bin/bash\n" \
632 "$ grep ^[rR]oo. /etc/passwd\n" \
633 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000634
Eric Andersen7e9276b2001-02-22 01:15:47 +0000635#define gunzip_trivial_usage \
636 "[OPTION]... FILE"
637#define gunzip_full_usage \
638 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
639 "Options:\n" \
640 "\t-c\tWrite output to standard output\n" \
641 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000642#define gunzip_example_usage \
643 "$ ls -la /tmp/BusyBox*\n" \
644 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
645 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
646 "$ ls -la /tmp/BusyBox*\n" \
647 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000648
649#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000650 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000651#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000652 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000653 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000654 "Options:\n" \
655 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
656 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000657#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000658 "$ ls -la /tmp/busybox*\n" \
659 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
660 "$ gzip /tmp/busybox.tar\n" \
661 "$ ls -la /tmp/busybox*\n" \
662 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000663
664#define halt_trivial_usage \
665 ""
666#define halt_full_usage \
667 "Halt the system."
668
669#define head_trivial_usage \
670 "[OPTION] [FILE]..."
671#define head_full_usage \
672 "Print first 10 lines of each FILE to standard output.\n" \
673 "With more than one FILE, precede each with a header giving the\n" \
674 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000675 "Options:\n" \
676 "\t-n NUM\t\tPrint first NUM lines instead of first 10"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000677#define head_example_usage \
678 "$ head -n 2 /etc/passwd\n" \
679 "root:x:0:0:root:/root:/bin/bash\n" \
680 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000681
Glenn L McGrath60281112001-11-02 11:39:46 +0000682#define hexdump_trivial_usage \
683 "[-[bcdefnosvx]] [OPTION] FILE"
684#define hexdump_full_usage \
685 "The hexdump utility is a filter which displays the specified files,\n" \
686 "or the standard input, if no files are specified, in a user specified\n"\
687 "format\n" \
688 "\t-b\t\tOne-byte octal display\n" \
689 "\t-c\t\tOne-byte character display\n" \
690 "\t-d\t\tTwo-byte decimal display\n" \
691 "\t-e FORMAT STRING\n" \
692 "\t-f FORMAT FILE\n" \
693 "\t-n LENGTH\tInterpret only length bytes of input\n" \
694 "\t-o\t\tTwo-byte octal display\n" \
695 "\t-s OFFSET\tSkip offset byte\n" \
696 "\t-v\t\tdisplay all input data\n" \
697 "\t-x\t\tTwo-byte hexadecimal display\n"
698
Eric Andersen7e9276b2001-02-22 01:15:47 +0000699#define hostid_trivial_usage \
700 ""
701#define hostid_full_usage \
702 "Print out a unique 32-bit identifier for the machine."
703
704#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000705 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000706#define hostname_full_usage \
707 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000708 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000709 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +0000710 "\t-s\tShort\n" \
711 "\t-i\tAddresses for the hostname\n" \
712 "\t-d\tDNS domain name\n" \
713 "\t-f\tFully qualified domain name\n" \
714 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000715#define hostname_example_usage \
716 "$ hostname\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000717 "sage \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000718
Robert Griebl1cd04452002-07-21 16:50:49 +0000719#define hwclock_trivial_usage \
720 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
721#define hwclock_full_usage \
722 "Query and set the hardware clock (RTC)\n\n" \
723 "Options:\n" \
724 "\t-r\tread hardware clock and print result\n" \
725 "\t-s\tset the system time from the hardware clock\n" \
726 "\t-w\tset the hardware clock to the current system time\n" \
727 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
728 "\t-l\tthe hardware clock is kept in local time"
729
Eric Andersen7e9276b2001-02-22 01:15:47 +0000730#define id_trivial_usage \
731 "[OPTIONS]... [USERNAME]"
732#define id_full_usage \
733 "Print information for USERNAME or the current user\n\n" \
734 "Options:\n" \
735 "\t-g\tprints only the group ID\n" \
736 "\t-u\tprints only the user ID\n" \
737 "\t-n\tprint a name instead of a number (with for -ug)\n" \
738 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000739#define id_example_usage \
740 "$ id\n" \
741 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000742
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000743#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +0000744 #define USAGE_SIOCSKEEPALIVE(a) a
745#else
746 #define USAGE_SIOCSKEEPALIVE(a)
747#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000748#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000749 #define USAGE_IFCONFIG_MII(a) a
750#else
751 #define USAGE_IFCONFIG_MII(a)
752#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000753#ifdef CONFIG_FEATURE_IFCONFIG_HW
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000754 #define USAGE_IFCONFIG_HW(a) a
755#else
756 #define USAGE_IFCONFIG_HW(a)
757#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000758#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000759 #define USAGE_IFCONFIG_OPT_A(a) a
760#else
761 #define USAGE_IFCONFIG_OPT_A(a)
762#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +0000763#ifdef CONFIG_FEATURE_IPV6
764 #define USAGE_IPV6(a) a
765#else
766 #define USAGE_IPV6(a)
767#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000768
Eric Andersen7e9276b2001-02-22 01:15:47 +0000769#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000770 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000771#define ifconfig_full_usage \
772 "configure a network interface\n\n" \
773 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +0000774 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
775 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000776 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000777 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000778 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000779 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
780 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000781 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000782 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
783 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000784 "\t[up|down] ..."
785
786#define init_trivial_usage \
787 ""
788#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000789 "Init is the parent of all processes."
790#define init_notes_usage \
791"This version of init is designed to be run only by the kernel.\n" \
792"\n" \
793"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
794"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
795"runlevels, use sysvinit.\n" \
796"\n" \
797"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
798"it has the following default behavior:\n" \
799"\n" \
800" ::sysinit:/etc/init.d/rcS\n" \
801" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000802" ::ctrlaltdel:/sbin/reboot\n" \
803" ::shutdown:/sbin/swapoff -a\n" \
804" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000805" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000806"\n" \
807"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
808"\n" \
809" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000810" tty3::askfirst:/bin/sh\n" \
811" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000812"\n" \
813"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
814"\n" \
815" <id>:<runlevels>:<action>:<process>\n" \
816"\n" \
817" <id>: \n" \
818"\n" \
819" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
820" The id field is used by BusyBox init to specify the controlling tty for\n" \
821" the specified process to run on. The contents of this field are\n" \
822" appended to "/dev/" and used as-is. There is no need for this field to\n" \
823" be unique, although if it isn't you may have strange results. If this\n" \
824" field is left blank, the controlling tty is set to the console. Also\n" \
825" note that if BusyBox detects that a serial console is in use, then only\n" \
826" entries whose controlling tty is either the serial console or /dev/null\n" \
827" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
828" stinkin' utmp.\n" \
829"\n" \
830" <runlevels>: \n" \
831"\n" \
832" The runlevels field is completely ignored.\n" \
833"\n" \
834" <action>: \n" \
835"\n" \
836" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000837" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000838"\n" \
839" The available actions can be classified into two groups: actions\n" \
840" that are run only once, and actions that are re-run when the specified\n" \
841" process exits.\n" \
842"\n" \
843" Run only-once actions:\n" \
844"\n" \
845" 'sysinit' is the first item run on boot. init waits until all\n" \
846" sysinit actions are completed before continuing. Following the\n" \
847" completion of all sysinit actions, all 'wait' actions are run.\n" \
848" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000849" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000850" therefore, init does not wait for them to complete. 'restart' is\n" \
851" the action taken to restart the init process. By default this should\n" \
852" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
853" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000854" actions are run when the system detects that someone on the system\n" \
855" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
856" wants to run 'reboot' at this point to cause the system to reboot.\n" \
857" Finally the 'shutdown' action specifies the actions to taken when\n" \
858" init is told to reboot. Unmounting filesystems and disabling swap\n" \
859" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000860"\n" \
861" Run repeatedly actions:\n" \
862"\n" \
863" 'respawn' actions are run after the 'once' actions. When a process\n" \
864" started with a 'respawn' action exits, init automatically restarts\n" \
865" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
866" respawning out of control. The 'askfirst' actions acts just like\n" \
867" respawn, except that before running the specified process it\n" \
868" displays the line "Please press Enter to activate this console."\n" \
869" and then waits for the user to press enter before starting the\n" \
870" specified process. \n" \
871"\n" \
872" Unrecognized actions (like initdefault) will cause init to emit an\n" \
873" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +0000874" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000875"\n" \
876" <process>: \n" \
877"\n" \
878" Specifies the process to be executed and it's command line.\n" \
879"\n" \
880"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +0000881"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000882" # This is run first except when booting in single-user mode.\n" \
883" #\n" \
884" ::sysinit:/etc/init.d/rcS\n" \
885" \n" \
886" # /bin/sh invocations on selected ttys\n" \
887" #\n" \
888" # Start an "askfirst" shell on the console (whatever that may be)\n" \
889" ::askfirst:-/bin/sh\n" \
890" # Start an "askfirst" shell on /dev/tty2-4\n" \
891" tty2::askfirst:-/bin/sh\n" \
892" tty3::askfirst:-/bin/sh\n" \
893" tty4::askfirst:-/bin/sh\n" \
894" \n" \
895" # /sbin/getty invocations for selected ttys\n" \
896" #\n" \
897" tty4::respawn:/sbin/getty 38400 tty5\n" \
898" tty5::respawn:/sbin/getty 38400 tty6\n" \
899" \n" \
900" \n" \
901" # Example of how to put a getty on a serial line (for a terminal)\n" \
902" #\n" \
903" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
904" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
905" #\n" \
906" # Example how to put a getty on a modem line.\n" \
907" #::respawn:/sbin/getty 57600 ttyS2\n" \
908" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000909" # Stuff to do when restarting the init process\n" \
910" ::restart:/sbin/init\n" \
911" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000912" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000913" ::ctrlaltdel:/sbin/reboot\n" \
914" ::shutdown:/bin/umount -a -r\n" \
915" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000916
917#define insmod_trivial_usage \
918 "[OPTION]... MODULE [symbol=value]..."
919#define insmod_full_usage \
920 "Loads the specified kernel modules into the kernel.\n\n" \
921 "Options:\n" \
922 "\t-f\tForce module to load into the wrong kernel version.\n" \
923 "\t-k\tMake module autoclean-able.\n" \
924 "\t-v\tverbose output\n" \
925 "\t-L\tLock to prevent simultaneous loads of a module\n" \
926 "\t-x\tdo not export externs"
927
928#define kill_trivial_usage \
929 "[-signal] process-id [process-id ...]"
930#define kill_full_usage \
931 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +0000932 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000933 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000934#define kill_example_usage \
935 "$ ps | grep apache\n" \
936 "252 root root S [apache]\n" \
937 "263 www-data www-data S [apache]\n" \
938 "264 www-data www-data S [apache]\n" \
939 "265 www-data www-data S [apache]\n" \
940 "266 www-data www-data S [apache]\n" \
941 "267 www-data www-data S [apache]\n" \
942 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000943
944#define killall_trivial_usage \
945 "[-signal] process-name [process-name ...]"
946#define killall_full_usage \
947 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000948 "Options:\n" \
949 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000950#define killall_example_usage \
951 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000952
Mark Whitley6317c4b2001-03-12 22:51:50 +0000953#define klogd_trivial_usage \
954 "-n"
955#define klogd_full_usage \
956 "Kernel logger.\n"\
957 "Options:\n"\
958 "\t-n\tRun as a foreground process."
959
Eric Andersen7e9276b2001-02-22 01:15:47 +0000960#define length_trivial_usage \
961 "STRING"
962#define length_full_usage \
963 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000964#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +0000965 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000966 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000967
968#define ln_trivial_usage \
969 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
970#define ln_full_usage \
971 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
972 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
973 "Options:\n" \
974 "\t-s\tmake symbolic links instead of hard links\n" \
975 "\t-f\tremove existing destination files\n" \
976 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000977#define ln_example_usage \
978 "$ ln -s BusyBox /tmp/ls\n" \
979 "$ ls -l /tmp/ls\n" \
980 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000981
982#define loadacm_trivial_usage \
983 "< mapfile"
984#define loadacm_full_usage \
985 "Loads an acm from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000986#define loadacm_example_usage \
987 "$ loadacm < /etc/i18n/acmname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000988
989#define loadfont_trivial_usage \
990 "< font"
991#define loadfont_full_usage \
992 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000993#define loadfont_example_usage \
994 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000995
996#define loadkmap_trivial_usage \
997 "< keymap"
998#define loadkmap_full_usage \
999 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001000#define loadkmap_example_usage \
1001 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001002
1003#define logger_trivial_usage \
1004 "[OPTION]... [MESSAGE]"
1005#define logger_full_usage \
1006 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1007 "Options:\n" \
1008 "\t-s\tLog to stderr as well as the system log.\n" \
1009 "\t-t\tLog using the specified tag (defaults to user name).\n" \
1010 "\t-p\tEnter the message with the specified priority.\n" \
1011 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001012#define logger_example_usage \
1013 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001014
Robert Griebl1fca5582002-06-04 20:45:46 +00001015#define login_trivial_usage \
1016 "[OPTION]... [username] [ENV=VAR ...]"
1017#define login_full_usage \
1018 "Begin a new session on the system\n\n" \
1019 "Options:\n" \
1020 "\t-f\tDo not authenticate (user already authenticated)\n" \
1021 "\t-h\tName of the remote host for this login.\n" \
1022 "\t-p\tPreserve environment."
1023
Eric Andersen7e9276b2001-02-22 01:15:47 +00001024#define logname_trivial_usage \
1025 ""
1026#define logname_full_usage \
1027 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001028#define logname_example_usage \
1029 "$ logname\n" \
1030 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001031
Mark Whitley6317c4b2001-03-12 22:51:50 +00001032#define logread_trivial_usage \
1033 ""
1034
1035#define logread_full_usage \
1036 "Shows the messages from syslogd (using circular buffer)."
1037
Matt Kraai83788da2002-03-20 17:38:37 +00001038#define losetup_trivial_usage \
1039 "[OPTION]... LOOPDEVICE FILE\n" \
1040 "or: losetup [OPTION]... -d LOOPDEVICE"
1041#define losetup_full_usage \
1042 "Associate LOOPDEVICE with FILE.\n\n" \
1043 "Options:\n" \
1044 "\t-d\t\tDisassociate LOOPDEVICE.\n" \
1045 "\t-o OFFSET\tStart OFFSET bytes into FILE.\n"
1046
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001047#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001048 #define USAGE_LS_TIMESTAMPS(a) a
1049#else
1050 #define USAGE_LS_TIMESTAMPS(a)
1051#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001052#ifdef CONFIG_FEATURE_LS_FILETYPES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001053 #define USAGE_LS_FILETYPES(a) a
1054#else
1055 #define USAGE_LS_FILETYPES(a)
1056#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001057#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001058 #define USAGE_LS_FOLLOWLINKS(a) a
1059#else
1060 #define USAGE_LS_FOLLOWLINKS(a)
1061#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001062#ifdef CONFIG_FEATURE_LS_RECURSIVE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001063 #define USAGE_LS_RECURSIVE(a) a
1064#else
1065 #define USAGE_LS_RECURSIVE(a)
1066#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001067#ifdef CONFIG_FEATURE_LS_SORTFILES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001068 #define USAGE_LS_SORTFILES(a) a
1069#else
1070 #define USAGE_LS_SORTFILES(a)
1071#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001072#ifdef CONFIG_FEATURE_AUTOWIDTH
Eric Andersen7e9276b2001-02-22 01:15:47 +00001073 #define USAGE_AUTOWIDTH(a) a
1074#else
1075 #define USAGE_AUTOWIDTH(a)
1076#endif
1077#define ls_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +00001078 "[-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 +00001079#define ls_full_usage \
1080 "List directory contents\n\n" \
1081 "Options:\n" \
1082 "\t-1\tlist files in a single column\n" \
1083 "\t-A\tdo not list implied . and ..\n" \
1084 "\t-a\tdo not hide entries starting with .\n" \
1085 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001086 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001087 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001088 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1089 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001090 "\t-i\tlist the i-node for each file\n" \
1091 "\t-l\tuse a long listing format\n" \
1092 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001093 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1094 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1095 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1096 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1097 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001098 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001099 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1100 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1101 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1102 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1103 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001104 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001105 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1106 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001107 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersened0d9582001-02-23 13:23:03 +00001108 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +00001109 "\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001110
1111#define lsmod_trivial_usage \
1112 ""
1113#define lsmod_full_usage \
1114 "List the currently loaded kernel modules."
1115
1116#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001117 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001118#define makedevs_full_usage \
1119 "Creates a range of block or character special files\n\n" \
1120 "TYPEs include:\n" \
1121 "\tb:\tMake a block (buffered) device.\n" \
1122 "\tc or u:\tMake a character (un-buffered) device.\n" \
1123 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1124 "FIRST specifies the number appended to NAME to create the first device.\n" \
1125 "LAST specifies the number of the last item that should be created.\n" \
1126 "If 's' is the last argument, the base device is created as well.\n\n" \
1127 "For example:\n" \
1128 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001129 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001130#define makedevs_example_usage \
1131 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
1132 "[creates ttyS2-ttyS63]\n" \
1133 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
1134 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001135
Eric Andersen7e9276b2001-02-22 01:15:47 +00001136#define md5sum_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001137 "[OPTION] [FILE]...\n" \
1138 "or: md5sum [OPTION] -c [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001139#define md5sum_full_usage \
1140 "Print or check MD5 checksums.\n\n" \
1141 "Options:\n" \
1142 "With no FILE, or when FILE is -, read standard input.\n\n" \
1143 "\t-b\tread files in binary mode\n" \
1144 "\t-c\tcheck MD5 sums against given list\n" \
1145 "\t-t\tread files in text mode (default)\n" \
1146 "\t-g\tread a string\n" \
1147 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001148 "\t-s\tdon't output anything, status code shows success\n" \
1149 "\t-w\twarn about improperly formated MD5 checksum lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001150#define md5sum_example_usage \
1151 "$ md5sum < busybox\n" \
1152 "6fd11e98b98a58f64ff3398d7b324003\n" \
1153 "$ md5sum busybox\n" \
1154 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1155 "$ md5sum -c -\n" \
1156 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1157 "busybox: OK\n" \
1158 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001159
Glenn L McGrath061c9002002-09-16 04:21:46 +00001160#define mesg_trivial_usage \
1161 "mesg [y|n]"
1162#define mesg_full_usage \
1163 "mesg [Y|N], controls write access to your terminal\n" \
1164 "\ty\tAllow write access to your terminal.\n" \
1165 "\tn\tDisallow write access to your terminal.\n"
1166
Eric Andersen7e9276b2001-02-22 01:15:47 +00001167#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001168 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001169#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001170 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001171 "Options:\n" \
1172 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001173 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001174#define mkdir_example_usage \
1175 "$ mkdir /tmp/foo\n" \
1176 "$ mkdir /tmp/foo\n" \
1177 "/tmp/foo: File exists\n" \
1178 "$ mkdir /tmp/foo/bar/baz\n" \
1179 "/tmp/foo/bar/baz: No such file or directory\n" \
1180 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001181
Eric Andersen7e9276b2001-02-22 01:15:47 +00001182#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001183 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001184#define mkfifo_full_usage \
1185 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1186 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001187 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001188
Eric Andersen7e9276b2001-02-22 01:15:47 +00001189#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001190 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001191#define mkfs_minix_full_usage \
1192 "Make a MINIX filesystem.\n\n" \
1193 "Options:\n" \
1194 "\t-c\t\tCheck the device for bad blocks\n" \
1195 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1196 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1197 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001198 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001199
Eric Andersen7e9276b2001-02-22 01:15:47 +00001200#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001201 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001202#define mknod_full_usage \
1203 "Create a special file (block, character, or pipe).\n\n" \
1204 "Options:\n" \
1205 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1206 "TYPEs include:\n" \
1207 "\tb:\tMake a block (buffered) device.\n" \
1208 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001209 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001210#define mknod_example_usage \
1211 "$ mknod /dev/fd0 b 2 0 \n" \
1212 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001213
Eric Andersen7e9276b2001-02-22 01:15:47 +00001214#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001215 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001216#define mkswap_full_usage \
1217 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001218 "Options:\n" \
1219 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001220 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001221 "\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 +00001222 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001223
Eric Andersen7e9276b2001-02-22 01:15:47 +00001224#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001225 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001226#define mktemp_full_usage \
1227 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001228 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001229#define mktemp_example_usage \
1230 "$ mktemp /tmp/temp.XXXXXX\n" \
1231 "/tmp/temp.mWiLjM\n" \
1232 "$ ls -la /tmp/temp.mWiLjM\n" \
1233 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001234
Eric Andersen8d79ce82001-07-22 23:00:15 +00001235#define modprobe_trivial_usage \
1236 "[FILE ...]"
1237#define modprobe_full_usage \
Eric Andersenabc95682002-07-03 02:52:35 +00001238 "Used for high level module loading and unloading."
Eric Andersen8d79ce82001-07-22 23:00:15 +00001239#define modprobe_example_usage \
1240 "$ modprobe cdrom\n"
1241
Eric Andersen7e9276b2001-02-22 01:15:47 +00001242#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001243 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001244#define more_full_usage \
1245 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001246#define more_example_usage \
1247 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001248
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001249#ifdef CONFIG_FEATURE_MOUNT_LOOP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001250 #define USAGE_MOUNT_LOOP(a) a
1251#else
1252 #define USAGE_MOUNT_LOOP(a)
1253#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001254#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001255 #define USAGE_MTAB(a) a
1256#else
1257 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001258#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001259#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001260 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001261#define mount_full_usage \
1262 "Mount a filesystem\n\n" \
1263 "Flags:\n" \
1264 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001265 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001266 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001267 "\t-n:\t\tDon't write a mount table entry.\n" \
1268 ) \
1269 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1270 "\t-r:\t\tMount the filesystem read-only.\n" \
1271 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1272 "\t-w:\t\tMount for reading and writing (default).\n" \
1273 "\n" \
1274 "Options for use with the \"-o\" flag:\n" \
1275 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1276 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1277 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1278 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001279 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001280 "\tloop:\t\tMounts a file via loop device.\n" \
1281 ) \
1282 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001283 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001284 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001285 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001286 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001287 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001288#define mount_example_usage \
1289 "$ mount\n" \
1290 "/dev/hda3 on / type minix (rw)\n" \
1291 "proc on /proc type proc (rw)\n" \
1292 "devpts on /dev/pts type devpts (rw)\n" \
1293 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1294 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001295
Eric Andersen7e9276b2001-02-22 01:15:47 +00001296#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001297 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001298#define mt_full_usage \
1299 "Control magnetic tape drive operation\n" \
1300 "\nAvailable Opcodes:\n\n" \
1301 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1302 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
1303 "ras3 reset retension rew rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001304 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001305
Eric Andersen7e9276b2001-02-22 01:15:47 +00001306#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001307 "SOURCE DEST\n" \
1308 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001309#define mv_full_usage \
1310 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001311#define mv_example_usage \
1312 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001313
Eric Andersen7e9276b2001-02-22 01:15:47 +00001314#define nc_trivial_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001315 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001316#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001317 "Netcat opens a pipe to IP:port\n\n" \
1318 "Options:\n" \
1319 "\t-l\t\tlisten mode, for inbound connects\n" \
1320 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00001321 "\t-i SECS\t\tdelay interval for lines sent\n" \
Eric Andersen00a6a752002-04-26 23:53:10 +00001322 "\t-e PROG\t\tprogram to exec after connect (dangerous!)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001323#define nc_example_usage \
1324 "$ nc foobar.somedomain.com 25\n" \
1325 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1326 "help\n" \
1327 "214-Commands supported:\n" \
1328 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1329 "214 NOOP QUIT RSET HELP\n" \
1330 "quit\n" \
1331 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001332
Eric Andersen1552ff72001-10-31 11:07:12 +00001333#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00001334 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00001335#define netstat_full_usage \
1336 "-l display listening server sockets\n" \
1337 "-a display all sockets (default: connected)\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001338 "-e display other/more information\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001339 "-n don't resolve names\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001340 "-r display routing table\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001341 "-t tcp sockets\n" \
1342 "-u udp sockets\n" \
1343 "-w raw sockets\n" \
1344 "-x unix sockets\n"
1345
Eric Andersen7e9276b2001-02-22 01:15:47 +00001346#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001347 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001348#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001349 "Queries the nameserver for the IP address of the given HOST\n" \
1350 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001351#define nslookup_example_usage \
1352 "$ nslookup localhost\n" \
1353 "Server: default\n" \
1354 "Address: default\n" \
1355 "\n" \
1356 "Name: debian\n" \
1357 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001358
Glenn L McGrath60281112001-11-02 11:39:46 +00001359#define od_trivial_usage \
1360 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
1361#define od_full_usage \
1362 "Write an unambiguous representation, octal bytes by default, of FILE\n"\
1363 "to standard output. With no FILE, or when FILE is -, read standard input."
1364
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00001365#define openvt_trivial_usage \
1366 "<vtnum> <COMMAND> [ARGS...]"
1367#define openvt_full_usage \
1368 "Start a command on a new virtual terminal"
1369#define openvt_example_usage \
1370 "openvt 2 /bin/ash\n"
1371
Eric Andersen27f64e12002-06-23 04:24:25 +00001372#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
1373 #define PASSWORD_ALG_TYPES(a) a
1374#else
1375 #define PASSWORD_ALG_TYPES(a)
1376#endif
1377#define passwd_trivial_usage \
1378 "[OPTION] [name]"
1379#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00001380 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00001381 "changes the password for the current user.\n" \
1382 "Options:\n" \
1383 "\t-a\tDefine which algorithm shall be used for the password.\n" \
1384 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001385 PASSWORD_ALG_TYPES(", sha1") \
Eric Andersen27f64e12002-06-23 04:24:25 +00001386 ")\n\t-d\tDelete the password for the specified user account.\n" \
1387 "\t-l\tLocks (disables) the specified user account.\n" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001388 "\t-u\tUnlocks (re-enables) the specified user account."
Eric Andersen27f64e12002-06-23 04:24:25 +00001389
Eric Andersen221b2ea2001-07-31 19:06:07 +00001390#define pidof_trivial_usage \
1391 "process-name [process-name ...]"
1392#define pidof_full_usage \
1393 "Lists the PIDs of all processes with names that match the names on the command line"
1394#define pidof_example_usage \
1395 "$ pidof init\n" \
1396 "1\n"
1397
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001398#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001399#define ping_trivial_usage "host"
1400#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1401#else
1402#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001403 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001404#define ping_full_usage \
1405 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1406 "Options:\n" \
1407 "\t-c COUNT\tSend only COUNT pings.\n" \
1408 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1409 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001410 "\t\t\tand when finished."
1411#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001412#define ping_example_usage \
1413 "$ ping localhost\n" \
1414 "PING slag (127.0.0.1): 56 data bytes\n" \
1415 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1416 "\n" \
1417 "--- debian ping statistics ---\n" \
1418 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1419 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001420
Eric Andersen51b8bd62002-07-03 11:46:38 +00001421#ifndef CONFIG_FEATURE_FANCY_PING6
1422#define ping6_trivial_usage "host"
1423#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1424#else
1425#define ping6_trivial_usage \
1426 "[OPTION]... host"
1427#define ping6_full_usage \
1428 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1429 "Options:\n" \
1430 "\t-c COUNT\tSend only COUNT pings.\n" \
1431 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1432 "\t-q\t\tQuiet mode, only displays output at start\n" \
1433 "\t\t\tand when finished."
1434#endif
1435#define ping6_example_usage \
1436 "$ ping6 ip6-localhost\n" \
1437 "PING ip6-localhost (::1): 56 data bytes\n" \
1438 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
1439 "\n" \
1440 "--- ip6-localhost ping statistics ---\n" \
1441 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1442 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
1443
Eric Andersen7e9276b2001-02-22 01:15:47 +00001444#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001445 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001446#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001447 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001448 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001449
Eric Andersen7e9276b2001-02-22 01:15:47 +00001450#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001451 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001452#define poweroff_full_usage \
1453 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001454
Eric Andersen7e9276b2001-02-22 01:15:47 +00001455#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001456 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001457#define printf_full_usage \
1458 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001459 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001460#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001461 "$ printf "Val=%d\\n" 5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001462 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001463
Eric Andersen7e9276b2001-02-22 01:15:47 +00001464#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001465 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001466#define ps_full_usage \
1467 "Report process status\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001468 "\nThis version of ps accepts no options."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001469#define ps_example_usage \
1470 "$ ps\n" \
1471 " PID Uid Gid State Command\n" \
1472 " 1 root root S init\n" \
1473 " 2 root root S [kflushd]\n" \
1474 " 3 root root S [kupdate]\n" \
1475 " 4 root root S [kpiod]\n" \
1476 " 5 root root S [kswapd]\n" \
1477 " 742 andersen andersen S [bash]\n" \
1478 " 743 andersen andersen S -bash\n" \
1479 " 745 root root S [getty]\n" \
1480 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001481
Eric Andersen7e9276b2001-02-22 01:15:47 +00001482#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001483 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001484#define pwd_full_usage \
1485 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001486#define pwd_example_usage \
1487 "$ pwd\n" \
1488 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001489
Eric Andersen7e9276b2001-02-22 01:15:47 +00001490#define rdate_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001491 "[OPTION] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001492#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001493 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001494 "Options:\n" \
1495 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001496 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001497
Eric Andersen7e9276b2001-02-22 01:15:47 +00001498#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001499 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001500#define readlink_full_usage \
1501 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001502
Eric Andersen7e9276b2001-02-22 01:15:47 +00001503#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001504 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001505#define reboot_full_usage \
1506 "Reboot the system."
1507
1508#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001509 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001510#define renice_full_usage \
1511 "Changes priority of running processes. Allowed priorities range\n" \
1512 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001513 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001514
Eric Andersen7e9276b2001-02-22 01:15:47 +00001515#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001516 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001517#define reset_full_usage \
1518 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001519
Eric Andersen7e9276b2001-02-22 01:15:47 +00001520#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001521 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001522#define rm_full_usage \
1523 "Remove (unlink) the FILE(s). You may use '--' to\n" \
1524 "indicate that all following arguments are non-options.\n\n" \
1525 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00001526 "\t-i\t\talways prompt before removing each destination" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001527 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001528 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001529#define rm_example_usage \
1530 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001531
Eric Andersen7e9276b2001-02-22 01:15:47 +00001532#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001533 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001534#define rmdir_full_usage \
1535 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001536#define rmdir_example_usage \
1537 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001538
Eric Andersen7e9276b2001-02-22 01:15:47 +00001539#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001540 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001541#define rmmod_full_usage \
1542 "Unloads the specified kernel modules from the kernel.\n\n" \
1543 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001544 "\t-a\tTry to remove all unused kernel modules."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001545#define rmmod_example_usage \
1546 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001547
Eric Andersen7e9276b2001-02-22 01:15:47 +00001548#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001549 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001550#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00001551 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00001552 "Options:\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001553 "\t-n\tDont resolve names.\n" \
1554 "\t-e\tDisplay other/more information"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001555
Glenn L McGrathf8736d22001-06-26 01:19:34 +00001556#define rpm2cpio_trivial_usage \
1557 "package.rpm"
1558#define rpm2cpio_full_usage \
1559 "Outputs a cpio archive of the rpm file."
1560
Eric Andersen6cf47a72001-10-31 10:24:36 +00001561#define run_parts_trivial_usage \
1562 "[-t] [-a ARG] [-u MASK] DIRECTORY"
1563#define run_parts_full_usage \
1564 "Run a bunch of scripts in a directory.\n\n" \
1565 "Options:\n" \
1566 "\t-t\t\tTest only what file will be executed, without execute them.\n" \
1567 "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \
1568 "\t-u MASK\tSet the umask to MASK before executing every program."
1569
Eric Andersen7e9276b2001-02-22 01:15:47 +00001570#define sed_trivial_usage \
Matt Kraai075228a2001-06-21 14:40:55 +00001571 "[-nef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001572#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001573 "Options:\n" \
1574 "\t-n\t\tsuppress automatic printing of pattern space\n" \
1575 "\t-e script\tadd the script to the commands to be executed\n" \
1576 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001577 "\n" \
1578 "If no -e or -f is given, the first non-option argument is taken as the\n" \
1579 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001580 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001581#define sed_example_usage \
1582 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
1583 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001584
Eric Andersen7e9276b2001-02-22 01:15:47 +00001585#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001586 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001587#define setkeycodes_full_usage \
1588 "Set entries into the kernel's scancode-to-keycode map,\n" \
1589 "allowing unusual keyboards to generate usable keycodes.\n\n" \
1590 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001591 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001592#define setkeycodes_example_usage \
1593 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001594
Matt Kraai2d91deb2001-08-01 17:21:35 +00001595#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001596 "[FILE]...\n" \
1597 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00001598#define lash_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001599 "lash: The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00001600#define lash_notes_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001601"This command does not yet have proper documentation.\n" \
1602"\n" \
1603"Use lash just as you would use any other shell. It properly handles pipes,\n" \
1604"redirects, job control, can be used as the shell for scripts, and has a\n" \
1605"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
1606"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
1607"use ash or bash. If you just need a very simple and extremely small shell,\n" \
1608"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001609
Eric Andersen7e9276b2001-02-22 01:15:47 +00001610#define sleep_trivial_usage \
1611 "N"
1612#define sleep_full_usage \
1613 "Pause for N seconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001614#define sleep_example_usage \
1615 "$ sleep 2\n" \
1616 "[2 second delay results]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001617
Eric Andersen7e9276b2001-02-22 01:15:47 +00001618
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001619#ifdef CONFIG_FEATURE_SORT_UNIQUE
Mark Whitleyfccaa362001-04-17 18:56:18 +00001620 #define USAGE_SORT_UNIQUE(a) a
1621#else
1622 #define USAGE_SORT_UNIQUE(a)
1623#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001624#ifdef CONFIG_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001625 #define USAGE_SORT_REVERSE(a) a
1626#else
1627 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001628#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001629#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001630 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001631#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001632 "Sorts lines of text in the specified files\n\n"\
1633 "Options:\n" \
1634 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
1635 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
1636 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001637#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001638 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001639 "a\n" \
1640 "b\n" \
1641 "c\n" \
1642 "d\n" \
1643 "e\n" \
1644 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001645
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001646#define start_stop_daemon_trivial_usage \
1647 "[OPTIONS]"
1648#define start_stop_daemon_full_usage \
1649 "Program to start and stop services.\n"\
1650 "Options:\n" \
1651 "-S\t\t\tstart\n"\
1652 "-K\t\t\tstop\n"\
1653 "-x <executable>\t\tprogram to start/check if it is running\n"\
1654 "-p <pid-file>\t\tpid file to check\n"\
1655 "-u <username>|<uid>\tstop this user's processes\n"\
1656 "-n <process-name>\tstop processes with this name\n"\
1657 "-s <signal>\t\tsignal to send (default 15)\n"\
1658 "-a <pathname>\t\tprogram to start (default <executable>)\n"
1659
Eric Andersen7e9276b2001-02-22 01:15:47 +00001660#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001661 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001662#define stty_full_usage \
1663 "Without arguments, prints baud rate, line discipline," \
1664 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001665 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00001666 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001667 "\n\t-a\t\tprint all current settings in human-readable form" \
1668 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00001669 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001670
Robert Griebl1fca5582002-06-04 20:45:46 +00001671#define su_trivial_usage \
1672 "[OPTION]... [-] [username]"
1673#define su_full_usage \
1674 "Change user id or become root.\n" \
1675 "Options:\n" \
1676 "\t-p\tPreserve environment"
1677
Eric Andersen27f64e12002-06-23 04:24:25 +00001678#define sulogin_trivial_usage \
1679 "[OPTION]... [tty-device]"
1680#define sulogin_full_usage \
1681 "Single user login\n" \
1682 "Options:\n" \
1683 "\t-f\tDo not authenticate (user already authenticated)\n" \
1684 "\t-h\tName of the remote host for this login.\n" \
1685 "\t-p\tPreserve environment."
1686
Eric Andersen7e9276b2001-02-22 01:15:47 +00001687#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001688 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001689#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001690 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001691 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001692 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001693
Eric Andersen7e9276b2001-02-22 01:15:47 +00001694#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001695 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001696#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001697 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001698 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001699 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001700
Eric Andersen7e9276b2001-02-22 01:15:47 +00001701#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001702 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001703#define sync_full_usage \
1704 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001705
Eric Andersen7e9276b2001-02-22 01:15:47 +00001706
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001707#ifdef CONFIG_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00001708 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001709#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00001710 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001711#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00001712#ifdef CONFIG_FEATURE_IPC_SYSLOG
1713 #define USAGE_IPC_LOG(a) a
1714#else
1715 #define USAGE_IPC_LOG(a)
1716#endif
1717
Eric Andersen7e9276b2001-02-22 01:15:47 +00001718#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001719 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001720#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00001721 "Linux system and kernel logging utility.\n" \
1722 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001723 "Options:\n" \
1724 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
1725 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001726 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001727 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00001728 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00001729 "\t-L\t\tLog locally and via network logging (default is network only)") \
1730 USAGE_IPC_LOG( \
1731 "\n\t-C\t\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001732#define syslogd_example_usage \
1733 "$ syslogd -R masterlog:514\n" \
1734 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001735
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001736
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001737#ifndef CONFIG_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00001738 #define USAGE_UNSIMPLE_TAIL(a)
1739#else
1740 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001741#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001742#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001743 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001744#define tail_full_usage \
1745 "Print last 10 lines of each FILE to standard output.\n" \
1746 "With more than one FILE, precede each with a header giving the\n" \
1747 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
1748 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001749 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001750 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
1751 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001752 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001753 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
1754 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001755 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001756 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001757 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
1758#define tail_example_usage \
1759 "$ tail -n 1 /etc/resolv.conf\n" \
1760 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001761
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001762#ifdef CONFIG_FEATURE_TAR_CREATE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001763 #define USAGE_TAR_CREATE(a) a
1764#else
1765 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001766#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001767#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001768 #define USAGE_TAR_EXCLUDE(a) a
1769#else
1770 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001771#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001772#define tar_trivial_usage \
1773 "-[" USAGE_TAR_CREATE("c") "xtvO] " \
Eric Andersen317827d2001-05-21 17:50:53 +00001774 USAGE_TAR_EXCLUDE("[--exclude FILE] [-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00001775 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001776#define tar_full_usage \
1777 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00001778 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001779 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001780 "\tx\t\textract\n" \
1781 "\tt\t\tlist\n" \
1782 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001783 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001784 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001785 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001786 "\texclude\t\tfile to exclude\n" \
1787 "\tX\t\tfile with names to exclude\n" \
1788 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00001789 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001790 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001791#define tar_example_usage \
1792 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
1793 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001794
Eric Andersen7e9276b2001-02-22 01:15:47 +00001795#define tee_trivial_usage \
1796 "[OPTION]... [FILE]..."
1797#define tee_full_usage \
1798 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001799 "Options:\n" \
1800 "\t-a\tappend to the given FILEs, do not overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001801#define tee_example_usage \
1802 "$ echo "Hello" | tee /tmp/foo\n" \
1803 "$ cat /tmp/foo\n" \
1804 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001805
Eric Andersen7e9276b2001-02-22 01:15:47 +00001806#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001807 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001808#define telnet_full_usage \
1809 "Telnet is used to establish interactive communication with another\n"\
1810 "computer over a network using the TELNET protocol."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001811
Eric Andersen08a72202002-09-30 20:52:10 +00001812#define telnetd_trivial_usage \
1813 "[OPTION]"
1814#define telnetd_full_usage \
1815 "Telnetd listens for incoming TELNET connections on PORT.\n"\
1816 "Options:\n" \
1817 "\t-p PORT\tlisten for connections on PORT (default 23)\n"\
1818 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
1819
Eric Andersen7e9276b2001-02-22 01:15:47 +00001820#define test_trivial_usage \
1821 "EXPRESSION\n or [ EXPRESSION ]"
1822#define test_full_usage \
1823 "Checks file types and compares values returning an exit\n" \
1824 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001825#define test_example_usage \
1826 "$ test 1 -eq 2\n" \
1827 "$ echo $?\n" \
1828 "1\n" \
1829 "$ test 1 -eq 1\n" \
1830 "$ echo $? \n" \
1831 "0\n" \
1832 "$ [ -d /etc ]\n" \
1833 "$ echo $?\n" \
1834 "0\n" \
1835 "$ [ -d /junk ]\n" \
1836 "$ echo $?\n" \
1837 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001838
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001839#ifdef CONFIG_FEATURE_TFTP_GET
Mark Whitley450736c2001-03-02 19:08:50 +00001840 #define USAGE_TFTP_GET(a) a
1841#else
1842 #define USAGE_TFTP_GET(a)
1843#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001844#ifdef CONFIG_FEATURE_TFTP_PUT
Mark Whitley450736c2001-03-02 19:08:50 +00001845 #define USAGE_TFTP_PUT(a) a
1846#else
1847 #define USAGE_TFTP_PUT(a)
1848#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001849#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Glenn L McGrathad117d82001-10-05 04:40:37 +00001850 #define USAGE_TFTP_BS(a) a
1851#else
1852 #define USAGE_TFTP_BS(a)
1853#endif
Mark Whitley450736c2001-03-02 19:08:50 +00001854
1855#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00001856 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00001857#define tftp_full_usage \
1858 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00001859 "Options:\n" \
Glenn L McGrathad117d82001-10-05 04:40:37 +00001860 "\t-l FILE\tLocal FILE.\n" \
1861 "\t-r FILE\tRemote FILE.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00001862 USAGE_TFTP_GET( \
Matt Kraai3be34302001-09-21 14:42:30 +00001863 "\t-g\tGet file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00001864 ) \
1865 USAGE_TFTP_PUT( \
Matt Kraai3be34302001-09-21 14:42:30 +00001866 "\t-p\tPut file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00001867 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00001868 USAGE_TFTP_BS( \
1869 "\t-b SIZE\tTransfer blocks of SIZE octets.\n" \
1870 )
Eric Andersenc3657422001-11-30 07:54:32 +00001871#define time_trivial_usage \
1872 "[OPTION]... COMMAND [ARGS...]"
1873#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00001874 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
1875 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00001876 "Options:\n" \
1877 "\t-v\tDisplays verbose resource usage information."
Mark Whitley450736c2001-03-02 19:08:50 +00001878
Eric Andersen420b2082002-09-17 22:14:58 +00001879#define top_trivial_usage \
1880 "[-d <seconds>]"
1881#define top_full_usage \
1882 "top provides an view of processor activity in real time.\n" \
1883 "This utility reads the status for all processes in /proc each <seconds>\n" \
1884 "and shows the status for however many processes will fit on the screen.\n" \
1885 "This utility will not show processes that are started after program startup,\n" \
1886 "but it will show the EXIT status for and PIDs that exit while it is running."
1887
Eric Andersen7e9276b2001-02-22 01:15:47 +00001888#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001889 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001890#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001891 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001892 "Options:\n" \
1893 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001894#define touch_example_usage \
1895 "$ ls -l /tmp/foo\n" \
1896 "/bin/ls: /tmp/foo: No such file or directory\n" \
1897 "$ touch /tmp/foo\n" \
1898 "$ ls -l /tmp/foo\n" \
1899 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001900
1901#define tr_trivial_usage \
1902 "[-cds] STRING1 [STRING2]"
1903#define tr_full_usage \
1904 "Translate, squeeze, and/or delete characters from\n" \
1905 "standard input, writing to standard output.\n\n" \
1906 "Options:\n" \
1907 "\t-c\ttake complement of STRING1\n" \
1908 "\t-d\tdelete input characters coded STRING1\n" \
1909 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001910#define tr_example_usage \
1911 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
1912 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001913
Eric Andersen5c58d282001-07-10 16:29:00 +00001914#define traceroute_trivial_usage \
1915 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n\
1916 [-s src_addr] [-t tos] [-w wait] host [data size]"
1917#define traceroute_full_usage \
1918 "trace the route ip packets follow going to \"host\"\n" \
1919 "Options:\n" \
1920 "\t-d\tset SO_DEBUG options to socket\n" \
1921 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
1922 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
1923 "\t-v\tVerbose output\n" \
1924 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
1925 "\t-p port#\tSet the base UDP port number used in probes\n" \
1926 "\t\t(default is 33434)\n" \
1927 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
1928 "\t\t(default is 3)\n" \
1929 "\t-s src_addr\tUse the following IP address as the source address\n" \
1930 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
1931 "\t\t(default 0)\n" \
1932 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
1933 "\t\t(default 3 sec.)."
1934
1935
Eric Andersen7e9276b2001-02-22 01:15:47 +00001936#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001937 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001938#define true_full_usage \
1939 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001940#define true_example_usage \
1941 "$ true\n" \
1942 "$ echo $?\n" \
1943 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001944
Eric Andersen7e9276b2001-02-22 01:15:47 +00001945#define tty_trivial_usage \
1946 ""
1947#define tty_full_usage \
1948 "Print the file name of the terminal connected to standard input.\n\n"\
1949 "Options:\n" \
1950 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001951#define tty_example_usage \
1952 "$ tty\n" \
1953 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001954
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00001955#define udhcpc_trivial_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00001956 "[-fbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00001957#define udhcpc_full_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00001958 "\tUsage: udhcpc [OPTIONS]\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00001959 "\t-c,\t--clientid=CLIENTID\tClient identifier\n" \
1960 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00001961 "\t-h,\t \tAlias for -h\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00001962 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00001963 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated.\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00001964 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
1965 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated.\n" \
1966 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
1967 "\t-q,\t--quit\tQuit after obtaining lease\n" \
1968 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
1969 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
1970 "\t-v,\t--version\tDisplay version"
1971
Russ Dill61fb4892002-10-14 21:41:28 +00001972#define udhcpd_trivial_usage \
1973 "[configfile]\n" \
1974
1975#define udhcpd_full_usage \
1976 "\tUsage: udhcpd [configfile]\n"
1977
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001978#ifdef CONFIG_FEATURE_MOUNT_FORCE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001979 #define USAGE_MOUNT_FORCE(a) a
1980#else
1981 #define USAGE_MOUNT_FORCE(a)
1982#endif
1983#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001984 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001985#define umount_full_usage \
1986 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00001987 "\nFlags:\n" "\t-a\tUnmount all file systems" \
1988 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
1989 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00001990 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00001991 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 +00001992#define umount_example_usage \
1993 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001994
1995#define uname_trivial_usage \
1996 "[OPTION]..."
1997#define uname_full_usage \
1998 "Print certain system information. With no OPTION, same as -s.\n\n" \
1999 "Options:\n" \
2000 "\t-a\tprint all information\n" \
2001 "\t-m\tthe machine (hardware) type\n" \
2002 "\t-n\tprint the machine's network node hostname\n" \
2003 "\t-r\tprint the operating system release\n" \
2004 "\t-s\tprint the operating system name\n" \
2005 "\t-p\tprint the host processor type\n" \
2006 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002007#define uname_example_usage \
2008 "$ uname -a\n" \
2009 "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002010
2011#define uniq_trivial_usage \
2012 "[OPTION]... [INPUT [OUTPUT]]"
2013#define uniq_full_usage \
2014 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00002015 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002016 "Options:\n" \
2017 "\t-c\tprefix lines by the number of occurrences\n" \
2018 "\t-d\tonly print duplicate lines\n" \
2019 "\t-u\tonly print unique lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002020#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002021 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002022 "a\n" \
2023 "b\n" \
2024 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002025
2026#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002027 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002028#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002029 "Converts FILE from unix format to dos format. When no option\n" \
2030 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002031 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002032 "Options:\n" \
2033 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002034 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002035
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002036#define unzip_trivial_usage \
2037 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
2038#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002039 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002040 "Options:\n" \
2041 "\t-l\tlist archive contents (short form)\n" \
2042 "\t-n\tnever overwrite existing files (default)\n" \
2043 "\t-o\toverwrite files without prompting\n" \
2044 "\t-p\tsend output to stdout\n" \
2045 "\t-q\tbe quiet\n" \
2046 "\t-x\texclude these files\n" \
2047 "\t-d\textract files into this directory"
2048
Eric Andersen7e9276b2001-02-22 01:15:47 +00002049#define update_trivial_usage \
2050 "[options]"
2051#define update_full_usage \
2052 "Periodically flushes filesystem buffers.\n\n" \
2053 "Options:\n" \
2054 "\t-S\tforce use of sync(2) instead of flushing\n" \
2055 "\t-s SECS\tcall sync this often (default 30)\n" \
2056 "\t-f SECS\tflush some buffers this often (default 5)"
2057
2058#define uptime_trivial_usage \
2059 ""
2060#define uptime_full_usage \
2061 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002062#define uptime_example_usage \
2063 "$ uptime\n" \
2064 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002065
2066#define usleep_trivial_usage \
2067 "N"
2068#define usleep_full_usage \
2069 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002070#define usleep_example_usage \
2071 "$ usleep 1000000\n" \
2072 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002073
2074#define uudecode_trivial_usage \
2075 "[FILE]..."
2076#define uudecode_full_usage \
2077 "Uudecode a file that is uuencoded.\n\n" \
2078 "Options:\n" \
Eric Andersen704b2c22001-03-16 08:06:30 +00002079 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002080#define uudecode_example_usage \
2081 "$ uudecode -o busybox busybox.uu\n" \
2082 "$ ls -l busybox\n" \
2083 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002084
2085#define uuencode_trivial_usage \
2086 "[OPTION] [INFILE] REMOTEFILE"
2087#define uuencode_full_usage \
2088 "Uuencode a file.\n\n" \
2089 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00002090 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002091#define uuencode_example_usage \
2092 "$ uuencode busybox busybox\n" \
2093 "begin 755 busybox\n" \
2094 "<encoded file snipped>\n" \
2095 "$ uudecode busybox busybox > busybox.uu\n" \
2096 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002097
Eric Andersen3f980402001-04-04 17:31:15 +00002098#define vi_trivial_usage \
2099 "[OPTION] [FILE]..."
2100#define vi_full_usage \
2101 "edit FILE.\n\n" \
2102 "Options:\n" \
2103 "\t-R\tRead-only- do not write to the file."
2104
Eric Andersen27f64e12002-06-23 04:24:25 +00002105#define vlock_trivial_usage \
2106 "[OPTIONS]"
2107#define vlock_full_usage \
2108 "Lock a virtual terminal. A password is required to unlock\n" \
2109 "Options:\n" \
2110 "\t-a\tLock all VTs"
2111
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002112#define watch_trivial_usage \
2113 "[-n <seconds>] COMMAND..."
2114#define watch_full_usage \
2115 "Executes a program periodically.\n" \
2116 "Options:\n" \
2117 "\t-n\tLoop period in seconds - default is 2."
2118#define watch_example_usage \
2119 "$ watch date\n" \
2120 "Mon Dec 17 10:31:40 GMT 2000\n" \
2121 "Mon Dec 17 10:31:42 GMT 2000\n" \
2122 "Mon Dec 17 10:31:44 GMT 2000"
2123
Eric Andersen7e9276b2001-02-22 01:15:47 +00002124#define watchdog_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002125 "DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002126#define watchdog_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002127 "Periodically write to watchdog device DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002128
2129#define wc_trivial_usage \
2130 "[OPTION]... [FILE]..."
2131#define wc_full_usage \
2132 "Print line, word, and byte counts for each FILE, and a total line if\n" \
2133 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
2134 "Options:\n" \
2135 "\t-c\tprint the byte counts\n" \
2136 "\t-l\tprint the newline counts\n" \
2137 "\t-L\tprint the length of the longest line\n" \
2138 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002139#define wc_example_usage \
2140 "$ wc /etc/passwd\n" \
2141 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002142
2143#define wget_trivial_usage \
Robert Griebld7760112002-05-14 23:36:45 +00002144 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n\t[--header 'header: value'] [-Y|--proxy on/off] [-P DIR] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002145#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00002146 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002147 "Options:\n" \
2148 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00002149 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00002150 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00002151 "\t-O\tsave to filename ('-' for stdout)\n" \
2152 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002153
2154#define which_trivial_usage \
2155 "[COMMAND ...]"
2156#define which_full_usage \
2157 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002158#define which_example_usage \
2159 "$ which login\n" \
2160 "/bin/login\n"
Eric Andersen00a6a752002-04-26 23:53:10 +00002161#define who_trivial_usage \
2162 " "
2163#define who_full_usage \
2164 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002165
2166#define whoami_trivial_usage \
2167 ""
2168#define whoami_full_usage \
2169 "Prints the user name associated with the current effective user id."
2170
2171#define xargs_trivial_usage \
2172 "[COMMAND] [ARGS...]"
2173#define xargs_full_usage \
2174 "Executes COMMAND on every item given by standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002175#define xargs_example_usage \
2176 "$ ls | xargs gzip\n" \
2177 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002178
2179#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002180 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002181#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002182 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002183
Eric Andersen7e9276b2001-02-22 01:15:47 +00002184#define zcat_trivial_usage \
2185 "FILE"
2186#define zcat_full_usage \
2187 "Uncompress to stdout."