blob: 9227025b28053c9a0f84424c33e9d49d707044d8 [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 \
Mike Frysinger058e7402005-04-23 07:00:33 +000049 "[-fqbDUA] [-c count] [-w timeout] [-I device] [-s sender] target"
Glenn L McGrath9e598412003-01-09 10:06:01 +000050#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" \
Mike Frysinger058e7402005-04-23 07:00:33 +000067 "or: ash -c command [args]..."
Eric Andersen08f59e32004-03-12 22:07:10 +000068#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 \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000106 "[-jy] [[month] year]"
Eric Andersenc98c0622001-12-06 15:16:43 +0000107#define cal_full_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000108 "Display a calendar.\n" \
109 "\nOptions:\n" \
110 "\t-j\tUse julian dates\n" \
111 "\t-y\tDisplay the entire year"
Eric Andersenc98c0622001-12-06 15:16:43 +0000112
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" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000145 "\t-v\tset the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000146
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" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000152 "\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" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000166 "\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" \
Mike Frysinger058e7402005-04-23 07:00:33 +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 \
Mike Frysinger4d149202005-05-12 22:36:07 +0000219 "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" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000222 "\t\t for all differing bytes\n" \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000223 "\t-s\tquiet mode - do not print"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000224
Rob Landley2acfd7b2005-05-11 23:12:49 +0000225#define comm_trivial_usage \
226 "[-123] FILE1 FILE2"
227#define comm_full_usage \
Mike Frysinger4d149202005-05-12 22:36:07 +0000228 "Compares FILE1 to FILE2, or to stdin if = is specified.\n\n" \
Rob Landley2acfd7b2005-05-11 23:12:49 +0000229 "Options:\n" \
230 "\t-1\tSuppress lines unique to FILE1\n" \
231 "\t-2\tSuppress lines unique to FILE2\n" \
232 "\t-3\tSuppress lines common to both files"
233
Paul Fox79c142d2005-08-01 16:04:40 +0000234#define bbconfig_trivial_usage \
235 ""
236#define bbconfig_full_usage \
237 "Print the config file which built busybox\n"
238
Eric Andersen7e9276b2001-02-22 01:15:47 +0000239#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000240 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000241#define cp_full_usage \
242 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
243 "\n" \
244 "\t-a\tSame as -dpR\n" \
Mike Frysinger6077d902005-01-07 00:56:47 +0000245 "\t-d,-P\tPreserves links\n" \
Mike Frysinger2ed05ab2005-04-14 02:52:50 +0000246 "\t-H,-L\tDereference all symlinks (implied by default)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000247 "\t-p\tPreserves file attributes if possible\n" \
248 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersenced97052004-02-20 09:55:37 +0000249 "\t-i\tinteractive, prompt before overwrite\n" \
250 "\t-R,-r\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000251
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000252#define cpio_trivial_usage \
253 "-[dimtuv][F cpiofile]"
254#define cpio_full_usage \
255 "Extract or list files from a cpio archive\n" \
256 "Main operation mode:\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000257 "\td\t\tmake leading directories\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000258 "\ti\t\textract\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000259 "\tm\t\tpreserve mtime\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000260 "\tt\t\tlist\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000261 "\tv\t\tverbose\n" \
Eric Andersen6925d502001-12-16 09:23:09 +0000262 "\tu\t\tunconditional overwrite\n" \
263 "\tF\t\tinput from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000264
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000265#define crond_trivial_usage \
266 "-d[#] -c <crondir> -f -b"
267#define crond_full_usage \
268 "\t-d [#] -l [#] -S -L logfile -f -b -c dir\n" \
269 "\t-d num\tdebug level\n" \
270 "\t-l num\tlog level (8 - default)\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +0000271 "\t-S\tlog to syslogd (default)\n" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000272 "\t-L file\tlog to file\n" \
273 "\t-f\trun in fordeground\n" \
274 "\t-b\trun in background (default)\n" \
275 "\t-c dir\tworking dir"
276
277#define crontab_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000278 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000279#define crontab_full_usage \
280 "\tfile <opts> replace crontab from file\n" \
281 "\t- <opts> replace crontab from stdin\n" \
282 "\t-u user specify user\n" \
283 "\t-l [user] list crontab for user\n" \
284 "\t-e [user] edit crontab for user\n" \
285 "\t-d [user] delete crontab for user\n" \
286 "\t-c dir specify crontab directory"
287
288
Eric Andersen7e9276b2001-02-22 01:15:47 +0000289#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000290 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000291#define cut_full_usage \
292 "Prints selected fields from each input FILE to standard output.\n\n" \
293 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000294 "\t-b LIST\t\tOutput only bytes from LIST\n" \
295 "\t-c LIST\t\tOutput only characters from LIST\n" \
296 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
297 "\t-s\t\tOutput only the lines containing delimiter\n" \
298 "\t-f N\t\tPrint only these fields\n" \
299 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000300#define cut_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +0000301 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000302 "Hello\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000303 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000304 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000305
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000306#ifdef CONFIG_FEATURE_DATE_ISOFMT
307#define USAGE_DATE_ISOFMT(a) a
308#else
309#define USAGE_DATE_ISOFMT(a)
310#endif
311
Eric Andersen7e9276b2001-02-22 01:15:47 +0000312#define date_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +0000313 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000314#define date_full_usage \
315 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000316 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000317 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000318 "\t-d STRING\tDisplays time described by STRING, not `now'\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000319 USAGE_DATE_ISOFMT("\t-I[TIMESPEC]\tOutputs an ISO-8601 compliant date/time string\n" \
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000320 "\t\t\tTIMESPEC=`date' (or missing) for date only,\n" \
321 "\t\t\t`hours', `minutes', or `seconds' for date and,\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000322 "\t\t\ttime to the indicated precision\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000323 "\t-s\t\tSets time described by STRING\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000324 "\t-r FILE\t\tDisplays the last modification time of FILE\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000325 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000326#define date_example_usage \
327 "$ date\n" \
328 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000329
Eric Andersen7e9276b2001-02-22 01:15:47 +0000330#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000331 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000332#define dc_full_usage \
333 "This is a Tiny RPN calculator that understands the\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000334 "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \
Eric Andersena9287742003-10-22 11:24:39 +0000335 "**, exp, and, or, not, eor.\n" \
336 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16.\n" \
337 "\nOptions:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000338 "p - Prints the value on the top of the stack, without altering the stack\n" \
339 "f - Prints the entire contents of the stack without altering anything\n" \
340 "o - Pops the value off the top of the stack and uses it to set the output radix\n" \
341 " Only 10 and 16 are supported"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000342#define dc_example_usage \
Eric Andersen9ab46572004-08-18 17:57:16 +0000343 "$ dc 2 2 + p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000344 "4\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000345 "$ dc 8 8 \\* 2 2 + / p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000346 "16\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000347 "$ dc 0 1 and p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000348 "0\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000349 "$ dc 0 1 or p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000350 "1\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000351 "$ echo 72 9 div 8 mul p | dc\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000352 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000353
Eric Andersen7e9276b2001-02-22 01:15:47 +0000354#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000355 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000356 "\t [seek=N] [conv=notrunc|noerror|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000357#define dd_full_usage \
358 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000359 "\tif=FILE\t\tread from FILE instead of stdin\n" \
360 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
361 "\tbs=N\t\tread and write N bytes at a time\n" \
362 "\tcount=N\t\tcopy only N input blocks\n" \
363 "\tskip=N\t\tskip N input blocks\n" \
364 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000365 "\tconv=notrunc\tdon't truncate output file\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000366 "\tconv=noerror\tcontinue after read errors\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000367 "\tconv=sync\tpad blocks with zeros\n" \
368 "\n" \
369 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000370 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000371#define dd_example_usage \
372 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
373 "4+0 records in\n" \
374 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000375
Eric Andersen7e9276b2001-02-22 01:15:47 +0000376#define deallocvt_trivial_usage \
Glenn L McGrath17b4a202004-01-15 11:50:19 +0000377 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000378#define deallocvt_full_usage \
379 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000380
Eric Andersenf349e972001-08-21 16:18:59 +0000381#define delgroup_trivial_usage \
382 "GROUP"
383#define delgroup_full_usage \
384 "Deletes group GROUP from the system"
385
386#define deluser_trivial_usage \
387 "USER"
388#define deluser_full_usage \
389 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000390
Eric Andersenf18bd892003-12-19 11:07:59 +0000391#ifdef CONFIG_DEVFSD_FG_NP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000392# define USAGE_DEVFSD_FG_NP(a) a
Eric Andersenf18bd892003-12-19 11:07:59 +0000393#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000394# define USAGE_DEVFSD_FG_NP(a)
Eric Andersenf18bd892003-12-19 11:07:59 +0000395#endif
396
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000397#define devfsd_trivial_usage \
Mike Frysingerb8d00462005-08-17 01:20:10 +0000398 "mntpnt [-v]" \
Eric Andersenf18bd892003-12-19 11:07:59 +0000399 USAGE_DEVFSD_FG_NP("[-fg][-np]" )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000400#define devfsd_full_usage \
Mike Frysingerb8d00462005-08-17 01:20:10 +0000401 "Optional daemon for managing devfs permissions and old device name symlinks.\n" \
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000402 "\nOptions:\n" \
403 "\tmntpnt\tThe mount point where devfs is mounted.\n\n" \
404 "\t-v\tPrint the protocol version numbers for devfsd\n" \
Eric Andersenf18bd892003-12-19 11:07:59 +0000405 "\t\tand the kernel-side protocol version and exits." \
406 USAGE_DEVFSD_FG_NP( "\n\n\t-fg\tRun the daemon in the foreground.\n\n" \
407 "\t-np\tExit after parsing the configuration file\n" \
408 "\t\tand processing synthetic REGISTER events.\n" \
409 "\t\tDo not poll for events.")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000410
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000411#ifdef CONFIG_FEATURE_HUMAN_READABLE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000412# define USAGE_HUMAN_READABLE(a) a
413# define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000414#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000415# define USAGE_HUMAN_READABLE(a)
416# define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000417#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000418#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000419 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000420#define df_full_usage \
421 "Print the filesystem space used and space available.\n\n" \
422 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000423 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000424 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
425 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000426 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000427 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000428#define df_example_usage \
429 "$ df\n" \
430 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
431 "/dev/sda3 8690864 8553540 137324 98% /\n" \
432 "/dev/sda1 64216 36364 27852 57% /boot\n" \
433 "$ df /dev/sda3\n" \
434 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
435 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000436
Eric Andersen7e9276b2001-02-22 01:15:47 +0000437#define dirname_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000438 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000439#define dirname_full_usage \
440 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000441#define dirname_example_usage \
442 "$ dirname /tmp/foo\n" \
443 "/tmp\n" \
444 "$ dirname /tmp/foo/\n" \
445 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000446
Eric Andersen7e9276b2001-02-22 01:15:47 +0000447#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000448 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000449#define dmesg_full_usage \
450 "Prints or controls the kernel ring buffer\n\n" \
451 "Options:\n" \
452 "\t-c\t\tClears the ring buffer's contents after printing\n" \
453 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000454 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000455
Eric Andersen7e9276b2001-02-22 01:15:47 +0000456#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000457 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000458#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000459 "Converts FILE from dos format to unix format. When no option\n" \
460 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000461 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000462 "Options:\n" \
463 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000464 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000465
Eric Andersen7e9276b2001-02-22 01:15:47 +0000466#define dpkg_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000467 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000468#define dpkg_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000469 "dpkg is a utility to install, remove and manage Debian packages.\n\n" \
470 "Options:\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000471 "\t-i\t\tInstall the package\n" \
472 "\t-l\t\tList of installed packages\n" \
473 "\t-C\t\tConfigure an unpackaged package\n" \
474 "\t-F depends\tIgnore depency problems\n" \
475 "\t-P\t\tPurge all files of a package\n" \
476 "\t-r\t\tRemove all but the configuration files for a package\n" \
477 "\t-u\t\tUnpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000478
Eric Andersen7e9276b2001-02-22 01:15:47 +0000479#define dpkg_deb_trivial_usage \
Glenn L McGrathcbc453c2004-05-02 03:01:08 +0000480 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000481#define dpkg_deb_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000482 "Perform actions on Debian packages (.debs)\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000483 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000484 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000485 "\t-e\tExtract control files to [argument] directory\n" \
486 "\t-f\tDisplay control field name starting with [argument]\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000487 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000488 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000489#define dpkg_deb_example_usage \
490 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000491
Manuel Novoa III cad53642003-03-19 09:13:01 +0000492#ifdef CONFIG_FEATURE_DU_DEFALT_BLOCKSIZE_1K
493#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a) a
494#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a)
495#else
496#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a)
497#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a) a
498#endif
499
Eric Andersen7e9276b2001-02-22 01:15:47 +0000500#define du_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000501 "[-aHLdclsx" USAGE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000502#define du_full_usage \
503 "Summarizes disk space used for each FILE and/or directory.\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000504 "Disk space is printed in units of " \
505 USAGE_DU_DEFALT_BLOCKSIZE_1k("1024") USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k("512") \
506 " bytes.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000507 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000508 "\t-a\tshow sizes of files in addition to directories\n" \
509 "\t-H\tfollow symbolic links that are FILE command line args\n" \
510 "\t-L\tfollow all symbolic links encountered\n" \
511 "\t-d N\tlimit output to directories (and files with -a) of depth < N\n" \
512 "\t-c\toutput a grand total\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000513 "\t-l\tcount sizes many times if hard linked\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000514 "\t-s\tdisplay only a total for each argument\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000515 "\t-x\tskip directories on different filesystems\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000516 USAGE_HUMAN_READABLE( \
517 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
518 "\t-m\tprint sizes in megabytes\n" ) \
519 "\t-k\tprint sizes in kilobytes" USAGE_DU_DEFALT_BLOCKSIZE_1k("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000520#define du_example_usage \
521 "$ du\n" \
522 "16 ./CVS\n" \
523 "12 ./kernel-patches/CVS\n" \
524 "80 ./kernel-patches\n" \
525 "12 ./tests/CVS\n" \
526 "36 ./tests\n" \
527 "12 ./scripts/CVS\n" \
528 "16 ./scripts\n" \
529 "12 ./docs/CVS\n" \
530 "104 ./docs\n" \
531 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000532
Eric Andersen7e9276b2001-02-22 01:15:47 +0000533#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000534 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000535#define dumpkmap_full_usage \
536 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000537#define dumpkmap_example_usage \
538 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000539
Russ Dill61fb4892002-10-14 21:41:28 +0000540#define dumpleases_trivial_usage \
541 "[-r|-a] [-f LEASEFILE]"
542#define dumpleases_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000543 "Displays the DHCP leases granted by udhcpd.\n\n" \
544 "Options:\n" \
Russ Dill61fb4892002-10-14 21:41:28 +0000545 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +0000546 "\t-r,\t--remaining\tInterpret lease times as time remaing\n" \
547 "\t-a,\t--absolute\tInterpret lease times as expire time"
Russ Dill61fb4892002-10-14 21:41:28 +0000548
Manuel Novoa III cad53642003-03-19 09:13:01 +0000549#ifdef CONFIG_FEATURE_FANCY_ECHO
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000550# define USAGE_FANCY_ECHO(a) a
Manuel Novoa III cad53642003-03-19 09:13:01 +0000551#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000552# define USAGE_FANCY_ECHO(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +0000553#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000554
Eric Andersen7e9276b2001-02-22 01:15:47 +0000555#define echo_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000556 USAGE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000557#define echo_full_usage \
558 "Prints the specified ARGs to stdout\n\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000559 USAGE_FANCY_ECHO("Options:\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000560 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000561 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000562 "\t-E\tdisable interpretation of backslash-escaped characters")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000563#define echo_example_usage \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000564 "$ echo \"Erik is cool\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000565 "Erik is cool\n" \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000566 USAGE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000567 "Erik\n" \
568 "is\n" \
569 "cool\n" \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000570 "$ echo \"Erik\\nis\\ncool\"\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000571 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000572
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000573#define eject_trivial_usage \
574 "[-t] [DEVICE]"
575#define eject_full_usage \
576 "Eject specified DEVICE (or default /dev/cdrom).\n\n" \
577 "Options:\n" \
Rob Landley9ea88362005-05-14 00:46:18 +0000578 "\t-t\tclose tray"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000579
Eric Andersen84e229c2001-03-29 22:48:33 +0000580#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000581 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000582#define env_full_usage \
583 "Prints the current environment or runs a program after setting\n" \
584 "up the specified environment.\n\n" \
585 "Options:\n" \
586 "\t-, -i\tstart with an empty environment\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000587 "\t-u\tremove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000588
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000589#define ether_wake_trivial_usage \
590 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
591#define ether_wake_full_usage \
592 "Send a magic packet to wake up sleeping machines.\n" \
593 "MAC must be a station address (00:11:22:33:44:55) or\n" \
594 " a hostname with a known 'ethers' entry.\n\n" \
595 "Options:\n" \
596 "\t-b\t\tSend wake-up packet to the broadcast address\n" \
597 "\t-i iface\tUse interface ifname instead of the default \"eth0\"\n" \
598 "\t-p pass\tAppend the four or six byte password PW to the packet\n"
599
Eric Andersen7e9276b2001-02-22 01:15:47 +0000600#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000601 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000602#define expr_full_usage \
603 "Prints the value of EXPRESSION to standard output.\n\n" \
604 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000605 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
606 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
607 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
608 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
609 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
610 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
611 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
612 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
613 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
614 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
615 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
616 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
617 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000618 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
619 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
620 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
621 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
622 "\t or 0\n" \
623 "\tlength STRING length of STRING\n" \
624 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
625 "\t it is a keyword like `match' or an\n" \
626 "\t operator like `/'\n" \
627 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000628 "Beware that many operators need to be escaped or quoted for shells.\n" \
629 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
630 "lexicographical. Pattern matches return the string matched between \n" \
631 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
632 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000633
Mike Frysingerfa69f112005-04-17 07:24:19 +0000634#define fakeidentd_trivial_usage \
635 "[-b ip] [STRING]"
636#define fakeidentd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +0000637 "Returns a set string to auth requests\n\n" \
638 "\t-b\tBind to ip address\n" \
Mike Frysingerfa69f112005-04-17 07:24:19 +0000639 "\tSTRING\tThe ident answer string (default is nobody)"
640
Eric Andersen7e9276b2001-02-22 01:15:47 +0000641#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000642 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000643#define false_full_usage \
644 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000645#define false_example_usage \
646 "$ false\n" \
647 "$ echo $?\n" \
648 "1\n"
649
650#define fbset_trivial_usage \
651 "[options] [mode]"
652#define fbset_full_usage \
653 "Show and modify frame buffer settings"
654#define fbset_example_usage \
655 "$ fbset\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000656 "mode \"1024x768-76\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000657 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
658 "\tgeometry 1024 768 1024 768 16\n" \
659 "\ttimings 12714 128 32 16 4 128 4\n" \
660 "\taccel false\n" \
661 "\trgba 5/11,6/5,5/0,0/0\n" \
662 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000663
Eric Andersen7e9276b2001-02-22 01:15:47 +0000664#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000665 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000666#define fdflush_full_usage \
667 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000668
Eric Andersen01c3d402003-07-05 07:51:31 +0000669#define fdformat_trivial_usage \
670 "[-n] DEVICE"
671#define fdformat_full_usage \
672 "Low-level formats a floppy disk\n\n" \
673 "Options:\n" \
674 "\t-n\tDon't verify after format"
675
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000676#define fdisk_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000677 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000678#define fdisk_full_usage \
679 "Change partition table\n" \
680 "Options:\n" \
Eric Andersena151d192004-04-06 17:16:36 +0000681 "\t-l List partition table(s)\n" \
682 "\t-u Give Start and End in sector (instead of cylinder) units\n" \
683 "\t-s PARTITION Give partition size(s) in blocks\n" \
684 "\t-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000685 "\t-C CYLINDERS Set the number of cylinders\n" \
686 "\t-H HEADS Set the number of heads\n" \
687 "\t-S SECTORS Set the number of sectors\n" \
Eric Andersena151d192004-04-06 17:16:36 +0000688 "\t-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000689
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000690#ifdef CONFIG_FEATURE_FIND_TYPE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000691# define USAGE_FIND_TYPE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +0000692#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000693# define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000694#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000695#ifdef CONFIG_FEATURE_FIND_PERM
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000696# define USAGE_FIND_PERM(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +0000697#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000698# define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000699#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000700#ifdef CONFIG_FEATURE_FIND_MTIME
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000701# define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000702#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000703# define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000704#endif
Eric Andersen97d86f22003-01-23 05:27:42 +0000705#ifdef CONFIG_FEATURE_FIND_NEWER
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000706# define USAGE_FIND_NEWER(a) a
Eric Andersen97d86f22003-01-23 05:27:42 +0000707#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000708# define USAGE_FIND_NEWER(a)
Eric Andersen97d86f22003-01-23 05:27:42 +0000709#endif
710#ifdef CONFIG_FEATURE_FIND_INUM
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000711# define USAGE_FIND_INUM(a) a
Eric Andersen97d86f22003-01-23 05:27:42 +0000712#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000713# define USAGE_FIND_INUM(a)
Eric Andersen97d86f22003-01-23 05:27:42 +0000714#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000715
Eric Andersen7e9276b2001-02-22 01:15:47 +0000716#define find_trivial_usage \
717 "[PATH...] [EXPRESSION]"
718#define find_full_usage \
719 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000720 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000721 "\nEXPRESSION may consist of:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000722 "\t-follow\t\tDereference symbolic links\n" \
723 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN\n" \
724 "\t-print\t\tPrint (default and assumed)\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000725 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000726 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
727) USAGE_FIND_PERM( \
728 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
729) USAGE_FIND_MTIME( \
Eric Andersen97d86f22003-01-23 05:27:42 +0000730 "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \
731) USAGE_FIND_NEWER( \
732 "\n\t-newer FILE\tModified time is more recent than FILE's" \
733) USAGE_FIND_INUM( \
734 "\n\t-inum N\t\tFile has inode number N")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000735#define find_example_usage \
Eric Andersen75eb90f2004-03-29 08:20:08 +0000736 "$ find / -name passwd\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000737 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000738
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000739#define fold_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +0000740 "[-bsw] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000741#define fold_full_usage \
742 "Wrap input lines in each FILE (standard input by default), writing to\n" \
743 "standard output.\n\n" \
744 "Options:\n" \
745 "\t-b\tcount bytes rather than columns\n" \
746 "\t-s\tbreak at spaces\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000747 "\t-w\tuse WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000748
Eric Andersen7e9276b2001-02-22 01:15:47 +0000749#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000750 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000751#define free_full_usage \
752 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000753#define free_example_usage \
754 "$ free\n" \
755 " total used free shared buffers\n" \
756 " Mem: 257628 248724 8904 59644 93124\n" \
757 " Swap: 128516 8404 120112\n" \
758 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000759
Eric Andersen7e9276b2001-02-22 01:15:47 +0000760#define freeramdisk_trivial_usage \
761 "DEVICE"
762#define freeramdisk_full_usage \
763 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000764#define freeramdisk_example_usage \
765 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000766
767#define fsck_minix_trivial_usage \
768 "[-larvsmf] /dev/name"
769#define fsck_minix_full_usage \
770 "Performs a consistency check for MINIX filesystems.\n\n" \
771 "Options:\n" \
772 "\t-l\tLists all filenames\n" \
773 "\t-r\tPerform interactive repairs\n" \
774 "\t-a\tPerform automatic repairs\n" \
775 "\t-v\tverbose\n" \
776 "\t-s\tOutputs super-block information\n" \
777 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000778 "\t-f\tForce file system check"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000779
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000780#define ftpget_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000781 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000782#define ftpget_full_usage \
783 "Retrieve a remote file via FTP.\n\n" \
784 "Options:\n" \
785 "\t-c, --continue Continue a previous transfer\n" \
786 "\t-v, --verbose Verbose\n" \
787 "\t-u, --username Username to be used\n" \
788 "\t-p, --password Password to be used\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000789 "\t-P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000790
791#define ftpput_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000792 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000793#define ftpput_full_usage \
794 "Store a local file on a remote machine via FTP.\n\n" \
795 "Options:\n" \
796 "\t-v, --verbose Verbose\n" \
797 "\t-u, --username Username to be used\n" \
798 "\t-p, --password Password to be used\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000799 "\t-P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000800
Eric Andersen7e9276b2001-02-22 01:15:47 +0000801#define getopt_trivial_usage \
802 "[OPTIONS]..."
803#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000804 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000805 "\t-a, --alternative Allow long options starting with single -\n" \
806 "\t-l, --longoptions=longopts Long options to be recognized\n" \
807 "\t-n, --name=progname The name under which errors are reported\n" \
808 "\t-o, --options=optstring Short options to be recognized\n" \
809 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
810 "\t-Q, --quiet-output No normal output\n" \
811 "\t-s, --shell=shell Set shell quoting conventions\n" \
812 "\t-T, --test Test for getopt(1) version\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000813 "\t-u, --unquoted Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000814#define getopt_example_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000815 "$ cat getopt.test\n" \
816 "#!/bin/sh\n" \
817 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
818 " -n 'example.busybox' -- \"$@\"`\n" \
819 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000820 "eval set -- \"$GETOPT\"\n" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000821 "while true ; do\n" \
822 " case $1 in\n" \
823 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
824 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
825 " -c|--c-long)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000826 " case \"$2\" in\n" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000827 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
828 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
829 " esac ;;\n" \
830 " --) shift ; break ;;\n" \
831 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
832 " esac\n" \
833 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000834
Eric Andersenf349e972001-08-21 16:18:59 +0000835#define getty_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000836 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +0000837#define getty_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +0000838 "Opens a tty, prompts for a login name, then invokes /bin/login\n\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000839 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000840 "\t-h\t\tEnable hardware (RTS/CTS) flow control\n" \
841 "\t-i\t\tDo not display /etc/issue before running login\n" \
842 "\t-L\t\tLocal line, so do not do carrier detect\n" \
843 "\t-m\t\tGet baud rate from modem's CONNECT status message\n" \
844 "\t-w\t\tWait for a CR or LF before sending /etc/issue\n" \
845 "\t-n\t\tDo not prompt the user for a login name\n" \
846 "\t-f issue_file\tDisplay issue_file instead of /etc/issue\n" \
847 "\t-l login_app\tInvoke login_app instead of /bin/login\n" \
848 "\t-t timeout\tTerminate after timeout if no username is read\n" \
849 "\t-I initstring\tSets the init string to send before anything else\n" \
850 "\t-H login_host\tLog login_host into the utmp file as the hostname"
Eric Andersenf349e972001-08-21 16:18:59 +0000851
852
Eric Andersen7e9276b2001-02-22 01:15:47 +0000853#define grep_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000854 "[-ihHnqvs] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000855#define grep_full_usage \
856 "Search for PATTERN in each FILE or standard input.\n\n" \
857 "Options:\n" \
858 "\t-H\tprefix output lines with filename where match was found\n" \
859 "\t-h\tsuppress the prefixing filename on output\n" \
860 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000861 "\t-l\tlist names of files that match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000862 "\t-n\tprint line number with output lines\n" \
863 "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \
864 "\t-v\tselect non-matching lines\n" \
865 "\t-s\tsuppress file open/read error messages"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000866#define grep_example_usage \
867 "$ grep root /etc/passwd\n" \
868 "root:x:0:0:root:/root:/bin/bash\n" \
869 "$ grep ^[rR]oo. /etc/passwd\n" \
870 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000871
Eric Andersen7e9276b2001-02-22 01:15:47 +0000872#define gunzip_trivial_usage \
873 "[OPTION]... FILE"
874#define gunzip_full_usage \
875 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
876 "Options:\n" \
877 "\t-c\tWrite output to standard output\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000878 "\t-f\tForce read when source is a terminal\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000879 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000880#define gunzip_example_usage \
881 "$ ls -la /tmp/BusyBox*\n" \
882 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
883 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
884 "$ ls -la /tmp/BusyBox*\n" \
885 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000886
887#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000888 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000889#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000890 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000891 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000892 "Options:\n" \
893 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000894 "\t-d\tDecompress\n" \
895 "\t-f\tForce write when destination is a terminal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000896#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000897 "$ ls -la /tmp/busybox*\n" \
898 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
899 "$ gzip /tmp/busybox.tar\n" \
900 "$ ls -la /tmp/busybox*\n" \
901 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000902
903#define halt_trivial_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +0000904 "[-d<delay>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000905#define halt_full_usage \
Glenn L McGrathd2501672004-07-23 05:16:17 +0000906 "Halt the system.\n" \
907 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000908 "\t-d\t\tdelay interval for halting"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000909
Eric Andersen3443bd72003-07-22 07:30:36 +0000910#ifdef CONFIG_FEATURE_HDPARM_GET_IDENTITY
911#define USAGE_HDPARM_IDENT(a) a
912#else
913#define USAGE_HDPARM_IDENT(a)
914#endif
915
916#ifdef CONFIG_FEATURE_HDPARM_HDIO_SCAN_HWIF
917#define USAGE_SCAN_HWIF(a) a
918#else
919#define USAGE_SCAN_HWIF(a)
920#endif
921
922#ifdef CONFIG_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF
923#define USAGE_UNREGISTER_HWIF(a) a
924#else
925#define USAGE_UNREGISTER_HWIF(a)
926#endif
927
928#ifdef CONFIG_FEATURE_HDPARM_HDIO_DRIVE_RESET
929#define USAGE_DRIVE_RESET(a) a
930#else
931#define USAGE_DRIVE_RESET(a)
932#endif
933
934#ifdef CONFIG_FEATURE_HDPARM_HDIO_TRISTATE_HWIF
935#define USAGE_TRISTATE_HWIF(a) a
936#else
937#define USAGE_TRISTATE_HWIF(a)
938#endif
939
Eric Andersen0a57a792003-08-06 08:57:35 +0000940#ifdef CONFIG_FEATURE_HDPARM_HDIO_GETSET_DMA
941#define USAGE_GETSET_DMA(a) a
942#else
943#define USAGE_GETSET_DMA(a)
944#endif
945
Eric Andersen3443bd72003-07-22 07:30:36 +0000946#define hdparm_trivial_usage \
947 "[options] [device] .."
948#define hdparm_full_usage \
949 "Options:" \
Eric Andersen15c03c32004-04-06 17:52:02 +0000950 "\t-a get/set fs readahead\n" \
951 "\t-A set drive read-lookahead flag (0/1)\n" \
952 "\t-b get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
953 "\t-B set Advanced Power Management setting (1-255)\n" \
954 "\t-c get/set IDE 32-bit IO setting\n" \
955 "\t-C check IDE power mode status\n" \
956 USAGE_GETSET_DMA("\t-d get/set using_dma flag\n") \
957 "\t-D enable/disable drive defect-mgmt\n" \
958 "\t-f flush buffer cache for device on exit\n" \
959 "\t-g display drive geometry\n" \
960 "\t-h display terse usage information\n" \
961 "\t-i display drive identification\n" \
962 USAGE_HDPARM_IDENT("\t-I detailed/current information directly from drive\n") \
963 USAGE_HDPARM_IDENT("\t-Istdin similar to -I, but wants /proc/ide/" "*" "/hd?/identify as input\n") \
964 "\t-k get/set keep_settings_over_reset flag (0/1)\n" \
965 "\t-K set drive keep_features_over_reset flag (0/1)\n" \
966 "\t-L set drive doorlock (0/1) (removable harddisks only)\n" \
967 "\t-m get/set multiple sector count\n" \
968 "\t-n get/set ignore-write-errors flag (0/1)\n" \
969 "\t-p set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
970 "\t-P set drive prefetch count\n" \
971 "\t-q change next setting quietly\n" \
972 "\t-Q get/set DMA tagged-queuing depth (if supported)\n" \
973 "\t-r get/set readonly flag (DANGEROUS to set)\n" \
974 USAGE_SCAN_HWIF("\t-R register an IDE interface (DANGEROUS)\n") \
975 "\t-S set standby (spindown) timeout\n" \
976 "\t-t perform device read timings\n" \
977 "\t-T perform cache read timings\n" \
978 "\t-u get/set unmaskirq flag (0/1)\n" \
979 USAGE_UNREGISTER_HWIF("\t-U un-register an IDE interface (DANGEROUS)\n") \
980 "\t-v defaults; same as -mcudkrag for IDE drives\n" \
981 "\t-V display program version and exit immediately\n" \
982 USAGE_DRIVE_RESET("\t-w perform device reset (DANGEROUS)\n") \
983 "\t-W set drive write-caching flag (0/1) (DANGEROUS)\n" \
984 USAGE_TRISTATE_HWIF("\t-x tristate device for hotswap (0/1) (DANGEROUS)\n") \
985 "\t-X set IDE xfer mode (DANGEROUS)\n" \
986 "\t-y put IDE drive in standby mode\n" \
987 "\t-Y put IDE drive to sleep\n" \
988 "\t-Z disable Seagate auto-powersaving mode\n" \
989 "\t-z re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +0000990
Manuel Novoa III cad53642003-03-19 09:13:01 +0000991#ifdef CONFIG_FEATURE_FANCY_HEAD
992#define USAGE_FANCY_HEAD(a) a
993#else
994#define USAGE_FANCY_HEAD(a)
995#endif
996
Eric Andersen7e9276b2001-02-22 01:15:47 +0000997#define head_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000998 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000999#define head_full_usage \
1000 "Print first 10 lines of each FILE to standard output.\n" \
1001 "With more than one FILE, precede each with a header giving the\n" \
1002 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001003 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001004 "\t-n NUM\t\tPrint first NUM lines instead of first 10" \
1005 USAGE_FANCY_HEAD( \
1006 "\n\t-c NUM\t\toutput the first NUM bytes\n" \
1007 "\t-q\t\tnever output headers giving file names\n" \
1008 "\t-v\t\talways output headers giving file names" )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001009#define head_example_usage \
1010 "$ head -n 2 /etc/passwd\n" \
1011 "root:x:0:0:root:/root:/bin/bash\n" \
1012 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001013
Glenn L McGrath60281112001-11-02 11:39:46 +00001014#define hexdump_trivial_usage \
1015 "[-[bcdefnosvx]] [OPTION] FILE"
1016#define hexdump_full_usage \
1017 "The hexdump utility is a filter which displays the specified files,\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001018 "or the standard input, if no files are specified, in a user specified\n" \
Glenn L McGrath60281112001-11-02 11:39:46 +00001019 "format\n" \
1020 "\t-b\t\tOne-byte octal display\n" \
1021 "\t-c\t\tOne-byte character display\n" \
1022 "\t-d\t\tTwo-byte decimal display\n" \
1023 "\t-e FORMAT STRING\n" \
1024 "\t-f FORMAT FILE\n" \
1025 "\t-n LENGTH\tInterpret only length bytes of input\n" \
1026 "\t-o\t\tTwo-byte octal display\n" \
1027 "\t-s OFFSET\tSkip offset byte\n" \
1028 "\t-v\t\tdisplay all input data\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001029 "\t-x\t\tTwo-byte hexadecimal display"
Glenn L McGrath60281112001-11-02 11:39:46 +00001030
Eric Andersen7e9276b2001-02-22 01:15:47 +00001031#define hostid_trivial_usage \
1032 ""
1033#define hostid_full_usage \
1034 "Print out a unique 32-bit identifier for the machine."
1035
1036#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001037 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001038#define hostname_full_usage \
1039 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001040 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001041 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +00001042 "\t-s\tShort\n" \
1043 "\t-i\tAddresses for the hostname\n" \
1044 "\t-d\tDNS domain name\n" \
1045 "\t-f\tFully qualified domain name\n" \
1046 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001047#define hostname_example_usage \
1048 "$ hostname\n" \
Eric Andersen08f59e32004-03-12 22:07:10 +00001049 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001050
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001051#ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001052# define USAGE_HTTPD_BASIC_AUTH(a) a
1053# ifdef CONFIG_FEATURE_HTTPD_AUTH_MD5
1054# define USAGE_HTTPD_AUTH_MD5(a) a
1055# else
1056# define USAGE_HTTPD_AUTH_MD5(a)
1057# endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001058#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001059# define USAGE_HTTPD_BASIC_AUTH(a)
1060# define USAGE_HTTPD_AUTH_MD5(a)
Eric Andersen40520512003-07-28 09:59:05 +00001061#endif
1062#ifdef CONFIG_FEATURE_HTTPD_USAGE_FROM_INETD_ONLY
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001063# define USAGE_HTTPD_STANDALONE(a)
1064# define USAGE_HTTPD_SETUID(a)
Eric Andersen40520512003-07-28 09:59:05 +00001065#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001066# define USAGE_HTTPD_STANDALONE(a) a
1067# ifdef CONFIG_FEATURE_HTTPD_SETUID
1068# define USAGE_HTTPD_SETUID(a) a
1069# else
1070# define USAGE_HTTPD_SETUID(a)
1071# endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001072#endif
1073#define httpd_trivial_usage \
Eric Andersen40520512003-07-28 09:59:05 +00001074 "[-c <conf file>]" \
1075 USAGE_HTTPD_STANDALONE(" [-p <port>]") \
1076 USAGE_HTTPD_SETUID(" [-u user]") \
1077 USAGE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
1078 USAGE_HTTPD_AUTH_MD5(" [-m pass]") \
Eric Andersen73afd892004-04-14 17:59:21 +00001079 " [-h home]" \
Eric Andersen40520512003-07-28 09:59:05 +00001080 " [-d/-e <string>]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001081#define httpd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001082 "Listens for incoming http server requests.\n\n" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001083 "Options:\n" \
1084 "\t-c FILE\t\tSpecifies configuration file. (default httpd.conf)\n" \
1085 USAGE_HTTPD_STANDALONE("\t-p PORT\tServer port (default 80)\n") \
1086 USAGE_HTTPD_SETUID("\t-u USER\tSet uid to USER after listening privileges port\n") \
1087 USAGE_HTTPD_BASIC_AUTH("\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
1088 USAGE_HTTPD_AUTH_MD5("\t-m PASS\t\tCrypt PASS with md5 algorithm\n") \
1089 "\t-h HOME \tSpecifies http HOME directory (default ./)\n" \
1090 "\t-e STRING\tHtml encode STRING\n" \
1091 "\t-d STRING\tURL decode STRING"
Eric Andersen40520512003-07-28 09:59:05 +00001092
Robert Griebl1cd04452002-07-21 16:50:49 +00001093#define hwclock_trivial_usage \
1094 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
1095#define hwclock_full_usage \
1096 "Query and set the hardware clock (RTC)\n\n" \
1097 "Options:\n" \
1098 "\t-r\tread hardware clock and print result\n" \
1099 "\t-s\tset the system time from the hardware clock\n" \
1100 "\t-w\tset the hardware clock to the current system time\n" \
1101 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
1102 "\t-l\tthe hardware clock is kept in local time"
1103
Eric Andersen9e480452003-07-03 10:07:04 +00001104#ifdef CONFIG_SELINUX
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001105# define USAGE_SELINUX(a) a
Eric Andersen9e480452003-07-03 10:07:04 +00001106#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001107# define USAGE_SELINUX(a)
Eric Andersen9e480452003-07-03 10:07:04 +00001108#endif
1109
Eric Andersen7e9276b2001-02-22 01:15:47 +00001110#define id_trivial_usage \
1111 "[OPTIONS]... [USERNAME]"
1112#define id_full_usage \
1113 "Print information for USERNAME or the current user\n\n" \
1114 "Options:\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001115 USAGE_SELINUX("\t-c\tprints only the security context\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001116 "\t-g\tprints only the group ID\n" \
1117 "\t-u\tprints only the user ID\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001118 "\t-n\tprint a name instead of a number\n" \
1119 "\t-r\tprints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001120#define id_example_usage \
1121 "$ id\n" \
1122 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001123
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001124#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001125# define USAGE_SIOCSKEEPALIVE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001126#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001127# define USAGE_SIOCSKEEPALIVE(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001128#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001129#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001130# define USAGE_IFCONFIG_MII(a) a
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001131#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001132# define USAGE_IFCONFIG_MII(a)
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001133#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001134#ifdef CONFIG_FEATURE_IFCONFIG_HW
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001135# define USAGE_IFCONFIG_HW(a) a
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001136#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001137# define USAGE_IFCONFIG_HW(a)
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001138#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001139#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001140# define USAGE_IFCONFIG_OPT_A(a) a
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001141#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001142# define USAGE_IFCONFIG_OPT_A(a)
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001143#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +00001144#ifdef CONFIG_FEATURE_IPV6
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001145# define USAGE_IPV6(a) a
Eric Andersen51b8bd62002-07-03 11:46:38 +00001146#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001147# define USAGE_IPV6(a)
Eric Andersen51b8bd62002-07-03 11:46:38 +00001148#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001149
Eric Andersen7e9276b2001-02-22 01:15:47 +00001150#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001151 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001152#define ifconfig_full_usage \
1153 "configure a network interface\n\n" \
1154 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +00001155 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
1156 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001157 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001158 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001159 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001160 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001161 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001162 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001163 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
1164 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001165 "\t[up|down] ..."
1166
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001167#define ifup_trivial_usage \
1168 "<-ahinv> <ifaces...>"
1169#define ifup_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001170 "ifup <options> <ifaces...>\n\n" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001171 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001172 "\t-h\tthis help\n" \
1173 "\t-a\tde/configure all interfaces automatically\n" \
1174 "\t-i FILE\tuse FILE for interface definitions\n" \
1175 "\t-n\tprint out what would happen, but don't do it\n" \
1176 "\t\t\t(note that this option doesn't disable mappings)\n" \
1177 "\t-v\tprint out what would happen before doing it\n" \
1178 "\t-m\tdon't run any mappings\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001179 "\t-f\tforce de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001180
1181#define ifdown_trivial_usage \
1182 "<-ahinv> <ifaces...>"
1183#define ifdown_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001184 "ifdown <options> <ifaces...>\n\n" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001185 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001186 "\t-h\tthis help\n" \
1187 "\t-a\tde/configure all interfaces automatically\n" \
1188 "\t-i FILE\tuse FILE for interface definitions\n" \
1189 "\t-n\tprint out what would happen, but don't do it\n" \
1190 "\t\t(note that this option doesn't disable mappings)\n" \
1191 "\t-v\tprint out what would happen before doing it\n" \
1192 "\t-m\tdon't run any mappings\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001193 "\t-f\tforce de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001194
Glenn L McGrath06e95652003-02-09 06:51:14 +00001195#define inetd_trivial_usage \
Paul Foxb8317532005-08-01 19:39:47 +00001196 "[-f] [-q len] [conf]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001197#define inetd_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001198 "Listens for network connections and launches programs\n\n" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001199 "Option:\n" \
Paul Foxb8317532005-08-01 19:39:47 +00001200 "\t-f\tRun as a foreground progress\n" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001201 "\t-q\tSets the size of the socket listen queue to\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001202 "\t\tthe specified value. Default is 128"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001203
Eric Andersen7e9276b2001-02-22 01:15:47 +00001204#define init_trivial_usage \
1205 ""
1206#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001207 "Init is the parent of all processes."
1208#define init_notes_usage \
1209"This version of init is designed to be run only by the kernel.\n" \
1210"\n" \
1211"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
1212"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
1213"runlevels, use sysvinit.\n" \
1214"\n" \
1215"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
1216"it has the following default behavior:\n" \
1217"\n" \
1218" ::sysinit:/etc/init.d/rcS\n" \
1219" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001220" ::ctrlaltdel:/sbin/reboot\n" \
1221" ::shutdown:/sbin/swapoff -a\n" \
1222" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001223" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001224"\n" \
1225"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1226"\n" \
1227" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001228" tty3::askfirst:/bin/sh\n" \
1229" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001230"\n" \
1231"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1232"\n" \
1233" <id>:<runlevels>:<action>:<process>\n" \
1234"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001235" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001236"\n" \
1237" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1238" The id field is used by BusyBox init to specify the controlling tty for\n" \
1239" the specified process to run on. The contents of this field are\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001240" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001241" be unique, although if it isn't you may have strange results. If this\n" \
1242" field is left blank, the controlling tty is set to the console. Also\n" \
1243" note that if BusyBox detects that a serial console is in use, then only\n" \
1244" entries whose controlling tty is either the serial console or /dev/null\n" \
1245" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1246" stinkin' utmp.\n" \
1247"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001248" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001249"\n" \
1250" The runlevels field is completely ignored.\n" \
1251"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001252" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001253"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001254" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001255" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001256"\n" \
1257" The available actions can be classified into two groups: actions\n" \
1258" that are run only once, and actions that are re-run when the specified\n" \
1259" process exits.\n" \
1260"\n" \
1261" Run only-once actions:\n" \
1262"\n" \
1263" 'sysinit' is the first item run on boot. init waits until all\n" \
1264" sysinit actions are completed before continuing. Following the\n" \
1265" completion of all sysinit actions, all 'wait' actions are run.\n" \
1266" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001267" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001268" therefore, init does not wait for them to complete. 'restart' is\n" \
1269" the action taken to restart the init process. By default this should\n" \
1270" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1271" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001272" actions are run when the system detects that someone on the system\n" \
1273" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1274" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1275" Finally the 'shutdown' action specifies the actions to taken when\n" \
1276" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1277" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001278"\n" \
1279" Run repeatedly actions:\n" \
1280"\n" \
1281" 'respawn' actions are run after the 'once' actions. When a process\n" \
1282" started with a 'respawn' action exits, init automatically restarts\n" \
1283" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1284" respawning out of control. The 'askfirst' actions acts just like\n" \
1285" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001286" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001287" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001288" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001289"\n" \
1290" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1291" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001292" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001293"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001294" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001295"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001296" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001297"\n" \
1298"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001299"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001300" # This is run first except when booting in single-user mode.\n" \
1301" #\n" \
1302" ::sysinit:/etc/init.d/rcS\n" \
1303" \n" \
1304" # /bin/sh invocations on selected ttys\n" \
1305" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001306" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001307" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001308" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001309" tty2::askfirst:-/bin/sh\n" \
1310" tty3::askfirst:-/bin/sh\n" \
1311" tty4::askfirst:-/bin/sh\n" \
1312" \n" \
1313" # /sbin/getty invocations for selected ttys\n" \
1314" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001315" tty4::respawn:/sbin/getty 38400 tty4\n" \
1316" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001317" \n" \
1318" \n" \
1319" # Example of how to put a getty on a serial line (for a terminal)\n" \
1320" #\n" \
1321" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1322" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1323" #\n" \
1324" # Example how to put a getty on a modem line.\n" \
1325" #::respawn:/sbin/getty 57600 ttyS2\n" \
1326" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001327" # Stuff to do when restarting the init process\n" \
1328" ::restart:/sbin/init\n" \
1329" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001330" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001331" ::ctrlaltdel:/sbin/reboot\n" \
1332" ::shutdown:/bin/umount -a -r\n" \
1333" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001334
Eric Andersenbe65c352003-01-23 04:57:35 +00001335#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001336# define USAGE_INSMOD_MAP(a) a
Eric Andersenbe65c352003-01-23 04:57:35 +00001337#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001338# define USAGE_INSMOD_MAP(a)
Eric Andersenbe65c352003-01-23 04:57:35 +00001339#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001340#define insmod_trivial_usage \
1341 "[OPTION]... MODULE [symbol=value]..."
1342#define insmod_full_usage \
1343 "Loads the specified kernel modules into the kernel.\n\n" \
1344 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001345 "\t-f\tForce module to load into the wrong kernel version\n" \
1346 "\t-k\tMake module autoclean-able\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001347 "\t-v\tverbose output\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001348 "\t-q\tquiet output\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001349 "\t-L\tLock to prevent simultaneous loads of a module\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001350 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout\n") \
Eric Andersen957879a2004-04-07 15:07:55 +00001351 "\t-o NAME\tSet internal module name to NAME\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001352 "\t-x\tdo not export externs"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001353
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001354#define install_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001355 "[-cgmops] [sources] <dest|directory>"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001356#define install_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001357 "Copies files and set attributes\n\n" \
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001358 "Options:\n" \
1359 "\t-c\tcopy the file, default\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001360 "\t-d\tcreate directories\n" \
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001361 "\t-g\tset group ownership\n" \
1362 "\t-m\tset permission modes\n" \
1363 "\t-o\tset ownership\n" \
1364 "\t-p\tpreserve date\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001365 "\t-s\tstrip symbol tables"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001366
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001367#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001368 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001369#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001370 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1371 "where OBJECT := { link | addr | route | tunnel }\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001372 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001373
1374#define ipaddr_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001375 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
1376 "\t\t[ dev STRING ] [ to PREFIX ] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001377#define ipaddr_full_usage \
1378 "ipaddr {add|del} IFADDR dev STRING\n" \
1379 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001380 "\t\t\t[ to PREFIX ] [ label PATTERN ]\n" \
1381 "\t\t\tIFADDR := PREFIX | ADDR peer PREFIX\n" \
1382 "\t\t\t[ broadcast ADDR ] [ anycast ADDR ]\n" \
1383 "\t\t\t[ label STRING ] [ scope SCOPE-ID ]\n" \
1384 "\t\t\tSCOPE-ID := [ host | link | global | NUMBER ]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001385
Eric Andersen3561b012004-04-13 19:27:20 +00001386#ifdef CONFIG_FEATURE_IPCALC_FANCY
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001387# define XUSAGE_IPCALC_FANCY(a) a
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001388#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001389# define XUSAGE_IPCALC_FANCY(a)
Eric Andersen3561b012004-04-13 19:27:20 +00001390#endif
Eric Andersende4f07e2003-12-11 01:18:07 +00001391#define ipcalc_trivial_usage \
Eric Andersen3561b012004-04-13 19:27:20 +00001392 "[OPTION]... <ADDRESS>[[/]<NETMASK>] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001393#define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001394 "Calculate IP network settings from a IP address\n\n" \
1395 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001396 "\t-b\t--broadcast\tDisplay calculated broadcast address\n" \
1397 "\t-n\t--network\tDisplay calculated network address\n" \
Eric Andersen3561b012004-04-13 19:27:20 +00001398 "\t-m\t--netmask\tDisplay default netmask for IP." \
Mike Frysinger058e7402005-04-23 07:00:33 +00001399 XUSAGE_IPCALC_FANCY( \
Eric Andersen3561b012004-04-13 19:27:20 +00001400 "\n\t-p\t--prefix\tDisplay the prefix for IP/NETMASK." \
Mike Frysinger058e7402005-04-23 07:00:33 +00001401 "\t-h\t--hostname\tDisplay first resolved host name\n" \
Eric Andersen3561b012004-04-13 19:27:20 +00001402 "\t-s\t--silent\tDon't ever display error messages.")
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001403
Rob Landley6eb1e412005-06-20 04:30:36 +00001404#define ipcrm_trivial_usage \
1405 "[-[MQS] key] [-[mqs] id]"
1406#define ipcrm_full_usage \
1407 "The upper-case options MQS are used to remove a shared memory\n" \
1408 "segment by an shmkey value. The lower-case options mqs are used\n" \
1409 "to remove a segment by shmid value.\n" \
1410 "\t-m | -M\tRemove the memory segment after the last detatch\n" \
1411 "\t-q | -Q\tRemove the message queue\n" \
1412 "\t-s | -S\tRemove the semaphore\n"
1413
1414#define ipcs_trivial_usage \
1415 "[[-smq] -i shmid] | [[-asmq] [-tclup]]"
1416#define ipcs_full_usage \
1417 "\t-i\tspecify a specific resource id\n" \
1418 "Resource specification:\n" \
1419 "\t-m\tshared memory segments\n" \
1420 "\t-q\tmessage queues\n" \
1421 "\t-s\tsempahore arrays\n" \
1422 "\t-a\tall (default)\n" \
1423 "Output format:\n" \
1424 "\t-t\ttime\n" \
1425 "\t-p\tpid\n" \
1426 "\t-s\tcreator\n" \
1427 "\t-a\tlimits\n" \
1428 "\t-i\tsummary\n"
1429
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001430#define iplink_trivial_usage \
1431 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1432#define iplink_full_usage \
1433 "iplink set DEVICE { up | down | arp { on | off } |\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001434 "\t\t\tdynamic { on | off } |\n" \
1435 "\t\t\tmtu MTU }\n" \
1436 "\tiplink show [ DEVICE ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001437
1438#define iproute_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001439 "{ list | flush | { add | del | change | append |\n" \
1440 "\t\treplace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001441#define iproute_full_usage \
1442 "iproute { list | flush } SELECTOR\n" \
1443 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001444 "\t\t\t[ oif STRING ] [ tos TOS ]\n" \
1445 "\tiproute { add | del | change | append | replace | monitor } ROUTE\n" \
1446 "\t\t\tSELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1447 "\t\t\tROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001448
1449#define iptunnel_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001450 "{ add | change | del | show } [ NAME ]\n" \
1451 "\t\t[ mode { ipip | gre | sit } ]\n" \
1452 "\t\t[ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001453#define iptunnel_full_usage \
1454 "iptunnel { add | change | del | show } [ NAME ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001455 "\t\t\t[ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1456 "\t\t\t[ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1457 "\t\t\t[ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001458
Eric Andersen7e9276b2001-02-22 01:15:47 +00001459#define kill_trivial_usage \
1460 "[-signal] process-id [process-id ...]"
1461#define kill_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001462 "Send a signal (default is SIGTERM) to the specified process(es).\n\n" \
David Kimdon56082dc2001-02-23 06:03:22 +00001463 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001464 "\t-l\tList all signal names and numbers"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001465#define kill_example_usage \
1466 "$ ps | grep apache\n" \
1467 "252 root root S [apache]\n" \
1468 "263 www-data www-data S [apache]\n" \
1469 "264 www-data www-data S [apache]\n" \
1470 "265 www-data www-data S [apache]\n" \
1471 "266 www-data www-data S [apache]\n" \
1472 "267 www-data www-data S [apache]\n" \
1473 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001474
1475#define killall_trivial_usage \
Eric Andersenb131db42004-08-19 18:25:02 +00001476 "[-q] [-signal] process-name [process-name ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001477#define killall_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001478 "Send a signal (default is SIGTERM) to the specified process(es).\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001479 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001480 "\t-l\tList all signal names and numbers\n" \
1481 "\t-q\tDo not complain if no processes were killed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001482#define killall_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001483 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001484
Mark Whitley6317c4b2001-03-12 22:51:50 +00001485#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001486 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001487#define klogd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001488 "Kernel logger.\n" \
1489 "Options:\n" \
1490 "\t-c n\tSets the default log level of console messages to n\n" \
1491 "\t-n\tRun as a foreground process"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001492
Eric Andersen7e9276b2001-02-22 01:15:47 +00001493#define length_trivial_usage \
1494 "STRING"
1495#define length_full_usage \
1496 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001497#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001498 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001499 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001500
1501#define ln_trivial_usage \
1502 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1503#define ln_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001504 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001505 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1506 "Options:\n" \
1507 "\t-s\tmake symbolic links instead of hard links\n" \
1508 "\t-f\tremove existing destination files\n" \
Rob Landley55b1efc2005-04-29 22:14:28 +00001509 "\t-n\tno dereference symlinks - treat like normal file\n" \
1510 "\t-b\tmake a backup of the target (if exists) before link operation\n" \
1511 "\t-S suffix\tuse suffix instead of ~ when making backup files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001512#define ln_example_usage \
1513 "$ ln -s BusyBox /tmp/ls\n" \
1514 "$ ls -l /tmp/ls\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001515 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001516
Eric Andersen7e9276b2001-02-22 01:15:47 +00001517#define loadfont_trivial_usage \
1518 "< font"
1519#define loadfont_full_usage \
1520 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001521#define loadfont_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001522 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001523
1524#define loadkmap_trivial_usage \
1525 "< keymap"
1526#define loadkmap_full_usage \
1527 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001528#define loadkmap_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001529 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001530
1531#define logger_trivial_usage \
1532 "[OPTION]... [MESSAGE]"
1533#define logger_full_usage \
1534 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1535 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001536 "\t-s\tLog to stderr as well as the system log\n" \
1537 "\t-t TAG\tLog using the specified tag (defaults to user name)\n" \
1538 "\t-p PRIORITY\tEnter the message with the specified priority\n" \
1539 "\t\tThis may be numerical or a ``facility.level'' pair"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001540#define logger_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001541 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001542
Robert Griebl1fca5582002-06-04 20:45:46 +00001543#define login_trivial_usage \
1544 "[OPTION]... [username] [ENV=VAR ...]"
1545#define login_full_usage \
1546 "Begin a new session on the system\n\n" \
1547 "Options:\n" \
1548 "\t-f\tDo not authenticate (user already authenticated)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001549 "\t-h\tName of the remote host for this login\n" \
1550 "\t-p\tPreserve environment"
Robert Griebl1fca5582002-06-04 20:45:46 +00001551
Eric Andersen7e9276b2001-02-22 01:15:47 +00001552#define logname_trivial_usage \
1553 ""
1554#define logname_full_usage \
1555 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001556#define logname_example_usage \
1557 "$ logname\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001558 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001559
Mark Whitley6317c4b2001-03-12 22:51:50 +00001560#define logread_trivial_usage \
Eric Andersend4a5e252003-12-19 11:32:14 +00001561 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001562#define logread_full_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001563 "Shows the messages from syslogd (using circular buffer).\n\n" \
Eric Andersend4a5e252003-12-19 11:32:14 +00001564 "Options:\n" \
1565 "\t-f\t\toutput data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001566
Matt Kraai83788da2002-03-20 17:38:37 +00001567#define losetup_trivial_usage \
1568 "[OPTION]... LOOPDEVICE FILE\n" \
1569 "or: losetup [OPTION]... -d LOOPDEVICE"
1570#define losetup_full_usage \
1571 "Associate LOOPDEVICE with FILE.\n\n" \
1572 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001573 "\t-d\t\tDisassociate LOOPDEVICE\n" \
1574 "\t-o OFFSET\tStart OFFSET bytes into FILE"
Matt Kraai83788da2002-03-20 17:38:37 +00001575
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001576#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001577# define USAGE_LS_TIMESTAMPS(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001578#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001579# define USAGE_LS_TIMESTAMPS(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001580#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001581#ifdef CONFIG_FEATURE_LS_FILETYPES
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001582# define USAGE_LS_FILETYPES(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001583#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001584# define USAGE_LS_FILETYPES(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001585#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001586#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001587# define USAGE_LS_FOLLOWLINKS(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001588#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001589# define USAGE_LS_FOLLOWLINKS(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001590#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001591#ifdef CONFIG_FEATURE_LS_RECURSIVE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001592# define USAGE_LS_RECURSIVE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001593#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001594# define USAGE_LS_RECURSIVE(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001595#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001596#ifdef CONFIG_FEATURE_LS_SORTFILES
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001597# define USAGE_LS_SORTFILES(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001598#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001599# define USAGE_LS_SORTFILES(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001600#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001601#ifdef CONFIG_FEATURE_AUTOWIDTH
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001602# define USAGE_AUTOWIDTH(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001603#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001604# define USAGE_AUTOWIDTH(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001605#endif
Paul Fox156dc412005-08-01 19:33:30 +00001606#ifdef CONFIG_FEATURE_LS_COLOR
1607 #define USAGE_LS_COLOR(a) a
1608#else
1609 #define USAGE_LS_COLOR(a)
1610#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00001611
Eric Andersen7e9276b2001-02-22 01:15:47 +00001612#define ls_trivial_usage \
Eric Andersen15c03c32004-04-06 17:52:02 +00001613 "[-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 +00001614#define ls_full_usage \
1615 "List directory contents\n\n" \
1616 "Options:\n" \
1617 "\t-1\tlist files in a single column\n" \
1618 "\t-A\tdo not list implied . and ..\n" \
1619 "\t-a\tdo not hide entries starting with .\n" \
1620 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001621 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Paul Fox156dc412005-08-01 19:33:30 +00001622 USAGE_LS_COLOR("\t--color[={always,never,auto}]\tto control coloring\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001623 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001624 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1625 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001626 "\t-i\tlist the i-node for each file\n" \
1627 "\t-l\tuse a long listing format\n" \
1628 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001629 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1630 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1631 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1632 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1633 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001634 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001635 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1636 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1637 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1638 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1639 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001640 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001641 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1642 USAGE_HUMAN_READABLE( \
Eric Andersen15c03c32004-04-06 17:52:02 +00001643 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n") \
1644 USAGE_SELINUX("\t-k\tprint security context\n") \
1645 USAGE_SELINUX("\t-K\tprint security context in long format\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001646
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001647#define lsattr_trivial_usage \
1648 "[-Radlv] [files...]"
1649#define lsattr_full_usage \
1650 "list file attributes on an ext2 fs\n\n" \
1651 "Options:\n" \
1652 "\t-R\trecursively list subdirectories\n" \
1653 "\t-a\tdo not hide entries starting with .\n" \
1654 "\t-d\tlist directory entries instead of contents\n" \
1655 "\t-l\tprint long flag names\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001656 "\t-v\tlist the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001657
Eric Andersen7e9276b2001-02-22 01:15:47 +00001658#define lsmod_trivial_usage \
1659 ""
1660#define lsmod_full_usage \
1661 "List the currently loaded kernel modules."
1662
Eric Andersen3d925622005-06-09 10:16:02 +00001663#ifdef CONFIG_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00001664#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001665 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001666#define makedevs_full_usage \
1667 "Creates a range of block or character special files\n\n" \
1668 "TYPEs include:\n" \
1669 "\tb:\tMake a block (buffered) device.\n" \
1670 "\tc or u:\tMake a character (un-buffered) device.\n" \
1671 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1672 "FIRST specifies the number appended to NAME to create the first device.\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001673 "LAST specifies the number of the last item that should be created\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001674 "If 's' is the last argument, the base device is created as well.\n\n" \
1675 "For example:\n" \
1676 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001677 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001678#define makedevs_example_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001679 "# makedevs /dev/ttyS c 4 66 2 63\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001680 "[creates ttyS2-ttyS63]\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001681 "# makedevs /dev/hda b 3 0 0 8 s\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001682 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001683#endif
1684
1685#ifdef CONFIG_FEATURE_MAKEDEVS_TABLE
1686#define makedevs_trivial_usage \
Eric Andersene8614db2005-07-18 09:28:36 +00001687 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00001688#define makedevs_full_usage \
Eric Andersene8614db2005-07-18 09:28:36 +00001689 "Creates a range of special files as specified in a device table.\n" \
1690 "Device table entries take the form of:\n" \
Eric Andersene8614db2005-07-18 09:28:36 +00001691 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
1692 "Where name is the file name, type can be one of:\n" \
1693 " f A regular file\n" \
1694 " d Directory\n" \
1695 " c Character special device file\n" \
1696 " b Block special device file\n" \
1697 " p Fifo (named pipe)\n" \
1698 "uid is the user id for the target file, gid is the group id for the\n" \
1699 "target file. The rest of the entries (major, minor, etc) apply to\n" \
Eric Andersen54e57da2005-07-18 09:42:37 +00001700 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00001701#define makedevs_example_usage \
1702 "For example:\n" \
1703 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
1704 "/dev d 755 0 0 - - - - -\n" \
1705 "/dev/console c 666 0 0 5 1 - - -\n" \
1706 "/dev/null c 666 0 0 1 3 0 0 -\n" \
1707 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
1708 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
1709 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
1710 "Will Produce:\n" \
1711 "/dev\n" \
1712 "/dev/console\n" \
1713 "/dev/null\n" \
1714 "/dev/zero\n" \
1715 "/dev/hda\n" \
Eric Andersen54e57da2005-07-18 09:42:37 +00001716 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001717#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001718
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001719#ifdef CONFIG_FEATURE_MD5_SHA1_SUM_CHECK
1720#define USAGE_MD5_SHA1_SUM_CHECK(a) a
1721#else
1722#define USAGE_MD5_SHA1_SUM_CHECK(a)
1723#endif
1724
Eric Andersen7e9276b2001-02-22 01:15:47 +00001725#define md5sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001726 "[OPTION] [FILEs...]" \
1727 USAGE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001728#define md5sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001729 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001730 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001731 "With no FILE, or when FILE is -, read standard input." \
1732 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
1733 "\t-c\tcheck MD5 sums against given list\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001734 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001735 "\t-s\tdon't output anything, status code shows success\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001736 "\t-w\twarn about improperly formated MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001737#define md5sum_example_usage \
1738 "$ md5sum < busybox\n" \
1739 "6fd11e98b98a58f64ff3398d7b324003\n" \
1740 "$ md5sum busybox\n" \
1741 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1742 "$ md5sum -c -\n" \
1743 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1744 "busybox: OK\n" \
1745 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001746
Glenn L McGrath061c9002002-09-16 04:21:46 +00001747#define mesg_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001748 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001749#define mesg_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001750 "mesg controls write access to your terminal\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001751 "\ty\tAllow write access to your terminal\n" \
1752 "\tn\tDisallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001753
Eric Andersen7e9276b2001-02-22 01:15:47 +00001754#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001755 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001756#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001757 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001758 "Options:\n" \
1759 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001760 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001761#define mkdir_example_usage \
1762 "$ mkdir /tmp/foo\n" \
1763 "$ mkdir /tmp/foo\n" \
1764 "/tmp/foo: File exists\n" \
1765 "$ mkdir /tmp/foo/bar/baz\n" \
1766 "/tmp/foo/bar/baz: No such file or directory\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001767 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001768
Mike Frysinger6447ac02005-06-11 05:29:40 +00001769#define mke2fs_trivial_usage \
1770 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
1771 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
1772 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
1773 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
1774 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
1775 "device [blocks-count]"
1776#define mke2fs_full_usage \
1777 "\t-b size\tblock size in bytes\n" \
1778 "\t-c\tcheck for bad blocks before creating\n" \
1779 "\t-E opts\tset extended options\n" \
1780 "\t-f size\tfragment size in bytes\n" \
1781 "\t-F\tforce (ignore sanity checks)\n" \
1782 "\t-g num\tnumber of blocks in a block group\n" \
1783 "\t-i ratio\tthe bytes/inode ratio\n" \
1784 "\t-j\tcreate a journal (ext3)\n" \
1785 "\t-J opts\tset journal options (size/device)\n" \
1786 "\t-l file\tread bad blocks list from file\n" \
1787 "\t-L lbl\tset the volume label\n" \
1788 "\t-m percent\tpercent of fs blocks to reserve for admin\n" \
1789 "\t-M dir\tset last mounted directory\n" \
1790 "\t-n\tdo not actually create anything\n" \
1791 "\t-N num\tnumber of inodes to create\n" \
1792 "\t-o os\tset the 'creator os' field\n" \
1793 "\t-O features\tdir_index/filetype/has_journal/journal_dev/sparse_super\n" \
1794 "\t-q\tquiet execution\n" \
1795 "\t-r rev\tset filesystem revision\n" \
1796 "\t-S\twrite superblock and group descriptors only\n" \
1797 "\t-T fs-type\tset usage type (news/largefile/largefile4)\n" \
1798 "\t-v\tverbose execution"
1799
Eric Andersen7e9276b2001-02-22 01:15:47 +00001800#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001801 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001802#define mkfifo_full_usage \
1803 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1804 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001805 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001806
Eric Andersen7e9276b2001-02-22 01:15:47 +00001807#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001808 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001809#define mkfs_minix_full_usage \
1810 "Make a MINIX filesystem.\n\n" \
1811 "Options:\n" \
1812 "\t-c\t\tCheck the device for bad blocks\n" \
1813 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1814 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1815 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001816 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001817
Eric Andersen7e9276b2001-02-22 01:15:47 +00001818#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001819 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001820#define mknod_full_usage \
1821 "Create a special file (block, character, or pipe).\n\n" \
1822 "Options:\n" \
1823 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1824 "TYPEs include:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001825 "\tb:\tMake a block (buffered) device\n" \
1826 "\tc or u:\tMake a character (un-buffered) device\n" \
1827 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001828#define mknod_example_usage \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001829 "$ mknod /dev/fd0 b 2 0\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001830 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001831
Eric Andersen7e9276b2001-02-22 01:15:47 +00001832#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001833 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001834#define mkswap_full_usage \
1835 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001836 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001837 "\t-c\t\tCheck for read-ability\n" \
1838 "\t-v0\t\tMake version 0 swap [max 128 Megs]\n" \
1839 "\t-v1\t\tMake version 1 swap [big!] (default for kernels >\n\t\t\t2.1.117)\n" \
1840 "\tblock-count\tNumber of block to use (default is entire partition)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001841
Eric Andersen7e9276b2001-02-22 01:15:47 +00001842#define mktemp_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001843 "[-dq] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001844#define mktemp_full_usage \
1845 "Creates a temporary file with its name based on TEMPLATE.\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001846 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX).\n\n" \
1847 "Options:\n" \
1848 "\t-d\t\tMake a directory instead of a file\n" \
1849 "\t-q\t\tFail silently if an error occurs"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001850#define mktemp_example_usage \
1851 "$ mktemp /tmp/temp.XXXXXX\n" \
1852 "/tmp/temp.mWiLjM\n" \
1853 "$ ls -la /tmp/temp.mWiLjM\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001854 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001855
Eric Andersen8d79ce82001-07-22 23:00:15 +00001856#define modprobe_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001857 "[-knqrsv] [MODULE ...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00001858#define modprobe_full_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001859 "Used for high level module loading and unloading.\n\n" \
1860 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001861 "\t-k\tMake module autoclean-able\n" \
1862 "\t-n\tJust show what would be done\n" \
1863 "\t-q\tQuiet output\n" \
1864 "\t-r\tRemove module (stacks) or do autoclean\n" \
1865 "\t-s\tReport via syslog instead of stderr\n" \
1866 "\t-v\tVerbose output"
Eric Andersen8d79ce82001-07-22 23:00:15 +00001867#define modprobe_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001868 "$ modprobe cdrom\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00001869
Eric Andersen7e9276b2001-02-22 01:15:47 +00001870#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001871 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001872#define more_full_usage \
1873 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001874#define more_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001875 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001876
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001877#ifdef CONFIG_FEATURE_MOUNT_LOOP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001878# define USAGE_MOUNT_LOOP(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001879#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001880# define USAGE_MOUNT_LOOP(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001881#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001882#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001883# define USAGE_MTAB(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001884#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001885# define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001886#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001887#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001888 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001889#define mount_full_usage \
Eric Andersen2715fa12004-03-09 21:32:57 +00001890 "Mount a filesystem. Autodetection of filesystem type requires the\n" \
1891 "/proc filesystem be already mounted.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001892 "Flags:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001893 "\t-a:\t\tMount all filesystems in fstab\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001894 USAGE_MTAB( \
Mike Frysinger058e7402005-04-23 07:00:33 +00001895 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it\n" \
1896 "\t-n:\t\tDon't write a mount table entry\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001897 ) \
Mike Frysinger058e7402005-04-23 07:00:33 +00001898 "\t-o option:\tOne of many filesystem options, listed below\n" \
1899 "\t-r:\t\tMount the filesystem read-only\n" \
1900 "\t-t fs-type:\tSpecify the filesystem type\n" \
1901 "\t-w:\t\tMount for reading and writing (default)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001902 "\n" \
1903 "Options for use with the \"-o\" flag:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001904 "\tasync/sync:\tWrites are asynchronous / synchronous\n" \
1905 "\tatime/noatime:\tEnable / disable updates to inode access times\n" \
1906 "\tdev/nodev:\tAllow use of special device files / disallow them\n" \
1907 "\texec/noexec:\tAllow use of executable files / disallow them\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001908 USAGE_MOUNT_LOOP( \
Mike Frysinger058e7402005-04-23 07:00:33 +00001909 "\tloop:\t\tMounts a file via loop device\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001910 ) \
Mike Frysinger058e7402005-04-23 07:00:33 +00001911 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them\n" \
1912 "\tremount:\tRe-mount a mounted filesystem, changing its flags\n" \
1913 "\tro/rw:\t\tMount for read-only / read-write\n" \
1914 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature\n" \
1915 "\nThere are EVEN MORE flags that are specific to each filesystem\n" \
1916 "You'll have to see the written documentation for those filesystems"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001917#define mount_example_usage \
1918 "$ mount\n" \
1919 "/dev/hda3 on / type minix (rw)\n" \
1920 "proc on /proc type proc (rw)\n" \
1921 "devpts on /dev/pts type devpts (rw)\n" \
1922 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001923 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001924
Rob Landleyd00b3a52005-08-20 05:07:08 +00001925#define mountpoint_trivial_usage \
1926 "[-q] <[-d] DIR | -x DEVICE>"
1927#define mountpoint_full_usage \
1928 "mountpoint checks if the directory is a mountpoint\n\n" \
1929 "Options:\n" \
1930 "\t-q:\t\tBe more quiet\n" \
1931 "\t-d:\t\tPrint major/minor device number of the filesystem\n" \
1932 "\t-x:\t\tPrint major/minor device number of the blockdevice"
1933#define mountpoint_example_usage \
1934 "$ mountpoint /proc\n" \
1935 "/proc is not a mountpoint\n" \
1936 "$ mountpoint /sys\n" \
1937 "/sys is a mountpoint\n"
1938
Eric Andersen7e9276b2001-02-22 01:15:47 +00001939#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001940 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001941#define mt_full_usage \
1942 "Control magnetic tape drive operation\n" \
1943 "\nAvailable Opcodes:\n\n" \
1944 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1945 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
Eric Andersen92fb9392003-08-08 20:09:03 +00001946 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001947 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001948
Eric Andersen7e9276b2001-02-22 01:15:47 +00001949#define mv_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001950 "[OPTION]... SOURCE DEST\n" \
1951 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001952#define mv_full_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001953 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY.\n\n" \
1954 "Options:\n" \
1955 "\t-f\tdon't prompt before overwriting\n" \
1956 "\t-i\tinteractive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001957#define mv_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001958 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001959
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001960#define nameif_trivial_usage \
Glenn L McGratha9adef02003-01-19 13:34:21 +00001961 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001962#define nameif_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00001963 "Nameif renaming network interface while it in the down state.\n\n" \
1964 "Options:\n" \
1965 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001966 "\t-s\t\tUse syslog (LOCAL0 facility)\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001967 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001968#define nameif_example_usage \
Eric Andersen178de172004-04-06 16:36:20 +00001969 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
1970 " or\n" \
1971 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00001972
Mike Frysinger7dc7f402005-05-06 05:00:34 +00001973#ifdef CONFIG_NC_GAPING_SECURITY_HOLE
1974# define USAGE_NC_EXEC(a) a
1975#else
1976# define USAGE_NC_EXEC(a)
1977#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001978#define nc_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001979 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001980#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00001981 "Netcat opens a pipe to IP:port\n\n" \
1982 "Options:\n" \
1983 "\t-l\t\tlisten mode, for inbound connects\n" \
1984 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00001985 "\t-i SECS\t\tdelay interval for lines sent\n" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00001986 USAGE_NC_EXEC( \
1987 "\t-e PROG\t\tprogram to exec after connect (dangerous!)\n" \
1988 ) \
1989 "\t-w SECS\t\ttimeout for connects and final net reads"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001990#define nc_example_usage \
1991 "$ nc foobar.somedomain.com 25\n" \
1992 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
1993 "help\n" \
1994 "214-Commands supported:\n" \
1995 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
1996 "214 NOOP QUIT RSET HELP\n" \
1997 "quit\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001998 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001999
Eric Andersen1552ff72001-10-31 11:07:12 +00002000#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00002001 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002002#define netstat_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00002003 "Netstat displays Linux networking information.\n\n" \
2004 "Options:\n" \
2005 "\t-l display listening server sockets\n" \
2006 "\t-a display all sockets (default: connected)\n" \
2007 "\t-e display other/more information\n" \
2008 "\t-n don't resolve names\n" \
2009 "\t-r display routing table\n" \
2010 "\t-t tcp sockets\n" \
2011 "\t-u udp sockets\n" \
2012 "\t-w raw sockets\n" \
2013 "\t-x unix sockets"
Eric Andersen1552ff72001-10-31 11:07:12 +00002014
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002015#define nice_trivial_usage \
2016 "[-n ADJUST] [COMMAND [ARG] ...]"
2017#define nice_full_usage \
2018 "Nice runs a program with modified scheduling priority.\n\n" \
2019 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002020 "\t-n ADJUST\tAdjust the scheduling priority by ADJUST"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002021
Eric Andersen7e9276b2001-02-22 01:15:47 +00002022#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00002023 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002024#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00002025 "Queries the nameserver for the IP address of the given HOST\n" \
2026 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002027#define nslookup_example_usage \
2028 "$ nslookup localhost\n" \
2029 "Server: default\n" \
2030 "Address: default\n" \
2031 "\n" \
2032 "Name: debian\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002033 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002034
Glenn L McGrath60281112001-11-02 11:39:46 +00002035#define od_trivial_usage \
2036 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
2037#define od_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002038 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Glenn L McGrath60281112001-11-02 11:39:46 +00002039 "to standard output. With no FILE, or when FILE is -, read standard input."
2040
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002041#define openvt_trivial_usage \
2042 "<vtnum> <COMMAND> [ARGS...]"
2043#define openvt_full_usage \
2044 "Start a command on a new virtual terminal"
2045#define openvt_example_usage \
2046 "openvt 2 /bin/ash\n"
2047
Eric Andersen27f64e12002-06-23 04:24:25 +00002048#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002049# define PASSWORD_ALG_TYPES(a) a
Tim Riker7b253f82003-12-28 05:02:40 +00002050#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002051# define PASSWORD_ALG_TYPES(a)
Eric Andersen27f64e12002-06-23 04:24:25 +00002052#endif
2053#define passwd_trivial_usage \
2054 "[OPTION] [name]"
2055#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00002056 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00002057 "changes the password for the current user.\n" \
2058 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002059 "\t-a\tDefine which algorithm shall be used for the password\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00002060 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00002061 PASSWORD_ALG_TYPES(", sha1") \
Mike Frysinger058e7402005-04-23 07:00:33 +00002062 ")\n\t-d\tDelete the password for the specified user account\n" \
2063 "\t-l\tLocks (disables) the specified user account\n" \
2064 "\t-u\tUnlocks (re-enables) the specified user account"
Eric Andersen27f64e12002-06-23 04:24:25 +00002065
Glenn L McGrath655d8142003-06-22 15:32:41 +00002066#define patch_trivial_usage \
Rob Landley078bacf2005-09-01 03:02:23 +00002067 "[-p<num>] [-i<patch.diff>]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002068#define patch_full_usage \
Rob Landley078bacf2005-09-01 03:02:23 +00002069 "[-p<num>]\n" \
2070 "[-i<diff>]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002071#define patch_example_usage \
Rob Landley078bacf2005-09-01 03:02:23 +00002072 "$ patch -p1 <example.diff\n" \
2073 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002074
Eric Andersen221b2ea2001-07-31 19:06:07 +00002075#define pidof_trivial_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002076 "process-name [OPTION] [process-name ...]"
Eric Andersen221b2ea2001-07-31 19:06:07 +00002077#define pidof_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002078 "Lists the PIDs of all processes with names that match the\n" \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002079 "names on the command line.\n" \
2080 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002081 "\t-s\t\tdisplay only a single PID"
Eric Andersen221b2ea2001-07-31 19:06:07 +00002082#define pidof_example_usage \
2083 "$ pidof init\n" \
2084 "1\n"
2085
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002086#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00002087#define ping_trivial_usage "host"
2088#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
2089#else
2090#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002091 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002092#define ping_full_usage \
2093 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
2094 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002095 "\t-c COUNT\tSend only COUNT pings\n" \
2096 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002097 "\t-q\t\tQuiet mode, only displays output at start\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002098 "\t\t\tand when finished"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002099#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002100#define ping_example_usage \
2101 "$ ping localhost\n" \
2102 "PING slag (127.0.0.1): 56 data bytes\n" \
2103 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2104 "\n" \
2105 "--- debian ping statistics ---\n" \
2106 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002107 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002108
Eric Andersen51b8bd62002-07-03 11:46:38 +00002109#ifndef CONFIG_FEATURE_FANCY_PING6
2110#define ping6_trivial_usage "host"
2111#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
2112#else
2113#define ping6_trivial_usage \
2114 "[OPTION]... host"
2115#define ping6_full_usage \
2116 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
2117 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002118 "\t-c COUNT\tSend only COUNT pings\n" \
2119 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56)\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +00002120 "\t-q\t\tQuiet mode, only displays output at start\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002121 "\t\t\tand when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002122#endif
2123#define ping6_example_usage \
2124 "$ ping6 ip6-localhost\n" \
2125 "PING ip6-localhost (::1): 56 data bytes\n" \
2126 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2127 "\n" \
2128 "--- ip6-localhost ping statistics ---\n" \
2129 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002130 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002131
Eric Andersen7e9276b2001-02-22 01:15:47 +00002132#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002133 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002134#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002135 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002136 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002137
Eric Andersen7e9276b2001-02-22 01:15:47 +00002138#define poweroff_trivial_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002139 "[-d<delay>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002140#define poweroff_full_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002141 "Halt the system and request that the kernel shut off the power.\n" \
2142 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002143 "\t-d\t\tdelay interval for shutting off"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002144
Mike Frysinger95d3c452005-04-21 23:29:24 +00002145#define printenv_trivial_usage \
2146 "[VARIABLES...]"
2147#define printenv_full_usage \
2148 "print all or part of environment\n\n" \
2149 "If no environment VARIABLE specified, print them all."
2150
Eric Andersen7e9276b2001-02-22 01:15:47 +00002151#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002152 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002153#define printf_full_usage \
2154 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002155 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002156#define printf_example_usage \
Mike Frysinger5c63a722005-04-16 04:23:58 +00002157 "$ printf \"Val=%d\\n\" 5\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002158 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002159
Rob Landley6eb1e412005-06-20 04:30:36 +00002160#if !defined(CONFIG_SELINUX) && !defined(CONFIG_PS_FEATURE_WIDE)
2161#define USAGE_PS "\n\tThis version of ps accepts no options."
2162#else
2163#define USAGE_PS "\nOptions:"
2164#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002165#ifdef CONFIG_SELINUX
2166#define USAGE_NONSELINUX(a)
2167#else
2168#define USAGE_NONSELINUX(a) a
2169#endif
Rob Landley6eb1e412005-06-20 04:30:36 +00002170#ifdef CONFIG_PS_FEATURE_WIDE
2171#define USAGE_PS_WIDE(a) a
2172#else
2173#define USAGE_PS_WIDE(a)
2174#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002175
Eric Andersen7e9276b2001-02-22 01:15:47 +00002176#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002177 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002178#define ps_full_usage \
2179 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002180 USAGE_PS \
2181 USAGE_SELINUX("\n\t-c\tshow SE Linux context") \
2182 USAGE_PS_WIDE("\n\tw\twide output")
2183
Tim Riker7b253f82003-12-28 05:02:40 +00002184
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002185#define ps_example_usage \
2186 "$ ps\n" \
2187 " PID Uid Gid State Command\n" \
2188 " 1 root root S init\n" \
2189 " 2 root root S [kflushd]\n" \
2190 " 3 root root S [kupdate]\n" \
2191 " 4 root root S [kpiod]\n" \
2192 " 5 root root S [kswapd]\n" \
2193 " 742 andersen andersen S [bash]\n" \
2194 " 743 andersen andersen S -bash\n" \
2195 " 745 root root S [getty]\n" \
2196 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002197
Eric Andersen7e9276b2001-02-22 01:15:47 +00002198#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002199 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002200#define pwd_full_usage \
2201 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002202#define pwd_example_usage \
2203 "$ pwd\n" \
2204 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002205
Eric Andersen7e9276b2001-02-22 01:15:47 +00002206#define rdate_trivial_usage \
Eric Andersen725db192003-07-22 08:26:05 +00002207 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002208#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002209 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002210 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002211 "\t-s\tSet the system date and time (default)\n" \
2212 "\t-p\tPrint the date and time"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002213
Ned Luddc6fbed52004-12-08 16:47:28 +00002214#ifdef CONFIG_FEATURE_READLINK_FOLLOW
2215#define USAGE_READLINK_FOLLOW(a) a
2216#else
2217#define USAGE_READLINK_FOLLOW(a)
2218#endif
2219
Eric Andersen7e9276b2001-02-22 01:15:47 +00002220#define readlink_trivial_usage \
Ned Luddc6fbed52004-12-08 16:47:28 +00002221 USAGE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002222#define readlink_full_usage \
Ned Luddc6fbed52004-12-08 16:47:28 +00002223 "Displays the value of a symbolic link." \
2224 USAGE_READLINK_FOLLOW("\n\nOptions:\n" \
2225 "\t-f\tcanonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002226
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002227#define readprofile_trivial_usage \
2228 "[OPTIONS]..."
2229#define readprofile_full_usage \
2230 "Options:\n" \
2231 "\t -m <mapfile> (default: /boot/System.map)\n" \
2232 "\t -p <profile> (default: /proc/profile)\n" \
2233 "\t -M <mult> set the profiling multiplier to <mult>\n" \
2234 "\t -i print only info about the sampling step\n" \
2235 "\t -v print verbose data\n" \
2236 "\t -a print all symbols, even if count is 0\n" \
2237 "\t -b print individual histogram-bin counts\n" \
2238 "\t -s print individual counters within functions\n" \
2239 "\t -r reset all the counters (root only)\n" \
2240 "\t -n disable byte order auto-detection"
2241
Glenn L McGrath62fae302002-12-10 00:14:33 +00002242#define realpath_trivial_usage \
2243 "pathname ..."
2244#define realpath_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002245 "Returns the absolute pathnames of given argument."
Tim Riker7b253f82003-12-28 05:02:40 +00002246
Eric Andersen7e9276b2001-02-22 01:15:47 +00002247#define reboot_trivial_usage \
Glenn L McGrath72b14a82004-07-23 03:33:38 +00002248 "[-d<delay>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002249#define reboot_full_usage \
Glenn L McGrath72b14a82004-07-23 03:33:38 +00002250 "Reboot the system.\n" \
2251 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002252 "\t-d\t\tdelay interval for rebooting"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002253
2254#define renice_trivial_usage \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002255 "{{-n INCREMENT} | PRIORITY} [[ -p | -g | -u ] ID ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002256#define renice_full_usage \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002257 "Changes priority of running processes.\n\n" \
2258 "Options:\n" \
2259 "\t-n\tadjusts current nice value (smaller is faster)\n" \
2260 "\t-p\tprocess id(s) (default)\n" \
2261 "\t-g\tprocess group id(s)\n" \
2262 "\t-u\tprocess user name(s) and/or id(s)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002263
Eric Andersen7e9276b2001-02-22 01:15:47 +00002264#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002265 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002266#define reset_full_usage \
2267 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002268
Eric Andersen7e9276b2001-02-22 01:15:47 +00002269#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002270 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002271#define rm_full_usage \
2272 "Remove (unlink) the FILE(s). You may use '--' to\n" \
2273 "indicate that all following arguments are non-options.\n\n" \
2274 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002275 "\t-i\t\talways prompt before removing each destination\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002276 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002277 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002278#define rm_example_usage \
2279 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002280
Eric Andersen7e9276b2001-02-22 01:15:47 +00002281#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002282 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002283#define rmdir_full_usage \
2284 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002285#define rmdir_example_usage \
2286 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002287
Eric Andersen7e9276b2001-02-22 01:15:47 +00002288#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002289 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002290#define rmmod_full_usage \
2291 "Unloads the specified kernel modules from the kernel.\n\n" \
2292 "Options:\n" \
Tim Rikercf932742002-12-14 01:58:59 +00002293 "\t-a\tRemove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002294#define rmmod_example_usage \
2295 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002296
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002297#ifdef CONFIG_FEATURE_IPV6
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002298# define USAGE_ROUTE_IPV6(a) a
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002299#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002300# define USAGE_ROUTE_IPV6(a) "\t"
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002301#endif
2302
2303
Eric Andersen7e9276b2001-02-22 01:15:47 +00002304#define route_trivial_usage \
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002305 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002306#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002307 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00002308 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002309 "\t-n\t\tDont resolve names\n" \
2310 "\t-e\t\tDisplay other/more information\n" \
2311 "\t-A inet" USAGE_ROUTE_IPV6("{6}") "\tSelect address family"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002312
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002313#define rpm_trivial_usage \
2314 "-i -q[ildc]p package.rpm"
2315#define rpm_full_usage \
2316 "Manipulates RPM packages" \
Eric Andersendfce3532003-06-15 07:00:54 +00002317 "\n\nOptions:" \
2318 "\n\t-i Install package" \
2319 "\n\t-q Query package" \
2320 "\n\t-p Query uninstalled package" \
2321 "\n\t-i Show information" \
2322 "\n\t-l List contents" \
2323 "\n\t-d List documents" \
2324 "\n\t-c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002325
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002326#define rpm2cpio_trivial_usage \
2327 "package.rpm"
2328#define rpm2cpio_full_usage \
2329 "Outputs a cpio archive of the rpm file."
2330
Eric Andersen6cf47a72001-10-31 10:24:36 +00002331#define run_parts_trivial_usage \
2332 "[-t] [-a ARG] [-u MASK] DIRECTORY"
2333#define run_parts_full_usage \
2334 "Run a bunch of scripts in a directory.\n\n" \
2335 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002336 "\t-t\tPrints what would be run, but does not actually run anything\n" \
2337 "\t-a ARG\tPass ARG as an argument for every program invoked\n" \
2338 "\t-u MASK\tSet the umask to MASK before executing every program"
Eric Andersen6cf47a72001-10-31 10:24:36 +00002339
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002340#define rx_trivial_usage \
2341 "FILE"
2342#define rx_full_usage \
2343 "Receive a file using the xmodem protocol."
2344#define rx_example_usage \
2345 "$ rx /tmp/foo\n"
2346
Eric Andersen7e9276b2001-02-22 01:15:47 +00002347#define sed_trivial_usage \
Rob Landley1ce59682004-05-26 21:59:31 +00002348 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002349#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002350 "Options:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002351 "\t-e script\tadd the script to the commands to be executed\n" \
Eric Andersenf802ff72004-04-12 15:12:06 +00002352 "\t-f scriptfile\tadd script-file contents to the\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002353 "\t\t\tcommands to be executed\n" \
Rob Landley1ce59682004-05-26 21:59:31 +00002354 "\t-i\t\tedit files in-place\n" \
2355 "\t-n\t\tsuppress automatic printing of pattern space\n" \
Rob Landley58b118a2004-05-26 22:09:37 +00002356 "\t-r\t\tuse extended regular expression syntax\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002357 "\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002358 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
2359 "script to interpret. All remaining arguments are names of input files; if no\n" \
Eric Andersenf802ff72004-04-12 15:12:06 +00002360 "input files are specified, then the standard input is read. Source files\n" \
2361 "will not be modified unless -i option is given."
2362
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002363#define sed_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002364 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002365 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002366
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002367#define seq_trivial_usage \
2368 "[first [increment]] last"
2369#define seq_full_usage \
2370 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
2371 "FIRST, INCREMENT default to 1\n" \
2372 "Arguments:\n" \
2373 "\tLAST\n" \
2374 "\tFIRST\tLAST\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002375 "\tFIRST\tINCREMENT\tLAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002376
Paul Foxfc2256a2005-08-01 18:12:30 +00002377#define setconsole_trivial_usage \
2378 "[-r|--reset] [DEVICE]"
2379#define setconsole_full_usage \
2380 "Redirects system console output to DEVICE (default: /dev/tty).\n\n" \
2381 "Options:\n" \
2382 "\t-r\tReset output to /dev/console."
2383
Eric Andersen7e9276b2001-02-22 01:15:47 +00002384#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002385 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002386#define setkeycodes_full_usage \
2387 "Set entries into the kernel's scancode-to-keycode map,\n" \
2388 "allowing unusual keyboards to generate usable keycodes.\n\n" \
2389 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002390 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002391#define setkeycodes_example_usage \
2392 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002393
Paul Fox42403642005-08-01 22:52:09 +00002394#define setsid_trivial_usage \
2395 "program [arg ...]"
2396#define setsid_full_usage \
2397 "Runs any program in a new session by calling setsid() before\n" \
2398 "exec'ing the rest of its arguments. See setsid(2) for details."
2399
Matt Kraai2d91deb2001-08-01 17:21:35 +00002400#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002401 "[FILE]...\n" \
2402 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00002403#define lash_full_usage \
Eric Andersen2e9c2572003-08-08 22:26:06 +00002404 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00002405#define lash_notes_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002406 "This command does not yet have proper documentation.\n\n" \
2407 "Use lash just as you would use any other shell. It properly handles pipes,\n" \
2408 "redirects, job control, can be used as the shell for scripts, and has a\n" \
2409 "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002410 "Bourne Shell syntax. If you need things like \"if-then-else\", \"while\", and such\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002411 "use ash or bash. If you just need a very simple and extremely small shell,\n" \
2412 "this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002413
Eric Andersen2e9c2572003-08-08 22:26:06 +00002414#define last_trivial_usage \
2415 ""
2416#define last_full_usage \
2417 "Shows listing of the last users that logged into the system"
2418
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002419#define sha1sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002420 "[OPTION] [FILEs...]" \
2421 USAGE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002422#define sha1sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002423 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n\n" \
2424 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002425 "With no FILE, or when FILE is -, read standard input." \
2426 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
2427 "\t-c\tcheck SHA1 sums against given list\n" \
2428 "\nThe following two options are useful only when verifying checksums:\n" \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002429 "\t-s\tdon't output anything, status code shows success\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002430 "\t-w\twarn about improperly formated SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002431
Manuel Novoa III cad53642003-03-19 09:13:01 +00002432#ifdef CONFIG_FEATURE_FANCY_SLEEP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002433# define USAGE_FANCY_SLEEP(a) a
2434# define USAGE_NOT_FANCY_SLEEP(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +00002435#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002436# define USAGE_FANCY_SLEEP(a)
2437# define USAGE_NOT_FANCY_SLEEP(a) a
Manuel Novoa III cad53642003-03-19 09:13:01 +00002438#endif
2439
Eric Andersen7e9276b2001-02-22 01:15:47 +00002440#define sleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002441 USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002442#define sleep_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002443 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \
2444 USAGE_FANCY_SLEEP( \
Eric Andersen178de172004-04-06 16:36:20 +00002445 "Pause for a time equal to the total of the args given, where each arg can\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00002446 "\t\thave an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002447#define sleep_example_usage \
2448 "$ sleep 2\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002449 "[2 second delay results]\n" \
2450 USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \
2451 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002452
Rob Landleyc0dedd02005-01-24 07:00:02 +00002453#ifdef CONFIG_SORT_BIG
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002454# define USAGE_SORT_BIG(a) a
Mark Whitleyfccaa362001-04-17 18:56:18 +00002455#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002456# define USAGE_SORT_BIG(a)
Mark Whitleyfccaa362001-04-17 18:56:18 +00002457#endif
Rob Landleyc0dedd02005-01-24 07:00:02 +00002458
Eric Andersen7e9276b2001-02-22 01:15:47 +00002459#define sort_trivial_usage \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002460 "[-nru" USAGE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002461#define sort_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002462 "Sorts lines of text in the specified files\n\n" \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002463 "Options:\n" \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002464 USAGE_SORT_BIG( \
2465 "\t-b\tignore leading blanks\n" \
2466 "\t-c\tcheck whether input is sorted\n" \
2467 "\t-d\tdictionary order (blank or alphanumeric only)\n" \
2468 "\t-f\tignore case\n" \
2469 "\t-g\tgeneral numerical sort\n" \
2470 "\t-i\tignore unprintable characters\n" \
2471 "\t-k\tspecify sort key\n" \
2472 "\t-M\tsort month\n" \
2473 ) \
2474 "\t-n\tsort numbers\n" \
2475 USAGE_SORT_BIG( \
2476 "\t-o\toutput to file\n" \
2477 "\t-k\tsort by key\n" \
2478 "\t-t\tuse key separator other than whitespace\n" \
2479 ) \
2480 "\t-r\treverse sort order\n" \
2481 USAGE_SORT_BIG("\t-s\tstable (don't sort ties alphabetically)\n") \
2482 "\t-u\tsuppress duplicate lines" \
2483 USAGE_SORT_BIG("\n\t-z\tinput terminated by nulls, not newlines\n") \
2484 USAGE_SORT_BIG("\t-mST\tignored for GNU compatability") \
2485 ""
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002486#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002487 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002488 "a\n" \
2489 "b\n" \
2490 "c\n" \
2491 "d\n" \
2492 "e\n" \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002493 "f\n" \
2494 USAGE_SORT_BIG( \
2495 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
2496 "d 2\n" \
2497 "b 2\n" \
2498 "c 3\n" \
2499 ) \
2500 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002501
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002502#define start_stop_daemon_trivial_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002503 "[OPTIONS] [--start|--stop] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002504#define start_stop_daemon_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002505 "Program to start and stop services." \
2506 "\n\nOptions:" \
2507 "\n\t-S|--start\t\t\tstart" \
2508 "\n\t-K|--stop\t\t\tstop" \
2509 "\n\t-a|--startas <pathname>\t\tstarts process specified by pathname" \
2510 "\n\t-b|--background\t\t\tforce process into background" \
2511 "\n\t-u|--user <username>|<uid>\tstop this user's processes" \
2512 "\n\t-x|--exec <executable>\t\tprogram to either start or check" \
2513 "\n\t-m|--make-pidfile <filename>\tcreate the -p file and enter pid in it" \
2514 "\n\t-n|--name <process-name>\tstop processes with this name" \
2515 "\n\t-p|--pidfile <pid-file>\t\tsave or load pid using a pid-file" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002516 "\n\t-q|--quiet\t\t\tbe quiet" \
Eric Andersen178de172004-04-06 16:36:20 +00002517 "\n\t-s|--signal <signal>\t\tsignal to send (default TERM)"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002518
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002519#ifdef CONFIG_FEATURE_STAT_FORMAT
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002520# define USAGE_STAT_FORMAT(a) a
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002521#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002522# define USAGE_STAT_FORMAT(a)
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002523#endif
2524#define stat_trivial_usage \
2525 "[OPTION] FILE..."
2526#define stat_full_usage \
2527 "display file (default) or filesystem status.\n\n" \
2528 "Options:\n" \
2529 USAGE_STAT_FORMAT("\t-c fmt\tuse the specified format\n") \
2530 "\t-f\tdisplay filesystem status\n" \
2531 "\t-L,-l\tdereference links\n" \
2532 "\t-t\tdisplay info in terse form\n" \
2533 USAGE_STAT_FORMAT( \
2534 "\nValid format sequences for files:\n" \
2535 " %a Access rights in octal\n" \
2536 " %A Access rights in human readable form\n" \
2537 " %b Number of blocks allocated (see %B)\n" \
2538 " %B The size in bytes of each block reported by %b\n" \
2539 " %d Device number in decimal\n" \
2540 " %D Device number in hex\n" \
2541 " %f Raw mode in hex\n" \
2542 " %F File type\n" \
2543 " %g Group ID of owner\n" \
2544 " %G Group name of owner\n" \
2545 " %h Number of hard links\n" \
2546 " %i Inode number\n" \
2547 " %n File name\n" \
2548 " %N Quoted file name with dereference if symbolic link\n" \
2549 " %o I/O block size\n" \
2550 " %s Total size, in bytes\n" \
2551 " %t Major device type in hex\n" \
2552 " %T Minor device type in hex\n" \
2553 " %u User ID of owner\n" \
2554 " %U User name of owner\n" \
2555 " %x Time of last access\n" \
2556 " %X Time of last access as seconds since Epoch\n" \
2557 " %y Time of last modification\n" \
2558 " %Y Time of last modification as seconds since Epoch\n" \
2559 " %z Time of last change\n" \
2560 " %Z Time of last change as seconds since Epoch\n" \
2561 "\nValid format sequences for file systems:\n" \
2562 " %a Free blocks available to non-superuser\n" \
2563 " %b Total data blocks in file system\n" \
2564 " %c Total file nodes in file system\n" \
2565 " %d Free file nodes in file system\n" \
2566 " %f Free blocks in file system\n" \
2567 " %i File System ID in hex\n" \
2568 " %l Maximum length of filenames\n" \
2569 " %n File name\n" \
2570 " %s Block size (for faster transfers)\n" \
2571 " %S Fundamental block size (for block counts)\n" \
2572 " %t Type in hex\n" \
2573 " %T Type in human readable form\n" \
2574 )
2575
Eric Andersenef5e8f82002-11-07 02:09:37 +00002576#define strings_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002577 "[-afo] [-n length] [file ... ]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002578#define strings_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002579 "Display printable strings in a binary file." \
2580 "\n\nOptions:" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002581 "\n\t-a\tScan the whole files (this is the default)." \
Eric Andersen178de172004-04-06 16:36:20 +00002582 "\n\t-f\tPrecede each string with the name of the file where it was found." \
2583 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002584 "\n\t-o\tEach string is preceded by its decimal offset in the file"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002585
Eric Andersen7e9276b2001-02-22 01:15:47 +00002586#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002587 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002588#define stty_full_usage \
2589 "Without arguments, prints baud rate, line discipline," \
2590 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002591 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00002592 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002593 "\n\t-a\t\tprint all current settings in human-readable form" \
2594 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00002595 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002596
Robert Griebl1fca5582002-06-04 20:45:46 +00002597#define su_trivial_usage \
2598 "[OPTION]... [-] [username]"
2599#define su_full_usage \
2600 "Change user id or become root.\n" \
2601 "Options:\n" \
2602 "\t-p\tPreserve environment"
2603
Eric Andersen27f64e12002-06-23 04:24:25 +00002604#define sulogin_trivial_usage \
2605 "[OPTION]... [tty-device]"
2606#define sulogin_full_usage \
2607 "Single user login\n" \
2608 "Options:\n" \
2609 "\t-f\tDo not authenticate (user already authenticated)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002610 "\t-h\tName of the remote host for this login\n" \
2611 "\t-p\tPreserve environment"
Eric Andersen27f64e12002-06-23 04:24:25 +00002612
Mike Frysinger95d3c452005-04-21 23:29:24 +00002613#define sum_trivial_usage \
2614 "[rs] [files...]"
2615#define sum_full_usage \
2616 "checksum and count the blocks in a file\n\n" \
2617 "Options:\n" \
2618 "\t-r\tuse BSD sum algorithm (1K blocks)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002619 "\t-s\tuse System V sum algorithm (512byte blocks)"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002620
Eric Andersen7e9276b2001-02-22 01:15:47 +00002621#define swapoff_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002622 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002623#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002624 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002625 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002626 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002627
Eric Andersen7e9276b2001-02-22 01:15:47 +00002628#define swapon_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002629 "[OPTION] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002630#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002631 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002632 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002633 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002634
Eric Andersen7e9276b2001-02-22 01:15:47 +00002635#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002636 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002637#define sync_full_usage \
2638 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002639
Eric Andersen7e9276b2001-02-22 01:15:47 +00002640
Eric Andersen29c77f72003-10-09 09:43:18 +00002641#ifdef CONFIG_FEATURE_ROTATE_LOGFILE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002642# define USAGE_ROTATE_LOGFILE(a) a
Eric Andersen29c77f72003-10-09 09:43:18 +00002643#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002644# define USAGE_ROTATE_LOGFILE(a)
Eric Andersen29c77f72003-10-09 09:43:18 +00002645#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002646#ifdef CONFIG_FEATURE_REMOTE_LOG
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002647# define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002648#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002649# define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002650#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00002651#ifdef CONFIG_FEATURE_IPC_SYSLOG
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002652# define USAGE_IPC_LOG(a) a
Robert Griebl65d415d2002-08-07 21:10:19 +00002653#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002654# define USAGE_IPC_LOG(a)
Robert Griebl65d415d2002-08-07 21:10:19 +00002655#endif
2656
Eric Andersenb9050282003-12-24 06:02:11 +00002657#ifdef CONFIG_SYSCTL
2658#define sysctl_trivial_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002659 "[OPTIONS]... [VALUE]..."
Eric Andersenb9050282003-12-24 06:02:11 +00002660#define sysctl_full_usage
2661 "sysctl - configure kernel parameters at runtime\n\n" \
2662 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002663 "\t-n\tUse this option to disable printing of the key name when printing values\n" \
2664 "\t-w\tUse this option when you want to change a sysctl setting\n" \
2665 "\t-p\tLoad in sysctl settings from the file specified or /etc/sysctl.conf if none given\n" \
2666 "\t-a\tDisplay all values currently available\n" \
2667 "\t-A\tDisplay all values currently available in table form"
Eric Andersenb9050282003-12-24 06:02:11 +00002668#define sysctl_example_usage
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002669 "sysctl [-n] variable ...\n" \
2670 "sysctl [-n] -w variable=value ...\n" \
2671 "sysctl [-n] -a\n" \
2672 "sysctl [-n] -p <file>\t(default /etc/sysctl.conf)\n" \
2673 "sysctl [-n] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00002674#endif
2675
Eric Andersen7e9276b2001-02-22 01:15:47 +00002676#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002677 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002678#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002679 "Linux system and kernel logging utility.\n" \
2680 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002681 "Options:\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002682 "\t-m MIN\t\tMinutes between MARK lines (default=20, 0=off)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002683 "\t-n\t\tRun as a foreground process\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002684 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)\n" \
2685 "\t-S\t\tMake logging output smaller." \
Eric Andersen29c77f72003-10-09 09:43:18 +00002686 USAGE_ROTATE_LOGFILE( \
Eric Andersen178de172004-04-06 16:36:20 +00002687 "\n\t-s SIZE\t\tMax size (KB) before rotate (default=200KB, 0=off)\n" \
2688 "\t-b NUM\t\tNumber of rotated logs to keep (default=1, max=99, 0=purge)") \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002689 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00002690 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00002691 "\t-L\t\tLog locally and via network logging (default is network only)") \
2692 USAGE_IPC_LOG( \
Eric Andersend4a5e252003-12-19 11:32:14 +00002693 "\n\t-C [size(KiB)]\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002694#define syslogd_example_usage \
2695 "$ syslogd -R masterlog:514\n" \
2696 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002697
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002698
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002699#ifndef CONFIG_FEATURE_FANCY_TAIL
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002700# define USAGE_UNSIMPLE_TAIL(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00002701#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002702# define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002703#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002704#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002705 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002706#define tail_full_usage \
2707 "Print last 10 lines of each FILE to standard output.\n" \
2708 "With more than one FILE, precede each with a header giving the\n" \
2709 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
2710 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002711 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002712 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
2713 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002714 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002715 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
2716 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002717 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002718 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002719 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
2720#define tail_example_usage \
2721 "$ tail -n 1 /etc/resolv.conf\n" \
2722 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002723
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002724#ifdef CONFIG_FEATURE_TAR_CREATE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002725# define USAGE_TAR_CREATE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002726#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002727# define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002728#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002729#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002730# define USAGE_TAR_EXCLUDE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002731#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002732# define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002733#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002734#ifdef CONFIG_FEATURE_TAR_GZIP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002735# define USAGE_TAR_GZIP(a) a
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002736#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002737# define USAGE_TAR_GZIP(a)
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002738#endif
2739#ifdef CONFIG_FEATURE_TAR_BZIP2
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002740# define USAGE_TAR_BZIP2(a) a
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002741#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002742# define USAGE_TAR_BZIP2(a)
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002743#endif
Glenn L McGrath7370f622003-11-18 21:49:23 +00002744#ifdef CONFIG_FEATURE_TAR_COMPRESS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002745# define USAGE_TAR_COMPRESS(a) a
Glenn L McGrath7370f622003-11-18 21:49:23 +00002746#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002747# define USAGE_TAR_COMPRESS(a)
Glenn L McGrath7370f622003-11-18 21:49:23 +00002748#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002749
Eric Andersen7e9276b2001-02-22 01:15:47 +00002750#define tar_trivial_usage \
Glenn L McGrath7370f622003-11-18 21:49:23 +00002751 "-[" 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 +00002752 USAGE_TAR_EXCLUDE("[-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00002753 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002754#define tar_full_usage \
2755 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00002756 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002757 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002758 "\tx\t\textract\n" \
2759 "\tt\t\tlist\n" \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002760 "\nArchive format selection:\n" \
2761 USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
2762 USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
Glenn L McGrath0c5d9c22003-11-18 23:27:49 +00002763 USAGE_TAR_COMPRESS("\tZ\t\tFilter the archive through compress\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002764 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002765 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002766 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002767 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002768 "\texclude\t\tfile to exclude\n" \
2769 "\tX\t\tfile with names to exclude\n" \
2770 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00002771 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002772 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002773#define tar_example_usage \
2774 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
2775 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002776
Eric Andersen7e9276b2001-02-22 01:15:47 +00002777#define tee_trivial_usage \
2778 "[OPTION]... [FILE]..."
2779#define tee_full_usage \
2780 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002781 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002782 "\t-a\tappend to the given FILEs, do not overwrite\n" \
2783 "\t-i\tignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002784#define tee_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002785 "$ echo \"Hello\" | tee /tmp/foo\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002786 "$ cat /tmp/foo\n" \
2787 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002788
Eric Andersen539ffc92004-02-22 12:25:47 +00002789#ifdef CONFIG_FEATURE_TELNET_AUTOLOGIN
2790#define telnet_trivial_usage \
2791 "[-a] [-l USER] HOST [PORT]"
2792#define telnet_full_usage \
2793 "Telnet is used to establish interactive communication with another\n" \
2794 "computer over a network using the TELNET protocol.\n\n" \
2795 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002796 "\t-a\t\tAttempt an automatic login with the USER variable\n" \
2797 "\t-l USER\t\tAttempt an automatic login with the USER argument\n" \
Eric Andersen539ffc92004-02-22 12:25:47 +00002798 "\tHOST\t\tThe official name, alias or the IP address of the\n" \
2799 "\t\t\tremote host.\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002800 "\tPORT\t\tThe remote port number to connect to. If it is not\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002801 "\t\t\tspecified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00002802#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00002803#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002804 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002805#define telnet_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002806 "Telnet is used to establish interactive communication with another\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002807 "computer over a network using the TELNET protocol."
Eric Andersen539ffc92004-02-22 12:25:47 +00002808#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002809
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002810#ifdef CONFIG_FEATURE_TELNETD_INETD
2811#define telnetd_trivial_usage \
2812 "(inetd mode) [OPTION]"
2813#define telnetd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002814 "Telnetd uses incoming TELNET connections via inetd.\n" \
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002815 "Options:\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002816 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002817 "\t-f issue_file\tDisplay issue_file instead of /etc/issue"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002818#else
Eric Andersen08a72202002-09-30 20:52:10 +00002819#define telnetd_trivial_usage \
2820 "[OPTION]"
2821#define telnetd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002822 "Telnetd listens for incoming TELNET connections on PORT.\n" \
Eric Andersen08a72202002-09-30 20:52:10 +00002823 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002824 "\t-p PORT\tlisten for connections on PORT (default 23)\n" \
2825 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)\n" \
2826 "\t-f issue_file\tDisplay issue_file instead of /etc/issue"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00002827#endif
Eric Andersen08a72202002-09-30 20:52:10 +00002828
Eric Andersen7e9276b2001-02-22 01:15:47 +00002829#define test_trivial_usage \
2830 "EXPRESSION\n or [ EXPRESSION ]"
2831#define test_full_usage \
2832 "Checks file types and compares values returning an exit\n" \
2833 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002834#define test_example_usage \
2835 "$ test 1 -eq 2\n" \
2836 "$ echo $?\n" \
2837 "1\n" \
2838 "$ test 1 -eq 1\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002839 "$ echo $?\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002840 "0\n" \
2841 "$ [ -d /etc ]\n" \
2842 "$ echo $?\n" \
2843 "0\n" \
2844 "$ [ -d /junk ]\n" \
2845 "$ echo $?\n" \
2846 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002847
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002848#ifdef CONFIG_FEATURE_TFTP_GET
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002849# define USAGE_TFTP_GET(a) a
Mark Whitley450736c2001-03-02 19:08:50 +00002850#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002851# define USAGE_TFTP_GET(a)
Mark Whitley450736c2001-03-02 19:08:50 +00002852#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002853#ifdef CONFIG_FEATURE_TFTP_PUT
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002854# define USAGE_TFTP_PUT(a) a
Mark Whitley450736c2001-03-02 19:08:50 +00002855#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002856# define USAGE_TFTP_PUT(a)
Mark Whitley450736c2001-03-02 19:08:50 +00002857#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002858#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002859# define USAGE_TFTP_BS(a) a
Glenn L McGrathad117d82001-10-05 04:40:37 +00002860#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002861# define USAGE_TFTP_BS(a)
Glenn L McGrathad117d82001-10-05 04:40:37 +00002862#endif
Mark Whitley450736c2001-03-02 19:08:50 +00002863
2864#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00002865 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00002866#define tftp_full_usage \
2867 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00002868 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002869 "\t-l FILE\tLocal FILE\n" \
2870 "\t-r FILE\tRemote FILE" \
2871 USAGE_TFTP_GET( \
2872 "\n\t-g\tGet file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002873 ) \
Mike Frysinger058e7402005-04-23 07:00:33 +00002874 USAGE_TFTP_PUT( \
2875 "\n\t-p\tPut file" \
Mark Whitley450736c2001-03-02 19:08:50 +00002876 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00002877 USAGE_TFTP_BS( \
Mike Frysinger058e7402005-04-23 07:00:33 +00002878 "\n\t-b SIZE\tTransfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00002879 )
Eric Andersenc3657422001-11-30 07:54:32 +00002880#define time_trivial_usage \
2881 "[OPTION]... COMMAND [ARGS...]"
2882#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00002883 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
2884 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00002885 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002886 "\t-v\tDisplays verbose resource usage information"
Mark Whitley450736c2001-03-02 19:08:50 +00002887
Eric Andersen420b2082002-09-17 22:14:58 +00002888#define top_trivial_usage \
2889 "[-d <seconds>]"
2890#define top_full_usage \
2891 "top provides an view of processor activity in real time.\n" \
2892 "This utility reads the status for all processes in /proc each <seconds>\n" \
2893 "and shows the status for however many processes will fit on the screen.\n" \
2894 "This utility will not show processes that are started after program startup,\n" \
2895 "but it will show the EXIT status for and PIDs that exit while it is running."
2896
Eric Andersen7e9276b2001-02-22 01:15:47 +00002897#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002898 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002899#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002900 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002901 "Options:\n" \
2902 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002903#define touch_example_usage \
2904 "$ ls -l /tmp/foo\n" \
2905 "/bin/ls: /tmp/foo: No such file or directory\n" \
2906 "$ touch /tmp/foo\n" \
2907 "$ ls -l /tmp/foo\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002908 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002909
2910#define tr_trivial_usage \
2911 "[-cds] STRING1 [STRING2]"
2912#define tr_full_usage \
2913 "Translate, squeeze, and/or delete characters from\n" \
2914 "standard input, writing to standard output.\n\n" \
2915 "Options:\n" \
2916 "\t-c\ttake complement of STRING1\n" \
2917 "\t-d\tdelete input characters coded STRING1\n" \
2918 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002919#define tr_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002920 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002921 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002922
Eric Andersen5c58d282001-07-10 16:29:00 +00002923#define traceroute_trivial_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002924 "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00002925 "\t[-s src_addr] [-t tos] [-w wait] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00002926#define traceroute_full_usage \
2927 "trace the route ip packets follow going to \"host\"\n" \
2928 "Options:\n" \
2929 "\t-d\tset SO_DEBUG options to socket\n" \
2930 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
2931 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
2932 "\t-v\tVerbose output\n" \
2933 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
2934 "\t-p port#\tSet the base UDP port number used in probes\n" \
2935 "\t\t(default is 33434)\n" \
2936 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
2937 "\t\t(default is 3)\n" \
2938 "\t-s src_addr\tUse the following IP address as the source address\n" \
2939 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
2940 "\t\t(default 0)\n" \
2941 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002942 "\t\t(default 3 sec.)"
Eric Andersen5c58d282001-07-10 16:29:00 +00002943
2944
Eric Andersen7e9276b2001-02-22 01:15:47 +00002945#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002946 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002947#define true_full_usage \
2948 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002949#define true_example_usage \
2950 "$ true\n" \
2951 "$ echo $?\n" \
2952 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002953
Eric Andersen7e9276b2001-02-22 01:15:47 +00002954#define tty_trivial_usage \
2955 ""
2956#define tty_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002957 "Print the file name of the terminal connected to standard input.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002958 "Options:\n" \
2959 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002960#define tty_example_usage \
2961 "$ tty\n" \
2962 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002963
Mike Frysinger174808c2005-06-11 01:14:09 +00002964#define tune2fs_trivial_usage \
2965 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
2966 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
2967 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
2968 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
2969 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
2970 "[-T last-check-time] [-U UUID] device"
2971#define tune2fs_full_usage \
2972 "Adjust filesystem options on ext[23] filesystems.\n\n"
2973
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002974#define udhcpc_trivial_usage \
Paul Foxa39bba32005-08-01 14:31:13 +00002975 "[-Cfbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002976#define udhcpc_full_usage \
Paul Foxa39bba32005-08-01 14:31:13 +00002977 "\t-c,\t--clientid=CLIENTID\tSet client identifier\n" \
2978 "\t-C,\t--clientid-none\tSuppress default client identifier\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002979 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00002980 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002981 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002982 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002983 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002984 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00002985 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
2986 "\t-q,\t--quit\tQuit after obtaining lease\n" \
2987 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
2988 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
2989 "\t-v,\t--version\tDisplay version"
2990
Russ Dill61fb4892002-10-14 21:41:28 +00002991#define udhcpd_trivial_usage \
2992 "[configfile]\n" \
2993
2994#define udhcpd_full_usage \
Glenn L McGrath9130c852002-12-12 12:56:18 +00002995 ""
Russ Dill61fb4892002-10-14 21:41:28 +00002996
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002997#ifdef CONFIG_FEATURE_MOUNT_FORCE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002998# define USAGE_MOUNT_FORCE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002999#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003000# define USAGE_MOUNT_FORCE(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00003001#endif
3002#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003003 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003004#define umount_full_usage \
3005 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00003006 "\nFlags:\n" "\t-a\tUnmount all file systems" \
3007 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
3008 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Eric Andersen77d92682001-05-23 20:32:09 +00003009 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \
John Beppu5d817682001-04-17 17:09:34 +00003010 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 +00003011#define umount_example_usage \
3012 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003013
3014#define uname_trivial_usage \
3015 "[OPTION]..."
3016#define uname_full_usage \
3017 "Print certain system information. With no OPTION, same as -s.\n\n" \
3018 "Options:\n" \
3019 "\t-a\tprint all information\n" \
3020 "\t-m\tthe machine (hardware) type\n" \
3021 "\t-n\tprint the machine's network node hostname\n" \
3022 "\t-r\tprint the operating system release\n" \
3023 "\t-s\tprint the operating system name\n" \
3024 "\t-p\tprint the host processor type\n" \
3025 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003026#define uname_example_usage \
3027 "$ uname -a\n" \
Eric Andersen7f48a952003-12-28 05:06:56 +00003028 "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 +00003029
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003030#define uncompress_trivial_usage \
3031 "[-c] [-f] [ name ... ]"
3032#define uncompress_full_usage \
3033 "Uncompress .Z file[s]\n" \
3034 "Options:\n" \
3035 "\t-c\textract to stdout\n" \
Eric Andersen178de172004-04-06 16:36:20 +00003036 "\t-f\tforce overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00003037
Eric Andersen7e9276b2001-02-22 01:15:47 +00003038#define uniq_trivial_usage \
3039 "[OPTION]... [INPUT [OUTPUT]]"
3040#define uniq_full_usage \
3041 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00003042 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003043 "Options:\n" \
3044 "\t-c\tprefix lines by the number of occurrences\n" \
3045 "\t-d\tonly print duplicate lines\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00003046 "\t-u\tonly print unique lines\n" \
3047 "\t-f N\tskip the first N fields\n" \
3048 "\t-s N\tskip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003049#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00003050 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003051 "a\n" \
3052 "b\n" \
3053 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003054
3055#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003056 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003057#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003058 "Converts FILE from unix format to dos format. When no option\n" \
3059 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00003060 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00003061 "Options:\n" \
3062 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00003063 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003064
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003065#define unzip_trivial_usage \
3066 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
3067#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00003068 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003069 "Options:\n" \
3070 "\t-l\tlist archive contents (short form)\n" \
3071 "\t-n\tnever overwrite existing files (default)\n" \
3072 "\t-o\toverwrite files without prompting\n" \
3073 "\t-p\tsend output to stdout\n" \
3074 "\t-q\tbe quiet\n" \
3075 "\t-x\texclude these files\n" \
3076 "\t-d\textract files into this directory"
3077
Eric Andersen7e9276b2001-02-22 01:15:47 +00003078#define uptime_trivial_usage \
3079 ""
3080#define uptime_full_usage \
3081 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003082#define uptime_example_usage \
3083 "$ uptime\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003084 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003085
3086#define usleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00003087 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003088#define usleep_full_usage \
3089 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003090#define usleep_example_usage \
3091 "$ usleep 1000000\n" \
3092 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003093
3094#define uudecode_trivial_usage \
3095 "[FILE]..."
3096#define uudecode_full_usage \
3097 "Uudecode a file that is uuencoded.\n\n" \
3098 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003099 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003100#define uudecode_example_usage \
3101 "$ uudecode -o busybox busybox.uu\n" \
3102 "$ ls -l busybox\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003103 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003104
3105#define uuencode_trivial_usage \
3106 "[OPTION] [INFILE] REMOTEFILE"
3107#define uuencode_full_usage \
3108 "Uuencode a file.\n\n" \
3109 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00003110 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003111#define uuencode_example_usage \
3112 "$ uuencode busybox busybox\n" \
3113 "begin 755 busybox\n" \
3114 "<encoded file snipped>\n" \
3115 "$ uudecode busybox busybox > busybox.uu\n" \
3116 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003117
Eric Andersen853c4942003-01-23 05:59:32 +00003118#define vconfig_trivial_usage \
3119 "COMMAND [OPTIONS] ..."
Eric Andersen853c4942003-01-23 05:59:32 +00003120#define vconfig_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00003121 "vconfig lets you create and remove virtual ethernet devices.\n\n" \
3122 "Options:\n" \
3123 "\tadd [interface-name] [vlan_id]\n" \
3124 "\trem [vlan-name]\n" \
3125 "\tset_flag [interface-name] [flag-num] [0 | 1]\n" \
3126 "\tset_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3127 "\tset_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3128 "\tset_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00003129
Eric Andersen3f980402001-04-04 17:31:15 +00003130#define vi_trivial_usage \
3131 "[OPTION] [FILE]..."
3132#define vi_full_usage \
3133 "edit FILE.\n\n" \
3134 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003135 "\t-R\tRead-only- do not write to the file"
Eric Andersen3f980402001-04-04 17:31:15 +00003136
Eric Andersen27f64e12002-06-23 04:24:25 +00003137#define vlock_trivial_usage \
3138 "[OPTIONS]"
3139#define vlock_full_usage \
3140 "Lock a virtual terminal. A password is required to unlock\n" \
3141 "Options:\n" \
3142 "\t-a\tLock all VTs"
3143
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003144#define watch_trivial_usage \
3145 "[-n <seconds>] COMMAND..."
3146#define watch_full_usage \
3147 "Executes a program periodically.\n" \
3148 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003149 "\t-n\tLoop period in seconds - default is 2"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003150#define watch_example_usage \
3151 "$ watch date\n" \
3152 "Mon Dec 17 10:31:40 GMT 2000\n" \
3153 "Mon Dec 17 10:31:42 GMT 2000\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003154 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003155
Eric Andersen7e9276b2001-02-22 01:15:47 +00003156#define watchdog_trivial_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00003157 "[-t <seconds>] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003158#define watchdog_full_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00003159 "Periodically write to watchdog device DEV.\n" \
3160 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003161 "\t-t\tTimer period in seconds - default is 30"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003162
3163#define wc_trivial_usage \
3164 "[OPTION]... [FILE]..."
3165#define wc_full_usage \
3166 "Print line, word, and byte counts for each FILE, and a total line if\n" \
3167 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
3168 "Options:\n" \
3169 "\t-c\tprint the byte counts\n" \
3170 "\t-l\tprint the newline counts\n" \
3171 "\t-L\tprint the length of the longest line\n" \
3172 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003173#define wc_example_usage \
3174 "$ wc /etc/passwd\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003175 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003176
3177#define wget_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00003178 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00003179 "\t\t[--header 'header: value'] [-Y|--proxy on/off] [-P DIR] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003180#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00003181 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003182 "Options:\n" \
3183 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00003184 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00003185 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00003186 "\t-O\tsave to filename ('-' for stdout)\n" \
3187 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003188
3189#define which_trivial_usage \
3190 "[COMMAND ...]"
3191#define which_full_usage \
3192 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003193#define which_example_usage \
3194 "$ which login\n" \
3195 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00003196
Eric Andersen00a6a752002-04-26 23:53:10 +00003197#define who_trivial_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003198 " "
Eric Andersen00a6a752002-04-26 23:53:10 +00003199#define who_full_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003200 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003201
3202#define whoami_trivial_usage \
3203 ""
3204#define whoami_full_usage \
3205 "Prints the user name associated with the current effective user id."
3206
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003207#ifdef CONFIG_FEATURE_XARGS_SUPPORT_CONFIRMATION
3208#define USAGE_XARGS_CONFIRMATION(a) a
3209#else
3210#define USAGE_XARGS_CONFIRMATION(a)
3211#endif
3212#ifdef CONFIG_FEATURE_XARGS_SUPPORT_TERMOPT
3213#define USAGE_XARGS_TERMOPT(a) a
3214#else
3215#define USAGE_XARGS_TERMOPT(a)
3216#endif
3217#ifdef CONFIG_FEATURE_XARGS_SUPPORT_ZERO_TERM
3218#define USAGE_XARGS_ZERO_TERM(a) a
3219#else
3220#define USAGE_XARGS_ZERO_TERM(a)
3221#endif
3222
3223
Eric Andersen7e9276b2001-02-22 01:15:47 +00003224#define xargs_trivial_usage \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003225 "[COMMAND] [OPTIONS] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003226#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00003227 "Executes COMMAND on every item given by standard input.\n\n" \
3228 "Options:\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003229 USAGE_XARGS_CONFIRMATION("\t-p\tPrompt the user about whether to run each command\n") \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00003230 "\t-r\tDo not run command for empty readed lines\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003231 USAGE_XARGS_TERMOPT("\t-x\tExit if the size is exceeded\n") \
3232 USAGE_XARGS_ZERO_TERM("\t-0\tInput filenames are terminated by a null character\n") \
Mike Frysinger058e7402005-04-23 07:00:33 +00003233 "\t-t\tPrint the command line on stderr before executing it"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003234#define xargs_example_usage \
3235 "$ ls | xargs gzip\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003236 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003237
3238#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003239 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003240#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003241 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003242
Eric Andersen7e9276b2001-02-22 01:15:47 +00003243#define zcat_trivial_usage \
3244 "FILE"
3245#define zcat_full_usage \
3246 "Uncompress to stdout."
Eric Andersen178de172004-04-06 16:36:20 +00003247
Rob Landleyad8071f2005-04-30 03:49:37 +00003248#define zcip_trivial_usage \
3249 "[OPTIONS] ifname script"
3250#define zcip_full_usage \
3251 "zcip manages a ZeroConf IPv4 link-local address.\n" \
3252 "Options:\n" \
3253 "\t-f foreground mode\n" \
3254 "\t-q quit after address (no daemon)\n" \
3255 "\t-r 169.254.x.x request this address first\n" \
3256 "\t-v verbose; show version\n"
3257
Eric Andersen178de172004-04-06 16:36:20 +00003258#endif /* __BB_USAGE_H__ */