blob: 9de9df8f39fa344d7e08642549b64673cd32a3d9 [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"
Mike Frysinger036f2992005-09-24 23:50:14 +0000238
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
Mike Frysinger51a43b42005-09-24 07:11:16 +0000549#define e2fsck_trivial_usage \
550 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
551 "[-I inode_buffer_blocks] [-P process_inode_size] " \
552 "[-l|-L bad_blocks_file] [-C fd] [-j ext-journal] " \
553 "[-E extended-options] device"
554#define e2fsck_full_usage \
555 "Check a Linux ext2/ext3 file system.\n\n" \
556 "Options:\n" \
557 "\t-p\tAutomatic repair (no questions)\n" \
558 "\t-n\tMake no changes to the filesystem\n" \
559 "\t-y\tAssume 'yes' to all questions\n" \
560 "\t-c\tCheck for bad blocks and add them to the badblock list\n" \
561 "\t-f\tForce checking even if filesystem is marked clean\n" \
562 "\t-v\tBe verbose\n" \
563 "\t-b superblock\tUse alternative superblock\n" \
564 "\t-B blocksize\tForce blocksize when looking for superblock\n" \
565 "\t-j journal\tSet location of the external journal\n" \
566 "\t-l file\tAdd to badblocks list\n" \
567 "\t-L file\tSet badblocks list"
568
Manuel Novoa III cad53642003-03-19 09:13:01 +0000569#ifdef CONFIG_FEATURE_FANCY_ECHO
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000570# define USAGE_FANCY_ECHO(a) a
Manuel Novoa III cad53642003-03-19 09:13:01 +0000571#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000572# define USAGE_FANCY_ECHO(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +0000573#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000574
Eric Andersen7e9276b2001-02-22 01:15:47 +0000575#define echo_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000576 USAGE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000577#define echo_full_usage \
578 "Prints the specified ARGs to stdout\n\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000579 USAGE_FANCY_ECHO("Options:\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000580 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000581 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000582 "\t-E\tdisable interpretation of backslash-escaped characters")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000583#define echo_example_usage \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000584 "$ echo \"Erik is cool\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000585 "Erik is cool\n" \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000586 USAGE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000587 "Erik\n" \
588 "is\n" \
589 "cool\n" \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000590 "$ echo \"Erik\\nis\\ncool\"\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000591 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000592
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000593#define eject_trivial_usage \
594 "[-t] [DEVICE]"
595#define eject_full_usage \
596 "Eject specified DEVICE (or default /dev/cdrom).\n\n" \
597 "Options:\n" \
Rob Landley9ea88362005-05-14 00:46:18 +0000598 "\t-t\tclose tray"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000599
Eric Andersen84e229c2001-03-29 22:48:33 +0000600#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000601 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000602#define env_full_usage \
603 "Prints the current environment or runs a program after setting\n" \
604 "up the specified environment.\n\n" \
605 "Options:\n" \
606 "\t-, -i\tstart with an empty environment\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000607 "\t-u\tremove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000608
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000609#define ether_wake_trivial_usage \
610 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
611#define ether_wake_full_usage \
612 "Send a magic packet to wake up sleeping machines.\n" \
613 "MAC must be a station address (00:11:22:33:44:55) or\n" \
614 " a hostname with a known 'ethers' entry.\n\n" \
615 "Options:\n" \
616 "\t-b\t\tSend wake-up packet to the broadcast address\n" \
617 "\t-i iface\tUse interface ifname instead of the default \"eth0\"\n" \
618 "\t-p pass\tAppend the four or six byte password PW to the packet\n"
619
Eric Andersen7e9276b2001-02-22 01:15:47 +0000620#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000621 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000622#define expr_full_usage \
623 "Prints the value of EXPRESSION to standard output.\n\n" \
624 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000625 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
626 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
627 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
628 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
629 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
630 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
631 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
632 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
633 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
634 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
635 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
636 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
637 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000638 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
639 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
640 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
641 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
642 "\t or 0\n" \
643 "\tlength STRING length of STRING\n" \
644 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
645 "\t it is a keyword like `match' or an\n" \
646 "\t operator like `/'\n" \
647 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000648 "Beware that many operators need to be escaped or quoted for shells.\n" \
649 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
650 "lexicographical. Pattern matches return the string matched between \n" \
651 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
652 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000653
Mike Frysingerfa69f112005-04-17 07:24:19 +0000654#define fakeidentd_trivial_usage \
655 "[-b ip] [STRING]"
656#define fakeidentd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +0000657 "Returns a set string to auth requests\n\n" \
658 "\t-b\tBind to ip address\n" \
Mike Frysingerfa69f112005-04-17 07:24:19 +0000659 "\tSTRING\tThe ident answer string (default is nobody)"
660
Eric Andersen7e9276b2001-02-22 01:15:47 +0000661#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000662 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000663#define false_full_usage \
664 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000665#define false_example_usage \
666 "$ false\n" \
667 "$ echo $?\n" \
668 "1\n"
669
670#define fbset_trivial_usage \
671 "[options] [mode]"
672#define fbset_full_usage \
673 "Show and modify frame buffer settings"
674#define fbset_example_usage \
675 "$ fbset\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000676 "mode \"1024x768-76\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000677 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
678 "\tgeometry 1024 768 1024 768 16\n" \
679 "\ttimings 12714 128 32 16 4 128 4\n" \
680 "\taccel false\n" \
681 "\trgba 5/11,6/5,5/0,0/0\n" \
682 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000683
Eric Andersen7e9276b2001-02-22 01:15:47 +0000684#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000685 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000686#define fdflush_full_usage \
687 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000688
Eric Andersen01c3d402003-07-05 07:51:31 +0000689#define fdformat_trivial_usage \
690 "[-n] DEVICE"
691#define fdformat_full_usage \
692 "Low-level formats a floppy disk\n\n" \
693 "Options:\n" \
694 "\t-n\tDon't verify after format"
695
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000696#define fdisk_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000697 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000698#define fdisk_full_usage \
699 "Change partition table\n" \
700 "Options:\n" \
Eric Andersena151d192004-04-06 17:16:36 +0000701 "\t-l List partition table(s)\n" \
702 "\t-u Give Start and End in sector (instead of cylinder) units\n" \
703 "\t-s PARTITION Give partition size(s) in blocks\n" \
704 "\t-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000705 "\t-C CYLINDERS Set the number of cylinders\n" \
706 "\t-H HEADS Set the number of heads\n" \
707 "\t-S SECTORS Set the number of sectors\n" \
Eric Andersena151d192004-04-06 17:16:36 +0000708 "\t-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000709
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000710#ifdef CONFIG_FEATURE_FIND_TYPE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000711# define USAGE_FIND_TYPE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +0000712#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000713# define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000714#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000715#ifdef CONFIG_FEATURE_FIND_PERM
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000716# define USAGE_FIND_PERM(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +0000717#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000718# define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000719#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000720#ifdef CONFIG_FEATURE_FIND_MTIME
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000721# define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000722#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000723# define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000724#endif
Eric Andersen97d86f22003-01-23 05:27:42 +0000725#ifdef CONFIG_FEATURE_FIND_NEWER
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000726# define USAGE_FIND_NEWER(a) a
Eric Andersen97d86f22003-01-23 05:27:42 +0000727#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000728# define USAGE_FIND_NEWER(a)
Eric Andersen97d86f22003-01-23 05:27:42 +0000729#endif
730#ifdef CONFIG_FEATURE_FIND_INUM
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000731# define USAGE_FIND_INUM(a) a
Eric Andersen97d86f22003-01-23 05:27:42 +0000732#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000733# define USAGE_FIND_INUM(a)
Eric Andersen97d86f22003-01-23 05:27:42 +0000734#endif
Rob Landley5d3a0e82005-10-04 03:34:39 +0000735#ifdef CONFIG_FEATURE_FIND_EXEC
736# define USAGE_FIND_EXEC(a) a
737#else
738# define USAGE_FIND_EXEC(a)
739#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000740
Eric Andersen7e9276b2001-02-22 01:15:47 +0000741#define find_trivial_usage \
742 "[PATH...] [EXPRESSION]"
743#define find_full_usage \
744 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000745 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000746 "\nEXPRESSION may consist of:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000747 "\t-follow\t\tDereference symbolic links\n" \
748 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN\n" \
749 "\t-print\t\tPrint (default and assumed)\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000750 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000751 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
752) USAGE_FIND_PERM( \
753 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
754) USAGE_FIND_MTIME( \
Eric Andersen97d86f22003-01-23 05:27:42 +0000755 "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \
756) USAGE_FIND_NEWER( \
757 "\n\t-newer FILE\tModified time is more recent than FILE's" \
758) USAGE_FIND_INUM( \
Rob Landley5d3a0e82005-10-04 03:34:39 +0000759 "\n\t-inum N\t\tFile has inode number N" \
760) USAGE_FIND_EXEC( \
761 "\n\t-exec CMD\tExecute CMD with all instances of {} replaced by the" \
762 "\n\t\t\tfiles matching EXPRESSION")
763
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000764#define find_example_usage \
Eric Andersen75eb90f2004-03-29 08:20:08 +0000765 "$ find / -name passwd\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000766 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000767
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000768#define fold_trivial_usage \
Glenn L McGrath0bd02572005-12-11 03:09:05 +0000769 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000770#define fold_full_usage \
771 "Wrap input lines in each FILE (standard input by default), writing to\n" \
772 "standard output.\n\n" \
773 "Options:\n" \
774 "\t-b\tcount bytes rather than columns\n" \
775 "\t-s\tbreak at spaces\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000776 "\t-w\tuse WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000777
Eric Andersen7e9276b2001-02-22 01:15:47 +0000778#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000779 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000780#define free_full_usage \
781 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000782#define free_example_usage \
783 "$ free\n" \
784 " total used free shared buffers\n" \
785 " Mem: 257628 248724 8904 59644 93124\n" \
786 " Swap: 128516 8404 120112\n" \
787 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000788
Eric Andersen7e9276b2001-02-22 01:15:47 +0000789#define freeramdisk_trivial_usage \
790 "DEVICE"
791#define freeramdisk_full_usage \
792 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000793#define freeramdisk_example_usage \
794 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000795
Mike Frysinger51a43b42005-09-24 07:11:16 +0000796#define fsck_trivial_usage \
797 "[-ANPRTV] [ -C [ fd ] ] [-t fstype] [fs-options] [filesys ...]"
798#define fsck_full_usage \
799 "Check and repair filesystems.\n\n" \
800 "Options:\n" \
801 "\t-A\tWalk /etc/fstab and check all filesystems\n" \
802 "\t-N\tDon't execute, just show what would be done\n" \
803 "\t-P\tWhen using -A, check filesystems in parallel\n" \
804 "\t-R\tWhen using -A, skip the root filesystem\n" \
805 "\t-T\tDon't show title on startup\n" \
806 "\t-V\tVerbose mode\n" \
807 "\t-C\tWrite status information to specified filedescriptor\n" \
808 "\t-t\tList of filesystem types to check"
809
Eric Andersen7e9276b2001-02-22 01:15:47 +0000810#define fsck_minix_trivial_usage \
811 "[-larvsmf] /dev/name"
812#define fsck_minix_full_usage \
813 "Performs a consistency check for MINIX filesystems.\n\n" \
814 "Options:\n" \
815 "\t-l\tLists all filenames\n" \
816 "\t-r\tPerform interactive repairs\n" \
817 "\t-a\tPerform automatic repairs\n" \
818 "\t-v\tverbose\n" \
819 "\t-s\tOutputs super-block information\n" \
820 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000821 "\t-f\tForce file system check"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000822
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000823#define ftpget_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000824 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000825#define ftpget_full_usage \
826 "Retrieve a remote file via FTP.\n\n" \
827 "Options:\n" \
828 "\t-c, --continue Continue a previous transfer\n" \
829 "\t-v, --verbose Verbose\n" \
830 "\t-u, --username Username to be used\n" \
831 "\t-p, --password Password to be used\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000832 "\t-P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000833
834#define ftpput_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000835 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000836#define ftpput_full_usage \
837 "Store a local file on a remote machine via FTP.\n\n" \
838 "Options:\n" \
839 "\t-v, --verbose Verbose\n" \
840 "\t-u, --username Username to be used\n" \
841 "\t-p, --password Password to be used\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000842 "\t-P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000843
Rob Landleyaa872762005-10-28 13:05:12 +0000844#define fuser_trivial_usage \
845 "[options] file OR port/proto"
846#define fuser_full_usage \
847 "Options:\n" \
848 "\t-m Show all processes on the same mounted fs\n" \
849 "\t-k Kill all processes that match.\n" \
850 "\t-s Don't print or kill anything.\n" \
851 "\t-4 When using port/proto only search IPv4 space\n" \
852 "\t-6 When using port/proto only search IPv6 space\n" \
853 "\t-SIGNAL When used with -k, this signal will be used to kill\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000854#define getopt_trivial_usage \
855 "[OPTIONS]..."
856#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000857 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000858 "\t-a, --alternative Allow long options starting with single -\n" \
859 "\t-l, --longoptions=longopts Long options to be recognized\n" \
860 "\t-n, --name=progname The name under which errors are reported\n" \
861 "\t-o, --options=optstring Short options to be recognized\n" \
862 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
863 "\t-Q, --quiet-output No normal output\n" \
864 "\t-s, --shell=shell Set shell quoting conventions\n" \
865 "\t-T, --test Test for getopt(1) version\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000866 "\t-u, --unquoted Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000867#define getopt_example_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000868 "$ cat getopt.test\n" \
869 "#!/bin/sh\n" \
870 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
871 " -n 'example.busybox' -- \"$@\"`\n" \
872 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000873 "eval set -- \"$GETOPT\"\n" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000874 "while true ; do\n" \
875 " case $1 in\n" \
876 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
877 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
878 " -c|--c-long)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000879 " case \"$2\" in\n" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000880 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
881 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
882 " esac ;;\n" \
883 " --) shift ; break ;;\n" \
884 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
885 " esac\n" \
886 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000887
Eric Andersenf349e972001-08-21 16:18:59 +0000888#define getty_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000889 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +0000890#define getty_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +0000891 "Opens a tty, prompts for a login name, then invokes /bin/login\n\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000892 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000893 "\t-h\t\tEnable hardware (RTS/CTS) flow control\n" \
894 "\t-i\t\tDo not display /etc/issue before running login\n" \
895 "\t-L\t\tLocal line, so do not do carrier detect\n" \
896 "\t-m\t\tGet baud rate from modem's CONNECT status message\n" \
897 "\t-w\t\tWait for a CR or LF before sending /etc/issue\n" \
898 "\t-n\t\tDo not prompt the user for a login name\n" \
899 "\t-f issue_file\tDisplay issue_file instead of /etc/issue\n" \
900 "\t-l login_app\tInvoke login_app instead of /bin/login\n" \
901 "\t-t timeout\tTerminate after timeout if no username is read\n" \
902 "\t-I initstring\tSets the init string to send before anything else\n" \
903 "\t-H login_host\tLog login_host into the utmp file as the hostname"
Eric Andersenf349e972001-08-21 16:18:59 +0000904
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000905#if ENABLE_FEATURE_GREP_EGREP_ALIAS
906#define USAGE_GREP_E(a) a
907#else
908#define USAGE_GREP_E(a)
909#endif
910#if ENABLE_FEATURE_GREP_CONTEXT
911#define USAGE_GREP_CTX(a) a
912#else
913#define USAGE_GREP_CTX(a)
914#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000915#define grep_trivial_usage \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000916 "[-ihHnqvs" \
917 USAGE_GREP_E("E") \
918 USAGE_GREP_CTX("ABC") \
919 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000920#define grep_full_usage \
921 "Search for PATTERN in each FILE or standard input.\n\n" \
922 "Options:\n" \
923 "\t-H\tprefix output lines with filename where match was found\n" \
924 "\t-h\tsuppress the prefixing filename on output\n" \
925 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000926 "\t-l\tlist names of files that match\n" \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000927 "\t-L\tlist names of files that do not match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000928 "\t-n\tprint line number with output lines\n" \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000929 "\t-q\tbe quiet. Returns 0 if PATTERN was found, 1 otherwise\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000930 "\t-v\tselect non-matching lines\n" \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000931 "\t-s\tsuppress file open/read error messages\n" \
932 "\t-c\tonly print count of matching lines\n" \
933 "\t-f\tread PATTERN from file\n" \
934 "\t-e\tPATTERN is a regular expression\n" \
935 "\t-F\tPATTERN is a set of newline-separated strings" \
936 USAGE_GREP_E("\n\t-E\tPATTERN is an extended regular expression") \
937 USAGE_GREP_CTX("\n\t-A\tprint NUM lines of trailing context") \
938 USAGE_GREP_CTX("\n\t-B\tprint NUM lines of leading context") \
939 USAGE_GREP_CTX("\n\t-C\tprint NUM lines of output context")
940
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000941#define grep_example_usage \
942 "$ grep root /etc/passwd\n" \
943 "root:x:0:0:root:/root:/bin/bash\n" \
944 "$ grep ^[rR]oo. /etc/passwd\n" \
945 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000946
Eric Andersen7e9276b2001-02-22 01:15:47 +0000947#define gunzip_trivial_usage \
948 "[OPTION]... FILE"
949#define gunzip_full_usage \
950 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
951 "Options:\n" \
952 "\t-c\tWrite output to standard output\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000953 "\t-f\tForce read when source is a terminal\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000954 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000955#define gunzip_example_usage \
956 "$ ls -la /tmp/BusyBox*\n" \
957 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
958 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
959 "$ ls -la /tmp/BusyBox*\n" \
960 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000961
962#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000963 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000964#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000965 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000966 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000967 "Options:\n" \
968 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000969 "\t-d\tDecompress\n" \
970 "\t-f\tForce write when destination is a terminal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000971#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000972 "$ ls -la /tmp/busybox*\n" \
973 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
974 "$ gzip /tmp/busybox.tar\n" \
975 "$ ls -la /tmp/busybox*\n" \
976 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000977
978#define halt_trivial_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +0000979 "[-d<delay>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000980#define halt_full_usage \
Glenn L McGrathd2501672004-07-23 05:16:17 +0000981 "Halt the system.\n" \
982 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000983 "\t-d\t\tdelay interval for halting"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000984
Eric Andersen3443bd72003-07-22 07:30:36 +0000985#ifdef CONFIG_FEATURE_HDPARM_GET_IDENTITY
986#define USAGE_HDPARM_IDENT(a) a
987#else
988#define USAGE_HDPARM_IDENT(a)
989#endif
990
991#ifdef CONFIG_FEATURE_HDPARM_HDIO_SCAN_HWIF
992#define USAGE_SCAN_HWIF(a) a
993#else
994#define USAGE_SCAN_HWIF(a)
995#endif
996
997#ifdef CONFIG_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF
998#define USAGE_UNREGISTER_HWIF(a) a
999#else
1000#define USAGE_UNREGISTER_HWIF(a)
1001#endif
1002
1003#ifdef CONFIG_FEATURE_HDPARM_HDIO_DRIVE_RESET
1004#define USAGE_DRIVE_RESET(a) a
1005#else
1006#define USAGE_DRIVE_RESET(a)
1007#endif
1008
1009#ifdef CONFIG_FEATURE_HDPARM_HDIO_TRISTATE_HWIF
1010#define USAGE_TRISTATE_HWIF(a) a
1011#else
1012#define USAGE_TRISTATE_HWIF(a)
1013#endif
1014
Eric Andersen0a57a792003-08-06 08:57:35 +00001015#ifdef CONFIG_FEATURE_HDPARM_HDIO_GETSET_DMA
1016#define USAGE_GETSET_DMA(a) a
1017#else
1018#define USAGE_GETSET_DMA(a)
1019#endif
1020
Eric Andersen3443bd72003-07-22 07:30:36 +00001021#define hdparm_trivial_usage \
1022 "[options] [device] .."
1023#define hdparm_full_usage \
1024 "Options:" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001025 "\t-a get/set fs readahead\n" \
1026 "\t-A set drive read-lookahead flag (0/1)\n" \
1027 "\t-b get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
1028 "\t-B set Advanced Power Management setting (1-255)\n" \
1029 "\t-c get/set IDE 32-bit IO setting\n" \
1030 "\t-C check IDE power mode status\n" \
1031 USAGE_GETSET_DMA("\t-d get/set using_dma flag\n") \
1032 "\t-D enable/disable drive defect-mgmt\n" \
1033 "\t-f flush buffer cache for device on exit\n" \
1034 "\t-g display drive geometry\n" \
1035 "\t-h display terse usage information\n" \
1036 "\t-i display drive identification\n" \
1037 USAGE_HDPARM_IDENT("\t-I detailed/current information directly from drive\n") \
1038 USAGE_HDPARM_IDENT("\t-Istdin similar to -I, but wants /proc/ide/" "*" "/hd?/identify as input\n") \
1039 "\t-k get/set keep_settings_over_reset flag (0/1)\n" \
1040 "\t-K set drive keep_features_over_reset flag (0/1)\n" \
1041 "\t-L set drive doorlock (0/1) (removable harddisks only)\n" \
1042 "\t-m get/set multiple sector count\n" \
1043 "\t-n get/set ignore-write-errors flag (0/1)\n" \
1044 "\t-p set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
1045 "\t-P set drive prefetch count\n" \
1046 "\t-q change next setting quietly\n" \
1047 "\t-Q get/set DMA tagged-queuing depth (if supported)\n" \
1048 "\t-r get/set readonly flag (DANGEROUS to set)\n" \
1049 USAGE_SCAN_HWIF("\t-R register an IDE interface (DANGEROUS)\n") \
1050 "\t-S set standby (spindown) timeout\n" \
1051 "\t-t perform device read timings\n" \
1052 "\t-T perform cache read timings\n" \
1053 "\t-u get/set unmaskirq flag (0/1)\n" \
1054 USAGE_UNREGISTER_HWIF("\t-U un-register an IDE interface (DANGEROUS)\n") \
1055 "\t-v defaults; same as -mcudkrag for IDE drives\n" \
1056 "\t-V display program version and exit immediately\n" \
1057 USAGE_DRIVE_RESET("\t-w perform device reset (DANGEROUS)\n") \
1058 "\t-W set drive write-caching flag (0/1) (DANGEROUS)\n" \
1059 USAGE_TRISTATE_HWIF("\t-x tristate device for hotswap (0/1) (DANGEROUS)\n") \
1060 "\t-X set IDE xfer mode (DANGEROUS)\n" \
1061 "\t-y put IDE drive in standby mode\n" \
1062 "\t-Y put IDE drive to sleep\n" \
1063 "\t-Z disable Seagate auto-powersaving mode\n" \
1064 "\t-z re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +00001065
Manuel Novoa III cad53642003-03-19 09:13:01 +00001066#ifdef CONFIG_FEATURE_FANCY_HEAD
1067#define USAGE_FANCY_HEAD(a) a
1068#else
1069#define USAGE_FANCY_HEAD(a)
1070#endif
1071
Eric Andersen7e9276b2001-02-22 01:15:47 +00001072#define head_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +00001073 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001074#define head_full_usage \
1075 "Print first 10 lines of each FILE to standard output.\n" \
1076 "With more than one FILE, precede each with a header giving the\n" \
1077 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001078 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001079 "\t-n NUM\t\tPrint first NUM lines instead of first 10" \
1080 USAGE_FANCY_HEAD( \
1081 "\n\t-c NUM\t\toutput the first NUM bytes\n" \
1082 "\t-q\t\tnever output headers giving file names\n" \
1083 "\t-v\t\talways output headers giving file names" )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001084#define head_example_usage \
1085 "$ head -n 2 /etc/passwd\n" \
1086 "root:x:0:0:root:/root:/bin/bash\n" \
1087 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001088
Glenn L McGrath60281112001-11-02 11:39:46 +00001089#define hexdump_trivial_usage \
Paul Fox969af892005-11-28 21:06:00 +00001090 "[-[bcCdefnosvx]] [OPTION] FILE"
Glenn L McGrath60281112001-11-02 11:39:46 +00001091#define hexdump_full_usage \
1092 "The hexdump utility is a filter which displays the specified files,\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001093 "or the standard input, if no files are specified, in a user specified\n" \
Glenn L McGrath60281112001-11-02 11:39:46 +00001094 "format\n" \
1095 "\t-b\t\tOne-byte octal display\n" \
1096 "\t-c\t\tOne-byte character display\n" \
Paul Fox969af892005-11-28 21:06:00 +00001097 "\t-C\t\tCanonical hex+ASCII, 16 bytes per line\n" \
Glenn L McGrath60281112001-11-02 11:39:46 +00001098 "\t-d\t\tTwo-byte decimal display\n" \
1099 "\t-e FORMAT STRING\n" \
1100 "\t-f FORMAT FILE\n" \
1101 "\t-n LENGTH\tInterpret only length bytes of input\n" \
1102 "\t-o\t\tTwo-byte octal display\n" \
1103 "\t-s OFFSET\tSkip offset byte\n" \
1104 "\t-v\t\tdisplay all input data\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001105 "\t-x\t\tTwo-byte hexadecimal display"
Glenn L McGrath60281112001-11-02 11:39:46 +00001106
Eric Andersen7e9276b2001-02-22 01:15:47 +00001107#define hostid_trivial_usage \
1108 ""
1109#define hostid_full_usage \
1110 "Print out a unique 32-bit identifier for the machine."
1111
1112#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001113 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001114#define hostname_full_usage \
1115 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001116 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001117 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +00001118 "\t-s\tShort\n" \
1119 "\t-i\tAddresses for the hostname\n" \
1120 "\t-d\tDNS domain name\n" \
1121 "\t-f\tFully qualified domain name\n" \
1122 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001123#define hostname_example_usage \
1124 "$ hostname\n" \
Eric Andersen08f59e32004-03-12 22:07:10 +00001125 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001126
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001127#ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001128# define USAGE_HTTPD_BASIC_AUTH(a) a
1129# ifdef CONFIG_FEATURE_HTTPD_AUTH_MD5
1130# define USAGE_HTTPD_AUTH_MD5(a) a
1131# else
1132# define USAGE_HTTPD_AUTH_MD5(a)
1133# endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001134#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001135# define USAGE_HTTPD_BASIC_AUTH(a)
1136# define USAGE_HTTPD_AUTH_MD5(a)
Eric Andersen40520512003-07-28 09:59:05 +00001137#endif
1138#ifdef CONFIG_FEATURE_HTTPD_USAGE_FROM_INETD_ONLY
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001139# define USAGE_HTTPD_STANDALONE(a)
1140# define USAGE_HTTPD_SETUID(a)
Eric Andersen40520512003-07-28 09:59:05 +00001141#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001142# define USAGE_HTTPD_STANDALONE(a) a
1143# ifdef CONFIG_FEATURE_HTTPD_SETUID
1144# define USAGE_HTTPD_SETUID(a) a
1145# else
1146# define USAGE_HTTPD_SETUID(a)
1147# endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001148#endif
1149#define httpd_trivial_usage \
Eric Andersen40520512003-07-28 09:59:05 +00001150 "[-c <conf file>]" \
1151 USAGE_HTTPD_STANDALONE(" [-p <port>]") \
1152 USAGE_HTTPD_SETUID(" [-u user]") \
1153 USAGE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
1154 USAGE_HTTPD_AUTH_MD5(" [-m pass]") \
Eric Andersen73afd892004-04-14 17:59:21 +00001155 " [-h home]" \
Eric Andersen40520512003-07-28 09:59:05 +00001156 " [-d/-e <string>]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001157#define httpd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001158 "Listens for incoming http server requests.\n\n" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001159 "Options:\n" \
1160 "\t-c FILE\t\tSpecifies configuration file. (default httpd.conf)\n" \
1161 USAGE_HTTPD_STANDALONE("\t-p PORT\tServer port (default 80)\n") \
1162 USAGE_HTTPD_SETUID("\t-u USER\tSet uid to USER after listening privileges port\n") \
1163 USAGE_HTTPD_BASIC_AUTH("\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
1164 USAGE_HTTPD_AUTH_MD5("\t-m PASS\t\tCrypt PASS with md5 algorithm\n") \
1165 "\t-h HOME \tSpecifies http HOME directory (default ./)\n" \
1166 "\t-e STRING\tHtml encode STRING\n" \
1167 "\t-d STRING\tURL decode STRING"
Eric Andersen40520512003-07-28 09:59:05 +00001168
Robert Griebl1cd04452002-07-21 16:50:49 +00001169#define hwclock_trivial_usage \
1170 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
1171#define hwclock_full_usage \
1172 "Query and set the hardware clock (RTC)\n\n" \
1173 "Options:\n" \
1174 "\t-r\tread hardware clock and print result\n" \
1175 "\t-s\tset the system time from the hardware clock\n" \
1176 "\t-w\tset the hardware clock to the current system time\n" \
1177 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
1178 "\t-l\tthe hardware clock is kept in local time"
1179
Eric Andersen9e480452003-07-03 10:07:04 +00001180#ifdef CONFIG_SELINUX
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001181# define USAGE_SELINUX(a) a
Eric Andersen9e480452003-07-03 10:07:04 +00001182#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001183# define USAGE_SELINUX(a)
Eric Andersen9e480452003-07-03 10:07:04 +00001184#endif
1185
Eric Andersen7e9276b2001-02-22 01:15:47 +00001186#define id_trivial_usage \
1187 "[OPTIONS]... [USERNAME]"
1188#define id_full_usage \
1189 "Print information for USERNAME or the current user\n\n" \
1190 "Options:\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001191 USAGE_SELINUX("\t-c\tprints only the security context\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001192 "\t-g\tprints only the group ID\n" \
1193 "\t-u\tprints only the user ID\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001194 "\t-n\tprint a name instead of a number\n" \
1195 "\t-r\tprints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001196#define id_example_usage \
1197 "$ id\n" \
1198 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001199
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001200#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001201# define USAGE_SIOCSKEEPALIVE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001202#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001203# define USAGE_SIOCSKEEPALIVE(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001204#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001205#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001206# define USAGE_IFCONFIG_MII(a) a
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001207#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001208# define USAGE_IFCONFIG_MII(a)
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001209#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001210#ifdef CONFIG_FEATURE_IFCONFIG_HW
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001211# define USAGE_IFCONFIG_HW(a) a
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001212#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001213# define USAGE_IFCONFIG_HW(a)
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001214#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001215#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001216# define USAGE_IFCONFIG_OPT_A(a) a
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001217#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001218# define USAGE_IFCONFIG_OPT_A(a)
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001219#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +00001220#ifdef CONFIG_FEATURE_IPV6
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001221# define USAGE_IPV6(a) a
Eric Andersen51b8bd62002-07-03 11:46:38 +00001222#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001223# define USAGE_IPV6(a)
Eric Andersen51b8bd62002-07-03 11:46:38 +00001224#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001225
Eric Andersen7e9276b2001-02-22 01:15:47 +00001226#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001227 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001228#define ifconfig_full_usage \
1229 "configure a network interface\n\n" \
1230 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +00001231 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
1232 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001233 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001234 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001235 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001236 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001237 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001238 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001239 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
1240 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001241 "\t[up|down] ..."
1242
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001243#define ifup_trivial_usage \
1244 "<-ahinv> <ifaces...>"
1245#define ifup_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001246 "ifup <options> <ifaces...>\n\n" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001247 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001248 "\t-h\tthis help\n" \
1249 "\t-a\tde/configure all interfaces automatically\n" \
1250 "\t-i FILE\tuse FILE for interface definitions\n" \
1251 "\t-n\tprint out what would happen, but don't do it\n" \
1252 "\t\t\t(note that this option doesn't disable mappings)\n" \
1253 "\t-v\tprint out what would happen before doing it\n" \
1254 "\t-m\tdon't run any mappings\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001255 "\t-f\tforce de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001256
1257#define ifdown_trivial_usage \
1258 "<-ahinv> <ifaces...>"
1259#define ifdown_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001260 "ifdown <options> <ifaces...>\n\n" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001261 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001262 "\t-h\tthis help\n" \
1263 "\t-a\tde/configure all interfaces automatically\n" \
1264 "\t-i FILE\tuse FILE for interface definitions\n" \
1265 "\t-n\tprint out what would happen, but don't do it\n" \
1266 "\t\t(note that this option doesn't disable mappings)\n" \
1267 "\t-v\tprint out what would happen before doing it\n" \
1268 "\t-m\tdon't run any mappings\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001269 "\t-f\tforce de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001270
Glenn L McGrath06e95652003-02-09 06:51:14 +00001271#define inetd_trivial_usage \
Paul Foxb8317532005-08-01 19:39:47 +00001272 "[-f] [-q len] [conf]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001273#define inetd_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001274 "Listens for network connections and launches programs\n\n" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001275 "Option:\n" \
Paul Foxb8317532005-08-01 19:39:47 +00001276 "\t-f\tRun as a foreground progress\n" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001277 "\t-q\tSets the size of the socket listen queue to\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001278 "\t\tthe specified value. Default is 128"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001279
Eric Andersen7e9276b2001-02-22 01:15:47 +00001280#define init_trivial_usage \
1281 ""
1282#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001283 "Init is the parent of all processes."
1284#define init_notes_usage \
1285"This version of init is designed to be run only by the kernel.\n" \
1286"\n" \
1287"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
1288"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
1289"runlevels, use sysvinit.\n" \
1290"\n" \
1291"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
1292"it has the following default behavior:\n" \
1293"\n" \
1294" ::sysinit:/etc/init.d/rcS\n" \
1295" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001296" ::ctrlaltdel:/sbin/reboot\n" \
1297" ::shutdown:/sbin/swapoff -a\n" \
1298" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001299" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001300"\n" \
1301"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1302"\n" \
1303" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001304" tty3::askfirst:/bin/sh\n" \
1305" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001306"\n" \
1307"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1308"\n" \
1309" <id>:<runlevels>:<action>:<process>\n" \
1310"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001311" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001312"\n" \
1313" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1314" The id field is used by BusyBox init to specify the controlling tty for\n" \
1315" the specified process to run on. The contents of this field are\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001316" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001317" be unique, although if it isn't you may have strange results. If this\n" \
1318" field is left blank, the controlling tty is set to the console. Also\n" \
1319" note that if BusyBox detects that a serial console is in use, then only\n" \
1320" entries whose controlling tty is either the serial console or /dev/null\n" \
1321" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1322" stinkin' utmp.\n" \
1323"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001324" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001325"\n" \
1326" The runlevels field is completely ignored.\n" \
1327"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001328" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001329"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001330" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001331" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001332"\n" \
1333" The available actions can be classified into two groups: actions\n" \
1334" that are run only once, and actions that are re-run when the specified\n" \
1335" process exits.\n" \
1336"\n" \
1337" Run only-once actions:\n" \
1338"\n" \
1339" 'sysinit' is the first item run on boot. init waits until all\n" \
1340" sysinit actions are completed before continuing. Following the\n" \
1341" completion of all sysinit actions, all 'wait' actions are run.\n" \
1342" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001343" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001344" therefore, init does not wait for them to complete. 'restart' is\n" \
1345" the action taken to restart the init process. By default this should\n" \
1346" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1347" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001348" actions are run when the system detects that someone on the system\n" \
1349" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1350" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1351" Finally the 'shutdown' action specifies the actions to taken when\n" \
1352" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1353" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001354"\n" \
1355" Run repeatedly actions:\n" \
1356"\n" \
1357" 'respawn' actions are run after the 'once' actions. When a process\n" \
1358" started with a 'respawn' action exits, init automatically restarts\n" \
1359" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1360" respawning out of control. The 'askfirst' actions acts just like\n" \
1361" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001362" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001363" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001364" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001365"\n" \
1366" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1367" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001368" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001369"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001370" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001371"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001372" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001373"\n" \
1374"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001375"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001376" # This is run first except when booting in single-user mode.\n" \
1377" #\n" \
1378" ::sysinit:/etc/init.d/rcS\n" \
1379" \n" \
1380" # /bin/sh invocations on selected ttys\n" \
1381" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001382" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001383" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001384" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001385" tty2::askfirst:-/bin/sh\n" \
1386" tty3::askfirst:-/bin/sh\n" \
1387" tty4::askfirst:-/bin/sh\n" \
1388" \n" \
1389" # /sbin/getty invocations for selected ttys\n" \
1390" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001391" tty4::respawn:/sbin/getty 38400 tty4\n" \
1392" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001393" \n" \
1394" \n" \
1395" # Example of how to put a getty on a serial line (for a terminal)\n" \
1396" #\n" \
1397" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1398" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1399" #\n" \
1400" # Example how to put a getty on a modem line.\n" \
1401" #::respawn:/sbin/getty 57600 ttyS2\n" \
1402" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001403" # Stuff to do when restarting the init process\n" \
1404" ::restart:/sbin/init\n" \
1405" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001406" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001407" ::ctrlaltdel:/sbin/reboot\n" \
1408" ::shutdown:/bin/umount -a -r\n" \
1409" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001410
Eric Andersenbe65c352003-01-23 04:57:35 +00001411#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001412# define USAGE_INSMOD_MAP(a) a
Eric Andersenbe65c352003-01-23 04:57:35 +00001413#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001414# define USAGE_INSMOD_MAP(a)
Eric Andersenbe65c352003-01-23 04:57:35 +00001415#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001416#define insmod_trivial_usage \
1417 "[OPTION]... MODULE [symbol=value]..."
1418#define insmod_full_usage \
1419 "Loads the specified kernel modules into the kernel.\n\n" \
1420 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001421 "\t-f\tForce module to load into the wrong kernel version\n" \
1422 "\t-k\tMake module autoclean-able\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001423 "\t-v\tverbose output\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001424 "\t-q\tquiet output\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001425 "\t-L\tLock to prevent simultaneous loads of a module\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001426 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout\n") \
Eric Andersen957879a2004-04-07 15:07:55 +00001427 "\t-o NAME\tSet internal module name to NAME\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001428 "\t-x\tdo not export externs"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001429
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001430#define install_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001431 "[-cgmops] [sources] <dest|directory>"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001432#define install_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001433 "Copies files and set attributes\n\n" \
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001434 "Options:\n" \
1435 "\t-c\tcopy the file, default\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001436 "\t-d\tcreate directories\n" \
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001437 "\t-g\tset group ownership\n" \
1438 "\t-m\tset permission modes\n" \
1439 "\t-o\tset ownership\n" \
1440 "\t-p\tpreserve date\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001441 "\t-s\tstrip symbol tables"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001442
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001443#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001444 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001445#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001446 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1447 "where OBJECT := { link | addr | route | tunnel }\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001448 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001449
1450#define ipaddr_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001451 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
1452 "\t\t[ dev STRING ] [ to PREFIX ] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001453#define ipaddr_full_usage \
1454 "ipaddr {add|del} IFADDR dev STRING\n" \
1455 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001456 "\t\t\t[ to PREFIX ] [ label PATTERN ]\n" \
1457 "\t\t\tIFADDR := PREFIX | ADDR peer PREFIX\n" \
1458 "\t\t\t[ broadcast ADDR ] [ anycast ADDR ]\n" \
1459 "\t\t\t[ label STRING ] [ scope SCOPE-ID ]\n" \
1460 "\t\t\tSCOPE-ID := [ host | link | global | NUMBER ]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001461
Eric Andersen3561b012004-04-13 19:27:20 +00001462#ifdef CONFIG_FEATURE_IPCALC_FANCY
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001463# define XUSAGE_IPCALC_FANCY(a) a
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001464#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001465# define XUSAGE_IPCALC_FANCY(a)
Eric Andersen3561b012004-04-13 19:27:20 +00001466#endif
Eric Andersende4f07e2003-12-11 01:18:07 +00001467#define ipcalc_trivial_usage \
Eric Andersen3561b012004-04-13 19:27:20 +00001468 "[OPTION]... <ADDRESS>[[/]<NETMASK>] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001469#define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001470 "Calculate IP network settings from a IP address\n\n" \
1471 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001472 "\t-b\t--broadcast\tDisplay calculated broadcast address\n" \
1473 "\t-n\t--network\tDisplay calculated network address\n" \
Mike Frysinger036f2992005-09-24 23:50:14 +00001474 "\t-m\t--netmask\tDisplay default netmask for IP" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001475 XUSAGE_IPCALC_FANCY( \
Mike Frysinger036f2992005-09-24 23:50:14 +00001476 "\n\t-p\t--prefix\tDisplay the prefix for IP/NETMASK\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001477 "\t-h\t--hostname\tDisplay first resolved host name\n" \
Mike Frysinger036f2992005-09-24 23:50:14 +00001478 "\t-s\t--silent\tDon't ever display error messages")
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001479
Rob Landley6eb1e412005-06-20 04:30:36 +00001480#define ipcrm_trivial_usage \
1481 "[-[MQS] key] [-[mqs] id]"
1482#define ipcrm_full_usage \
1483 "The upper-case options MQS are used to remove a shared memory\n" \
1484 "segment by an shmkey value. The lower-case options mqs are used\n" \
1485 "to remove a segment by shmid value.\n" \
1486 "\t-m | -M\tRemove the memory segment after the last detatch\n" \
1487 "\t-q | -Q\tRemove the message queue\n" \
1488 "\t-s | -S\tRemove the semaphore\n"
1489
1490#define ipcs_trivial_usage \
1491 "[[-smq] -i shmid] | [[-asmq] [-tclup]]"
1492#define ipcs_full_usage \
1493 "\t-i\tspecify a specific resource id\n" \
1494 "Resource specification:\n" \
1495 "\t-m\tshared memory segments\n" \
1496 "\t-q\tmessage queues\n" \
1497 "\t-s\tsempahore arrays\n" \
1498 "\t-a\tall (default)\n" \
1499 "Output format:\n" \
1500 "\t-t\ttime\n" \
1501 "\t-p\tpid\n" \
1502 "\t-s\tcreator\n" \
1503 "\t-a\tlimits\n" \
1504 "\t-i\tsummary\n"
1505
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001506#define iplink_trivial_usage \
1507 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1508#define iplink_full_usage \
1509 "iplink set DEVICE { up | down | arp { on | off } |\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001510 "\t\t\tdynamic { on | off } |\n" \
1511 "\t\t\tmtu MTU }\n" \
1512 "\tiplink show [ DEVICE ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001513
1514#define iproute_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001515 "{ list | flush | { add | del | change | append |\n" \
1516 "\t\treplace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001517#define iproute_full_usage \
1518 "iproute { list | flush } SELECTOR\n" \
1519 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001520 "\t\t\t[ oif STRING ] [ tos TOS ]\n" \
1521 "\tiproute { add | del | change | append | replace | monitor } ROUTE\n" \
1522 "\t\t\tSELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1523 "\t\t\tROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001524
1525#define iptunnel_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001526 "{ add | change | del | show } [ NAME ]\n" \
1527 "\t\t[ mode { ipip | gre | sit } ]\n" \
1528 "\t\t[ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001529#define iptunnel_full_usage \
1530 "iptunnel { add | change | del | show } [ NAME ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001531 "\t\t\t[ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1532 "\t\t\t[ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1533 "\t\t\t[ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001534
Eric Andersen7e9276b2001-02-22 01:15:47 +00001535#define kill_trivial_usage \
1536 "[-signal] process-id [process-id ...]"
1537#define kill_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001538 "Send a signal (default is SIGTERM) to the specified process(es).\n\n" \
David Kimdon56082dc2001-02-23 06:03:22 +00001539 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001540 "\t-l\tList all signal names and numbers"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001541#define kill_example_usage \
1542 "$ ps | grep apache\n" \
1543 "252 root root S [apache]\n" \
1544 "263 www-data www-data S [apache]\n" \
1545 "264 www-data www-data S [apache]\n" \
1546 "265 www-data www-data S [apache]\n" \
1547 "266 www-data www-data S [apache]\n" \
1548 "267 www-data www-data S [apache]\n" \
1549 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001550
1551#define killall_trivial_usage \
Eric Andersenb131db42004-08-19 18:25:02 +00001552 "[-q] [-signal] process-name [process-name ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001553#define killall_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001554 "Send a signal (default is SIGTERM) to the specified process(es).\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001555 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001556 "\t-l\tList all signal names and numbers\n" \
1557 "\t-q\tDo not complain if no processes were killed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001558#define killall_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001559 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001560
Mark Whitley6317c4b2001-03-12 22:51:50 +00001561#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001562 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001563#define klogd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001564 "Kernel logger.\n" \
1565 "Options:\n" \
1566 "\t-c n\tSets the default log level of console messages to n\n" \
1567 "\t-n\tRun as a foreground process"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001568
Eric Andersen7e9276b2001-02-22 01:15:47 +00001569#define length_trivial_usage \
1570 "STRING"
1571#define length_full_usage \
1572 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001573#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001574 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001575 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001576
Rob Landley9200e792005-09-15 19:26:59 +00001577#define less_trivial_usage \
1578 "[-EMNmh~?] FILE1 FILE2..."
1579#define less_full_usage \
1580 "View a file or list of files. The position within files can be\n" \
1581 "changed, and files can be manipulated in various ways with the\n" \
1582 "following options:\n\n" \
1583 "\t-E\tQuit once the end of a file is reached\n" \
1584 "\t-M\tDisplay a status line containing the current line numbers\n" \
1585 "\t\tand the percentage through the file\n" \
1586 "\t-N\tPrefix line numbers to each line\n" \
1587 "\t-m\tDisplay a status line containing the percentage through the\n" \
1588 "\t\tfile\n" \
1589 "\t-~\tSuppress ~s displayed when input past the end of the file is\n" \
1590 "\t\treached.\n" \
1591 "\t-h, -?\tDisplay this help message\n"
1592
Eric Andersen7e9276b2001-02-22 01:15:47 +00001593#define ln_trivial_usage \
1594 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1595#define ln_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001596 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001597 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1598 "Options:\n" \
1599 "\t-s\tmake symbolic links instead of hard links\n" \
1600 "\t-f\tremove existing destination files\n" \
Rob Landley55b1efc2005-04-29 22:14:28 +00001601 "\t-n\tno dereference symlinks - treat like normal file\n" \
1602 "\t-b\tmake a backup of the target (if exists) before link operation\n" \
1603 "\t-S suffix\tuse suffix instead of ~ when making backup files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001604#define ln_example_usage \
1605 "$ ln -s BusyBox /tmp/ls\n" \
1606 "$ ls -l /tmp/ls\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001607 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001608
Eric Andersen7e9276b2001-02-22 01:15:47 +00001609#define loadfont_trivial_usage \
1610 "< font"
1611#define loadfont_full_usage \
1612 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001613#define loadfont_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001614 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001615
1616#define loadkmap_trivial_usage \
1617 "< keymap"
1618#define loadkmap_full_usage \
1619 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001620#define loadkmap_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001621 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001622
1623#define logger_trivial_usage \
1624 "[OPTION]... [MESSAGE]"
1625#define logger_full_usage \
1626 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1627 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001628 "\t-s\tLog to stderr as well as the system log\n" \
1629 "\t-t TAG\tLog using the specified tag (defaults to user name)\n" \
1630 "\t-p PRIORITY\tEnter the message with the specified priority\n" \
1631 "\t\tThis may be numerical or a ``facility.level'' pair"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001632#define logger_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001633 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001634
Robert Griebl1fca5582002-06-04 20:45:46 +00001635#define login_trivial_usage \
1636 "[OPTION]... [username] [ENV=VAR ...]"
1637#define login_full_usage \
1638 "Begin a new session on the system\n\n" \
1639 "Options:\n" \
1640 "\t-f\tDo not authenticate (user already authenticated)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001641 "\t-h\tName of the remote host for this login\n" \
1642 "\t-p\tPreserve environment"
Robert Griebl1fca5582002-06-04 20:45:46 +00001643
Eric Andersen7e9276b2001-02-22 01:15:47 +00001644#define logname_trivial_usage \
1645 ""
1646#define logname_full_usage \
1647 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001648#define logname_example_usage \
1649 "$ logname\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001650 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001651
Mark Whitley6317c4b2001-03-12 22:51:50 +00001652#define logread_trivial_usage \
Eric Andersend4a5e252003-12-19 11:32:14 +00001653 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001654#define logread_full_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001655 "Shows the messages from syslogd (using circular buffer).\n\n" \
Eric Andersend4a5e252003-12-19 11:32:14 +00001656 "Options:\n" \
1657 "\t-f\t\toutput data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001658
Matt Kraai83788da2002-03-20 17:38:37 +00001659#define losetup_trivial_usage \
Rob Landleyce887932005-12-21 17:00:25 +00001660 "[-od] LOOPDEVICE [FILE]"
Matt Kraai83788da2002-03-20 17:38:37 +00001661#define losetup_full_usage \
Rob Landley1d589b22005-11-29 23:47:10 +00001662 "Associate LOOPDEVICE with FILE, or display current association.\n\n" \
Matt Kraai83788da2002-03-20 17:38:37 +00001663 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001664 "\t-d\t\tDisassociate LOOPDEVICE\n" \
1665 "\t-o OFFSET\tStart OFFSET bytes into FILE"
Rob Landley1d589b22005-11-29 23:47:10 +00001666#define losetup_notes_usage \
1667 "One argument (losetup /dev/loop1) will display the current association\n" \
1668 "(if any), or disassociate it (with -d). The display shows the offset\n" \
1669 "and filename of the file the loop device is currently bound to.\n\n" \
1670 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
1671 "with an optional offset (-o 12345). Encryption is not yet supported.\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00001672
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001673#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001674# define USAGE_LS_TIMESTAMPS(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001675#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001676# define USAGE_LS_TIMESTAMPS(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001677#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001678#ifdef CONFIG_FEATURE_LS_FILETYPES
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001679# define USAGE_LS_FILETYPES(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001680#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001681# define USAGE_LS_FILETYPES(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001682#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001683#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001684# define USAGE_LS_FOLLOWLINKS(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001685#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001686# define USAGE_LS_FOLLOWLINKS(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001687#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001688#ifdef CONFIG_FEATURE_LS_RECURSIVE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001689# define USAGE_LS_RECURSIVE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001690#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001691# define USAGE_LS_RECURSIVE(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001692#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001693#ifdef CONFIG_FEATURE_LS_SORTFILES
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001694# define USAGE_LS_SORTFILES(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001695#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001696# define USAGE_LS_SORTFILES(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001697#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001698#ifdef CONFIG_FEATURE_AUTOWIDTH
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001699# define USAGE_AUTOWIDTH(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001700#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001701# define USAGE_AUTOWIDTH(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001702#endif
Paul Fox156dc412005-08-01 19:33:30 +00001703#ifdef CONFIG_FEATURE_LS_COLOR
1704 #define USAGE_LS_COLOR(a) a
1705#else
1706 #define USAGE_LS_COLOR(a)
1707#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00001708
Eric Andersen7e9276b2001-02-22 01:15:47 +00001709#define ls_trivial_usage \
Eric Andersen15c03c32004-04-06 17:52:02 +00001710 "[-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 +00001711#define ls_full_usage \
1712 "List directory contents\n\n" \
1713 "Options:\n" \
1714 "\t-1\tlist files in a single column\n" \
1715 "\t-A\tdo not list implied . and ..\n" \
1716 "\t-a\tdo not hide entries starting with .\n" \
1717 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001718 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Paul Fox156dc412005-08-01 19:33:30 +00001719 USAGE_LS_COLOR("\t--color[={always,never,auto}]\tto control coloring\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001720 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001721 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1722 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001723 "\t-i\tlist the i-node for each file\n" \
1724 "\t-l\tuse a long listing format\n" \
1725 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001726 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1727 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1728 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1729 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1730 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001731 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001732 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1733 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1734 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1735 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1736 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001737 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001738 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1739 USAGE_HUMAN_READABLE( \
Eric Andersen15c03c32004-04-06 17:52:02 +00001740 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n") \
1741 USAGE_SELINUX("\t-k\tprint security context\n") \
1742 USAGE_SELINUX("\t-K\tprint security context in long format\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001743
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001744#define lsattr_trivial_usage \
1745 "[-Radlv] [files...]"
1746#define lsattr_full_usage \
1747 "list file attributes on an ext2 fs\n\n" \
1748 "Options:\n" \
1749 "\t-R\trecursively list subdirectories\n" \
1750 "\t-a\tdo not hide entries starting with .\n" \
1751 "\t-d\tlist directory entries instead of contents\n" \
1752 "\t-l\tprint long flag names\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001753 "\t-v\tlist the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001754
Eric Andersen7e9276b2001-02-22 01:15:47 +00001755#define lsmod_trivial_usage \
1756 ""
1757#define lsmod_full_usage \
1758 "List the currently loaded kernel modules."
1759
Eric Andersen3d925622005-06-09 10:16:02 +00001760#ifdef CONFIG_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00001761#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001762 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001763#define makedevs_full_usage \
1764 "Creates a range of block or character special files\n\n" \
1765 "TYPEs include:\n" \
1766 "\tb:\tMake a block (buffered) device.\n" \
1767 "\tc or u:\tMake a character (un-buffered) device.\n" \
1768 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1769 "FIRST specifies the number appended to NAME to create the first device.\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001770 "LAST specifies the number of the last item that should be created\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001771 "If 's' is the last argument, the base device is created as well.\n\n" \
1772 "For example:\n" \
1773 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001774 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001775#define makedevs_example_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001776 "# makedevs /dev/ttyS c 4 66 2 63\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001777 "[creates ttyS2-ttyS63]\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001778 "# makedevs /dev/hda b 3 0 0 8 s\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001779 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001780#endif
1781
1782#ifdef CONFIG_FEATURE_MAKEDEVS_TABLE
1783#define makedevs_trivial_usage \
Eric Andersene8614db2005-07-18 09:28:36 +00001784 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00001785#define makedevs_full_usage \
Eric Andersene8614db2005-07-18 09:28:36 +00001786 "Creates a range of special files as specified in a device table.\n" \
1787 "Device table entries take the form of:\n" \
Eric Andersene8614db2005-07-18 09:28:36 +00001788 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
1789 "Where name is the file name, type can be one of:\n" \
1790 " f A regular file\n" \
1791 " d Directory\n" \
1792 " c Character special device file\n" \
1793 " b Block special device file\n" \
1794 " p Fifo (named pipe)\n" \
1795 "uid is the user id for the target file, gid is the group id for the\n" \
1796 "target file. The rest of the entries (major, minor, etc) apply to\n" \
Eric Andersen54e57da2005-07-18 09:42:37 +00001797 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00001798#define makedevs_example_usage \
1799 "For example:\n" \
1800 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
1801 "/dev d 755 0 0 - - - - -\n" \
1802 "/dev/console c 666 0 0 5 1 - - -\n" \
1803 "/dev/null c 666 0 0 1 3 0 0 -\n" \
1804 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
1805 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
1806 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
1807 "Will Produce:\n" \
1808 "/dev\n" \
1809 "/dev/console\n" \
1810 "/dev/null\n" \
1811 "/dev/zero\n" \
1812 "/dev/hda\n" \
Eric Andersen54e57da2005-07-18 09:42:37 +00001813 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001814#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001815
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001816#ifdef CONFIG_FEATURE_MD5_SHA1_SUM_CHECK
1817#define USAGE_MD5_SHA1_SUM_CHECK(a) a
1818#else
1819#define USAGE_MD5_SHA1_SUM_CHECK(a)
1820#endif
1821
Eric Andersen7e9276b2001-02-22 01:15:47 +00001822#define md5sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001823 "[OPTION] [FILEs...]" \
1824 USAGE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001825#define md5sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001826 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001827 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001828 "With no FILE, or when FILE is -, read standard input." \
1829 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
1830 "\t-c\tcheck MD5 sums against given list\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001831 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001832 "\t-s\tdon't output anything, status code shows success\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001833 "\t-w\twarn about improperly formated MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001834#define md5sum_example_usage \
1835 "$ md5sum < busybox\n" \
1836 "6fd11e98b98a58f64ff3398d7b324003\n" \
1837 "$ md5sum busybox\n" \
1838 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1839 "$ md5sum -c -\n" \
1840 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1841 "busybox: OK\n" \
1842 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001843
Rob Landley70f7ef72005-12-13 08:21:33 +00001844#define mdev_trivial_usage \
1845 "[-s]"
1846#define mdev_full_usage \
1847 "\ts\tScan /sys and populate /dev during system boot\n\n" \
1848 "Called with no options (via hotplug) it uses environment variables\n" \
1849 "to determine which device to add/remove."
1850#ifdef CONFIG_FEATURE_MDEV_CONFIG
1851#define mdev_notes_usage \
1852 "The mdev config file contains lines that look like:\n" \
1853 " hd[a-z][0-9]* 0:3 660\n\n" \
1854 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
1855 "Optionally, that can be followed (on the same line) by an asterisk\n" \
1856 "and a command line to run after creating the corresponding device(s),\n"\
1857 "ala:\n\n" \
1858 " hdc root:cdrom 660 *ln -s hdc cdrom\n\n" \
1859 "Config file parsing stops on the first matching line. If no config\n"\
1860 "entry is matched, devices are created with default 0:0 660. (Make\n"\
1861 "the last line match .* to override this.)\n\n"
1862#endif
1863
Glenn L McGrath061c9002002-09-16 04:21:46 +00001864#define mesg_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001865 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001866#define mesg_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001867 "mesg controls write access to your terminal\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001868 "\ty\tAllow write access to your terminal\n" \
1869 "\tn\tDisallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001870
Eric Andersen7e9276b2001-02-22 01:15:47 +00001871#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001872 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001873#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001874 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001875 "Options:\n" \
1876 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001877 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001878#define mkdir_example_usage \
1879 "$ mkdir /tmp/foo\n" \
1880 "$ mkdir /tmp/foo\n" \
1881 "/tmp/foo: File exists\n" \
1882 "$ mkdir /tmp/foo/bar/baz\n" \
1883 "/tmp/foo/bar/baz: No such file or directory\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001884 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001885
Mike Frysinger6447ac02005-06-11 05:29:40 +00001886#define mke2fs_trivial_usage \
1887 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
1888 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
1889 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
1890 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
1891 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
1892 "device [blocks-count]"
1893#define mke2fs_full_usage \
1894 "\t-b size\tblock size in bytes\n" \
1895 "\t-c\tcheck for bad blocks before creating\n" \
1896 "\t-E opts\tset extended options\n" \
1897 "\t-f size\tfragment size in bytes\n" \
1898 "\t-F\tforce (ignore sanity checks)\n" \
1899 "\t-g num\tnumber of blocks in a block group\n" \
1900 "\t-i ratio\tthe bytes/inode ratio\n" \
1901 "\t-j\tcreate a journal (ext3)\n" \
1902 "\t-J opts\tset journal options (size/device)\n" \
1903 "\t-l file\tread bad blocks list from file\n" \
1904 "\t-L lbl\tset the volume label\n" \
1905 "\t-m percent\tpercent of fs blocks to reserve for admin\n" \
1906 "\t-M dir\tset last mounted directory\n" \
1907 "\t-n\tdo not actually create anything\n" \
1908 "\t-N num\tnumber of inodes to create\n" \
1909 "\t-o os\tset the 'creator os' field\n" \
1910 "\t-O features\tdir_index/filetype/has_journal/journal_dev/sparse_super\n" \
1911 "\t-q\tquiet execution\n" \
1912 "\t-r rev\tset filesystem revision\n" \
1913 "\t-S\twrite superblock and group descriptors only\n" \
1914 "\t-T fs-type\tset usage type (news/largefile/largefile4)\n" \
1915 "\t-v\tverbose execution"
1916
Eric Andersen7e9276b2001-02-22 01:15:47 +00001917#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001918 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001919#define mkfifo_full_usage \
1920 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1921 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001922 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001923
Eric Andersen7e9276b2001-02-22 01:15:47 +00001924#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001925 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001926#define mkfs_minix_full_usage \
1927 "Make a MINIX filesystem.\n\n" \
1928 "Options:\n" \
1929 "\t-c\t\tCheck the device for bad blocks\n" \
1930 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1931 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1932 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001933 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001934
Eric Andersen7e9276b2001-02-22 01:15:47 +00001935#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001936 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001937#define mknod_full_usage \
1938 "Create a special file (block, character, or pipe).\n\n" \
1939 "Options:\n" \
1940 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1941 "TYPEs include:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001942 "\tb:\tMake a block (buffered) device\n" \
1943 "\tc or u:\tMake a character (un-buffered) device\n" \
1944 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001945#define mknod_example_usage \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001946 "$ mknod /dev/fd0 b 2 0\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001947 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001948
Eric Andersen7e9276b2001-02-22 01:15:47 +00001949#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001950 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001951#define mkswap_full_usage \
1952 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001953 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001954 "\t-c\t\tCheck for read-ability\n" \
1955 "\t-v0\t\tMake version 0 swap [max 128 Megs]\n" \
1956 "\t-v1\t\tMake version 1 swap [big!] (default for kernels >\n\t\t\t2.1.117)\n" \
1957 "\tblock-count\tNumber of block to use (default is entire partition)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001958
Eric Andersen7e9276b2001-02-22 01:15:47 +00001959#define mktemp_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001960 "[-dq] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001961#define mktemp_full_usage \
1962 "Creates a temporary file with its name based on TEMPLATE.\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001963 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX).\n\n" \
1964 "Options:\n" \
1965 "\t-d\t\tMake a directory instead of a file\n" \
1966 "\t-q\t\tFail silently if an error occurs"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001967#define mktemp_example_usage \
1968 "$ mktemp /tmp/temp.XXXXXX\n" \
1969 "/tmp/temp.mWiLjM\n" \
1970 "$ ls -la /tmp/temp.mWiLjM\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001971 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001972
Eric Andersen8d79ce82001-07-22 23:00:15 +00001973#define modprobe_trivial_usage \
Rob Landley9c32a152005-12-11 20:12:24 +00001974 "[-knqrsv] MODULE [symbol=value ...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00001975#define modprobe_full_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001976 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001977 "\t-k\tMake module autoclean-able\n" \
1978 "\t-n\tJust show what would be done\n" \
1979 "\t-q\tQuiet output\n" \
1980 "\t-r\tRemove module (stacks) or do autoclean\n" \
1981 "\t-s\tReport via syslog instead of stderr\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00001982 "\t-v\tVerbose output\n\n"
1983#define modprobe_notes_usage \
1984"modprobe can (un)load a stack of modules, passing each module options (when\n" \
1985"loading). modprobe uses a configuration file to determine what option(s) to\n" \
1986"pass each module it loads.\n" \
1987"\n" \
1988"The configuration file is searched (in order) amongst:\n" \
1989"\n" \
1990" /etc/modprobe.conf (2.6 only)\n" \
1991" /etc/modules.conf\n" \
1992" /etc/conf.modules (deprecated)\n" \
1993"\n" \
1994"They all have the same syntax (see below). If none is present, it is\n" \
1995"_not_ an error; each loaded module is then expected to load without\n" \
1996"options. Once a file is found, the others are tested for.\n" \
1997"\n" \
1998"/etc/modules.conf entry format:\n" \
1999"\n" \
2000" alias <alias_name> <mod_name>\n" \
2001" Makes it possible to modprobe alias_name, when there is no such module.\n" \
2002" It makes sense if your mod_name is long, or you want a more reprenstative\n" \
2003" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2004" This makes it also possible to use a different set of options (below) for\n" \
2005" the module and the alias.\n" \
2006" A module can be aliased more than once.\n" \
2007"\n" \
2008" options <mod_name|alias_name> <symbol=value ...>\n" \
2009" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2010" the \"symbol=value\" pairs as option to that module.\n" \
2011"\n" \
2012"Sample /etc/modules.conf file:\n" \
2013"\n" \
2014" options tulip irq=3\n" \
2015" alias tulip tulip2\n" \
2016" options tulip2 irq=4 io=0x308\n" \
2017"\n" \
2018"Other functionality offered by 'classic' modprobe is not available in\n" \
2019"this implementation.\n" \
2020"\n" \
2021"If module options are present both in the config file, and on the command line,\n" \
2022"then the options from the command line will be passed to the module _after_\n" \
2023"the options from the config file. That way, you can have defaults in the config\n" \
2024"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002025#define modprobe_example_usage \
Rob Landley9c32a152005-12-11 20:12:24 +00002026 "(with the above /etc/modules.conf):\n\n" \
2027 "$ modprobe tulip\n" \
2028 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2029 "$ modprobe tulip irq=5\n" \
2030 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2031 "$ modprobe tulip2\n" \
2032 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2033 " which are the default for alias 'tulip2'\n\n" \
2034 "$ modprobe tulip2 irq=8\n" \
2035 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2036 " which are the default for alias 'tulip2' overriden by the option 'irq=8'\n\n" \
2037 " from the command line\n\n" \
2038 "$ modprobe tulip2 irq=2 io=0x210\n" \
2039 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2040 " which are the default for alias 'tulip2' overriden by the options 'irq=2 io=0x210'\n\n" \
2041 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002042
Eric Andersen7e9276b2001-02-22 01:15:47 +00002043#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002044 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002045#define more_full_usage \
2046 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002047#define more_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002048 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002049
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002050#ifdef CONFIG_FEATURE_MOUNT_LOOP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002051# define USAGE_MOUNT_LOOP(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002052#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002053# define USAGE_MOUNT_LOOP(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00002054#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002055#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002056# define USAGE_MTAB(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002057#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002058# define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002059#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002060#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002061 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002062#define mount_full_usage \
Eric Andersen2715fa12004-03-09 21:32:57 +00002063 "Mount a filesystem. Autodetection of filesystem type requires the\n" \
2064 "/proc filesystem be already mounted.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002065 "Flags:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002066 "\t-a:\t\tMount all filesystems in fstab\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002067 USAGE_MTAB( \
Mike Frysinger058e7402005-04-23 07:00:33 +00002068 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it\n" \
2069 "\t-n:\t\tDon't write a mount table entry\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002070 ) \
Mike Frysinger058e7402005-04-23 07:00:33 +00002071 "\t-o option:\tOne of many filesystem options, listed below\n" \
2072 "\t-r:\t\tMount the filesystem read-only\n" \
2073 "\t-t fs-type:\tSpecify the filesystem type\n" \
2074 "\t-w:\t\tMount for reading and writing (default)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002075 "\n" \
2076 "Options for use with the \"-o\" flag:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002077 "\tasync/sync:\tWrites are asynchronous / synchronous\n" \
2078 "\tatime/noatime:\tEnable / disable updates to inode access times\n" \
2079 "\tdev/nodev:\tAllow use of special device files / disallow them\n" \
2080 "\texec/noexec:\tAllow use of executable files / disallow them\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002081 USAGE_MOUNT_LOOP( \
Rob Landley1d589b22005-11-29 23:47:10 +00002082 "\tloop:\t\t Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002083 ) \
Mike Frysinger058e7402005-04-23 07:00:33 +00002084 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them\n" \
2085 "\tremount:\tRe-mount a mounted filesystem, changing its flags\n" \
2086 "\tro/rw:\t\tMount for read-only / read-write\n" \
Rob Landley1d589b22005-11-29 23:47:10 +00002087 "\tbind:\t\tBind a directory to an additional location\n" \
2088 "\tmove:\t\tRelocate an existing mount point.\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002089 "\nThere are EVEN MORE flags that are specific to each filesystem\n" \
2090 "You'll have to see the written documentation for those filesystems"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002091#define mount_example_usage \
2092 "$ mount\n" \
2093 "/dev/hda3 on / type minix (rw)\n" \
2094 "proc on /proc type proc (rw)\n" \
2095 "devpts on /dev/pts type devpts (rw)\n" \
2096 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
Rob Landley1d589b22005-11-29 23:47:10 +00002097 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2098 "$ mount cd_image.iso mydir\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002099
Rob Landleyd00b3a52005-08-20 05:07:08 +00002100#define mountpoint_trivial_usage \
2101 "[-q] <[-d] DIR | -x DEVICE>"
2102#define mountpoint_full_usage \
2103 "mountpoint checks if the directory is a mountpoint\n\n" \
2104 "Options:\n" \
2105 "\t-q:\t\tBe more quiet\n" \
2106 "\t-d:\t\tPrint major/minor device number of the filesystem\n" \
2107 "\t-x:\t\tPrint major/minor device number of the blockdevice"
2108#define mountpoint_example_usage \
2109 "$ mountpoint /proc\n" \
2110 "/proc is not a mountpoint\n" \
2111 "$ mountpoint /sys\n" \
2112 "/sys is a mountpoint\n"
2113
Eric Andersen7e9276b2001-02-22 01:15:47 +00002114#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002115 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002116#define mt_full_usage \
2117 "Control magnetic tape drive operation\n" \
2118 "\nAvailable Opcodes:\n\n" \
2119 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2120 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
Eric Andersen92fb9392003-08-08 20:09:03 +00002121 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002122 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002123
Eric Andersen7e9276b2001-02-22 01:15:47 +00002124#define mv_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002125 "[OPTION]... SOURCE DEST\n" \
2126 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002127#define mv_full_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002128 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY.\n\n" \
2129 "Options:\n" \
2130 "\t-f\tdon't prompt before overwriting\n" \
2131 "\t-i\tinteractive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002132#define mv_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002133 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002134
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002135#define nameif_trivial_usage \
Glenn L McGratha9adef02003-01-19 13:34:21 +00002136 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002137#define nameif_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002138 "Nameif renaming network interface while it in the down state.\n\n" \
2139 "Options:\n" \
2140 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002141 "\t-s\t\tUse syslog (LOCAL0 facility)\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002142 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002143#define nameif_example_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002144 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2145 " or\n" \
2146 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002147
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002148#ifdef CONFIG_NC_GAPING_SECURITY_HOLE
2149# define USAGE_NC_EXEC(a) a
2150#else
2151# define USAGE_NC_EXEC(a)
2152#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002153#define nc_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002154 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002155#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00002156 "Netcat opens a pipe to IP:port\n\n" \
2157 "Options:\n" \
2158 "\t-l\t\tlisten mode, for inbound connects\n" \
2159 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00002160 "\t-i SECS\t\tdelay interval for lines sent\n" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002161 USAGE_NC_EXEC( \
2162 "\t-e PROG\t\tprogram to exec after connect (dangerous!)\n" \
2163 ) \
2164 "\t-w SECS\t\ttimeout for connects and final net reads"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002165#define nc_example_usage \
2166 "$ nc foobar.somedomain.com 25\n" \
2167 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2168 "help\n" \
2169 "214-Commands supported:\n" \
2170 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2171 "214 NOOP QUIT RSET HELP\n" \
2172 "quit\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002173 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002174
Eric Andersen1552ff72001-10-31 11:07:12 +00002175#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00002176 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002177#define netstat_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00002178 "Netstat displays Linux networking information.\n\n" \
2179 "Options:\n" \
2180 "\t-l display listening server sockets\n" \
2181 "\t-a display all sockets (default: connected)\n" \
2182 "\t-e display other/more information\n" \
2183 "\t-n don't resolve names\n" \
2184 "\t-r display routing table\n" \
2185 "\t-t tcp sockets\n" \
2186 "\t-u udp sockets\n" \
2187 "\t-w raw sockets\n" \
2188 "\t-x unix sockets"
Eric Andersen1552ff72001-10-31 11:07:12 +00002189
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002190#define nice_trivial_usage \
2191 "[-n ADJUST] [COMMAND [ARG] ...]"
2192#define nice_full_usage \
2193 "Nice runs a program with modified scheduling priority.\n\n" \
2194 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002195 "\t-n ADJUST\tAdjust the scheduling priority by ADJUST"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002196
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002197#define nohup_trivial_usage \
2198 "COMMAND [ARGS]"
2199#define nohup_full_usage \
2200 "run a command immune to hangups, with output to a non-tty"
2201#define nohup_example_usage \
2202 "$ nohup make &"
2203
Eric Andersen7e9276b2001-02-22 01:15:47 +00002204#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00002205 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002206#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00002207 "Queries the nameserver for the IP address of the given HOST\n" \
2208 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002209#define nslookup_example_usage \
2210 "$ nslookup localhost\n" \
2211 "Server: default\n" \
2212 "Address: default\n" \
2213 "\n" \
2214 "Name: debian\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002215 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002216
Glenn L McGrath60281112001-11-02 11:39:46 +00002217#define od_trivial_usage \
2218 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
2219#define od_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002220 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Glenn L McGrath60281112001-11-02 11:39:46 +00002221 "to standard output. With no FILE, or when FILE is -, read standard input."
2222
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002223#define openvt_trivial_usage \
2224 "<vtnum> <COMMAND> [ARGS...]"
2225#define openvt_full_usage \
2226 "Start a command on a new virtual terminal"
2227#define openvt_example_usage \
2228 "openvt 2 /bin/ash\n"
2229
Eric Andersen27f64e12002-06-23 04:24:25 +00002230#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002231# define PASSWORD_ALG_TYPES(a) a
Tim Riker7b253f82003-12-28 05:02:40 +00002232#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002233# define PASSWORD_ALG_TYPES(a)
Eric Andersen27f64e12002-06-23 04:24:25 +00002234#endif
2235#define passwd_trivial_usage \
2236 "[OPTION] [name]"
2237#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00002238 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00002239 "changes the password for the current user.\n" \
2240 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002241 "\t-a\tDefine which algorithm shall be used for the password\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00002242 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00002243 PASSWORD_ALG_TYPES(", sha1") \
Mike Frysinger058e7402005-04-23 07:00:33 +00002244 ")\n\t-d\tDelete the password for the specified user account\n" \
2245 "\t-l\tLocks (disables) the specified user account\n" \
2246 "\t-u\tUnlocks (re-enables) the specified user account"
Eric Andersen27f64e12002-06-23 04:24:25 +00002247
Glenn L McGrath655d8142003-06-22 15:32:41 +00002248#define patch_trivial_usage \
Rob Landley078bacf2005-09-01 03:02:23 +00002249 "[-p<num>] [-i<patch.diff>]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002250#define patch_full_usage \
Rob Landley078bacf2005-09-01 03:02:23 +00002251 "[-p<num>]\n" \
2252 "[-i<diff>]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002253#define patch_example_usage \
Rob Landley078bacf2005-09-01 03:02:23 +00002254 "$ patch -p1 <example.diff\n" \
2255 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002256
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002257#if ENABLE_FEATURE_PIDOF_SINGLE
2258#define USAGE_FEATURE_PIDOF_SINGLE(a) a
2259#else
2260#define USAGE_FEATURE_PIDOF_SINGLE(a)
2261#endif
2262#if ENABLE_FEATURE_PIDOF_OMIT
2263#define USAGE_FEATURE_PIDOF_OMIT(a) a
2264#else
2265#define USAGE_FEATURE_PIDOF_OMIT(a)
2266#endif
2267#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
2268#define USAGE_PIDOF "Options:"
2269#else
2270#define USAGE_PIDOF "\n\tThis version of pidof accepts no options."
2271#endif
2272
Eric Andersen221b2ea2001-07-31 19:06:07 +00002273#define pidof_trivial_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002274 "process-name [OPTION] [process-name ...]"
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002275
Eric Andersen221b2ea2001-07-31 19:06:07 +00002276#define pidof_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002277 "Lists the PIDs of all processes with names that match the\n" \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002278 "names on the command line.\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002279 USAGE_PIDOF \
2280 USAGE_FEATURE_PIDOF_SINGLE("\n\t-s\t\tdisplay only a single PID") \
2281 USAGE_FEATURE_PIDOF_OMIT("\n\t-o\t\tomit given pid.") \
2282 USAGE_FEATURE_PIDOF_OMIT("\n\t\t\tUse %PPID to omit the parent pid of pidof itself")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002283#define pidof_example_usage \
2284 "$ pidof init\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002285 "1\n" \
2286 USAGE_FEATURE_PIDOF_OMIT("$ pidof /bin/sh\n20351 5973 5950\n") \
2287 USAGE_FEATURE_PIDOF_OMIT("$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002288
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002289#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00002290#define ping_trivial_usage "host"
2291#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
2292#else
2293#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002294 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002295#define ping_full_usage \
2296 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
2297 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002298 "\t-c COUNT\tSend only COUNT pings\n" \
2299 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002300 "\t-q\t\tQuiet mode, only displays output at start\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002301 "\t\t\tand when finished"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002302#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002303#define ping_example_usage \
2304 "$ ping localhost\n" \
2305 "PING slag (127.0.0.1): 56 data bytes\n" \
2306 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2307 "\n" \
2308 "--- debian ping statistics ---\n" \
2309 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002310 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002311
Eric Andersen51b8bd62002-07-03 11:46:38 +00002312#ifndef CONFIG_FEATURE_FANCY_PING6
2313#define ping6_trivial_usage "host"
2314#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
2315#else
2316#define ping6_trivial_usage \
2317 "[OPTION]... host"
2318#define ping6_full_usage \
2319 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
2320 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002321 "\t-c COUNT\tSend only COUNT pings\n" \
2322 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56)\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +00002323 "\t-q\t\tQuiet mode, only displays output at start\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002324 "\t\t\tand when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002325#endif
2326#define ping6_example_usage \
2327 "$ ping6 ip6-localhost\n" \
2328 "PING ip6-localhost (::1): 56 data bytes\n" \
2329 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2330 "\n" \
2331 "--- ip6-localhost ping statistics ---\n" \
2332 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002333 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002334
Eric Andersen7e9276b2001-02-22 01:15:47 +00002335#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002336 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002337#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002338 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002339 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002340
Eric Andersen7e9276b2001-02-22 01:15:47 +00002341#define poweroff_trivial_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002342 "[-d<delay>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002343#define poweroff_full_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002344 "Halt the system and request that the kernel shut off the power.\n" \
2345 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002346 "\t-d\t\tdelay interval for shutting off"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002347
Mike Frysinger95d3c452005-04-21 23:29:24 +00002348#define printenv_trivial_usage \
2349 "[VARIABLES...]"
2350#define printenv_full_usage \
2351 "print all or part of environment\n\n" \
2352 "If no environment VARIABLE specified, print them all."
2353
Eric Andersen7e9276b2001-02-22 01:15:47 +00002354#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002355 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002356#define printf_full_usage \
2357 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002358 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002359#define printf_example_usage \
Mike Frysinger5c63a722005-04-16 04:23:58 +00002360 "$ printf \"Val=%d\\n\" 5\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002361 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002362
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002363#if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE
Rob Landley6eb1e412005-06-20 04:30:36 +00002364#define USAGE_PS "\n\tThis version of ps accepts no options."
2365#else
2366#define USAGE_PS "\nOptions:"
2367#endif
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002368#if ENABLE_FEATURE_PS_WIDE
Rob Landley6eb1e412005-06-20 04:30:36 +00002369#define USAGE_PS_WIDE(a) a
2370#else
2371#define USAGE_PS_WIDE(a)
2372#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002373
Eric Andersen7e9276b2001-02-22 01:15:47 +00002374#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002375 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002376#define ps_full_usage \
2377 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002378 USAGE_PS \
2379 USAGE_SELINUX("\n\t-c\tshow SE Linux context") \
2380 USAGE_PS_WIDE("\n\tw\twide output")
2381
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002382#define ps_example_usage \
2383 "$ ps\n" \
2384 " PID Uid Gid State Command\n" \
2385 " 1 root root S init\n" \
2386 " 2 root root S [kflushd]\n" \
2387 " 3 root root S [kupdate]\n" \
2388 " 4 root root S [kpiod]\n" \
2389 " 5 root root S [kswapd]\n" \
2390 " 742 andersen andersen S [bash]\n" \
2391 " 743 andersen andersen S -bash\n" \
2392 " 745 root root S [getty]\n" \
2393 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002394
Eric Andersen7e9276b2001-02-22 01:15:47 +00002395#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002396 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002397#define pwd_full_usage \
2398 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002399#define pwd_example_usage \
2400 "$ pwd\n" \
2401 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002402
Eric Andersen7e9276b2001-02-22 01:15:47 +00002403#define rdate_trivial_usage \
Eric Andersen725db192003-07-22 08:26:05 +00002404 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002405#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002406 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002407 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002408 "\t-s\tSet the system date and time (default)\n" \
2409 "\t-p\tPrint the date and time"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002410
Ned Luddc6fbed52004-12-08 16:47:28 +00002411#ifdef CONFIG_FEATURE_READLINK_FOLLOW
2412#define USAGE_READLINK_FOLLOW(a) a
2413#else
2414#define USAGE_READLINK_FOLLOW(a)
2415#endif
2416
Eric Andersen7e9276b2001-02-22 01:15:47 +00002417#define readlink_trivial_usage \
Ned Luddc6fbed52004-12-08 16:47:28 +00002418 USAGE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002419#define readlink_full_usage \
Ned Luddc6fbed52004-12-08 16:47:28 +00002420 "Displays the value of a symbolic link." \
2421 USAGE_READLINK_FOLLOW("\n\nOptions:\n" \
2422 "\t-f\tcanonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002423
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002424#define readprofile_trivial_usage \
2425 "[OPTIONS]..."
2426#define readprofile_full_usage \
2427 "Options:\n" \
2428 "\t -m <mapfile> (default: /boot/System.map)\n" \
2429 "\t -p <profile> (default: /proc/profile)\n" \
2430 "\t -M <mult> set the profiling multiplier to <mult>\n" \
2431 "\t -i print only info about the sampling step\n" \
2432 "\t -v print verbose data\n" \
2433 "\t -a print all symbols, even if count is 0\n" \
2434 "\t -b print individual histogram-bin counts\n" \
2435 "\t -s print individual counters within functions\n" \
2436 "\t -r reset all the counters (root only)\n" \
2437 "\t -n disable byte order auto-detection"
2438
Glenn L McGrath62fae302002-12-10 00:14:33 +00002439#define realpath_trivial_usage \
2440 "pathname ..."
2441#define realpath_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002442 "Returns the absolute pathnames of given argument."
Tim Riker7b253f82003-12-28 05:02:40 +00002443
Eric Andersen7e9276b2001-02-22 01:15:47 +00002444#define reboot_trivial_usage \
Glenn L McGrath72b14a82004-07-23 03:33:38 +00002445 "[-d<delay>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002446#define reboot_full_usage \
Glenn L McGrath72b14a82004-07-23 03:33:38 +00002447 "Reboot the system.\n" \
2448 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002449 "\t-d\t\tdelay interval for rebooting"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002450
2451#define renice_trivial_usage \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002452 "{{-n INCREMENT} | PRIORITY} [[ -p | -g | -u ] ID ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002453#define renice_full_usage \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002454 "Changes priority of running processes.\n\n" \
2455 "Options:\n" \
2456 "\t-n\tadjusts current nice value (smaller is faster)\n" \
2457 "\t-p\tprocess id(s) (default)\n" \
2458 "\t-g\tprocess group id(s)\n" \
2459 "\t-u\tprocess user name(s) and/or id(s)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002460
Eric Andersen7e9276b2001-02-22 01:15:47 +00002461#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002462 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002463#define reset_full_usage \
2464 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002465
Eric Andersen7e9276b2001-02-22 01:15:47 +00002466#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002467 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002468#define rm_full_usage \
2469 "Remove (unlink) the FILE(s). You may use '--' to\n" \
2470 "indicate that all following arguments are non-options.\n\n" \
2471 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002472 "\t-i\t\talways prompt before removing each destination\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002473 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002474 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002475#define rm_example_usage \
2476 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002477
Eric Andersen7e9276b2001-02-22 01:15:47 +00002478#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002479 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002480#define rmdir_full_usage \
2481 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002482#define rmdir_example_usage \
2483 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002484
Eric Andersen7e9276b2001-02-22 01:15:47 +00002485#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002486 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002487#define rmmod_full_usage \
2488 "Unloads the specified kernel modules from the kernel.\n\n" \
2489 "Options:\n" \
Tim Rikercf932742002-12-14 01:58:59 +00002490 "\t-a\tRemove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002491#define rmmod_example_usage \
2492 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002493
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002494#ifdef CONFIG_FEATURE_IPV6
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002495# define USAGE_ROUTE_IPV6(a) a
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002496#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002497# define USAGE_ROUTE_IPV6(a) "\t"
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002498#endif
2499
2500
Eric Andersen7e9276b2001-02-22 01:15:47 +00002501#define route_trivial_usage \
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002502 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002503#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002504 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00002505 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002506 "\t-n\t\tDont resolve names\n" \
2507 "\t-e\t\tDisplay other/more information\n" \
2508 "\t-A inet" USAGE_ROUTE_IPV6("{6}") "\tSelect address family"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002509
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002510#define rpm_trivial_usage \
2511 "-i -q[ildc]p package.rpm"
2512#define rpm_full_usage \
2513 "Manipulates RPM packages" \
Eric Andersendfce3532003-06-15 07:00:54 +00002514 "\n\nOptions:" \
2515 "\n\t-i Install package" \
2516 "\n\t-q Query package" \
2517 "\n\t-p Query uninstalled package" \
2518 "\n\t-i Show information" \
2519 "\n\t-l List contents" \
2520 "\n\t-d List documents" \
2521 "\n\t-c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002522
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002523#define rpm2cpio_trivial_usage \
2524 "package.rpm"
2525#define rpm2cpio_full_usage \
2526 "Outputs a cpio archive of the rpm file."
2527
Eric Andersen6cf47a72001-10-31 10:24:36 +00002528#define run_parts_trivial_usage \
2529 "[-t] [-a ARG] [-u MASK] DIRECTORY"
2530#define run_parts_full_usage \
2531 "Run a bunch of scripts in a directory.\n\n" \
2532 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002533 "\t-t\tPrints what would be run, but does not actually run anything\n" \
2534 "\t-a ARG\tPass ARG as an argument for every program invoked\n" \
2535 "\t-u MASK\tSet the umask to MASK before executing every program"
Eric Andersen6cf47a72001-10-31 10:24:36 +00002536
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002537#if BB_APPLET_RUNLEVEL
2538#define runlevel_trivial_usage \
2539 "[utmp]"
2540#define runlevel_full_usage \
2541 "Find the current and previous system runlevel.\n\n" \
2542 "If no utmp file exists or if no runlevel record can be found,\n" \
2543 "runlevel prints \"unknown\""
2544#define runlevel_example_usage \
2545 "$ runlevel /var/run/utmp\n" \
2546 "N 2"
2547#endif
2548
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002549#define rx_trivial_usage \
2550 "FILE"
2551#define rx_full_usage \
2552 "Receive a file using the xmodem protocol."
2553#define rx_example_usage \
2554 "$ rx /tmp/foo\n"
2555
Eric Andersen7e9276b2001-02-22 01:15:47 +00002556#define sed_trivial_usage \
Rob Landley1ce59682004-05-26 21:59:31 +00002557 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002558#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002559 "Options:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002560 "\t-e script\tadd the script to the commands to be executed\n" \
Eric Andersenf802ff72004-04-12 15:12:06 +00002561 "\t-f scriptfile\tadd script-file contents to the\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002562 "\t\t\tcommands to be executed\n" \
Rob Landley1ce59682004-05-26 21:59:31 +00002563 "\t-i\t\tedit files in-place\n" \
2564 "\t-n\t\tsuppress automatic printing of pattern space\n" \
Rob Landley58b118a2004-05-26 22:09:37 +00002565 "\t-r\t\tuse extended regular expression syntax\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002566 "\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002567 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
2568 "script to interpret. All remaining arguments are names of input files; if no\n" \
Eric Andersenf802ff72004-04-12 15:12:06 +00002569 "input files are specified, then the standard input is read. Source files\n" \
2570 "will not be modified unless -i option is given."
2571
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002572#define sed_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002573 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002574 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002575
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002576#define seq_trivial_usage \
2577 "[first [increment]] last"
2578#define seq_full_usage \
2579 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
2580 "FIRST, INCREMENT default to 1\n" \
2581 "Arguments:\n" \
2582 "\tLAST\n" \
2583 "\tFIRST\tLAST\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002584 "\tFIRST\tINCREMENT\tLAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002585
Paul Foxfc2256a2005-08-01 18:12:30 +00002586#define setconsole_trivial_usage \
2587 "[-r|--reset] [DEVICE]"
2588#define setconsole_full_usage \
2589 "Redirects system console output to DEVICE (default: /dev/tty).\n\n" \
2590 "Options:\n" \
2591 "\t-r\tReset output to /dev/console."
2592
Eric Andersen7e9276b2001-02-22 01:15:47 +00002593#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002594 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002595#define setkeycodes_full_usage \
2596 "Set entries into the kernel's scancode-to-keycode map,\n" \
2597 "allowing unusual keyboards to generate usable keycodes.\n\n" \
2598 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002599 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002600#define setkeycodes_example_usage \
2601 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002602
Paul Fox42403642005-08-01 22:52:09 +00002603#define setsid_trivial_usage \
2604 "program [arg ...]"
2605#define setsid_full_usage \
2606 "Runs any program in a new session by calling setsid() before\n" \
2607 "exec'ing the rest of its arguments. See setsid(2) for details."
2608
Matt Kraai2d91deb2001-08-01 17:21:35 +00002609#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002610 "[FILE]...\n" \
2611 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00002612#define lash_full_usage \
Eric Andersen2e9c2572003-08-08 22:26:06 +00002613 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00002614#define lash_notes_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002615 "This command does not yet have proper documentation.\n\n" \
2616 "Use lash just as you would use any other shell. It properly handles pipes,\n" \
2617 "redirects, job control, can be used as the shell for scripts, and has a\n" \
2618 "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002619 "Bourne Shell syntax. If you need things like \"if-then-else\", \"while\", and such\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002620 "use ash or bash. If you just need a very simple and extremely small shell,\n" \
2621 "this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002622
Eric Andersen2e9c2572003-08-08 22:26:06 +00002623#define last_trivial_usage \
2624 ""
2625#define last_full_usage \
2626 "Shows listing of the last users that logged into the system"
2627
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002628#define sha1sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002629 "[OPTION] [FILEs...]" \
2630 USAGE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002631#define sha1sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002632 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n\n" \
2633 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002634 "With no FILE, or when FILE is -, read standard input." \
2635 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
2636 "\t-c\tcheck SHA1 sums against given list\n" \
2637 "\nThe following two options are useful only when verifying checksums:\n" \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002638 "\t-s\tdon't output anything, status code shows success\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002639 "\t-w\twarn about improperly formated SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002640
Manuel Novoa III cad53642003-03-19 09:13:01 +00002641#ifdef CONFIG_FEATURE_FANCY_SLEEP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002642# define USAGE_FANCY_SLEEP(a) a
2643# define USAGE_NOT_FANCY_SLEEP(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +00002644#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002645# define USAGE_FANCY_SLEEP(a)
2646# define USAGE_NOT_FANCY_SLEEP(a) a
Manuel Novoa III cad53642003-03-19 09:13:01 +00002647#endif
2648
Eric Andersen7e9276b2001-02-22 01:15:47 +00002649#define sleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002650 USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002651#define sleep_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002652 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \
2653 USAGE_FANCY_SLEEP( \
Eric Andersen178de172004-04-06 16:36:20 +00002654 "Pause for a time equal to the total of the args given, where each arg can\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00002655 "\t\thave an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002656#define sleep_example_usage \
2657 "$ sleep 2\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002658 "[2 second delay results]\n" \
2659 USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \
2660 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002661
Rob Landleyc0dedd02005-01-24 07:00:02 +00002662#ifdef CONFIG_SORT_BIG
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002663# define USAGE_SORT_BIG(a) a
Mark Whitleyfccaa362001-04-17 18:56:18 +00002664#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002665# define USAGE_SORT_BIG(a)
Mark Whitleyfccaa362001-04-17 18:56:18 +00002666#endif
Rob Landleyc0dedd02005-01-24 07:00:02 +00002667
Eric Andersen7e9276b2001-02-22 01:15:47 +00002668#define sort_trivial_usage \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002669 "[-nru" USAGE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002670#define sort_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002671 "Sorts lines of text in the specified files\n\n" \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002672 "Options:\n" \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002673 USAGE_SORT_BIG( \
2674 "\t-b\tignore leading blanks\n" \
2675 "\t-c\tcheck whether input is sorted\n" \
2676 "\t-d\tdictionary order (blank or alphanumeric only)\n" \
2677 "\t-f\tignore case\n" \
2678 "\t-g\tgeneral numerical sort\n" \
2679 "\t-i\tignore unprintable characters\n" \
2680 "\t-k\tspecify sort key\n" \
2681 "\t-M\tsort month\n" \
2682 ) \
2683 "\t-n\tsort numbers\n" \
2684 USAGE_SORT_BIG( \
2685 "\t-o\toutput to file\n" \
2686 "\t-k\tsort by key\n" \
2687 "\t-t\tuse key separator other than whitespace\n" \
2688 ) \
2689 "\t-r\treverse sort order\n" \
2690 USAGE_SORT_BIG("\t-s\tstable (don't sort ties alphabetically)\n") \
2691 "\t-u\tsuppress duplicate lines" \
2692 USAGE_SORT_BIG("\n\t-z\tinput terminated by nulls, not newlines\n") \
2693 USAGE_SORT_BIG("\t-mST\tignored for GNU compatability") \
2694 ""
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002695#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002696 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002697 "a\n" \
2698 "b\n" \
2699 "c\n" \
2700 "d\n" \
2701 "e\n" \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002702 "f\n" \
2703 USAGE_SORT_BIG( \
2704 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
2705 "d 2\n" \
2706 "b 2\n" \
2707 "c 3\n" \
2708 ) \
2709 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002710
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002711#define start_stop_daemon_trivial_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002712 "[OPTIONS] [--start|--stop] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002713#define start_stop_daemon_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002714 "Program to start and stop services." \
2715 "\n\nOptions:" \
2716 "\n\t-S|--start\t\t\tstart" \
2717 "\n\t-K|--stop\t\t\tstop" \
2718 "\n\t-a|--startas <pathname>\t\tstarts process specified by pathname" \
2719 "\n\t-b|--background\t\t\tforce process into background" \
2720 "\n\t-u|--user <username>|<uid>\tstop this user's processes" \
2721 "\n\t-x|--exec <executable>\t\tprogram to either start or check" \
2722 "\n\t-m|--make-pidfile <filename>\tcreate the -p file and enter pid in it" \
2723 "\n\t-n|--name <process-name>\tstop processes with this name" \
2724 "\n\t-p|--pidfile <pid-file>\t\tsave or load pid using a pid-file" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002725 "\n\t-q|--quiet\t\t\tbe quiet" \
Eric Andersen178de172004-04-06 16:36:20 +00002726 "\n\t-s|--signal <signal>\t\tsignal to send (default TERM)"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002727
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002728#ifdef CONFIG_FEATURE_STAT_FORMAT
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002729# define USAGE_STAT_FORMAT(a) a
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002730#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002731# define USAGE_STAT_FORMAT(a)
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002732#endif
2733#define stat_trivial_usage \
2734 "[OPTION] FILE..."
2735#define stat_full_usage \
2736 "display file (default) or filesystem status.\n\n" \
2737 "Options:\n" \
2738 USAGE_STAT_FORMAT("\t-c fmt\tuse the specified format\n") \
2739 "\t-f\tdisplay filesystem status\n" \
2740 "\t-L,-l\tdereference links\n" \
2741 "\t-t\tdisplay info in terse form\n" \
2742 USAGE_STAT_FORMAT( \
2743 "\nValid format sequences for files:\n" \
2744 " %a Access rights in octal\n" \
2745 " %A Access rights in human readable form\n" \
2746 " %b Number of blocks allocated (see %B)\n" \
2747 " %B The size in bytes of each block reported by %b\n" \
2748 " %d Device number in decimal\n" \
2749 " %D Device number in hex\n" \
2750 " %f Raw mode in hex\n" \
2751 " %F File type\n" \
2752 " %g Group ID of owner\n" \
2753 " %G Group name of owner\n" \
2754 " %h Number of hard links\n" \
2755 " %i Inode number\n" \
2756 " %n File name\n" \
2757 " %N Quoted file name with dereference if symbolic link\n" \
2758 " %o I/O block size\n" \
2759 " %s Total size, in bytes\n" \
2760 " %t Major device type in hex\n" \
2761 " %T Minor device type in hex\n" \
2762 " %u User ID of owner\n" \
2763 " %U User name of owner\n" \
2764 " %x Time of last access\n" \
2765 " %X Time of last access as seconds since Epoch\n" \
2766 " %y Time of last modification\n" \
2767 " %Y Time of last modification as seconds since Epoch\n" \
2768 " %z Time of last change\n" \
2769 " %Z Time of last change as seconds since Epoch\n" \
2770 "\nValid format sequences for file systems:\n" \
2771 " %a Free blocks available to non-superuser\n" \
2772 " %b Total data blocks in file system\n" \
2773 " %c Total file nodes in file system\n" \
2774 " %d Free file nodes in file system\n" \
2775 " %f Free blocks in file system\n" \
2776 " %i File System ID in hex\n" \
2777 " %l Maximum length of filenames\n" \
2778 " %n File name\n" \
2779 " %s Block size (for faster transfers)\n" \
2780 " %S Fundamental block size (for block counts)\n" \
2781 " %t Type in hex\n" \
2782 " %T Type in human readable form\n" \
2783 )
2784
Eric Andersenef5e8f82002-11-07 02:09:37 +00002785#define strings_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002786 "[-afo] [-n length] [file ... ]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002787#define strings_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002788 "Display printable strings in a binary file." \
2789 "\n\nOptions:" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002790 "\n\t-a\tScan the whole files (this is the default)." \
Eric Andersen178de172004-04-06 16:36:20 +00002791 "\n\t-f\tPrecede each string with the name of the file where it was found." \
2792 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002793 "\n\t-o\tEach string is preceded by its decimal offset in the file"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002794
Eric Andersen7e9276b2001-02-22 01:15:47 +00002795#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002796 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002797#define stty_full_usage \
2798 "Without arguments, prints baud rate, line discipline," \
2799 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002800 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00002801 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002802 "\n\t-a\t\tprint all current settings in human-readable form" \
2803 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00002804 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002805
Robert Griebl1fca5582002-06-04 20:45:46 +00002806#define su_trivial_usage \
2807 "[OPTION]... [-] [username]"
2808#define su_full_usage \
2809 "Change user id or become root.\n" \
2810 "Options:\n" \
2811 "\t-p\tPreserve environment"
2812
Eric Andersen27f64e12002-06-23 04:24:25 +00002813#define sulogin_trivial_usage \
2814 "[OPTION]... [tty-device]"
2815#define sulogin_full_usage \
2816 "Single user login\n" \
2817 "Options:\n" \
2818 "\t-f\tDo not authenticate (user already authenticated)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002819 "\t-h\tName of the remote host for this login\n" \
2820 "\t-p\tPreserve environment"
Eric Andersen27f64e12002-06-23 04:24:25 +00002821
Mike Frysinger95d3c452005-04-21 23:29:24 +00002822#define sum_trivial_usage \
2823 "[rs] [files...]"
2824#define sum_full_usage \
2825 "checksum and count the blocks in a file\n\n" \
2826 "Options:\n" \
2827 "\t-r\tuse BSD sum algorithm (1K blocks)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002828 "\t-s\tuse System V sum algorithm (512byte blocks)"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002829
Eric Andersen7e9276b2001-02-22 01:15:47 +00002830#define swapoff_trivial_usage \
Mike Frysinger68071e42005-09-13 02:26:24 +00002831 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002832#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002833 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002834 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002835 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002836
Eric Andersen7e9276b2001-02-22 01:15:47 +00002837#define swapon_trivial_usage \
Mike Frysinger68071e42005-09-13 02:26:24 +00002838 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002839#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002840 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002841 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002842 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002843
Rob Landley0f34a822005-10-27 22:55:50 +00002844#define switch_root_trivial_usage \
Rob Landley70f7ef72005-12-13 08:21:33 +00002845 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00002846#define switch_root_full_usage \
2847 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Rob Landley70f7ef72005-12-13 08:21:33 +00002848 "and exec NEW_INIT.\n\n" \
2849 "Options:\n" \
2850 "\t-c\tRedirect console to device on new root"
Rob Landley0f34a822005-10-27 22:55:50 +00002851
Eric Andersen7e9276b2001-02-22 01:15:47 +00002852#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002853 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002854#define sync_full_usage \
2855 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002856
Eric Andersen7e9276b2001-02-22 01:15:47 +00002857
Eric Andersen29c77f72003-10-09 09:43:18 +00002858#ifdef CONFIG_FEATURE_ROTATE_LOGFILE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002859# define USAGE_ROTATE_LOGFILE(a) a
Eric Andersen29c77f72003-10-09 09:43:18 +00002860#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002861# define USAGE_ROTATE_LOGFILE(a)
Eric Andersen29c77f72003-10-09 09:43:18 +00002862#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002863#ifdef CONFIG_FEATURE_REMOTE_LOG
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002864# define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002865#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002866# define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002867#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00002868#ifdef CONFIG_FEATURE_IPC_SYSLOG
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002869# define USAGE_IPC_LOG(a) a
Robert Griebl65d415d2002-08-07 21:10:19 +00002870#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002871# define USAGE_IPC_LOG(a)
Robert Griebl65d415d2002-08-07 21:10:19 +00002872#endif
2873
Eric Andersenb9050282003-12-24 06:02:11 +00002874#define sysctl_trivial_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002875 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00002876#define sysctl_full_usage \
2877 "configure kernel parameters at runtime\n\n" \
Eric Andersenb9050282003-12-24 06:02:11 +00002878 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002879 "\t-n\tUse this option to disable printing of the key name when printing values\n" \
2880 "\t-w\tUse this option when you want to change a sysctl setting\n" \
2881 "\t-p\tLoad in sysctl settings from the file specified or /etc/sysctl.conf if none given\n" \
2882 "\t-a\tDisplay all values currently available\n" \
2883 "\t-A\tDisplay all values currently available in table form"
Eric Andersen5d38f5b2005-09-12 21:42:48 +00002884#define sysctl_example_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002885 "sysctl [-n] variable ...\n" \
2886 "sysctl [-n] -w variable=value ...\n" \
2887 "sysctl [-n] -a\n" \
2888 "sysctl [-n] -p <file>\t(default /etc/sysctl.conf)\n" \
2889 "sysctl [-n] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00002890
Eric Andersen7e9276b2001-02-22 01:15:47 +00002891#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002892 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002893#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002894 "Linux system and kernel logging utility.\n" \
2895 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002896 "Options:\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002897 "\t-m MIN\t\tMinutes between MARK lines (default=20, 0=off)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002898 "\t-n\t\tRun as a foreground process\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002899 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)\n" \
2900 "\t-S\t\tMake logging output smaller." \
Eric Andersen29c77f72003-10-09 09:43:18 +00002901 USAGE_ROTATE_LOGFILE( \
Eric Andersen178de172004-04-06 16:36:20 +00002902 "\n\t-s SIZE\t\tMax size (KB) before rotate (default=200KB, 0=off)\n" \
2903 "\t-b NUM\t\tNumber of rotated logs to keep (default=1, max=99, 0=purge)") \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002904 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00002905 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00002906 "\t-L\t\tLog locally and via network logging (default is network only)") \
2907 USAGE_IPC_LOG( \
Eric Andersend4a5e252003-12-19 11:32:14 +00002908 "\n\t-C [size(KiB)]\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002909#define syslogd_example_usage \
2910 "$ syslogd -R masterlog:514\n" \
2911 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002912
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002913
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002914#ifndef CONFIG_FEATURE_FANCY_TAIL
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002915# define USAGE_UNSIMPLE_TAIL(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00002916#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002917# define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002918#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002919#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002920 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002921#define tail_full_usage \
2922 "Print last 10 lines of each FILE to standard output.\n" \
2923 "With more than one FILE, precede each with a header giving the\n" \
2924 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
2925 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002926 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002927 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
2928 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002929 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002930 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
2931 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002932 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002933 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002934 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
2935#define tail_example_usage \
2936 "$ tail -n 1 /etc/resolv.conf\n" \
2937 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002938
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002939#ifdef CONFIG_FEATURE_TAR_CREATE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002940# define USAGE_TAR_CREATE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002941#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002942# define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002943#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002944#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002945# define USAGE_TAR_EXCLUDE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002946#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002947# define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002948#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002949#ifdef CONFIG_FEATURE_TAR_GZIP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002950# define USAGE_TAR_GZIP(a) a
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002951#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002952# define USAGE_TAR_GZIP(a)
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002953#endif
2954#ifdef CONFIG_FEATURE_TAR_BZIP2
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002955# define USAGE_TAR_BZIP2(a) a
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002956#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002957# define USAGE_TAR_BZIP2(a)
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002958#endif
Glenn L McGrath7370f622003-11-18 21:49:23 +00002959#ifdef CONFIG_FEATURE_TAR_COMPRESS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002960# define USAGE_TAR_COMPRESS(a) a
Glenn L McGrath7370f622003-11-18 21:49:23 +00002961#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002962# define USAGE_TAR_COMPRESS(a)
Glenn L McGrath7370f622003-11-18 21:49:23 +00002963#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002964
Eric Andersen7e9276b2001-02-22 01:15:47 +00002965#define tar_trivial_usage \
Glenn L McGrath7370f622003-11-18 21:49:23 +00002966 "-[" 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 +00002967 USAGE_TAR_EXCLUDE("[-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00002968 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002969#define tar_full_usage \
2970 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00002971 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002972 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002973 "\tx\t\textract\n" \
2974 "\tt\t\tlist\n" \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002975 "\nArchive format selection:\n" \
2976 USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
2977 USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
Glenn L McGrath0c5d9c22003-11-18 23:27:49 +00002978 USAGE_TAR_COMPRESS("\tZ\t\tFilter the archive through compress\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002979 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002980 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002981 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002982 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002983 "\texclude\t\tfile to exclude\n" \
2984 "\tX\t\tfile with names to exclude\n" \
2985 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00002986 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002987 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002988#define tar_example_usage \
2989 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
2990 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002991
Eric Andersen7e9276b2001-02-22 01:15:47 +00002992#define tee_trivial_usage \
2993 "[OPTION]... [FILE]..."
2994#define tee_full_usage \
2995 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002996 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002997 "\t-a\tappend to the given FILEs, do not overwrite\n" \
2998 "\t-i\tignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002999#define tee_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003000 "$ echo \"Hello\" | tee /tmp/foo\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003001 "$ cat /tmp/foo\n" \
3002 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003003
Eric Andersen539ffc92004-02-22 12:25:47 +00003004#ifdef CONFIG_FEATURE_TELNET_AUTOLOGIN
3005#define telnet_trivial_usage \
3006 "[-a] [-l USER] HOST [PORT]"
3007#define telnet_full_usage \
3008 "Telnet is used to establish interactive communication with another\n" \
3009 "computer over a network using the TELNET protocol.\n\n" \
3010 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003011 "\t-a\t\tAttempt an automatic login with the USER variable\n" \
3012 "\t-l USER\t\tAttempt an automatic login with the USER argument\n" \
Eric Andersen539ffc92004-02-22 12:25:47 +00003013 "\tHOST\t\tThe official name, alias or the IP address of the\n" \
3014 "\t\t\tremote host.\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003015 "\tPORT\t\tThe remote port number to connect to. If it is not\n" \
Eric Andersen178de172004-04-06 16:36:20 +00003016 "\t\t\tspecified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00003017#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003018#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003019 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003020#define telnet_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003021 "Telnet is used to establish interactive communication with another\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003022 "computer over a network using the TELNET protocol."
Eric Andersen539ffc92004-02-22 12:25:47 +00003023#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003024
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003025#ifdef CONFIG_FEATURE_TELNETD_INETD
3026#define telnetd_trivial_usage \
3027 "(inetd mode) [OPTION]"
3028#define telnetd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003029 "Telnetd uses incoming TELNET connections via inetd.\n" \
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003030 "Options:\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00003031 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003032 "\t-f issue_file\tDisplay issue_file instead of /etc/issue"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003033#else
Eric Andersen08a72202002-09-30 20:52:10 +00003034#define telnetd_trivial_usage \
3035 "[OPTION]"
3036#define telnetd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003037 "Telnetd listens for incoming TELNET connections on PORT.\n" \
Eric Andersen08a72202002-09-30 20:52:10 +00003038 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003039 "\t-p PORT\tlisten for connections on PORT (default 23)\n" \
3040 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)\n" \
3041 "\t-f issue_file\tDisplay issue_file instead of /etc/issue"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003042#endif
Eric Andersen08a72202002-09-30 20:52:10 +00003043
Eric Andersen7e9276b2001-02-22 01:15:47 +00003044#define test_trivial_usage \
3045 "EXPRESSION\n or [ EXPRESSION ]"
3046#define test_full_usage \
3047 "Checks file types and compares values returning an exit\n" \
3048 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003049#define test_example_usage \
3050 "$ test 1 -eq 2\n" \
3051 "$ echo $?\n" \
3052 "1\n" \
3053 "$ test 1 -eq 1\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00003054 "$ echo $?\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003055 "0\n" \
3056 "$ [ -d /etc ]\n" \
3057 "$ echo $?\n" \
3058 "0\n" \
3059 "$ [ -d /junk ]\n" \
3060 "$ echo $?\n" \
3061 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003062
Eric Andersenbdfd0d72001-10-24 05:00:29 +00003063#ifdef CONFIG_FEATURE_TFTP_GET
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003064# define USAGE_TFTP_GET(a) a
Mark Whitley450736c2001-03-02 19:08:50 +00003065#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003066# define USAGE_TFTP_GET(a)
Mark Whitley450736c2001-03-02 19:08:50 +00003067#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00003068#ifdef CONFIG_FEATURE_TFTP_PUT
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003069# define USAGE_TFTP_PUT(a) a
Mark Whitley450736c2001-03-02 19:08:50 +00003070#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003071# define USAGE_TFTP_PUT(a)
Mark Whitley450736c2001-03-02 19:08:50 +00003072#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00003073#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003074# define USAGE_TFTP_BS(a) a
Glenn L McGrathad117d82001-10-05 04:40:37 +00003075#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003076# define USAGE_TFTP_BS(a)
Glenn L McGrathad117d82001-10-05 04:40:37 +00003077#endif
Mark Whitley450736c2001-03-02 19:08:50 +00003078
3079#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00003080 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00003081#define tftp_full_usage \
3082 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00003083 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003084 "\t-l FILE\tLocal FILE\n" \
3085 "\t-r FILE\tRemote FILE" \
3086 USAGE_TFTP_GET( \
3087 "\n\t-g\tGet file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003088 ) \
Mike Frysinger058e7402005-04-23 07:00:33 +00003089 USAGE_TFTP_PUT( \
3090 "\n\t-p\tPut file" \
Mark Whitley450736c2001-03-02 19:08:50 +00003091 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00003092 USAGE_TFTP_BS( \
Mike Frysinger058e7402005-04-23 07:00:33 +00003093 "\n\t-b SIZE\tTransfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00003094 )
Eric Andersenc3657422001-11-30 07:54:32 +00003095#define time_trivial_usage \
3096 "[OPTION]... COMMAND [ARGS...]"
3097#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00003098 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
3099 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00003100 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003101 "\t-v\tDisplays verbose resource usage information"
Mark Whitley450736c2001-03-02 19:08:50 +00003102
Eric Andersen420b2082002-09-17 22:14:58 +00003103#define top_trivial_usage \
3104 "[-d <seconds>]"
3105#define top_full_usage \
3106 "top provides an view of processor activity in real time.\n" \
3107 "This utility reads the status for all processes in /proc each <seconds>\n" \
3108 "and shows the status for however many processes will fit on the screen.\n" \
3109 "This utility will not show processes that are started after program startup,\n" \
3110 "but it will show the EXIT status for and PIDs that exit while it is running."
3111
Eric Andersen7e9276b2001-02-22 01:15:47 +00003112#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003113 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003114#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003115 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003116 "Options:\n" \
3117 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003118#define touch_example_usage \
3119 "$ ls -l /tmp/foo\n" \
3120 "/bin/ls: /tmp/foo: No such file or directory\n" \
3121 "$ touch /tmp/foo\n" \
3122 "$ ls -l /tmp/foo\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003123 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003124
3125#define tr_trivial_usage \
3126 "[-cds] STRING1 [STRING2]"
3127#define tr_full_usage \
3128 "Translate, squeeze, and/or delete characters from\n" \
3129 "standard input, writing to standard output.\n\n" \
3130 "Options:\n" \
3131 "\t-c\ttake complement of STRING1\n" \
3132 "\t-d\tdelete input characters coded STRING1\n" \
3133 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003134#define tr_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003135 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003136 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003137
Eric Andersen5c58d282001-07-10 16:29:00 +00003138#define traceroute_trivial_usage \
"Vladimir N. Oleynik"45a8ed82005-09-06 16:08:33 +00003139 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
3140 "\t[-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
3141 "\t[-z pausemsecs] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00003142#define traceroute_full_usage \
3143 "trace the route ip packets follow going to \"host\"\n" \
3144 "Options:\n" \
"Vladimir N. Oleynik"45a8ed82005-09-06 16:08:33 +00003145 "\t-F\tSet the don't fragment bit\n" \
3146 "\t-I\tUse ICMP ECHO instead of UDP datagrams\n" \
3147 "\t-l\tDisplay the ttl value of the returned packet\n" \
3148 "\t-d\tSet SO_DEBUG options to socket\n" \
Eric Andersen5c58d282001-07-10 16:29:00 +00003149 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
3150 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
3151 "\t-v\tVerbose output\n" \
3152 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
3153 "\t-p port#\tSet the base UDP port number used in probes\n" \
3154 "\t\t(default is 33434)\n" \
3155 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
3156 "\t\t(default is 3)\n" \
3157 "\t-s src_addr\tUse the following IP address as the source address\n" \
3158 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
3159 "\t\t(default 0)\n" \
3160 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
Mike Frysinger036f2992005-09-24 23:50:14 +00003161 "\t\t(default 3 sec)\n" \
3162 "\t-g\tSpecify a loose source route gateway (8 maximum)"
Eric Andersen5c58d282001-07-10 16:29:00 +00003163
3164
Eric Andersen7e9276b2001-02-22 01:15:47 +00003165#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003166 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003167#define true_full_usage \
3168 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003169#define true_example_usage \
3170 "$ true\n" \
3171 "$ echo $?\n" \
3172 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003173
Eric Andersen7e9276b2001-02-22 01:15:47 +00003174#define tty_trivial_usage \
3175 ""
3176#define tty_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003177 "Print the file name of the terminal connected to standard input.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003178 "Options:\n" \
3179 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003180#define tty_example_usage \
3181 "$ tty\n" \
3182 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003183
Mike Frysinger174808c2005-06-11 01:14:09 +00003184#define tune2fs_trivial_usage \
3185 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
3186 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
3187 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
3188 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
3189 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
3190 "[-T last-check-time] [-U UUID] device"
3191#define tune2fs_full_usage \
3192 "Adjust filesystem options on ext[23] filesystems.\n\n"
3193
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003194#define udhcpc_trivial_usage \
Paul Fox28de9512005-09-22 18:59:13 +00003195 "[-Cfbnqv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003196#define udhcpc_full_usage \
Paul Foxa39bba32005-08-01 14:31:13 +00003197 "\t-c,\t--clientid=CLIENTID\tSet client identifier\n" \
3198 "\t-C,\t--clientid-none\tSuppress default client identifier\n" \
Paul Fox28de9512005-09-22 18:59:13 +00003199 "\t-V,\t--vendorclass=CLASSID\tSet vendor class identifier\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003200 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00003201 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003202 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003203 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003204 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003205 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003206 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
3207 "\t-q,\t--quit\tQuit after obtaining lease\n" \
3208 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
3209 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
3210 "\t-v,\t--version\tDisplay version"
3211
Russ Dill61fb4892002-10-14 21:41:28 +00003212#define udhcpd_trivial_usage \
3213 "[configfile]\n" \
3214
3215#define udhcpd_full_usage \
Glenn L McGrath9130c852002-12-12 12:56:18 +00003216 ""
Russ Dill61fb4892002-10-14 21:41:28 +00003217
Eric Andersenbdfd0d72001-10-24 05:00:29 +00003218#ifdef CONFIG_FEATURE_MOUNT_FORCE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003219# define USAGE_MOUNT_FORCE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00003220#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003221# define USAGE_MOUNT_FORCE(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00003222#endif
3223#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003224 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003225#define umount_full_usage \
3226 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00003227 "\nFlags:\n" "\t-a\tUnmount all file systems" \
3228 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
3229 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Rob Landley16722552005-09-24 22:41:08 +00003230 "\n\t-l\tLazy umount (detach filesystem)" \
3231 "\n\t-f\tForce umount (i.e., unreachable NFS server)" \
3232 USAGE_MOUNT_LOOP("\n\t-D\tDo not free loop device (if a loop device has been used)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003233#define umount_example_usage \
3234 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003235
3236#define uname_trivial_usage \
3237 "[OPTION]..."
3238#define uname_full_usage \
3239 "Print certain system information. With no OPTION, same as -s.\n\n" \
3240 "Options:\n" \
3241 "\t-a\tprint all information\n" \
3242 "\t-m\tthe machine (hardware) type\n" \
3243 "\t-n\tprint the machine's network node hostname\n" \
3244 "\t-r\tprint the operating system release\n" \
3245 "\t-s\tprint the operating system name\n" \
3246 "\t-p\tprint the host processor type\n" \
3247 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003248#define uname_example_usage \
3249 "$ uname -a\n" \
Eric Andersen7f48a952003-12-28 05:06:56 +00003250 "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 +00003251
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003252#define uncompress_trivial_usage \
3253 "[-c] [-f] [ name ... ]"
3254#define uncompress_full_usage \
3255 "Uncompress .Z file[s]\n" \
3256 "Options:\n" \
3257 "\t-c\textract to stdout\n" \
Eric Andersen178de172004-04-06 16:36:20 +00003258 "\t-f\tforce overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00003259
Eric Andersen7e9276b2001-02-22 01:15:47 +00003260#define uniq_trivial_usage \
Rob Landley14efdc52005-09-07 04:18:36 +00003261 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003262#define uniq_full_usage \
3263 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00003264 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003265 "Options:\n" \
3266 "\t-c\tprefix lines by the number of occurrences\n" \
3267 "\t-d\tonly print duplicate lines\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00003268 "\t-u\tonly print unique lines\n" \
3269 "\t-f N\tskip the first N fields\n" \
3270 "\t-s N\tskip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003271#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00003272 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003273 "a\n" \
3274 "b\n" \
3275 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003276
3277#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003278 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003279#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003280 "Converts FILE from unix format to dos format. When no option\n" \
3281 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00003282 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00003283 "Options:\n" \
3284 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00003285 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003286
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003287#define unzip_trivial_usage \
3288 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
3289#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00003290 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003291 "Options:\n" \
3292 "\t-l\tlist archive contents (short form)\n" \
3293 "\t-n\tnever overwrite existing files (default)\n" \
3294 "\t-o\toverwrite files without prompting\n" \
3295 "\t-p\tsend output to stdout\n" \
3296 "\t-q\tbe quiet\n" \
3297 "\t-x\texclude these files\n" \
3298 "\t-d\textract files into this directory"
3299
Eric Andersen7e9276b2001-02-22 01:15:47 +00003300#define uptime_trivial_usage \
3301 ""
3302#define uptime_full_usage \
3303 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003304#define uptime_example_usage \
3305 "$ uptime\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003306 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003307
3308#define usleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00003309 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003310#define usleep_full_usage \
3311 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003312#define usleep_example_usage \
3313 "$ usleep 1000000\n" \
3314 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003315
3316#define uudecode_trivial_usage \
3317 "[FILE]..."
3318#define uudecode_full_usage \
3319 "Uudecode a file that is uuencoded.\n\n" \
3320 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003321 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003322#define uudecode_example_usage \
3323 "$ uudecode -o busybox busybox.uu\n" \
3324 "$ ls -l busybox\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003325 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003326
3327#define uuencode_trivial_usage \
3328 "[OPTION] [INFILE] REMOTEFILE"
3329#define uuencode_full_usage \
3330 "Uuencode a file.\n\n" \
3331 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00003332 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003333#define uuencode_example_usage \
3334 "$ uuencode busybox busybox\n" \
3335 "begin 755 busybox\n" \
3336 "<encoded file snipped>\n" \
3337 "$ uudecode busybox busybox > busybox.uu\n" \
3338 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003339
Eric Andersen853c4942003-01-23 05:59:32 +00003340#define vconfig_trivial_usage \
3341 "COMMAND [OPTIONS] ..."
Eric Andersen853c4942003-01-23 05:59:32 +00003342#define vconfig_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00003343 "vconfig lets you create and remove virtual ethernet devices.\n\n" \
3344 "Options:\n" \
3345 "\tadd [interface-name] [vlan_id]\n" \
3346 "\trem [vlan-name]\n" \
3347 "\tset_flag [interface-name] [flag-num] [0 | 1]\n" \
3348 "\tset_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3349 "\tset_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3350 "\tset_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00003351
Eric Andersen3f980402001-04-04 17:31:15 +00003352#define vi_trivial_usage \
3353 "[OPTION] [FILE]..."
3354#define vi_full_usage \
3355 "edit FILE.\n\n" \
3356 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003357 "\t-R\tRead-only- do not write to the file"
Eric Andersen3f980402001-04-04 17:31:15 +00003358
Eric Andersen27f64e12002-06-23 04:24:25 +00003359#define vlock_trivial_usage \
3360 "[OPTIONS]"
3361#define vlock_full_usage \
3362 "Lock a virtual terminal. A password is required to unlock\n" \
3363 "Options:\n" \
3364 "\t-a\tLock all VTs"
3365
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003366#define watch_trivial_usage \
3367 "[-n <seconds>] COMMAND..."
3368#define watch_full_usage \
3369 "Executes a program periodically.\n" \
3370 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003371 "\t-n\tLoop period in seconds - default is 2"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003372#define watch_example_usage \
3373 "$ watch date\n" \
3374 "Mon Dec 17 10:31:40 GMT 2000\n" \
3375 "Mon Dec 17 10:31:42 GMT 2000\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003376 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003377
Eric Andersen7e9276b2001-02-22 01:15:47 +00003378#define watchdog_trivial_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00003379 "[-t <seconds>] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003380#define watchdog_full_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00003381 "Periodically write to watchdog device DEV.\n" \
3382 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003383 "\t-t\tTimer period in seconds - default is 30"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003384
3385#define wc_trivial_usage \
3386 "[OPTION]... [FILE]..."
3387#define wc_full_usage \
3388 "Print line, word, and byte counts for each FILE, and a total line if\n" \
3389 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
3390 "Options:\n" \
3391 "\t-c\tprint the byte counts\n" \
3392 "\t-l\tprint the newline counts\n" \
3393 "\t-L\tprint the length of the longest line\n" \
3394 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003395#define wc_example_usage \
3396 "$ wc /etc/passwd\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003397 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003398
3399#define wget_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00003400 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00003401 "\t\t[--header 'header: value'] [-Y|--proxy on/off] [-P DIR] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003402#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00003403 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003404 "Options:\n" \
3405 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00003406 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00003407 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00003408 "\t-O\tsave to filename ('-' for stdout)\n" \
3409 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003410
3411#define which_trivial_usage \
3412 "[COMMAND ...]"
3413#define which_full_usage \
3414 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003415#define which_example_usage \
3416 "$ which login\n" \
3417 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00003418
Eric Andersen00a6a752002-04-26 23:53:10 +00003419#define who_trivial_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003420 " "
Eric Andersen00a6a752002-04-26 23:53:10 +00003421#define who_full_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003422 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003423
3424#define whoami_trivial_usage \
3425 ""
3426#define whoami_full_usage \
3427 "Prints the user name associated with the current effective user id."
3428
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003429#ifdef CONFIG_FEATURE_XARGS_SUPPORT_CONFIRMATION
3430#define USAGE_XARGS_CONFIRMATION(a) a
3431#else
3432#define USAGE_XARGS_CONFIRMATION(a)
3433#endif
3434#ifdef CONFIG_FEATURE_XARGS_SUPPORT_TERMOPT
3435#define USAGE_XARGS_TERMOPT(a) a
3436#else
3437#define USAGE_XARGS_TERMOPT(a)
3438#endif
3439#ifdef CONFIG_FEATURE_XARGS_SUPPORT_ZERO_TERM
3440#define USAGE_XARGS_ZERO_TERM(a) a
3441#else
3442#define USAGE_XARGS_ZERO_TERM(a)
3443#endif
3444
3445
Eric Andersen7e9276b2001-02-22 01:15:47 +00003446#define xargs_trivial_usage \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003447 "[COMMAND] [OPTIONS] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003448#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00003449 "Executes COMMAND on every item given by standard input.\n\n" \
3450 "Options:\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003451 USAGE_XARGS_CONFIRMATION("\t-p\tPrompt the user about whether to run each command\n") \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00003452 "\t-r\tDo not run command for empty readed lines\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003453 USAGE_XARGS_TERMOPT("\t-x\tExit if the size is exceeded\n") \
3454 USAGE_XARGS_ZERO_TERM("\t-0\tInput filenames are terminated by a null character\n") \
Mike Frysinger058e7402005-04-23 07:00:33 +00003455 "\t-t\tPrint the command line on stderr before executing it"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003456#define xargs_example_usage \
3457 "$ ls | xargs gzip\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003458 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003459
3460#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003461 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003462#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003463 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003464
Eric Andersen7e9276b2001-02-22 01:15:47 +00003465#define zcat_trivial_usage \
3466 "FILE"
3467#define zcat_full_usage \
3468 "Uncompress to stdout."
Eric Andersen178de172004-04-06 16:36:20 +00003469
Rob Landleyad8071f2005-04-30 03:49:37 +00003470#define zcip_trivial_usage \
3471 "[OPTIONS] ifname script"
3472#define zcip_full_usage \
3473 "zcip manages a ZeroConf IPv4 link-local address.\n" \
3474 "Options:\n" \
3475 "\t-f foreground mode\n" \
3476 "\t-q quit after address (no daemon)\n" \
3477 "\t-r 169.254.x.x request this address first\n" \
3478 "\t-v verbose; show version\n"
3479
Eric Andersen178de172004-04-06 16:36:20 +00003480#endif /* __BB_USAGE_H__ */