blob: cc2aa327451b9aface3cbffb088241acb17979fc [file] [log] [blame]
Eric Andersen178de172004-04-06 16:36:20 +00001#ifndef __BB_USAGE_H__
2#define __BB_USAGE_H__
3
Eric Andersenf349e972001-08-21 16:18:59 +00004#define addgroup_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00005 "[-g GID] group_name [user_name]"
Eric Andersenf349e972001-08-21 16:18:59 +00006#define addgroup_full_usage \
Eric Andersen192c35f2004-09-02 22:22:17 +00007 "Adds a group to the system\n\n" \
Eric Andersenf349e972001-08-21 16:18:59 +00008 "Options:\n" \
Eric Andersen178de172004-04-06 16:36:20 +00009 "\t-g GID\t\tspecify gid"
Eric Andersenf349e972001-08-21 16:18:59 +000010
11#define adduser_trivial_usage \
Eric Andersene0716ba2003-01-14 06:42:56 +000012 "[OPTIONS] user_name"
Eric Andersenf349e972001-08-21 16:18:59 +000013#define adduser_full_usage \
Eric Andersen192c35f2004-09-02 22:22:17 +000014 "Adds a user to the system\n\n" \
Eric Andersenf349e972001-08-21 16:18:59 +000015 "Options:\n" \
Eric Andersen178de172004-04-06 16:36:20 +000016 "\t-h DIR\t\tAssign home directory DIR\n" \
17 "\t-g GECOS\tAssign gecos field GECOS\n" \
18 "\t-s SHELL\tAssign login shell SHELL\n" \
19 "\t-G\t\tAdd the user to existing group GROUP\n" \
20 "\t-S\t\tcreate a system user (ignored)\n" \
21 "\t-D\t\tDo not assign a password (logins still possible via ssh)\n" \
22 "\t-H\t\tDo not create the home directory"
Eric Andersenf349e972001-08-21 16:18:59 +000023
Mark Whitley6f932772001-03-20 19:18:10 +000024#define adjtimex_trivial_usage \
25 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
26#define adjtimex_full_usage \
27 "Reads and optionally sets system timebase parameters.\n" \
28 "See adjtimex(2).\n\n" \
29 "Options:\n" \
30 "\t-q\t\tquiet mode - do not print\n" \
31 "\t-o offset\ttime offset, microseconds\n" \
32 "\t-f frequency\tfrequency adjust, integer kernel units (65536 is 1ppm)\n" \
33 "\t\t\t(positive values make the system clock run fast)\n" \
34 "\t-t tick\t\tmicroseconds per tick, usually 10000\n" \
Eric Andersen178de172004-04-06 16:36:20 +000035 "\t-p timeconstant"
Mark Whitley6f932772001-03-20 19:18:10 +000036
Eric Andersen7e9276b2001-02-22 01:15:47 +000037#define ar_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +000038 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Eric Andersen7e9276b2001-02-22 01:15:47 +000039#define ar_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +000040 "Extract or list FILES from an ar archive.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +000041 "Options:\n" \
42 "\t-o\t\tpreserve original dates\n" \
43 "\t-p\t\textract to stdout\n" \
44 "\t-t\t\tlist\n" \
45 "\t-x\t\textract\n" \
Eric Andersen178de172004-04-06 16:36:20 +000046 "\t-v\t\tverbosely list files processed"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000047
Glenn L McGrath9e598412003-01-09 10:06:01 +000048#define arping_trivial_usage \
49 "[-fqbDUA] [-c count] [-w timeout] [-I device] [-s sender] target\n"
50#define arping_full_usage \
51 "Ping hosts by ARP requests/replies.\n\n" \
52 "Options:\n" \
53 "\t-f\t\tQuit on first ARP reply\n" \
54 "\t-q\t\tBe quiet\n" \
55 "\t-b\t\tKeep broadcasting, don't go unicast\n" \
56 "\t-D\t\tDuplicated address detection mode\n" \
57 "\t-U\t\tUnsolicited ARP mode, update your neighbours\n" \
58 "\t-A\t\tARP answer mode, update your neighbours\n" \
59 "\t-c count\tStop after sending count ARP request packets\n" \
60 "\t-w timeout\tTime to wait for ARP reply, in seconds\n" \
61 "\t-I device\tOutgoing interface name, default is eth0\n" \
62 "\t-s sender\tSet specific sender IP address\n" \
Eric Andersen178de172004-04-06 16:36:20 +000063 "\ttarget\t\tTarget IP address of ARP request"
Glenn L McGrath9e598412003-01-09 10:06:01 +000064
Eric Andersen08f59e32004-03-12 22:07:10 +000065#define ash_trivial_usage \
66 "[FILE]...\n" \
67 "or: ash -c command [args]...\n"
68#define ash_full_usage \
69 "The ash shell (command interpreter)"
70
71#define awk_trivial_usage \
72 "[OPTION]... [program-text] [FILE ...]"
73#define awk_full_usage \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000074 "Options:\n" \
Eric Andersen08f59e32004-03-12 22:07:10 +000075 "\t-v var=val\t\tassign value 'val' to variable 'var'\n" \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000076 "\t-F sep\t\tuse 'sep' as field separator\n" \
Eric Andersen178de172004-04-06 16:36:20 +000077 "\t-f progname\t\tread program source from file 'progname'"
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000078
Eric Andersen7e9276b2001-02-22 01:15:47 +000079#define basename_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000080 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000081#define basename_full_usage \
82 "Strips directory path and suffixes from FILE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000083 "If specified, also removes any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000084#define basename_example_usage \
85 "$ basename /usr/local/bin/foo\n" \
86 "foo\n" \
87 "$ basename /usr/local/bin/\n" \
88 "bin\n" \
89 "$ basename /foo/bar.txt .txt\n" \
90 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000091
Glenn L McGrath24e28332001-10-05 03:48:57 +000092#define bunzip2_trivial_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000093 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +000094#define bunzip2_full_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000095 "Uncompress FILE (or standard input if FILE is '-' or omitted).\n\n" \
96 "Options:\n" \
97 "\t-c\tWrite output to standard output\n" \
98 "\t-f\tForce"
Glenn L McGrath24e28332001-10-05 03:48:57 +000099
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000100#define bzcat_trivial_usage \
101 "FILE"
102#define bzcat_full_usage \
103 "Uncompress to stdout."
104
Eric Andersenc98c0622001-12-06 15:16:43 +0000105#define cal_trivial_usage \
106 "[-jy] [[month] year]"
107#define cal_full_usage \
108 "Display a calendar.\n" \
109 "\nOptions:\n" \
110 "\t-j\tUse julian dates.\n" \
111 "\t-y\tDisplay the entire year."
112
Eric Andersen7e9276b2001-02-22 01:15:47 +0000113#define cat_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000114 "[-u] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000115#define cat_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000116 "Concatenates FILE(s) and prints them to stdout.\n\n" \
117 "Options:\n" \
118 "\t-u\tignored since unbuffered i/o is always used"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000119#define cat_example_usage \
120 "$ cat /proc/uptime\n" \
121 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000122
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000123#define chattr_trivial_usage \
124 "[-R] [-+=AacDdijsStTu] [-v version] files..."
125#define chattr_full_usage \
126 "change file attributes on an ext2 fs\n\n" \
127 "Modifiers:\n" \
128 "\t-\tremove attributes\n" \
129 "\t+\tadd attributes\n" \
130 "\t=\tset attributes\n" \
131 "Attributes:\n" \
132 "\tA\tdon't track atime\n" \
133 "\ta\tappend mode only\n" \
134 "\tc\tenable compress\n" \
135 "\tD\twrite dir contents synchronously\n" \
136 "\td\tdo not backup with dump\n" \
137 "\ti\tcannot be modified (immutable)\n" \
138 "\tj\twrite all data to journal first\n" \
139 "\ts\tzero disk storage when deleted\n" \
140 "\tS\twrite file contents synchronously\n" \
141 "\tt\tdisable tail-merging of partial blocks with other files\n" \
142 "\tu\tallow file to be undeleted\n" \
143 "Options:\n" \
144 "\t-R\trecursively list subdirectories\n" \
145 "\t-v\tset the file's version/generation number\n"
146
Eric Andersen7e9276b2001-02-22 01:15:47 +0000147#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000148 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000149#define chgrp_full_usage \
150 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000151 "\nOptions:\n" \
152 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000153#define chgrp_example_usage \
154 "$ ls -l /tmp/foo\n" \
155 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
156 "$ chgrp root /tmp/foo\n" \
157 "$ ls -l /tmp/foo\n" \
158 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000159
Eric Andersen7e9276b2001-02-22 01:15:47 +0000160#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000161 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000162#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000163 "Each MODE is one or more of the letters ugoa, one of the\n" \
164 "symbols +-= and one or more of the letters rwxst.\n\n" \
165 "Options:\n" \
166 "\t-R\tChanges files and directories recursively."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000167#define chmod_example_usage \
168 "$ ls -l /tmp/foo\n" \
169 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
170 "$ chmod u+x /tmp/foo\n" \
171 "$ ls -l /tmp/foo\n" \
172 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
173 "$ chmod 444 /tmp/foo\n" \
174 "$ ls -l /tmp/foo\n" \
175 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000176
Eric Andersen7e9276b2001-02-22 01:15:47 +0000177#define chown_trivial_usage \
Eric Andersen238da242001-05-11 16:31:46 +0000178 "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000179#define chown_full_usage \
180 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000181 "\nOptions:\n" \
Eric Andersen238da242001-05-11 16:31:46 +0000182 "\t-R\tChanges files and directories recursively.\n" \
183 "\t-h\tDo not dereference symbolic links."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000184#define chown_example_usage \
185 "$ ls -l /tmp/foo\n" \
186 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
187 "$ chown root /tmp/foo\n" \
188 "$ ls -l /tmp/foo\n" \
189 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
190 "$ chown root.root /tmp/foo\n" \
191 "ls -l /tmp/foo\n" \
192 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000193
Eric Andersen7e9276b2001-02-22 01:15:47 +0000194#define chroot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000195 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000196#define chroot_full_usage \
197 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000198#define chroot_example_usage \
199 "$ ls -l /bin/ls\n" \
200 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000201 "# mount /dev/hdc1 /mnt -t minix\n" \
202 "# chroot /mnt\n" \
203 "# ls -l /bin/ls\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000204 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000205
Eric Andersen7e9276b2001-02-22 01:15:47 +0000206#define chvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000207 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000208#define chvt_full_usage \
209 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000210
Eric Andersen7e9276b2001-02-22 01:15:47 +0000211#define clear_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000212 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000213#define clear_full_usage \
214 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000215
Eric Andersen7e9276b2001-02-22 01:15:47 +0000216#define cmp_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000217 "[-l] [-s] FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000218#define cmp_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000219 "Compare files. Compares FILE1 vs stdin if FILE2 is not specified.\n\n" \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000220 "Options:\n" \
221 "\t-l\tWrite the byte numbers (decimal) and values (octal)\n" \
222 "\t\t for all differing bytes.\n" \
223 "\t-s\tquiet mode - do not print"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000224
Eric Andersen7e9276b2001-02-22 01:15:47 +0000225#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000226 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000227#define cp_full_usage \
228 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
229 "\n" \
230 "\t-a\tSame as -dpR\n" \
Mike Frysinger6077d902005-01-07 00:56:47 +0000231 "\t-d,-P\tPreserves links\n" \
Mike Frysinger2ed05ab2005-04-14 02:52:50 +0000232 "\t-H,-L\tDereference all symlinks (implied by default)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000233 "\t-p\tPreserves file attributes if possible\n" \
234 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersenced97052004-02-20 09:55:37 +0000235 "\t-i\tinteractive, prompt before overwrite\n" \
236 "\t-R,-r\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000237
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000238#define cpio_trivial_usage \
239 "-[dimtuv][F cpiofile]"
240#define cpio_full_usage \
241 "Extract or list files from a cpio archive\n" \
242 "Main operation mode:\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000243 "\td\t\tmake leading directories\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000244 "\ti\t\textract\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000245 "\tm\t\tpreserve mtime\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000246 "\tt\t\tlist\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000247 "\tv\t\tverbose\n" \
Eric Andersen6925d502001-12-16 09:23:09 +0000248 "\tu\t\tunconditional overwrite\n" \
249 "\tF\t\tinput from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000250
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000251#define crond_trivial_usage \
252 "-d[#] -c <crondir> -f -b"
253#define crond_full_usage \
254 "\t-d [#] -l [#] -S -L logfile -f -b -c dir\n" \
255 "\t-d num\tdebug level\n" \
256 "\t-l num\tlog level (8 - default)\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +0000257 "\t-S\tlog to syslogd (default)\n" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000258 "\t-L file\tlog to file\n" \
259 "\t-f\trun in fordeground\n" \
260 "\t-b\trun in background (default)\n" \
261 "\t-c dir\tworking dir"
262
263#define crontab_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000264 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000265#define crontab_full_usage \
266 "\tfile <opts> replace crontab from file\n" \
267 "\t- <opts> replace crontab from stdin\n" \
268 "\t-u user specify user\n" \
269 "\t-l [user] list crontab for user\n" \
270 "\t-e [user] edit crontab for user\n" \
271 "\t-d [user] delete crontab for user\n" \
272 "\t-c dir specify crontab directory"
273
274
Eric Andersen7e9276b2001-02-22 01:15:47 +0000275#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000276 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000277#define cut_full_usage \
278 "Prints selected fields from each input FILE to standard output.\n\n" \
279 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000280 "\t-b LIST\t\tOutput only bytes from LIST\n" \
281 "\t-c LIST\t\tOutput only characters from LIST\n" \
282 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
283 "\t-s\t\tOutput only the lines containing delimiter\n" \
284 "\t-f N\t\tPrint only these fields\n" \
285 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000286#define cut_example_usage \
287 "$ echo "Hello world" | cut -f 1 -d ' '\n" \
288 "Hello\n" \
289 "$ echo "Hello world" | cut -f 2 -d ' '\n" \
290 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000291
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000292#ifdef CONFIG_FEATURE_DATE_ISOFMT
293#define USAGE_DATE_ISOFMT(a) a
294#else
295#define USAGE_DATE_ISOFMT(a)
296#endif
297
Eric Andersen7e9276b2001-02-22 01:15:47 +0000298#define date_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +0000299 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000300#define date_full_usage \
301 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000302 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000303 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000304 "\t-d STRING\tDisplays time described by STRING, not `now'\n" \
305 USAGE_DATE_ISOFMT("\t-I[TIMESPEC]\tOutputs an ISO-8601 compliant date/time string.\n" \
306 "\t\t\tTIMESPEC=`date' (or missing) for date only,\n" \
307 "\t\t\t`hours', `minutes', or `seconds' for date and,\n" \
308 "\t\t\ttime to the indicated precision.\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000309 "\t-s\t\tSets time described by STRING\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000310 "\t-r FILE\t\tDisplays the last modification time of FILE\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000311 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000312#define date_example_usage \
313 "$ date\n" \
314 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000315
Eric Andersen7e9276b2001-02-22 01:15:47 +0000316#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000317 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000318#define dc_full_usage \
319 "This is a Tiny RPN calculator that understands the\n" \
Eric Andersena9287742003-10-22 11:24:39 +0000320 "following operations: +, add, -, sub, *, mul, /, div, %, mod, "\
321 "**, exp, and, or, not, eor.\n" \
322 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16.\n" \
323 "\nOptions:\n" \
Glenn L McGrath6d074322002-12-12 10:31:53 +0000324 "p - Prints the value on the top of the stack, without altering the stack.\n" \
325 "f - Prints the entire contents of the stack without altering anything.\n" \
326 "o - Pops the value off the top of the stack and uses it to set the output radix.\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000327 " Only 10 and 16 are supported."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000328#define dc_example_usage \
Eric Andersen9ab46572004-08-18 17:57:16 +0000329 "$ dc 2 2 + p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000330 "4\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000331 "$ dc 8 8 \\* 2 2 + / p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000332 "16\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000333 "$ dc 0 1 and p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000334 "0\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000335 "$ dc 0 1 or p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000336 "1\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000337 "$ echo 72 9 div 8 mul p | dc\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000338 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000339
Eric Andersen7e9276b2001-02-22 01:15:47 +0000340#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000341 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000342 "\t [seek=N] [conv=notrunc|noerror|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000343#define dd_full_usage \
344 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000345 "\tif=FILE\t\tread from FILE instead of stdin\n" \
346 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
347 "\tbs=N\t\tread and write N bytes at a time\n" \
348 "\tcount=N\t\tcopy only N input blocks\n" \
349 "\tskip=N\t\tskip N input blocks\n" \
350 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000351 "\tconv=notrunc\tdon't truncate output file\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000352 "\tconv=noerror\tcontinue after read errors\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000353 "\tconv=sync\tpad blocks with zeros\n" \
354 "\n" \
355 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000356 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000357#define dd_example_usage \
358 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
359 "4+0 records in\n" \
360 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000361
Eric Andersen7e9276b2001-02-22 01:15:47 +0000362#define deallocvt_trivial_usage \
Glenn L McGrath17b4a202004-01-15 11:50:19 +0000363 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000364#define deallocvt_full_usage \
365 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000366
Eric Andersenf349e972001-08-21 16:18:59 +0000367#define delgroup_trivial_usage \
368 "GROUP"
369#define delgroup_full_usage \
370 "Deletes group GROUP from the system"
371
372#define deluser_trivial_usage \
373 "USER"
374#define deluser_full_usage \
375 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000376
Eric Andersenf18bd892003-12-19 11:07:59 +0000377#ifdef CONFIG_DEVFSD_FG_NP
378 #define USAGE_DEVFSD_FG_NP(a) a
379#else
380 #define USAGE_DEVFSD_FG_NP(a)
381#endif
382
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000383#define devfsd_trivial_usage \
Eric Andersenf18bd892003-12-19 11:07:59 +0000384 "mntpnt [-v]"\
385 USAGE_DEVFSD_FG_NP("[-fg][-np]" )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000386#define devfsd_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000387 "Optional daemon for managing devfs permissions and old device name symlinks.\n" \
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000388 "\nOptions:\n" \
389 "\tmntpnt\tThe mount point where devfs is mounted.\n\n" \
390 "\t-v\tPrint the protocol version numbers for devfsd\n" \
Eric Andersenf18bd892003-12-19 11:07:59 +0000391 "\t\tand the kernel-side protocol version and exits." \
392 USAGE_DEVFSD_FG_NP( "\n\n\t-fg\tRun the daemon in the foreground.\n\n" \
393 "\t-np\tExit after parsing the configuration file\n" \
394 "\t\tand processing synthetic REGISTER events.\n" \
395 "\t\tDo not poll for events.")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000396
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000397#ifdef CONFIG_FEATURE_HUMAN_READABLE
Eric Andersened0d9582001-02-23 13:23:03 +0000398 #define USAGE_HUMAN_READABLE(a) a
399 #define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000400#else
Tim Riker7b253f82003-12-28 05:02:40 +0000401 #define USAGE_HUMAN_READABLE(a)
Eric Andersened0d9582001-02-23 13:23:03 +0000402 #define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000403#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000404#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000405 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000406#define df_full_usage \
407 "Print the filesystem space used and space available.\n\n" \
408 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000409 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000410 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
411 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000412 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000413 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000414#define df_example_usage \
415 "$ df\n" \
416 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
417 "/dev/sda3 8690864 8553540 137324 98% /\n" \
418 "/dev/sda1 64216 36364 27852 57% /boot\n" \
419 "$ df /dev/sda3\n" \
420 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
421 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000422
Eric Andersen7e9276b2001-02-22 01:15:47 +0000423#define dirname_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000424 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000425#define dirname_full_usage \
426 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000427#define dirname_example_usage \
428 "$ dirname /tmp/foo\n" \
429 "/tmp\n" \
430 "$ dirname /tmp/foo/\n" \
431 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000432
Eric Andersen7e9276b2001-02-22 01:15:47 +0000433#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000434 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000435#define dmesg_full_usage \
436 "Prints or controls the kernel ring buffer\n\n" \
437 "Options:\n" \
438 "\t-c\t\tClears the ring buffer's contents after printing\n" \
439 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000440 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000441
Eric Andersen7e9276b2001-02-22 01:15:47 +0000442#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000443 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000444#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000445 "Converts FILE from dos format to unix format. When no option\n" \
446 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000447 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000448 "Options:\n" \
449 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000450 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000451
Eric Andersen7e9276b2001-02-22 01:15:47 +0000452#define dpkg_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000453 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000454#define dpkg_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000455 "dpkg is a utility to install, remove and manage Debian packages.\n\n" \
456 "Options:\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000457 "\t-i\t\tInstall the package\n" \
458 "\t-l\t\tList of installed packages\n" \
459 "\t-C\t\tConfigure an unpackaged package\n" \
460 "\t-F depends\tIgnore depency problems\n" \
461 "\t-P\t\tPurge all files of a package\n" \
462 "\t-r\t\tRemove all but the configuration files for a package\n" \
463 "\t-u\t\tUnpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000464
Eric Andersen7e9276b2001-02-22 01:15:47 +0000465#define dpkg_deb_trivial_usage \
Glenn L McGrathcbc453c2004-05-02 03:01:08 +0000466 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000467#define dpkg_deb_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000468 "Perform actions on Debian packages (.debs)\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000469 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000470 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000471 "\t-e\tExtract control files to [argument] directory\n" \
472 "\t-f\tDisplay control field name starting with [argument]\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000473 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000474 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000475#define dpkg_deb_example_usage \
476 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000477
Manuel Novoa III cad53642003-03-19 09:13:01 +0000478#ifdef CONFIG_FEATURE_DU_DEFALT_BLOCKSIZE_1K
479#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a) a
480#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a)
481#else
482#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a)
483#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a) a
484#endif
485
Eric Andersen7e9276b2001-02-22 01:15:47 +0000486#define du_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000487 "[-aHLdclsx" USAGE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000488#define du_full_usage \
489 "Summarizes disk space used for each FILE and/or directory.\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000490 "Disk space is printed in units of " \
491 USAGE_DU_DEFALT_BLOCKSIZE_1k("1024") USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k("512") \
492 " bytes.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000493 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000494 "\t-a\tshow sizes of files in addition to directories\n" \
495 "\t-H\tfollow symbolic links that are FILE command line args\n" \
496 "\t-L\tfollow all symbolic links encountered\n" \
497 "\t-d N\tlimit output to directories (and files with -a) of depth < N\n" \
498 "\t-c\toutput a grand total\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000499 "\t-l\tcount sizes many times if hard linked\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000500 "\t-s\tdisplay only a total for each argument\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000501 "\t-x\tskip directories on different filesystems\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000502 USAGE_HUMAN_READABLE( \
503 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
504 "\t-m\tprint sizes in megabytes\n" ) \
505 "\t-k\tprint sizes in kilobytes" USAGE_DU_DEFALT_BLOCKSIZE_1k("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000506#define du_example_usage \
507 "$ du\n" \
508 "16 ./CVS\n" \
509 "12 ./kernel-patches/CVS\n" \
510 "80 ./kernel-patches\n" \
511 "12 ./tests/CVS\n" \
512 "36 ./tests\n" \
513 "12 ./scripts/CVS\n" \
514 "16 ./scripts\n" \
515 "12 ./docs/CVS\n" \
516 "104 ./docs\n" \
517 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000518
Eric Andersen7e9276b2001-02-22 01:15:47 +0000519#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000520 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000521#define dumpkmap_full_usage \
522 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000523#define dumpkmap_example_usage \
524 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000525
Russ Dill61fb4892002-10-14 21:41:28 +0000526#define dumpleases_trivial_usage \
527 "[-r|-a] [-f LEASEFILE]"
528#define dumpleases_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000529 "Displays the DHCP leases granted by udhcpd.\n\n" \
530 "Options:\n" \
Russ Dill61fb4892002-10-14 21:41:28 +0000531 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +0000532 "\t-r,\t--remaining\tInterpret lease times as time remaing\n" \
533 "\t-a,\t--absolute\tInterpret lease times as expire time"
Russ Dill61fb4892002-10-14 21:41:28 +0000534
Manuel Novoa III cad53642003-03-19 09:13:01 +0000535#ifdef CONFIG_FEATURE_FANCY_ECHO
536 #define USAGE_FANCY_ECHO(a) a
537#else
Tim Riker7b253f82003-12-28 05:02:40 +0000538 #define USAGE_FANCY_ECHO(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +0000539#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000540
Eric Andersen7e9276b2001-02-22 01:15:47 +0000541#define echo_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000542 USAGE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000543#define echo_full_usage \
544 "Prints the specified ARGs to stdout\n\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000545 USAGE_FANCY_ECHO("Options:\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000546 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000547 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000548 "\t-E\tdisable interpretation of backslash-escaped characters")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000549#define echo_example_usage \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000550 "$ echo \"Erik is cool\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000551 "Erik is cool\n" \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000552 USAGE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000553 "Erik\n" \
554 "is\n" \
555 "cool\n" \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000556 "$ echo \"Erik\\nis\\ncool\"\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000557 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000558
Eric Andersen84e229c2001-03-29 22:48:33 +0000559#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000560 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000561#define env_full_usage \
562 "Prints the current environment or runs a program after setting\n" \
563 "up the specified environment.\n\n" \
564 "Options:\n" \
565 "\t-, -i\tstart with an empty environment\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000566 "\t-u\tremove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000567
Eric Andersen7e9276b2001-02-22 01:15:47 +0000568#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000569 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000570#define expr_full_usage \
571 "Prints the value of EXPRESSION to standard output.\n\n" \
572 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000573 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
574 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
575 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
576 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
577 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
578 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
579 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
580 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
581 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
582 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
583 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
584 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
585 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000586 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
587 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
588 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
589 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
590 "\t or 0\n" \
591 "\tlength STRING length of STRING\n" \
592 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
593 "\t it is a keyword like `match' or an\n" \
594 "\t operator like `/'\n" \
595 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000596 "Beware that many operators need to be escaped or quoted for shells.\n" \
597 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
598 "lexicographical. Pattern matches return the string matched between \n" \
599 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
600 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000601
Mike Frysingerfa69f112005-04-17 07:24:19 +0000602#define fakeidentd_trivial_usage \
603 "[-b ip] [STRING]"
604#define fakeidentd_full_usage \
605 "Returns a set string to auth requests\n\n"\
606 "\t-b\tBind to ip address\n"\
607 "\tSTRING\tThe ident answer string (default is nobody)"
608
Eric Andersen7e9276b2001-02-22 01:15:47 +0000609#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000610 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000611#define false_full_usage \
612 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000613#define false_example_usage \
614 "$ false\n" \
615 "$ echo $?\n" \
616 "1\n"
617
618#define fbset_trivial_usage \
619 "[options] [mode]"
620#define fbset_full_usage \
621 "Show and modify frame buffer settings"
622#define fbset_example_usage \
623 "$ fbset\n" \
624 "mode "1024x768-76"\n" \
625 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
626 "\tgeometry 1024 768 1024 768 16\n" \
627 "\ttimings 12714 128 32 16 4 128 4\n" \
628 "\taccel false\n" \
629 "\trgba 5/11,6/5,5/0,0/0\n" \
630 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000631
Eric Andersen7e9276b2001-02-22 01:15:47 +0000632#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000633 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000634#define fdflush_full_usage \
635 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000636
Eric Andersen01c3d402003-07-05 07:51:31 +0000637#define fdformat_trivial_usage \
638 "[-n] DEVICE"
639#define fdformat_full_usage \
640 "Low-level formats a floppy disk\n\n" \
641 "Options:\n" \
642 "\t-n\tDon't verify after format"
643
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000644#define fdisk_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000645 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000646#define fdisk_full_usage \
647 "Change partition table\n" \
648 "Options:\n" \
Eric Andersena151d192004-04-06 17:16:36 +0000649 "\t-l List partition table(s)\n" \
650 "\t-u Give Start and End in sector (instead of cylinder) units\n" \
651 "\t-s PARTITION Give partition size(s) in blocks\n" \
652 "\t-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000653 "\t-C CYLINDERS Set the number of cylinders\n" \
654 "\t-H HEADS Set the number of heads\n" \
655 "\t-S SECTORS Set the number of sectors\n" \
Eric Andersena151d192004-04-06 17:16:36 +0000656 "\t-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000657
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000658#ifdef CONFIG_FEATURE_FIND_TYPE
Eric Andersen7e9276b2001-02-22 01:15:47 +0000659 #define USAGE_FIND_TYPE(a) a
660#else
661 #define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000662#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000663#ifdef CONFIG_FEATURE_FIND_PERM
Eric Andersen7e9276b2001-02-22 01:15:47 +0000664 #define USAGE_FIND_PERM(a) a
665#else
666 #define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000667#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000668#ifdef CONFIG_FEATURE_FIND_MTIME
Eric Andersen7e9276b2001-02-22 01:15:47 +0000669 #define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000670#else
Eric Andersen7e9276b2001-02-22 01:15:47 +0000671 #define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000672#endif
Eric Andersen97d86f22003-01-23 05:27:42 +0000673#ifdef CONFIG_FEATURE_FIND_NEWER
674 #define USAGE_FIND_NEWER(a) a
675#else
676 #define USAGE_FIND_NEWER(a)
677#endif
678#ifdef CONFIG_FEATURE_FIND_INUM
679 #define USAGE_FIND_INUM(a) a
680#else
681 #define USAGE_FIND_INUM(a)
682#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000683
Eric Andersen7e9276b2001-02-22 01:15:47 +0000684#define find_trivial_usage \
685 "[PATH...] [EXPRESSION]"
686#define find_full_usage \
687 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000688 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000689 "\nEXPRESSION may consist of:\n" \
690 "\t-follow\t\tDereference symbolic links.\n" \
John Beppu5d817682001-04-17 17:09:34 +0000691 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \
Mark Whitleye0a7f912001-03-28 22:04:42 +0000692 "\t-print\t\tPrint (default and assumed).\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000693 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000694 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
695) USAGE_FIND_PERM( \
696 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
697) USAGE_FIND_MTIME( \
Eric Andersen97d86f22003-01-23 05:27:42 +0000698 "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \
699) USAGE_FIND_NEWER( \
700 "\n\t-newer FILE\tModified time is more recent than FILE's" \
701) USAGE_FIND_INUM( \
702 "\n\t-inum N\t\tFile has inode number N")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000703#define find_example_usage \
Eric Andersen75eb90f2004-03-29 08:20:08 +0000704 "$ find / -name passwd\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000705 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000706
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000707#define fold_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +0000708 "[-bsw] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000709#define fold_full_usage \
710 "Wrap input lines in each FILE (standard input by default), writing to\n" \
711 "standard output.\n\n" \
712 "Options:\n" \
713 "\t-b\tcount bytes rather than columns\n" \
714 "\t-s\tbreak at spaces\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000715 "\t-w\tuse WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000716
Eric Andersen7e9276b2001-02-22 01:15:47 +0000717#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000718 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000719#define free_full_usage \
720 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000721#define free_example_usage \
722 "$ free\n" \
723 " total used free shared buffers\n" \
724 " Mem: 257628 248724 8904 59644 93124\n" \
725 " Swap: 128516 8404 120112\n" \
726 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000727
Eric Andersen7e9276b2001-02-22 01:15:47 +0000728#define freeramdisk_trivial_usage \
729 "DEVICE"
730#define freeramdisk_full_usage \
731 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000732#define freeramdisk_example_usage \
733 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000734
735#define fsck_minix_trivial_usage \
736 "[-larvsmf] /dev/name"
737#define fsck_minix_full_usage \
738 "Performs a consistency check for MINIX filesystems.\n\n" \
739 "Options:\n" \
740 "\t-l\tLists all filenames\n" \
741 "\t-r\tPerform interactive repairs\n" \
742 "\t-a\tPerform automatic repairs\n" \
743 "\t-v\tverbose\n" \
744 "\t-s\tOutputs super-block information\n" \
745 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
746 "\t-f\tForce file system check."
747
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000748#define ftpget_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000749 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000750#define ftpget_full_usage \
751 "Retrieve a remote file via FTP.\n\n" \
752 "Options:\n" \
753 "\t-c, --continue Continue a previous transfer\n" \
754 "\t-v, --verbose Verbose\n" \
755 "\t-u, --username Username to be used\n" \
756 "\t-p, --password Password to be used\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000757 "\t-P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000758
759#define ftpput_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000760 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000761#define ftpput_full_usage \
762 "Store a local file on a remote machine via FTP.\n\n" \
763 "Options:\n" \
764 "\t-v, --verbose Verbose\n" \
765 "\t-u, --username Username to be used\n" \
766 "\t-p, --password Password to be used\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000767 "\t-P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000768
Eric Andersen7e9276b2001-02-22 01:15:47 +0000769#define getopt_trivial_usage \
770 "[OPTIONS]..."
771#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000772 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000773 "\t-a, --alternative Allow long options starting with single -\n" \
774 "\t-l, --longoptions=longopts Long options to be recognized\n" \
775 "\t-n, --name=progname The name under which errors are reported\n" \
776 "\t-o, --options=optstring Short options to be recognized\n" \
777 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
778 "\t-Q, --quiet-output No normal output\n" \
779 "\t-s, --shell=shell Set shell quoting conventions\n" \
780 "\t-T, --test Test for getopt(1) version\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000781 "\t-u, --unquoted Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000782#define getopt_example_usage \
783 "$ cat getopt.test\n" \
784 "#!/bin/sh\n" \
785 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000786 " -n 'example.busybox' -- \"$@\"`\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000787 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
788 "eval set -- "$GETOPT"\n" \
789 "while true ; do\n" \
790 " case $1 in\n" \
791 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000792 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000793 " -c|--c-long)\n" \
794 " case "$2" in\n" \
795 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
Aaron Lehmann933d10d2002-08-23 22:09:50 +0000796 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000797 " esac ;;\n" \
798 " --) shift ; break ;;\n" \
799 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
800 " esac\n" \
801 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000802
Eric Andersenf349e972001-08-21 16:18:59 +0000803#define getty_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000804 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +0000805#define getty_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +0000806 "Opens a tty, prompts for a login name, then invokes /bin/login\n\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000807 "Options:\n" \
808 "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \
809 "\t-i\t\tDo not display /etc/issue before running login.\n" \
810 "\t-L\t\tLocal line, so do not do carrier detect.\n" \
811 "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \
812 "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \
Glenn L McGrath49e74ef2003-05-13 14:59:07 +0000813 "\t-n\t\tDo not prompt the user for a login name.\n" \
814 "\t-f issue_file\tDisplay issue_file instead of /etc/issue.\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000815 "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \
816 "\t-t timeout\tTerminate after timeout if no username is read.\n" \
817 "\t-I initstring\tSets the init string to send before anything else.\n" \
818 "\t-H login_host\tLog login_host into the utmp file as the hostname."
819
820
Eric Andersen7e9276b2001-02-22 01:15:47 +0000821#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000822 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000823#define grep_full_usage \
824 "Search for PATTERN in each FILE or standard input.\n\n" \
825 "Options:\n" \
826 "\t-H\tprefix output lines with filename where match was found\n" \
827 "\t-h\tsuppress the prefixing filename on output\n" \
828 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000829 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000830 "\t-n\tprint line number with output lines\n" \
831 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
832 "\t-v\tselect non-matching lines\n" \
833 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000834#define grep_example_usage \
835 "$ grep root /etc/passwd\n" \
836 "root:x:0:0:root:/root:/bin/bash\n" \
837 "$ grep ^[rR]oo. /etc/passwd\n" \
838 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000839
Eric Andersen7e9276b2001-02-22 01:15:47 +0000840#define gunzip_trivial_usage \
841 "[OPTION]... FILE"
842#define gunzip_full_usage \
843 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
844 "Options:\n" \
845 "\t-c\tWrite output to standard output\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000846 "\t-f\tForce read when source is a terminal\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000847 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000848#define gunzip_example_usage \
849 "$ ls -la /tmp/BusyBox*\n" \
850 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
851 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
852 "$ ls -la /tmp/BusyBox*\n" \
853 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000854
855#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000856 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000857#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000858 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000859 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000860 "Options:\n" \
861 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000862 "\t-d\tDecompress\n" \
863 "\t-f\tForce write when destination is a terminal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000864#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000865 "$ ls -la /tmp/busybox*\n" \
866 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
867 "$ gzip /tmp/busybox.tar\n" \
868 "$ ls -la /tmp/busybox*\n" \
869 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000870
871#define halt_trivial_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +0000872 "[-d<delay>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000873#define halt_full_usage \
Glenn L McGrathd2501672004-07-23 05:16:17 +0000874 "Halt the system.\n" \
875 "Options:\n" \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +0000876 "\t-d\t\tdelay interval for halting."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000877
Eric Andersen3443bd72003-07-22 07:30:36 +0000878#ifdef CONFIG_FEATURE_HDPARM_GET_IDENTITY
879#define USAGE_HDPARM_IDENT(a) a
880#else
881#define USAGE_HDPARM_IDENT(a)
882#endif
883
884#ifdef CONFIG_FEATURE_HDPARM_HDIO_SCAN_HWIF
885#define USAGE_SCAN_HWIF(a) a
886#else
887#define USAGE_SCAN_HWIF(a)
888#endif
889
890#ifdef CONFIG_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF
891#define USAGE_UNREGISTER_HWIF(a) a
892#else
893#define USAGE_UNREGISTER_HWIF(a)
894#endif
895
896#ifdef CONFIG_FEATURE_HDPARM_HDIO_DRIVE_RESET
897#define USAGE_DRIVE_RESET(a) a
898#else
899#define USAGE_DRIVE_RESET(a)
900#endif
901
902#ifdef CONFIG_FEATURE_HDPARM_HDIO_TRISTATE_HWIF
903#define USAGE_TRISTATE_HWIF(a) a
904#else
905#define USAGE_TRISTATE_HWIF(a)
906#endif
907
Eric Andersen0a57a792003-08-06 08:57:35 +0000908#ifdef CONFIG_FEATURE_HDPARM_HDIO_GETSET_DMA
909#define USAGE_GETSET_DMA(a) a
910#else
911#define USAGE_GETSET_DMA(a)
912#endif
913
Eric Andersen3443bd72003-07-22 07:30:36 +0000914#define hdparm_trivial_usage \
915 "[options] [device] .."
916#define hdparm_full_usage \
917 "Options:" \
Eric Andersen15c03c32004-04-06 17:52:02 +0000918 "\t-a get/set fs readahead\n" \
919 "\t-A set drive read-lookahead flag (0/1)\n" \
920 "\t-b get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
921 "\t-B set Advanced Power Management setting (1-255)\n" \
922 "\t-c get/set IDE 32-bit IO setting\n" \
923 "\t-C check IDE power mode status\n" \
924 USAGE_GETSET_DMA("\t-d get/set using_dma flag\n") \
925 "\t-D enable/disable drive defect-mgmt\n" \
926 "\t-f flush buffer cache for device on exit\n" \
927 "\t-g display drive geometry\n" \
928 "\t-h display terse usage information\n" \
929 "\t-i display drive identification\n" \
930 USAGE_HDPARM_IDENT("\t-I detailed/current information directly from drive\n") \
931 USAGE_HDPARM_IDENT("\t-Istdin similar to -I, but wants /proc/ide/" "*" "/hd?/identify as input\n") \
932 "\t-k get/set keep_settings_over_reset flag (0/1)\n" \
933 "\t-K set drive keep_features_over_reset flag (0/1)\n" \
934 "\t-L set drive doorlock (0/1) (removable harddisks only)\n" \
935 "\t-m get/set multiple sector count\n" \
936 "\t-n get/set ignore-write-errors flag (0/1)\n" \
937 "\t-p set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
938 "\t-P set drive prefetch count\n" \
939 "\t-q change next setting quietly\n" \
940 "\t-Q get/set DMA tagged-queuing depth (if supported)\n" \
941 "\t-r get/set readonly flag (DANGEROUS to set)\n" \
942 USAGE_SCAN_HWIF("\t-R register an IDE interface (DANGEROUS)\n") \
943 "\t-S set standby (spindown) timeout\n" \
944 "\t-t perform device read timings\n" \
945 "\t-T perform cache read timings\n" \
946 "\t-u get/set unmaskirq flag (0/1)\n" \
947 USAGE_UNREGISTER_HWIF("\t-U un-register an IDE interface (DANGEROUS)\n") \
948 "\t-v defaults; same as -mcudkrag for IDE drives\n" \
949 "\t-V display program version and exit immediately\n" \
950 USAGE_DRIVE_RESET("\t-w perform device reset (DANGEROUS)\n") \
951 "\t-W set drive write-caching flag (0/1) (DANGEROUS)\n" \
952 USAGE_TRISTATE_HWIF("\t-x tristate device for hotswap (0/1) (DANGEROUS)\n") \
953 "\t-X set IDE xfer mode (DANGEROUS)\n" \
954 "\t-y put IDE drive in standby mode\n" \
955 "\t-Y put IDE drive to sleep\n" \
956 "\t-Z disable Seagate auto-powersaving mode\n" \
957 "\t-z re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +0000958
Manuel Novoa III cad53642003-03-19 09:13:01 +0000959#ifdef CONFIG_FEATURE_FANCY_HEAD
960#define USAGE_FANCY_HEAD(a) a
961#else
962#define USAGE_FANCY_HEAD(a)
963#endif
964
Eric Andersen7e9276b2001-02-22 01:15:47 +0000965#define head_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000966 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000967#define head_full_usage \
968 "Print first 10 lines of each FILE to standard output.\n" \
969 "With more than one FILE, precede each with a header giving the\n" \
970 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000971 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000972 "\t-n NUM\t\tPrint first NUM lines instead of first 10" \
973 USAGE_FANCY_HEAD( \
974 "\n\t-c NUM\t\toutput the first NUM bytes\n" \
975 "\t-q\t\tnever output headers giving file names\n" \
976 "\t-v\t\talways output headers giving file names" )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000977#define head_example_usage \
978 "$ head -n 2 /etc/passwd\n" \
979 "root:x:0:0:root:/root:/bin/bash\n" \
980 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000981
Glenn L McGrath60281112001-11-02 11:39:46 +0000982#define hexdump_trivial_usage \
983 "[-[bcdefnosvx]] [OPTION] FILE"
984#define hexdump_full_usage \
985 "The hexdump utility is a filter which displays the specified files,\n" \
986 "or the standard input, if no files are specified, in a user specified\n"\
987 "format\n" \
988 "\t-b\t\tOne-byte octal display\n" \
989 "\t-c\t\tOne-byte character display\n" \
990 "\t-d\t\tTwo-byte decimal display\n" \
991 "\t-e FORMAT STRING\n" \
992 "\t-f FORMAT FILE\n" \
993 "\t-n LENGTH\tInterpret only length bytes of input\n" \
994 "\t-o\t\tTwo-byte octal display\n" \
995 "\t-s OFFSET\tSkip offset byte\n" \
996 "\t-v\t\tdisplay all input data\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000997 "\t-x\t\tTwo-byte hexadecimal display"
Glenn L McGrath60281112001-11-02 11:39:46 +0000998
Eric Andersen7e9276b2001-02-22 01:15:47 +0000999#define hostid_trivial_usage \
1000 ""
1001#define hostid_full_usage \
1002 "Print out a unique 32-bit identifier for the machine."
1003
1004#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001005 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001006#define hostname_full_usage \
1007 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001008 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001009 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +00001010 "\t-s\tShort\n" \
1011 "\t-i\tAddresses for the hostname\n" \
1012 "\t-d\tDNS domain name\n" \
1013 "\t-f\tFully qualified domain name\n" \
1014 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001015#define hostname_example_usage \
1016 "$ hostname\n" \
Eric Andersen08f59e32004-03-12 22:07:10 +00001017 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001018
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001019#ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH
1020 #define USAGE_HTTPD_BASIC_AUTH(a) a
Eric Andersen40520512003-07-28 09:59:05 +00001021 #ifdef CONFIG_FEATURE_HTTPD_AUTH_MD5
1022 #define USAGE_HTTPD_AUTH_MD5(a) a
1023 #else
1024 #define USAGE_HTTPD_AUTH_MD5(a)
1025 #endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001026#else
1027 #define USAGE_HTTPD_BASIC_AUTH(a)
Eric Andersen40520512003-07-28 09:59:05 +00001028 #define USAGE_HTTPD_AUTH_MD5(a)
1029#endif
1030#ifdef CONFIG_FEATURE_HTTPD_USAGE_FROM_INETD_ONLY
1031 #define USAGE_HTTPD_STANDALONE(a)
1032 #define USAGE_HTTPD_SETUID(a)
1033#else
1034 #define USAGE_HTTPD_STANDALONE(a) a
1035 #ifdef CONFIG_FEATURE_HTTPD_SETUID
1036 #define USAGE_HTTPD_SETUID(a) a
1037 #else
1038 #define USAGE_HTTPD_SETUID(a)
1039 #endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001040#endif
1041#define httpd_trivial_usage \
Eric Andersen40520512003-07-28 09:59:05 +00001042 "[-c <conf file>]" \
1043 USAGE_HTTPD_STANDALONE(" [-p <port>]") \
1044 USAGE_HTTPD_SETUID(" [-u user]") \
1045 USAGE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
1046 USAGE_HTTPD_AUTH_MD5(" [-m pass]") \
Eric Andersen73afd892004-04-14 17:59:21 +00001047 " [-h home]" \
Eric Andersen40520512003-07-28 09:59:05 +00001048 " [-d/-e <string>]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001049#define httpd_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001050 "Listens for incoming http server requests.\n\n"\
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001051 "Options:\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001052 "\t-c FILE\t\tSpecifies configuration file. (default httpd.conf)\n" \
Eric Andersen40520512003-07-28 09:59:05 +00001053 USAGE_HTTPD_STANDALONE("\t-p PORT\tServer port (default 80)\n") \
Eric Andersenaff114c2004-04-14 17:51:38 +00001054 USAGE_HTTPD_SETUID("\t-u USER\tSet uid to USER after listening privileges port\n") \
Eric Andersen40520512003-07-28 09:59:05 +00001055 USAGE_HTTPD_BASIC_AUTH("\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
Eric Andersena151d192004-04-06 17:16:36 +00001056 USAGE_HTTPD_AUTH_MD5("\t-m PASS\t\tCrypt PASS with md5 algorithm\n") \
Eric Andersen73afd892004-04-14 17:59:21 +00001057 "\t-h HOME \tSpecifies http HOME directory (default ./)\n" \
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001058 "\t-e STRING\tHtml encode STRING\n" \
Eric Andersen40520512003-07-28 09:59:05 +00001059 "\t-d STRING\tURL decode STRING"
1060
Robert Griebl1cd04452002-07-21 16:50:49 +00001061#define hwclock_trivial_usage \
1062 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
1063#define hwclock_full_usage \
1064 "Query and set the hardware clock (RTC)\n\n" \
1065 "Options:\n" \
1066 "\t-r\tread hardware clock and print result\n" \
1067 "\t-s\tset the system time from the hardware clock\n" \
1068 "\t-w\tset the hardware clock to the current system time\n" \
1069 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
1070 "\t-l\tthe hardware clock is kept in local time"
1071
Eric Andersen9e480452003-07-03 10:07:04 +00001072#ifdef CONFIG_SELINUX
Eric Andersen15c03c32004-04-06 17:52:02 +00001073 #define USAGE_SELINUX(a) a
Eric Andersen9e480452003-07-03 10:07:04 +00001074#else
Eric Andersen15c03c32004-04-06 17:52:02 +00001075 #define USAGE_SELINUX(a)
Eric Andersen9e480452003-07-03 10:07:04 +00001076#endif
1077
Eric Andersen7e9276b2001-02-22 01:15:47 +00001078#define id_trivial_usage \
1079 "[OPTIONS]... [USERNAME]"
1080#define id_full_usage \
1081 "Print information for USERNAME or the current user\n\n" \
1082 "Options:\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001083 USAGE_SELINUX("\t-c\tprints only the security context\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001084 "\t-g\tprints only the group ID\n" \
1085 "\t-u\tprints only the user ID\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001086 "\t-n\tprint a name instead of a number\n" \
1087 "\t-r\tprints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001088#define id_example_usage \
1089 "$ id\n" \
1090 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001091
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001092#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001093 #define USAGE_SIOCSKEEPALIVE(a) a
1094#else
1095 #define USAGE_SIOCSKEEPALIVE(a)
1096#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001097#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001098 #define USAGE_IFCONFIG_MII(a) a
1099#else
1100 #define USAGE_IFCONFIG_MII(a)
1101#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001102#ifdef CONFIG_FEATURE_IFCONFIG_HW
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001103 #define USAGE_IFCONFIG_HW(a) a
1104#else
1105 #define USAGE_IFCONFIG_HW(a)
1106#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001107#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001108 #define USAGE_IFCONFIG_OPT_A(a) a
1109#else
1110 #define USAGE_IFCONFIG_OPT_A(a)
1111#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +00001112#ifdef CONFIG_FEATURE_IPV6
1113 #define USAGE_IPV6(a) a
1114#else
1115 #define USAGE_IPV6(a)
1116#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001117
Eric Andersen7e9276b2001-02-22 01:15:47 +00001118#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001119 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001120#define ifconfig_full_usage \
1121 "configure a network interface\n\n" \
1122 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +00001123 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
1124 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001125 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001126 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001127 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001128 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
1129 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001130 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001131 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
1132 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001133 "\t[up|down] ..."
1134
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001135#define ifup_trivial_usage \
1136 "<-ahinv> <ifaces...>"
1137#define ifup_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001138 "ifup <options> <ifaces...>\n\n" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001139 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001140 "\t-h\tthis help\n" \
1141 "\t-a\tde/configure all interfaces automatically\n" \
1142 "\t-i FILE\tuse FILE for interface definitions\n" \
1143 "\t-n\tprint out what would happen, but don't do it\n" \
1144 "\t\t\t(note that this option doesn't disable mappings)\n" \
1145 "\t-v\tprint out what would happen before doing it\n" \
1146 "\t-m\tdon't run any mappings\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001147 "\t-f\tforce de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001148
1149#define ifdown_trivial_usage \
1150 "<-ahinv> <ifaces...>"
1151#define ifdown_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001152 "ifdown <options> <ifaces...>\n\n" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001153 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001154 "\t-h\tthis help\n" \
1155 "\t-a\tde/configure all interfaces automatically\n" \
1156 "\t-i FILE\tuse FILE for interface definitions\n" \
1157 "\t-n\tprint out what would happen, but don't do it\n" \
1158 "\t\t(note that this option doesn't disable mappings)\n" \
1159 "\t-v\tprint out what would happen before doing it\n" \
1160 "\t-m\tdon't run any mappings\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001161 "\t-f\tforce de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001162
Glenn L McGrath06e95652003-02-09 06:51:14 +00001163#define inetd_trivial_usage \
1164 "[-q len] [conf]"
1165#define inetd_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001166 "Listens for network connections and launches programs\n\n" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001167 "Option:\n" \
1168 "\t-q\tSets the size of the socket listen queue to\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001169 "\t\tthe specified value. Default is 128."
Glenn L McGrath06e95652003-02-09 06:51:14 +00001170
Eric Andersen7e9276b2001-02-22 01:15:47 +00001171#define init_trivial_usage \
1172 ""
1173#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001174 "Init is the parent of all processes."
1175#define init_notes_usage \
1176"This version of init is designed to be run only by the kernel.\n" \
1177"\n" \
1178"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
1179"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
1180"runlevels, use sysvinit.\n" \
1181"\n" \
1182"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
1183"it has the following default behavior:\n" \
1184"\n" \
1185" ::sysinit:/etc/init.d/rcS\n" \
1186" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001187" ::ctrlaltdel:/sbin/reboot\n" \
1188" ::shutdown:/sbin/swapoff -a\n" \
1189" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001190" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001191"\n" \
1192"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1193"\n" \
1194" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001195" tty3::askfirst:/bin/sh\n" \
1196" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001197"\n" \
1198"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1199"\n" \
1200" <id>:<runlevels>:<action>:<process>\n" \
1201"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001202" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001203"\n" \
1204" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1205" The id field is used by BusyBox init to specify the controlling tty for\n" \
1206" the specified process to run on. The contents of this field are\n" \
1207" appended to "/dev/" and used as-is. There is no need for this field to\n" \
1208" be unique, although if it isn't you may have strange results. If this\n" \
1209" field is left blank, the controlling tty is set to the console. Also\n" \
1210" note that if BusyBox detects that a serial console is in use, then only\n" \
1211" entries whose controlling tty is either the serial console or /dev/null\n" \
1212" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1213" stinkin' utmp.\n" \
1214"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001215" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001216"\n" \
1217" The runlevels field is completely ignored.\n" \
1218"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001219" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001220"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001221" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001222" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001223"\n" \
1224" The available actions can be classified into two groups: actions\n" \
1225" that are run only once, and actions that are re-run when the specified\n" \
1226" process exits.\n" \
1227"\n" \
1228" Run only-once actions:\n" \
1229"\n" \
1230" 'sysinit' is the first item run on boot. init waits until all\n" \
1231" sysinit actions are completed before continuing. Following the\n" \
1232" completion of all sysinit actions, all 'wait' actions are run.\n" \
1233" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001234" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001235" therefore, init does not wait for them to complete. 'restart' is\n" \
1236" the action taken to restart the init process. By default this should\n" \
1237" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1238" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001239" actions are run when the system detects that someone on the system\n" \
1240" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1241" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1242" Finally the 'shutdown' action specifies the actions to taken when\n" \
1243" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1244" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001245"\n" \
1246" Run repeatedly actions:\n" \
1247"\n" \
1248" 'respawn' actions are run after the 'once' actions. When a process\n" \
1249" started with a 'respawn' action exits, init automatically restarts\n" \
1250" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1251" respawning out of control. The 'askfirst' actions acts just like\n" \
1252" respawn, except that before running the specified process it\n" \
1253" displays the line "Please press Enter to activate this console."\n" \
1254" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001255" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001256"\n" \
1257" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1258" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001259" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001260"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001261" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001262"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001263" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001264"\n" \
1265"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001266"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001267" # This is run first except when booting in single-user mode.\n" \
1268" #\n" \
1269" ::sysinit:/etc/init.d/rcS\n" \
1270" \n" \
1271" # /bin/sh invocations on selected ttys\n" \
1272" #\n" \
1273" # Start an "askfirst" shell on the console (whatever that may be)\n" \
1274" ::askfirst:-/bin/sh\n" \
1275" # Start an "askfirst" shell on /dev/tty2-4\n" \
1276" tty2::askfirst:-/bin/sh\n" \
1277" tty3::askfirst:-/bin/sh\n" \
1278" tty4::askfirst:-/bin/sh\n" \
1279" \n" \
1280" # /sbin/getty invocations for selected ttys\n" \
1281" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001282" tty4::respawn:/sbin/getty 38400 tty4\n" \
1283" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001284" \n" \
1285" \n" \
1286" # Example of how to put a getty on a serial line (for a terminal)\n" \
1287" #\n" \
1288" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1289" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1290" #\n" \
1291" # Example how to put a getty on a modem line.\n" \
1292" #::respawn:/sbin/getty 57600 ttyS2\n" \
1293" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001294" # Stuff to do when restarting the init process\n" \
1295" ::restart:/sbin/init\n" \
1296" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001297" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001298" ::ctrlaltdel:/sbin/reboot\n" \
1299" ::shutdown:/bin/umount -a -r\n" \
1300" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001301
Eric Andersenbe65c352003-01-23 04:57:35 +00001302#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
1303 #define USAGE_INSMOD_MAP(a) a
1304#else
1305 #define USAGE_INSMOD_MAP(a)
1306#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001307#define insmod_trivial_usage \
1308 "[OPTION]... MODULE [symbol=value]..."
1309#define insmod_full_usage \
1310 "Loads the specified kernel modules into the kernel.\n\n" \
1311 "Options:\n" \
1312 "\t-f\tForce module to load into the wrong kernel version.\n" \
1313 "\t-k\tMake module autoclean-able.\n" \
1314 "\t-v\tverbose output\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001315 "\t-q\tquiet output\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001316 "\t-L\tLock to prevent simultaneous loads of a module\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001317 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout\n") \
Eric Andersen957879a2004-04-07 15:07:55 +00001318 "\t-o NAME\tSet internal module name to NAME\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001319 "\t-x\tdo not export externs"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001320
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001321#define install_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001322 "[-cgmops] [sources] <dest|directory>"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001323#define install_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001324 "Copies files and set attributes\n\n" \
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001325 "Options:\n" \
1326 "\t-c\tcopy the file, default\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001327 "\t-d\tcreate directories\n" \
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001328 "\t-g\tset group ownership\n" \
1329 "\t-m\tset permission modes\n" \
1330 "\t-o\tset ownership\n" \
1331 "\t-p\tpreserve date\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001332 "\t-s\tstrip symbol tables"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001333
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001334#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001335 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001336#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001337 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1338 "where OBJECT := { link | addr | route | tunnel }\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001339 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001340
1341#define ipaddr_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001342 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
1343 "\t\t[ dev STRING ] [ to PREFIX ] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001344#define ipaddr_full_usage \
1345 "ipaddr {add|del} IFADDR dev STRING\n" \
1346 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001347 "\t\t\t[ to PREFIX ] [ label PATTERN ]\n" \
1348 "\t\t\tIFADDR := PREFIX | ADDR peer PREFIX\n" \
1349 "\t\t\t[ broadcast ADDR ] [ anycast ADDR ]\n" \
1350 "\t\t\t[ label STRING ] [ scope SCOPE-ID ]\n" \
1351 "\t\t\tSCOPE-ID := [ host | link | global | NUMBER ]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001352
Eric Andersen3561b012004-04-13 19:27:20 +00001353#ifdef CONFIG_FEATURE_IPCALC_FANCY
1354 #define XUSAGE_IPCALC_FANCY(a) a
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001355#else
Eric Andersen3561b012004-04-13 19:27:20 +00001356 #define XUSAGE_IPCALC_FANCY(a)
1357#endif
Eric Andersende4f07e2003-12-11 01:18:07 +00001358#define ipcalc_trivial_usage \
Eric Andersen3561b012004-04-13 19:27:20 +00001359 "[OPTION]... <ADDRESS>[[/]<NETMASK>] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001360#define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001361 "Calculate IP network settings from a IP address\n\n" \
1362 "Options:\n" \
1363 "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \
Eric Andersen3561b012004-04-13 19:27:20 +00001364 "\t-n\t--network\tDisplay calculated network address.\n" \
1365 "\t-m\t--netmask\tDisplay default netmask for IP." \
1366 XUSAGE_IPCALC_FANCY(\
1367 "\n\t-p\t--prefix\tDisplay the prefix for IP/NETMASK." \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001368 "\t-h\t--hostname\tDisplay first resolved host name.\n" \
Eric Andersen3561b012004-04-13 19:27:20 +00001369 "\t-s\t--silent\tDon't ever display error messages.")
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001370
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001371#define iplink_trivial_usage \
1372 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1373#define iplink_full_usage \
1374 "iplink set DEVICE { up | down | arp { on | off } |\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001375 "\t\t\tdynamic { on | off } |\n" \
1376 "\t\t\tmtu MTU }\n" \
1377 "\tiplink show [ DEVICE ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001378
1379#define iproute_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001380 "{ list | flush | { add | del | change | append |\n" \
1381 "\t\treplace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001382#define iproute_full_usage \
1383 "iproute { list | flush } SELECTOR\n" \
1384 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001385 "\t\t\t[ oif STRING ] [ tos TOS ]\n" \
1386 "\tiproute { add | del | change | append | replace | monitor } ROUTE\n" \
1387 "\t\t\tSELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1388 "\t\t\tROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001389
1390#define iptunnel_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001391 "{ add | change | del | show } [ NAME ]\n" \
1392 "\t\t[ mode { ipip | gre | sit } ]\n" \
1393 "\t\t[ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001394#define iptunnel_full_usage \
1395 "iptunnel { add | change | del | show } [ NAME ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001396 "\t\t\t[ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1397 "\t\t\t[ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1398 "\t\t\t[ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001399
Eric Andersen7e9276b2001-02-22 01:15:47 +00001400#define kill_trivial_usage \
1401 "[-signal] process-id [process-id ...]"
1402#define kill_full_usage \
1403 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
David Kimdon56082dc2001-02-23 06:03:22 +00001404 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001405 "\t-l\tList all signal names and numbers."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001406#define kill_example_usage \
1407 "$ ps | grep apache\n" \
1408 "252 root root S [apache]\n" \
1409 "263 www-data www-data S [apache]\n" \
1410 "264 www-data www-data S [apache]\n" \
1411 "265 www-data www-data S [apache]\n" \
1412 "266 www-data www-data S [apache]\n" \
1413 "267 www-data www-data S [apache]\n" \
1414 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001415
1416#define killall_trivial_usage \
Eric Andersenb131db42004-08-19 18:25:02 +00001417 "[-q] [-signal] process-name [process-name ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001418#define killall_full_usage \
1419 "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001420 "Options:\n" \
Eric Andersenb131db42004-08-19 18:25:02 +00001421 "\t-l\tList all signal names and numbers.\n"\
1422 "\t-q\tDo not complain if no processes were killed."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001423#define killall_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001424 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001425
Mark Whitley6317c4b2001-03-12 22:51:50 +00001426#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001427 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001428#define klogd_full_usage \
1429 "Kernel logger.\n"\
1430 "Options:\n"\
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001431 "\t-c n\tSets the default log level of console messages to n.\n"\
Mark Whitley6317c4b2001-03-12 22:51:50 +00001432 "\t-n\tRun as a foreground process."
1433
Eric Andersen7e9276b2001-02-22 01:15:47 +00001434#define length_trivial_usage \
1435 "STRING"
1436#define length_full_usage \
1437 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001438#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001439 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001440 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001441
1442#define ln_trivial_usage \
1443 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1444#define ln_full_usage \
1445 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\
1446 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1447 "Options:\n" \
1448 "\t-s\tmake symbolic links instead of hard links\n" \
1449 "\t-f\tremove existing destination files\n" \
1450 "\t-n\tno dereference symlinks - treat like normal file"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001451#define ln_example_usage \
1452 "$ ln -s BusyBox /tmp/ls\n" \
1453 "$ ls -l /tmp/ls\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001454 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001455
Eric Andersen7e9276b2001-02-22 01:15:47 +00001456#define loadfont_trivial_usage \
1457 "< font"
1458#define loadfont_full_usage \
1459 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001460#define loadfont_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001461 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001462
1463#define loadkmap_trivial_usage \
1464 "< keymap"
1465#define loadkmap_full_usage \
1466 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001467#define loadkmap_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001468 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001469
1470#define logger_trivial_usage \
1471 "[OPTION]... [MESSAGE]"
1472#define logger_full_usage \
1473 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1474 "Options:\n" \
1475 "\t-s\tLog to stderr as well as the system log.\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001476 "\t-t TAG\tLog using the specified tag (defaults to user name).\n" \
1477 "\t-p PRIORITY\tEnter the message with the specified priority.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001478 "\t\tThis may be numerical or a ``facility.level'' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001479#define logger_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001480 "$ logger "hello"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001481
Robert Griebl1fca5582002-06-04 20:45:46 +00001482#define login_trivial_usage \
1483 "[OPTION]... [username] [ENV=VAR ...]"
1484#define login_full_usage \
1485 "Begin a new session on the system\n\n" \
1486 "Options:\n" \
1487 "\t-f\tDo not authenticate (user already authenticated)\n" \
1488 "\t-h\tName of the remote host for this login.\n" \
1489 "\t-p\tPreserve environment."
1490
Eric Andersen7e9276b2001-02-22 01:15:47 +00001491#define logname_trivial_usage \
1492 ""
1493#define logname_full_usage \
1494 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001495#define logname_example_usage \
1496 "$ logname\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001497 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001498
Mark Whitley6317c4b2001-03-12 22:51:50 +00001499#define logread_trivial_usage \
Eric Andersend4a5e252003-12-19 11:32:14 +00001500 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001501#define logread_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001502 "Shows the messages from syslogd (using circular buffer).\n\n" \
Eric Andersend4a5e252003-12-19 11:32:14 +00001503 "Options:\n" \
1504 "\t-f\t\toutput data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001505
Matt Kraai83788da2002-03-20 17:38:37 +00001506#define losetup_trivial_usage \
1507 "[OPTION]... LOOPDEVICE FILE\n" \
1508 "or: losetup [OPTION]... -d LOOPDEVICE"
1509#define losetup_full_usage \
1510 "Associate LOOPDEVICE with FILE.\n\n" \
1511 "Options:\n" \
1512 "\t-d\t\tDisassociate LOOPDEVICE.\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001513 "\t-o OFFSET\tStart OFFSET bytes into FILE."
Matt Kraai83788da2002-03-20 17:38:37 +00001514
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001515#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001516 #define USAGE_LS_TIMESTAMPS(a) a
1517#else
1518 #define USAGE_LS_TIMESTAMPS(a)
1519#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001520#ifdef CONFIG_FEATURE_LS_FILETYPES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001521 #define USAGE_LS_FILETYPES(a) a
1522#else
1523 #define USAGE_LS_FILETYPES(a)
1524#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001525#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Eric Andersen7e9276b2001-02-22 01:15:47 +00001526 #define USAGE_LS_FOLLOWLINKS(a) a
1527#else
1528 #define USAGE_LS_FOLLOWLINKS(a)
1529#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001530#ifdef CONFIG_FEATURE_LS_RECURSIVE
Eric Andersen7e9276b2001-02-22 01:15:47 +00001531 #define USAGE_LS_RECURSIVE(a) a
1532#else
1533 #define USAGE_LS_RECURSIVE(a)
1534#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001535#ifdef CONFIG_FEATURE_LS_SORTFILES
Eric Andersen7e9276b2001-02-22 01:15:47 +00001536 #define USAGE_LS_SORTFILES(a) a
1537#else
1538 #define USAGE_LS_SORTFILES(a)
1539#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001540#ifdef CONFIG_FEATURE_AUTOWIDTH
Eric Andersen7e9276b2001-02-22 01:15:47 +00001541 #define USAGE_AUTOWIDTH(a) a
1542#else
1543 #define USAGE_AUTOWIDTH(a)
1544#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00001545
Eric Andersen7e9276b2001-02-22 01:15:47 +00001546#define ls_trivial_usage \
Eric Andersen15c03c32004-04-06 17:52:02 +00001547 "[-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" USAGE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001548#define ls_full_usage \
1549 "List directory contents\n\n" \
1550 "Options:\n" \
1551 "\t-1\tlist files in a single column\n" \
1552 "\t-A\tdo not list implied . and ..\n" \
1553 "\t-a\tdo not hide entries starting with .\n" \
1554 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001555 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001556 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001557 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1558 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001559 "\t-i\tlist the i-node for each file\n" \
1560 "\t-l\tuse a long listing format\n" \
1561 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001562 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1563 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1564 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1565 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1566 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001567 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001568 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1569 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1570 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1571 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1572 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001573 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001574 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1575 USAGE_HUMAN_READABLE( \
Eric Andersen15c03c32004-04-06 17:52:02 +00001576 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n") \
1577 USAGE_SELINUX("\t-k\tprint security context\n") \
1578 USAGE_SELINUX("\t-K\tprint security context in long format\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001579
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001580#define lsattr_trivial_usage \
1581 "[-Radlv] [files...]"
1582#define lsattr_full_usage \
1583 "list file attributes on an ext2 fs\n\n" \
1584 "Options:\n" \
1585 "\t-R\trecursively list subdirectories\n" \
1586 "\t-a\tdo not hide entries starting with .\n" \
1587 "\t-d\tlist directory entries instead of contents\n" \
1588 "\t-l\tprint long flag names\n" \
1589 "\t-v\tlist the file's version/generation number\n"
1590
Eric Andersen7e9276b2001-02-22 01:15:47 +00001591#define lsmod_trivial_usage \
1592 ""
1593#define lsmod_full_usage \
1594 "List the currently loaded kernel modules."
1595
1596#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001597 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001598#define makedevs_full_usage \
1599 "Creates a range of block or character special files\n\n" \
1600 "TYPEs include:\n" \
1601 "\tb:\tMake a block (buffered) device.\n" \
1602 "\tc or u:\tMake a character (un-buffered) device.\n" \
1603 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1604 "FIRST specifies the number appended to NAME to create the first device.\n" \
1605 "LAST specifies the number of the last item that should be created.\n" \
1606 "If 's' is the last argument, the base device is created as well.\n\n" \
1607 "For example:\n" \
1608 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001609 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001610#define makedevs_example_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001611 "# makedevs /dev/ttyS c 4 66 2 63\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001612 "[creates ttyS2-ttyS63]\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001613 "# makedevs /dev/hda b 3 0 0 8 s\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001614 "[creates hda,hda1-hda8]\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001615
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001616#ifdef CONFIG_FEATURE_MD5_SHA1_SUM_CHECK
1617#define USAGE_MD5_SHA1_SUM_CHECK(a) a
1618#else
1619#define USAGE_MD5_SHA1_SUM_CHECK(a)
1620#endif
1621
Eric Andersen7e9276b2001-02-22 01:15:47 +00001622#define md5sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001623 "[OPTION] [FILEs...]" \
1624 USAGE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001625#define md5sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001626 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001627 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001628 "With no FILE, or when FILE is -, read standard input." \
1629 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
1630 "\t-c\tcheck MD5 sums against given list\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001631 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001632 "\t-s\tdon't output anything, status code shows success\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001633 "\t-w\twarn about improperly formated MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001634#define md5sum_example_usage \
1635 "$ md5sum < busybox\n" \
1636 "6fd11e98b98a58f64ff3398d7b324003\n" \
1637 "$ md5sum busybox\n" \
1638 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1639 "$ md5sum -c -\n" \
1640 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1641 "busybox: OK\n" \
1642 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001643
Glenn L McGrath061c9002002-09-16 04:21:46 +00001644#define mesg_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001645 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001646#define mesg_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001647 "mesg controls write access to your terminal\n" \
Glenn L McGrath061c9002002-09-16 04:21:46 +00001648 "\ty\tAllow write access to your terminal.\n" \
1649 "\tn\tDisallow write access to your terminal.\n"
1650
Eric Andersen7e9276b2001-02-22 01:15:47 +00001651#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001652 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001653#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001654 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001655 "Options:\n" \
1656 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001657 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001658#define mkdir_example_usage \
1659 "$ mkdir /tmp/foo\n" \
1660 "$ mkdir /tmp/foo\n" \
1661 "/tmp/foo: File exists\n" \
1662 "$ mkdir /tmp/foo/bar/baz\n" \
1663 "/tmp/foo/bar/baz: No such file or directory\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001664 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001665
Eric Andersen7e9276b2001-02-22 01:15:47 +00001666#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001667 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001668#define mkfifo_full_usage \
1669 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1670 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001671 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001672
Eric Andersen7e9276b2001-02-22 01:15:47 +00001673#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001674 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001675#define mkfs_minix_full_usage \
1676 "Make a MINIX filesystem.\n\n" \
1677 "Options:\n" \
1678 "\t-c\t\tCheck the device for bad blocks\n" \
1679 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1680 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1681 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001682 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001683
Eric Andersen7e9276b2001-02-22 01:15:47 +00001684#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001685 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001686#define mknod_full_usage \
1687 "Create a special file (block, character, or pipe).\n\n" \
1688 "Options:\n" \
1689 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1690 "TYPEs include:\n" \
1691 "\tb:\tMake a block (buffered) device.\n" \
1692 "\tc or u:\tMake a character (un-buffered) device.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001693 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001694#define mknod_example_usage \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001695 "$ mknod /dev/fd0 b 2 0\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001696 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001697
Eric Andersen7e9276b2001-02-22 01:15:47 +00001698#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001699 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001700#define mkswap_full_usage \
1701 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001702 "Options:\n" \
1703 "\t-c\t\tCheck for read-ability.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001704 "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001705 "\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 +00001706 "\tblock-count\tNumber of block to use (default is entire partition)."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001707
Eric Andersen7e9276b2001-02-22 01:15:47 +00001708#define mktemp_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001709 "[-dq] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001710#define mktemp_full_usage \
1711 "Creates a temporary file with its name based on TEMPLATE.\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001712 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX).\n\n" \
1713 "Options:\n" \
1714 "\t-d\t\tMake a directory instead of a file\n" \
1715 "\t-q\t\tFail silently if an error occurs"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001716#define mktemp_example_usage \
1717 "$ mktemp /tmp/temp.XXXXXX\n" \
1718 "/tmp/temp.mWiLjM\n" \
1719 "$ ls -la /tmp/temp.mWiLjM\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001720 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001721
Eric Andersen8d79ce82001-07-22 23:00:15 +00001722#define modprobe_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001723 "[-knqrsv] [MODULE ...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00001724#define modprobe_full_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001725 "Used for high level module loading and unloading.\n\n" \
1726 "Options:\n" \
1727 "\t-k\tMake module autoclean-able.\n" \
1728 "\t-n\tJust show what would be done.\n" \
1729 "\t-q\tQuiet output.\n" \
1730 "\t-r\tRemove module (stacks) or do autoclean.\n" \
1731 "\t-s\tReport via syslog instead of stderr.\n" \
1732 "\t-v\tVerbose output."
Eric Andersen8d79ce82001-07-22 23:00:15 +00001733#define modprobe_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001734 "$ modprobe cdrom\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00001735
Eric Andersen7e9276b2001-02-22 01:15:47 +00001736#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001737 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001738#define more_full_usage \
1739 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001740#define more_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001741 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001742
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001743#ifdef CONFIG_FEATURE_MOUNT_LOOP
Eric Andersen7e9276b2001-02-22 01:15:47 +00001744 #define USAGE_MOUNT_LOOP(a) a
1745#else
1746 #define USAGE_MOUNT_LOOP(a)
1747#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001748#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Eric Andersen7e9276b2001-02-22 01:15:47 +00001749 #define USAGE_MTAB(a) a
1750#else
1751 #define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001752#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001753#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001754 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001755#define mount_full_usage \
Eric Andersen2715fa12004-03-09 21:32:57 +00001756 "Mount a filesystem. Autodetection of filesystem type requires the\n" \
1757 "/proc filesystem be already mounted.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001758 "Flags:\n" \
1759 "\t-a:\t\tMount all filesystems in fstab.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001760 USAGE_MTAB( \
Eric Andersena0cfe942001-02-23 10:07:09 +00001761 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001762 "\t-n:\t\tDon't write a mount table entry.\n" \
1763 ) \
1764 "\t-o option:\tOne of many filesystem options, listed below.\n" \
1765 "\t-r:\t\tMount the filesystem read-only.\n" \
1766 "\t-t fs-type:\tSpecify the filesystem type.\n" \
1767 "\t-w:\t\tMount for reading and writing (default).\n" \
1768 "\n" \
1769 "Options for use with the \"-o\" flag:\n" \
1770 "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \
1771 "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \
1772 "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \
1773 "\texec/noexec:\tAllow use of executable files / disallow them.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001774 USAGE_MOUNT_LOOP( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001775 "\tloop:\t\tMounts a file via loop device.\n" \
1776 ) \
1777 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00001778 "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001779 "\tro/rw:\t\tMount for read-only / read-write.\n" \
Eric Andersen2f6e1f82001-05-21 15:59:34 +00001780 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001781 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001782 "You'll have to see the written documentation for those filesystems."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001783#define mount_example_usage \
1784 "$ mount\n" \
1785 "/dev/hda3 on / type minix (rw)\n" \
1786 "proc on /proc type proc (rw)\n" \
1787 "devpts on /dev/pts type devpts (rw)\n" \
1788 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001789 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001790
Eric Andersen7e9276b2001-02-22 01:15:47 +00001791#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001792 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001793#define mt_full_usage \
1794 "Control magnetic tape drive operation\n" \
1795 "\nAvailable Opcodes:\n\n" \
1796 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1797 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
Eric Andersen92fb9392003-08-08 20:09:03 +00001798 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001799 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001800
Eric Andersen7e9276b2001-02-22 01:15:47 +00001801#define mv_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001802 "[OPTION]... SOURCE DEST\n" \
1803 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001804#define mv_full_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001805 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY.\n\n" \
1806 "Options:\n" \
1807 "\t-f\tdon't prompt before overwriting\n" \
1808 "\t-i\tinteractive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001809#define mv_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001810 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001811
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001812#define nameif_trivial_usage \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001813 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001814#define nameif_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00001815 "Nameif renaming network interface while it in the down state.\n\n" \
1816 "Options:\n" \
1817 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
1818 "\t-s\t\tUse syslog (LOCAL0 facility).\n" \
1819 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001820#define nameif_example_usage \
Eric Andersen178de172004-04-06 16:36:20 +00001821 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
1822 " or\n" \
1823 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001824
Eric Andersen7e9276b2001-02-22 01:15:47 +00001825#define nc_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001826 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001827#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001828 "Netcat opens a pipe to IP:port\n\n" \
1829 "Options:\n" \
1830 "\t-l\t\tlisten mode, for inbound connects\n" \
1831 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00001832 "\t-i SECS\t\tdelay interval for lines sent\n" \
Eric Andersen00a6a752002-04-26 23:53:10 +00001833 "\t-e PROG\t\tprogram to exec after connect (dangerous!)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001834#define nc_example_usage \
1835 "$ nc foobar.somedomain.com 25\n" \
1836 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1837 "help\n" \
1838 "214-Commands supported:\n" \
1839 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1840 "214 NOOP QUIT RSET HELP\n" \
1841 "quit\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001842 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001843
Eric Andersen1552ff72001-10-31 11:07:12 +00001844#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00001845 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00001846#define netstat_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001847 "Netstat displays Linux networking information.\n\n" \
1848 "Options:\n" \
1849 "\t-l display listening server sockets\n" \
1850 "\t-a display all sockets (default: connected)\n" \
1851 "\t-e display other/more information\n" \
1852 "\t-n don't resolve names\n" \
1853 "\t-r display routing table\n" \
1854 "\t-t tcp sockets\n" \
1855 "\t-u udp sockets\n" \
1856 "\t-w raw sockets\n" \
1857 "\t-x unix sockets"
Eric Andersen1552ff72001-10-31 11:07:12 +00001858
Manuel Novoa III 2c511602005-02-13 20:14:05 +00001859#define nice_trivial_usage \
1860 "[-n ADJUST] [COMMAND [ARG] ...]"
1861#define nice_full_usage \
1862 "Nice runs a program with modified scheduling priority.\n\n" \
1863 "Options:\n" \
1864 "\t-n ADJUST\tAdjust the scheduling priority by ADJUST.\n" \
1865
Eric Andersen7e9276b2001-02-22 01:15:47 +00001866#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001867 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001868#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00001869 "Queries the nameserver for the IP address of the given HOST\n" \
1870 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001871#define nslookup_example_usage \
1872 "$ nslookup localhost\n" \
1873 "Server: default\n" \
1874 "Address: default\n" \
1875 "\n" \
1876 "Name: debian\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001877 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001878
Glenn L McGrath60281112001-11-02 11:39:46 +00001879#define od_trivial_usage \
1880 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
1881#define od_full_usage \
1882 "Write an unambiguous representation, octal bytes by default, of FILE\n"\
1883 "to standard output. With no FILE, or when FILE is -, read standard input."
1884
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00001885#define openvt_trivial_usage \
1886 "<vtnum> <COMMAND> [ARGS...]"
1887#define openvt_full_usage \
1888 "Start a command on a new virtual terminal"
1889#define openvt_example_usage \
1890 "openvt 2 /bin/ash\n"
1891
Eric Andersen27f64e12002-06-23 04:24:25 +00001892#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
1893 #define PASSWORD_ALG_TYPES(a) a
Tim Riker7b253f82003-12-28 05:02:40 +00001894#else
Eric Andersen27f64e12002-06-23 04:24:25 +00001895 #define PASSWORD_ALG_TYPES(a)
1896#endif
1897#define passwd_trivial_usage \
1898 "[OPTION] [name]"
1899#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00001900 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00001901 "changes the password for the current user.\n" \
1902 "Options:\n" \
1903 "\t-a\tDefine which algorithm shall be used for the password.\n" \
1904 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001905 PASSWORD_ALG_TYPES(", sha1") \
Eric Andersen27f64e12002-06-23 04:24:25 +00001906 ")\n\t-d\tDelete the password for the specified user account.\n" \
1907 "\t-l\tLocks (disables) the specified user account.\n" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00001908 "\t-u\tUnlocks (re-enables) the specified user account."
Eric Andersen27f64e12002-06-23 04:24:25 +00001909
Glenn L McGrath655d8142003-06-22 15:32:41 +00001910#define patch_trivial_usage \
1911 "[-p<num>]"
1912#define patch_full_usage \
1913 "[-p<num>]"
1914#define patch_example_usage \
1915 "$ patch -p1 <example.diff"
1916
Eric Andersen221b2ea2001-07-31 19:06:07 +00001917#define pidof_trivial_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00001918 "process-name [OPTION] [process-name ...]"
Eric Andersen221b2ea2001-07-31 19:06:07 +00001919#define pidof_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00001920 "Lists the PIDs of all processes with names that match the\n" \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00001921 "names on the command line.\n" \
1922 "Options:\n" \
1923 "\t-s\t\tdisplay only a single PID."
Eric Andersen221b2ea2001-07-31 19:06:07 +00001924#define pidof_example_usage \
1925 "$ pidof init\n" \
1926 "1\n"
1927
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001928#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00001929#define ping_trivial_usage "host"
1930#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1931#else
1932#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001933 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001934#define ping_full_usage \
1935 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1936 "Options:\n" \
1937 "\t-c COUNT\tSend only COUNT pings.\n" \
1938 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1939 "\t-q\t\tQuiet mode, only displays output at start\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001940 "\t\t\tand when finished."
1941#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001942#define ping_example_usage \
1943 "$ ping localhost\n" \
1944 "PING slag (127.0.0.1): 56 data bytes\n" \
1945 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
1946 "\n" \
1947 "--- debian ping statistics ---\n" \
1948 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001949 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001950
Eric Andersen51b8bd62002-07-03 11:46:38 +00001951#ifndef CONFIG_FEATURE_FANCY_PING6
1952#define ping6_trivial_usage "host"
1953#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
1954#else
1955#define ping6_trivial_usage \
1956 "[OPTION]... host"
1957#define ping6_full_usage \
1958 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
1959 "Options:\n" \
1960 "\t-c COUNT\tSend only COUNT pings.\n" \
1961 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \
1962 "\t-q\t\tQuiet mode, only displays output at start\n" \
1963 "\t\t\tand when finished."
1964#endif
1965#define ping6_example_usage \
1966 "$ ping6 ip6-localhost\n" \
1967 "PING ip6-localhost (::1): 56 data bytes\n" \
1968 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
1969 "\n" \
1970 "--- ip6-localhost ping statistics ---\n" \
1971 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001972 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00001973
Eric Andersen7e9276b2001-02-22 01:15:47 +00001974#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001975 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001976#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001977 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001978 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001979
Eric Andersen7e9276b2001-02-22 01:15:47 +00001980#define poweroff_trivial_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00001981 "[-d<delay>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001982#define poweroff_full_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00001983 "Halt the system and request that the kernel shut off the power.\n" \
1984 "Options:\n" \
1985 "\t-d\t\tdelay interval for shutting off."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001986
Mike Frysinger95d3c452005-04-21 23:29:24 +00001987#define printenv_trivial_usage \
1988 "[VARIABLES...]"
1989#define printenv_full_usage \
1990 "print all or part of environment\n\n" \
1991 "If no environment VARIABLE specified, print them all."
1992
Eric Andersen7e9276b2001-02-22 01:15:47 +00001993#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001994 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001995#define printf_full_usage \
1996 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001997 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001998#define printf_example_usage \
Mike Frysinger5c63a722005-04-16 04:23:58 +00001999 "$ printf \"Val=%d\\n\" 5\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002000 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002001
Eric Andersen15c03c32004-04-06 17:52:02 +00002002#ifdef CONFIG_SELINUX
2003#define USAGE_NONSELINUX(a)
2004#else
2005#define USAGE_NONSELINUX(a) a
2006#endif
2007
Eric Andersen7e9276b2001-02-22 01:15:47 +00002008#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002009 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002010#define ps_full_usage \
2011 "Report process status\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00002012 USAGE_NONSELINUX("\n\tThis version of ps accepts no options.") \
2013 USAGE_SELINUX("\nOptions:\n\t-c\tshow SE Linux context")
Tim Riker7b253f82003-12-28 05:02:40 +00002014
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002015#define ps_example_usage \
2016 "$ ps\n" \
2017 " PID Uid Gid State Command\n" \
2018 " 1 root root S init\n" \
2019 " 2 root root S [kflushd]\n" \
2020 " 3 root root S [kupdate]\n" \
2021 " 4 root root S [kpiod]\n" \
2022 " 5 root root S [kswapd]\n" \
2023 " 742 andersen andersen S [bash]\n" \
2024 " 743 andersen andersen S -bash\n" \
2025 " 745 root root S [getty]\n" \
2026 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002027
Eric Andersen7e9276b2001-02-22 01:15:47 +00002028#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002029 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002030#define pwd_full_usage \
2031 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002032#define pwd_example_usage \
2033 "$ pwd\n" \
2034 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002035
Eric Andersen7e9276b2001-02-22 01:15:47 +00002036#define rdate_trivial_usage \
Eric Andersen725db192003-07-22 08:26:05 +00002037 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002038#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002039 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002040 "Options:\n" \
2041 "\t-s\tSet the system date and time (default).\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002042 "\t-p\tPrint the date and time."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002043
Ned Luddc6fbed52004-12-08 16:47:28 +00002044#ifdef CONFIG_FEATURE_READLINK_FOLLOW
2045#define USAGE_READLINK_FOLLOW(a) a
2046#else
2047#define USAGE_READLINK_FOLLOW(a)
2048#endif
2049
Eric Andersen7e9276b2001-02-22 01:15:47 +00002050#define readlink_trivial_usage \
Ned Luddc6fbed52004-12-08 16:47:28 +00002051 USAGE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002052#define readlink_full_usage \
Ned Luddc6fbed52004-12-08 16:47:28 +00002053 "Displays the value of a symbolic link." \
2054 USAGE_READLINK_FOLLOW("\n\nOptions:\n" \
2055 "\t-f\tcanonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002056
Glenn L McGrath62fae302002-12-10 00:14:33 +00002057#define realpath_trivial_usage \
2058 "pathname ..."
2059#define realpath_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002060 "Returns the absolute pathnames of given argument."
Tim Riker7b253f82003-12-28 05:02:40 +00002061
Eric Andersen7e9276b2001-02-22 01:15:47 +00002062#define reboot_trivial_usage \
Glenn L McGrath72b14a82004-07-23 03:33:38 +00002063 "[-d<delay>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002064#define reboot_full_usage \
Glenn L McGrath72b14a82004-07-23 03:33:38 +00002065 "Reboot the system.\n" \
2066 "Options:\n" \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002067 "\t-d\t\tdelay interval for rebooting."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002068
2069#define renice_trivial_usage \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002070 "{{-n INCREMENT} | PRIORITY} [[ -p | -g | -u ] ID ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002071#define renice_full_usage \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002072 "Changes priority of running processes.\n\n" \
2073 "Options:\n" \
2074 "\t-n\tadjusts current nice value (smaller is faster)\n" \
2075 "\t-p\tprocess id(s) (default)\n" \
2076 "\t-g\tprocess group id(s)\n" \
2077 "\t-u\tprocess user name(s) and/or id(s)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002078
Eric Andersen7e9276b2001-02-22 01:15:47 +00002079#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002080 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002081#define reset_full_usage \
2082 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002083
Eric Andersen7e9276b2001-02-22 01:15:47 +00002084#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002085 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002086#define rm_full_usage \
2087 "Remove (unlink) the FILE(s). You may use '--' to\n" \
2088 "indicate that all following arguments are non-options.\n\n" \
2089 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002090 "\t-i\t\talways prompt before removing each destination\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002091 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002092 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002093#define rm_example_usage \
2094 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002095
Eric Andersen7e9276b2001-02-22 01:15:47 +00002096#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002097 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002098#define rmdir_full_usage \
2099 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002100#define rmdir_example_usage \
2101 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002102
Eric Andersen7e9276b2001-02-22 01:15:47 +00002103#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002104 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002105#define rmmod_full_usage \
2106 "Unloads the specified kernel modules from the kernel.\n\n" \
2107 "Options:\n" \
Tim Rikercf932742002-12-14 01:58:59 +00002108 "\t-a\tRemove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002109#define rmmod_example_usage \
2110 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002111
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002112#ifdef CONFIG_FEATURE_IPV6
2113 #define USAGE_ROUTE_IPV6(a) a
2114#else
2115 #define USAGE_ROUTE_IPV6(a) "\t"
2116#endif
2117
2118
Eric Andersen7e9276b2001-02-22 01:15:47 +00002119#define route_trivial_usage \
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002120 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002121#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002122 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00002123 "Options:\n" \
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002124 "\t-n\t\tDont resolve names.\n" \
2125 "\t-e\t\tDisplay other/more information.\n" \
2126 "\t-A inet" USAGE_ROUTE_IPV6("{6}") "\tSelect address family."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002127
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002128#define rpm_trivial_usage \
2129 "-i -q[ildc]p package.rpm"
2130#define rpm_full_usage \
2131 "Manipulates RPM packages" \
Eric Andersendfce3532003-06-15 07:00:54 +00002132 "\n\nOptions:" \
2133 "\n\t-i Install package" \
2134 "\n\t-q Query package" \
2135 "\n\t-p Query uninstalled package" \
2136 "\n\t-i Show information" \
2137 "\n\t-l List contents" \
2138 "\n\t-d List documents" \
2139 "\n\t-c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002140
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002141#define rpm2cpio_trivial_usage \
2142 "package.rpm"
2143#define rpm2cpio_full_usage \
2144 "Outputs a cpio archive of the rpm file."
2145
Eric Andersen6cf47a72001-10-31 10:24:36 +00002146#define run_parts_trivial_usage \
2147 "[-t] [-a ARG] [-u MASK] DIRECTORY"
2148#define run_parts_full_usage \
2149 "Run a bunch of scripts in a directory.\n\n" \
2150 "Options:\n" \
Eric Andersena151d192004-04-06 17:16:36 +00002151 "\t-t\tPrints what would be run, but does not actually run anything.\n" \
Eric Andersen6cf47a72001-10-31 10:24:36 +00002152 "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \
2153 "\t-u MASK\tSet the umask to MASK before executing every program."
2154
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002155#define rx_trivial_usage \
2156 "FILE"
2157#define rx_full_usage \
2158 "Receive a file using the xmodem protocol."
2159#define rx_example_usage \
2160 "$ rx /tmp/foo\n"
2161
Eric Andersen7e9276b2001-02-22 01:15:47 +00002162#define sed_trivial_usage \
Rob Landley1ce59682004-05-26 21:59:31 +00002163 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002164#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002165 "Options:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002166 "\t-e script\tadd the script to the commands to be executed\n" \
Eric Andersenf802ff72004-04-12 15:12:06 +00002167 "\t-f scriptfile\tadd script-file contents to the\n" \
2168 "\t\t\tcommands to be executed\n" \
Rob Landley1ce59682004-05-26 21:59:31 +00002169 "\t-i\t\tedit files in-place\n" \
2170 "\t-n\t\tsuppress automatic printing of pattern space\n" \
Rob Landley58b118a2004-05-26 22:09:37 +00002171 "\t-r\t\tuse extended regular expression syntax\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002172 "\n" \
Eric Andersenf802ff72004-04-12 15:12:06 +00002173 "If no -e or -f is given, the first non-option argument is taken as the sed\n"\
2174 "script to interpret. All remaining arguments are names of input files; if no\n"\
2175 "input files are specified, then the standard input is read. Source files\n" \
2176 "will not be modified unless -i option is given."
2177
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002178#define sed_example_usage \
2179 "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
2180 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002181
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002182#define seq_trivial_usage \
2183 "[first [increment]] last"
2184#define seq_full_usage \
2185 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
2186 "FIRST, INCREMENT default to 1\n" \
2187 "Arguments:\n" \
2188 "\tLAST\n" \
2189 "\tFIRST\tLAST\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002190 "\tFIRST\tINCREMENT\tLAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002191
Eric Andersen7e9276b2001-02-22 01:15:47 +00002192#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002193 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002194#define setkeycodes_full_usage \
2195 "Set entries into the kernel's scancode-to-keycode map,\n" \
2196 "allowing unusual keyboards to generate usable keycodes.\n\n" \
2197 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002198 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002199#define setkeycodes_example_usage \
2200 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002201
Matt Kraai2d91deb2001-08-01 17:21:35 +00002202#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002203 "[FILE]...\n" \
2204 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00002205#define lash_full_usage \
Eric Andersen2e9c2572003-08-08 22:26:06 +00002206 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00002207#define lash_notes_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002208 "This command does not yet have proper documentation.\n\n" \
2209 "Use lash just as you would use any other shell. It properly handles pipes,\n" \
2210 "redirects, job control, can be used as the shell for scripts, and has a\n" \
2211 "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
2212 "Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
2213 "use ash or bash. If you just need a very simple and extremely small shell,\n" \
2214 "this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002215
Eric Andersen2e9c2572003-08-08 22:26:06 +00002216#define last_trivial_usage \
2217 ""
2218#define last_full_usage \
2219 "Shows listing of the last users that logged into the system"
2220
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002221#define sha1sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002222 "[OPTION] [FILEs...]" \
2223 USAGE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002224#define sha1sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002225 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n\n" \
2226 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002227 "With no FILE, or when FILE is -, read standard input." \
2228 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
2229 "\t-c\tcheck SHA1 sums against given list\n" \
2230 "\nThe following two options are useful only when verifying checksums:\n" \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002231 "\t-s\tdon't output anything, status code shows success\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002232 "\t-w\twarn about improperly formated SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002233
Manuel Novoa III cad53642003-03-19 09:13:01 +00002234#ifdef CONFIG_FEATURE_FANCY_SLEEP
2235 #define USAGE_FANCY_SLEEP(a) a
2236 #define USAGE_NOT_FANCY_SLEEP(a)
2237#else
Tim Riker7b253f82003-12-28 05:02:40 +00002238 #define USAGE_FANCY_SLEEP(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +00002239 #define USAGE_NOT_FANCY_SLEEP(a) a
2240#endif
2241
Eric Andersen7e9276b2001-02-22 01:15:47 +00002242#define sleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002243 USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002244#define sleep_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002245 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \
2246 USAGE_FANCY_SLEEP( \
Eric Andersen178de172004-04-06 16:36:20 +00002247 "Pause for a time equal to the total of the args given, where each arg can\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00002248 "\t\thave an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002249#define sleep_example_usage \
2250 "$ sleep 2\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002251 "[2 second delay results]\n" \
2252 USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \
2253 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002254
Rob Landleyc0dedd02005-01-24 07:00:02 +00002255#ifdef CONFIG_SORT_BIG
2256 #define USAGE_SORT_BIG(a) a
Mark Whitleyfccaa362001-04-17 18:56:18 +00002257#else
Rob Landleyc0dedd02005-01-24 07:00:02 +00002258 #define USAGE_SORT_BIG(a)
Mark Whitleyfccaa362001-04-17 18:56:18 +00002259#endif
Rob Landleyc0dedd02005-01-24 07:00:02 +00002260
2261
Eric Andersen7e9276b2001-02-22 01:15:47 +00002262#define sort_trivial_usage \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002263 "[-nru" USAGE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002264#define sort_full_usage \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002265 "Sorts lines of text in the specified files\n\n"\
2266 "Options:\n" \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002267 USAGE_SORT_BIG( \
2268 "\t-b\tignore leading blanks\n" \
2269 "\t-c\tcheck whether input is sorted\n" \
2270 "\t-d\tdictionary order (blank or alphanumeric only)\n" \
2271 "\t-f\tignore case\n" \
2272 "\t-g\tgeneral numerical sort\n" \
2273 "\t-i\tignore unprintable characters\n" \
2274 "\t-k\tspecify sort key\n" \
2275 "\t-M\tsort month\n" \
2276 ) \
2277 "\t-n\tsort numbers\n" \
2278 USAGE_SORT_BIG( \
2279 "\t-o\toutput to file\n" \
2280 "\t-k\tsort by key\n" \
2281 "\t-t\tuse key separator other than whitespace\n" \
2282 ) \
2283 "\t-r\treverse sort order\n" \
2284 USAGE_SORT_BIG("\t-s\tstable (don't sort ties alphabetically)\n") \
2285 "\t-u\tsuppress duplicate lines" \
2286 USAGE_SORT_BIG("\n\t-z\tinput terminated by nulls, not newlines\n") \
2287 USAGE_SORT_BIG("\t-mST\tignored for GNU compatability") \
2288 ""
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002289#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002290 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002291 "a\n" \
2292 "b\n" \
2293 "c\n" \
2294 "d\n" \
2295 "e\n" \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002296 "f\n" \
2297 USAGE_SORT_BIG( \
2298 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
2299 "d 2\n" \
2300 "b 2\n" \
2301 "c 3\n" \
2302 ) \
2303 ""
2304
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002305
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002306#define start_stop_daemon_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00002307 "[OPTIONS] [--start|--stop] ... [-- arguments...]\n"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002308#define start_stop_daemon_full_usage \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002309 "Program to start and stop services."\
2310 "\n\nOptions:"\
2311 "\n\t-S|--start\t\t\tstart"\
2312 "\n\t-K|--stop\t\t\tstop"\
Eric Andersena151d192004-04-06 17:16:36 +00002313 "\n\t-a|--startas <pathname>\t\tstarts process specified by pathname"\
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002314 "\n\t-b|--background\t\t\tforce process into background"\
2315 "\n\t-u|--user <username>|<uid>\tstop this user's processes"\
Eric Andersena151d192004-04-06 17:16:36 +00002316 "\n\t-x|--exec <executable>\t\tprogram to either start or check"\
Eric Andersen625da9d2004-04-13 18:28:46 +00002317 "\n\t-m|--make-pidfile <filename>\tcreate the -p file and enter pid in it"\
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002318 "\n\t-n|--name <process-name>\tstop processes with this name"\
2319 "\n\t-p|--pidfile <pid-file>\t\tsave or load pid using a pid-file"\
2320 "\n\t-q|--quiet\t\t\tbe quiet" \
Eric Andersen178de172004-04-06 16:36:20 +00002321 "\n\t-s|--signal <signal>\t\tsignal to send (default TERM)"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002322
Eric Andersenef5e8f82002-11-07 02:09:37 +00002323#define strings_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002324 "[-afo] [-n length] [file ... ]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002325#define strings_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002326 "Display printable strings in a binary file." \
2327 "\n\nOptions:" \
Glenn L McGrath85396672004-07-21 12:25:55 +00002328 "\n\t-a\tScan the whole files (this is the default)."\
Eric Andersen178de172004-04-06 16:36:20 +00002329 "\n\t-f\tPrecede each string with the name of the file where it was found." \
2330 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
2331 "\n\t-o\tEach string is preceded by its decimal offset in the file."
Eric Andersenef5e8f82002-11-07 02:09:37 +00002332
Eric Andersen7e9276b2001-02-22 01:15:47 +00002333#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002334 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002335#define stty_full_usage \
2336 "Without arguments, prints baud rate, line discipline," \
2337 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002338 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00002339 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002340 "\n\t-a\t\tprint all current settings in human-readable form" \
2341 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00002342 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002343
Robert Griebl1fca5582002-06-04 20:45:46 +00002344#define su_trivial_usage \
2345 "[OPTION]... [-] [username]"
2346#define su_full_usage \
2347 "Change user id or become root.\n" \
2348 "Options:\n" \
2349 "\t-p\tPreserve environment"
2350
Eric Andersen27f64e12002-06-23 04:24:25 +00002351#define sulogin_trivial_usage \
2352 "[OPTION]... [tty-device]"
2353#define sulogin_full_usage \
2354 "Single user login\n" \
2355 "Options:\n" \
2356 "\t-f\tDo not authenticate (user already authenticated)\n" \
2357 "\t-h\tName of the remote host for this login.\n" \
2358 "\t-p\tPreserve environment."
2359
Mike Frysinger95d3c452005-04-21 23:29:24 +00002360#define sum_trivial_usage \
2361 "[rs] [files...]"
2362#define sum_full_usage \
2363 "checksum and count the blocks in a file\n\n" \
2364 "Options:\n" \
2365 "\t-r\tuse BSD sum algorithm (1K blocks)\n" \
2366 "\t-s\tuse System V sum algorithm (512byte blocks)\n"
2367
Eric Andersen7e9276b2001-02-22 01:15:47 +00002368#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002369 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002370#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002371 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002372 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002373 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002374
Eric Andersen7e9276b2001-02-22 01:15:47 +00002375#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002376 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002377#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002378 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002379 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002380 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002381
Eric Andersen7e9276b2001-02-22 01:15:47 +00002382#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002383 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002384#define sync_full_usage \
2385 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002386
Eric Andersen7e9276b2001-02-22 01:15:47 +00002387
Eric Andersen29c77f72003-10-09 09:43:18 +00002388#ifdef CONFIG_FEATURE_ROTATE_LOGFILE
2389 #define USAGE_ROTATE_LOGFILE(a) a
2390#else
Tim Riker7b253f82003-12-28 05:02:40 +00002391 #define USAGE_ROTATE_LOGFILE(a)
Eric Andersen29c77f72003-10-09 09:43:18 +00002392#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002393#ifdef CONFIG_FEATURE_REMOTE_LOG
Eric Andersen7e9276b2001-02-22 01:15:47 +00002394 #define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002395#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00002396 #define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002397#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00002398#ifdef CONFIG_FEATURE_IPC_SYSLOG
2399 #define USAGE_IPC_LOG(a) a
2400#else
2401 #define USAGE_IPC_LOG(a)
2402#endif
2403
Eric Andersenb9050282003-12-24 06:02:11 +00002404#ifdef CONFIG_SYSCTL
2405#define sysctl_trivial_usage \
2406 "[OPTIONS]... [VALUE]...\n"
2407#define sysctl_full_usage
2408 "sysctl - configure kernel parameters at runtime\n\n" \
2409 "Options:\n" \
2410 "\t-n\tUse this option to disable printing of the key name when printing values.\n" \
Eric Andersenb9050282003-12-24 06:02:11 +00002411 "\t-w\tUse this option when you want to change a sysctl setting.\n" \
2412 "\t-p\tLoad in sysctl settings from the file specified or /etc/sysctl.conf if none given.\n" \
2413 "\t-a\tDisplay all values currently available.\n" \
2414 "\t-A\tDisplay all values currently available in table form."
Eric Andersenb9050282003-12-24 06:02:11 +00002415#define sysctl_example_usage
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002416 "sysctl [-n] variable ...\n" \
2417 "sysctl [-n] -w variable=value ...\n" \
2418 "sysctl [-n] -a\n" \
2419 "sysctl [-n] -p <file>\t(default /etc/sysctl.conf)\n" \
2420 "sysctl [-n] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00002421#endif
2422
Eric Andersen7e9276b2001-02-22 01:15:47 +00002423#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002424 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002425#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002426 "Linux system and kernel logging utility.\n" \
2427 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002428 "Options:\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002429 "\t-m MIN\t\tMinutes between MARK lines (default=20, 0=off)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002430 "\t-n\t\tRun as a foreground process\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002431 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)\n" \
2432 "\t-S\t\tMake logging output smaller." \
Eric Andersen29c77f72003-10-09 09:43:18 +00002433 USAGE_ROTATE_LOGFILE( \
Eric Andersen178de172004-04-06 16:36:20 +00002434 "\n\t-s SIZE\t\tMax size (KB) before rotate (default=200KB, 0=off)\n" \
2435 "\t-b NUM\t\tNumber of rotated logs to keep (default=1, max=99, 0=purge)") \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002436 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00002437 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00002438 "\t-L\t\tLog locally and via network logging (default is network only)") \
2439 USAGE_IPC_LOG( \
Eric Andersend4a5e252003-12-19 11:32:14 +00002440 "\n\t-C [size(KiB)]\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002441#define syslogd_example_usage \
2442 "$ syslogd -R masterlog:514\n" \
2443 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002444
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002445
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002446#ifndef CONFIG_FEATURE_FANCY_TAIL
Eric Andersen7e9276b2001-02-22 01:15:47 +00002447 #define USAGE_UNSIMPLE_TAIL(a)
2448#else
2449 #define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002450#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002451#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002452 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002453#define tail_full_usage \
2454 "Print last 10 lines of each FILE to standard output.\n" \
2455 "With more than one FILE, precede each with a header giving the\n" \
2456 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
2457 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002458 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002459 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
2460 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002461 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002462 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
2463 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002464 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002465 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002466 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
2467#define tail_example_usage \
2468 "$ tail -n 1 /etc/resolv.conf\n" \
2469 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002470
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002471#ifdef CONFIG_FEATURE_TAR_CREATE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002472 #define USAGE_TAR_CREATE(a) a
2473#else
2474 #define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002475#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002476#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002477 #define USAGE_TAR_EXCLUDE(a) a
2478#else
2479 #define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002480#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002481#ifdef CONFIG_FEATURE_TAR_GZIP
2482 #define USAGE_TAR_GZIP(a) a
2483#else
2484 #define USAGE_TAR_GZIP(a)
2485#endif
2486#ifdef CONFIG_FEATURE_TAR_BZIP2
2487 #define USAGE_TAR_BZIP2(a) a
2488#else
2489 #define USAGE_TAR_BZIP2(a)
2490#endif
Glenn L McGrath7370f622003-11-18 21:49:23 +00002491#ifdef CONFIG_FEATURE_TAR_COMPRESS
2492 #define USAGE_TAR_COMPRESS(a) a
2493#else
2494 #define USAGE_TAR_COMPRESS(a)
2495#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002496
Eric Andersen7e9276b2001-02-22 01:15:47 +00002497#define tar_trivial_usage \
Glenn L McGrath7370f622003-11-18 21:49:23 +00002498 "-[" USAGE_TAR_CREATE("c") USAGE_TAR_GZIP("z") USAGE_TAR_BZIP2("j") USAGE_TAR_COMPRESS("Z") "xtvO] " \
Glenn L McGrathce91c8a2003-12-26 14:01:37 +00002499 USAGE_TAR_EXCLUDE("[-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00002500 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002501#define tar_full_usage \
2502 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00002503 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002504 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002505 "\tx\t\textract\n" \
2506 "\tt\t\tlist\n" \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002507 "\nArchive format selection:\n" \
2508 USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
2509 USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
Glenn L McGrath0c5d9c22003-11-18 23:27:49 +00002510 USAGE_TAR_COMPRESS("\tZ\t\tFilter the archive through compress\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002511 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002512 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002513 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002514 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002515 "\texclude\t\tfile to exclude\n" \
2516 "\tX\t\tfile with names to exclude\n" \
2517 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00002518 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002519 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002520#define tar_example_usage \
2521 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
2522 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002523
Eric Andersen7e9276b2001-02-22 01:15:47 +00002524#define tee_trivial_usage \
2525 "[OPTION]... [FILE]..."
2526#define tee_full_usage \
2527 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002528 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002529 "\t-a\tappend to the given FILEs, do not overwrite\n" \
2530 "\t-i\tignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002531#define tee_example_usage \
2532 "$ echo "Hello" | tee /tmp/foo\n" \
2533 "$ cat /tmp/foo\n" \
2534 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002535
Eric Andersen539ffc92004-02-22 12:25:47 +00002536#ifdef CONFIG_FEATURE_TELNET_AUTOLOGIN
2537#define telnet_trivial_usage \
2538 "[-a] [-l USER] HOST [PORT]"
2539#define telnet_full_usage \
2540 "Telnet is used to establish interactive communication with another\n" \
2541 "computer over a network using the TELNET protocol.\n\n" \
2542 "Options:\n" \
2543 "\t-a\t\tAttempt an automatic login with the USER variable.\n" \
2544 "\t-l USER\t\tAttempt an automatic login with the USER argument.\n" \
2545 "\tHOST\t\tThe official name, alias or the IP address of the\n" \
2546 "\t\t\tremote host.\n" \
2547 "\tPORT\t\tThe remote port number to connect to. If it is not\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002548 "\t\t\tspecified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00002549#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00002550#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002551 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002552#define telnet_full_usage \
2553 "Telnet is used to establish interactive communication with another\n"\
2554 "computer over a network using the TELNET protocol."
Eric Andersen539ffc92004-02-22 12:25:47 +00002555#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002556
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002557#ifdef CONFIG_FEATURE_TELNETD_INETD
2558#define telnetd_trivial_usage \
2559 "(inetd mode) [OPTION]"
2560#define telnetd_full_usage \
2561 "Telnetd uses incoming TELNET connections via inetd.\n"\
2562 "Options:\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002563 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)\n" \
2564 "\t-f issue_file\tDisplay issue_file instead of /etc/issue."
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002565#else
Eric Andersen08a72202002-09-30 20:52:10 +00002566#define telnetd_trivial_usage \
2567 "[OPTION]"
2568#define telnetd_full_usage \
2569 "Telnetd listens for incoming TELNET connections on PORT.\n"\
2570 "Options:\n" \
2571 "\t-p PORT\tlisten for connections on PORT (default 23)\n"\
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002572 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)\n"\
2573 "\t-f issue_file\tDisplay issue_file instead of /etc/issue."
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002574#endif
Eric Andersen08a72202002-09-30 20:52:10 +00002575
Eric Andersen7e9276b2001-02-22 01:15:47 +00002576#define test_trivial_usage \
2577 "EXPRESSION\n or [ EXPRESSION ]"
2578#define test_full_usage \
2579 "Checks file types and compares values returning an exit\n" \
2580 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002581#define test_example_usage \
2582 "$ test 1 -eq 2\n" \
2583 "$ echo $?\n" \
2584 "1\n" \
2585 "$ test 1 -eq 1\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002586 "$ echo $?\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002587 "0\n" \
2588 "$ [ -d /etc ]\n" \
2589 "$ echo $?\n" \
2590 "0\n" \
2591 "$ [ -d /junk ]\n" \
2592 "$ echo $?\n" \
2593 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002594
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002595#ifdef CONFIG_FEATURE_TFTP_GET
Mark Whitley450736c2001-03-02 19:08:50 +00002596 #define USAGE_TFTP_GET(a) a
2597#else
2598 #define USAGE_TFTP_GET(a)
2599#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002600#ifdef CONFIG_FEATURE_TFTP_PUT
Mark Whitley450736c2001-03-02 19:08:50 +00002601 #define USAGE_TFTP_PUT(a) a
2602#else
2603 #define USAGE_TFTP_PUT(a)
2604#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002605#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Glenn L McGrathad117d82001-10-05 04:40:37 +00002606 #define USAGE_TFTP_BS(a) a
2607#else
2608 #define USAGE_TFTP_BS(a)
2609#endif
Mark Whitley450736c2001-03-02 19:08:50 +00002610
2611#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00002612 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00002613#define tftp_full_usage \
2614 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00002615 "Options:\n" \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002616 "\t-l FILE\tLocal FILE.\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002617 "\t-r FILE\tRemote FILE." \
Mark Whitley450736c2001-03-02 19:08:50 +00002618 USAGE_TFTP_GET( \
Eric Andersen178de172004-04-06 16:36:20 +00002619 "\n\t-g\tGet file." \
Mark Whitley450736c2001-03-02 19:08:50 +00002620 ) \
2621 USAGE_TFTP_PUT( \
Eric Andersen178de172004-04-06 16:36:20 +00002622 "\n\t-p\tPut file." \
Mark Whitley450736c2001-03-02 19:08:50 +00002623 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002624 USAGE_TFTP_BS( \
Eric Andersen178de172004-04-06 16:36:20 +00002625 "\n\t-b SIZE\tTransfer blocks of SIZE octets." \
Tim Riker7b253f82003-12-28 05:02:40 +00002626 )
Eric Andersenc3657422001-11-30 07:54:32 +00002627#define time_trivial_usage \
2628 "[OPTION]... COMMAND [ARGS...]"
2629#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00002630 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
2631 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00002632 "Options:\n" \
2633 "\t-v\tDisplays verbose resource usage information."
Mark Whitley450736c2001-03-02 19:08:50 +00002634
Eric Andersen420b2082002-09-17 22:14:58 +00002635#define top_trivial_usage \
2636 "[-d <seconds>]"
2637#define top_full_usage \
2638 "top provides an view of processor activity in real time.\n" \
2639 "This utility reads the status for all processes in /proc each <seconds>\n" \
2640 "and shows the status for however many processes will fit on the screen.\n" \
2641 "This utility will not show processes that are started after program startup,\n" \
2642 "but it will show the EXIT status for and PIDs that exit while it is running."
2643
Eric Andersen7e9276b2001-02-22 01:15:47 +00002644#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002645 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002646#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002647 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002648 "Options:\n" \
2649 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002650#define touch_example_usage \
2651 "$ ls -l /tmp/foo\n" \
2652 "/bin/ls: /tmp/foo: No such file or directory\n" \
2653 "$ touch /tmp/foo\n" \
2654 "$ ls -l /tmp/foo\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002655 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002656
2657#define tr_trivial_usage \
2658 "[-cds] STRING1 [STRING2]"
2659#define tr_full_usage \
2660 "Translate, squeeze, and/or delete characters from\n" \
2661 "standard input, writing to standard output.\n\n" \
2662 "Options:\n" \
2663 "\t-c\ttake complement of STRING1\n" \
2664 "\t-d\tdelete input characters coded STRING1\n" \
2665 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002666#define tr_example_usage \
2667 "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002668 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002669
Eric Andersen5c58d282001-07-10 16:29:00 +00002670#define traceroute_trivial_usage \
Eric Andersen15c03c32004-04-06 17:52:02 +00002671 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n"\
2672 "\t[-s src_addr] [-t tos] [-w wait] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00002673#define traceroute_full_usage \
2674 "trace the route ip packets follow going to \"host\"\n" \
2675 "Options:\n" \
2676 "\t-d\tset SO_DEBUG options to socket\n" \
2677 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
2678 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
2679 "\t-v\tVerbose output\n" \
2680 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
2681 "\t-p port#\tSet the base UDP port number used in probes\n" \
2682 "\t\t(default is 33434)\n" \
2683 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
2684 "\t\t(default is 3)\n" \
2685 "\t-s src_addr\tUse the following IP address as the source address\n" \
2686 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
2687 "\t\t(default 0)\n" \
2688 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
2689 "\t\t(default 3 sec.)."
2690
2691
Eric Andersen7e9276b2001-02-22 01:15:47 +00002692#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002693 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002694#define true_full_usage \
2695 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002696#define true_example_usage \
2697 "$ true\n" \
2698 "$ echo $?\n" \
2699 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002700
Eric Andersen7e9276b2001-02-22 01:15:47 +00002701#define tty_trivial_usage \
2702 ""
2703#define tty_full_usage \
2704 "Print the file name of the terminal connected to standard input.\n\n"\
2705 "Options:\n" \
2706 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002707#define tty_example_usage \
2708 "$ tty\n" \
2709 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002710
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002711#define udhcpc_trivial_usage \
Russ Dill61fb4892002-10-14 21:41:28 +00002712 "[-fbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002713#define udhcpc_full_usage \
2714 "\t-c,\t--clientid=CLIENTID\tClient identifier\n" \
2715 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00002716 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002717 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00002718 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated.\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002719 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
2720 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated.\n" \
2721 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
2722 "\t-q,\t--quit\tQuit after obtaining lease\n" \
2723 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
2724 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
2725 "\t-v,\t--version\tDisplay version"
2726
Russ Dill61fb4892002-10-14 21:41:28 +00002727#define udhcpd_trivial_usage \
2728 "[configfile]\n" \
2729
2730#define udhcpd_full_usage \
Glenn L McGrath9130c852002-12-12 12:56:18 +00002731 ""
Russ Dill61fb4892002-10-14 21:41:28 +00002732
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002733#ifdef CONFIG_FEATURE_MOUNT_FORCE
Eric Andersen7e9276b2001-02-22 01:15:47 +00002734 #define USAGE_MOUNT_FORCE(a) a
2735#else
2736 #define USAGE_MOUNT_FORCE(a)
2737#endif
2738#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002739 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002740#define umount_full_usage \
2741 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00002742 "\nFlags:\n" "\t-a\tUnmount all file systems" \
2743 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
2744 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00002745 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00002746 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 +00002747#define umount_example_usage \
2748 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002749
2750#define uname_trivial_usage \
2751 "[OPTION]..."
2752#define uname_full_usage \
2753 "Print certain system information. With no OPTION, same as -s.\n\n" \
2754 "Options:\n" \
2755 "\t-a\tprint all information\n" \
2756 "\t-m\tthe machine (hardware) type\n" \
2757 "\t-n\tprint the machine's network node hostname\n" \
2758 "\t-r\tprint the operating system release\n" \
2759 "\t-s\tprint the operating system name\n" \
2760 "\t-p\tprint the host processor type\n" \
2761 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002762#define uname_example_usage \
2763 "$ uname -a\n" \
Eric Andersen7f48a952003-12-28 05:06:56 +00002764 "Linux debian 2.4.23 #2 Tue Dec 23 17:09:10 MST 2003 i686 GNU/Linux\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002765
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00002766#define uncompress_trivial_usage \
2767 "[-c] [-f] [ name ... ]"
2768#define uncompress_full_usage \
2769 "Uncompress .Z file[s]\n" \
2770 "Options:\n" \
2771 "\t-c\textract to stdout\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002772 "\t-f\tforce overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00002773
Eric Andersen7e9276b2001-02-22 01:15:47 +00002774#define uniq_trivial_usage \
2775 "[OPTION]... [INPUT [OUTPUT]]"
2776#define uniq_full_usage \
2777 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00002778 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002779 "Options:\n" \
2780 "\t-c\tprefix lines by the number of occurrences\n" \
2781 "\t-d\tonly print duplicate lines\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002782 "\t-u\tonly print unique lines\n" \
2783 "\t-f N\tskip the first N fields\n" \
2784 "\t-s N\tskip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002785#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002786 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002787 "a\n" \
2788 "b\n" \
2789 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002790
2791#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002792 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002793#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002794 "Converts FILE from unix format to dos format. When no option\n" \
2795 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002796 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002797 "Options:\n" \
2798 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00002799 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002800
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002801#define unzip_trivial_usage \
2802 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
2803#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002804 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00002805 "Options:\n" \
2806 "\t-l\tlist archive contents (short form)\n" \
2807 "\t-n\tnever overwrite existing files (default)\n" \
2808 "\t-o\toverwrite files without prompting\n" \
2809 "\t-p\tsend output to stdout\n" \
2810 "\t-q\tbe quiet\n" \
2811 "\t-x\texclude these files\n" \
2812 "\t-d\textract files into this directory"
2813
Eric Andersen7e9276b2001-02-22 01:15:47 +00002814#define uptime_trivial_usage \
2815 ""
2816#define uptime_full_usage \
2817 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002818#define uptime_example_usage \
2819 "$ uptime\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002820 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002821
2822#define usleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002823 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002824#define usleep_full_usage \
2825 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002826#define usleep_example_usage \
2827 "$ usleep 1000000\n" \
2828 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002829
2830#define uudecode_trivial_usage \
2831 "[FILE]..."
2832#define uudecode_full_usage \
2833 "Uudecode a file that is uuencoded.\n\n" \
2834 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002835 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002836#define uudecode_example_usage \
2837 "$ uudecode -o busybox busybox.uu\n" \
2838 "$ ls -l busybox\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002839 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002840
2841#define uuencode_trivial_usage \
2842 "[OPTION] [INFILE] REMOTEFILE"
2843#define uuencode_full_usage \
2844 "Uuencode a file.\n\n" \
2845 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00002846 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002847#define uuencode_example_usage \
2848 "$ uuencode busybox busybox\n" \
2849 "begin 755 busybox\n" \
2850 "<encoded file snipped>\n" \
2851 "$ uudecode busybox busybox > busybox.uu\n" \
2852 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002853
Eric Andersen853c4942003-01-23 05:59:32 +00002854#define vconfig_trivial_usage \
2855 "COMMAND [OPTIONS] ..."
Eric Andersen853c4942003-01-23 05:59:32 +00002856#define vconfig_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002857 "vconfig lets you create and remove virtual ethernet devices.\n\n" \
2858 "Options:\n" \
2859 "\tadd [interface-name] [vlan_id]\n" \
2860 "\trem [vlan-name]\n" \
2861 "\tset_flag [interface-name] [flag-num] [0 | 1]\n" \
2862 "\tset_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
2863 "\tset_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
2864 "\tset_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00002865
Eric Andersen3f980402001-04-04 17:31:15 +00002866#define vi_trivial_usage \
2867 "[OPTION] [FILE]..."
2868#define vi_full_usage \
2869 "edit FILE.\n\n" \
2870 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002871 "\t-R\tRead-only- do not write to the file."
Eric Andersen3f980402001-04-04 17:31:15 +00002872
Eric Andersen27f64e12002-06-23 04:24:25 +00002873#define vlock_trivial_usage \
2874 "[OPTIONS]"
2875#define vlock_full_usage \
2876 "Lock a virtual terminal. A password is required to unlock\n" \
2877 "Options:\n" \
2878 "\t-a\tLock all VTs"
2879
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002880#define watch_trivial_usage \
2881 "[-n <seconds>] COMMAND..."
2882#define watch_full_usage \
2883 "Executes a program periodically.\n" \
2884 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002885 "\t-n\tLoop period in seconds - default is 2."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002886#define watch_example_usage \
2887 "$ watch date\n" \
2888 "Mon Dec 17 10:31:40 GMT 2000\n" \
2889 "Mon Dec 17 10:31:42 GMT 2000\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002890 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00002891
Eric Andersen7e9276b2001-02-22 01:15:47 +00002892#define watchdog_trivial_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00002893 "[-t <seconds>] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002894#define watchdog_full_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00002895 "Periodically write to watchdog device DEV.\n" \
2896 "Options:\n" \
2897 "\t-t\tTimer period in seconds - default is 30."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002898
2899#define wc_trivial_usage \
2900 "[OPTION]... [FILE]..."
2901#define wc_full_usage \
2902 "Print line, word, and byte counts for each FILE, and a total line if\n" \
2903 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
2904 "Options:\n" \
2905 "\t-c\tprint the byte counts\n" \
2906 "\t-l\tprint the newline counts\n" \
2907 "\t-L\tprint the length of the longest line\n" \
2908 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002909#define wc_example_usage \
2910 "$ wc /etc/passwd\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002911 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002912
2913#define wget_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002914 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00002915 "\t\t[--header 'header: value'] [-Y|--proxy on/off] [-P DIR] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002916#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00002917 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002918 "Options:\n" \
2919 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00002920 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00002921 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00002922 "\t-O\tsave to filename ('-' for stdout)\n" \
2923 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002924
2925#define which_trivial_usage \
2926 "[COMMAND ...]"
2927#define which_full_usage \
2928 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002929#define which_example_usage \
2930 "$ which login\n" \
2931 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00002932
Eric Andersen00a6a752002-04-26 23:53:10 +00002933#define who_trivial_usage \
2934 " "
2935#define who_full_usage \
2936 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002937
2938#define whoami_trivial_usage \
2939 ""
2940#define whoami_full_usage \
2941 "Prints the user name associated with the current effective user id."
2942
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002943#ifdef CONFIG_FEATURE_XARGS_SUPPORT_CONFIRMATION
2944#define USAGE_XARGS_CONFIRMATION(a) a
2945#else
2946#define USAGE_XARGS_CONFIRMATION(a)
2947#endif
2948#ifdef CONFIG_FEATURE_XARGS_SUPPORT_TERMOPT
2949#define USAGE_XARGS_TERMOPT(a) a
2950#else
2951#define USAGE_XARGS_TERMOPT(a)
2952#endif
2953#ifdef CONFIG_FEATURE_XARGS_SUPPORT_ZERO_TERM
2954#define USAGE_XARGS_ZERO_TERM(a) a
2955#else
2956#define USAGE_XARGS_ZERO_TERM(a)
2957#endif
2958
2959
Eric Andersen7e9276b2001-02-22 01:15:47 +00002960#define xargs_trivial_usage \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002961 "[COMMAND] [OPTIONS] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002962#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002963 "Executes COMMAND on every item given by standard input.\n\n" \
2964 "Options:\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002965 USAGE_XARGS_CONFIRMATION("\t-p\tPrompt the user about whether to run each command\n") \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002966 "\t-r\tDo not run command for empty readed lines\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00002967 USAGE_XARGS_TERMOPT("\t-x\tExit if the size is exceeded\n") \
2968 USAGE_XARGS_ZERO_TERM("\t-0\tInput filenames are terminated by a null character\n") \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00002969 "\t-t\tPrint the command line on stderr before executing it."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002970#define xargs_example_usage \
2971 "$ ls | xargs gzip\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002972 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002973
2974#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002975 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002976#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002977 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002978
Eric Andersen7e9276b2001-02-22 01:15:47 +00002979#define zcat_trivial_usage \
2980 "FILE"
2981#define zcat_full_usage \
2982 "Uncompress to stdout."
Eric Andersen178de172004-04-06 16:36:20 +00002983
2984#endif /* __BB_USAGE_H__ */