blob: 36739c7129220d3609e90bed20d572e71f02d734 [file] [log] [blame]
"Robert P. J. Day"63fc1a92006-07-02 19:47:05 +00001/* vi: set sw=4 ts=4: */
Eric Andersen178de172004-04-06 16:36:20 +00002#ifndef __BB_USAGE_H__
3#define __BB_USAGE_H__
4
Eric Andersenf349e972001-08-21 16:18:59 +00005#define addgroup_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00006 "[-g GID] group_name [user_name]"
Eric Andersenf349e972001-08-21 16:18:59 +00007#define addgroup_full_usage \
Eric Andersen192c35f2004-09-02 22:22:17 +00008 "Adds a group to the system\n\n" \
Eric Andersenf349e972001-08-21 16:18:59 +00009 "Options:\n" \
Eric Andersen178de172004-04-06 16:36:20 +000010 "\t-g GID\t\tspecify gid"
Eric Andersenf349e972001-08-21 16:18:59 +000011
12#define adduser_trivial_usage \
Eric Andersene0716ba2003-01-14 06:42:56 +000013 "[OPTIONS] user_name"
Eric Andersenf349e972001-08-21 16:18:59 +000014#define adduser_full_usage \
Eric Andersen192c35f2004-09-02 22:22:17 +000015 "Adds a user to the system\n\n" \
Eric Andersenf349e972001-08-21 16:18:59 +000016 "Options:\n" \
Eric Andersen178de172004-04-06 16:36:20 +000017 "\t-h DIR\t\tAssign home directory DIR\n" \
18 "\t-g GECOS\tAssign gecos field GECOS\n" \
19 "\t-s SHELL\tAssign login shell SHELL\n" \
20 "\t-G\t\tAdd the user to existing group GROUP\n" \
21 "\t-S\t\tcreate a system user (ignored)\n" \
22 "\t-D\t\tDo not assign a password (logins still possible via ssh)\n" \
23 "\t-H\t\tDo not create the home directory"
Eric Andersenf349e972001-08-21 16:18:59 +000024
Mark Whitley6f932772001-03-20 19:18:10 +000025#define adjtimex_trivial_usage \
26 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
27#define adjtimex_full_usage \
28 "Reads and optionally sets system timebase parameters.\n" \
29 "See adjtimex(2).\n\n" \
30 "Options:\n" \
31 "\t-q\t\tquiet mode - do not print\n" \
32 "\t-o offset\ttime offset, microseconds\n" \
33 "\t-f frequency\tfrequency adjust, integer kernel units (65536 is 1ppm)\n" \
34 "\t\t\t(positive values make the system clock run fast)\n" \
35 "\t-t tick\t\tmicroseconds per tick, usually 10000\n" \
Eric Andersen178de172004-04-06 16:36:20 +000036 "\t-p timeconstant"
Mark Whitley6f932772001-03-20 19:18:10 +000037
Eric Andersen7e9276b2001-02-22 01:15:47 +000038#define ar_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +000039 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Eric Andersen7e9276b2001-02-22 01:15:47 +000040#define ar_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +000041 "Extract or list FILES from an ar archive.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +000042 "Options:\n" \
43 "\t-o\t\tpreserve original dates\n" \
44 "\t-p\t\textract to stdout\n" \
45 "\t-t\t\tlist\n" \
46 "\t-x\t\textract\n" \
Eric Andersen178de172004-04-06 16:36:20 +000047 "\t-v\t\tverbosely list files processed"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000048
Glenn L McGrath9e598412003-01-09 10:06:01 +000049#define arping_trivial_usage \
Bernhard Reutner-Fischere47c4cb2006-03-31 18:10:31 +000050 "[-fqbDUA] [-c count] [-w timeout] [-i device] [-s sender] target"
Glenn L McGrath9e598412003-01-09 10:06:01 +000051#define arping_full_usage \
52 "Ping hosts by ARP requests/replies.\n\n" \
53 "Options:\n" \
54 "\t-f\t\tQuit on first ARP reply\n" \
55 "\t-q\t\tBe quiet\n" \
56 "\t-b\t\tKeep broadcasting, don't go unicast\n" \
57 "\t-D\t\tDuplicated address detection mode\n" \
58 "\t-U\t\tUnsolicited ARP mode, update your neighbours\n" \
59 "\t-A\t\tARP answer mode, update your neighbours\n" \
60 "\t-c count\tStop after sending count ARP request packets\n" \
61 "\t-w timeout\tTime to wait for ARP reply, in seconds\n" \
Bernhard Reutner-Fischere47c4cb2006-03-31 18:10:31 +000062 "\t-i device\tOutgoing interface name, default is eth0\n" \
Glenn L McGrath9e598412003-01-09 10:06:01 +000063 "\t-s sender\tSet specific sender IP address\n" \
Eric Andersen178de172004-04-06 16:36:20 +000064 "\ttarget\t\tTarget IP address of ARP request"
Glenn L McGrath9e598412003-01-09 10:06:01 +000065
Eric Andersen08f59e32004-03-12 22:07:10 +000066#define ash_trivial_usage \
67 "[FILE]...\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +000068 "or: ash -c command [args]..."
Eric Andersen08f59e32004-03-12 22:07:10 +000069#define ash_full_usage \
70 "The ash shell (command interpreter)"
71
72#define awk_trivial_usage \
73 "[OPTION]... [program-text] [FILE ...]"
74#define awk_full_usage \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000075 "Options:\n" \
Mike Frysinger4fcefb92006-02-06 23:38:59 +000076 "\t-v var=val\tassign value 'val' to variable 'var'\n" \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000077 "\t-F sep\t\tuse 'sep' as field separator\n" \
Mike Frysinger4fcefb92006-02-06 23:38:59 +000078 "\t-f progname\tread program source from file 'progname'"
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000079
Eric Andersen7e9276b2001-02-22 01:15:47 +000080#define basename_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000081 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000082#define basename_full_usage \
83 "Strips directory path and suffixes from FILE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000084 "If specified, also removes any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000085#define basename_example_usage \
86 "$ basename /usr/local/bin/foo\n" \
87 "foo\n" \
88 "$ basename /usr/local/bin/\n" \
89 "bin\n" \
90 "$ basename /foo/bar.txt .txt\n" \
91 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000092
Glenn L McGrath24e28332001-10-05 03:48:57 +000093#define bunzip2_trivial_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000094 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +000095#define bunzip2_full_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000096 "Uncompress FILE (or standard input if FILE is '-' or omitted).\n\n" \
97 "Options:\n" \
98 "\t-c\tWrite output to standard output\n" \
99 "\t-f\tForce"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000100
Rob Landley6130b9b2006-01-23 21:10:38 +0000101#define busybox_notes_usage \
102 "Hello world!\n"
103
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000104#define bzcat_trivial_usage \
105 "FILE"
106#define bzcat_full_usage \
107 "Uncompress to stdout."
108
Rob Landleyc1d69902006-01-20 18:28:50 +0000109#define unlzma_trivial_usage \
110 "[OPTION]... [FILE]"
111#define unlzma_full_usage \
112 "Uncompress FILE (or standard input if FILE is '-' or omitted).\n\n" \
113 "Options:\n" \
114 "\t-c\tWrite output to standard output\n" \
115 "\t-f\tForce"
116
117#define lzmacat_trivial_usage \
118 "FILE"
119#define lzmacat_full_usage \
120 "Uncompress to stdout."
121
Eric Andersenc98c0622001-12-06 15:16:43 +0000122#define cal_trivial_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000123 "[-jy] [[month] year]"
Eric Andersenc98c0622001-12-06 15:16:43 +0000124#define cal_full_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000125 "Display a calendar.\n" \
126 "\nOptions:\n" \
127 "\t-j\tUse julian dates\n" \
128 "\t-y\tDisplay the entire year"
Eric Andersenc98c0622001-12-06 15:16:43 +0000129
Eric Andersen7e9276b2001-02-22 01:15:47 +0000130#define cat_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000131 "[-u] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000132#define cat_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000133 "Concatenates FILE(s) and prints them to stdout.\n\n" \
134 "Options:\n" \
135 "\t-u\tignored since unbuffered i/o is always used"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000136#define cat_example_usage \
137 "$ cat /proc/uptime\n" \
138 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000139
Rob Landley8abbee42006-05-31 19:36:04 +0000140#define catv_trivial_usage \
141 "[-etv] [FILE]..."
142#define catv_full_usage \
143 "Display nonprinting characters as ^x or M-x.\n\n"\
144 "\t-e\tEnd each line with $\n" \
145 "\t-t\tShow tabs as ^I\n" \
146 "\t-v\tDon't use ^x or M-x escapes."
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000147#define chattr_trivial_usage \
148 "[-R] [-+=AacDdijsStTu] [-v version] files..."
149#define chattr_full_usage \
150 "change file attributes on an ext2 fs\n\n" \
151 "Modifiers:\n" \
152 "\t-\tremove attributes\n" \
153 "\t+\tadd attributes\n" \
154 "\t=\tset attributes\n" \
155 "Attributes:\n" \
156 "\tA\tdon't track atime\n" \
157 "\ta\tappend mode only\n" \
158 "\tc\tenable compress\n" \
159 "\tD\twrite dir contents synchronously\n" \
160 "\td\tdo not backup with dump\n" \
161 "\ti\tcannot be modified (immutable)\n" \
162 "\tj\twrite all data to journal first\n" \
163 "\ts\tzero disk storage when deleted\n" \
164 "\tS\twrite file contents synchronously\n" \
165 "\tt\tdisable tail-merging of partial blocks with other files\n" \
166 "\tu\tallow file to be undeleted\n" \
167 "Options:\n" \
168 "\t-R\trecursively list subdirectories\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000169 "\t-v\tset the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000170
Eric Andersen7e9276b2001-02-22 01:15:47 +0000171#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000172 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000173#define chgrp_full_usage \
174 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000175 "\nOptions:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000176 "\t-R\tChanges files and directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000177#define chgrp_example_usage \
178 "$ ls -l /tmp/foo\n" \
179 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
180 "$ chgrp root /tmp/foo\n" \
181 "$ ls -l /tmp/foo\n" \
182 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000183
Eric Andersen7e9276b2001-02-22 01:15:47 +0000184#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000185 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000186#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000187 "Each MODE is one or more of the letters ugoa, one of the\n" \
188 "symbols +-= and one or more of the letters rwxst.\n\n" \
189 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000190 "\t-R\tChanges files and directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000191#define chmod_example_usage \
192 "$ ls -l /tmp/foo\n" \
193 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
194 "$ chmod u+x /tmp/foo\n" \
195 "$ ls -l /tmp/foo\n" \
196 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
197 "$ chmod 444 /tmp/foo\n" \
198 "$ ls -l /tmp/foo\n" \
199 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000200
Eric Andersen7e9276b2001-02-22 01:15:47 +0000201#define chown_trivial_usage \
Eric Andersen238da242001-05-11 16:31:46 +0000202 "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000203#define chown_full_usage \
204 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000205 "\nOptions:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000206 "\t-R\tChanges files and directories recursively\n" \
207 "\t-h\tDo not dereference symbolic links"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000208#define chown_example_usage \
209 "$ ls -l /tmp/foo\n" \
210 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
211 "$ chown root /tmp/foo\n" \
212 "$ ls -l /tmp/foo\n" \
213 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
214 "$ chown root.root /tmp/foo\n" \
215 "ls -l /tmp/foo\n" \
216 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000217
Eric Andersen7e9276b2001-02-22 01:15:47 +0000218#define chroot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000219 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000220#define chroot_full_usage \
221 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000222#define chroot_example_usage \
223 "$ ls -l /bin/ls\n" \
224 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000225 "# mount /dev/hdc1 /mnt -t minix\n" \
226 "# chroot /mnt\n" \
227 "# ls -l /bin/ls\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000228 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000229
Eric Andersen7e9276b2001-02-22 01:15:47 +0000230#define chvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000231 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000232#define chvt_full_usage \
233 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000234
Rob Landley856489b2006-04-18 20:57:28 +0000235#define cksum_trivial_usage \
236 "FILES..."
237#define cksum_full_usage \
238 "Calculates the CRC32 checksums of FILES."
239
Eric Andersen7e9276b2001-02-22 01:15:47 +0000240#define clear_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000241 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000242#define clear_full_usage \
243 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000244
Eric Andersen7e9276b2001-02-22 01:15:47 +0000245#define cmp_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000246 "[-l] [-s] FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000247#define cmp_full_usage \
Mike Frysinger4d149202005-05-12 22:36:07 +0000248 "Compares FILE1 vs stdin if FILE2 is not specified.\n\n" \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000249 "Options:\n" \
250 "\t-l\tWrite the byte numbers (decimal) and values (octal)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000251 "\t\t for all differing bytes\n" \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000252 "\t-s\tquiet mode - do not print"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000253
Rob Landley2acfd7b2005-05-11 23:12:49 +0000254#define comm_trivial_usage \
255 "[-123] FILE1 FILE2"
256#define comm_full_usage \
Mike Frysinger4d149202005-05-12 22:36:07 +0000257 "Compares FILE1 to FILE2, or to stdin if = is specified.\n\n" \
Rob Landley2acfd7b2005-05-11 23:12:49 +0000258 "Options:\n" \
259 "\t-1\tSuppress lines unique to FILE1\n" \
260 "\t-2\tSuppress lines unique to FILE2\n" \
261 "\t-3\tSuppress lines common to both files"
262
Paul Fox79c142d2005-08-01 16:04:40 +0000263#define bbconfig_trivial_usage \
264 ""
265#define bbconfig_full_usage \
Mike Frysingerbf28ed82006-02-21 04:32:03 +0000266 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000267
Rob Landley69674942006-09-11 00:34:01 +0000268#define bbsh_trivial_usage \
269 "[FILE]...\n" \
270 "or: bbsh -c command [args]..."
271#define bbsh_full_usage \
272 "The bbsh shell (command interpreter)"
273
Eric Andersen7e9276b2001-02-22 01:15:47 +0000274#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000275 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000276#define cp_full_usage \
277 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
278 "\n" \
279 "\t-a\tSame as -dpR\n" \
Mike Frysinger6077d902005-01-07 00:56:47 +0000280 "\t-d,-P\tPreserves links\n" \
Mike Frysinger2ed05ab2005-04-14 02:52:50 +0000281 "\t-H,-L\tDereference all symlinks (implied by default)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000282 "\t-p\tPreserves file attributes if possible\n" \
283 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersenced97052004-02-20 09:55:37 +0000284 "\t-i\tinteractive, prompt before overwrite\n" \
285 "\t-R,-r\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000286
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000287#define cpio_trivial_usage \
288 "-[dimtuv][F cpiofile]"
289#define cpio_full_usage \
290 "Extract or list files from a cpio archive\n" \
291 "Main operation mode:\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000292 "\td\t\tmake leading directories\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000293 "\ti\t\textract\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000294 "\tm\t\tpreserve mtime\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000295 "\tt\t\tlist\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000296 "\tv\t\tverbose\n" \
Eric Andersen6925d502001-12-16 09:23:09 +0000297 "\tu\t\tunconditional overwrite\n" \
298 "\tF\t\tinput from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000299
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000300#define crond_trivial_usage \
301 "-d[#] -c <crondir> -f -b"
302#define crond_full_usage \
303 "\t-d [#] -l [#] -S -L logfile -f -b -c dir\n" \
304 "\t-d num\tdebug level\n" \
305 "\t-l num\tlog level (8 - default)\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +0000306 "\t-S\tlog to syslogd (default)\n" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000307 "\t-L file\tlog to file\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +0000308 "\t-f\trun in foreground\n" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000309 "\t-b\trun in background (default)\n" \
310 "\t-c dir\tworking dir"
311
312#define crontab_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000313 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000314#define crontab_full_usage \
315 "\tfile <opts> replace crontab from file\n" \
316 "\t- <opts> replace crontab from stdin\n" \
317 "\t-u user specify user\n" \
318 "\t-l [user] list crontab for user\n" \
319 "\t-e [user] edit crontab for user\n" \
320 "\t-d [user] delete crontab for user\n" \
321 "\t-c dir specify crontab directory"
322
323
Eric Andersen7e9276b2001-02-22 01:15:47 +0000324#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000325 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000326#define cut_full_usage \
327 "Prints selected fields from each input FILE to standard output.\n\n" \
328 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000329 "\t-b LIST\t\tOutput only bytes from LIST\n" \
330 "\t-c LIST\t\tOutput only characters from LIST\n" \
331 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
332 "\t-s\t\tOutput only the lines containing delimiter\n" \
333 "\t-f N\t\tPrint only these fields\n" \
334 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000335#define cut_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +0000336 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000337 "Hello\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000338 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000339 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000340
Eric Andersen7e9276b2001-02-22 01:15:47 +0000341#define date_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +0000342 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000343#define date_full_usage \
344 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000345 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000346 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000347 "\t-d STRING\tDisplays time described by STRING, not `now'\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000348USE_FEATURE_DATE_ISOFMT( \
349 "\t-I[TIMESPEC]\tOutputs an ISO-8601 compliant date/time string\n" \
350 "\t\t\tTIMESPEC=`date' (or missing) for date only,\n" \
351 "\t\t\t`hours', `minutes', or `seconds' for date and,\n" \
352 "\t\t\ttime to the indicated precision\n" \
353 "\t-D hint\t\tUse 'hint' as date format, via strptime()\n" \
354) \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000355 "\t-s\t\tSets time described by STRING\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000356 "\t-r FILE\t\tDisplays the last modification time of FILE\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000357 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000358#define date_example_usage \
359 "$ date\n" \
360 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000361
Eric Andersen7e9276b2001-02-22 01:15:47 +0000362#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000363 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000364#define dc_full_usage \
365 "This is a Tiny RPN calculator that understands the\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000366 "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \
Eric Andersena9287742003-10-22 11:24:39 +0000367 "**, exp, and, or, not, eor.\n" \
368 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16.\n" \
369 "\nOptions:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000370 "p - Prints the value on the top of the stack, without altering the stack\n" \
371 "f - Prints the entire contents of the stack without altering anything\n" \
372 "o - Pops the value off the top of the stack and uses it to set the output radix\n" \
373 " Only 10 and 16 are supported"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000374#define dc_example_usage \
Eric Andersen9ab46572004-08-18 17:57:16 +0000375 "$ dc 2 2 + p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000376 "4\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000377 "$ dc 8 8 \\* 2 2 + / p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000378 "16\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000379 "$ dc 0 1 and p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000380 "0\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000381 "$ dc 0 1 or p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000382 "1\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000383 "$ echo 72 9 div 8 mul p | dc\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000384 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000385
Eric Andersen7e9276b2001-02-22 01:15:47 +0000386#define dd_trivial_usage \
Rob Landley2686d3b2006-05-16 16:52:12 +0000387 "[if=FILE] [of=FILE] " USE_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
388 "\t [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync]")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000389#define dd_full_usage \
390 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000391 "\tif=FILE\t\tread from FILE instead of stdin\n" \
392 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
393 "\tbs=N\t\tread and write N bytes at a time\n" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000394 USE_FEATURE_DD_IBS_OBS("\tibs=N\t\tread N bytes at a time\n") \
395 USE_FEATURE_DD_IBS_OBS("\tobs=N\t\twrite N bytes at a time\n") \
Eric Andersena0cfe942001-02-23 10:07:09 +0000396 "\tcount=N\t\tcopy only N input blocks\n" \
397 "\tskip=N\t\tskip N input blocks\n" \
398 "\tseek=N\t\tskip N output blocks\n" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000399 USE_FEATURE_DD_IBS_OBS( \
400 "\tconv=notrunc\tdon't truncate output file\n" \
401 "\tconv=noerror\tcontinue after read errors\n" \
402 "\tconv=sync\tpad blocks with zeros\n" \
403 ) \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000404 "\n" \
405 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000406 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000407#define dd_example_usage \
408 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
409 "4+0 records in\n" \
410 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000411
Eric Andersen7e9276b2001-02-22 01:15:47 +0000412#define deallocvt_trivial_usage \
Glenn L McGrath17b4a202004-01-15 11:50:19 +0000413 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000414#define deallocvt_full_usage \
415 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000416
Eric Andersenf349e972001-08-21 16:18:59 +0000417#define delgroup_trivial_usage \
418 "GROUP"
419#define delgroup_full_usage \
420 "Deletes group GROUP from the system"
421
422#define deluser_trivial_usage \
423 "USER"
424#define deluser_full_usage \
425 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000426
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000427#define devfsd_trivial_usage \
Mike Frysingerb8d00462005-08-17 01:20:10 +0000428 "mntpnt [-v]" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000429 USE_DEVFSD_FG_NP("[-fg][-np]" )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000430#define devfsd_full_usage \
Mike Frysingerb8d00462005-08-17 01:20:10 +0000431 "Optional daemon for managing devfs permissions and old device name symlinks.\n" \
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000432 "\nOptions:\n" \
433 "\tmntpnt\tThe mount point where devfs is mounted.\n\n" \
434 "\t-v\tPrint the protocol version numbers for devfsd\n" \
Eric Andersenf18bd892003-12-19 11:07:59 +0000435 "\t\tand the kernel-side protocol version and exits." \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000436 USE_DEVFSD_FG_NP( "\n\n\t-fg\tRun the daemon in the foreground.\n\n" \
Eric Andersenf18bd892003-12-19 11:07:59 +0000437 "\t-np\tExit after parsing the configuration file\n" \
438 "\t\tand processing synthetic REGISTER events.\n" \
439 "\t\tDo not poll for events.")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000440
Eric Andersen7e9276b2001-02-22 01:15:47 +0000441#define df_trivial_usage \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000442 "[-" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000443#define df_full_usage \
444 "Print the filesystem space used and space available.\n\n" \
445 "Options:\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000446 USE_FEATURE_HUMAN_READABLE( \
447 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
448 "\t-m\tprint sizes in megabytes\n" \
449 "\t-k\tprint sizes in kilobytes(default)" \
450 ) \
451 SKIP_FEATURE_HUMAN_READABLE("\n\t-k\tignored")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000452#define df_example_usage \
453 "$ df\n" \
454 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
455 "/dev/sda3 8690864 8553540 137324 98% /\n" \
456 "/dev/sda1 64216 36364 27852 57% /boot\n" \
457 "$ df /dev/sda3\n" \
458 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
459 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000460
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000461#define diff_trivial_usage \
Bernhard Reutner-Fischerbc142142006-04-06 16:07:08 +0000462 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000463#define diff_full_usage \
464 "Compare files line by line and output the differences between them.\n" \
465 "This diff implementation only supports unified diffs.\n\n" \
466 "Options:\n" \
467 "\t-a\tTreat all files as text\n" \
468 "\t-b\tIgnore changes in the amount of whitespace\n" \
469 "\t-d\tTry hard to find a smaller set of changes\n" \
470 "\t-i\tIgnore case differences\n" \
Bernhard Reutner-Fischerbc142142006-04-06 16:07:08 +0000471 "\t-L\tUse LABEL instead of the filename in the unified header\n" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000472 "\t-N\tTreat absent files as empty\n" \
473 "\t-q\tOutput only whether files differ\n" \
474 "\t-r\tRecursively compare any subdirectories\n" \
475 "\t-S\tStart with FILE when comparing directories\n" \
476 "\t-T\tMake tabs line up by prefixing a tab when necessary\n" \
477 "\t-s\tReport when two files are the same\n" \
478 "\t-t\tExpand tabs to spaces in output\n" \
479 "\t-U\tOutput LINES lines of context\n" \
480 "\t-w\tIgnore all whitespace\n"
481
Eric Andersen7e9276b2001-02-22 01:15:47 +0000482#define dirname_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000483 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000484#define dirname_full_usage \
485 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000486#define dirname_example_usage \
487 "$ dirname /tmp/foo\n" \
488 "/tmp\n" \
489 "$ dirname /tmp/foo/\n" \
490 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000491
Eric Andersen7e9276b2001-02-22 01:15:47 +0000492#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000493 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000494#define dmesg_full_usage \
495 "Prints or controls the kernel ring buffer\n\n" \
496 "Options:\n" \
497 "\t-c\t\tClears the ring buffer's contents after printing\n" \
498 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000499 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000500
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000501#define dnsd_trivial_usage \
Denis Vlasenko9213a9e2006-09-17 16:28:10 +0000502 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000503#define dnsd_full_usage \
Denis Vlasenko9213a9e2006-09-17 16:28:10 +0000504 "Small and static DNS server daemon\n\n" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000505 "Options:\n" \
506 "\t-c\t\tconfig filename\n" \
507 "\t-t\t\tTTL in seconds\n" \
508 "\t-p\t\tlistening port\n" \
509 "\t-i\t\tlistening iface ip (default all)\n" \
510 "\t-d\t\tdaemonize"
511
Eric Andersen7e9276b2001-02-22 01:15:47 +0000512#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000513 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000514#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000515 "Converts FILE from dos format to unix format. When no option\n" \
516 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000517 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000518 "Options:\n" \
519 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000520 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000521
Eric Andersen7e9276b2001-02-22 01:15:47 +0000522#define dpkg_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000523 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000524#define dpkg_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000525 "dpkg is a utility to install, remove and manage Debian packages.\n\n" \
526 "Options:\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000527 "\t-i\t\tInstall the package\n" \
528 "\t-l\t\tList of installed packages\n" \
529 "\t-C\t\tConfigure an unpackaged package\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +0000530 "\t-F depends\tIgnore dependency problems\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000531 "\t-P\t\tPurge all files of a package\n" \
532 "\t-r\t\tRemove all but the configuration files for a package\n" \
533 "\t-u\t\tUnpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000534
Eric Andersen7e9276b2001-02-22 01:15:47 +0000535#define dpkg_deb_trivial_usage \
Glenn L McGrathcbc453c2004-05-02 03:01:08 +0000536 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000537#define dpkg_deb_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000538 "Perform actions on Debian packages (.debs)\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000539 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000540 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000541 "\t-e\tExtract control files to [argument] directory\n" \
542 "\t-f\tDisplay control field name starting with [argument]\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000543 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000544 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000545#define dpkg_deb_example_usage \
546 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000547
Eric Andersen7e9276b2001-02-22 01:15:47 +0000548#define du_trivial_usage \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000549 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000550#define du_full_usage \
551 "Summarizes disk space used for each FILE and/or directory.\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000552 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000553 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
554 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000555 " bytes.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000556 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000557 "\t-a\tshow sizes of files in addition to directories\n" \
558 "\t-H\tfollow symbolic links that are FILE command line args\n" \
559 "\t-L\tfollow all symbolic links encountered\n" \
560 "\t-d N\tlimit output to directories (and files with -a) of depth < N\n" \
561 "\t-c\toutput a grand total\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000562 "\t-l\tcount sizes many times if hard linked\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000563 "\t-s\tdisplay only a total for each argument\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000564 "\t-x\tskip directories on different filesystems\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000565 USE_FEATURE_HUMAN_READABLE( \
566 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
567 "\t-m\tprint sizes in megabytes\n" \
568 ) \
569 "\t-k\tprint sizes in kilobytes" \
570 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000571#define du_example_usage \
572 "$ du\n" \
573 "16 ./CVS\n" \
574 "12 ./kernel-patches/CVS\n" \
575 "80 ./kernel-patches\n" \
576 "12 ./tests/CVS\n" \
577 "36 ./tests\n" \
578 "12 ./scripts/CVS\n" \
579 "16 ./scripts\n" \
580 "12 ./docs/CVS\n" \
581 "104 ./docs\n" \
582 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000583
Eric Andersen7e9276b2001-02-22 01:15:47 +0000584#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000585 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000586#define dumpkmap_full_usage \
587 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000588#define dumpkmap_example_usage \
589 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000590
Russ Dill61fb4892002-10-14 21:41:28 +0000591#define dumpleases_trivial_usage \
592 "[-r|-a] [-f LEASEFILE]"
593#define dumpleases_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000594 "Displays the DHCP leases granted by udhcpd.\n\n" \
595 "Options:\n" \
Russ Dill61fb4892002-10-14 21:41:28 +0000596 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +0000597 "\t-r,\t--remaining\tInterpret lease times as time remaining\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +0000598 "\t-a,\t--absolute\tInterpret lease times as expire time"
Russ Dill61fb4892002-10-14 21:41:28 +0000599
Mike Frysinger51a43b42005-09-24 07:11:16 +0000600#define e2fsck_trivial_usage \
601 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
602 "[-I inode_buffer_blocks] [-P process_inode_size] " \
Mike Frysinger874af852006-03-08 07:03:27 +0000603 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
Mike Frysinger51a43b42005-09-24 07:11:16 +0000604 "[-E extended-options] device"
605#define e2fsck_full_usage \
606 "Check a Linux ext2/ext3 file system.\n\n" \
607 "Options:\n" \
608 "\t-p\tAutomatic repair (no questions)\n" \
609 "\t-n\tMake no changes to the filesystem\n" \
610 "\t-y\tAssume 'yes' to all questions\n" \
611 "\t-c\tCheck for bad blocks and add them to the badblock list\n" \
612 "\t-f\tForce checking even if filesystem is marked clean\n" \
613 "\t-v\tBe verbose\n" \
614 "\t-b superblock\tUse alternative superblock\n" \
615 "\t-B blocksize\tForce blocksize when looking for superblock\n" \
616 "\t-j journal\tSet location of the external journal\n" \
617 "\t-l file\tAdd to badblocks list\n" \
618 "\t-L file\tSet badblocks list"
619
Eric Andersen7e9276b2001-02-22 01:15:47 +0000620#define echo_trivial_usage \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000621 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000622#define echo_full_usage \
623 "Prints the specified ARGs to stdout\n\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000624 USE_FEATURE_FANCY_ECHO( \
625 "Options:\n" \
626 "\t-n\tsuppress trailing newline\n" \
627 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
628 "\t-E\tdisable interpretation of backslash-escaped characters" \
629 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000630#define echo_example_usage \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000631 "$ echo \"Erik is cool\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000632 "Erik is cool\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000633 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000634 "Erik\n" \
635 "is\n" \
636 "cool\n" \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000637 "$ echo \"Erik\\nis\\ncool\"\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000638 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000639
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000640#define eject_trivial_usage \
641 "[-t] [DEVICE]"
642#define eject_full_usage \
643 "Eject specified DEVICE (or default /dev/cdrom).\n\n" \
644 "Options:\n" \
Rob Landley9ea88362005-05-14 00:46:18 +0000645 "\t-t\tclose tray"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000646
Rob Landley3b890392006-05-04 20:56:43 +0000647#define ed_trivial_usage ""
648#define ed_full_usage ""
649
Eric Andersen84e229c2001-03-29 22:48:33 +0000650#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000651 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000652#define env_full_usage \
653 "Prints the current environment or runs a program after setting\n" \
654 "up the specified environment.\n\n" \
655 "Options:\n" \
656 "\t-, -i\tstart with an empty environment\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000657 "\t-u\tremove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000658
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000659#define ether_wake_trivial_usage \
660 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
661#define ether_wake_full_usage \
662 "Send a magic packet to wake up sleeping machines.\n" \
663 "MAC must be a station address (00:11:22:33:44:55) or\n" \
664 " a hostname with a known 'ethers' entry.\n\n" \
665 "Options:\n" \
666 "\t-b\t\tSend wake-up packet to the broadcast address\n" \
667 "\t-i iface\tUse interface ifname instead of the default \"eth0\"\n" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +0000668 "\t-p pass\tAppend the four or six byte password PW to the packet"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000669
Eric Andersen7e9276b2001-02-22 01:15:47 +0000670#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000671 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000672#define expr_full_usage \
673 "Prints the value of EXPRESSION to standard output.\n\n" \
674 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000675 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
676 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
677 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
678 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
679 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
680 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
681 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
682 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
683 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
684 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
685 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
686 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
687 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000688 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
689 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
690 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
691 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
692 "\t or 0\n" \
693 "\tlength STRING length of STRING\n" \
694 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
695 "\t it is a keyword like `match' or an\n" \
696 "\t operator like `/'\n" \
697 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000698 "Beware that many operators need to be escaped or quoted for shells.\n" \
699 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
700 "lexicographical. Pattern matches return the string matched between \n" \
701 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
702 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000703
Mike Frysingerfa69f112005-04-17 07:24:19 +0000704#define fakeidentd_trivial_usage \
705 "[-b ip] [STRING]"
706#define fakeidentd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +0000707 "Returns a set string to auth requests\n\n" \
708 "\t-b\tBind to ip address\n" \
Mike Frysingerfa69f112005-04-17 07:24:19 +0000709 "\tSTRING\tThe ident answer string (default is nobody)"
710
Eric Andersen7e9276b2001-02-22 01:15:47 +0000711#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000712 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000713#define false_full_usage \
714 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000715#define false_example_usage \
716 "$ false\n" \
717 "$ echo $?\n" \
718 "1\n"
719
720#define fbset_trivial_usage \
721 "[options] [mode]"
722#define fbset_full_usage \
723 "Show and modify frame buffer settings"
724#define fbset_example_usage \
725 "$ fbset\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000726 "mode \"1024x768-76\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000727 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
728 "\tgeometry 1024 768 1024 768 16\n" \
729 "\ttimings 12714 128 32 16 4 128 4\n" \
730 "\taccel false\n" \
731 "\trgba 5/11,6/5,5/0,0/0\n" \
732 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000733
Eric Andersen7e9276b2001-02-22 01:15:47 +0000734#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000735 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000736#define fdflush_full_usage \
737 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000738
Eric Andersen01c3d402003-07-05 07:51:31 +0000739#define fdformat_trivial_usage \
740 "[-n] DEVICE"
741#define fdformat_full_usage \
742 "Low-level formats a floppy disk\n\n" \
743 "Options:\n" \
744 "\t-n\tDon't verify after format"
745
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000746#define fdisk_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000747 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000748#define fdisk_full_usage \
749 "Change partition table\n" \
750 "Options:\n" \
Eric Andersena151d192004-04-06 17:16:36 +0000751 "\t-l List partition table(s)\n" \
752 "\t-u Give Start and End in sector (instead of cylinder) units\n" \
753 "\t-s PARTITION Give partition size(s) in blocks\n" \
754 "\t-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000755 "\t-C CYLINDERS Set the number of cylinders\n" \
756 "\t-H HEADS Set the number of heads\n" \
757 "\t-S SECTORS Set the number of sectors\n" \
Eric Andersena151d192004-04-06 17:16:36 +0000758 "\t-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000759
Eric Andersen7e9276b2001-02-22 01:15:47 +0000760#define find_trivial_usage \
761 "[PATH...] [EXPRESSION]"
762#define find_full_usage \
763 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000764 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000765 "\nEXPRESSION may consist of:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000766 "\t-follow\t\tDereference symbolic links\n" \
767 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN\n" \
768 "\t-print\t\tPrint (default and assumed)\n" \
Paul Foxd7384292006-05-12 14:47:20 +0000769 USE_FEATURE_FIND_PRINT0( \
770 "\t-print0\t\tDelimit output with null characters rather than\n\t\t\tnewlines" \
771) USE_FEATURE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000772 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000773) USE_FEATURE_FIND_PERM( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000774 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000775) USE_FEATURE_FIND_MTIME( \
Paul Fox72d1a232006-01-13 21:05:41 +0000776 "\n\t-mtime DAYS\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000777) USE_FEATURE_FIND_MMIN( \
Paul Fox72d1a232006-01-13 21:05:41 +0000778 "\n\t-mmin MINS\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) minutes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000779) USE_FEATURE_FIND_NEWER( \
Eric Andersen97d86f22003-01-23 05:27:42 +0000780 "\n\t-newer FILE\tModified time is more recent than FILE's" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000781) USE_FEATURE_FIND_INUM( \
Rob Landley5d3a0e82005-10-04 03:34:39 +0000782 "\n\t-inum N\t\tFile has inode number N" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000783) USE_FEATURE_FIND_EXEC( \
Rob Landley5d3a0e82005-10-04 03:34:39 +0000784 "\n\t-exec CMD\tExecute CMD with all instances of {} replaced by the" \
785 "\n\t\t\tfiles matching EXPRESSION")
786
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000787#define find_example_usage \
Eric Andersen75eb90f2004-03-29 08:20:08 +0000788 "$ find / -name passwd\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000789 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000790
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000791#define fold_trivial_usage \
Glenn L McGrath0bd02572005-12-11 03:09:05 +0000792 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000793#define fold_full_usage \
794 "Wrap input lines in each FILE (standard input by default), writing to\n" \
795 "standard output.\n\n" \
796 "Options:\n" \
797 "\t-b\tcount bytes rather than columns\n" \
798 "\t-s\tbreak at spaces\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000799 "\t-w\tuse WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000800
Eric Andersen7e9276b2001-02-22 01:15:47 +0000801#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000802 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000803#define free_full_usage \
804 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000805#define free_example_usage \
806 "$ free\n" \
807 " total used free shared buffers\n" \
808 " Mem: 257628 248724 8904 59644 93124\n" \
809 " Swap: 128516 8404 120112\n" \
810 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000811
Eric Andersen7e9276b2001-02-22 01:15:47 +0000812#define freeramdisk_trivial_usage \
813 "DEVICE"
814#define freeramdisk_full_usage \
815 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000816#define freeramdisk_example_usage \
817 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000818
Mike Frysinger51a43b42005-09-24 07:11:16 +0000819#define fsck_trivial_usage \
820 "[-ANPRTV] [ -C [ fd ] ] [-t fstype] [fs-options] [filesys ...]"
821#define fsck_full_usage \
822 "Check and repair filesystems.\n\n" \
823 "Options:\n" \
824 "\t-A\tWalk /etc/fstab and check all filesystems\n" \
825 "\t-N\tDon't execute, just show what would be done\n" \
826 "\t-P\tWhen using -A, check filesystems in parallel\n" \
827 "\t-R\tWhen using -A, skip the root filesystem\n" \
828 "\t-T\tDon't show title on startup\n" \
829 "\t-V\tVerbose mode\n" \
830 "\t-C\tWrite status information to specified filedescriptor\n" \
831 "\t-t\tList of filesystem types to check"
832
Eric Andersen7e9276b2001-02-22 01:15:47 +0000833#define fsck_minix_trivial_usage \
834 "[-larvsmf] /dev/name"
835#define fsck_minix_full_usage \
836 "Performs a consistency check for MINIX filesystems.\n\n" \
837 "Options:\n" \
838 "\t-l\tLists all filenames\n" \
839 "\t-r\tPerform interactive repairs\n" \
840 "\t-a\tPerform automatic repairs\n" \
841 "\t-v\tverbose\n" \
842 "\t-s\tOutputs super-block information\n" \
843 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000844 "\t-f\tForce file system check"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000845
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000846#define ftpget_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000847 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000848#define ftpget_full_usage \
849 "Retrieve a remote file via FTP.\n\n" \
850 "Options:\n" \
851 "\t-c, --continue Continue a previous transfer\n" \
852 "\t-v, --verbose Verbose\n" \
853 "\t-u, --username Username to be used\n" \
854 "\t-p, --password Password to be used\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000855 "\t-P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000856
857#define ftpput_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000858 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000859#define ftpput_full_usage \
860 "Store a local file on a remote machine via FTP.\n\n" \
861 "Options:\n" \
862 "\t-v, --verbose Verbose\n" \
863 "\t-u, --username Username to be used\n" \
864 "\t-p, --password Password to be used\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000865 "\t-P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000866
Rob Landleyaa872762005-10-28 13:05:12 +0000867#define fuser_trivial_usage \
868 "[options] file OR port/proto"
869#define fuser_full_usage \
870 "Options:\n" \
871 "\t-m Show all processes on the same mounted fs\n" \
872 "\t-k Kill all processes that match.\n" \
873 "\t-s Don't print or kill anything.\n" \
874 "\t-4 When using port/proto only search IPv4 space\n" \
875 "\t-6 When using port/proto only search IPv6 space\n" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +0000876 "\t-SIGNAL When used with -k, this signal will be used to kill"
877
Eric Andersen7e9276b2001-02-22 01:15:47 +0000878#define getopt_trivial_usage \
879 "[OPTIONS]..."
880#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000881 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000882 "\t-a, --alternative Allow long options starting with single -\n" \
883 "\t-l, --longoptions=longopts Long options to be recognized\n" \
884 "\t-n, --name=progname The name under which errors are reported\n" \
885 "\t-o, --options=optstring Short options to be recognized\n" \
886 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
887 "\t-Q, --quiet-output No normal output\n" \
888 "\t-s, --shell=shell Set shell quoting conventions\n" \
889 "\t-T, --test Test for getopt(1) version\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000890 "\t-u, --unquoted Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000891#define getopt_example_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000892 "$ cat getopt.test\n" \
893 "#!/bin/sh\n" \
894 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
895 " -n 'example.busybox' -- \"$@\"`\n" \
896 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000897 "eval set -- \"$GETOPT\"\n" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000898 "while true ; do\n" \
899 " case $1 in\n" \
900 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
901 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
902 " -c|--c-long)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000903 " case \"$2\" in\n" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000904 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
905 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
906 " esac ;;\n" \
907 " --) shift ; break ;;\n" \
908 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
909 " esac\n" \
910 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000911
Eric Andersenf349e972001-08-21 16:18:59 +0000912#define getty_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000913 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +0000914#define getty_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +0000915 "Opens a tty, prompts for a login name, then invokes /bin/login\n\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000916 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000917 "\t-h\t\tEnable hardware (RTS/CTS) flow control\n" \
918 "\t-i\t\tDo not display /etc/issue before running login\n" \
919 "\t-L\t\tLocal line, so do not do carrier detect\n" \
920 "\t-m\t\tGet baud rate from modem's CONNECT status message\n" \
921 "\t-w\t\tWait for a CR or LF before sending /etc/issue\n" \
922 "\t-n\t\tDo not prompt the user for a login name\n" \
923 "\t-f issue_file\tDisplay issue_file instead of /etc/issue\n" \
924 "\t-l login_app\tInvoke login_app instead of /bin/login\n" \
925 "\t-t timeout\tTerminate after timeout if no username is read\n" \
926 "\t-I initstring\tSets the init string to send before anything else\n" \
927 "\t-H login_host\tLog login_host into the utmp file as the hostname"
Eric Andersenf349e972001-08-21 16:18:59 +0000928
Eric Andersen7e9276b2001-02-22 01:15:47 +0000929#define grep_trivial_usage \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000930 "[-ihHnqvs" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000931 USE_FEATURE_GREP_EGREP_ALIAS("E") \
932 USE_FEATURE_GREP_CONTEXT("ABC") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000933 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000934#define grep_full_usage \
935 "Search for PATTERN in each FILE or standard input.\n\n" \
936 "Options:\n" \
937 "\t-H\tprefix output lines with filename where match was found\n" \
938 "\t-h\tsuppress the prefixing filename on output\n" \
939 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000940 "\t-l\tlist names of files that match\n" \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000941 "\t-L\tlist names of files that do not match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000942 "\t-n\tprint line number with output lines\n" \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000943 "\t-q\tbe quiet. Returns 0 if PATTERN was found, 1 otherwise\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000944 "\t-v\tselect non-matching lines\n" \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000945 "\t-s\tsuppress file open/read error messages\n" \
946 "\t-c\tonly print count of matching lines\n" \
947 "\t-f\tread PATTERN from file\n" \
948 "\t-e\tPATTERN is a regular expression\n" \
949 "\t-F\tPATTERN is a set of newline-separated strings" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000950 USE_FEATURE_GREP_EGREP_ALIAS("\n\t-E\tPATTERN is an extended regular expression") \
951 USE_FEATURE_GREP_CONTEXT("\n\t-A\tprint NUM lines of trailing context") \
952 USE_FEATURE_GREP_CONTEXT("\n\t-B\tprint NUM lines of leading context") \
953 USE_FEATURE_GREP_CONTEXT("\n\t-C\tprint NUM lines of output context")
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000954
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000955#define grep_example_usage \
956 "$ grep root /etc/passwd\n" \
957 "root:x:0:0:root:/root:/bin/bash\n" \
958 "$ grep ^[rR]oo. /etc/passwd\n" \
959 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000960
Eric Andersen7e9276b2001-02-22 01:15:47 +0000961#define gunzip_trivial_usage \
962 "[OPTION]... FILE"
963#define gunzip_full_usage \
964 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
965 "Options:\n" \
966 "\t-c\tWrite output to standard output\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000967 "\t-f\tForce read when source is a terminal\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000968 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000969#define gunzip_example_usage \
970 "$ ls -la /tmp/BusyBox*\n" \
971 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
972 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
973 "$ ls -la /tmp/BusyBox*\n" \
974 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000975
976#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000977 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000978#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000979 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000980 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000981 "Options:\n" \
982 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000983 "\t-d\tDecompress\n" \
984 "\t-f\tForce write when destination is a terminal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000985#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000986 "$ ls -la /tmp/busybox*\n" \
987 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
988 "$ gzip /tmp/busybox.tar\n" \
989 "$ ls -la /tmp/busybox*\n" \
990 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000991
992#define halt_trivial_usage \
Rob Landley64612912006-01-30 08:31:37 +0000993 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000994#define halt_full_usage \
Glenn L McGrathd2501672004-07-23 05:16:17 +0000995 "Halt the system.\n" \
996 "Options:\n" \
Rob Landley64612912006-01-30 08:31:37 +0000997 "\t-d\t\tdelay interval for halting\n" \
998 "\t-n\t\tno call to sync()\n" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +0000999 "\t-f\t\tforce halt (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001000
Eric Andersen3443bd72003-07-22 07:30:36 +00001001#define hdparm_trivial_usage \
1002 "[options] [device] .."
1003#define hdparm_full_usage \
Rob Landley6d8ce172006-06-07 21:22:42 +00001004 USE_FEATURE_HDPARM_GET_IDENTITY("\tIf no device name is specified try to read from stdin.\n") \
Rob Landley06208412006-05-31 22:52:57 +00001005 "\nOptions:\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001006 "\t-a get/set fs readahead\n" \
1007 "\t-A set drive read-lookahead flag (0/1)\n" \
1008 "\t-b get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
1009 "\t-B set Advanced Power Management setting (1-255)\n" \
1010 "\t-c get/set IDE 32-bit IO setting\n" \
1011 "\t-C check IDE power mode status\n" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001012 USE_FEATURE_HDPARM_HDIO_GETSET_DMA("\t-d get/set using_dma flag\n") \
Eric Andersen15c03c32004-04-06 17:52:02 +00001013 "\t-D enable/disable drive defect-mgmt\n" \
1014 "\t-f flush buffer cache for device on exit\n" \
1015 "\t-g display drive geometry\n" \
1016 "\t-h display terse usage information\n" \
Rob Landley06208412006-05-31 22:52:57 +00001017 USE_FEATURE_HDPARM_GET_IDENTITY("\t-i display drive identification\n") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001018 USE_FEATURE_HDPARM_GET_IDENTITY("\t-I detailed/current information directly from drive\n") \
Eric Andersen15c03c32004-04-06 17:52:02 +00001019 "\t-k get/set keep_settings_over_reset flag (0/1)\n" \
1020 "\t-K set drive keep_features_over_reset flag (0/1)\n" \
1021 "\t-L set drive doorlock (0/1) (removable harddisks only)\n" \
1022 "\t-m get/set multiple sector count\n" \
1023 "\t-n get/set ignore-write-errors flag (0/1)\n" \
1024 "\t-p set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
1025 "\t-P set drive prefetch count\n" \
1026 "\t-q change next setting quietly\n" \
1027 "\t-Q get/set DMA tagged-queuing depth (if supported)\n" \
1028 "\t-r get/set readonly flag (DANGEROUS to set)\n" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001029 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF("\t-R register an IDE interface (DANGEROUS)\n") \
Eric Andersen15c03c32004-04-06 17:52:02 +00001030 "\t-S set standby (spindown) timeout\n" \
1031 "\t-t perform device read timings\n" \
1032 "\t-T perform cache read timings\n" \
1033 "\t-u get/set unmaskirq flag (0/1)\n" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001034 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF("\t-U un-register an IDE interface (DANGEROUS)\n") \
Eric Andersen15c03c32004-04-06 17:52:02 +00001035 "\t-v defaults; same as -mcudkrag for IDE drives\n" \
1036 "\t-V display program version and exit immediately\n" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001037 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET("\t-w perform device reset (DANGEROUS)\n") \
Eric Andersen15c03c32004-04-06 17:52:02 +00001038 "\t-W set drive write-caching flag (0/1) (DANGEROUS)\n" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001039 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF("\t-x tristate device for hotswap (0/1) (DANGEROUS)\n") \
Eric Andersen15c03c32004-04-06 17:52:02 +00001040 "\t-X set IDE xfer mode (DANGEROUS)\n" \
1041 "\t-y put IDE drive in standby mode\n" \
1042 "\t-Y put IDE drive to sleep\n" \
1043 "\t-Z disable Seagate auto-powersaving mode\n" \
1044 "\t-z re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +00001045
Eric Andersen7e9276b2001-02-22 01:15:47 +00001046#define head_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +00001047 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001048#define head_full_usage \
1049 "Print first 10 lines of each FILE to standard output.\n" \
1050 "With more than one FILE, precede each with a header giving the\n" \
1051 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001052 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001053 "\t-n NUM\t\tPrint first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001054 USE_FEATURE_FANCY_HEAD( \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001055 "\n\t-c NUM\t\toutput the first NUM bytes\n" \
1056 "\t-q\t\tnever output headers giving file names\n" \
1057 "\t-v\t\talways output headers giving file names" )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001058#define head_example_usage \
1059 "$ head -n 2 /etc/passwd\n" \
1060 "root:x:0:0:root:/root:/bin/bash\n" \
1061 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001062
Glenn L McGrath60281112001-11-02 11:39:46 +00001063#define hexdump_trivial_usage \
Paul Fox969af892005-11-28 21:06:00 +00001064 "[-[bcCdefnosvx]] [OPTION] FILE"
Glenn L McGrath60281112001-11-02 11:39:46 +00001065#define hexdump_full_usage \
1066 "The hexdump utility is a filter which displays the specified files,\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001067 "or the standard input, if no files are specified, in a user specified\n" \
Glenn L McGrath60281112001-11-02 11:39:46 +00001068 "format\n" \
1069 "\t-b\t\tOne-byte octal display\n" \
1070 "\t-c\t\tOne-byte character display\n" \
Paul Fox969af892005-11-28 21:06:00 +00001071 "\t-C\t\tCanonical hex+ASCII, 16 bytes per line\n" \
Glenn L McGrath60281112001-11-02 11:39:46 +00001072 "\t-d\t\tTwo-byte decimal display\n" \
1073 "\t-e FORMAT STRING\n" \
1074 "\t-f FORMAT FILE\n" \
1075 "\t-n LENGTH\tInterpret only length bytes of input\n" \
1076 "\t-o\t\tTwo-byte octal display\n" \
1077 "\t-s OFFSET\tSkip offset byte\n" \
1078 "\t-v\t\tdisplay all input data\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001079 "\t-x\t\tTwo-byte hexadecimal display"
Glenn L McGrath60281112001-11-02 11:39:46 +00001080
Eric Andersen7e9276b2001-02-22 01:15:47 +00001081#define hostid_trivial_usage \
1082 ""
1083#define hostid_full_usage \
1084 "Print out a unique 32-bit identifier for the machine."
1085
1086#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001087 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001088#define hostname_full_usage \
1089 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001090 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001091 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +00001092 "\t-s\tShort\n" \
1093 "\t-i\tAddresses for the hostname\n" \
1094 "\t-d\tDNS domain name\n" \
1095 "\t-f\tFully qualified domain name\n" \
1096 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001097#define hostname_example_usage \
1098 "$ hostname\n" \
Eric Andersen08f59e32004-03-12 22:07:10 +00001099 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001100
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001101#define httpd_trivial_usage \
Eric Andersen40520512003-07-28 09:59:05 +00001102 "[-c <conf file>]" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001103 USE_FEATURE_HTTPD_WITHOUT_INETD(" [-p <port>]") \
1104 USE_FEATURE_HTTPD_SETUID(" [-u user]") \
1105 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
1106 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Eric Andersen73afd892004-04-14 17:59:21 +00001107 " [-h home]" \
Eric Andersen40520512003-07-28 09:59:05 +00001108 " [-d/-e <string>]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001109#define httpd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001110 "Listens for incoming http server requests.\n\n" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001111 "Options:\n" \
1112 "\t-c FILE\t\tSpecifies configuration file. (default httpd.conf)\n" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001113 USE_FEATURE_HTTPD_WITHOUT_INETD("\t-p PORT\tServer port (default 80)\n") \
1114 USE_FEATURE_HTTPD_SETUID("\t-u USER\tSet uid to USER after listening privileges port\n") \
1115 USE_FEATURE_HTTPD_BASIC_AUTH("\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
1116 USE_FEATURE_HTTPD_AUTH_MD5("\t-m PASS\t\tCrypt PASS with md5 algorithm\n") \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001117 "\t-h HOME \tSpecifies http HOME directory (default ./)\n" \
1118 "\t-e STRING\tHtml encode STRING\n" \
1119 "\t-d STRING\tURL decode STRING"
Eric Andersen40520512003-07-28 09:59:05 +00001120
Robert Griebl1cd04452002-07-21 16:50:49 +00001121#define hwclock_trivial_usage \
1122 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
1123#define hwclock_full_usage \
1124 "Query and set the hardware clock (RTC)\n\n" \
1125 "Options:\n" \
1126 "\t-r\tread hardware clock and print result\n" \
1127 "\t-s\tset the system time from the hardware clock\n" \
1128 "\t-w\tset the hardware clock to the current system time\n" \
1129 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
1130 "\t-l\tthe hardware clock is kept in local time"
1131
Eric Andersen9e480452003-07-03 10:07:04 +00001132#ifdef CONFIG_SELINUX
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001133# define USAGE_SELINUX(a) a
Eric Andersen9e480452003-07-03 10:07:04 +00001134#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001135# define USAGE_SELINUX(a)
Eric Andersen9e480452003-07-03 10:07:04 +00001136#endif
1137
Eric Andersen7e9276b2001-02-22 01:15:47 +00001138#define id_trivial_usage \
1139 "[OPTIONS]... [USERNAME]"
1140#define id_full_usage \
1141 "Print information for USERNAME or the current user\n\n" \
1142 "Options:\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001143 USAGE_SELINUX("\t-c\tprints only the security context\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001144 "\t-g\tprints only the group ID\n" \
1145 "\t-u\tprints only the user ID\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001146 "\t-n\tprint a name instead of a number\n" \
1147 "\t-r\tprints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001148#define id_example_usage \
1149 "$ id\n" \
1150 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001151
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001152#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001153# define USAGE_SIOCSKEEPALIVE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001154#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001155# define USAGE_SIOCSKEEPALIVE(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001156#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001157#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001158# define USAGE_IFCONFIG_MII(a) a
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001159#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001160# define USAGE_IFCONFIG_MII(a)
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001161#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001162#ifdef CONFIG_FEATURE_IFCONFIG_HW
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001163# define USAGE_IFCONFIG_HW(a) a
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001164#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001165# define USAGE_IFCONFIG_HW(a)
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001166#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001167#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001168# define USAGE_IFCONFIG_OPT_A(a) a
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001169#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001170# define USAGE_IFCONFIG_OPT_A(a)
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001171#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +00001172#ifdef CONFIG_FEATURE_IPV6
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001173# define USAGE_IPV6(a) a
Eric Andersen51b8bd62002-07-03 11:46:38 +00001174#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001175# define USAGE_IPV6(a)
Eric Andersen51b8bd62002-07-03 11:46:38 +00001176#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001177
Eric Andersen7e9276b2001-02-22 01:15:47 +00001178#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001179 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001180#define ifconfig_full_usage \
1181 "configure a network interface\n\n" \
1182 "Options:\n" \
Mike Frysingercf89c372006-05-19 16:14:31 +00001183 USAGE_IPV6("\t[add <address>[/<prefixlen>]]\n") \
1184 USAGE_IPV6("\t[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001185 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001186 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001187 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001188 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001189 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001190 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001191 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
1192 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001193 "\t[up|down] ..."
1194
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001195#define ifup_trivial_usage \
1196 "<-ahinv> <ifaces...>"
1197#define ifup_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001198 "ifup <options> <ifaces...>\n\n" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001199 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001200 "\t-h\tthis help\n" \
1201 "\t-a\tde/configure all interfaces automatically\n" \
1202 "\t-i FILE\tuse FILE for interface definitions\n" \
1203 "\t-n\tprint out what would happen, but don't do it\n" \
1204 "\t\t\t(note that this option doesn't disable mappings)\n" \
1205 "\t-v\tprint out what would happen before doing it\n" \
1206 "\t-m\tdon't run any mappings\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001207 "\t-f\tforce de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001208
1209#define ifdown_trivial_usage \
1210 "<-ahinv> <ifaces...>"
1211#define ifdown_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001212 "ifdown <options> <ifaces...>\n\n" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001213 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001214 "\t-h\tthis help\n" \
1215 "\t-a\tde/configure all interfaces automatically\n" \
1216 "\t-i FILE\tuse FILE for interface definitions\n" \
1217 "\t-n\tprint out what would happen, but don't do it\n" \
1218 "\t\t(note that this option doesn't disable mappings)\n" \
1219 "\t-v\tprint out what would happen before doing it\n" \
1220 "\t-m\tdon't run any mappings\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001221 "\t-f\tforce de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001222
Glenn L McGrath06e95652003-02-09 06:51:14 +00001223#define inetd_trivial_usage \
Paul Foxb8317532005-08-01 19:39:47 +00001224 "[-f] [-q len] [conf]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001225#define inetd_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001226 "Listens for network connections and launches programs\n\n" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001227 "Option:\n" \
Paul Foxb8317532005-08-01 19:39:47 +00001228 "\t-f\tRun as a foreground progress\n" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001229 "\t-q\tSets the size of the socket listen queue to\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001230 "\t\tthe specified value. Default is 128"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001231
Eric Andersen7e9276b2001-02-22 01:15:47 +00001232#define init_trivial_usage \
1233 ""
1234#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001235 "Init is the parent of all processes."
1236#define init_notes_usage \
1237"This version of init is designed to be run only by the kernel.\n" \
1238"\n" \
1239"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
1240"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
1241"runlevels, use sysvinit.\n" \
1242"\n" \
1243"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
1244"it has the following default behavior:\n" \
1245"\n" \
1246" ::sysinit:/etc/init.d/rcS\n" \
1247" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001248" ::ctrlaltdel:/sbin/reboot\n" \
1249" ::shutdown:/sbin/swapoff -a\n" \
1250" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001251" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001252"\n" \
1253"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1254"\n" \
1255" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001256" tty3::askfirst:/bin/sh\n" \
1257" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001258"\n" \
1259"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1260"\n" \
1261" <id>:<runlevels>:<action>:<process>\n" \
1262"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001263" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001264"\n" \
1265" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1266" The id field is used by BusyBox init to specify the controlling tty for\n" \
1267" the specified process to run on. The contents of this field are\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001268" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001269" be unique, although if it isn't you may have strange results. If this\n" \
1270" field is left blank, the controlling tty is set to the console. Also\n" \
1271" note that if BusyBox detects that a serial console is in use, then only\n" \
1272" entries whose controlling tty is either the serial console or /dev/null\n" \
1273" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1274" stinkin' utmp.\n" \
1275"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001276" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001277"\n" \
1278" The runlevels field is completely ignored.\n" \
1279"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001280" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001281"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001282" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001283" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001284"\n" \
1285" The available actions can be classified into two groups: actions\n" \
1286" that are run only once, and actions that are re-run when the specified\n" \
1287" process exits.\n" \
1288"\n" \
1289" Run only-once actions:\n" \
1290"\n" \
1291" 'sysinit' is the first item run on boot. init waits until all\n" \
1292" sysinit actions are completed before continuing. Following the\n" \
1293" completion of all sysinit actions, all 'wait' actions are run.\n" \
1294" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001295" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001296" therefore, init does not wait for them to complete. 'restart' is\n" \
1297" the action taken to restart the init process. By default this should\n" \
1298" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1299" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001300" actions are run when the system detects that someone on the system\n" \
1301" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1302" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1303" Finally the 'shutdown' action specifies the actions to taken when\n" \
1304" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1305" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001306"\n" \
1307" Run repeatedly actions:\n" \
1308"\n" \
1309" 'respawn' actions are run after the 'once' actions. When a process\n" \
1310" started with a 'respawn' action exits, init automatically restarts\n" \
1311" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1312" respawning out of control. The 'askfirst' actions acts just like\n" \
1313" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001314" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001315" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001316" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001317"\n" \
1318" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1319" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001320" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001321"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001322" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001323"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001324" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001325"\n" \
1326"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001327"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001328" # This is run first except when booting in single-user mode.\n" \
1329" #\n" \
1330" ::sysinit:/etc/init.d/rcS\n" \
1331" \n" \
1332" # /bin/sh invocations on selected ttys\n" \
1333" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001334" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001335" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001336" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001337" tty2::askfirst:-/bin/sh\n" \
1338" tty3::askfirst:-/bin/sh\n" \
1339" tty4::askfirst:-/bin/sh\n" \
1340" \n" \
1341" # /sbin/getty invocations for selected ttys\n" \
1342" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001343" tty4::respawn:/sbin/getty 38400 tty4\n" \
1344" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001345" \n" \
1346" \n" \
1347" # Example of how to put a getty on a serial line (for a terminal)\n" \
1348" #\n" \
1349" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1350" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1351" #\n" \
1352" # Example how to put a getty on a modem line.\n" \
1353" #::respawn:/sbin/getty 57600 ttyS2\n" \
1354" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001355" # Stuff to do when restarting the init process\n" \
1356" ::restart:/sbin/init\n" \
1357" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001358" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001359" ::ctrlaltdel:/sbin/reboot\n" \
1360" ::shutdown:/bin/umount -a -r\n" \
1361" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001362
Eric Andersenbe65c352003-01-23 04:57:35 +00001363#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001364# define USAGE_INSMOD_MAP(a) a
Eric Andersenbe65c352003-01-23 04:57:35 +00001365#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001366# define USAGE_INSMOD_MAP(a)
Eric Andersenbe65c352003-01-23 04:57:35 +00001367#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001368#define insmod_trivial_usage \
1369 "[OPTION]... MODULE [symbol=value]..."
1370#define insmod_full_usage \
1371 "Loads the specified kernel modules into the kernel.\n\n" \
1372 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001373 "\t-f\tForce module to load into the wrong kernel version\n" \
1374 "\t-k\tMake module autoclean-able\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001375 "\t-v\tverbose output\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001376 "\t-q\tquiet output\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001377 "\t-L\tLock to prevent simultaneous loads of a module\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001378 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout\n") \
Eric Andersen957879a2004-04-07 15:07:55 +00001379 "\t-o NAME\tSet internal module name to NAME\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001380 "\t-x\tdo not export externs"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001381
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001382#define install_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001383 "[-cgmops] [sources] <dest|directory>"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001384#define install_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001385 "Copies files and set attributes\n\n" \
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001386 "Options:\n" \
1387 "\t-c\tcopy the file, default\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001388 "\t-d\tcreate directories\n" \
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001389 "\t-g\tset group ownership\n" \
1390 "\t-m\tset permission modes\n" \
1391 "\t-o\tset ownership\n" \
1392 "\t-p\tpreserve date\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001393 "\t-s\tstrip symbol tables"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001394
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001395#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001396 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001397#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001398 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1399 "where OBJECT := { link | addr | route | tunnel }\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001400 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001401
1402#define ipaddr_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001403 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
1404 "\t\t[ dev STRING ] [ to PREFIX ] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001405#define ipaddr_full_usage \
Rob Landleydaa4a6d2006-03-30 01:59:30 +00001406 "ipaddr {add|delete} IFADDR dev STRING\n" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001407 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001408 "\t\t\t[ to PREFIX ] [ label PATTERN ]\n" \
1409 "\t\t\tIFADDR := PREFIX | ADDR peer PREFIX\n" \
1410 "\t\t\t[ broadcast ADDR ] [ anycast ADDR ]\n" \
1411 "\t\t\t[ label STRING ] [ scope SCOPE-ID ]\n" \
1412 "\t\t\tSCOPE-ID := [ host | link | global | NUMBER ]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001413
Eric Andersen3561b012004-04-13 19:27:20 +00001414#ifdef CONFIG_FEATURE_IPCALC_FANCY
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001415# define XUSAGE_IPCALC_FANCY(a) a
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001416#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001417# define XUSAGE_IPCALC_FANCY(a)
Eric Andersen3561b012004-04-13 19:27:20 +00001418#endif
Eric Andersende4f07e2003-12-11 01:18:07 +00001419#define ipcalc_trivial_usage \
Eric Andersen3561b012004-04-13 19:27:20 +00001420 "[OPTION]... <ADDRESS>[[/]<NETMASK>] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001421#define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001422 "Calculate IP network settings from a IP address\n\n" \
1423 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001424 "\t-b\t--broadcast\tDisplay calculated broadcast address\n" \
1425 "\t-n\t--network\tDisplay calculated network address\n" \
Mike Frysinger036f2992005-09-24 23:50:14 +00001426 "\t-m\t--netmask\tDisplay default netmask for IP" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001427 XUSAGE_IPCALC_FANCY( \
Mike Frysinger036f2992005-09-24 23:50:14 +00001428 "\n\t-p\t--prefix\tDisplay the prefix for IP/NETMASK\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001429 "\t-h\t--hostname\tDisplay first resolved host name\n" \
Mike Frysinger036f2992005-09-24 23:50:14 +00001430 "\t-s\t--silent\tDon't ever display error messages")
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001431
Rob Landley6eb1e412005-06-20 04:30:36 +00001432#define ipcrm_trivial_usage \
1433 "[-[MQS] key] [-[mqs] id]"
1434#define ipcrm_full_usage \
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001435 "The upper-case options MQS are used to remove a shared memory segment by a\n" \
1436 "segment by a shmkey value. The lower-case options mqs are used\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001437 "to remove a segment by shmid value.\n" \
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001438 "\t-[mM]\tRemove the memory segment after the last detach\n" \
1439 "\t-[qQ]\tRemove the message queue\n" \
1440 "\t-[sS]\tRemove the semaphore"
Rob Landley6eb1e412005-06-20 04:30:36 +00001441
1442#define ipcs_trivial_usage \
Bernhard Reutner-Fischerd1f939e2006-09-20 15:56:53 +00001443 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001444#define ipcs_full_usage \
1445 "\t-i\tspecify a specific resource id\n" \
1446 "Resource specification:\n" \
1447 "\t-m\tshared memory segments\n" \
1448 "\t-q\tmessage queues\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00001449 "\t-s\tsemaphore arrays\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001450 "\t-a\tall (default)\n" \
1451 "Output format:\n" \
1452 "\t-t\ttime\n" \
Bernhard Reutner-Fischerd1f939e2006-09-20 15:56:53 +00001453 "\t-c\tcreator\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001454 "\t-p\tpid\n" \
Bernhard Reutner-Fischerd1f939e2006-09-20 15:56:53 +00001455 "\t-l\tlimits\n" \
1456 "\t-u\tsummary"
Rob Landley6eb1e412005-06-20 04:30:36 +00001457
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001458#define iplink_trivial_usage \
1459 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1460#define iplink_full_usage \
1461 "iplink set DEVICE { up | down | arp { on | off } |\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001462 "\t\t\tdynamic { on | off } |\n" \
1463 "\t\t\tmtu MTU }\n" \
1464 "\tiplink show [ DEVICE ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001465
1466#define iproute_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001467 "{ list | flush | { add | del | change | append |\n" \
1468 "\t\treplace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001469#define iproute_full_usage \
1470 "iproute { list | flush } SELECTOR\n" \
1471 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001472 "\t\t\t[ oif STRING ] [ tos TOS ]\n" \
1473 "\tiproute { add | del | change | append | replace | monitor } ROUTE\n" \
1474 "\t\t\tSELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1475 "\t\t\tROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001476
1477#define iptunnel_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001478 "{ add | change | del | show } [ NAME ]\n" \
1479 "\t\t[ mode { ipip | gre | sit } ]\n" \
1480 "\t\t[ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001481#define iptunnel_full_usage \
1482 "iptunnel { add | change | del | show } [ NAME ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001483 "\t\t\t[ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1484 "\t\t\t[ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1485 "\t\t\t[ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001486
Eric Andersen7e9276b2001-02-22 01:15:47 +00001487#define kill_trivial_usage \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001488 "[-l] [-signal] process-id [process-id ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001489#define kill_full_usage \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001490 "Send a signal (default is TERM) to the specified process(es).\n\n" \
David Kimdon56082dc2001-02-23 06:03:22 +00001491 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001492 "\t-l\tList all signal names and numbers"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001493#define kill_example_usage \
1494 "$ ps | grep apache\n" \
1495 "252 root root S [apache]\n" \
1496 "263 www-data www-data S [apache]\n" \
1497 "264 www-data www-data S [apache]\n" \
1498 "265 www-data www-data S [apache]\n" \
1499 "266 www-data www-data S [apache]\n" \
1500 "267 www-data www-data S [apache]\n" \
1501 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001502
1503#define killall_trivial_usage \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001504 "[-l] [-q] [-signal] process-name [process-name ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001505#define killall_full_usage \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001506 "Send a signal (default is TERM) to the specified process(es).\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001507 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001508 "\t-l\tList all signal names and numbers\n" \
1509 "\t-q\tDo not complain if no processes were killed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001510#define killall_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001511 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001512
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001513#define killall5_trivial_usage \
1514 "[-l] [-signal]"
1515#define killall5_full_usage \
1516 "Send a signal (default is TERM) to all processes outside current session.\n\n" \
1517 "Options:\n" \
1518 "\t-l\tList all signal names and numbers\n" \
1519
Mark Whitley6317c4b2001-03-12 22:51:50 +00001520#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001521 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001522#define klogd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001523 "Kernel logger.\n" \
1524 "Options:\n" \
1525 "\t-c n\tSets the default log level of console messages to n\n" \
1526 "\t-n\tRun as a foreground process"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001527
Eric Andersen7e9276b2001-02-22 01:15:47 +00001528#define length_trivial_usage \
1529 "STRING"
1530#define length_full_usage \
1531 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001532#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001533 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001534 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001535
Rob Landley9200e792005-09-15 19:26:59 +00001536#define less_trivial_usage \
1537 "[-EMNmh~?] FILE1 FILE2..."
1538#define less_full_usage \
1539 "View a file or list of files. The position within files can be\n" \
1540 "changed, and files can be manipulated in various ways with the\n" \
1541 "following options:\n\n" \
1542 "\t-E\tQuit once the end of a file is reached\n" \
1543 "\t-M\tDisplay a status line containing the current line numbers\n" \
1544 "\t\tand the percentage through the file\n" \
1545 "\t-N\tPrefix line numbers to each line\n" \
1546 "\t-m\tDisplay a status line containing the percentage through the\n" \
1547 "\t\tfile\n" \
1548 "\t-~\tSuppress ~s displayed when input past the end of the file is\n" \
1549 "\t\treached.\n" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001550 "\t-h, -?\tDisplay this help message"
Rob Landley9200e792005-09-15 19:26:59 +00001551
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001552#define setarch_trivial_usage \
1553 "<personality> <program> [args ...]"
1554#define setarch_full_usage \
1555 "Personality may be:\n" \
1556 "\tlinux32\tSet 32bit uname emulation\n" \
1557 "\tlinux64\tSet 64bit uname emulation"
1558
Eric Andersen7e9276b2001-02-22 01:15:47 +00001559#define ln_trivial_usage \
1560 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1561#define ln_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001562 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001563 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1564 "Options:\n" \
1565 "\t-s\tmake symbolic links instead of hard links\n" \
1566 "\t-f\tremove existing destination files\n" \
Rob Landley55b1efc2005-04-29 22:14:28 +00001567 "\t-n\tno dereference symlinks - treat like normal file\n" \
1568 "\t-b\tmake a backup of the target (if exists) before link operation\n" \
1569 "\t-S suffix\tuse suffix instead of ~ when making backup files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001570#define ln_example_usage \
1571 "$ ln -s BusyBox /tmp/ls\n" \
1572 "$ ls -l /tmp/ls\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001573 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001574
Eric Andersen7e9276b2001-02-22 01:15:47 +00001575#define loadfont_trivial_usage \
1576 "< font"
1577#define loadfont_full_usage \
1578 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001579#define loadfont_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001580 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001581
1582#define loadkmap_trivial_usage \
1583 "< keymap"
1584#define loadkmap_full_usage \
1585 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001586#define loadkmap_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001587 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001588
1589#define logger_trivial_usage \
1590 "[OPTION]... [MESSAGE]"
1591#define logger_full_usage \
1592 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1593 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001594 "\t-s\tLog to stderr as well as the system log\n" \
1595 "\t-t TAG\tLog using the specified tag (defaults to user name)\n" \
1596 "\t-p PRIORITY\tEnter the message with the specified priority\n" \
1597 "\t\tThis may be numerical or a ``facility.level'' pair"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001598#define logger_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001599 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001600
Robert Griebl1fca5582002-06-04 20:45:46 +00001601#define login_trivial_usage \
1602 "[OPTION]... [username] [ENV=VAR ...]"
1603#define login_full_usage \
1604 "Begin a new session on the system\n\n" \
1605 "Options:\n" \
1606 "\t-f\tDo not authenticate (user already authenticated)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001607 "\t-h\tName of the remote host for this login\n" \
1608 "\t-p\tPreserve environment"
Robert Griebl1fca5582002-06-04 20:45:46 +00001609
Eric Andersen7e9276b2001-02-22 01:15:47 +00001610#define logname_trivial_usage \
1611 ""
1612#define logname_full_usage \
1613 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001614#define logname_example_usage \
1615 "$ logname\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001616 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001617
Mark Whitley6317c4b2001-03-12 22:51:50 +00001618#define logread_trivial_usage \
Eric Andersend4a5e252003-12-19 11:32:14 +00001619 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001620#define logread_full_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001621 "Shows the messages from syslogd (using circular buffer).\n\n" \
Eric Andersend4a5e252003-12-19 11:32:14 +00001622 "Options:\n" \
1623 "\t-f\t\toutput data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001624
Matt Kraai83788da2002-03-20 17:38:37 +00001625#define losetup_trivial_usage \
Denis Vlasenko956a5692006-09-27 14:51:27 +00001626 "[-o OFFSET] [-d] LOOPDEVICE [FILE]]"
Matt Kraai83788da2002-03-20 17:38:37 +00001627#define losetup_full_usage \
Denis Vlasenko956a5692006-09-27 14:51:27 +00001628 "(Dis)associate LOOPDEVICE with FILE, or display current associations.\n\n" \
Matt Kraai83788da2002-03-20 17:38:37 +00001629 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001630 "\t-d\t\tDisassociate LOOPDEVICE\n" \
1631 "\t-o OFFSET\tStart OFFSET bytes into FILE"
Rob Landley1d589b22005-11-29 23:47:10 +00001632#define losetup_notes_usage \
Denis Vlasenko956a5692006-09-27 14:51:27 +00001633 "No arguments will display all current associations.\n" \
Rob Landley1d589b22005-11-29 23:47:10 +00001634 "One argument (losetup /dev/loop1) will display the current association\n" \
1635 "(if any), or disassociate it (with -d). The display shows the offset\n" \
1636 "and filename of the file the loop device is currently bound to.\n\n" \
1637 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
1638 "with an optional offset (-o 12345). Encryption is not yet supported.\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00001639
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001640#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001641# define USAGE_LS_TIMESTAMPS(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001642#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001643# define USAGE_LS_TIMESTAMPS(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001644#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001645#ifdef CONFIG_FEATURE_LS_FILETYPES
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001646# define USAGE_LS_FILETYPES(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001647#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001648# define USAGE_LS_FILETYPES(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001649#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001650#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001651# define USAGE_LS_FOLLOWLINKS(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001652#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001653# define USAGE_LS_FOLLOWLINKS(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001654#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001655#ifdef CONFIG_FEATURE_LS_RECURSIVE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001656# define USAGE_LS_RECURSIVE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001657#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001658# define USAGE_LS_RECURSIVE(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001659#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001660#ifdef CONFIG_FEATURE_LS_SORTFILES
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001661# define USAGE_LS_SORTFILES(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001662#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001663# define USAGE_LS_SORTFILES(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001664#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001665#ifdef CONFIG_FEATURE_AUTOWIDTH
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001666# define USAGE_AUTOWIDTH(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001667#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001668# define USAGE_AUTOWIDTH(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001669#endif
Paul Fox156dc412005-08-01 19:33:30 +00001670#ifdef CONFIG_FEATURE_LS_COLOR
1671 #define USAGE_LS_COLOR(a) a
1672#else
1673 #define USAGE_LS_COLOR(a)
1674#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00001675
Eric Andersen7e9276b2001-02-22 01:15:47 +00001676#define ls_trivial_usage \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001677 "[-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") USE_FEATURE_HUMAN_READABLE("h") "k" USAGE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001678#define ls_full_usage \
1679 "List directory contents\n\n" \
1680 "Options:\n" \
1681 "\t-1\tlist files in a single column\n" \
1682 "\t-A\tdo not list implied . and ..\n" \
1683 "\t-a\tdo not hide entries starting with .\n" \
1684 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001685 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Paul Fox156dc412005-08-01 19:33:30 +00001686 USAGE_LS_COLOR("\t--color[={always,never,auto}]\tto control coloring\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001687 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001688 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1689 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001690 "\t-i\tlist the i-node for each file\n" \
1691 "\t-l\tuse a long listing format\n" \
1692 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001693 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1694 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1695 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1696 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1697 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001698 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001699 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1700 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1701 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1702 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1703 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001704 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001705 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001706 USE_FEATURE_HUMAN_READABLE( \
Eric Andersen15c03c32004-04-06 17:52:02 +00001707 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n") \
1708 USAGE_SELINUX("\t-k\tprint security context\n") \
1709 USAGE_SELINUX("\t-K\tprint security context in long format\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001710
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001711#define lsattr_trivial_usage \
1712 "[-Radlv] [files...]"
1713#define lsattr_full_usage \
1714 "list file attributes on an ext2 fs\n\n" \
1715 "Options:\n" \
1716 "\t-R\trecursively list subdirectories\n" \
1717 "\t-a\tdo not hide entries starting with .\n" \
1718 "\t-d\tlist directory entries instead of contents\n" \
1719 "\t-l\tprint long flag names\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001720 "\t-v\tlist the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001721
Eric Andersen7e9276b2001-02-22 01:15:47 +00001722#define lsmod_trivial_usage \
1723 ""
1724#define lsmod_full_usage \
1725 "List the currently loaded kernel modules."
1726
Eric Andersen3d925622005-06-09 10:16:02 +00001727#ifdef CONFIG_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00001728#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001729 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001730#define makedevs_full_usage \
1731 "Creates a range of block or character special files\n\n" \
1732 "TYPEs include:\n" \
1733 "\tb:\tMake a block (buffered) device.\n" \
1734 "\tc or u:\tMake a character (un-buffered) device.\n" \
1735 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1736 "FIRST specifies the number appended to NAME to create the first device.\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001737 "LAST specifies the number of the last item that should be created\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001738 "If 's' is the last argument, the base device is created as well.\n\n" \
1739 "For example:\n" \
1740 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001741 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001742#define makedevs_example_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001743 "# makedevs /dev/ttyS c 4 66 2 63\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001744 "[creates ttyS2-ttyS63]\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001745 "# makedevs /dev/hda b 3 0 0 8 s\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001746 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001747#endif
1748
1749#ifdef CONFIG_FEATURE_MAKEDEVS_TABLE
1750#define makedevs_trivial_usage \
Eric Andersene8614db2005-07-18 09:28:36 +00001751 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00001752#define makedevs_full_usage \
Eric Andersene8614db2005-07-18 09:28:36 +00001753 "Creates a range of special files as specified in a device table.\n" \
1754 "Device table entries take the form of:\n" \
Eric Andersene8614db2005-07-18 09:28:36 +00001755 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
1756 "Where name is the file name, type can be one of:\n" \
1757 " f A regular file\n" \
1758 " d Directory\n" \
1759 " c Character special device file\n" \
1760 " b Block special device file\n" \
1761 " p Fifo (named pipe)\n" \
1762 "uid is the user id for the target file, gid is the group id for the\n" \
1763 "target file. The rest of the entries (major, minor, etc) apply to\n" \
Eric Andersen54e57da2005-07-18 09:42:37 +00001764 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00001765#define makedevs_example_usage \
1766 "For example:\n" \
1767 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
1768 "/dev d 755 0 0 - - - - -\n" \
1769 "/dev/console c 666 0 0 5 1 - - -\n" \
1770 "/dev/null c 666 0 0 1 3 0 0 -\n" \
1771 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
1772 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
1773 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
1774 "Will Produce:\n" \
1775 "/dev\n" \
1776 "/dev/console\n" \
1777 "/dev/null\n" \
1778 "/dev/zero\n" \
1779 "/dev/hda\n" \
Eric Andersen54e57da2005-07-18 09:42:37 +00001780 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001781#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001782
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001783#ifdef CONFIG_FEATURE_MD5_SHA1_SUM_CHECK
1784#define USAGE_MD5_SHA1_SUM_CHECK(a) a
1785#else
1786#define USAGE_MD5_SHA1_SUM_CHECK(a)
1787#endif
1788
Eric Andersen7e9276b2001-02-22 01:15:47 +00001789#define md5sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001790 "[OPTION] [FILEs...]" \
1791 USAGE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001792#define md5sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001793 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001794 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001795 "With no FILE, or when FILE is -, read standard input." \
1796 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
1797 "\t-c\tcheck MD5 sums against given list\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001798 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001799 "\t-s\tdon't output anything, status code shows success\n" \
"Robert P. J. Day"eea56182006-07-20 19:02:24 +00001800 "\t-w\twarn about improperly formatted MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001801#define md5sum_example_usage \
1802 "$ md5sum < busybox\n" \
1803 "6fd11e98b98a58f64ff3398d7b324003\n" \
1804 "$ md5sum busybox\n" \
1805 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1806 "$ md5sum -c -\n" \
1807 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1808 "busybox: OK\n" \
1809 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001810
Rob Landley70f7ef72005-12-13 08:21:33 +00001811#define mdev_trivial_usage \
1812 "[-s]"
1813#define mdev_full_usage \
Mike Frysinger35cf19d2006-02-02 22:52:59 +00001814 "\t-s\tScan /sys and populate /dev during system boot\n\n" \
Rob Landley70f7ef72005-12-13 08:21:33 +00001815 "Called with no options (via hotplug) it uses environment variables\n" \
1816 "to determine which device to add/remove."
Rob Landleyef10d522006-06-26 14:11:33 +00001817#define mdev_notes_usage "" \
1818USE_FEATURE_MDEV_CONFIG( \
Rob Landley70f7ef72005-12-13 08:21:33 +00001819 "The mdev config file contains lines that look like:\n" \
Tim Rikerc1ef7bd2006-01-25 00:08:53 +00001820 " hd[a-z][0-9]* 0:3 660\n\n" \
1821 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00001822 USE_FEATURE_MDEV_EXEC( \
1823 "Optionally, that can be followed (on the same line) by a special character\n" \
1824 "and a command line to run after creating/before deleting the corresponding\n" \
1825 "device(s). The environment variable $MDEV indicates the active device node\n" \
1826 "(which is useful if it's a regex match). For example:\n\n" \
1827 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
1828 "The special characters are @ (run after creating), $ (run before deleting),\n" \
1829 "and * (run both after creating and before deleting). The commands run in\n" \
1830 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
1831 ) \
Rob Landley70f7ef72005-12-13 08:21:33 +00001832 "Config file parsing stops on the first matching line. If no config\n"\
1833 "entry is matched, devices are created with default 0:0 660. (Make\n"\
Rob Landleyef10d522006-06-26 14:11:33 +00001834 "the last line match .* to override this.)\n\n" \
1835)
Rob Landley70f7ef72005-12-13 08:21:33 +00001836
Glenn L McGrath061c9002002-09-16 04:21:46 +00001837#define mesg_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001838 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001839#define mesg_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001840 "mesg controls write access to your terminal\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001841 "\ty\tAllow write access to your terminal\n" \
1842 "\tn\tDisallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001843
Eric Andersen7e9276b2001-02-22 01:15:47 +00001844#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001845 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001846#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001847 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001848 "Options:\n" \
1849 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001850 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001851#define mkdir_example_usage \
1852 "$ mkdir /tmp/foo\n" \
1853 "$ mkdir /tmp/foo\n" \
1854 "/tmp/foo: File exists\n" \
1855 "$ mkdir /tmp/foo/bar/baz\n" \
1856 "/tmp/foo/bar/baz: No such file or directory\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001857 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001858
Mike Frysinger6447ac02005-06-11 05:29:40 +00001859#define mke2fs_trivial_usage \
1860 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
1861 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
1862 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
1863 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
1864 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
1865 "device [blocks-count]"
1866#define mke2fs_full_usage \
1867 "\t-b size\tblock size in bytes\n" \
1868 "\t-c\tcheck for bad blocks before creating\n" \
1869 "\t-E opts\tset extended options\n" \
1870 "\t-f size\tfragment size in bytes\n" \
1871 "\t-F\tforce (ignore sanity checks)\n" \
1872 "\t-g num\tnumber of blocks in a block group\n" \
1873 "\t-i ratio\tthe bytes/inode ratio\n" \
1874 "\t-j\tcreate a journal (ext3)\n" \
1875 "\t-J opts\tset journal options (size/device)\n" \
1876 "\t-l file\tread bad blocks list from file\n" \
1877 "\t-L lbl\tset the volume label\n" \
1878 "\t-m percent\tpercent of fs blocks to reserve for admin\n" \
1879 "\t-M dir\tset last mounted directory\n" \
1880 "\t-n\tdo not actually create anything\n" \
1881 "\t-N num\tnumber of inodes to create\n" \
1882 "\t-o os\tset the 'creator os' field\n" \
1883 "\t-O features\tdir_index/filetype/has_journal/journal_dev/sparse_super\n" \
1884 "\t-q\tquiet execution\n" \
1885 "\t-r rev\tset filesystem revision\n" \
1886 "\t-S\twrite superblock and group descriptors only\n" \
1887 "\t-T fs-type\tset usage type (news/largefile/largefile4)\n" \
1888 "\t-v\tverbose execution"
1889
Eric Andersen7e9276b2001-02-22 01:15:47 +00001890#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001891 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001892#define mkfifo_full_usage \
1893 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1894 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001895 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001896
Eric Andersen7e9276b2001-02-22 01:15:47 +00001897#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001898 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001899#define mkfs_minix_full_usage \
1900 "Make a MINIX filesystem.\n\n" \
1901 "Options:\n" \
1902 "\t-c\t\tCheck the device for bad blocks\n" \
1903 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1904 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1905 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001906 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001907
Eric Andersen7e9276b2001-02-22 01:15:47 +00001908#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001909 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001910#define mknod_full_usage \
1911 "Create a special file (block, character, or pipe).\n\n" \
1912 "Options:\n" \
1913 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1914 "TYPEs include:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001915 "\tb:\tMake a block (buffered) device\n" \
1916 "\tc or u:\tMake a character (un-buffered) device\n" \
1917 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001918#define mknod_example_usage \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001919 "$ mknod /dev/fd0 b 2 0\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001920 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001921
Eric Andersen7e9276b2001-02-22 01:15:47 +00001922#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001923 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001924#define mkswap_full_usage \
1925 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001926 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001927 "\t-c\t\tCheck for read-ability\n" \
1928 "\t-v0\t\tMake version 0 swap [max 128 Megs]\n" \
1929 "\t-v1\t\tMake version 1 swap [big!] (default for kernels >\n\t\t\t2.1.117)\n" \
1930 "\tblock-count\tNumber of block to use (default is entire partition)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001931
Eric Andersen7e9276b2001-02-22 01:15:47 +00001932#define mktemp_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001933 "[-dq] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001934#define mktemp_full_usage \
1935 "Creates a temporary file with its name based on TEMPLATE.\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001936 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX).\n\n" \
1937 "Options:\n" \
1938 "\t-d\t\tMake a directory instead of a file\n" \
1939 "\t-q\t\tFail silently if an error occurs"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001940#define mktemp_example_usage \
1941 "$ mktemp /tmp/temp.XXXXXX\n" \
1942 "/tmp/temp.mWiLjM\n" \
1943 "$ ls -la /tmp/temp.mWiLjM\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001944 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001945
Eric Andersen8d79ce82001-07-22 23:00:15 +00001946#define modprobe_trivial_usage \
Rob Landley9c32a152005-12-11 20:12:24 +00001947 "[-knqrsv] MODULE [symbol=value ...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00001948#define modprobe_full_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001949 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001950 "\t-k\tMake module autoclean-able\n" \
1951 "\t-n\tJust show what would be done\n" \
1952 "\t-q\tQuiet output\n" \
1953 "\t-r\tRemove module (stacks) or do autoclean\n" \
1954 "\t-s\tReport via syslog instead of stderr\n" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001955 "\t-v\tVerbose output"
Rob Landley9c32a152005-12-11 20:12:24 +00001956#define modprobe_notes_usage \
1957"modprobe can (un)load a stack of modules, passing each module options (when\n" \
1958"loading). modprobe uses a configuration file to determine what option(s) to\n" \
1959"pass each module it loads.\n" \
1960"\n" \
1961"The configuration file is searched (in order) amongst:\n" \
1962"\n" \
1963" /etc/modprobe.conf (2.6 only)\n" \
1964" /etc/modules.conf\n" \
1965" /etc/conf.modules (deprecated)\n" \
1966"\n" \
1967"They all have the same syntax (see below). If none is present, it is\n" \
1968"_not_ an error; each loaded module is then expected to load without\n" \
1969"options. Once a file is found, the others are tested for.\n" \
1970"\n" \
1971"/etc/modules.conf entry format:\n" \
1972"\n" \
1973" alias <alias_name> <mod_name>\n" \
1974" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00001975" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00001976" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
1977" This makes it also possible to use a different set of options (below) for\n" \
1978" the module and the alias.\n" \
1979" A module can be aliased more than once.\n" \
1980"\n" \
1981" options <mod_name|alias_name> <symbol=value ...>\n" \
1982" When loading module mod_name (or the module aliased by alias_name), pass\n" \
1983" the \"symbol=value\" pairs as option to that module.\n" \
1984"\n" \
1985"Sample /etc/modules.conf file:\n" \
1986"\n" \
1987" options tulip irq=3\n" \
1988" alias tulip tulip2\n" \
1989" options tulip2 irq=4 io=0x308\n" \
1990"\n" \
1991"Other functionality offered by 'classic' modprobe is not available in\n" \
1992"this implementation.\n" \
1993"\n" \
1994"If module options are present both in the config file, and on the command line,\n" \
1995"then the options from the command line will be passed to the module _after_\n" \
1996"the options from the config file. That way, you can have defaults in the config\n" \
1997"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00001998#define modprobe_example_usage \
Rob Landley9c32a152005-12-11 20:12:24 +00001999 "(with the above /etc/modules.conf):\n\n" \
2000 "$ modprobe tulip\n" \
2001 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2002 "$ modprobe tulip irq=5\n" \
2003 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2004 "$ modprobe tulip2\n" \
2005 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2006 " which are the default for alias 'tulip2'\n\n" \
2007 "$ modprobe tulip2 irq=8\n" \
2008 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002009 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002010 " from the command line\n\n" \
2011 "$ modprobe tulip2 irq=2 io=0x210\n" \
2012 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002013 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002014 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002015
Eric Andersen7e9276b2001-02-22 01:15:47 +00002016#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002017 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002018#define more_full_usage \
2019 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002020#define more_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002021 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002022
Eric Andersen7e9276b2001-02-22 01:15:47 +00002023#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002024 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002025#define mount_full_usage \
Mike Frysinger29ed59e2006-01-04 00:04:08 +00002026 "Mount a filesystem. Filesystem autodetection requires /proc be mounted.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002027 "Flags:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002028 "\t-a:\t\tMount all filesystems in fstab\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002029 USE_FEATURE_MTAB_SUPPORT( \
2030 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it\n" \
2031 "\t-n:\t\tDon't write a mount table entry\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002032 ) \
Mike Frysinger058e7402005-04-23 07:00:33 +00002033 "\t-o option:\tOne of many filesystem options, listed below\n" \
2034 "\t-r:\t\tMount the filesystem read-only\n" \
2035 "\t-t fs-type:\tSpecify the filesystem type\n" \
2036 "\t-w:\t\tMount for reading and writing (default)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002037 "\n" \
2038 "Options for use with the \"-o\" flag:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002039 USE_FEATURE_MOUNT_LOOP( \
2040 "\tloop:\t\tIgnored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002041 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002042 USE_FEATURE_MOUNT_FLAGS( \
2043 "\t[a]sync:\tWrites are asynchronous / synchronous\n" \
2044 "\t[no]atime:\tDisable / enable updates to inode access times\n" \
2045 "\t[no]diratime:\tDisable / enable atime updates to directories\n" \
2046 "\t[no]dev:\tAllow use of special device files / disallow them\n" \
2047 "\t[no]exec:\tAllow use of executable files / disallow them\n" \
2048 "\t[no]suid:\tAllow set-user-id-root programs / disallow them\n" \
2049 "\t[r]shared:\tConvert [recursively] to a shared subtree.\n" \
2050 "\t[r]slave:\tConvert [recursively] to a slave subtree.\n" \
2051 "\t[r]private:\tConvert [recursively] to a private subtree\n" \
2052 "\t[un]bindable:\tMake mount point [un]able to be bind mounted.\n" \
2053 "\tbind:\t\tBind a directory to an additional location\n" \
2054 "\tmove:\t\tRelocate an existing mount point.\n" \
2055 ) \
Mike Frysinger058e7402005-04-23 07:00:33 +00002056 "\tremount:\tRe-mount a mounted filesystem, changing its flags\n" \
2057 "\tro/rw:\t\tMount for read-only / read-write\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002058 "\nThere are EVEN MORE flags that are specific to each filesystem\n" \
2059 "You'll have to see the written documentation for those filesystems"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002060#define mount_example_usage \
2061 "$ mount\n" \
2062 "/dev/hda3 on / type minix (rw)\n" \
2063 "proc on /proc type proc (rw)\n" \
2064 "devpts on /dev/pts type devpts (rw)\n" \
2065 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
Rob Landley1d589b22005-11-29 23:47:10 +00002066 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2067 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002068#define mount_notes_usage \
Denis Vlasenko9213a9e2006-09-17 16:28:10 +00002069 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002070
Rob Landleyd00b3a52005-08-20 05:07:08 +00002071#define mountpoint_trivial_usage \
2072 "[-q] <[-d] DIR | -x DEVICE>"
2073#define mountpoint_full_usage \
2074 "mountpoint checks if the directory is a mountpoint\n\n" \
2075 "Options:\n" \
2076 "\t-q:\t\tBe more quiet\n" \
2077 "\t-d:\t\tPrint major/minor device number of the filesystem\n" \
2078 "\t-x:\t\tPrint major/minor device number of the blockdevice"
2079#define mountpoint_example_usage \
2080 "$ mountpoint /proc\n" \
2081 "/proc is not a mountpoint\n" \
2082 "$ mountpoint /sys\n" \
2083 "/sys is a mountpoint\n"
2084
Eric Andersen7e9276b2001-02-22 01:15:47 +00002085#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002086 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002087#define mt_full_usage \
2088 "Control magnetic tape drive operation\n" \
2089 "\nAvailable Opcodes:\n\n" \
2090 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2091 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
Eric Andersen92fb9392003-08-08 20:09:03 +00002092 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002093 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002094
Eric Andersen7e9276b2001-02-22 01:15:47 +00002095#define mv_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002096 "[OPTION]... SOURCE DEST\n" \
2097 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002098#define mv_full_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002099 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY.\n\n" \
2100 "Options:\n" \
2101 "\t-f\tdon't prompt before overwriting\n" \
2102 "\t-i\tinteractive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002103#define mv_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002104 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002105
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002106#define nameif_trivial_usage \
Glenn L McGratha9adef02003-01-19 13:34:21 +00002107 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002108#define nameif_full_usage \
Denis Vlasenko3538b9a2006-09-06 18:36:50 +00002109 "Nameif renames network interface while it in the down state.\n\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002110 "Options:\n" \
2111 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002112 "\t-s\t\tUse syslog (LOCAL0 facility)\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002113 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002114#define nameif_example_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002115 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2116 " or\n" \
2117 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002118
Rob Landley1cca9482006-07-10 19:45:20 +00002119#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
2120#define NC_BR1 "["
2121#define NC_BR2 "]"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002122#else
Rob Landley1cca9482006-07-10 19:45:20 +00002123#define NC_BR1
2124#define NC_BR2
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002125#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002126
Eric Andersen7e9276b2001-02-22 01:15:47 +00002127#define nc_trivial_usage \
Rob Landley1cca9482006-07-10 19:45:20 +00002128 "[" \
2129 NC_BR1 USE_NC_SERVER("-lp")USE_NC_EXTRA("iwf") NC_BR2 \
2130 " ["USE_NC_EXTRA("FILENAME|")"{IPADDR PORTNUM}]"USE_NC_EXTRA(" [-e COMMAND]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002131#define nc_full_usage \
Rob Landley1cca9482006-07-10 19:45:20 +00002132 "Netcat opens a pipe, either to IP:port\n\n" \
2133 "Options:" \
2134 USE_NC_EXTRA( \
2135 "\n\t-e\t\texec rest of command line after connect\n" \
2136 "\t-i SECS\t\tdelay interval for lines sent\n" \
2137 "\t-w SECS\t\ttimeout for connect\n" \
2138 "\t-f filename\tuse file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002139 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002140 USE_NC_SERVER( \
2141 "\n\t-l\t\tlisten mode, for inbound connects\n" \
2142 USE_NC_EXTRA("\t\t\t(use -l twice with -e for persistent server)\n") \
2143 "\t-p PORT\t\tlocal port number" \
2144 )
2145
2146
2147#define nc_notes_usage "" \
2148 USE_NC_EXTRA( \
2149 "To use netcat as a terminal emulator on a serial port:\n\n" \
2150 "$ stty 115200 -F /dev/ttyS0\n" \
2151 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2152 ) ""
2153
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002154#define nc_example_usage \
2155 "$ nc foobar.somedomain.com 25\n" \
2156 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2157 "help\n" \
2158 "214-Commands supported:\n" \
2159 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2160 "214 NOOP QUIT RSET HELP\n" \
2161 "quit\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002162 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002163
Eric Andersen1552ff72001-10-31 11:07:12 +00002164#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00002165 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002166#define netstat_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00002167 "Netstat displays Linux networking information.\n\n" \
2168 "Options:\n" \
2169 "\t-l display listening server sockets\n" \
2170 "\t-a display all sockets (default: connected)\n" \
2171 "\t-e display other/more information\n" \
2172 "\t-n don't resolve names\n" \
2173 "\t-r display routing table\n" \
2174 "\t-t tcp sockets\n" \
2175 "\t-u udp sockets\n" \
2176 "\t-w raw sockets\n" \
2177 "\t-x unix sockets"
Eric Andersen1552ff72001-10-31 11:07:12 +00002178
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002179#define nice_trivial_usage \
2180 "[-n ADJUST] [COMMAND [ARG] ...]"
2181#define nice_full_usage \
2182 "Nice runs a program with modified scheduling priority.\n\n" \
2183 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002184 "\t-n ADJUST\tAdjust the scheduling priority by ADJUST"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002185
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002186#define nohup_trivial_usage \
2187 "COMMAND [ARGS]"
2188#define nohup_full_usage \
2189 "run a command immune to hangups, with output to a non-tty"
2190#define nohup_example_usage \
2191 "$ nohup make &"
2192
Eric Andersen7e9276b2001-02-22 01:15:47 +00002193#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00002194 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002195#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00002196 "Queries the nameserver for the IP address of the given HOST\n" \
2197 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002198#define nslookup_example_usage \
2199 "$ nslookup localhost\n" \
2200 "Server: default\n" \
2201 "Address: default\n" \
2202 "\n" \
2203 "Name: debian\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002204 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002205
Glenn L McGrath60281112001-11-02 11:39:46 +00002206#define od_trivial_usage \
2207 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
2208#define od_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002209 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Glenn L McGrath60281112001-11-02 11:39:46 +00002210 "to standard output. With no FILE, or when FILE is -, read standard input."
2211
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002212#define openvt_trivial_usage \
2213 "<vtnum> <COMMAND> [ARGS...]"
2214#define openvt_full_usage \
2215 "Start a command on a new virtual terminal"
2216#define openvt_example_usage \
2217 "openvt 2 /bin/ash\n"
2218
Eric Andersen27f64e12002-06-23 04:24:25 +00002219#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002220# define PASSWORD_ALG_TYPES(a) a
Tim Riker7b253f82003-12-28 05:02:40 +00002221#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002222# define PASSWORD_ALG_TYPES(a)
Eric Andersen27f64e12002-06-23 04:24:25 +00002223#endif
2224#define passwd_trivial_usage \
2225 "[OPTION] [name]"
2226#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00002227 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00002228 "changes the password for the current user.\n" \
2229 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002230 "\t-a\tDefine which algorithm shall be used for the password\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00002231 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00002232 PASSWORD_ALG_TYPES(", sha1") \
Mike Frysinger058e7402005-04-23 07:00:33 +00002233 ")\n\t-d\tDelete the password for the specified user account\n" \
2234 "\t-l\tLocks (disables) the specified user account\n" \
2235 "\t-u\tUnlocks (re-enables) the specified user account"
Eric Andersen27f64e12002-06-23 04:24:25 +00002236
Glenn L McGrath655d8142003-06-22 15:32:41 +00002237#define patch_trivial_usage \
Mike Frysingercc826d72006-06-28 00:22:32 +00002238 "[-p<num>] [-i <diff>]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002239#define patch_full_usage \
Mike Frysingercc826d72006-06-28 00:22:32 +00002240 "\t-p <num>\tStrip <num> leading components from file names\n" \
2241 "\t-i <diff>\tRead <diff> instead of stdin"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002242#define patch_example_usage \
Mike Frysingercc826d72006-06-28 00:22:32 +00002243 "$ patch -p1 < example.diff\n" \
Rob Landley078bacf2005-09-01 03:02:23 +00002244 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002245
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002246#if ENABLE_FEATURE_PIDOF_SINGLE
2247#define USAGE_FEATURE_PIDOF_SINGLE(a) a
2248#else
2249#define USAGE_FEATURE_PIDOF_SINGLE(a)
2250#endif
2251#if ENABLE_FEATURE_PIDOF_OMIT
2252#define USAGE_FEATURE_PIDOF_OMIT(a) a
2253#else
2254#define USAGE_FEATURE_PIDOF_OMIT(a)
2255#endif
2256#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
2257#define USAGE_PIDOF "Options:"
2258#else
2259#define USAGE_PIDOF "\n\tThis version of pidof accepts no options."
2260#endif
2261
Eric Andersen221b2ea2001-07-31 19:06:07 +00002262#define pidof_trivial_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002263 "process-name [OPTION] [process-name ...]"
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002264
Eric Andersen221b2ea2001-07-31 19:06:07 +00002265#define pidof_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002266 "Lists the PIDs of all processes with names that match the\n" \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002267 "names on the command line.\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002268 USAGE_PIDOF \
2269 USAGE_FEATURE_PIDOF_SINGLE("\n\t-s\t\tdisplay only a single PID") \
2270 USAGE_FEATURE_PIDOF_OMIT("\n\t-o\t\tomit given pid.") \
2271 USAGE_FEATURE_PIDOF_OMIT("\n\t\t\tUse %PPID to omit the parent pid of pidof itself")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002272#define pidof_example_usage \
2273 "$ pidof init\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002274 "1\n" \
2275 USAGE_FEATURE_PIDOF_OMIT("$ pidof /bin/sh\n20351 5973 5950\n") \
2276 USAGE_FEATURE_PIDOF_OMIT("$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002277
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002278#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00002279#define ping_trivial_usage "host"
2280#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
2281#else
2282#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002283 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002284#define ping_full_usage \
2285 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
2286 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002287 "\t-c COUNT\tSend only COUNT pings\n" \
2288 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56)\n" \
Denis Vlasenko2cbe6e62006-09-02 16:17:30 +00002289 "\t-I IPADDR\tUse IPADDR as source address\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002290 "\t-q\t\tQuiet mode, only displays output at start\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002291 "\t\t\tand when finished"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002292#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002293#define ping_example_usage \
2294 "$ ping localhost\n" \
2295 "PING slag (127.0.0.1): 56 data bytes\n" \
2296 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2297 "\n" \
2298 "--- debian ping statistics ---\n" \
2299 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002300 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002301
Eric Andersen51b8bd62002-07-03 11:46:38 +00002302#ifndef CONFIG_FEATURE_FANCY_PING6
2303#define ping6_trivial_usage "host"
2304#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
2305#else
2306#define ping6_trivial_usage \
2307 "[OPTION]... host"
2308#define ping6_full_usage \
2309 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
2310 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002311 "\t-c COUNT\tSend only COUNT pings\n" \
2312 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56)\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +00002313 "\t-q\t\tQuiet mode, only displays output at start\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002314 "\t\t\tand when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002315#endif
2316#define ping6_example_usage \
2317 "$ ping6 ip6-localhost\n" \
2318 "PING ip6-localhost (::1): 56 data bytes\n" \
2319 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2320 "\n" \
2321 "--- ip6-localhost ping statistics ---\n" \
2322 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002323 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002324
Eric Andersen7e9276b2001-02-22 01:15:47 +00002325#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002326 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002327#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002328 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002329 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002330
Eric Andersen7e9276b2001-02-22 01:15:47 +00002331#define poweroff_trivial_usage \
Rob Landley64612912006-01-30 08:31:37 +00002332 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002333#define poweroff_full_usage \
Rob Landley64612912006-01-30 08:31:37 +00002334 "Halt and shut off power.\n" \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002335 "Options:\n" \
Rob Landley64612912006-01-30 08:31:37 +00002336 "\t-d\t\tdelay interval for halting\n" \
2337 "\t-n\t\tno call to sync()\n" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00002338 "\t-f\t\tforce power off (don't go through init)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002339
Mike Frysinger95d3c452005-04-21 23:29:24 +00002340#define printenv_trivial_usage \
2341 "[VARIABLES...]"
2342#define printenv_full_usage \
2343 "print all or part of environment\n\n" \
2344 "If no environment VARIABLE specified, print them all."
2345
Eric Andersen7e9276b2001-02-22 01:15:47 +00002346#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002347 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002348#define printf_full_usage \
2349 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002350 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002351#define printf_example_usage \
Mike Frysinger5c63a722005-04-16 04:23:58 +00002352 "$ printf \"Val=%d\\n\" 5\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002353 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002354
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002355#if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE
Rob Landley6eb1e412005-06-20 04:30:36 +00002356#define USAGE_PS "\n\tThis version of ps accepts no options."
2357#else
2358#define USAGE_PS "\nOptions:"
2359#endif
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002360#if ENABLE_FEATURE_PS_WIDE
Rob Landley6eb1e412005-06-20 04:30:36 +00002361#define USAGE_PS_WIDE(a) a
2362#else
2363#define USAGE_PS_WIDE(a)
2364#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002365
Eric Andersen7e9276b2001-02-22 01:15:47 +00002366#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002367 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002368#define ps_full_usage \
2369 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002370 USAGE_PS \
2371 USAGE_SELINUX("\n\t-c\tshow SE Linux context") \
2372 USAGE_PS_WIDE("\n\tw\twide output")
2373
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002374#define ps_example_usage \
2375 "$ ps\n" \
2376 " PID Uid Gid State Command\n" \
2377 " 1 root root S init\n" \
2378 " 2 root root S [kflushd]\n" \
2379 " 3 root root S [kupdate]\n" \
2380 " 4 root root S [kpiod]\n" \
2381 " 5 root root S [kswapd]\n" \
2382 " 742 andersen andersen S [bash]\n" \
2383 " 743 andersen andersen S -bash\n" \
2384 " 745 root root S [getty]\n" \
2385 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002386
Eric Andersen7e9276b2001-02-22 01:15:47 +00002387#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002388 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002389#define pwd_full_usage \
2390 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002391#define pwd_example_usage \
2392 "$ pwd\n" \
2393 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002394
Eric Andersen7e9276b2001-02-22 01:15:47 +00002395#define rdate_trivial_usage \
Eric Andersen725db192003-07-22 08:26:05 +00002396 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002397#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002398 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002399 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002400 "\t-s\tSet the system date and time (default)\n" \
2401 "\t-p\tPrint the date and time"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002402
Rob Landley0e4690d2006-08-20 22:12:18 +00002403#define readahead_trivial_usage \
2404 "[FILE]..."
2405#define readahead_full_usage \
2406 "Preloads FILE(s) in RAM cache so that subsequent reads for those" \
2407 "files do not block on disk I/O."
2408
Ned Luddc6fbed52004-12-08 16:47:28 +00002409#ifdef CONFIG_FEATURE_READLINK_FOLLOW
2410#define USAGE_READLINK_FOLLOW(a) a
2411#else
2412#define USAGE_READLINK_FOLLOW(a)
2413#endif
2414
Eric Andersen7e9276b2001-02-22 01:15:47 +00002415#define readlink_trivial_usage \
Ned Luddc6fbed52004-12-08 16:47:28 +00002416 USAGE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002417#define readlink_full_usage \
Ned Luddc6fbed52004-12-08 16:47:28 +00002418 "Displays the value of a symbolic link." \
2419 USAGE_READLINK_FOLLOW("\n\nOptions:\n" \
2420 "\t-f\tcanonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002421
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002422#define readprofile_trivial_usage \
2423 "[OPTIONS]..."
2424#define readprofile_full_usage \
2425 "Options:\n" \
2426 "\t -m <mapfile> (default: /boot/System.map)\n" \
2427 "\t -p <profile> (default: /proc/profile)\n" \
2428 "\t -M <mult> set the profiling multiplier to <mult>\n" \
2429 "\t -i print only info about the sampling step\n" \
2430 "\t -v print verbose data\n" \
2431 "\t -a print all symbols, even if count is 0\n" \
2432 "\t -b print individual histogram-bin counts\n" \
2433 "\t -s print individual counters within functions\n" \
2434 "\t -r reset all the counters (root only)\n" \
2435 "\t -n disable byte order auto-detection"
2436
Glenn L McGrath62fae302002-12-10 00:14:33 +00002437#define realpath_trivial_usage \
2438 "pathname ..."
2439#define realpath_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002440 "Returns the absolute pathnames of given argument."
Tim Riker7b253f82003-12-28 05:02:40 +00002441
Eric Andersen7e9276b2001-02-22 01:15:47 +00002442#define reboot_trivial_usage \
Rob Landley64612912006-01-30 08:31:37 +00002443 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002444#define reboot_full_usage \
Glenn L McGrath72b14a82004-07-23 03:33:38 +00002445 "Reboot the system.\n" \
2446 "Options:\n" \
Rob Landley64612912006-01-30 08:31:37 +00002447 "\t-d\t\tdelay interval for rebooting\n" \
2448 "\t-n\t\tno call to sync()\n" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00002449 "\t-f\t\tforce reboot (don't go through init)"
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#define runlevel_trivial_usage \
2538 "[utmp]"
2539#define runlevel_full_usage \
2540 "Find the current and previous system runlevel.\n\n" \
2541 "If no utmp file exists or if no runlevel record can be found,\n" \
2542 "runlevel prints \"unknown\""
2543#define runlevel_example_usage \
2544 "$ runlevel /var/run/utmp\n" \
2545 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002546
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002547#define rx_trivial_usage \
2548 "FILE"
2549#define rx_full_usage \
2550 "Receive a file using the xmodem protocol."
2551#define rx_example_usage \
2552 "$ rx /tmp/foo\n"
2553
Eric Andersen7e9276b2001-02-22 01:15:47 +00002554#define sed_trivial_usage \
Rob Landley1ce59682004-05-26 21:59:31 +00002555 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002556#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002557 "Options:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002558 "\t-e script\tadd the script to the commands to be executed\n" \
Eric Andersenf802ff72004-04-12 15:12:06 +00002559 "\t-f scriptfile\tadd script-file contents to the\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002560 "\t\t\tcommands to be executed\n" \
Rob Landley1ce59682004-05-26 21:59:31 +00002561 "\t-i\t\tedit files in-place\n" \
2562 "\t-n\t\tsuppress automatic printing of pattern space\n" \
Rob Landley58b118a2004-05-26 22:09:37 +00002563 "\t-r\t\tuse extended regular expression syntax\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002564 "\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002565 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
2566 "script to interpret. All remaining arguments are names of input files; if no\n" \
Eric Andersenf802ff72004-04-12 15:12:06 +00002567 "input files are specified, then the standard input is read. Source files\n" \
2568 "will not be modified unless -i option is given."
2569
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002570#define sed_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002571 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002572 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002573
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002574#define seq_trivial_usage \
2575 "[first [increment]] last"
2576#define seq_full_usage \
2577 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
2578 "FIRST, INCREMENT default to 1\n" \
2579 "Arguments:\n" \
2580 "\tLAST\n" \
2581 "\tFIRST\tLAST\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002582 "\tFIRST\tINCREMENT\tLAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002583
Paul Foxfc2256a2005-08-01 18:12:30 +00002584#define setconsole_trivial_usage \
2585 "[-r|--reset] [DEVICE]"
2586#define setconsole_full_usage \
2587 "Redirects system console output to DEVICE (default: /dev/tty).\n\n" \
2588 "Options:\n" \
2589 "\t-r\tReset output to /dev/console."
2590
Eric Andersen7e9276b2001-02-22 01:15:47 +00002591#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002592 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002593#define setkeycodes_full_usage \
2594 "Set entries into the kernel's scancode-to-keycode map,\n" \
2595 "allowing unusual keyboards to generate usable keycodes.\n\n" \
2596 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002597 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002598#define setkeycodes_example_usage \
2599 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002600
Rob Landley87848d92006-03-27 23:23:43 +00002601#define setlogcons_trivial_usage \
2602 "N"
2603#define setlogcons_full_usage \
2604 "Redirects the kernel output to console N (0 for current)."
2605
Paul Fox42403642005-08-01 22:52:09 +00002606#define setsid_trivial_usage \
2607 "program [arg ...]"
2608#define setsid_full_usage \
2609 "Runs any program in a new session by calling setsid() before\n" \
2610 "exec'ing the rest of its arguments. See setsid(2) for details."
2611
Matt Kraai2d91deb2001-08-01 17:21:35 +00002612#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002613 "[FILE]...\n" \
2614 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00002615#define lash_full_usage \
Eric Andersen2e9c2572003-08-08 22:26:06 +00002616 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00002617#define lash_notes_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002618 "This command does not yet have proper documentation.\n\n" \
2619 "Use lash just as you would use any other shell. It properly handles pipes,\n" \
2620 "redirects, job control, can be used as the shell for scripts, and has a\n" \
2621 "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002622 "Bourne Shell syntax. If you need things like \"if-then-else\", \"while\", and such\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002623 "use ash or bash. If you just need a very simple and extremely small shell,\n" \
2624 "this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002625
Eric Andersen2e9c2572003-08-08 22:26:06 +00002626#define last_trivial_usage \
2627 ""
2628#define last_full_usage \
2629 "Shows listing of the last users that logged into the system"
2630
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002631#define sha1sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002632 "[OPTION] [FILEs...]" \
2633 USAGE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002634#define sha1sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002635 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n\n" \
2636 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002637 "With no FILE, or when FILE is -, read standard input." \
2638 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
2639 "\t-c\tcheck SHA1 sums against given list\n" \
2640 "\nThe following two options are useful only when verifying checksums:\n" \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002641 "\t-s\tdon't output anything, status code shows success\n" \
"Robert P. J. Day"eea56182006-07-20 19:02:24 +00002642 "\t-w\twarn about improperly formatted SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002643
Manuel Novoa III cad53642003-03-19 09:13:01 +00002644#ifdef CONFIG_FEATURE_FANCY_SLEEP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002645# define USAGE_FANCY_SLEEP(a) a
2646# define USAGE_NOT_FANCY_SLEEP(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +00002647#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002648# define USAGE_FANCY_SLEEP(a)
2649# define USAGE_NOT_FANCY_SLEEP(a) a
Manuel Novoa III cad53642003-03-19 09:13:01 +00002650#endif
2651
Eric Andersen7e9276b2001-02-22 01:15:47 +00002652#define sleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002653 USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002654#define sleep_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002655 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \
2656 USAGE_FANCY_SLEEP( \
Eric Andersen178de172004-04-06 16:36:20 +00002657 "Pause for a time equal to the total of the args given, where each arg can\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00002658 "\t\thave an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002659#define sleep_example_usage \
2660 "$ sleep 2\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002661 "[2 second delay results]\n" \
2662 USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \
2663 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002664
Rob Landley6130b9b2006-01-23 21:10:38 +00002665#if ENABLE_FEATURE_SORT_BIG
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002666# define USAGE_SORT_BIG(a) a
Mark Whitleyfccaa362001-04-17 18:56:18 +00002667#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002668# define USAGE_SORT_BIG(a)
Mark Whitleyfccaa362001-04-17 18:56:18 +00002669#endif
Rob Landleyc0dedd02005-01-24 07:00:02 +00002670
Eric Andersen7e9276b2001-02-22 01:15:47 +00002671#define sort_trivial_usage \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002672 "[-nru" USAGE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002673#define sort_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002674 "Sorts lines of text in the specified files\n\n" \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002675 "Options:\n" \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002676 USAGE_SORT_BIG( \
2677 "\t-b\tignore leading blanks\n" \
2678 "\t-c\tcheck whether input is sorted\n" \
2679 "\t-d\tdictionary order (blank or alphanumeric only)\n" \
2680 "\t-f\tignore case\n" \
2681 "\t-g\tgeneral numerical sort\n" \
2682 "\t-i\tignore unprintable characters\n" \
2683 "\t-k\tspecify sort key\n" \
2684 "\t-M\tsort month\n" \
2685 ) \
2686 "\t-n\tsort numbers\n" \
2687 USAGE_SORT_BIG( \
2688 "\t-o\toutput to file\n" \
2689 "\t-k\tsort by key\n" \
2690 "\t-t\tuse key separator other than whitespace\n" \
2691 ) \
2692 "\t-r\treverse sort order\n" \
2693 USAGE_SORT_BIG("\t-s\tstable (don't sort ties alphabetically)\n") \
2694 "\t-u\tsuppress duplicate lines" \
2695 USAGE_SORT_BIG("\n\t-z\tinput terminated by nulls, not newlines\n") \
Bernhard Reutner-Fischera1bccc02006-04-02 20:17:55 +00002696 USAGE_SORT_BIG("\t-mST\tignored for GNU compatibility") \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002697 ""
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002698#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002699 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002700 "a\n" \
2701 "b\n" \
2702 "c\n" \
2703 "d\n" \
2704 "e\n" \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002705 "f\n" \
2706 USAGE_SORT_BIG( \
2707 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
2708 "d 2\n" \
2709 "b 2\n" \
2710 "c 3\n" \
2711 ) \
2712 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002713
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002714#define start_stop_daemon_trivial_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002715 "[OPTIONS] [--start|--stop] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002716#define start_stop_daemon_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002717 "Program to start and stop services." \
2718 "\n\nOptions:" \
2719 "\n\t-S|--start\t\t\tstart" \
2720 "\n\t-K|--stop\t\t\tstop" \
2721 "\n\t-a|--startas <pathname>\t\tstarts process specified by pathname" \
2722 "\n\t-b|--background\t\t\tforce process into background" \
2723 "\n\t-u|--user <username>|<uid>\tstop this user's processes" \
2724 "\n\t-x|--exec <executable>\t\tprogram to either start or check" \
Bernhard Reutner-Fischer4d0f54a2006-09-15 19:25:18 +00002725 "\n\t-m|--make-pidfile\tcreate the -p file and enter pid in it" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002726 "\n\t-n|--name <process-name>\tstop processes with this name" \
2727 "\n\t-p|--pidfile <pid-file>\t\tsave or load pid using a pid-file" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002728 "\n\t-q|--quiet\t\t\tbe quiet" \
Bernhard Reutner-Fischera926f8e2006-06-11 17:24:01 +00002729USE_FEATURE_START_STOP_DAEMON_FANCY( \
2730 "\n\t-o|--oknodo\t\t\texit status 0 if nothing done" \
2731 "\n\t-v|--verbose\t\t\tbe verbose" \
2732) \
Rob Landleyf0623a22006-07-17 00:35:07 +00002733 "\n\t-s|--signal <signal>\t\tsignal to send (default TERM)" \
2734 "\n\t-U|--chuid <username>|<uid>\tstart process with this name"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002735
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002736#ifdef CONFIG_FEATURE_STAT_FORMAT
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002737# define USAGE_STAT_FORMAT(a) a
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002738#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002739# define USAGE_STAT_FORMAT(a)
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002740#endif
2741#define stat_trivial_usage \
2742 "[OPTION] FILE..."
2743#define stat_full_usage \
2744 "display file (default) or filesystem status.\n\n" \
2745 "Options:\n" \
2746 USAGE_STAT_FORMAT("\t-c fmt\tuse the specified format\n") \
2747 "\t-f\tdisplay filesystem status\n" \
2748 "\t-L,-l\tdereference links\n" \
2749 "\t-t\tdisplay info in terse form\n" \
2750 USAGE_STAT_FORMAT( \
2751 "\nValid format sequences for files:\n" \
2752 " %a Access rights in octal\n" \
2753 " %A Access rights in human readable form\n" \
2754 " %b Number of blocks allocated (see %B)\n" \
2755 " %B The size in bytes of each block reported by %b\n" \
2756 " %d Device number in decimal\n" \
2757 " %D Device number in hex\n" \
2758 " %f Raw mode in hex\n" \
2759 " %F File type\n" \
2760 " %g Group ID of owner\n" \
2761 " %G Group name of owner\n" \
2762 " %h Number of hard links\n" \
2763 " %i Inode number\n" \
2764 " %n File name\n" \
2765 " %N Quoted file name with dereference if symbolic link\n" \
2766 " %o I/O block size\n" \
2767 " %s Total size, in bytes\n" \
2768 " %t Major device type in hex\n" \
2769 " %T Minor device type in hex\n" \
2770 " %u User ID of owner\n" \
2771 " %U User name of owner\n" \
2772 " %x Time of last access\n" \
2773 " %X Time of last access as seconds since Epoch\n" \
2774 " %y Time of last modification\n" \
2775 " %Y Time of last modification as seconds since Epoch\n" \
2776 " %z Time of last change\n" \
2777 " %Z Time of last change as seconds since Epoch\n" \
2778 "\nValid format sequences for file systems:\n" \
2779 " %a Free blocks available to non-superuser\n" \
2780 " %b Total data blocks in file system\n" \
2781 " %c Total file nodes in file system\n" \
2782 " %d Free file nodes in file system\n" \
2783 " %f Free blocks in file system\n" \
2784 " %i File System ID in hex\n" \
2785 " %l Maximum length of filenames\n" \
2786 " %n File name\n" \
2787 " %s Block size (for faster transfers)\n" \
2788 " %S Fundamental block size (for block counts)\n" \
2789 " %t Type in hex\n" \
2790 " %T Type in human readable form\n" \
2791 )
2792
Eric Andersenef5e8f82002-11-07 02:09:37 +00002793#define strings_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002794 "[-afo] [-n length] [file ... ]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002795#define strings_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002796 "Display printable strings in a binary file." \
2797 "\n\nOptions:" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002798 "\n\t-a\tScan the whole files (this is the default)." \
Eric Andersen178de172004-04-06 16:36:20 +00002799 "\n\t-f\tPrecede each string with the name of the file where it was found." \
2800 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002801 "\n\t-o\tEach string is preceded by its decimal offset in the file"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002802
Eric Andersen7e9276b2001-02-22 01:15:47 +00002803#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002804 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002805#define stty_full_usage \
2806 "Without arguments, prints baud rate, line discipline," \
2807 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002808 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00002809 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002810 "\n\t-a\t\tprint all current settings in human-readable form" \
2811 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00002812 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002813
Robert Griebl1fca5582002-06-04 20:45:46 +00002814#define su_trivial_usage \
2815 "[OPTION]... [-] [username]"
2816#define su_full_usage \
2817 "Change user id or become root.\n" \
2818 "Options:\n" \
Bernhard Reutner-Fischer5a620ea2006-01-19 18:04:15 +00002819 "\t-p, -m\tPreserve environment" \
2820 "\n\t-c\tCommand to pass to 'sh -c'" \
2821 "\n\t-s\tShell to use instead of default shell"
Robert Griebl1fca5582002-06-04 20:45:46 +00002822
Eric Andersen27f64e12002-06-23 04:24:25 +00002823#define sulogin_trivial_usage \
2824 "[OPTION]... [tty-device]"
2825#define sulogin_full_usage \
2826 "Single user login\n" \
2827 "Options:\n" \
Rob Landley69674942006-09-11 00:34:01 +00002828 "\t-t\tTimeout"
Eric Andersen27f64e12002-06-23 04:24:25 +00002829
Mike Frysinger95d3c452005-04-21 23:29:24 +00002830#define sum_trivial_usage \
2831 "[rs] [files...]"
2832#define sum_full_usage \
2833 "checksum and count the blocks in a file\n\n" \
2834 "Options:\n" \
2835 "\t-r\tuse BSD sum algorithm (1K blocks)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002836 "\t-s\tuse System V sum algorithm (512byte blocks)"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002837
Eric Andersen7e9276b2001-02-22 01:15:47 +00002838#define swapoff_trivial_usage \
Mike Frysinger68071e42005-09-13 02:26:24 +00002839 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002840#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002841 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002842 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002843 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002844
Eric Andersen7e9276b2001-02-22 01:15:47 +00002845#define swapon_trivial_usage \
Mike Frysinger68071e42005-09-13 02:26:24 +00002846 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002847#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002848 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002849 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002850 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002851
Rob Landley0f34a822005-10-27 22:55:50 +00002852#define switch_root_trivial_usage \
Rob Landley70f7ef72005-12-13 08:21:33 +00002853 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00002854#define switch_root_full_usage \
2855 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Rob Landley70f7ef72005-12-13 08:21:33 +00002856 "and exec NEW_INIT.\n\n" \
2857 "Options:\n" \
2858 "\t-c\tRedirect console to device on new root"
Rob Landley0f34a822005-10-27 22:55:50 +00002859
Eric Andersen7e9276b2001-02-22 01:15:47 +00002860#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002861 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002862#define sync_full_usage \
2863 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002864
Eric Andersen7e9276b2001-02-22 01:15:47 +00002865
Eric Andersen29c77f72003-10-09 09:43:18 +00002866#ifdef CONFIG_FEATURE_ROTATE_LOGFILE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002867# define USAGE_ROTATE_LOGFILE(a) a
Eric Andersen29c77f72003-10-09 09:43:18 +00002868#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002869# define USAGE_ROTATE_LOGFILE(a)
Eric Andersen29c77f72003-10-09 09:43:18 +00002870#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002871#ifdef CONFIG_FEATURE_REMOTE_LOG
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002872# define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002873#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002874# define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002875#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00002876#ifdef CONFIG_FEATURE_IPC_SYSLOG
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002877# define USAGE_IPC_LOG(a) a
Robert Griebl65d415d2002-08-07 21:10:19 +00002878#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002879# define USAGE_IPC_LOG(a)
Robert Griebl65d415d2002-08-07 21:10:19 +00002880#endif
2881
Eric Andersenb9050282003-12-24 06:02:11 +00002882#define sysctl_trivial_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002883 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00002884#define sysctl_full_usage \
2885 "configure kernel parameters at runtime\n\n" \
Eric Andersenb9050282003-12-24 06:02:11 +00002886 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002887 "\t-n\tUse this option to disable printing of the key name when printing values\n" \
2888 "\t-w\tUse this option when you want to change a sysctl setting\n" \
2889 "\t-p\tLoad in sysctl settings from the file specified or /etc/sysctl.conf if none given\n" \
2890 "\t-a\tDisplay all values currently available\n" \
2891 "\t-A\tDisplay all values currently available in table form"
Eric Andersen5d38f5b2005-09-12 21:42:48 +00002892#define sysctl_example_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002893 "sysctl [-n] variable ...\n" \
2894 "sysctl [-n] -w variable=value ...\n" \
2895 "sysctl [-n] -a\n" \
2896 "sysctl [-n] -p <file>\t(default /etc/sysctl.conf)\n" \
2897 "sysctl [-n] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00002898
Eric Andersen7e9276b2001-02-22 01:15:47 +00002899#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002900 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002901#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002902 "Linux system and kernel logging utility.\n" \
2903 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002904 "Options:\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002905 "\t-m MIN\t\tMinutes between MARK lines (default=20, 0=off)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002906 "\t-n\t\tRun as a foreground process\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002907 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)\n" \
2908 "\t-S\t\tMake logging output smaller." \
Eric Andersen29c77f72003-10-09 09:43:18 +00002909 USAGE_ROTATE_LOGFILE( \
Eric Andersen178de172004-04-06 16:36:20 +00002910 "\n\t-s SIZE\t\tMax size (KB) before rotate (default=200KB, 0=off)\n" \
2911 "\t-b NUM\t\tNumber of rotated logs to keep (default=1, max=99, 0=purge)") \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002912 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00002913 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00002914 "\t-L\t\tLog locally and via network logging (default is network only)") \
2915 USAGE_IPC_LOG( \
Eric Andersend4a5e252003-12-19 11:32:14 +00002916 "\n\t-C [size(KiB)]\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002917#define syslogd_example_usage \
2918 "$ syslogd -R masterlog:514\n" \
2919 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002920
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002921
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002922#ifndef CONFIG_FEATURE_FANCY_TAIL
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002923# define USAGE_UNSIMPLE_TAIL(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00002924#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002925# define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002926#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002927#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002928 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002929#define tail_full_usage \
2930 "Print last 10 lines of each FILE to standard output.\n" \
2931 "With more than one FILE, precede each with a header giving the\n" \
2932 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
2933 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002934 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002935 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
2936 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002937 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002938 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
2939 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002940 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002941 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002942 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
2943#define tail_example_usage \
2944 "$ tail -n 1 /etc/resolv.conf\n" \
2945 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002946
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002947#ifdef CONFIG_FEATURE_TAR_CREATE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002948# define USAGE_TAR_CREATE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002949#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002950# define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002951#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002952#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002953# define USAGE_TAR_EXCLUDE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002954#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002955# define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002956#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002957#ifdef CONFIG_FEATURE_TAR_GZIP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002958# define USAGE_TAR_GZIP(a) a
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002959#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002960# define USAGE_TAR_GZIP(a)
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002961#endif
2962#ifdef CONFIG_FEATURE_TAR_BZIP2
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002963# define USAGE_TAR_BZIP2(a) a
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002964#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002965# define USAGE_TAR_BZIP2(a)
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002966#endif
Rob Landleyc1d69902006-01-20 18:28:50 +00002967#ifdef CONFIG_FEATURE_TAR_LZMA
2968# define USAGE_TAR_LZMA(a) a
2969#else
2970# define USAGE_TAR_LZMA(a)
2971#endif
Glenn L McGrath7370f622003-11-18 21:49:23 +00002972#ifdef CONFIG_FEATURE_TAR_COMPRESS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002973# define USAGE_TAR_COMPRESS(a) a
Glenn L McGrath7370f622003-11-18 21:49:23 +00002974#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002975# define USAGE_TAR_COMPRESS(a)
Glenn L McGrath7370f622003-11-18 21:49:23 +00002976#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002977
Eric Andersen7e9276b2001-02-22 01:15:47 +00002978#define tar_trivial_usage \
Rob Landleyc1d69902006-01-20 18:28:50 +00002979 "-[" USAGE_TAR_CREATE("c") USAGE_TAR_GZIP("z") USAGE_TAR_BZIP2("j") USAGE_TAR_LZMA("a") USAGE_TAR_COMPRESS("Z") "xtvO] " \
Glenn L McGrathce91c8a2003-12-26 14:01:37 +00002980 USAGE_TAR_EXCLUDE("[-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00002981 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002982#define tar_full_usage \
2983 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00002984 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002985 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002986 "\tx\t\textract\n" \
2987 "\tt\t\tlist\n" \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002988 "\nArchive format selection:\n" \
2989 USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
2990 USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
Rob Landleyc1d69902006-01-20 18:28:50 +00002991 USAGE_TAR_LZMA("\ta\t\tFilter the archive through lzma\n") \
Glenn L McGrath0c5d9c22003-11-18 23:27:49 +00002992 USAGE_TAR_COMPRESS("\tZ\t\tFilter the archive through compress\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002993 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002994 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002995 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002996 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002997 "\texclude\t\tfile to exclude\n" \
2998 "\tX\t\tfile with names to exclude\n" \
2999 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00003000 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003001 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003002#define tar_example_usage \
3003 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3004 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003005
Eric Andersen7e9276b2001-02-22 01:15:47 +00003006#define tee_trivial_usage \
3007 "[OPTION]... [FILE]..."
3008#define tee_full_usage \
3009 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00003010 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00003011 "\t-a\tappend to the given FILEs, do not overwrite\n" \
3012 "\t-i\tignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003013#define tee_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003014 "$ echo \"Hello\" | tee /tmp/foo\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003015 "$ cat /tmp/foo\n" \
3016 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003017
Eric Andersen539ffc92004-02-22 12:25:47 +00003018#ifdef CONFIG_FEATURE_TELNET_AUTOLOGIN
3019#define telnet_trivial_usage \
3020 "[-a] [-l USER] HOST [PORT]"
3021#define telnet_full_usage \
3022 "Telnet is used to establish interactive communication with another\n" \
3023 "computer over a network using the TELNET protocol.\n\n" \
3024 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003025 "\t-a\t\tAttempt an automatic login with the USER variable\n" \
3026 "\t-l USER\t\tAttempt an automatic login with the USER argument\n" \
Eric Andersen539ffc92004-02-22 12:25:47 +00003027 "\tHOST\t\tThe official name, alias or the IP address of the\n" \
3028 "\t\t\tremote host.\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003029 "\tPORT\t\tThe remote port number to connect to. If it is not\n" \
Eric Andersen178de172004-04-06 16:36:20 +00003030 "\t\t\tspecified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00003031#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003032#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003033 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003034#define telnet_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003035 "Telnet is used to establish interactive communication with another\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003036 "computer over a network using the TELNET protocol."
Eric Andersen539ffc92004-02-22 12:25:47 +00003037#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003038
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003039#ifdef CONFIG_FEATURE_TELNETD_INETD
3040#define telnetd_trivial_usage \
3041 "(inetd mode) [OPTION]"
3042#define telnetd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003043 "Telnetd uses incoming TELNET connections via inetd.\n" \
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003044 "Options:\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00003045 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003046 "\t-f issue_file\tDisplay issue_file instead of /etc/issue"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003047#else
Eric Andersen08a72202002-09-30 20:52:10 +00003048#define telnetd_trivial_usage \
3049 "[OPTION]"
3050#define telnetd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003051 "Telnetd listens for incoming TELNET connections on PORT.\n" \
Eric Andersen08a72202002-09-30 20:52:10 +00003052 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003053 "\t-p PORT\tlisten for connections on PORT (default 23)\n" \
3054 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)\n" \
3055 "\t-f issue_file\tDisplay issue_file instead of /etc/issue"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003056#endif
Eric Andersen08a72202002-09-30 20:52:10 +00003057
Eric Andersen7e9276b2001-02-22 01:15:47 +00003058#define test_trivial_usage \
3059 "EXPRESSION\n or [ EXPRESSION ]"
3060#define test_full_usage \
3061 "Checks file types and compares values returning an exit\n" \
3062 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003063#define test_example_usage \
3064 "$ test 1 -eq 2\n" \
3065 "$ echo $?\n" \
3066 "1\n" \
3067 "$ test 1 -eq 1\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00003068 "$ echo $?\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003069 "0\n" \
3070 "$ [ -d /etc ]\n" \
3071 "$ echo $?\n" \
3072 "0\n" \
3073 "$ [ -d /junk ]\n" \
3074 "$ echo $?\n" \
3075 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003076
Eric Andersenbdfd0d72001-10-24 05:00:29 +00003077#ifdef CONFIG_FEATURE_TFTP_GET
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003078# define USAGE_TFTP_GET(a) a
Mark Whitley450736c2001-03-02 19:08:50 +00003079#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003080# define USAGE_TFTP_GET(a)
Mark Whitley450736c2001-03-02 19:08:50 +00003081#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00003082#ifdef CONFIG_FEATURE_TFTP_PUT
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003083# define USAGE_TFTP_PUT(a) a
Mark Whitley450736c2001-03-02 19:08:50 +00003084#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003085# define USAGE_TFTP_PUT(a)
Mark Whitley450736c2001-03-02 19:08:50 +00003086#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00003087#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003088# define USAGE_TFTP_BS(a) a
Glenn L McGrathad117d82001-10-05 04:40:37 +00003089#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003090# define USAGE_TFTP_BS(a)
Glenn L McGrathad117d82001-10-05 04:40:37 +00003091#endif
Mark Whitley450736c2001-03-02 19:08:50 +00003092
3093#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00003094 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00003095#define tftp_full_usage \
3096 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00003097 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003098 "\t-l FILE\tLocal FILE\n" \
3099 "\t-r FILE\tRemote FILE" \
3100 USAGE_TFTP_GET( \
3101 "\n\t-g\tGet file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003102 ) \
Mike Frysinger058e7402005-04-23 07:00:33 +00003103 USAGE_TFTP_PUT( \
3104 "\n\t-p\tPut file" \
Mark Whitley450736c2001-03-02 19:08:50 +00003105 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00003106 USAGE_TFTP_BS( \
Mike Frysinger058e7402005-04-23 07:00:33 +00003107 "\n\t-b SIZE\tTransfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00003108 )
Eric Andersenc3657422001-11-30 07:54:32 +00003109#define time_trivial_usage \
3110 "[OPTION]... COMMAND [ARGS...]"
3111#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00003112 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
3113 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00003114 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003115 "\t-v\tDisplays verbose resource usage information"
Mark Whitley450736c2001-03-02 19:08:50 +00003116
Eric Andersen420b2082002-09-17 22:14:58 +00003117#define top_trivial_usage \
3118 "[-d <seconds>]"
3119#define top_full_usage \
3120 "top provides an view of processor activity in real time.\n" \
3121 "This utility reads the status for all processes in /proc each <seconds>\n" \
3122 "and shows the status for however many processes will fit on the screen.\n" \
3123 "This utility will not show processes that are started after program startup,\n" \
3124 "but it will show the EXIT status for and PIDs that exit while it is running."
3125
Eric Andersen7e9276b2001-02-22 01:15:47 +00003126#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003127 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003128#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003129 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003130 "Options:\n" \
3131 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003132#define touch_example_usage \
3133 "$ ls -l /tmp/foo\n" \
3134 "/bin/ls: /tmp/foo: No such file or directory\n" \
3135 "$ touch /tmp/foo\n" \
3136 "$ ls -l /tmp/foo\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003137 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003138
3139#define tr_trivial_usage \
3140 "[-cds] STRING1 [STRING2]"
3141#define tr_full_usage \
3142 "Translate, squeeze, and/or delete characters from\n" \
3143 "standard input, writing to standard output.\n\n" \
3144 "Options:\n" \
3145 "\t-c\ttake complement of STRING1\n" \
3146 "\t-d\tdelete input characters coded STRING1\n" \
3147 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003148#define tr_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003149 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003150 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003151
Eric Andersen5c58d282001-07-10 16:29:00 +00003152#define traceroute_trivial_usage \
"Vladimir N. Oleynik"45a8ed82005-09-06 16:08:33 +00003153 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
3154 "\t[-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
3155 "\t[-z pausemsecs] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00003156#define traceroute_full_usage \
3157 "trace the route ip packets follow going to \"host\"\n" \
3158 "Options:\n" \
"Vladimir N. Oleynik"45a8ed82005-09-06 16:08:33 +00003159 "\t-F\tSet the don't fragment bit\n" \
3160 "\t-I\tUse ICMP ECHO instead of UDP datagrams\n" \
3161 "\t-l\tDisplay the ttl value of the returned packet\n" \
3162 "\t-d\tSet SO_DEBUG options to socket\n" \
Eric Andersen5c58d282001-07-10 16:29:00 +00003163 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
3164 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
3165 "\t-v\tVerbose output\n" \
3166 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
3167 "\t-p port#\tSet the base UDP port number used in probes\n" \
3168 "\t\t(default is 33434)\n" \
3169 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
3170 "\t\t(default is 3)\n" \
3171 "\t-s src_addr\tUse the following IP address as the source address\n" \
3172 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
3173 "\t\t(default 0)\n" \
3174 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
Mike Frysinger036f2992005-09-24 23:50:14 +00003175 "\t\t(default 3 sec)\n" \
3176 "\t-g\tSpecify a loose source route gateway (8 maximum)"
Eric Andersen5c58d282001-07-10 16:29:00 +00003177
3178
Eric Andersen7e9276b2001-02-22 01:15:47 +00003179#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003180 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003181#define true_full_usage \
3182 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003183#define true_example_usage \
3184 "$ true\n" \
3185 "$ echo $?\n" \
3186 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003187
Eric Andersen7e9276b2001-02-22 01:15:47 +00003188#define tty_trivial_usage \
3189 ""
3190#define tty_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003191 "Print the file name of the terminal connected to standard input.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003192 "Options:\n" \
3193 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003194#define tty_example_usage \
3195 "$ tty\n" \
3196 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003197
Mike Frysinger174808c2005-06-11 01:14:09 +00003198#define tune2fs_trivial_usage \
3199 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
3200 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
3201 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
3202 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
3203 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
3204 "[-T last-check-time] [-U UUID] device"
3205#define tune2fs_full_usage \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00003206 "Adjust filesystem options on ext[23] filesystems."
Mike Frysinger174808c2005-06-11 01:14:09 +00003207
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003208#define udhcpc_trivial_usage \
Rob Landleya2841e62006-02-20 23:26:38 +00003209 "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003210#define udhcpc_full_usage \
Paul Foxa39bba32005-08-01 14:31:13 +00003211 "\t-c,\t--clientid=CLIENTID\tSet client identifier\n" \
3212 "\t-C,\t--clientid-none\tSuppress default client identifier\n" \
Paul Fox28de9512005-09-22 18:59:13 +00003213 "\t-V,\t--vendorclass=CLASSID\tSet vendor class identifier\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003214 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00003215 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003216 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003217 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003218 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003219 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003220 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
3221 "\t-q,\t--quit\tQuit after obtaining lease\n" \
Denis Vlasenkoe175ff22006-09-26 17:41:00 +00003222 "\t-R,\t--release\tRelease IP on quit\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003223 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
3224 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
Rob Landleya2841e62006-02-20 23:26:38 +00003225 "\t-t,\t--retries=NUM\tSend up to NUM request packets\n"\
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003226 "\t-v,\t--version\tDisplay version"
3227
Russ Dill61fb4892002-10-14 21:41:28 +00003228#define udhcpd_trivial_usage \
3229 "[configfile]\n" \
3230
3231#define udhcpd_full_usage \
Glenn L McGrath9130c852002-12-12 12:56:18 +00003232 ""
Russ Dill61fb4892002-10-14 21:41:28 +00003233
Eric Andersen7e9276b2001-02-22 01:15:47 +00003234#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003235 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003236#define umount_full_usage \
3237 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00003238 "\nFlags:\n" "\t-a\tUnmount all file systems" \
Rob Landleye55a73c2006-08-09 20:55:35 +00003239 USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
John Beppu5d817682001-04-17 17:09:34 +00003240 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Rob Landley16722552005-09-24 22:41:08 +00003241 "\n\t-l\tLazy umount (detach filesystem)" \
3242 "\n\t-f\tForce umount (i.e., unreachable NFS server)" \
Rob Landleye55a73c2006-08-09 20:55:35 +00003243 USE_FEATURE_MOUNT_LOOP("\n\t-D\tDo not free loop device (if a loop device has been used)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003244#define umount_example_usage \
3245 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003246
3247#define uname_trivial_usage \
3248 "[OPTION]..."
3249#define uname_full_usage \
3250 "Print certain system information. With no OPTION, same as -s.\n\n" \
3251 "Options:\n" \
3252 "\t-a\tprint all information\n" \
3253 "\t-m\tthe machine (hardware) type\n" \
3254 "\t-n\tprint the machine's network node hostname\n" \
3255 "\t-r\tprint the operating system release\n" \
3256 "\t-s\tprint the operating system name\n" \
3257 "\t-p\tprint the host processor type\n" \
3258 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003259#define uname_example_usage \
3260 "$ uname -a\n" \
Eric Andersen7f48a952003-12-28 05:06:56 +00003261 "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 +00003262
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003263#define uncompress_trivial_usage \
3264 "[-c] [-f] [ name ... ]"
3265#define uncompress_full_usage \
3266 "Uncompress .Z file[s]\n" \
3267 "Options:\n" \
3268 "\t-c\textract to stdout\n" \
Eric Andersen178de172004-04-06 16:36:20 +00003269 "\t-f\tforce overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00003270
Eric Andersen7e9276b2001-02-22 01:15:47 +00003271#define uniq_trivial_usage \
Rob Landley14efdc52005-09-07 04:18:36 +00003272 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003273#define uniq_full_usage \
3274 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00003275 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003276 "Options:\n" \
3277 "\t-c\tprefix lines by the number of occurrences\n" \
3278 "\t-d\tonly print duplicate lines\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00003279 "\t-u\tonly print unique lines\n" \
3280 "\t-f N\tskip the first N fields\n" \
3281 "\t-s N\tskip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003282#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00003283 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003284 "a\n" \
3285 "b\n" \
3286 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003287
3288#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003289 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003290#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003291 "Converts FILE from unix format to dos format. When no option\n" \
3292 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00003293 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00003294 "Options:\n" \
3295 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00003296 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003297
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003298#define unzip_trivial_usage \
3299 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
3300#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00003301 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003302 "Options:\n" \
3303 "\t-l\tlist archive contents (short form)\n" \
3304 "\t-n\tnever overwrite existing files (default)\n" \
3305 "\t-o\toverwrite files without prompting\n" \
3306 "\t-p\tsend output to stdout\n" \
3307 "\t-q\tbe quiet\n" \
3308 "\t-x\texclude these files\n" \
3309 "\t-d\textract files into this directory"
3310
Eric Andersen7e9276b2001-02-22 01:15:47 +00003311#define uptime_trivial_usage \
3312 ""
3313#define uptime_full_usage \
3314 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003315#define uptime_example_usage \
3316 "$ uptime\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003317 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003318
3319#define usleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00003320 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003321#define usleep_full_usage \
3322 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003323#define usleep_example_usage \
3324 "$ usleep 1000000\n" \
3325 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003326
3327#define uudecode_trivial_usage \
3328 "[FILE]..."
3329#define uudecode_full_usage \
3330 "Uudecode a file that is uuencoded.\n\n" \
3331 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003332 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003333#define uudecode_example_usage \
3334 "$ uudecode -o busybox busybox.uu\n" \
3335 "$ ls -l busybox\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003336 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003337
3338#define uuencode_trivial_usage \
3339 "[OPTION] [INFILE] REMOTEFILE"
3340#define uuencode_full_usage \
3341 "Uuencode a file.\n\n" \
3342 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00003343 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003344#define uuencode_example_usage \
3345 "$ uuencode busybox busybox\n" \
3346 "begin 755 busybox\n" \
3347 "<encoded file snipped>\n" \
3348 "$ uudecode busybox busybox > busybox.uu\n" \
3349 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003350
Eric Andersen853c4942003-01-23 05:59:32 +00003351#define vconfig_trivial_usage \
3352 "COMMAND [OPTIONS] ..."
Eric Andersen853c4942003-01-23 05:59:32 +00003353#define vconfig_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00003354 "vconfig lets you create and remove virtual ethernet devices.\n\n" \
3355 "Options:\n" \
3356 "\tadd [interface-name] [vlan_id]\n" \
3357 "\trem [vlan-name]\n" \
3358 "\tset_flag [interface-name] [flag-num] [0 | 1]\n" \
3359 "\tset_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3360 "\tset_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3361 "\tset_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00003362
Eric Andersen3f980402001-04-04 17:31:15 +00003363#define vi_trivial_usage \
3364 "[OPTION] [FILE]..."
3365#define vi_full_usage \
3366 "edit FILE.\n\n" \
3367 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003368 "\t-R\tRead-only- do not write to the file"
Eric Andersen3f980402001-04-04 17:31:15 +00003369
Eric Andersen27f64e12002-06-23 04:24:25 +00003370#define vlock_trivial_usage \
3371 "[OPTIONS]"
3372#define vlock_full_usage \
3373 "Lock a virtual terminal. A password is required to unlock\n" \
3374 "Options:\n" \
3375 "\t-a\tLock all VTs"
3376
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003377#define watch_trivial_usage \
3378 "[-n <seconds>] COMMAND..."
3379#define watch_full_usage \
3380 "Executes a program periodically.\n" \
3381 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003382 "\t-n\tLoop period in seconds - default is 2"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003383#define watch_example_usage \
3384 "$ watch date\n" \
3385 "Mon Dec 17 10:31:40 GMT 2000\n" \
3386 "Mon Dec 17 10:31:42 GMT 2000\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003387 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003388
Eric Andersen7e9276b2001-02-22 01:15:47 +00003389#define watchdog_trivial_usage \
Mike Frysingercd68a2e2006-06-26 21:31:17 +00003390 "[-t <seconds>] [-F] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003391#define watchdog_full_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00003392 "Periodically write to watchdog device DEV.\n" \
3393 "Options:\n" \
Mike Frysingercd68a2e2006-06-26 21:31:17 +00003394 "\t-t\tTimer period in seconds - default is 30\n" \
3395 "\t-F\tStay in the foreground and don't fork"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003396
3397#define wc_trivial_usage \
3398 "[OPTION]... [FILE]..."
3399#define wc_full_usage \
3400 "Print line, word, and byte counts for each FILE, and a total line if\n" \
3401 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
3402 "Options:\n" \
3403 "\t-c\tprint the byte counts\n" \
3404 "\t-l\tprint the newline counts\n" \
3405 "\t-L\tprint the length of the longest line\n" \
3406 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003407#define wc_example_usage \
3408 "$ wc /etc/passwd\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003409 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003410
3411#define wget_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00003412 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n" \
Bernhard Reutner-Fischerbfbc4eb2006-09-02 15:30:26 +00003413 "\t\t[--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
3414 "\t\t[-U|--user-agent agent] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003415#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00003416 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003417 "Options:\n" \
3418 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00003419 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00003420 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00003421 "\t-O\tsave to filename ('-' for stdout)\n" \
Bernhard Reutner-Fischerbfbc4eb2006-09-02 15:30:26 +00003422 "\t-U\tadjust 'User-Agent' field\n" \
Robert Griebld7760112002-05-14 23:36:45 +00003423 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003424
3425#define which_trivial_usage \
3426 "[COMMAND ...]"
3427#define which_full_usage \
3428 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003429#define which_example_usage \
3430 "$ which login\n" \
3431 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00003432
Eric Andersen00a6a752002-04-26 23:53:10 +00003433#define who_trivial_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003434 " "
Eric Andersen00a6a752002-04-26 23:53:10 +00003435#define who_full_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003436 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003437
3438#define whoami_trivial_usage \
3439 ""
3440#define whoami_full_usage \
3441 "Prints the user name associated with the current effective user id."
3442
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003443#ifdef CONFIG_FEATURE_XARGS_SUPPORT_CONFIRMATION
3444#define USAGE_XARGS_CONFIRMATION(a) a
3445#else
3446#define USAGE_XARGS_CONFIRMATION(a)
3447#endif
3448#ifdef CONFIG_FEATURE_XARGS_SUPPORT_TERMOPT
3449#define USAGE_XARGS_TERMOPT(a) a
3450#else
3451#define USAGE_XARGS_TERMOPT(a)
3452#endif
3453#ifdef CONFIG_FEATURE_XARGS_SUPPORT_ZERO_TERM
3454#define USAGE_XARGS_ZERO_TERM(a) a
3455#else
3456#define USAGE_XARGS_ZERO_TERM(a)
3457#endif
3458
3459
Eric Andersen7e9276b2001-02-22 01:15:47 +00003460#define xargs_trivial_usage \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003461 "[COMMAND] [OPTIONS] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003462#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00003463 "Executes COMMAND on every item given by standard input.\n\n" \
3464 "Options:\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003465 USAGE_XARGS_CONFIRMATION("\t-p\tPrompt the user about whether to run each command\n") \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00003466 "\t-r\tDo not run command for empty read lines\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003467 USAGE_XARGS_TERMOPT("\t-x\tExit if the size is exceeded\n") \
3468 USAGE_XARGS_ZERO_TERM("\t-0\tInput filenames are terminated by a null character\n") \
Mike Frysinger058e7402005-04-23 07:00:33 +00003469 "\t-t\tPrint the command line on stderr before executing it"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003470#define xargs_example_usage \
3471 "$ ls | xargs gzip\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003472 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003473
3474#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003475 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003476#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003477 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003478
Eric Andersen7e9276b2001-02-22 01:15:47 +00003479#define zcat_trivial_usage \
3480 "FILE"
3481#define zcat_full_usage \
3482 "Uncompress to stdout."
Eric Andersen178de172004-04-06 16:36:20 +00003483
Rob Landleyad8071f2005-04-30 03:49:37 +00003484#define zcip_trivial_usage \
3485 "[OPTIONS] ifname script"
3486#define zcip_full_usage \
3487 "zcip manages a ZeroConf IPv4 link-local address.\n" \
3488 "Options:\n" \
3489 "\t-f foreground mode\n" \
3490 "\t-q quit after address (no daemon)\n" \
3491 "\t-r 169.254.x.x request this address first\n" \
Rob Landleye1ee4822006-06-24 22:39:19 +00003492 "\t-v verbose"
Rob Landleyad8071f2005-04-30 03:49:37 +00003493
Eric Andersen178de172004-04-06 16:36:20 +00003494#endif /* __BB_USAGE_H__ */