blob: d0aa3243f5202140159251b29a067d5883b91f40 [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
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000524#ifdef CONFIG_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000525 #define USAGE_FIND_TYPE(a) a
526#else
527 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000528#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000529#ifdef CONFIG_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000530 #define USAGE_FIND_PERM(a) a
531#else
532 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000533#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000534#ifdef CONFIG_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000535 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000536#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000537 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000538#endif
539
Eric Andersen7e9276b2001-02-22 01:15:47 +0000540#define find_trivial_usage \
541 "[PATH...] [EXPRESSION]"
542#define find_full_usage \
543 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000544 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000545 "\nEXPRESSION may consist of:\n" \
546 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000547 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000548 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000549 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000550 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
551) USAGE_FIND_PERM( \
552 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
553) USAGE_FIND_MTIME( \
554 "\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 +0000555#define find_example_usage \
556 "$ find / -name /etc/passwd\n" \
557 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000558
Eric Andersen7e9276b2001-02-22 01:15:47 +0000559#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000560 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000561#define free_full_usage \
562 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000563#define free_example_usage \
564 "$ free\n" \
565 " total used free shared buffers\n" \
566 " Mem: 257628 248724 8904 59644 93124\n" \
567 " Swap: 128516 8404 120112\n" \
568 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000569
Eric Andersen7e9276b2001-02-22 01:15:47 +0000570#define freeramdisk_trivial_usage \
571 "DEVICE"
572#define freeramdisk_full_usage \
573 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000574#define freeramdisk_example_usage \
575 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000576
577#define fsck_minix_trivial_usage \
578 "[-larvsmf] /dev/name"
579#define fsck_minix_full_usage \
580 "Performs a consistency check for MINIX filesystems.\n\n" \
581 "Options:\n" \
582 "\t-l\tLists all filenames\n" \
583 "\t-r\tPerform interactive repairs\n" \
584 "\t-a\tPerform automatic repairs\n" \
585 "\t-v\tverbose\n" \
586 "\t-s\tOutputs super-block information\n" \
587 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
588 "\t-f\tForce file system check."
589
590#define getopt_trivial_usage \
591 "[OPTIONS]..."
592#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000593 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000594 "\t-a, --alternative Allow long options starting with single -\n" \
595 "\t-l, --longoptions=longopts Long options to be recognized\n" \
596 "\t-n, --name=progname The name under which errors are reported\n" \
597 "\t-o, --options=optstring Short options to be recognized\n" \
598 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
599 "\t-Q, --quiet-output No normal output\n" \
600 "\t-s, --shell=shell Set shell quoting conventions\n" \
601 "\t-T, --test Test for getopt(1) version\n" \
602 "\t-u, --unqote Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000603#define getopt_example_usage \
604 "$ cat getopt.test\n" \
605 "#!/bin/sh\n" \
606 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
607 " -n 'example.busybox' -- "$@"`\n" \
608 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
609 "eval set -- "$GETOPT"\n" \
610 "while true ; do\n" \
611 " case $1 in\n" \
612 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000613 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000614 " -c|--c-long)\n" \
615 " case "$2" in\n" \
616 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000617 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000618 " esac ;;\n" \
619 " --) shift ; break ;;\n" \
620 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
621 " esac\n" \
622 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000623
Eric Andersenf349e972001-08-21 16:18:59 +0000624#define getty_trivial_usage \
625 "getty [OPTIONS]... baud_rate,... line [termtype]"
626#define getty_full_usage \
627 "\nOpens a tty, prompts for a login name, then invokes /bin/login\n\n" \
628 "Options:\n" \
629 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
630 "\t-i\t\tDo not display /etc/issue before running login.\n" \
631 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
632 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
633 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
634 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
635 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
636 "\t-I initstring\tSets the init string to send before anything else.\n" \
637 "\t-H login_host\tLog login_host into the utmp file as the hostname."
638
639
Eric Andersen7e9276b2001-02-22 01:15:47 +0000640#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000641 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000642#define grep_full_usage \
643 "Search for PATTERN in each FILE or standard input.\n\n" \
644 "Options:\n" \
645 "\t-H\tprefix output lines with filename where match was found\n" \
646 "\t-h\tsuppress the prefixing filename on output\n" \
647 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000648 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000649 "\t-n\tprint line number with output lines\n" \
650 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
651 "\t-v\tselect non-matching lines\n" \
652 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000653#define grep_example_usage \
654 "$ grep root /etc/passwd\n" \
655 "root:x:0:0:root:/root:/bin/bash\n" \
656 "$ grep ^[rR]oo. /etc/passwd\n" \
657 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000658
Eric Andersen7e9276b2001-02-22 01:15:47 +0000659#define gunzip_trivial_usage \
660 "[OPTION]... FILE"
661#define gunzip_full_usage \
662 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
663 "Options:\n" \
664 "\t-c\tWrite output to standard output\n" \
665 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000666#define gunzip_example_usage \
667 "$ ls -la /tmp/BusyBox*\n" \
668 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
669 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
670 "$ ls -la /tmp/BusyBox*\n" \
671 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000672
673#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000674 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000675#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000676 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000677 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000678 "Options:\n" \
679 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
680 "\t-d\tdecompress"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000681#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000682 "$ ls -la /tmp/busybox*\n" \
683 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
684 "$ gzip /tmp/busybox.tar\n" \
685 "$ ls -la /tmp/busybox*\n" \
686 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000687
688#define halt_trivial_usage \
689 ""
690#define halt_full_usage \
691 "Halt the system."
692
693#define head_trivial_usage \
694 "[OPTION] [FILE]..."
695#define head_full_usage \
696 "Print first 10 lines of each FILE to standard output.\n" \
697 "With more than one FILE, precede each with a header giving the\n" \
698 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000699 "Options:\n" \
700 "\t-n NUM\t\tPrint first NUM lines instead of first 10"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000701#define head_example_usage \
702 "$ head -n 2 /etc/passwd\n" \
703 "root:x:0:0:root:/root:/bin/bash\n" \
704 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000705
Glenn L McGrath60281112001-11-02 11:39:46 +0000706#define hexdump_trivial_usage \
707 "[-[bcdefnosvx]] [OPTION] FILE"
708#define hexdump_full_usage \
709 "The hexdump utility is a filter which displays the specified files,\n" \
710 "or the standard input, if no files are specified, in a user specified\n"\
711 "format\n" \
712 "\t-b\t\tOne-byte octal display\n" \
713 "\t-c\t\tOne-byte character display\n" \
714 "\t-d\t\tTwo-byte decimal display\n" \
715 "\t-e FORMAT STRING\n" \
716 "\t-f FORMAT FILE\n" \
717 "\t-n LENGTH\tInterpret only length bytes of input\n" \
718 "\t-o\t\tTwo-byte octal display\n" \
719 "\t-s OFFSET\tSkip offset byte\n" \
720 "\t-v\t\tdisplay all input data\n" \
721 "\t-x\t\tTwo-byte hexadecimal display\n"
722
Eric Andersen7e9276b2001-02-22 01:15:47 +0000723#define hostid_trivial_usage \
724 ""
725#define hostid_full_usage \
726 "Print out a unique 32-bit identifier for the machine."
727
728#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000729 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000730#define hostname_full_usage \
731 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000732 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000733 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +0000734 "\t-s\tShort\n" \
735 "\t-i\tAddresses for the hostname\n" \
736 "\t-d\tDNS domain name\n" \
737 "\t-f\tFully qualified domain name\n" \
738 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000739#define hostname_example_usage \
740 "$ hostname\n" \
Eric Andersen317827d2001-05-21 17:50:53 +0000741 "sage \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000742
Robert Griebl1cd04452002-07-21 16:50:49 +0000743#define hwclock_trivial_usage \
744 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
745#define hwclock_full_usage \
746 "Query and set the hardware clock (RTC)\n\n" \
747 "Options:\n" \
748 "\t-r\tread hardware clock and print result\n" \
749 "\t-s\tset the system time from the hardware clock\n" \
750 "\t-w\tset the hardware clock to the current system time\n" \
751 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
752 "\t-l\tthe hardware clock is kept in local time"
753
Eric Andersen7e9276b2001-02-22 01:15:47 +0000754#define id_trivial_usage \
755 "[OPTIONS]... [USERNAME]"
756#define id_full_usage \
757 "Print information for USERNAME or the current user\n\n" \
758 "Options:\n" \
759 "\t-g\tprints only the group ID\n" \
760 "\t-u\tprints only the user ID\n" \
761 "\t-n\tprint a name instead of a number (with for -ug)\n" \
762 "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000763#define id_example_usage \
764 "$ id\n" \
765 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000766
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000767#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +0000768 #define USAGE_SIOCSKEEPALIVE(a) a
769#else
770 #define USAGE_SIOCSKEEPALIVE(a)
771#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000772#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000773 #define USAGE_IFCONFIG_MII(a) a
774#else
775 #define USAGE_IFCONFIG_MII(a)
776#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000777#ifdef CONFIG_FEATURE_IFCONFIG_HW
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000778 #define USAGE_IFCONFIG_HW(a) a
779#else
780 #define USAGE_IFCONFIG_HW(a)
781#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000782#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000783 #define USAGE_IFCONFIG_OPT_A(a) a
784#else
785 #define USAGE_IFCONFIG_OPT_A(a)
786#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +0000787#ifdef CONFIG_FEATURE_IPV6
788 #define USAGE_IPV6(a) a
789#else
790 #define USAGE_IPV6(a)
791#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000792
Eric Andersen7e9276b2001-02-22 01:15:47 +0000793#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000794 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000795#define ifconfig_full_usage \
796 "configure a network interface\n\n" \
797 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +0000798 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
799 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000800 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000801 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000802 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000803 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
804 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000805 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +0000806 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
807 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000808 "\t[up|down] ..."
809
Glenn L McGrath021fa7d2002-11-09 09:34:15 +0000810#define ifup_trivial_usage \
811 "<-ahinv> <ifaces...>"
812#define ifup_full_usage \
813 "Usage: ifup <options> <ifaces...>\n\n" \
814 "Options:\n" \
815 "\t-h, --help\t\tthis help\n" \
816 "\t-a, --all\t\tde/configure all interfaces automatically\n" \
817 "\t-i, --interfaces FILE\tuse FILE for interface definitions\n" \
818 "\t-n, --no-act\t\tprint out what would happen, but don't do it\n" \
819 "\t\t\t\t(note that this option doesn't disable mappings)\n" \
820 "\t-v, --verbose\t\tprint out what would happen before doing it\n" \
821 "\t--no-mappings\t\tdon't run any mappings\n" \
822 "\t--force\t\t\tforce de/configuration\n"
823
824#define ifdown_trivial_usage \
825 "<-ahinv> <ifaces...>"
826#define ifdown_full_usage \
827 "Usage: ifdown <options> <ifaces...>\n\n" \
828 "Options:\n" \
829 "\t-h, --help\t\tthis help\n" \
830 "\t-a, --all\t\tde/configure all interfaces automatically\n" \
831 "\t-i, --interfaces FILE\tuse FILE for interface definitions\n" \
832 "\t-n, --no-act\t\tprint out what would happen, but don't do it\n" \
833 "\t\t\t\t(note that this option doesn't disable mappings)\n" \
834 "\t-v, --verbose\t\tprint out what would happen before doing it\n" \
835 "\t--no-mappings\t\tdon't run any mappings\n" \
836 "\t--force\t\t\tforce de/configuration\n"
837
Eric Andersen7e9276b2001-02-22 01:15:47 +0000838#define init_trivial_usage \
839 ""
840#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000841 "Init is the parent of all processes."
842#define init_notes_usage \
843"This version of init is designed to be run only by the kernel.\n" \
844"\n" \
845"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
846"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
847"runlevels, use sysvinit.\n" \
848"\n" \
849"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
850"it has the following default behavior:\n" \
851"\n" \
852" ::sysinit:/etc/init.d/rcS\n" \
853" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000854" ::ctrlaltdel:/sbin/reboot\n" \
855" ::shutdown:/sbin/swapoff -a\n" \
856" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000857" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000858"\n" \
859"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
860"\n" \
861" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000862" tty3::askfirst:/bin/sh\n" \
863" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000864"\n" \
865"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
866"\n" \
867" <id>:<runlevels>:<action>:<process>\n" \
868"\n" \
869" <id>: \n" \
870"\n" \
871" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
872" The id field is used by BusyBox init to specify the controlling tty for\n" \
873" the specified process to run on. The contents of this field are\n" \
874" appended to "/dev/" and used as-is. There is no need for this field to\n" \
875" be unique, although if it isn't you may have strange results. If this\n" \
876" field is left blank, the controlling tty is set to the console. Also\n" \
877" note that if BusyBox detects that a serial console is in use, then only\n" \
878" entries whose controlling tty is either the serial console or /dev/null\n" \
879" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
880" stinkin' utmp.\n" \
881"\n" \
882" <runlevels>: \n" \
883"\n" \
884" The runlevels field is completely ignored.\n" \
885"\n" \
886" <action>: \n" \
887"\n" \
888" Valid actions include: sysinit, respawn, askfirst, wait, \n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000889" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000890"\n" \
891" The available actions can be classified into two groups: actions\n" \
892" that are run only once, and actions that are re-run when the specified\n" \
893" process exits.\n" \
894"\n" \
895" Run only-once actions:\n" \
896"\n" \
897" 'sysinit' is the first item run on boot. init waits until all\n" \
898" sysinit actions are completed before continuing. Following the\n" \
899" completion of all sysinit actions, all 'wait' actions are run.\n" \
900" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000901" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000902" therefore, init does not wait for them to complete. 'restart' is\n" \
903" the action taken to restart the init process. By default this should\n" \
904" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
905" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000906" actions are run when the system detects that someone on the system\n" \
907" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
908" wants to run 'reboot' at this point to cause the system to reboot.\n" \
909" Finally the 'shutdown' action specifies the actions to taken when\n" \
910" init is told to reboot. Unmounting filesystems and disabling swap\n" \
911" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000912"\n" \
913" Run repeatedly actions:\n" \
914"\n" \
915" 'respawn' actions are run after the 'once' actions. When a process\n" \
916" started with a 'respawn' action exits, init automatically restarts\n" \
917" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
918" respawning out of control. The 'askfirst' actions acts just like\n" \
919" respawn, except that before running the specified process it\n" \
920" displays the line "Please press Enter to activate this console."\n" \
921" and then waits for the user to press enter before starting the\n" \
922" specified process. \n" \
923"\n" \
924" Unrecognized actions (like initdefault) will cause init to emit an\n" \
925" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +0000926" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000927"\n" \
928" <process>: \n" \
929"\n" \
930" Specifies the process to be executed and it's command line.\n" \
931"\n" \
932"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +0000933"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000934" # This is run first except when booting in single-user mode.\n" \
935" #\n" \
936" ::sysinit:/etc/init.d/rcS\n" \
937" \n" \
938" # /bin/sh invocations on selected ttys\n" \
939" #\n" \
940" # Start an "askfirst" shell on the console (whatever that may be)\n" \
941" ::askfirst:-/bin/sh\n" \
942" # Start an "askfirst" shell on /dev/tty2-4\n" \
943" tty2::askfirst:-/bin/sh\n" \
944" tty3::askfirst:-/bin/sh\n" \
945" tty4::askfirst:-/bin/sh\n" \
946" \n" \
947" # /sbin/getty invocations for selected ttys\n" \
948" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +0000949" tty4::respawn:/sbin/getty 38400 tty4\n" \
950" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000951" \n" \
952" \n" \
953" # Example of how to put a getty on a serial line (for a terminal)\n" \
954" #\n" \
955" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
956" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
957" #\n" \
958" # Example how to put a getty on a modem line.\n" \
959" #::respawn:/sbin/getty 57600 ttyS2\n" \
960" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +0000961" # Stuff to do when restarting the init process\n" \
962" ::restart:/sbin/init\n" \
963" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000964" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +0000965" ::ctrlaltdel:/sbin/reboot\n" \
966" ::shutdown:/bin/umount -a -r\n" \
967" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000968
969#define insmod_trivial_usage \
970 "[OPTION]... MODULE [symbol=value]..."
971#define insmod_full_usage \
972 "Loads the specified kernel modules into the kernel.\n\n" \
973 "Options:\n" \
974 "\t-f\tForce module to load into the wrong kernel version.\n" \
975 "\t-k\tMake module autoclean-able.\n" \
976 "\t-v\tverbose output\n" \
977 "\t-L\tLock to prevent simultaneous loads of a module\n" \
978 "\t-x\tdo not export externs"
979
Glenn L McGrath9a2d2722002-11-10 01:33:55 +0000980#define ip_trivial_usage \
981 "not written yet"
982#define ip_full_usage \
983 "not written yet"
984
Eric Andersen7e9276b2001-02-22 01:15:47 +0000985#define kill_trivial_usage \
986 "[-signal] process-id [process-id ...]"
987#define kill_full_usage \
988 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +0000989 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000990 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000991#define kill_example_usage \
992 "$ ps | grep apache\n" \
993 "252 root root S [apache]\n" \
994 "263 www-data www-data S [apache]\n" \
995 "264 www-data www-data S [apache]\n" \
996 "265 www-data www-data S [apache]\n" \
997 "266 www-data www-data S [apache]\n" \
998 "267 www-data www-data S [apache]\n" \
999 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001000
1001#define killall_trivial_usage \
1002 "[-signal] process-name [process-name ...]"
1003#define killall_full_usage \
1004 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001005 "Options:\n" \
1006 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001007#define killall_example_usage \
1008 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001009
Mark Whitley6317c4b2001-03-12 22:51:50 +00001010#define klogd_trivial_usage \
1011 "-n"
1012#define klogd_full_usage \
1013 "Kernel logger.\n"\
1014 "Options:\n"\
1015 "\t-n\tRun as a foreground process."
1016
Eric Andersen7e9276b2001-02-22 01:15:47 +00001017#define length_trivial_usage \
1018 "STRING"
1019#define length_full_usage \
1020 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001021#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001022 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001023 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001024
1025#define ln_trivial_usage \
1026 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1027#define ln_full_usage \
1028 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
1029 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1030 "Options:\n" \
1031 "\t-s\tmake symbolic links instead of hard links\n" \
1032 "\t-f\tremove existing destination files\n" \
1033 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001034#define ln_example_usage \
1035 "$ ln -s BusyBox /tmp/ls\n" \
1036 "$ ls -l /tmp/ls\n" \
1037 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001038
1039#define loadacm_trivial_usage \
1040 "< mapfile"
1041#define loadacm_full_usage \
1042 "Loads an acm from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001043#define loadacm_example_usage \
1044 "$ loadacm < /etc/i18n/acmname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001045
1046#define loadfont_trivial_usage \
1047 "< font"
1048#define loadfont_full_usage \
1049 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001050#define loadfont_example_usage \
1051 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001052
1053#define loadkmap_trivial_usage \
1054 "< keymap"
1055#define loadkmap_full_usage \
1056 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001057#define loadkmap_example_usage \
1058 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001059
1060#define logger_trivial_usage \
1061 "[OPTION]... [MESSAGE]"
1062#define logger_full_usage \
1063 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1064 "Options:\n" \
1065 "\t-s\tLog to stderr as well as the system log.\n" \
1066 "\t-t\tLog using the specified tag (defaults to user name).\n" \
1067 "\t-p\tEnter the message with the specified priority.\n" \
1068 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001069#define logger_example_usage \
1070 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001071
Robert Griebl1fca5582002-06-04 20:45:46 +00001072#define login_trivial_usage \
1073 "[OPTION]... [username] [ENV=VAR ...]"
1074#define login_full_usage \
1075 "Begin a new session on the system\n\n" \
1076 "Options:\n" \
1077 "\t-f\tDo not authenticate (user already authenticated)\n" \
1078 "\t-h\tName of the remote host for this login.\n" \
1079 "\t-p\tPreserve environment."
1080
Eric Andersen7e9276b2001-02-22 01:15:47 +00001081#define logname_trivial_usage \
1082 ""
1083#define logname_full_usage \
1084 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001085#define logname_example_usage \
1086 "$ logname\n" \
1087 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001088
Mark Whitley6317c4b2001-03-12 22:51:50 +00001089#define logread_trivial_usage \
1090 ""
1091
1092#define logread_full_usage \
1093 "Shows the messages from syslogd (using circular buffer)."
1094
Matt Kraai83788da2002-03-20 17:38:37 +00001095#define losetup_trivial_usage \
1096 "[OPTION]... LOOPDEVICE FILE\n" \
1097 "or: losetup [OPTION]... -d LOOPDEVICE"
1098#define losetup_full_usage \
1099 "Associate LOOPDEVICE with FILE.\n\n" \
1100 "Options:\n" \
1101 "\t-d\t\tDisassociate LOOPDEVICE.\n" \
1102 "\t-o OFFSET\tStart OFFSET bytes into FILE.\n"
1103
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001104#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001105 #define USAGE_LS_TIMESTAMPS(a) a
1106#else
1107 #define USAGE_LS_TIMESTAMPS(a)
1108#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001109#ifdef CONFIG_FEATURE_LS_FILETYPES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001110 #define USAGE_LS_FILETYPES(a) a
1111#else
1112 #define USAGE_LS_FILETYPES(a)
1113#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001114#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001115 #define USAGE_LS_FOLLOWLINKS(a) a
1116#else
1117 #define USAGE_LS_FOLLOWLINKS(a)
1118#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001119#ifdef CONFIG_FEATURE_LS_RECURSIVE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001120 #define USAGE_LS_RECURSIVE(a) a
1121#else
1122 #define USAGE_LS_RECURSIVE(a)
1123#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001124#ifdef CONFIG_FEATURE_LS_SORTFILES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001125 #define USAGE_LS_SORTFILES(a) a
1126#else
1127 #define USAGE_LS_SORTFILES(a)
1128#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001129#ifdef CONFIG_FEATURE_AUTOWIDTH
Eric Andersen7e9276b2001-02-22 01:15:47 +00001130 #define USAGE_AUTOWIDTH(a) a
1131#else
1132 #define USAGE_AUTOWIDTH(a)
1133#endif
1134#define ls_trivial_usage \
Eric Andersened0d9582001-02-23 13:23:03 +00001135 "[-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 +00001136#define ls_full_usage \
1137 "List directory contents\n\n" \
1138 "Options:\n" \
1139 "\t-1\tlist files in a single column\n" \
1140 "\t-A\tdo not list implied . and ..\n" \
1141 "\t-a\tdo not hide entries starting with .\n" \
1142 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001143 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001144 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001145 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1146 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001147 "\t-i\tlist the i-node for each file\n" \
1148 "\t-l\tuse a long listing format\n" \
1149 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001150 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1151 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1152 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1153 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1154 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001155 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001156 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1157 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1158 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1159 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1160 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001161 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001162 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1163 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001164 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
Eric Andersened0d9582001-02-23 13:23:03 +00001165 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +00001166 "\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001167
1168#define lsmod_trivial_usage \
1169 ""
1170#define lsmod_full_usage \
1171 "List the currently loaded kernel modules."
1172
1173#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001174 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001175#define makedevs_full_usage \
1176 "Creates a range of block or character special files\n\n" \
1177 "TYPEs include:\n" \
1178 "\tb:\tMake a block (buffered) device.\n" \
1179 "\tc or u:\tMake a character (un-buffered) device.\n" \
1180 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1181 "FIRST specifies the number appended to NAME to create the first device.\n" \
1182 "LAST specifies the number of the last item that should be created.\n" \
1183 "If 's' is the last argument, the base device is created as well.\n\n" \
1184 "For example:\n" \
1185 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001186 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001187#define makedevs_example_usage \
1188 "$ makedevs /dev/ttyS c 4 66 2 63\n" \
1189 "[creates ttyS2-ttyS63]\n" \
1190 "$ makedevs /dev/hda b 3 0 0 8 s\n" \
1191 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001192
Eric Andersen7e9276b2001-02-22 01:15:47 +00001193#define md5sum_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001194 "[OPTION] [FILE]...\n" \
1195 "or: md5sum [OPTION] -c [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001196#define md5sum_full_usage \
1197 "Print or check MD5 checksums.\n\n" \
1198 "Options:\n" \
1199 "With no FILE, or when FILE is -, read standard input.\n\n" \
1200 "\t-b\tread files in binary mode\n" \
1201 "\t-c\tcheck MD5 sums against given list\n" \
1202 "\t-t\tread files in text mode (default)\n" \
1203 "\t-g\tread a string\n" \
1204 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001205 "\t-s\tdon't output anything, status code shows success\n" \
1206 "\t-w\twarn about improperly formated MD5 checksum lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001207#define md5sum_example_usage \
1208 "$ md5sum < busybox\n" \
1209 "6fd11e98b98a58f64ff3398d7b324003\n" \
1210 "$ md5sum busybox\n" \
1211 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1212 "$ md5sum -c -\n" \
1213 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1214 "busybox: OK\n" \
1215 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001216
Glenn L McGrath061c9002002-09-16 04:21:46 +00001217#define mesg_trivial_usage \
1218 "mesg [y|n]"
1219#define mesg_full_usage \
1220 "mesg [Y|N], controls write access to your terminal\n" \
1221 "\ty\tAllow write access to your terminal.\n" \
1222 "\tn\tDisallow write access to your terminal.\n"
1223
Eric Andersen7e9276b2001-02-22 01:15:47 +00001224#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001225 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001226#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001227 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001228 "Options:\n" \
1229 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001230 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001231#define mkdir_example_usage \
1232 "$ mkdir /tmp/foo\n" \
1233 "$ mkdir /tmp/foo\n" \
1234 "/tmp/foo: File exists\n" \
1235 "$ mkdir /tmp/foo/bar/baz\n" \
1236 "/tmp/foo/bar/baz: No such file or directory\n" \
1237 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001238
Eric Andersen7e9276b2001-02-22 01:15:47 +00001239#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001240 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001241#define mkfifo_full_usage \
1242 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1243 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001244 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001245
Eric Andersen7e9276b2001-02-22 01:15:47 +00001246#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001247 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001248#define mkfs_minix_full_usage \
1249 "Make a MINIX filesystem.\n\n" \
1250 "Options:\n" \
1251 "\t-c\t\tCheck the device for bad blocks\n" \
1252 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1253 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1254 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001255 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001256
Eric Andersen7e9276b2001-02-22 01:15:47 +00001257#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001258 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001259#define mknod_full_usage \
1260 "Create a special file (block, character, or pipe).\n\n" \
1261 "Options:\n" \
1262 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1263 "TYPEs include:\n" \
1264 "\tb:\tMake a block (buffered) device.\n" \
1265 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001266 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001267#define mknod_example_usage \
1268 "$ mknod /dev/fd0 b 2 0 \n" \
1269 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001270
Eric Andersen7e9276b2001-02-22 01:15:47 +00001271#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001272 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001273#define mkswap_full_usage \
1274 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001275 "Options:\n" \
1276 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001277 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001278 "\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 +00001279 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001280
Eric Andersen7e9276b2001-02-22 01:15:47 +00001281#define mktemp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001282 "[-q] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001283#define mktemp_full_usage \
1284 "Creates a temporary file with its name based on TEMPLATE.\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001285 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001286#define mktemp_example_usage \
1287 "$ mktemp /tmp/temp.XXXXXX\n" \
1288 "/tmp/temp.mWiLjM\n" \
1289 "$ ls -la /tmp/temp.mWiLjM\n" \
1290 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001291
Eric Andersen8d79ce82001-07-22 23:00:15 +00001292#define modprobe_trivial_usage \
1293 "[FILE ...]"
1294#define modprobe_full_usage \
Eric Andersenabc95682002-07-03 02:52:35 +00001295 "Used for high level module loading and unloading."
Eric Andersen8d79ce82001-07-22 23:00:15 +00001296#define modprobe_example_usage \
1297 "$ modprobe cdrom\n"
1298
Eric Andersen7e9276b2001-02-22 01:15:47 +00001299#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001300 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001301#define more_full_usage \
1302 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001303#define more_example_usage \
1304 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001305
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001306#ifdef CONFIG_FEATURE_MOUNT_LOOP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001307 #define USAGE_MOUNT_LOOP(a) a
1308#else
1309 #define USAGE_MOUNT_LOOP(a)
1310#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001311#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001312 #define USAGE_MTAB(a) a
1313#else
1314 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001315#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001316#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001317 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001318#define mount_full_usage \
1319 "Mount a filesystem\n\n" \
1320 "Flags:\n" \
1321 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001322 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001323 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001324 "\t-n:\t\tDon't write a mount table entry.\n" \
1325 ) \
1326 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1327 "\t-r:\t\tMount the filesystem read-only.\n" \
1328 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1329 "\t-w:\t\tMount for reading and writing (default).\n" \
1330 "\n" \
1331 "Options for use with the \"-o\" flag:\n" \
1332 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1333 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1334 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1335 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001336 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001337 "\tloop:\t\tMounts a file via loop device.\n" \
1338 ) \
1339 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001340 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001341 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001342 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001343 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001344 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001345#define mount_example_usage \
1346 "$ mount\n" \
1347 "/dev/hda3 on / type minix (rw)\n" \
1348 "proc on /proc type proc (rw)\n" \
1349 "devpts on /dev/pts type devpts (rw)\n" \
1350 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1351 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001352
Eric Andersen7e9276b2001-02-22 01:15:47 +00001353#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001354 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001355#define mt_full_usage \
1356 "Control magnetic tape drive operation\n" \
1357 "\nAvailable Opcodes:\n\n" \
1358 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1359 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
1360 "ras3 reset retension rew rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001361 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001362
Eric Andersen7e9276b2001-02-22 01:15:47 +00001363#define mv_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001364 "SOURCE DEST\n" \
1365 "or: mv SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001366#define mv_full_usage \
1367 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001368#define mv_example_usage \
1369 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001370
Eric Andersen7e9276b2001-02-22 01:15:47 +00001371#define nc_trivial_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001372 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001373#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001374 "Netcat opens a pipe to IP:port\n\n" \
1375 "Options:\n" \
1376 "\t-l\t\tlisten mode, for inbound connects\n" \
1377 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00001378 "\t-i SECS\t\tdelay interval for lines sent\n" \
Eric Andersen00a6a752002-04-26 23:53:10 +00001379 "\t-e PROG\t\tprogram to exec after connect (dangerous!)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001380#define nc_example_usage \
1381 "$ nc foobar.somedomain.com 25\n" \
1382 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1383 "help\n" \
1384 "214-Commands supported:\n" \
1385 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1386 "214 NOOP QUIT RSET HELP\n" \
1387 "quit\n" \
1388 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001389
Eric Andersen1552ff72001-10-31 11:07:12 +00001390#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00001391 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00001392#define netstat_full_usage \
1393 "-l display listening server sockets\n" \
1394 "-a display all sockets (default: connected)\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001395 "-e display other/more information\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001396 "-n don't resolve names\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001397 "-r display routing table\n" \
Eric Andersen1552ff72001-10-31 11:07:12 +00001398 "-t tcp sockets\n" \
1399 "-u udp sockets\n" \
1400 "-w raw sockets\n" \
1401 "-x unix sockets\n"
1402
Eric Andersen7e9276b2001-02-22 01:15:47 +00001403#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001404 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001405#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001406 "Queries the nameserver for the IP address of the given HOST\n" \
1407 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001408#define nslookup_example_usage \
1409 "$ nslookup localhost\n" \
1410 "Server: default\n" \
1411 "Address: default\n" \
1412 "\n" \
1413 "Name: debian\n" \
1414 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001415
Glenn L McGrath60281112001-11-02 11:39:46 +00001416#define od_trivial_usage \
1417 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
1418#define od_full_usage \
1419 "Write an unambiguous representation, octal bytes by default, of FILE\n"\
1420 "to standard output. With no FILE, or when FILE is -, read standard input."
1421
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00001422#define openvt_trivial_usage \
1423 "<vtnum> <COMMAND> [ARGS...]"
1424#define openvt_full_usage \
1425 "Start a command on a new virtual terminal"
1426#define openvt_example_usage \
1427 "openvt 2 /bin/ash\n"
1428
Eric Andersen27f64e12002-06-23 04:24:25 +00001429#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
1430 #define PASSWORD_ALG_TYPES(a) a
1431#else
1432 #define PASSWORD_ALG_TYPES(a)
1433#endif
1434#define passwd_trivial_usage \
1435 "[OPTION] [name]"
1436#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00001437 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00001438 "changes the password for the current user.\n" \
1439 "Options:\n" \
1440 "\t-a\tDefine which algorithm shall be used for the password.\n" \
1441 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001442 PASSWORD_ALG_TYPES(", sha1") \
Eric Andersen27f64e12002-06-23 04:24:25 +00001443 ")\n\t-d\tDelete the password for the specified user account.\n" \
1444 "\t-l\tLocks (disables) the specified user account.\n" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001445 "\t-u\tUnlocks (re-enables) the specified user account."
Eric Andersen27f64e12002-06-23 04:24:25 +00001446
Eric Andersen221b2ea2001-07-31 19:06:07 +00001447#define pidof_trivial_usage \
1448 "process-name [process-name ...]"
1449#define pidof_full_usage \
1450 "Lists the PIDs of all processes with names that match the names on the command line"
1451#define pidof_example_usage \
1452 "$ pidof init\n" \
1453 "1\n"
1454
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001455#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001456#define ping_trivial_usage "host"
1457#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1458#else
1459#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001460 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001461#define ping_full_usage \
1462 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1463 "Options:\n" \
1464 "\t-c COUNT\tSend only COUNT pings.\n" \
1465 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1466 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001467 "\t\t\tand when finished."
1468#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001469#define ping_example_usage \
1470 "$ ping localhost\n" \
1471 "PING slag (127.0.0.1): 56 data bytes\n" \
1472 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1473 "\n" \
1474 "--- debian ping statistics ---\n" \
1475 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1476 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001477
Eric Andersen51b8bd62002-07-03 11:46:38 +00001478#ifndef CONFIG_FEATURE_FANCY_PING6
1479#define ping6_trivial_usage "host"
1480#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1481#else
1482#define ping6_trivial_usage \
1483 "[OPTION]... host"
1484#define ping6_full_usage \
1485 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1486 "Options:\n" \
1487 "\t-c COUNT\tSend only COUNT pings.\n" \
1488 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1489 "\t-q\t\tQuiet mode, only displays output at start\n" \
1490 "\t\t\tand when finished."
1491#endif
1492#define ping6_example_usage \
1493 "$ ping6 ip6-localhost\n" \
1494 "PING ip6-localhost (::1): 56 data bytes\n" \
1495 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
1496 "\n" \
1497 "--- ip6-localhost ping statistics ---\n" \
1498 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
1499 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
1500
Eric Andersen7e9276b2001-02-22 01:15:47 +00001501#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001502 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001503#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001504 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001505 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001506
Eric Andersen7e9276b2001-02-22 01:15:47 +00001507#define poweroff_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001508 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001509#define poweroff_full_usage \
1510 "Halt the system and request that the kernel shut off the power."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001511
Eric Andersen7e9276b2001-02-22 01:15:47 +00001512#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001513 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001514#define printf_full_usage \
1515 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001516 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001517#define printf_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001518 "$ printf "Val=%d\\n" 5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001519 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001520
Eric Andersen7e9276b2001-02-22 01:15:47 +00001521#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001522 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001523#define ps_full_usage \
1524 "Report process status\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001525 "\nThis version of ps accepts no options."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001526#define ps_example_usage \
1527 "$ ps\n" \
1528 " PID Uid Gid State Command\n" \
1529 " 1 root root S init\n" \
1530 " 2 root root S [kflushd]\n" \
1531 " 3 root root S [kupdate]\n" \
1532 " 4 root root S [kpiod]\n" \
1533 " 5 root root S [kswapd]\n" \
1534 " 742 andersen andersen S [bash]\n" \
1535 " 743 andersen andersen S -bash\n" \
1536 " 745 root root S [getty]\n" \
1537 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001538
Eric Andersen7e9276b2001-02-22 01:15:47 +00001539#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001540 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001541#define pwd_full_usage \
1542 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001543#define pwd_example_usage \
1544 "$ pwd\n" \
1545 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001546
Eric Andersen7e9276b2001-02-22 01:15:47 +00001547#define rdate_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001548 "[OPTION] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001549#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001550 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001551 "Options:\n" \
1552 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001553 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001554
Eric Andersen7e9276b2001-02-22 01:15:47 +00001555#define readlink_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001556 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001557#define readlink_full_usage \
1558 "Read a symbolic link."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001559
Eric Andersen7e9276b2001-02-22 01:15:47 +00001560#define reboot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001561 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001562#define reboot_full_usage \
1563 "Reboot the system."
1564
1565#define renice_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001566 "priority pid [pid ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001567#define renice_full_usage \
1568 "Changes priority of running processes. Allowed priorities range\n" \
1569 "from 20 (the process runs only when nothing else is running) to 0\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001570 "(default priority) to -20 (almost nothing else ever gets to run)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001571
Eric Andersen7e9276b2001-02-22 01:15:47 +00001572#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001573 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001574#define reset_full_usage \
1575 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001576
Eric Andersen7e9276b2001-02-22 01:15:47 +00001577#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001578 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001579#define rm_full_usage \
1580 "Remove (unlink) the FILE(s). You may use '--' to\n" \
1581 "indicate that all following arguments are non-options.\n\n" \
1582 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00001583 "\t-i\t\talways prompt before removing each destination" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001584 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001585 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001586#define rm_example_usage \
1587 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001588
Eric Andersen7e9276b2001-02-22 01:15:47 +00001589#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001590 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001591#define rmdir_full_usage \
1592 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001593#define rmdir_example_usage \
1594 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001595
Eric Andersen7e9276b2001-02-22 01:15:47 +00001596#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001597 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001598#define rmmod_full_usage \
1599 "Unloads the specified kernel modules from the kernel.\n\n" \
1600 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001601 "\t-a\tTry to remove all unused kernel modules."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001602#define rmmod_example_usage \
1603 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001604
Eric Andersen7e9276b2001-02-22 01:15:47 +00001605#define route_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001606 "[{add|del|flush}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001607#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00001608 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00001609 "Options:\n" \
Robert Griebl8187bb42002-05-14 23:10:58 +00001610 "\t-n\tDont resolve names.\n" \
1611 "\t-e\tDisplay other/more information"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001612
Glenn L McGrathf8736d22001-06-26 01:19:34 +00001613#define rpm2cpio_trivial_usage \
1614 "package.rpm"
1615#define rpm2cpio_full_usage \
1616 "Outputs a cpio archive of the rpm file."
1617
Eric Andersen6cf47a72001-10-31 10:24:36 +00001618#define run_parts_trivial_usage \
1619 "[-t] [-a ARG] [-u MASK] DIRECTORY"
1620#define run_parts_full_usage \
1621 "Run a bunch of scripts in a directory.\n\n" \
1622 "Options:\n" \
1623 "\t-t\t\tTest only what file will be executed, without execute them.\n" \
1624 "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \
1625 "\t-u MASK\tSet the umask to MASK before executing every program."
1626
Eric Andersen7e9276b2001-02-22 01:15:47 +00001627#define sed_trivial_usage \
Matt Kraai075228a2001-06-21 14:40:55 +00001628 "[-nef] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001629#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001630 "Options:\n" \
1631 "\t-n\t\tsuppress automatic printing of pattern space\n" \
1632 "\t-e script\tadd the script to the commands to be executed\n" \
1633 "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001634 "\n" \
1635 "If no -e or -f is given, the first non-option argument is taken as the\n" \
1636 "sed script to interpret. All remaining arguments are names of input\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001637 "files; if no input files are specified, then the standard input is read."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001638#define sed_example_usage \
1639 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
1640 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001641
Eric Andersen7e9276b2001-02-22 01:15:47 +00001642#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001643 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001644#define setkeycodes_full_usage \
1645 "Set entries into the kernel's scancode-to-keycode map,\n" \
1646 "allowing unusual keyboards to generate usable keycodes.\n\n" \
1647 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001648 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001649#define setkeycodes_example_usage \
1650 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001651
Matt Kraai2d91deb2001-08-01 17:21:35 +00001652#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001653 "[FILE]...\n" \
1654 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00001655#define lash_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001656 "lash: The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00001657#define lash_notes_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001658"This command does not yet have proper documentation.\n" \
1659"\n" \
1660"Use lash just as you would use any other shell. It properly handles pipes,\n" \
1661"redirects, job control, can be used as the shell for scripts, and has a\n" \
1662"sufficient set of builtins to do what is needed. It does not (yet) support\n" \
1663"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
1664"use ash or bash. If you just need a very simple and extremely small shell,\n" \
1665"this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001666
Eric Andersen7e9276b2001-02-22 01:15:47 +00001667#define sleep_trivial_usage \
1668 "N"
1669#define sleep_full_usage \
1670 "Pause for N seconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001671#define sleep_example_usage \
1672 "$ sleep 2\n" \
1673 "[2 second delay results]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001674
Eric Andersen7e9276b2001-02-22 01:15:47 +00001675
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001676#ifdef CONFIG_FEATURE_SORT_UNIQUE
Mark Whitleyfccaa362001-04-17 18:56:18 +00001677 #define USAGE_SORT_UNIQUE(a) a
1678#else
1679 #define USAGE_SORT_UNIQUE(a)
1680#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001681#ifdef CONFIG_FEATURE_SORT_REVERSE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001682 #define USAGE_SORT_REVERSE(a) a
1683#else
1684 #define USAGE_SORT_REVERSE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001685#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001686#define sort_trivial_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001687 "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001688#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00001689 "Sorts lines of text in the specified files\n\n"\
1690 "Options:\n" \
1691 USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \
1692 USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \
1693 "\t-n\tsort numerics"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001694#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001695 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001696 "a\n" \
1697 "b\n" \
1698 "c\n" \
1699 "d\n" \
1700 "e\n" \
1701 "f\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001702
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001703#define start_stop_daemon_trivial_usage \
1704 "[OPTIONS]"
1705#define start_stop_daemon_full_usage \
1706 "Program to start and stop services.\n"\
1707 "Options:\n" \
1708 "-S\t\t\tstart\n"\
1709 "-K\t\t\tstop\n"\
Eric Andersenfe5b1a92002-10-22 19:21:48 +00001710 "-b\t\t\tforce process into background (daemonize)\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001711 "-x <executable>\t\tprogram to start/check if it is running\n"\
Eric Andersenc2af1ee2001-10-18 19:33:06 +00001712 "-u <username>|<uid>\tstop this user's processes\n"\
1713 "-n <process-name>\tstop processes with this name\n"\
1714 "-s <signal>\t\tsignal to send (default 15)\n"\
1715 "-a <pathname>\t\tprogram to start (default <executable>)\n"
1716
Eric Andersenef5e8f82002-11-07 02:09:37 +00001717#define strings_trivial_usage \
1718 "[-afo] [-n length] [file ... ]"
1719#define strings_full_usage \
1720 "Display printable strings in a binary file." \
1721 "\n\nOptions:" \
1722 "\n\t-f\tPrecede each string with the name of the file where it was found." \
1723 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
1724 "\n\t-o\tEach string is preceded by its decimal offset in the file."
1725
Eric Andersen7e9276b2001-02-22 01:15:47 +00001726#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001727 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001728#define stty_full_usage \
1729 "Without arguments, prints baud rate, line discipline," \
1730 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001731 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00001732 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001733 "\n\t-a\t\tprint all current settings in human-readable form" \
1734 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00001735 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001736
Robert Griebl1fca5582002-06-04 20:45:46 +00001737#define su_trivial_usage \
1738 "[OPTION]... [-] [username]"
1739#define su_full_usage \
1740 "Change user id or become root.\n" \
1741 "Options:\n" \
1742 "\t-p\tPreserve environment"
1743
Eric Andersen27f64e12002-06-23 04:24:25 +00001744#define sulogin_trivial_usage \
1745 "[OPTION]... [tty-device]"
1746#define sulogin_full_usage \
1747 "Single user login\n" \
1748 "Options:\n" \
1749 "\t-f\tDo not authenticate (user already authenticated)\n" \
1750 "\t-h\tName of the remote host for this login.\n" \
1751 "\t-p\tPreserve environment."
1752
Eric Andersen7e9276b2001-02-22 01:15:47 +00001753#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001754 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001755#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001756 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001757 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001758 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001759
Eric Andersen7e9276b2001-02-22 01:15:47 +00001760#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001761 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001762#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001763 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001764 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001765 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001766
Eric Andersen7e9276b2001-02-22 01:15:47 +00001767#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001768 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001769#define sync_full_usage \
1770 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001771
Eric Andersen7e9276b2001-02-22 01:15:47 +00001772
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001773#ifdef CONFIG_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00001774 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001775#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00001776 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001777#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00001778#ifdef CONFIG_FEATURE_IPC_SYSLOG
1779 #define USAGE_IPC_LOG(a) a
1780#else
1781 #define USAGE_IPC_LOG(a)
1782#endif
1783
Eric Andersen7e9276b2001-02-22 01:15:47 +00001784#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001785 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001786#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00001787 "Linux system and kernel logging utility.\n" \
1788 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001789 "Options:\n" \
1790 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \
1791 "\t-n\t\tRun as a foreground process\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001792 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001793 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00001794 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00001795 "\t-L\t\tLog locally and via network logging (default is network only)") \
1796 USAGE_IPC_LOG( \
1797 "\n\t-C\t\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001798#define syslogd_example_usage \
1799 "$ syslogd -R masterlog:514\n" \
1800 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001801
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001802
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001803#ifndef CONFIG_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00001804 #define USAGE_UNSIMPLE_TAIL(a)
1805#else
1806 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001807#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001808#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001809 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001810#define tail_full_usage \
1811 "Print last 10 lines of each FILE to standard output.\n" \
1812 "With more than one FILE, precede each with a header giving the\n" \
1813 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
1814 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001815 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001816 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
1817 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001818 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001819 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
1820 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001821 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001822 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001823 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
1824#define tail_example_usage \
1825 "$ tail -n 1 /etc/resolv.conf\n" \
1826 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001827
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001828#ifdef CONFIG_FEATURE_TAR_CREATE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001829 #define USAGE_TAR_CREATE(a) a
1830#else
1831 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001832#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001833#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001834 #define USAGE_TAR_EXCLUDE(a) a
1835#else
1836 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001837#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001838#define tar_trivial_usage \
1839 "-[" USAGE_TAR_CREATE("c") "xtvO] " \
Eric Andersen317827d2001-05-21 17:50:53 +00001840 USAGE_TAR_EXCLUDE("[--exclude FILE] [-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00001841 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001842#define tar_full_usage \
1843 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00001844 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001845 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001846 "\tx\t\textract\n" \
1847 "\tt\t\tlist\n" \
1848 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001849 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001850 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001851 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001852 "\texclude\t\tfile to exclude\n" \
1853 "\tX\t\tfile with names to exclude\n" \
1854 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00001855 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001856 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001857#define tar_example_usage \
1858 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
1859 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001860
Eric Andersen7e9276b2001-02-22 01:15:47 +00001861#define tee_trivial_usage \
1862 "[OPTION]... [FILE]..."
1863#define tee_full_usage \
1864 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001865 "Options:\n" \
1866 "\t-a\tappend to the given FILEs, do not overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001867#define tee_example_usage \
1868 "$ echo "Hello" | tee /tmp/foo\n" \
1869 "$ cat /tmp/foo\n" \
1870 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001871
Eric Andersen7e9276b2001-02-22 01:15:47 +00001872#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001873 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001874#define telnet_full_usage \
1875 "Telnet is used to establish interactive communication with another\n"\
1876 "computer over a network using the TELNET protocol."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001877
Eric Andersen08a72202002-09-30 20:52:10 +00001878#define telnetd_trivial_usage \
1879 "[OPTION]"
1880#define telnetd_full_usage \
1881 "Telnetd listens for incoming TELNET connections on PORT.\n"\
1882 "Options:\n" \
1883 "\t-p PORT\tlisten for connections on PORT (default 23)\n"\
1884 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)"
1885
Eric Andersen7e9276b2001-02-22 01:15:47 +00001886#define test_trivial_usage \
1887 "EXPRESSION\n or [ EXPRESSION ]"
1888#define test_full_usage \
1889 "Checks file types and compares values returning an exit\n" \
1890 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001891#define test_example_usage \
1892 "$ test 1 -eq 2\n" \
1893 "$ echo $?\n" \
1894 "1\n" \
1895 "$ test 1 -eq 1\n" \
1896 "$ echo $? \n" \
1897 "0\n" \
1898 "$ [ -d /etc ]\n" \
1899 "$ echo $?\n" \
1900 "0\n" \
1901 "$ [ -d /junk ]\n" \
1902 "$ echo $?\n" \
1903 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001904
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001905#ifdef CONFIG_FEATURE_TFTP_GET
Mark Whitley450736c2001-03-02 19:08:50 +00001906 #define USAGE_TFTP_GET(a) a
1907#else
1908 #define USAGE_TFTP_GET(a)
1909#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001910#ifdef CONFIG_FEATURE_TFTP_PUT
Mark Whitley450736c2001-03-02 19:08:50 +00001911 #define USAGE_TFTP_PUT(a) a
1912#else
1913 #define USAGE_TFTP_PUT(a)
1914#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001915#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Glenn L McGrathad117d82001-10-05 04:40:37 +00001916 #define USAGE_TFTP_BS(a) a
1917#else
1918 #define USAGE_TFTP_BS(a)
1919#endif
Mark Whitley450736c2001-03-02 19:08:50 +00001920
1921#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00001922 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00001923#define tftp_full_usage \
1924 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00001925 "Options:\n" \
Glenn L McGrathad117d82001-10-05 04:40:37 +00001926 "\t-l FILE\tLocal FILE.\n" \
1927 "\t-r FILE\tRemote FILE.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00001928 USAGE_TFTP_GET( \
Matt Kraai3be34302001-09-21 14:42:30 +00001929 "\t-g\tGet file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00001930 ) \
1931 USAGE_TFTP_PUT( \
Matt Kraai3be34302001-09-21 14:42:30 +00001932 "\t-p\tPut file.\n" \
Mark Whitley450736c2001-03-02 19:08:50 +00001933 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00001934 USAGE_TFTP_BS( \
1935 "\t-b SIZE\tTransfer blocks of SIZE octets.\n" \
1936 )
Eric Andersenc3657422001-11-30 07:54:32 +00001937#define time_trivial_usage \
1938 "[OPTION]... COMMAND [ARGS...]"
1939#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00001940 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
1941 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00001942 "Options:\n" \
1943 "\t-v\tDisplays verbose resource usage information."
Mark Whitley450736c2001-03-02 19:08:50 +00001944
Eric Andersen420b2082002-09-17 22:14:58 +00001945#define top_trivial_usage \
1946 "[-d <seconds>]"
1947#define top_full_usage \
1948 "top provides an view of processor activity in real time.\n" \
1949 "This utility reads the status for all processes in /proc each <seconds>\n" \
1950 "and shows the status for however many processes will fit on the screen.\n" \
1951 "This utility will not show processes that are started after program startup,\n" \
1952 "but it will show the EXIT status for and PIDs that exit while it is running."
1953
Eric Andersen7e9276b2001-02-22 01:15:47 +00001954#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001955 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001956#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001957 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001958 "Options:\n" \
1959 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001960#define touch_example_usage \
1961 "$ ls -l /tmp/foo\n" \
1962 "/bin/ls: /tmp/foo: No such file or directory\n" \
1963 "$ touch /tmp/foo\n" \
1964 "$ ls -l /tmp/foo\n" \
1965 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001966
1967#define tr_trivial_usage \
1968 "[-cds] STRING1 [STRING2]"
1969#define tr_full_usage \
1970 "Translate, squeeze, and/or delete characters from\n" \
1971 "standard input, writing to standard output.\n\n" \
1972 "Options:\n" \
1973 "\t-c\ttake complement of STRING1\n" \
1974 "\t-d\tdelete input characters coded STRING1\n" \
1975 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001976#define tr_example_usage \
1977 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
1978 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001979
Eric Andersen5c58d282001-07-10 16:29:00 +00001980#define traceroute_trivial_usage \
1981 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n\
1982 [-s src_addr] [-t tos] [-w wait] host [data size]"
1983#define traceroute_full_usage \
1984 "trace the route ip packets follow going to \"host\"\n" \
1985 "Options:\n" \
1986 "\t-d\tset SO_DEBUG options to socket\n" \
1987 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
1988 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
1989 "\t-v\tVerbose output\n" \
1990 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
1991 "\t-p port#\tSet the base UDP port number used in probes\n" \
1992 "\t\t(default is 33434)\n" \
1993 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
1994 "\t\t(default is 3)\n" \
1995 "\t-s src_addr\tUse the following IP address as the source address\n" \
1996 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
1997 "\t\t(default 0)\n" \
1998 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
1999 "\t\t(default 3 sec.)."
2000
2001
Eric Andersen7e9276b2001-02-22 01:15:47 +00002002#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002003 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002004#define true_full_usage \
2005 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002006#define true_example_usage \
2007 "$ true\n" \
2008 "$ echo $?\n" \
2009 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002010
Eric Andersen7e9276b2001-02-22 01:15:47 +00002011#define tty_trivial_usage \
2012 ""
2013#define tty_full_usage \
2014 "Print the file name of the terminal connected to standard input.\n\n"\
2015 "Options:\n" \
2016 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002017#define tty_example_usage \
2018 "$ tty\n" \
2019 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002020
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002021#define udhcpc_trivial_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00002022 "[-fbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002023#define udhcpc_full_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00002024 "\tUsage: udhcpc [OPTIONS]\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002025 "\t-c,\t--clientid=CLIENTID\tClient identifier\n" \
2026 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00002027 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002028 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00002029 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated.\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002030 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
2031 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated.\n" \
2032 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
2033 "\t-q,\t--quit\tQuit after obtaining lease\n" \
2034 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
2035 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
2036 "\t-v,\t--version\tDisplay version"
2037
Russ Dill61fb4892002-10-14 21:41:28 +00002038#define udhcpd_trivial_usage \
2039 "[configfile]\n" \
2040
2041#define udhcpd_full_usage \
2042 "\tUsage: udhcpd [configfile]\n"
2043
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002044#ifdef CONFIG_FEATURE_MOUNT_FORCE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002045 #define USAGE_MOUNT_FORCE(a) a
2046#else
2047 #define USAGE_MOUNT_FORCE(a)
2048#endif
2049#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002050 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002051#define umount_full_usage \
2052 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00002053 "\nFlags:\n" "\t-a\tUnmount all file systems" \
2054 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
2055 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00002056 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00002057 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 +00002058#define umount_example_usage \
2059 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002060
2061#define uname_trivial_usage \
2062 "[OPTION]..."
2063#define uname_full_usage \
2064 "Print certain system information. With no OPTION, same as -s.\n\n" \
2065 "Options:\n" \
2066 "\t-a\tprint all information\n" \
2067 "\t-m\tthe machine (hardware) type\n" \
2068 "\t-n\tprint the machine's network node hostname\n" \
2069 "\t-r\tprint the operating system release\n" \
2070 "\t-s\tprint the operating system name\n" \
2071 "\t-p\tprint the host processor type\n" \
2072 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002073#define uname_example_usage \
2074 "$ uname -a\n" \
2075 "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002076
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00002077#define uncompress_trivial_usage \
2078 "[-c] [-f] [ name ... ]"
2079#define uncompress_full_usage \
2080 "Uncompress .Z file[s]\n" \
2081 "Options:\n" \
2082 "\t-c\textract to stdout\n" \
2083 "\t-f\tforce overwrite an existing file\n"
2084
Eric Andersen7e9276b2001-02-22 01:15:47 +00002085#define uniq_trivial_usage \
2086 "[OPTION]... [INPUT [OUTPUT]]"
2087#define uniq_full_usage \
2088 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00002089 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002090 "Options:\n" \
2091 "\t-c\tprefix lines by the number of occurrences\n" \
2092 "\t-d\tonly print duplicate lines\n" \
2093 "\t-u\tonly print unique lines"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002094#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002095 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002096 "a\n" \
2097 "b\n" \
2098 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002099
2100#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002101 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002102#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002103 "Converts FILE from unix format to dos format. When no option\n" \
2104 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002105 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002106 "Options:\n" \
2107 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002108 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002109
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002110#define unzip_trivial_usage \
2111 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
2112#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002113 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002114 "Options:\n" \
2115 "\t-l\tlist archive contents (short form)\n" \
2116 "\t-n\tnever overwrite existing files (default)\n" \
2117 "\t-o\toverwrite files without prompting\n" \
2118 "\t-p\tsend output to stdout\n" \
2119 "\t-q\tbe quiet\n" \
2120 "\t-x\texclude these files\n" \
2121 "\t-d\textract files into this directory"
2122
Eric Andersen7e9276b2001-02-22 01:15:47 +00002123#define update_trivial_usage \
2124 "[options]"
2125#define update_full_usage \
2126 "Periodically flushes filesystem buffers.\n\n" \
2127 "Options:\n" \
2128 "\t-S\tforce use of sync(2) instead of flushing\n" \
2129 "\t-s SECS\tcall sync this often (default 30)\n" \
2130 "\t-f SECS\tflush some buffers this often (default 5)"
2131
2132#define uptime_trivial_usage \
2133 ""
2134#define uptime_full_usage \
2135 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002136#define uptime_example_usage \
2137 "$ uptime\n" \
2138 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002139
2140#define usleep_trivial_usage \
2141 "N"
2142#define usleep_full_usage \
2143 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002144#define usleep_example_usage \
2145 "$ usleep 1000000\n" \
2146 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002147
2148#define uudecode_trivial_usage \
2149 "[FILE]..."
2150#define uudecode_full_usage \
2151 "Uudecode a file that is uuencoded.\n\n" \
2152 "Options:\n" \
Eric Andersen704b2c22001-03-16 08:06:30 +00002153 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002154#define uudecode_example_usage \
2155 "$ uudecode -o busybox busybox.uu\n" \
2156 "$ ls -l busybox\n" \
2157 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002158
2159#define uuencode_trivial_usage \
2160 "[OPTION] [INFILE] REMOTEFILE"
2161#define uuencode_full_usage \
2162 "Uuencode a file.\n\n" \
2163 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00002164 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002165#define uuencode_example_usage \
2166 "$ uuencode busybox busybox\n" \
2167 "begin 755 busybox\n" \
2168 "<encoded file snipped>\n" \
2169 "$ uudecode busybox busybox > busybox.uu\n" \
2170 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002171
Eric Andersen3f980402001-04-04 17:31:15 +00002172#define vi_trivial_usage \
2173 "[OPTION] [FILE]..."
2174#define vi_full_usage \
2175 "edit FILE.\n\n" \
2176 "Options:\n" \
2177 "\t-R\tRead-only- do not write to the file."
2178
Eric Andersen27f64e12002-06-23 04:24:25 +00002179#define vlock_trivial_usage \
2180 "[OPTIONS]"
2181#define vlock_full_usage \
2182 "Lock a virtual terminal. A password is required to unlock\n" \
2183 "Options:\n" \
2184 "\t-a\tLock all VTs"
2185
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002186#define watch_trivial_usage \
2187 "[-n <seconds>] COMMAND..."
2188#define watch_full_usage \
2189 "Executes a program periodically.\n" \
2190 "Options:\n" \
2191 "\t-n\tLoop period in seconds - default is 2."
2192#define watch_example_usage \
2193 "$ watch date\n" \
2194 "Mon Dec 17 10:31:40 GMT 2000\n" \
2195 "Mon Dec 17 10:31:42 GMT 2000\n" \
2196 "Mon Dec 17 10:31:44 GMT 2000"
2197
Eric Andersen7e9276b2001-02-22 01:15:47 +00002198#define watchdog_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002199 "DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002200#define watchdog_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002201 "Periodically write to watchdog device DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002202
2203#define wc_trivial_usage \
2204 "[OPTION]... [FILE]..."
2205#define wc_full_usage \
2206 "Print line, word, and byte counts for each FILE, and a total line if\n" \
2207 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
2208 "Options:\n" \
2209 "\t-c\tprint the byte counts\n" \
2210 "\t-l\tprint the newline counts\n" \
2211 "\t-L\tprint the length of the longest line\n" \
2212 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002213#define wc_example_usage \
2214 "$ wc /etc/passwd\n" \
2215 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002216
2217#define wget_trivial_usage \
Robert Griebld7760112002-05-14 23:36:45 +00002218 "[-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 +00002219#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00002220 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002221 "Options:\n" \
2222 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00002223 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00002224 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00002225 "\t-O\tsave to filename ('-' for stdout)\n" \
2226 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002227
2228#define which_trivial_usage \
2229 "[COMMAND ...]"
2230#define which_full_usage \
2231 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002232#define which_example_usage \
2233 "$ which login\n" \
2234 "/bin/login\n"
Eric Andersen00a6a752002-04-26 23:53:10 +00002235#define who_trivial_usage \
2236 " "
2237#define who_full_usage \
2238 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002239
2240#define whoami_trivial_usage \
2241 ""
2242#define whoami_full_usage \
2243 "Prints the user name associated with the current effective user id."
2244
2245#define xargs_trivial_usage \
2246 "[COMMAND] [ARGS...]"
2247#define xargs_full_usage \
2248 "Executes COMMAND on every item given by standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002249#define xargs_example_usage \
2250 "$ ls | xargs gzip\n" \
2251 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002252
2253#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002254 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002255#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002256 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002257
Eric Andersen7e9276b2001-02-22 01:15:47 +00002258#define zcat_trivial_usage \
2259 "FILE"
2260#define zcat_full_usage \
2261 "Uncompress to stdout."