blob: 17fd4073a3e279337b53d44ab4ad286626536f31 [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 Andersenf6f7bfb2002-10-22 12:24:59 +0000189#define crond_trivial_usage \
190 "-d[#] -c <crondir> -f -b"
191#define crond_full_usage \
192 "\t-d [#] -l [#] -S -L logfile -f -b -c dir\n" \
193 "\t-d num\tdebug level\n" \
194 "\t-l num\tlog level (8 - default)\n" \
195 "\t-S\tlog to syslod (defualt)\n" \
196 "\t-L file\tlog to file\n" \
197 "\t-f\trun in fordeground\n" \
198 "\t-b\trun in background (default)\n" \
199 "\t-c dir\tworking dir"
200
201#define crontab_trivial_usage \
202 "crontab [-c dir] {file|-}|[-u|-l|-e|-d user]"
203#define crontab_full_usage \
204 "\tfile <opts> replace crontab from file\n" \
205 "\t- <opts> replace crontab from stdin\n" \
206 "\t-u user specify user\n" \
207 "\t-l [user] list crontab for user\n" \
208 "\t-e [user] edit crontab for user\n" \
209 "\t-d [user] delete crontab for user\n" \
210 "\t-c dir specify crontab directory"
211
212
Eric Andersen7e9276b2001-02-22 01:15:47 +0000213#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000214 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000215#define cut_full_usage \
216 "Prints selected fields from each input FILE to standard output.\n\n" \
217 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000218 "\t-b LIST\t\tOutput only bytes from LIST\n" \
219 "\t-c LIST\t\tOutput only characters from LIST\n" \
220 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
221 "\t-s\t\tOutput only the lines containing delimiter\n" \
222 "\t-f N\t\tPrint only these fields\n" \
223 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000224#define cut_example_usage \
225 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
226 "Hello\n" \
227 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
228 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000229
Eric Andersen7e9276b2001-02-22 01:15:47 +0000230#define date_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000231 "[OPTION]... [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000232#define date_full_usage \
233 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000234 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000235 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000236 "\t-d STRING\tdisplay time described by STRING, not `now'\n" \
237 "\t-s\t\tSets time described by STRING\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000238 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000239#define date_example_usage \
240 "$ date\n" \
241 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000242
Eric Andersen7e9276b2001-02-22 01:15:47 +0000243#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000244 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000245#define dc_full_usage \
246 "This is a Tiny RPN calculator that understands the\n" \
247 "following operations: +, -, /, *, and, or, not, eor.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000248 "i.e., 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000249#define dc_example_usage \
250 "$ dc 2 2 +\n" \
251 "4\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000252 "$ dc 8 8 * 2 2 + /\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000253 "16\n" \
254 "$ dc 0 1 and\n" \
255 "0\n" \
256 "$ dc 0 1 or\n" \
257 "1\n" \
258 "$ echo 72 9 div 8 mul | dc\n" \
259 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000260
Eric Andersen7e9276b2001-02-22 01:15:47 +0000261#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000262 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000263 "\t [seek=N] [conv=notrunc|noerror|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000264#define dd_full_usage \
265 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000266 "\tif=FILE\t\tread from FILE instead of stdin\n" \
267 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
268 "\tbs=N\t\tread and write N bytes at a time\n" \
269 "\tcount=N\t\tcopy only N input blocks\n" \
270 "\tskip=N\t\tskip N input blocks\n" \
271 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000272 "\tconv=notrunc\tdon't truncate output file\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000273 "\tconv=noerror\tcontinue after read errors\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000274 "\tconv=sync\tpad blocks with zeros\n" \
275 "\n" \
276 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000277 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000278#define dd_example_usage \
279 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
280 "4+0 records in\n" \
281 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000282
Eric Andersen7e9276b2001-02-22 01:15:47 +0000283#define deallocvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000284 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000285#define deallocvt_full_usage \
286 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000287
Eric Andersenf349e972001-08-21 16:18:59 +0000288#define delgroup_trivial_usage \
289 "GROUP"
290#define delgroup_full_usage \
291 "Deletes group GROUP from the system"
292
293#define deluser_trivial_usage \
294 "USER"
295#define deluser_full_usage \
296 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000297
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000298#ifdef CONFIG_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000299 #define USAGE_HUMAN_READABLE(a) a
300 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000301#else
Eric Andersened0d9582001-02-23 13:23:03 +0000302 #define USAGE_HUMAN_READABLE(a)
303 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000304#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000305#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000306 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000307#define df_full_usage \
308 "Print the filesystem space used and space available.\n\n" \
309 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000310 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000311 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
312 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000313 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000314 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000315#define df_example_usage \
316 "$ df\n" \
317 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
318 "/dev/sda3 8690864 8553540 137324 98% /\n" \
319 "/dev/sda1 64216 36364 27852 57% /boot\n" \
320 "$ df /dev/sda3\n" \
321 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
322 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000323
Eric Andersen7e9276b2001-02-22 01:15:47 +0000324#define dirname_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000325 "[FILENAME ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000326#define dirname_full_usage \
327 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000328#define dirname_example_usage \
329 "$ dirname /tmp/foo\n" \
330 "/tmp\n" \
331 "$ dirname /tmp/foo/\n" \
332 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000333
Eric Andersen7e9276b2001-02-22 01:15:47 +0000334#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000335 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000336#define dmesg_full_usage \
337 "Prints or controls the kernel ring buffer\n\n" \
338 "Options:\n" \
339 "\t-c\t\tClears the ring buffer's contents after printing\n" \
340 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000341 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000342
Eric Andersen7e9276b2001-02-22 01:15:47 +0000343#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000344 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000345#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000346 "Converts FILE from dos format to unix format. When no option\n" \
347 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000348 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000349 "Options:\n" \
350 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000351 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000352
Eric Andersen7e9276b2001-02-22 01:15:47 +0000353#define dpkg_trivial_usage \
Eric Andersen9fe5f982002-04-13 14:48:51 +0000354 "-i package_file\n" \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000355 "[-CPru] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000356#define dpkg_full_usage \
Glenn L McGrathb9e4ce92001-07-18 05:16:31 +0000357 "\t-i\tInstall the package\n" \
358 "\t-C\tConfigure an unpackaged package\n" \
359 "\t-P\tPurge all files of a package\n" \
360 "\t-r\tRemove all but the configuration files for a package\n" \
361 "\t-u\tUnpack a package, but dont configure it\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000362
Eric Andersen7e9276b2001-02-22 01:15:47 +0000363#define dpkg_deb_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000364 "[-cefItxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000365#define dpkg_deb_full_usage \
366 "Perform actions on debian packages (.debs)\n\n" \
367 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000368 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000369 "\t-e\tExtract control files to [argument] directory\n" \
370 "\t-f\tDisplay control field name starting with [argument]\n" \
371 "\t-I\tDisplay the control filenamed [argument]\n" \
372 "\t-t\tExtract filesystem tree to stdout in tar format\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000373 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000374 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000375#define dpkg_deb_example_usage \
376 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000377
Eric Andersen7e9276b2001-02-22 01:15:47 +0000378#define du_trivial_usage \
Eric Andersen265d2292002-04-06 23:16:44 +0000379 "[-lsx" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000380#define du_full_usage \
381 "Summarizes disk space used for each FILE and/or directory.\n" \
382 "Disk space is printed in units of 1024 bytes.\n\n" \
383 "Options:\n" \
384 "\t-l\tcount sizes many times if hard linked\n" \
385 "\t-s\tdisplay only a total for each argument" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000386 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000387 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
388 "\t-m\tprint sizes in megabytes\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000389 "\t-x\tskip directories on different filesystems\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000390 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000391 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000392#define du_example_usage \
393 "$ du\n" \
394 "16 ./CVS\n" \
395 "12 ./kernel-patches/CVS\n" \
396 "80 ./kernel-patches\n" \
397 "12 ./tests/CVS\n" \
398 "36 ./tests\n" \
399 "12 ./scripts/CVS\n" \
400 "16 ./scripts\n" \
401 "12 ./docs/CVS\n" \
402 "104 ./docs\n" \
403 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000404
Eric Andersen7e9276b2001-02-22 01:15:47 +0000405#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000406 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000407#define dumpkmap_full_usage \
408 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000409#define dumpkmap_example_usage \
410 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000411
Russ Dill61fb4892002-10-14 21:41:28 +0000412#define dumpleases_trivial_usage \
413 "[-r|-a] [-f LEASEFILE]"
414#define dumpleases_full_usage \
415 "Usage: dumpleases -f <file> -[r|a]\n" \
416 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
417 "\t-r,\t--remaining\tInterepret lease times as time remaing\n" \
418 "\t-a,\t--absolute\tInterepret lease times as expire time\n"
419
Eric Andersen7e9276b2001-02-22 01:15:47 +0000420#define dutmp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000421 "[FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000422#define dutmp_full_usage \
423 "Dump utmp file format (pipe delimited) from FILE\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000424 "or stdin to stdout. (i.e., 'dutmp /var/run/utmp')"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000425#define dutmp_example_usage \
426 "$ dutmp /var/run/utmp\n" \
427 "8|7||si|||0|0|0|955637625|760097|0\n" \
428 "2|0|~|~~|reboot||0|0|0|955637625|782235|0\n" \
429 "1|20020|~|~~|runlevel||0|0|0|955637625|800089|0\n" \
430 "8|125||l4|||0|0|0|955637629|998367|0\n" \
431 "6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0\n" \
432 "6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0\n" \
433 "7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000434
Eric Andersen7e9276b2001-02-22 01:15:47 +0000435#define echo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000436 "[-neE] [ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000437#define echo_full_usage \
438 "Prints the specified ARGs to stdout\n\n" \
439 "Options:\n" \
440 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000441 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000442 "\t-E\tdisable interpretation of backslash-escaped characters"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000443#define echo_example_usage \
444 "$ echo "Erik is cool"\n" \
445 "Erik is cool\n" \
John Beppu5d817682001-04-17 17:09:34 +0000446 "$ echo -e "Erik\\nis\\ncool"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000447 "Erik\n" \
448 "is\n" \
449 "cool\n" \
Eric Andersen6197c512001-05-18 23:14:53 +0000450 "$ echo "Erik\\nis\\ncool"\n" \
451 "Erik\\nis\\ncool\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000452
Eric Andersen84e229c2001-03-29 22:48:33 +0000453#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000454 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000455#define env_full_usage \
456 "Prints the current environment or runs a program after setting\n" \
457 "up the specified environment.\n\n" \
458 "Options:\n" \
459 "\t-, -i\tstart with an empty environment\n" \
460 "\t-u\tremove variable from the environment\n"
461
Eric Andersen7e9276b2001-02-22 01:15:47 +0000462#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000463 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000464#define expr_full_usage \
465 "Prints the value of EXPRESSION to standard output.\n\n" \
466 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000467 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
468 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
469 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
470 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
471 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
472 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
473 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
474 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
475 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
476 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
477 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
478 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
479 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000480 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
481 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
482 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
483 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
484 "\t or 0\n" \
485 "\tlength STRING length of STRING\n" \
486 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
487 "\t it is a keyword like `match' or an\n" \
488 "\t operator like `/'\n" \
489 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000490 "Beware that many operators need to be escaped or quoted for shells.\n" \
491 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
492 "lexicographical. Pattern matches return the string matched between \n" \
493 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
494 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000495
Eric Andersen7e9276b2001-02-22 01:15:47 +0000496#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000497 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000498#define false_full_usage \
499 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000500#define false_example_usage \
501 "$ false\n" \
502 "$ echo $?\n" \
503 "1\n"
504
505#define fbset_trivial_usage \
506 "[options] [mode]"
507#define fbset_full_usage \
508 "Show and modify frame buffer settings"
509#define fbset_example_usage \
510 "$ fbset\n" \
511 "mode "1024x768-76"\n" \
512 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
513 "\tgeometry 1024 768 1024 768 16\n" \
514 "\ttimings 12714 128 32 16 4 128 4\n" \
515 "\taccel false\n" \
516 "\trgba 5/11,6/5,5/0,0/0\n" \
517 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000518
Eric Andersen7e9276b2001-02-22 01:15:47 +0000519#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000520 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000521#define fdflush_full_usage \
522 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000523
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000524#define fdisk_trivial_usage \
525 "[-l] [-v] [-b SSZ] [-u] DISK"
526#define fdisk_full_usage \
527 "Change partition table\n" \
528 "Options:\n" \
529 "-l List partition table(s)\n" \
530 "-u Give Start and End in sector (instead of cylinder) units\n" \
531 "-s PARTITION Give partition size(s) in blocks\n" \
532 "-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
Glenn L McGrath062c74f2002-11-27 09:29:49 +0000533 "-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000534
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000535#ifdef CONFIG_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000536 #define USAGE_FIND_TYPE(a) a
537#else
538 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000539#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000540#ifdef CONFIG_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000541 #define USAGE_FIND_PERM(a) a
542#else
543 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000544#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000545#ifdef CONFIG_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000546 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000547#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000548 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000549#endif
550
Eric Andersen7e9276b2001-02-22 01:15:47 +0000551#define find_trivial_usage \
552 "[PATH...] [EXPRESSION]"
553#define find_full_usage \
554 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000555 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000556 "\nEXPRESSION may consist of:\n" \
557 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000558 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000559 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000560 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000561 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
562) USAGE_FIND_PERM( \
563 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
564) USAGE_FIND_MTIME( \
565 "\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 +0000566#define find_example_usage \
567 "$ find / -name /etc/passwd\n" \
568 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000569
Eric Andersen7e9276b2001-02-22 01:15:47 +0000570#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000571 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000572#define free_full_usage \
573 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000574#define free_example_usage \
575 "$ free\n" \
576 " total used free shared buffers\n" \
577 " Mem: 257628 248724 8904 59644 93124\n" \
578 " Swap: 128516 8404 120112\n" \
579 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000580
Eric Andersen7e9276b2001-02-22 01:15:47 +0000581#define freeramdisk_trivial_usage \
582 "DEVICE"
583#define freeramdisk_full_usage \
584 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000585#define freeramdisk_example_usage \
586 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000587
588#define fsck_minix_trivial_usage \
589 "[-larvsmf] /dev/name"
590#define fsck_minix_full_usage \
591 "Performs a consistency check for MINIX filesystems.\n\n" \
592 "Options:\n" \
593 "\t-l\tLists all filenames\n" \
594 "\t-r\tPerform interactive repairs\n" \
595 "\t-a\tPerform automatic repairs\n" \
596 "\t-v\tverbose\n" \
597 "\t-s\tOutputs super-block information\n" \
598 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
599 "\t-f\tForce file system check."
600
601#define getopt_trivial_usage \
602 "[OPTIONS]..."
603#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000604 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000605 "\t-a, --alternative Allow long options starting with single -\n" \
606 "\t-l, --longoptions=longopts Long options to be recognized\n" \
607 "\t-n, --name=progname The name under which errors are reported\n" \
608 "\t-o, --options=optstring Short options to be recognized\n" \
609 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
610 "\t-Q, --quiet-output No normal output\n" \
611 "\t-s, --shell=shell Set shell quoting conventions\n" \
612 "\t-T, --test Test for getopt(1) version\n" \
613 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000614#define getopt_example_usage \
615 "$ cat getopt.test\n" \
616 "#!/bin/sh\n" \
617 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
618 " -n 'example.busybox' -- "$@"`\n" \
619 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
620 "eval set -- "$GETOPT"\n" \
621 "while true ; do\n" \
622 " case $1 in\n" \
623 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000624 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000625 " -c|--c-long)\n" \
626 " case "$2" in\n" \
627 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000628 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000629 " esac ;;\n" \
630 " --) shift ; break ;;\n" \
631 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
632 " esac\n" \
633 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000634
Eric Andersenf349e972001-08-21 16:18:59 +0000635#define getty_trivial_usage \
636 "getty [OPTIONS]... baud_rate,... line [termtype]"
637#define getty_full_usage \
638 "\nOpens a tty, prompts for a login name, then invokes /bin/login\n\n" \
639 "Options:\n" \
640 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
641 "\t-i\t\tDo not display /etc/issue before running login.\n" \
642 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
643 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
644 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
645 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
646 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
647 "\t-I initstring\tSets the init string to send before anything else.\n" \
648 "\t-H login_host\tLog login_host into the utmp file as the hostname."
649
650
Eric Andersen7e9276b2001-02-22 01:15:47 +0000651#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000652 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000653#define grep_full_usage \
654 "Search for PATTERN in each FILE or standard input.\n\n" \
655 "Options:\n" \
656 "\t-H\tprefix output lines with filename where match was found\n" \
657 "\t-h\tsuppress the prefixing filename on output\n" \
658 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000659 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000660 "\t-n\tprint line number with output lines\n" \
661 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
662 "\t-v\tselect non-matching lines\n" \
663 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000664#define grep_example_usage \
665 "$ grep root /etc/passwd\n" \
666 "root:x:0:0:root:/root:/bin/bash\n" \
667 "$ grep ^[rR]oo. /etc/passwd\n" \
668 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000669
Eric Andersen7e9276b2001-02-22 01:15:47 +0000670#define gunzip_trivial_usage \
671 "[OPTION]... FILE"
672#define gunzip_full_usage \
673 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
674 "Options:\n" \
675 "\t-c\tWrite output to standard output\n" \
676 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000677#define gunzip_example_usage \
678 "$ ls -la /tmp/BusyBox*\n" \
679 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
680 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
681 "$ ls -la /tmp/BusyBox*\n" \
682 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000683
684#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000685 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000686#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000687 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000688 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000689 "Options:\n" \
690 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
691 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000692#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000693 "$ ls -la /tmp/busybox*\n" \
694 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
695 "$ gzip /tmp/busybox.tar\n" \
696 "$ ls -la /tmp/busybox*\n" \
697 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000698
699#define halt_trivial_usage \
700 ""
701#define halt_full_usage \
702 "Halt the system."
703
704#define head_trivial_usage \
705 "[OPTION] [FILE]..."
706#define head_full_usage \
707 "Print first 10 lines of each FILE to standard output.\n" \
708 "With more than one FILE, precede each with a header giving the\n" \
709 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000710 "Options:\n" \
711 "\t-n NUM\t\tPrint first NUM lines instead of first 10"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000712#define head_example_usage \
713 "$ head -n 2 /etc/passwd\n" \
714 "root:x:0:0:root:/root:/bin/bash\n" \
715 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000716
Glenn L McGrath60281112001-11-02 11:39:46 +0000717#define hexdump_trivial_usage \
718 "[-[bcdefnosvx]] [OPTION] FILE"
719#define hexdump_full_usage \
720 "The hexdump utility is a filter which displays the specified files,\n" \
721 "or the standard input, if no files are specified, in a user specified\n"\
722 "format\n" \
723 "\t-b\t\tOne-byte octal display\n" \
724 "\t-c\t\tOne-byte character display\n" \
725 "\t-d\t\tTwo-byte decimal display\n" \
726 "\t-e FORMAT STRING\n" \
727 "\t-f FORMAT FILE\n" \
728 "\t-n LENGTH\tInterpret only length bytes of input\n" \
729 "\t-o\t\tTwo-byte octal display\n" \
730 "\t-s OFFSET\tSkip offset byte\n" \
731 "\t-v\t\tdisplay all input data\n" \
732 "\t-x\t\tTwo-byte hexadecimal display\n"
733
Eric Andersen7e9276b2001-02-22 01:15:47 +0000734#define hostid_trivial_usage \
735 ""
736#define hostid_full_usage \
737 "Print out a unique 32-bit identifier for the machine."
738
739#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000740 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000741#define hostname_full_usage \
742 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000743 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000744 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +0000745 "\t-s\tShort\n" \
746 "\t-i\tAddresses for the hostname\n" \
747 "\t-d\tDNS domain name\n" \
748 "\t-f\tFully qualified domain name\n" \
749 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000750#define hostname_example_usage \
751 "$ hostname\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000752 "sage \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000753
Robert Griebl1cd04452002-07-21 16:50:49 +0000754#define hwclock_trivial_usage \
755 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
756#define hwclock_full_usage \
757 "Query and set the hardware clock (RTC)\n\n" \
758 "Options:\n" \
759 "\t-r\tread hardware clock and print result\n" \
760 "\t-s\tset the system time from the hardware clock\n" \
761 "\t-w\tset the hardware clock to the current system time\n" \
762 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
763 "\t-l\tthe hardware clock is kept in local time"
764
Eric Andersen7e9276b2001-02-22 01:15:47 +0000765#define id_trivial_usage \
766 "[OPTIONS]... [USERNAME]"
767#define id_full_usage \
768 "Print information for USERNAME or the current user\n\n" \
769 "Options:\n" \
770 "\t-g\tprints only the group ID\n" \
771 "\t-u\tprints only the user ID\n" \
772 "\t-n\tprint a name instead of a number (with for -ug)\n" \
773 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000774#define id_example_usage \
775 "$ id\n" \
776 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000777
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000778#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +0000779 #define USAGE_SIOCSKEEPALIVE(a) a
780#else
781 #define USAGE_SIOCSKEEPALIVE(a)
782#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000783#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000784 #define USAGE_IFCONFIG_MII(a) a
785#else
786 #define USAGE_IFCONFIG_MII(a)
787#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000788#ifdef CONFIG_FEATURE_IFCONFIG_HW
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000789 #define USAGE_IFCONFIG_HW(a) a
790#else
791 #define USAGE_IFCONFIG_HW(a)
792#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000793#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000794 #define USAGE_IFCONFIG_OPT_A(a) a
795#else
796 #define USAGE_IFCONFIG_OPT_A(a)
797#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +0000798#ifdef CONFIG_FEATURE_IPV6
799 #define USAGE_IPV6(a) a
800#else
801 #define USAGE_IPV6(a)
802#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000803
Eric Andersen7e9276b2001-02-22 01:15:47 +0000804#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000805 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000806#define ifconfig_full_usage \
807 "configure a network interface\n\n" \
808 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +0000809 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
810 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000811 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000812 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000813 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000814 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
815 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000816 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000817 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
818 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000819 "\t[up|down] ..."
820
Glenn L McGrath021fa7d2002-11-09 09:34:15 +0000821#define ifup_trivial_usage \
822 "<-ahinv> <ifaces...>"
823#define ifup_full_usage \
824 "Usage: ifup <options> <ifaces...>\n\n" \
825 "Options:\n" \
826 "\t-h, --help\t\tthis help\n" \
827 "\t-a, --all\t\tde/configure all interfaces automatically\n" \
828 "\t-i, --interfaces FILE\tuse FILE for interface definitions\n" \
829 "\t-n, --no-act\t\tprint out what would happen, but don't do it\n" \
830 "\t\t\t\t(note that this option doesn't disable mappings)\n" \
831 "\t-v, --verbose\t\tprint out what would happen before doing it\n" \
832 "\t--no-mappings\t\tdon't run any mappings\n" \
833 "\t--force\t\t\tforce de/configuration\n"
834
835#define ifdown_trivial_usage \
836 "<-ahinv> <ifaces...>"
837#define ifdown_full_usage \
838 "Usage: ifdown <options> <ifaces...>\n\n" \
839 "Options:\n" \
840 "\t-h, --help\t\tthis help\n" \
841 "\t-a, --all\t\tde/configure all interfaces automatically\n" \
842 "\t-i, --interfaces FILE\tuse FILE for interface definitions\n" \
843 "\t-n, --no-act\t\tprint out what would happen, but don't do it\n" \
844 "\t\t\t\t(note that this option doesn't disable mappings)\n" \
845 "\t-v, --verbose\t\tprint out what would happen before doing it\n" \
846 "\t--no-mappings\t\tdon't run any mappings\n" \
847 "\t--force\t\t\tforce de/configuration\n"
848
Eric Andersen7e9276b2001-02-22 01:15:47 +0000849#define init_trivial_usage \
850 ""
851#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000852 "Init is the parent of all processes."
853#define init_notes_usage \
854"This version of init is designed to be run only by the kernel.\n" \
855"\n" \
856"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
857"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
858"runlevels, use sysvinit.\n" \
859"\n" \
860"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
861"it has the following default behavior:\n" \
862"\n" \
863" ::sysinit:/etc/init.d/rcS\n" \
864" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000865" ::ctrlaltdel:/sbin/reboot\n" \
866" ::shutdown:/sbin/swapoff -a\n" \
867" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000868" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000869"\n" \
870"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
871"\n" \
872" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000873" tty3::askfirst:/bin/sh\n" \
874" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000875"\n" \
876"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
877"\n" \
878" <id>:<runlevels>:<action>:<process>\n" \
879"\n" \
880" <id>: \n" \
881"\n" \
882" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
883" The id field is used by BusyBox init to specify the controlling tty for\n" \
884" the specified process to run on. The contents of this field are\n" \
885" appended to "/dev/" and used as-is. There is no need for this field to\n" \
886" be unique, although if it isn't you may have strange results. If this\n" \
887" field is left blank, the controlling tty is set to the console. Also\n" \
888" note that if BusyBox detects that a serial console is in use, then only\n" \
889" entries whose controlling tty is either the serial console or /dev/null\n" \
890" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
891" stinkin' utmp.\n" \
892"\n" \
893" <runlevels>: \n" \
894"\n" \
895" The runlevels field is completely ignored.\n" \
896"\n" \
897" <action>: \n" \
898"\n" \
899" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000900" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000901"\n" \
902" The available actions can be classified into two groups: actions\n" \
903" that are run only once, and actions that are re-run when the specified\n" \
904" process exits.\n" \
905"\n" \
906" Run only-once actions:\n" \
907"\n" \
908" 'sysinit' is the first item run on boot. init waits until all\n" \
909" sysinit actions are completed before continuing. Following the\n" \
910" completion of all sysinit actions, all 'wait' actions are run.\n" \
911" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000912" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000913" therefore, init does not wait for them to complete. 'restart' is\n" \
914" the action taken to restart the init process. By default this should\n" \
915" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
916" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000917" actions are run when the system detects that someone on the system\n" \
918" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
919" wants to run 'reboot' at this point to cause the system to reboot.\n" \
920" Finally the 'shutdown' action specifies the actions to taken when\n" \
921" init is told to reboot. Unmounting filesystems and disabling swap\n" \
922" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000923"\n" \
924" Run repeatedly actions:\n" \
925"\n" \
926" 'respawn' actions are run after the 'once' actions. When a process\n" \
927" started with a 'respawn' action exits, init automatically restarts\n" \
928" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
929" respawning out of control. The 'askfirst' actions acts just like\n" \
930" respawn, except that before running the specified process it\n" \
931" displays the line "Please press Enter to activate this console."\n" \
932" and then waits for the user to press enter before starting the\n" \
933" specified process. \n" \
934"\n" \
935" Unrecognized actions (like initdefault) will cause init to emit an\n" \
936" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +0000937" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000938"\n" \
939" <process>: \n" \
940"\n" \
941" Specifies the process to be executed and it's command line.\n" \
942"\n" \
943"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +0000944"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000945" # This is run first except when booting in single-user mode.\n" \
946" #\n" \
947" ::sysinit:/etc/init.d/rcS\n" \
948" \n" \
949" # /bin/sh invocations on selected ttys\n" \
950" #\n" \
951" # Start an "askfirst" shell on the console (whatever that may be)\n" \
952" ::askfirst:-/bin/sh\n" \
953" # Start an "askfirst" shell on /dev/tty2-4\n" \
954" tty2::askfirst:-/bin/sh\n" \
955" tty3::askfirst:-/bin/sh\n" \
956" tty4::askfirst:-/bin/sh\n" \
957" \n" \
958" # /sbin/getty invocations for selected ttys\n" \
959" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +0000960" tty4::respawn:/sbin/getty 38400 tty4\n" \
961" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000962" \n" \
963" \n" \
964" # Example of how to put a getty on a serial line (for a terminal)\n" \
965" #\n" \
966" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
967" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
968" #\n" \
969" # Example how to put a getty on a modem line.\n" \
970" #::respawn:/sbin/getty 57600 ttyS2\n" \
971" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000972" # Stuff to do when restarting the init process\n" \
973" ::restart:/sbin/init\n" \
974" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000975" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000976" ::ctrlaltdel:/sbin/reboot\n" \
977" ::shutdown:/bin/umount -a -r\n" \
978" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000979
980#define insmod_trivial_usage \
981 "[OPTION]... MODULE [symbol=value]..."
982#define insmod_full_usage \
983 "Loads the specified kernel modules into the kernel.\n\n" \
984 "Options:\n" \
985 "\t-f\tForce module to load into the wrong kernel version.\n" \
986 "\t-k\tMake module autoclean-able.\n" \
987 "\t-v\tverbose output\n" \
988 "\t-L\tLock to prevent simultaneous loads of a module\n" \
989 "\t-x\tdo not export externs"
990
Glenn L McGrath9a2d2722002-11-10 01:33:55 +0000991#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +0000992 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +0000993#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +0000994 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
995 "where OBJECT := { link | addr | route | tunnel }\n" \
996 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }\n"
997
998#define ipaddr_trivial_usage \
999 "{ {add|del} IFADDR dev STRING | {show|flush} [ dev STRING ] [ to PREFIX ] }"
1000#define ipaddr_full_usage \
1001 "ipaddr {add|del} IFADDR dev STRING\n" \
1002 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
1003 " [ to PREFIX ] [ label PATTERN ]\n" \
1004 "IFADDR := PREFIX | ADDR peer PREFIX\n" \
1005 " [ broadcast ADDR ] [ anycast ADDR ]\n" \
1006 " [ label STRING ] [ scope SCOPE-ID ]\n" \
1007 "SCOPE-ID := [ host | link | global | NUMBER ]\n"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001008
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001009#ifndef CONFIG_FEATURE_IPCALC_FANCY
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001010# define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001011 "[--broadcast] [--netmask] [--network] ipaddr <netmask>"
1012
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001013# define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001014 "Calculate IP network settings from a IP address\n\n" \
1015 "Options:\n" \
1016 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1017 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
1018 "\t-w\t--network\tDisplay calculated network address."
1019#else
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001020# define ipcalc_trivial_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001021 "[OPTION]... ipaddr <netmask>"
1022
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001023# define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001024 "Calculate IP network settings from a IP address\n\n" \
1025 "Options:\n" \
1026 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
1027 "\t-n\t--netmask\tDisplay default netmask for IP.\n" \
1028 "\t-w\t--network\tDisplay calculated network address.\n" \
1029 "\t-h\t--hostname\tDisplay first resolved host name.\n" \
1030 "\t-s\t--silent\tDon't ever display error messages."
1031#endif
1032
1033#define ipcalc_notes_usage \
1034 "ipcalc provides a simple way to calculate IP information for\n" \
1035 "a host. The various options specify what information ipcalc\n" \
1036 "should display on standard out. Multiple options may be\n" \
1037 "specified.\n"
1038
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001039#define iplink_trivial_usage \
1040 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1041#define iplink_full_usage \
1042 "iplink set DEVICE { up | down | arp { on | off } |\n" \
1043 " dynamic { on | off } |\n" \
1044 " mtu MTU }\n" \
1045 "iplink show [ DEVICE ]\n"
1046
1047#define iproute_trivial_usage \
1048 "{ list | flush | { add | del | change | append | replace | monitor } ROUTE }"
1049#define iproute_full_usage \
1050 "iproute { list | flush } SELECTOR\n" \
1051 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
1052 " [ oif STRING ] [ tos TOS ]\n" \
1053 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
1054 "SELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1055 "ROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]\n"
1056
1057#define iptunnel_trivial_usage \
1058 "{ add | change | del | show } [ NAME ] [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
1059#define iptunnel_full_usage \
1060 "iptunnel { add | change | del | show } [ NAME ]\n" \
1061 " [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1062 " [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1063 " [ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]\n"
1064
Eric Andersen7e9276b2001-02-22 01:15:47 +00001065#define kill_trivial_usage \
1066 "[-signal] process-id [process-id ...]"
1067#define kill_full_usage \
1068 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +00001069 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001070 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001071#define kill_example_usage \
1072 "$ ps | grep apache\n" \
1073 "252 root root S [apache]\n" \
1074 "263 www-data www-data S [apache]\n" \
1075 "264 www-data www-data S [apache]\n" \
1076 "265 www-data www-data S [apache]\n" \
1077 "266 www-data www-data S [apache]\n" \
1078 "267 www-data www-data S [apache]\n" \
1079 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001080
1081#define killall_trivial_usage \
1082 "[-signal] process-name [process-name ...]"
1083#define killall_full_usage \
1084 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001085 "Options:\n" \
1086 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001087#define killall_example_usage \
1088 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001089
Mark Whitley6317c4b2001-03-12 22:51:50 +00001090#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001091 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001092#define klogd_full_usage \
1093 "Kernel logger.\n"\
1094 "Options:\n"\
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001095 "\t-c n\tSets the default log level of console messages to n.\n"\
Mark Whitley6317c4b2001-03-12 22:51:50 +00001096 "\t-n\tRun as a foreground process."
1097
Eric Andersen7e9276b2001-02-22 01:15:47 +00001098#define length_trivial_usage \
1099 "STRING"
1100#define length_full_usage \
1101 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001102#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001103 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001104 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001105
1106#define ln_trivial_usage \
1107 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1108#define ln_full_usage \
1109 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
1110 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1111 "Options:\n" \
1112 "\t-s\tmake symbolic links instead of hard links\n" \
1113 "\t-f\tremove existing destination files\n" \
1114 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001115#define ln_example_usage \
1116 "$ ln -s BusyBox /tmp/ls\n" \
1117 "$ ls -l /tmp/ls\n" \
1118 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001119
1120#define loadacm_trivial_usage \
1121 "< mapfile"
1122#define loadacm_full_usage \
1123 "Loads an acm from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001124#define loadacm_example_usage \
1125 "$ loadacm < /etc/i18n/acmname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001126
1127#define loadfont_trivial_usage \
1128 "< font"
1129#define loadfont_full_usage \
1130 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001131#define loadfont_example_usage \
1132 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001133
1134#define loadkmap_trivial_usage \
1135 "< keymap"
1136#define loadkmap_full_usage \
1137 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001138#define loadkmap_example_usage \
1139 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001140
1141#define logger_trivial_usage \
1142 "[OPTION]... [MESSAGE]"
1143#define logger_full_usage \
1144 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1145 "Options:\n" \
1146 "\t-s\tLog to stderr as well as the system log.\n" \
1147 "\t-t\tLog using the specified tag (defaults to user name).\n" \
1148 "\t-p\tEnter the message with the specified priority.\n" \
1149 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001150#define logger_example_usage \
1151 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001152
Robert Griebl1fca5582002-06-04 20:45:46 +00001153#define login_trivial_usage \
1154 "[OPTION]... [username] [ENV=VAR ...]"
1155#define login_full_usage \
1156 "Begin a new session on the system\n\n" \
1157 "Options:\n" \
1158 "\t-f\tDo not authenticate (user already authenticated)\n" \
1159 "\t-h\tName of the remote host for this login.\n" \
1160 "\t-p\tPreserve environment."
1161
Eric Andersen7e9276b2001-02-22 01:15:47 +00001162#define logname_trivial_usage \
1163 ""
1164#define logname_full_usage \
1165 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001166#define logname_example_usage \
1167 "$ logname\n" \
1168 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001169
Mark Whitley6317c4b2001-03-12 22:51:50 +00001170#define logread_trivial_usage \
1171 ""
1172
1173#define logread_full_usage \
1174 "Shows the messages from syslogd (using circular buffer)."
1175
Matt Kraai83788da2002-03-20 17:38:37 +00001176#define losetup_trivial_usage \
1177 "[OPTION]... LOOPDEVICE FILE\n" \
1178 "or: losetup [OPTION]... -d LOOPDEVICE"
1179#define losetup_full_usage \
1180 "Associate LOOPDEVICE with FILE.\n\n" \
1181 "Options:\n" \
1182 "\t-d\t\tDisassociate LOOPDEVICE.\n" \
1183 "\t-o OFFSET\tStart OFFSET bytes into FILE.\n"
1184
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001185#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001186 #define USAGE_LS_TIMESTAMPS(a) a
1187#else
1188 #define USAGE_LS_TIMESTAMPS(a)
1189#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001190#ifdef CONFIG_FEATURE_LS_FILETYPES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001191 #define USAGE_LS_FILETYPES(a) a
1192#else
1193 #define USAGE_LS_FILETYPES(a)
1194#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001195#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001196 #define USAGE_LS_FOLLOWLINKS(a) a
1197#else
1198 #define USAGE_LS_FOLLOWLINKS(a)
1199#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001200#ifdef CONFIG_FEATURE_LS_RECURSIVE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001201 #define USAGE_LS_RECURSIVE(a) a
1202#else
1203 #define USAGE_LS_RECURSIVE(a)
1204#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001205#ifdef CONFIG_FEATURE_LS_SORTFILES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001206 #define USAGE_LS_SORTFILES(a) a
1207#else
1208 #define USAGE_LS_SORTFILES(a)
1209#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001210#ifdef CONFIG_FEATURE_AUTOWIDTH
Eric Andersen7e9276b2001-02-22 01:15:47 +00001211 #define USAGE_AUTOWIDTH(a) a
1212#else
1213 #define USAGE_AUTOWIDTH(a)
1214#endif
1215#define ls_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +00001216 "[-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 +00001217#define ls_full_usage \
1218 "List directory contents\n\n" \
1219 "Options:\n" \
1220 "\t-1\tlist files in a single column\n" \
1221 "\t-A\tdo not list implied . and ..\n" \
1222 "\t-a\tdo not hide entries starting with .\n" \
1223 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001224 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001225 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001226 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1227 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001228 "\t-i\tlist the i-node for each file\n" \
1229 "\t-l\tuse a long listing format\n" \
1230 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001231 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1232 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1233 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1234 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1235 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001236 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001237 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1238 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1239 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1240 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1241 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001242 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001243 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1244 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001245 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersened0d9582001-02-23 13:23:03 +00001246 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +00001247 "\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001248
1249#define lsmod_trivial_usage \
1250 ""
1251#define lsmod_full_usage \
1252 "List the currently loaded kernel modules."
1253
1254#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001255 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001256#define makedevs_full_usage \
1257 "Creates a range of block or character special files\n\n" \
1258 "TYPEs include:\n" \
1259 "\tb:\tMake a block (buffered) device.\n" \
1260 "\tc or u:\tMake a character (un-buffered) device.\n" \
1261 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1262 "FIRST specifies the number appended to NAME to create the first device.\n" \
1263 "LAST specifies the number of the last item that should be created.\n" \
1264 "If 's' is the last argument, the base device is created as well.\n\n" \
1265 "For example:\n" \
1266 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001267 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001268#define makedevs_example_usage \
1269 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
1270 "[creates ttyS2-ttyS63]\n" \
1271 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
1272 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001273
Eric Andersen7e9276b2001-02-22 01:15:47 +00001274#define md5sum_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001275 "[OPTION] [FILE]...\n" \
1276 "or: md5sum [OPTION] -c [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001277#define md5sum_full_usage \
1278 "Print or check MD5 checksums.\n\n" \
1279 "Options:\n" \
1280 "With no FILE, or when FILE is -, read standard input.\n\n" \
1281 "\t-b\tread files in binary mode\n" \
1282 "\t-c\tcheck MD5 sums against given list\n" \
1283 "\t-t\tread files in text mode (default)\n" \
1284 "\t-g\tread a string\n" \
1285 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001286 "\t-s\tdon't output anything, status code shows success\n" \
1287 "\t-w\twarn about improperly formated MD5 checksum lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001288#define md5sum_example_usage \
1289 "$ md5sum < busybox\n" \
1290 "6fd11e98b98a58f64ff3398d7b324003\n" \
1291 "$ md5sum busybox\n" \
1292 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1293 "$ md5sum -c -\n" \
1294 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1295 "busybox: OK\n" \
1296 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001297
Glenn L McGrath061c9002002-09-16 04:21:46 +00001298#define mesg_trivial_usage \
1299 "mesg [y|n]"
1300#define mesg_full_usage \
1301 "mesg [Y|N], controls write access to your terminal\n" \
1302 "\ty\tAllow write access to your terminal.\n" \
1303 "\tn\tDisallow write access to your terminal.\n"
1304
Eric Andersen7e9276b2001-02-22 01:15:47 +00001305#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001306 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001307#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001308 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001309 "Options:\n" \
1310 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001311 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001312#define mkdir_example_usage \
1313 "$ mkdir /tmp/foo\n" \
1314 "$ mkdir /tmp/foo\n" \
1315 "/tmp/foo: File exists\n" \
1316 "$ mkdir /tmp/foo/bar/baz\n" \
1317 "/tmp/foo/bar/baz: No such file or directory\n" \
1318 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001319
Eric Andersen7e9276b2001-02-22 01:15:47 +00001320#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001321 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001322#define mkfifo_full_usage \
1323 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1324 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001325 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001326
Eric Andersen7e9276b2001-02-22 01:15:47 +00001327#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001328 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001329#define mkfs_minix_full_usage \
1330 "Make a MINIX filesystem.\n\n" \
1331 "Options:\n" \
1332 "\t-c\t\tCheck the device for bad blocks\n" \
1333 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1334 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1335 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001336 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001337
Eric Andersen7e9276b2001-02-22 01:15:47 +00001338#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001339 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001340#define mknod_full_usage \
1341 "Create a special file (block, character, or pipe).\n\n" \
1342 "Options:\n" \
1343 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1344 "TYPEs include:\n" \
1345 "\tb:\tMake a block (buffered) device.\n" \
1346 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001347 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001348#define mknod_example_usage \
1349 "$ mknod /dev/fd0 b 2 0 \n" \
1350 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001351
Eric Andersen7e9276b2001-02-22 01:15:47 +00001352#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001353 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001354#define mkswap_full_usage \
1355 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001356 "Options:\n" \
1357 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001358 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001359 "\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 +00001360 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001361
Eric Andersen7e9276b2001-02-22 01:15:47 +00001362#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001363 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001364#define mktemp_full_usage \
1365 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001366 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001367#define mktemp_example_usage \
1368 "$ mktemp /tmp/temp.XXXXXX\n" \
1369 "/tmp/temp.mWiLjM\n" \
1370 "$ ls -la /tmp/temp.mWiLjM\n" \
1371 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001372
Eric Andersen8d79ce82001-07-22 23:00:15 +00001373#define modprobe_trivial_usage \
1374 "[FILE ...]"
1375#define modprobe_full_usage \
Eric Andersenabc95682002-07-03 02:52:35 +00001376 "Used for high level module loading and unloading."
Eric Andersen8d79ce82001-07-22 23:00:15 +00001377#define modprobe_example_usage \
1378 "$ modprobe cdrom\n"
1379
Eric Andersen7e9276b2001-02-22 01:15:47 +00001380#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001381 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001382#define more_full_usage \
1383 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001384#define more_example_usage \
1385 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001386
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001387#ifdef CONFIG_FEATURE_MOUNT_LOOP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001388 #define USAGE_MOUNT_LOOP(a) a
1389#else
1390 #define USAGE_MOUNT_LOOP(a)
1391#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001392#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001393 #define USAGE_MTAB(a) a
1394#else
1395 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001396#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001397#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001398 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001399#define mount_full_usage \
1400 "Mount a filesystem\n\n" \
1401 "Flags:\n" \
1402 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001403 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001404 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001405 "\t-n:\t\tDon't write a mount table entry.\n" \
1406 ) \
1407 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1408 "\t-r:\t\tMount the filesystem read-only.\n" \
1409 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1410 "\t-w:\t\tMount for reading and writing (default).\n" \
1411 "\n" \
1412 "Options for use with the \"-o\" flag:\n" \
1413 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1414 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1415 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1416 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001417 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001418 "\tloop:\t\tMounts a file via loop device.\n" \
1419 ) \
1420 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001421 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001422 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001423 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001424 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001425 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001426#define mount_example_usage \
1427 "$ mount\n" \
1428 "/dev/hda3 on / type minix (rw)\n" \
1429 "proc on /proc type proc (rw)\n" \
1430 "devpts on /dev/pts type devpts (rw)\n" \
1431 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1432 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001433
Eric Andersen7e9276b2001-02-22 01:15:47 +00001434#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001435 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001436#define mt_full_usage \
1437 "Control magnetic tape drive operation\n" \
1438 "\nAvailable Opcodes:\n\n" \
1439 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1440 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
1441 "ras3 reset retension rew rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001442 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001443
Eric Andersen7e9276b2001-02-22 01:15:47 +00001444#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001445 "SOURCE DEST\n" \
1446 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001447#define mv_full_usage \
1448 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001449#define mv_example_usage \
1450 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001451
Eric Andersen7e9276b2001-02-22 01:15:47 +00001452#define nc_trivial_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001453 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001454#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001455 "Netcat opens a pipe to IP:port\n\n" \
1456 "Options:\n" \
1457 "\t-l\t\tlisten mode, for inbound connects\n" \
1458 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00001459 "\t-i SECS\t\tdelay interval for lines sent\n" \
Eric Andersen00a6a752002-04-26 23:53:10 +00001460 "\t-e PROG\t\tprogram to exec after connect (dangerous!)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001461#define nc_example_usage \
1462 "$ nc foobar.somedomain.com 25\n" \
1463 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1464 "help\n" \
1465 "214-Commands supported:\n" \
1466 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1467 "214 NOOP QUIT RSET HELP\n" \
1468 "quit\n" \
1469 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001470
Eric Andersen1552ff72001-10-31 11:07:12 +00001471#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00001472 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00001473#define netstat_full_usage \
1474 "-l display listening server sockets\n" \
1475 "-a display all sockets (default: connected)\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001476 "-e display other/more information\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001477 "-n don't resolve names\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001478 "-r display routing table\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001479 "-t tcp sockets\n" \
1480 "-u udp sockets\n" \
1481 "-w raw sockets\n" \
1482 "-x unix sockets\n"
1483
Eric Andersen7e9276b2001-02-22 01:15:47 +00001484#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001485 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001486#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001487 "Queries the nameserver for the IP address of the given HOST\n" \
1488 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001489#define nslookup_example_usage \
1490 "$ nslookup localhost\n" \
1491 "Server: default\n" \
1492 "Address: default\n" \
1493 "\n" \
1494 "Name: debian\n" \
1495 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001496
Glenn L McGrath60281112001-11-02 11:39:46 +00001497#define od_trivial_usage \
1498 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
1499#define od_full_usage \
1500 "Write an unambiguous representation, octal bytes by default, of FILE\n"\
1501 "to standard output. With no FILE, or when FILE is -, read standard input."
1502
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00001503#define openvt_trivial_usage \
1504 "<vtnum> <COMMAND> [ARGS...]"
1505#define openvt_full_usage \
1506 "Start a command on a new virtual terminal"
1507#define openvt_example_usage \
1508 "openvt 2 /bin/ash\n"
1509
Eric Andersen27f64e12002-06-23 04:24:25 +00001510#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
1511 #define PASSWORD_ALG_TYPES(a) a
1512#else
1513 #define PASSWORD_ALG_TYPES(a)
1514#endif
1515#define passwd_trivial_usage \
1516 "[OPTION] [name]"
1517#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00001518 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00001519 "changes the password for the current user.\n" \
1520 "Options:\n" \
1521 "\t-a\tDefine which algorithm shall be used for the password.\n" \
1522 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001523 PASSWORD_ALG_TYPES(", sha1") \
Eric Andersen27f64e12002-06-23 04:24:25 +00001524 ")\n\t-d\tDelete the password for the specified user account.\n" \
1525 "\t-l\tLocks (disables) the specified user account.\n" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001526 "\t-u\tUnlocks (re-enables) the specified user account."
Eric Andersen27f64e12002-06-23 04:24:25 +00001527
Eric Andersen221b2ea2001-07-31 19:06:07 +00001528#define pidof_trivial_usage \
1529 "process-name [process-name ...]"
1530#define pidof_full_usage \
1531 "Lists the PIDs of all processes with names that match the names on the command line"
1532#define pidof_example_usage \
1533 "$ pidof init\n" \
1534 "1\n"
1535
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001536#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001537#define ping_trivial_usage "host"
1538#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1539#else
1540#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001541 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001542#define ping_full_usage \
1543 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1544 "Options:\n" \
1545 "\t-c COUNT\tSend only COUNT pings.\n" \
1546 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1547 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001548 "\t\t\tand when finished."
1549#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001550#define ping_example_usage \
1551 "$ ping localhost\n" \
1552 "PING slag (127.0.0.1): 56 data bytes\n" \
1553 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1554 "\n" \
1555 "--- debian ping statistics ---\n" \
1556 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1557 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001558
Eric Andersen51b8bd62002-07-03 11:46:38 +00001559#ifndef CONFIG_FEATURE_FANCY_PING6
1560#define ping6_trivial_usage "host"
1561#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1562#else
1563#define ping6_trivial_usage \
1564 "[OPTION]... host"
1565#define ping6_full_usage \
1566 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1567 "Options:\n" \
1568 "\t-c COUNT\tSend only COUNT pings.\n" \
1569 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1570 "\t-q\t\tQuiet mode, only displays output at start\n" \
1571 "\t\t\tand when finished."
1572#endif
1573#define ping6_example_usage \
1574 "$ ping6 ip6-localhost\n" \
1575 "PING ip6-localhost (::1): 56 data bytes\n" \
1576 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
1577 "\n" \
1578 "--- ip6-localhost ping statistics ---\n" \
1579 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1580 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
1581
Eric Andersen7e9276b2001-02-22 01:15:47 +00001582#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001583 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001584#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001585 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001586 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001587
Eric Andersen7e9276b2001-02-22 01:15:47 +00001588#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001589 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001590#define poweroff_full_usage \
1591 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001592
Eric Andersen7e9276b2001-02-22 01:15:47 +00001593#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001594 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001595#define printf_full_usage \
1596 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001597 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001598#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001599 "$ printf "Val=%d\\n" 5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001600 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001601
Eric Andersen7e9276b2001-02-22 01:15:47 +00001602#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001603 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001604#define ps_full_usage \
1605 "Report process status\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001606 "\nThis version of ps accepts no options."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001607#define ps_example_usage \
1608 "$ ps\n" \
1609 " PID Uid Gid State Command\n" \
1610 " 1 root root S init\n" \
1611 " 2 root root S [kflushd]\n" \
1612 " 3 root root S [kupdate]\n" \
1613 " 4 root root S [kpiod]\n" \
1614 " 5 root root S [kswapd]\n" \
1615 " 742 andersen andersen S [bash]\n" \
1616 " 743 andersen andersen S -bash\n" \
1617 " 745 root root S [getty]\n" \
1618 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001619
Eric Andersen7e9276b2001-02-22 01:15:47 +00001620#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001621 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001622#define pwd_full_usage \
1623 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001624#define pwd_example_usage \
1625 "$ pwd\n" \
1626 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001627
Eric Andersen7e9276b2001-02-22 01:15:47 +00001628#define rdate_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001629 "[OPTION] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001630#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001631 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001632 "Options:\n" \
1633 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001634 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001635
Eric Andersen7e9276b2001-02-22 01:15:47 +00001636#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001637 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001638#define readlink_full_usage \
1639 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001640
Glenn L McGrath62fae302002-12-10 00:14:33 +00001641#define realpath_trivial_usage \
1642 "pathname ..."
1643#define realpath_full_usage \
1644 "return the canonicalized absolute pathnames of given arguments\n\n"
1645
Eric Andersen7e9276b2001-02-22 01:15:47 +00001646#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001647 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001648#define reboot_full_usage \
1649 "Reboot the system."
1650
1651#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001652 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001653#define renice_full_usage \
1654 "Changes priority of running processes. Allowed priorities range\n" \
1655 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001656 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001657
Eric Andersen7e9276b2001-02-22 01:15:47 +00001658#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001659 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001660#define reset_full_usage \
1661 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001662
Eric Andersen7e9276b2001-02-22 01:15:47 +00001663#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001664 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001665#define rm_full_usage \
1666 "Remove (unlink) the FILE(s). You may use '--' to\n" \
1667 "indicate that all following arguments are non-options.\n\n" \
1668 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00001669 "\t-i\t\talways prompt before removing each destination" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001670 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001671 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001672#define rm_example_usage \
1673 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001674
Eric Andersen7e9276b2001-02-22 01:15:47 +00001675#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001676 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001677#define rmdir_full_usage \
1678 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001679#define rmdir_example_usage \
1680 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001681
Eric Andersen7e9276b2001-02-22 01:15:47 +00001682#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001683 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001684#define rmmod_full_usage \
1685 "Unloads the specified kernel modules from the kernel.\n\n" \
1686 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001687 "\t-a\tTry to remove all unused kernel modules."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001688#define rmmod_example_usage \
1689 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001690
Eric Andersen7e9276b2001-02-22 01:15:47 +00001691#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001692 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001693#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00001694 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00001695 "Options:\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001696 "\t-n\tDont resolve names.\n" \
1697 "\t-e\tDisplay other/more information"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001698
Glenn L McGrathf8736d22001-06-26 01:19:34 +00001699#define rpm2cpio_trivial_usage \
1700 "package.rpm"
1701#define rpm2cpio_full_usage \
1702 "Outputs a cpio archive of the rpm file."
1703
Eric Andersen6cf47a72001-10-31 10:24:36 +00001704#define run_parts_trivial_usage \
1705 "[-t] [-a ARG] [-u MASK] DIRECTORY"
1706#define run_parts_full_usage \
1707 "Run a bunch of scripts in a directory.\n\n" \
1708 "Options:\n" \
1709 "\t-t\t\tTest only what file will be executed, without execute them.\n" \
1710 "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \
1711 "\t-u MASK\tSet the umask to MASK before executing every program."
1712
Eric Andersen7e9276b2001-02-22 01:15:47 +00001713#define sed_trivial_usage \
Matt Kraai075228a2001-06-21 14:40:55 +00001714 "[-nef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001715#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001716 "Options:\n" \
1717 "\t-n\t\tsuppress automatic printing of pattern space\n" \
1718 "\t-e script\tadd the script to the commands to be executed\n" \
1719 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001720 "\n" \
1721 "If no -e or -f is given, the first non-option argument is taken as the\n" \
1722 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001723 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001724#define sed_example_usage \
1725 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
1726 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001727
Eric Andersen7e9276b2001-02-22 01:15:47 +00001728#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001729 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001730#define setkeycodes_full_usage \
1731 "Set entries into the kernel's scancode-to-keycode map,\n" \
1732 "allowing unusual keyboards to generate usable keycodes.\n\n" \
1733 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001734 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001735#define setkeycodes_example_usage \
1736 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001737
Matt Kraai2d91deb2001-08-01 17:21:35 +00001738#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001739 "[FILE]...\n" \
1740 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00001741#define lash_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001742 "lash: The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00001743#define lash_notes_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001744"This command does not yet have proper documentation.\n" \
1745"\n" \
1746"Use lash just as you would use any other shell. It properly handles pipes,\n" \
1747"redirects, job control, can be used as the shell for scripts, and has a\n" \
1748"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
1749"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
1750"use ash or bash. If you just need a very simple and extremely small shell,\n" \
1751"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001752
Eric Andersen7e9276b2001-02-22 01:15:47 +00001753#define sleep_trivial_usage \
1754 "N"
1755#define sleep_full_usage \
1756 "Pause for N seconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001757#define sleep_example_usage \
1758 "$ sleep 2\n" \
1759 "[2 second delay results]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001760
Eric Andersen7e9276b2001-02-22 01:15:47 +00001761
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001762#ifdef CONFIG_FEATURE_SORT_UNIQUE
Mark Whitleyfccaa362001-04-17 18:56:18 +00001763 #define USAGE_SORT_UNIQUE(a) a
1764#else
1765 #define USAGE_SORT_UNIQUE(a)
1766#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001767#ifdef CONFIG_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001768 #define USAGE_SORT_REVERSE(a) a
1769#else
1770 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001771#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001772#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001773 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001774#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001775 "Sorts lines of text in the specified files\n\n"\
1776 "Options:\n" \
1777 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
1778 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
1779 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001780#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001781 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001782 "a\n" \
1783 "b\n" \
1784 "c\n" \
1785 "d\n" \
1786 "e\n" \
1787 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001788
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001789#define start_stop_daemon_trivial_usage \
1790 "[OPTIONS]"
1791#define start_stop_daemon_full_usage \
1792 "Program to start and stop services.\n"\
1793 "Options:\n" \
1794 "-S\t\t\tstart\n"\
1795 "-K\t\t\tstop\n"\
Eric Andersenfe5b1a92002-10-22 19:21:48 +00001796 "-b\t\t\tforce process into background (daemonize)\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001797 "-x <executable>\t\tprogram to start/check if it is running\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001798 "-u <username>|<uid>\tstop this user's processes\n"\
1799 "-n <process-name>\tstop processes with this name\n"\
1800 "-s <signal>\t\tsignal to send (default 15)\n"\
1801 "-a <pathname>\t\tprogram to start (default <executable>)\n"
1802
Eric Andersenef5e8f82002-11-07 02:09:37 +00001803#define strings_trivial_usage \
1804 "[-afo] [-n length] [file ... ]"
1805#define strings_full_usage \
1806 "Display printable strings in a binary file." \
1807 "\n\nOptions:" \
1808 "\n\t-f\tPrecede each string with the name of the file where it was found." \
1809 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
1810 "\n\t-o\tEach string is preceded by its decimal offset in the file."
1811
Eric Andersen7e9276b2001-02-22 01:15:47 +00001812#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001813 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001814#define stty_full_usage \
1815 "Without arguments, prints baud rate, line discipline," \
1816 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001817 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00001818 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001819 "\n\t-a\t\tprint all current settings in human-readable form" \
1820 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00001821 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001822
Robert Griebl1fca5582002-06-04 20:45:46 +00001823#define su_trivial_usage \
1824 "[OPTION]... [-] [username]"
1825#define su_full_usage \
1826 "Change user id or become root.\n" \
1827 "Options:\n" \
1828 "\t-p\tPreserve environment"
1829
Eric Andersen27f64e12002-06-23 04:24:25 +00001830#define sulogin_trivial_usage \
1831 "[OPTION]... [tty-device]"
1832#define sulogin_full_usage \
1833 "Single user login\n" \
1834 "Options:\n" \
1835 "\t-f\tDo not authenticate (user already authenticated)\n" \
1836 "\t-h\tName of the remote host for this login.\n" \
1837 "\t-p\tPreserve environment."
1838
Eric Andersen7e9276b2001-02-22 01:15:47 +00001839#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001840 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001841#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001842 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001843 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001844 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001845
Eric Andersen7e9276b2001-02-22 01:15:47 +00001846#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001847 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001848#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001849 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001850 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001851 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001852
Eric Andersen7e9276b2001-02-22 01:15:47 +00001853#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001854 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001855#define sync_full_usage \
1856 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001857
Eric Andersen7e9276b2001-02-22 01:15:47 +00001858
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001859#ifdef CONFIG_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00001860 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001861#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00001862 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001863#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00001864#ifdef CONFIG_FEATURE_IPC_SYSLOG
1865 #define USAGE_IPC_LOG(a) a
1866#else
1867 #define USAGE_IPC_LOG(a)
1868#endif
1869
Eric Andersen7e9276b2001-02-22 01:15:47 +00001870#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001871 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001872#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00001873 "Linux system and kernel logging utility.\n" \
1874 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001875 "Options:\n" \
1876 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
1877 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001878 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001879 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00001880 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00001881 "\t-L\t\tLog locally and via network logging (default is network only)") \
1882 USAGE_IPC_LOG( \
1883 "\n\t-C\t\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001884#define syslogd_example_usage \
1885 "$ syslogd -R masterlog:514\n" \
1886 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001887
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001888
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001889#ifndef CONFIG_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00001890 #define USAGE_UNSIMPLE_TAIL(a)
1891#else
1892 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001893#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001894#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001895 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001896#define tail_full_usage \
1897 "Print last 10 lines of each FILE to standard output.\n" \
1898 "With more than one FILE, precede each with a header giving the\n" \
1899 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
1900 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001901 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001902 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
1903 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001904 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001905 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
1906 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001907 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001908 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001909 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
1910#define tail_example_usage \
1911 "$ tail -n 1 /etc/resolv.conf\n" \
1912 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001913
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001914#ifdef CONFIG_FEATURE_TAR_CREATE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001915 #define USAGE_TAR_CREATE(a) a
1916#else
1917 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001918#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001919#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001920 #define USAGE_TAR_EXCLUDE(a) a
1921#else
1922 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001923#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001924#define tar_trivial_usage \
1925 "-[" USAGE_TAR_CREATE("c") "xtvO] " \
Eric Andersen317827d2001-05-21 17:50:53 +00001926 USAGE_TAR_EXCLUDE("[--exclude FILE] [-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00001927 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001928#define tar_full_usage \
1929 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00001930 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001931 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001932 "\tx\t\textract\n" \
1933 "\tt\t\tlist\n" \
1934 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001935 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001936 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001937 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001938 "\texclude\t\tfile to exclude\n" \
1939 "\tX\t\tfile with names to exclude\n" \
1940 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00001941 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001942 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001943#define tar_example_usage \
1944 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
1945 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001946
Eric Andersen7e9276b2001-02-22 01:15:47 +00001947#define tee_trivial_usage \
1948 "[OPTION]... [FILE]..."
1949#define tee_full_usage \
1950 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001951 "Options:\n" \
1952 "\t-a\tappend to the given FILEs, do not overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001953#define tee_example_usage \
1954 "$ echo "Hello" | tee /tmp/foo\n" \
1955 "$ cat /tmp/foo\n" \
1956 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001957
Eric Andersen7e9276b2001-02-22 01:15:47 +00001958#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001959 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001960#define telnet_full_usage \
1961 "Telnet is used to establish interactive communication with another\n"\
1962 "computer over a network using the TELNET protocol."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001963
Eric Andersen08a72202002-09-30 20:52:10 +00001964#define telnetd_trivial_usage \
1965 "[OPTION]"
1966#define telnetd_full_usage \
1967 "Telnetd listens for incoming TELNET connections on PORT.\n"\
1968 "Options:\n" \
1969 "\t-p PORT\tlisten for connections on PORT (default 23)\n"\
1970 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
1971
Eric Andersen7e9276b2001-02-22 01:15:47 +00001972#define test_trivial_usage \
1973 "EXPRESSION\n or [ EXPRESSION ]"
1974#define test_full_usage \
1975 "Checks file types and compares values returning an exit\n" \
1976 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001977#define test_example_usage \
1978 "$ test 1 -eq 2\n" \
1979 "$ echo $?\n" \
1980 "1\n" \
1981 "$ test 1 -eq 1\n" \
1982 "$ echo $? \n" \
1983 "0\n" \
1984 "$ [ -d /etc ]\n" \
1985 "$ echo $?\n" \
1986 "0\n" \
1987 "$ [ -d /junk ]\n" \
1988 "$ echo $?\n" \
1989 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001990
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001991#ifdef CONFIG_FEATURE_TFTP_GET
Mark Whitley450736c2001-03-02 19:08:50 +00001992 #define USAGE_TFTP_GET(a) a
1993#else
1994 #define USAGE_TFTP_GET(a)
1995#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001996#ifdef CONFIG_FEATURE_TFTP_PUT
Mark Whitley450736c2001-03-02 19:08:50 +00001997 #define USAGE_TFTP_PUT(a) a
1998#else
1999 #define USAGE_TFTP_PUT(a)
2000#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002001#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Glenn L McGrathad117d82001-10-05 04:40:37 +00002002 #define USAGE_TFTP_BS(a) a
2003#else
2004 #define USAGE_TFTP_BS(a)
2005#endif
Mark Whitley450736c2001-03-02 19:08:50 +00002006
2007#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00002008 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00002009#define tftp_full_usage \
2010 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00002011 "Options:\n" \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002012 "\t-l FILE\tLocal FILE.\n" \
2013 "\t-r FILE\tRemote FILE.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002014 USAGE_TFTP_GET( \
Matt Kraai3be34302001-09-21 14:42:30 +00002015 "\t-g\tGet file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002016 ) \
2017 USAGE_TFTP_PUT( \
Matt Kraai3be34302001-09-21 14:42:30 +00002018 "\t-p\tPut file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00002019 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002020 USAGE_TFTP_BS( \
2021 "\t-b SIZE\tTransfer blocks of SIZE octets.\n" \
2022 )
Eric Andersenc3657422001-11-30 07:54:32 +00002023#define time_trivial_usage \
2024 "[OPTION]... COMMAND [ARGS...]"
2025#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00002026 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
2027 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00002028 "Options:\n" \
2029 "\t-v\tDisplays verbose resource usage information."
Mark Whitley450736c2001-03-02 19:08:50 +00002030
Eric Andersen420b2082002-09-17 22:14:58 +00002031#define top_trivial_usage \
2032 "[-d <seconds>]"
2033#define top_full_usage \
2034 "top provides an view of processor activity in real time.\n" \
2035 "This utility reads the status for all processes in /proc each <seconds>\n" \
2036 "and shows the status for however many processes will fit on the screen.\n" \
2037 "This utility will not show processes that are started after program startup,\n" \
2038 "but it will show the EXIT status for and PIDs that exit while it is running."
2039
Eric Andersen7e9276b2001-02-22 01:15:47 +00002040#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002041 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002042#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002043 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002044 "Options:\n" \
2045 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002046#define touch_example_usage \
2047 "$ ls -l /tmp/foo\n" \
2048 "/bin/ls: /tmp/foo: No such file or directory\n" \
2049 "$ touch /tmp/foo\n" \
2050 "$ ls -l /tmp/foo\n" \
2051 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002052
2053#define tr_trivial_usage \
2054 "[-cds] STRING1 [STRING2]"
2055#define tr_full_usage \
2056 "Translate, squeeze, and/or delete characters from\n" \
2057 "standard input, writing to standard output.\n\n" \
2058 "Options:\n" \
2059 "\t-c\ttake complement of STRING1\n" \
2060 "\t-d\tdelete input characters coded STRING1\n" \
2061 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002062#define tr_example_usage \
2063 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
2064 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002065
Eric Andersen5c58d282001-07-10 16:29:00 +00002066#define traceroute_trivial_usage \
2067 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n\
2068 [-s src_addr] [-t tos] [-w wait] host [data size]"
2069#define traceroute_full_usage \
2070 "trace the route ip packets follow going to \"host\"\n" \
2071 "Options:\n" \
2072 "\t-d\tset SO_DEBUG options to socket\n" \
2073 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
2074 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
2075 "\t-v\tVerbose output\n" \
2076 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
2077 "\t-p port#\tSet the base UDP port number used in probes\n" \
2078 "\t\t(default is 33434)\n" \
2079 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
2080 "\t\t(default is 3)\n" \
2081 "\t-s src_addr\tUse the following IP address as the source address\n" \
2082 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
2083 "\t\t(default 0)\n" \
2084 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
2085 "\t\t(default 3 sec.)."
2086
2087
Eric Andersen7e9276b2001-02-22 01:15:47 +00002088#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002089 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002090#define true_full_usage \
2091 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002092#define true_example_usage \
2093 "$ true\n" \
2094 "$ echo $?\n" \
2095 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002096
Eric Andersen7e9276b2001-02-22 01:15:47 +00002097#define tty_trivial_usage \
2098 ""
2099#define tty_full_usage \
2100 "Print the file name of the terminal connected to standard input.\n\n"\
2101 "Options:\n" \
2102 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002103#define tty_example_usage \
2104 "$ tty\n" \
2105 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002106
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002107#define udhcpc_trivial_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00002108 "[-fbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002109#define udhcpc_full_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00002110 "\tUsage: udhcpc [OPTIONS]\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002111 "\t-c,\t--clientid=CLIENTID\tClient identifier\n" \
2112 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00002113 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002114 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00002115 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated.\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002116 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
2117 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated.\n" \
2118 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
2119 "\t-q,\t--quit\tQuit after obtaining lease\n" \
2120 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
2121 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
2122 "\t-v,\t--version\tDisplay version"
2123
Russ Dill61fb4892002-10-14 21:41:28 +00002124#define udhcpd_trivial_usage \
2125 "[configfile]\n" \
2126
2127#define udhcpd_full_usage \
2128 "\tUsage: udhcpd [configfile]\n"
2129
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002130#ifdef CONFIG_FEATURE_MOUNT_FORCE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002131 #define USAGE_MOUNT_FORCE(a) a
2132#else
2133 #define USAGE_MOUNT_FORCE(a)
2134#endif
2135#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002136 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002137#define umount_full_usage \
2138 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00002139 "\nFlags:\n" "\t-a\tUnmount all file systems" \
2140 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
2141 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00002142 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00002143 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 +00002144#define umount_example_usage \
2145 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002146
2147#define uname_trivial_usage \
2148 "[OPTION]..."
2149#define uname_full_usage \
2150 "Print certain system information. With no OPTION, same as -s.\n\n" \
2151 "Options:\n" \
2152 "\t-a\tprint all information\n" \
2153 "\t-m\tthe machine (hardware) type\n" \
2154 "\t-n\tprint the machine's network node hostname\n" \
2155 "\t-r\tprint the operating system release\n" \
2156 "\t-s\tprint the operating system name\n" \
2157 "\t-p\tprint the host processor type\n" \
2158 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002159#define uname_example_usage \
2160 "$ uname -a\n" \
2161 "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002162
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00002163#define uncompress_trivial_usage \
2164 "[-c] [-f] [ name ... ]"
2165#define uncompress_full_usage \
2166 "Uncompress .Z file[s]\n" \
2167 "Options:\n" \
2168 "\t-c\textract to stdout\n" \
2169 "\t-f\tforce overwrite an existing file\n"
2170
Eric Andersen7e9276b2001-02-22 01:15:47 +00002171#define uniq_trivial_usage \
2172 "[OPTION]... [INPUT [OUTPUT]]"
2173#define uniq_full_usage \
2174 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00002175 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002176 "Options:\n" \
2177 "\t-c\tprefix lines by the number of occurrences\n" \
2178 "\t-d\tonly print duplicate lines\n" \
2179 "\t-u\tonly print unique lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002180#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002181 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002182 "a\n" \
2183 "b\n" \
2184 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002185
2186#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002187 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002188#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002189 "Converts FILE from unix format to dos format. When no option\n" \
2190 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002191 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002192 "Options:\n" \
2193 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002194 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002195
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002196#define unzip_trivial_usage \
2197 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
2198#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002199 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002200 "Options:\n" \
2201 "\t-l\tlist archive contents (short form)\n" \
2202 "\t-n\tnever overwrite existing files (default)\n" \
2203 "\t-o\toverwrite files without prompting\n" \
2204 "\t-p\tsend output to stdout\n" \
2205 "\t-q\tbe quiet\n" \
2206 "\t-x\texclude these files\n" \
2207 "\t-d\textract files into this directory"
2208
Eric Andersen7e9276b2001-02-22 01:15:47 +00002209#define update_trivial_usage \
2210 "[options]"
2211#define update_full_usage \
2212 "Periodically flushes filesystem buffers.\n\n" \
2213 "Options:\n" \
2214 "\t-S\tforce use of sync(2) instead of flushing\n" \
2215 "\t-s SECS\tcall sync this often (default 30)\n" \
2216 "\t-f SECS\tflush some buffers this often (default 5)"
2217
2218#define uptime_trivial_usage \
2219 ""
2220#define uptime_full_usage \
2221 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002222#define uptime_example_usage \
2223 "$ uptime\n" \
2224 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002225
2226#define usleep_trivial_usage \
2227 "N"
2228#define usleep_full_usage \
2229 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002230#define usleep_example_usage \
2231 "$ usleep 1000000\n" \
2232 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002233
2234#define uudecode_trivial_usage \
2235 "[FILE]..."
2236#define uudecode_full_usage \
2237 "Uudecode a file that is uuencoded.\n\n" \
2238 "Options:\n" \
Eric Andersen704b2c22001-03-16 08:06:30 +00002239 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002240#define uudecode_example_usage \
2241 "$ uudecode -o busybox busybox.uu\n" \
2242 "$ ls -l busybox\n" \
2243 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002244
2245#define uuencode_trivial_usage \
2246 "[OPTION] [INFILE] REMOTEFILE"
2247#define uuencode_full_usage \
2248 "Uuencode a file.\n\n" \
2249 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00002250 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002251#define uuencode_example_usage \
2252 "$ uuencode busybox busybox\n" \
2253 "begin 755 busybox\n" \
2254 "<encoded file snipped>\n" \
2255 "$ uudecode busybox busybox > busybox.uu\n" \
2256 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002257
Eric Andersen3f980402001-04-04 17:31:15 +00002258#define vi_trivial_usage \
2259 "[OPTION] [FILE]..."
2260#define vi_full_usage \
2261 "edit FILE.\n\n" \
2262 "Options:\n" \
2263 "\t-R\tRead-only- do not write to the file."
2264
Eric Andersen27f64e12002-06-23 04:24:25 +00002265#define vlock_trivial_usage \
2266 "[OPTIONS]"
2267#define vlock_full_usage \
2268 "Lock a virtual terminal. A password is required to unlock\n" \
2269 "Options:\n" \
2270 "\t-a\tLock all VTs"
2271
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002272#define watch_trivial_usage \
2273 "[-n <seconds>] COMMAND..."
2274#define watch_full_usage \
2275 "Executes a program periodically.\n" \
2276 "Options:\n" \
2277 "\t-n\tLoop period in seconds - default is 2."
2278#define watch_example_usage \
2279 "$ watch date\n" \
2280 "Mon Dec 17 10:31:40 GMT 2000\n" \
2281 "Mon Dec 17 10:31:42 GMT 2000\n" \
2282 "Mon Dec 17 10:31:44 GMT 2000"
2283
Eric Andersen7e9276b2001-02-22 01:15:47 +00002284#define watchdog_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002285 "DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002286#define watchdog_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002287 "Periodically write to watchdog device DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002288
2289#define wc_trivial_usage \
2290 "[OPTION]... [FILE]..."
2291#define wc_full_usage \
2292 "Print line, word, and byte counts for each FILE, and a total line if\n" \
2293 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
2294 "Options:\n" \
2295 "\t-c\tprint the byte counts\n" \
2296 "\t-l\tprint the newline counts\n" \
2297 "\t-L\tprint the length of the longest line\n" \
2298 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002299#define wc_example_usage \
2300 "$ wc /etc/passwd\n" \
2301 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002302
2303#define wget_trivial_usage \
Robert Griebld7760112002-05-14 23:36:45 +00002304 "[-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 +00002305#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00002306 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002307 "Options:\n" \
2308 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00002309 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00002310 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00002311 "\t-O\tsave to filename ('-' for stdout)\n" \
2312 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002313
2314#define which_trivial_usage \
2315 "[COMMAND ...]"
2316#define which_full_usage \
2317 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002318#define which_example_usage \
2319 "$ which login\n" \
2320 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00002321
Eric Andersen00a6a752002-04-26 23:53:10 +00002322#define who_trivial_usage \
2323 " "
2324#define who_full_usage \
2325 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002326
2327#define whoami_trivial_usage \
2328 ""
2329#define whoami_full_usage \
2330 "Prints the user name associated with the current effective user id."
2331
2332#define xargs_trivial_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002333 "[COMMAND] [-prt] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002334#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002335 "Executes COMMAND on every item given by standard input.\n\n" \
2336 "Options:\n" \
2337 "\t-p\tPrompt the user about whether to run each command\n" \
2338 "\t-r\tDo not run command for empty readed lines\n" \
2339 "\t-t\tPrint the command line on stderr before executing it."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002340#define xargs_example_usage \
2341 "$ ls | xargs gzip\n" \
2342 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002343
2344#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002345 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002346#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002347 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002348
Eric Andersen7e9276b2001-02-22 01:15:47 +00002349#define zcat_trivial_usage \
2350 "FILE"
2351#define zcat_full_usage \
2352 "Uncompress to stdout."