blob: 622c9c4d74a8dee994229a8a813ae7de16b15779 [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
Eric Andersen7e9276b2001-02-22 01:15:47 +0000268#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000269 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000270#define cp_full_usage \
271 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
272 "\n" \
273 "\t-a\tSame as -dpR\n" \
Mike Frysinger6077d902005-01-07 00:56:47 +0000274 "\t-d,-P\tPreserves links\n" \
Mike Frysinger2ed05ab2005-04-14 02:52:50 +0000275 "\t-H,-L\tDereference all symlinks (implied by default)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000276 "\t-p\tPreserves file attributes if possible\n" \
277 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersenced97052004-02-20 09:55:37 +0000278 "\t-i\tinteractive, prompt before overwrite\n" \
279 "\t-R,-r\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000280
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000281#define cpio_trivial_usage \
282 "-[dimtuv][F cpiofile]"
283#define cpio_full_usage \
284 "Extract or list files from a cpio archive\n" \
285 "Main operation mode:\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000286 "\td\t\tmake leading directories\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000287 "\ti\t\textract\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000288 "\tm\t\tpreserve mtime\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000289 "\tt\t\tlist\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000290 "\tv\t\tverbose\n" \
Eric Andersen6925d502001-12-16 09:23:09 +0000291 "\tu\t\tunconditional overwrite\n" \
292 "\tF\t\tinput from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000293
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000294#define crond_trivial_usage \
295 "-d[#] -c <crondir> -f -b"
296#define crond_full_usage \
297 "\t-d [#] -l [#] -S -L logfile -f -b -c dir\n" \
298 "\t-d num\tdebug level\n" \
299 "\t-l num\tlog level (8 - default)\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +0000300 "\t-S\tlog to syslogd (default)\n" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000301 "\t-L file\tlog to file\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +0000302 "\t-f\trun in foreground\n" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000303 "\t-b\trun in background (default)\n" \
304 "\t-c dir\tworking dir"
305
306#define crontab_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000307 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000308#define crontab_full_usage \
309 "\tfile <opts> replace crontab from file\n" \
310 "\t- <opts> replace crontab from stdin\n" \
311 "\t-u user specify user\n" \
312 "\t-l [user] list crontab for user\n" \
313 "\t-e [user] edit crontab for user\n" \
314 "\t-d [user] delete crontab for user\n" \
315 "\t-c dir specify crontab directory"
316
317
Eric Andersen7e9276b2001-02-22 01:15:47 +0000318#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000319 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000320#define cut_full_usage \
321 "Prints selected fields from each input FILE to standard output.\n\n" \
322 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000323 "\t-b LIST\t\tOutput only bytes from LIST\n" \
324 "\t-c LIST\t\tOutput only characters from LIST\n" \
325 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
326 "\t-s\t\tOutput only the lines containing delimiter\n" \
327 "\t-f N\t\tPrint only these fields\n" \
328 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000329#define cut_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +0000330 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000331 "Hello\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000332 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000333 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000334
Eric Andersen7e9276b2001-02-22 01:15:47 +0000335#define date_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +0000336 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000337#define date_full_usage \
338 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000339 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000340 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000341 "\t-d STRING\tDisplays time described by STRING, not `now'\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000342USE_FEATURE_DATE_ISOFMT( \
343 "\t-I[TIMESPEC]\tOutputs an ISO-8601 compliant date/time string\n" \
344 "\t\t\tTIMESPEC=`date' (or missing) for date only,\n" \
345 "\t\t\t`hours', `minutes', or `seconds' for date and,\n" \
346 "\t\t\ttime to the indicated precision\n" \
347 "\t-D hint\t\tUse 'hint' as date format, via strptime()\n" \
348) \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000349 "\t-s\t\tSets time described by STRING\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000350 "\t-r FILE\t\tDisplays the last modification time of FILE\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000351 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000352#define date_example_usage \
353 "$ date\n" \
354 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000355
Eric Andersen7e9276b2001-02-22 01:15:47 +0000356#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000357 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000358#define dc_full_usage \
359 "This is a Tiny RPN calculator that understands the\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000360 "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \
Eric Andersena9287742003-10-22 11:24:39 +0000361 "**, exp, and, or, not, eor.\n" \
362 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16.\n" \
363 "\nOptions:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000364 "p - Prints the value on the top of the stack, without altering the stack\n" \
365 "f - Prints the entire contents of the stack without altering anything\n" \
366 "o - Pops the value off the top of the stack and uses it to set the output radix\n" \
367 " Only 10 and 16 are supported"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000368#define dc_example_usage \
Eric Andersen9ab46572004-08-18 17:57:16 +0000369 "$ dc 2 2 + p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000370 "4\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000371 "$ dc 8 8 \\* 2 2 + / p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000372 "16\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000373 "$ dc 0 1 and p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000374 "0\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000375 "$ dc 0 1 or p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000376 "1\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000377 "$ echo 72 9 div 8 mul p | dc\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000378 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000379
Eric Andersen7e9276b2001-02-22 01:15:47 +0000380#define dd_trivial_usage \
Rob Landley2686d3b2006-05-16 16:52:12 +0000381 "[if=FILE] [of=FILE] " USE_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
382 "\t [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync]")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000383#define dd_full_usage \
384 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000385 "\tif=FILE\t\tread from FILE instead of stdin\n" \
386 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
387 "\tbs=N\t\tread and write N bytes at a time\n" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000388 USE_FEATURE_DD_IBS_OBS("\tibs=N\t\tread N bytes at a time\n") \
389 USE_FEATURE_DD_IBS_OBS("\tobs=N\t\twrite N bytes at a time\n") \
Eric Andersena0cfe942001-02-23 10:07:09 +0000390 "\tcount=N\t\tcopy only N input blocks\n" \
391 "\tskip=N\t\tskip N input blocks\n" \
392 "\tseek=N\t\tskip N output blocks\n" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000393 USE_FEATURE_DD_IBS_OBS( \
394 "\tconv=notrunc\tdon't truncate output file\n" \
395 "\tconv=noerror\tcontinue after read errors\n" \
396 "\tconv=sync\tpad blocks with zeros\n" \
397 ) \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000398 "\n" \
399 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000400 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000401#define dd_example_usage \
402 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
403 "4+0 records in\n" \
404 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000405
Eric Andersen7e9276b2001-02-22 01:15:47 +0000406#define deallocvt_trivial_usage \
Glenn L McGrath17b4a202004-01-15 11:50:19 +0000407 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000408#define deallocvt_full_usage \
409 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000410
Eric Andersenf349e972001-08-21 16:18:59 +0000411#define delgroup_trivial_usage \
412 "GROUP"
413#define delgroup_full_usage \
414 "Deletes group GROUP from the system"
415
416#define deluser_trivial_usage \
417 "USER"
418#define deluser_full_usage \
419 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000420
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000421#define devfsd_trivial_usage \
Mike Frysingerb8d00462005-08-17 01:20:10 +0000422 "mntpnt [-v]" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000423 USE_DEVFSD_FG_NP("[-fg][-np]" )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000424#define devfsd_full_usage \
Mike Frysingerb8d00462005-08-17 01:20:10 +0000425 "Optional daemon for managing devfs permissions and old device name symlinks.\n" \
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000426 "\nOptions:\n" \
427 "\tmntpnt\tThe mount point where devfs is mounted.\n\n" \
428 "\t-v\tPrint the protocol version numbers for devfsd\n" \
Eric Andersenf18bd892003-12-19 11:07:59 +0000429 "\t\tand the kernel-side protocol version and exits." \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000430 USE_DEVFSD_FG_NP( "\n\n\t-fg\tRun the daemon in the foreground.\n\n" \
Eric Andersenf18bd892003-12-19 11:07:59 +0000431 "\t-np\tExit after parsing the configuration file\n" \
432 "\t\tand processing synthetic REGISTER events.\n" \
433 "\t\tDo not poll for events.")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000434
Eric Andersen7e9276b2001-02-22 01:15:47 +0000435#define df_trivial_usage \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000436 "[-" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000437#define df_full_usage \
438 "Print the filesystem space used and space available.\n\n" \
439 "Options:\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000440 USE_FEATURE_HUMAN_READABLE( \
441 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
442 "\t-m\tprint sizes in megabytes\n" \
443 "\t-k\tprint sizes in kilobytes(default)" \
444 ) \
445 SKIP_FEATURE_HUMAN_READABLE("\n\t-k\tignored")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000446#define df_example_usage \
447 "$ df\n" \
448 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
449 "/dev/sda3 8690864 8553540 137324 98% /\n" \
450 "/dev/sda1 64216 36364 27852 57% /boot\n" \
451 "$ df /dev/sda3\n" \
452 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
453 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000454
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000455#define diff_trivial_usage \
Bernhard Reutner-Fischerbc142142006-04-06 16:07:08 +0000456 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000457#define diff_full_usage \
458 "Compare files line by line and output the differences between them.\n" \
459 "This diff implementation only supports unified diffs.\n\n" \
460 "Options:\n" \
461 "\t-a\tTreat all files as text\n" \
462 "\t-b\tIgnore changes in the amount of whitespace\n" \
463 "\t-d\tTry hard to find a smaller set of changes\n" \
464 "\t-i\tIgnore case differences\n" \
Bernhard Reutner-Fischerbc142142006-04-06 16:07:08 +0000465 "\t-L\tUse LABEL instead of the filename in the unified header\n" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000466 "\t-N\tTreat absent files as empty\n" \
467 "\t-q\tOutput only whether files differ\n" \
468 "\t-r\tRecursively compare any subdirectories\n" \
469 "\t-S\tStart with FILE when comparing directories\n" \
470 "\t-T\tMake tabs line up by prefixing a tab when necessary\n" \
471 "\t-s\tReport when two files are the same\n" \
472 "\t-t\tExpand tabs to spaces in output\n" \
473 "\t-U\tOutput LINES lines of context\n" \
474 "\t-w\tIgnore all whitespace\n"
475
Eric Andersen7e9276b2001-02-22 01:15:47 +0000476#define dirname_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000477 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000478#define dirname_full_usage \
479 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000480#define dirname_example_usage \
481 "$ dirname /tmp/foo\n" \
482 "/tmp\n" \
483 "$ dirname /tmp/foo/\n" \
484 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000485
Eric Andersen7e9276b2001-02-22 01:15:47 +0000486#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000487 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000488#define dmesg_full_usage \
489 "Prints or controls the kernel ring buffer\n\n" \
490 "Options:\n" \
491 "\t-c\t\tClears the ring buffer's contents after printing\n" \
492 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000493 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000494
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000495#define dnsd_trivial_usage \
496 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
497#define dnsd_full_usage \
498 "Small and static DNS server daemon\n\n" \
499 "Options:\n" \
500 "\t-c\t\tconfig filename\n" \
501 "\t-t\t\tTTL in seconds\n" \
502 "\t-p\t\tlistening port\n" \
503 "\t-i\t\tlistening iface ip (default all)\n" \
504 "\t-d\t\tdaemonize"
505
Eric Andersen7e9276b2001-02-22 01:15:47 +0000506#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000507 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000508#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000509 "Converts FILE from dos format to unix format. When no option\n" \
510 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000511 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000512 "Options:\n" \
513 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000514 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000515
Eric Andersen7e9276b2001-02-22 01:15:47 +0000516#define dpkg_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000517 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000518#define dpkg_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000519 "dpkg is a utility to install, remove and manage Debian packages.\n\n" \
520 "Options:\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000521 "\t-i\t\tInstall the package\n" \
522 "\t-l\t\tList of installed packages\n" \
523 "\t-C\t\tConfigure an unpackaged package\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +0000524 "\t-F depends\tIgnore dependency problems\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000525 "\t-P\t\tPurge all files of a package\n" \
526 "\t-r\t\tRemove all but the configuration files for a package\n" \
527 "\t-u\t\tUnpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000528
Eric Andersen7e9276b2001-02-22 01:15:47 +0000529#define dpkg_deb_trivial_usage \
Glenn L McGrathcbc453c2004-05-02 03:01:08 +0000530 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000531#define dpkg_deb_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000532 "Perform actions on Debian packages (.debs)\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000533 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000534 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000535 "\t-e\tExtract control files to [argument] directory\n" \
536 "\t-f\tDisplay control field name starting with [argument]\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000537 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000538 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000539#define dpkg_deb_example_usage \
540 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000541
Eric Andersen7e9276b2001-02-22 01:15:47 +0000542#define du_trivial_usage \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000543 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000544#define du_full_usage \
545 "Summarizes disk space used for each FILE and/or directory.\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000546 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000547 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
548 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000549 " bytes.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000550 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000551 "\t-a\tshow sizes of files in addition to directories\n" \
552 "\t-H\tfollow symbolic links that are FILE command line args\n" \
553 "\t-L\tfollow all symbolic links encountered\n" \
554 "\t-d N\tlimit output to directories (and files with -a) of depth < N\n" \
555 "\t-c\toutput a grand total\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000556 "\t-l\tcount sizes many times if hard linked\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000557 "\t-s\tdisplay only a total for each argument\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000558 "\t-x\tskip directories on different filesystems\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000559 USE_FEATURE_HUMAN_READABLE( \
560 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
561 "\t-m\tprint sizes in megabytes\n" \
562 ) \
563 "\t-k\tprint sizes in kilobytes" \
564 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000565#define du_example_usage \
566 "$ du\n" \
567 "16 ./CVS\n" \
568 "12 ./kernel-patches/CVS\n" \
569 "80 ./kernel-patches\n" \
570 "12 ./tests/CVS\n" \
571 "36 ./tests\n" \
572 "12 ./scripts/CVS\n" \
573 "16 ./scripts\n" \
574 "12 ./docs/CVS\n" \
575 "104 ./docs\n" \
576 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000577
Eric Andersen7e9276b2001-02-22 01:15:47 +0000578#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000579 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000580#define dumpkmap_full_usage \
581 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000582#define dumpkmap_example_usage \
583 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000584
Russ Dill61fb4892002-10-14 21:41:28 +0000585#define dumpleases_trivial_usage \
586 "[-r|-a] [-f LEASEFILE]"
587#define dumpleases_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000588 "Displays the DHCP leases granted by udhcpd.\n\n" \
589 "Options:\n" \
Russ Dill61fb4892002-10-14 21:41:28 +0000590 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +0000591 "\t-r,\t--remaining\tInterpret lease times as time remaining\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +0000592 "\t-a,\t--absolute\tInterpret lease times as expire time"
Russ Dill61fb4892002-10-14 21:41:28 +0000593
Mike Frysinger51a43b42005-09-24 07:11:16 +0000594#define e2fsck_trivial_usage \
595 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
596 "[-I inode_buffer_blocks] [-P process_inode_size] " \
Mike Frysinger874af852006-03-08 07:03:27 +0000597 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
Mike Frysinger51a43b42005-09-24 07:11:16 +0000598 "[-E extended-options] device"
599#define e2fsck_full_usage \
600 "Check a Linux ext2/ext3 file system.\n\n" \
601 "Options:\n" \
602 "\t-p\tAutomatic repair (no questions)\n" \
603 "\t-n\tMake no changes to the filesystem\n" \
604 "\t-y\tAssume 'yes' to all questions\n" \
605 "\t-c\tCheck for bad blocks and add them to the badblock list\n" \
606 "\t-f\tForce checking even if filesystem is marked clean\n" \
607 "\t-v\tBe verbose\n" \
608 "\t-b superblock\tUse alternative superblock\n" \
609 "\t-B blocksize\tForce blocksize when looking for superblock\n" \
610 "\t-j journal\tSet location of the external journal\n" \
611 "\t-l file\tAdd to badblocks list\n" \
612 "\t-L file\tSet badblocks list"
613
Eric Andersen7e9276b2001-02-22 01:15:47 +0000614#define echo_trivial_usage \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000615 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000616#define echo_full_usage \
617 "Prints the specified ARGs to stdout\n\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000618 USE_FEATURE_FANCY_ECHO( \
619 "Options:\n" \
620 "\t-n\tsuppress trailing newline\n" \
621 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
622 "\t-E\tdisable interpretation of backslash-escaped characters" \
623 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000624#define echo_example_usage \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000625 "$ echo \"Erik is cool\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000626 "Erik is cool\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000627 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000628 "Erik\n" \
629 "is\n" \
630 "cool\n" \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000631 "$ echo \"Erik\\nis\\ncool\"\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000632 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000633
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000634#define eject_trivial_usage \
635 "[-t] [DEVICE]"
636#define eject_full_usage \
637 "Eject specified DEVICE (or default /dev/cdrom).\n\n" \
638 "Options:\n" \
Rob Landley9ea88362005-05-14 00:46:18 +0000639 "\t-t\tclose tray"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000640
Rob Landley3b890392006-05-04 20:56:43 +0000641#define ed_trivial_usage ""
642#define ed_full_usage ""
643
Eric Andersen84e229c2001-03-29 22:48:33 +0000644#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000645 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000646#define env_full_usage \
647 "Prints the current environment or runs a program after setting\n" \
648 "up the specified environment.\n\n" \
649 "Options:\n" \
650 "\t-, -i\tstart with an empty environment\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000651 "\t-u\tremove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000652
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000653#define ether_wake_trivial_usage \
654 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
655#define ether_wake_full_usage \
656 "Send a magic packet to wake up sleeping machines.\n" \
657 "MAC must be a station address (00:11:22:33:44:55) or\n" \
658 " a hostname with a known 'ethers' entry.\n\n" \
659 "Options:\n" \
660 "\t-b\t\tSend wake-up packet to the broadcast address\n" \
661 "\t-i iface\tUse interface ifname instead of the default \"eth0\"\n" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +0000662 "\t-p pass\tAppend the four or six byte password PW to the packet"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000663
Eric Andersen7e9276b2001-02-22 01:15:47 +0000664#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000665 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000666#define expr_full_usage \
667 "Prints the value of EXPRESSION to standard output.\n\n" \
668 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000669 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
670 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
671 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
672 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
673 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
674 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
675 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
676 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
677 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
678 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
679 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
680 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
681 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000682 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
683 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
684 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
685 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
686 "\t or 0\n" \
687 "\tlength STRING length of STRING\n" \
688 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
689 "\t it is a keyword like `match' or an\n" \
690 "\t operator like `/'\n" \
691 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000692 "Beware that many operators need to be escaped or quoted for shells.\n" \
693 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
694 "lexicographical. Pattern matches return the string matched between \n" \
695 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
696 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000697
Mike Frysingerfa69f112005-04-17 07:24:19 +0000698#define fakeidentd_trivial_usage \
699 "[-b ip] [STRING]"
700#define fakeidentd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +0000701 "Returns a set string to auth requests\n\n" \
702 "\t-b\tBind to ip address\n" \
Mike Frysingerfa69f112005-04-17 07:24:19 +0000703 "\tSTRING\tThe ident answer string (default is nobody)"
704
Eric Andersen7e9276b2001-02-22 01:15:47 +0000705#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000706 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000707#define false_full_usage \
708 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000709#define false_example_usage \
710 "$ false\n" \
711 "$ echo $?\n" \
712 "1\n"
713
714#define fbset_trivial_usage \
715 "[options] [mode]"
716#define fbset_full_usage \
717 "Show and modify frame buffer settings"
718#define fbset_example_usage \
719 "$ fbset\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000720 "mode \"1024x768-76\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000721 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
722 "\tgeometry 1024 768 1024 768 16\n" \
723 "\ttimings 12714 128 32 16 4 128 4\n" \
724 "\taccel false\n" \
725 "\trgba 5/11,6/5,5/0,0/0\n" \
726 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000727
Eric Andersen7e9276b2001-02-22 01:15:47 +0000728#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000729 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000730#define fdflush_full_usage \
731 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000732
Eric Andersen01c3d402003-07-05 07:51:31 +0000733#define fdformat_trivial_usage \
734 "[-n] DEVICE"
735#define fdformat_full_usage \
736 "Low-level formats a floppy disk\n\n" \
737 "Options:\n" \
738 "\t-n\tDon't verify after format"
739
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000740#define fdisk_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000741 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000742#define fdisk_full_usage \
743 "Change partition table\n" \
744 "Options:\n" \
Eric Andersena151d192004-04-06 17:16:36 +0000745 "\t-l List partition table(s)\n" \
746 "\t-u Give Start and End in sector (instead of cylinder) units\n" \
747 "\t-s PARTITION Give partition size(s) in blocks\n" \
748 "\t-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000749 "\t-C CYLINDERS Set the number of cylinders\n" \
750 "\t-H HEADS Set the number of heads\n" \
751 "\t-S SECTORS Set the number of sectors\n" \
Eric Andersena151d192004-04-06 17:16:36 +0000752 "\t-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000753
Eric Andersen7e9276b2001-02-22 01:15:47 +0000754#define find_trivial_usage \
755 "[PATH...] [EXPRESSION]"
756#define find_full_usage \
757 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000758 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000759 "\nEXPRESSION may consist of:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000760 "\t-follow\t\tDereference symbolic links\n" \
761 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN\n" \
762 "\t-print\t\tPrint (default and assumed)\n" \
Paul Foxd7384292006-05-12 14:47:20 +0000763 USE_FEATURE_FIND_PRINT0( \
764 "\t-print0\t\tDelimit output with null characters rather than\n\t\t\tnewlines" \
765) USE_FEATURE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000766 "\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 +0000767) USE_FEATURE_FIND_PERM( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000768 "\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 +0000769) USE_FEATURE_FIND_MTIME( \
Paul Fox72d1a232006-01-13 21:05:41 +0000770 "\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 +0000771) USE_FEATURE_FIND_MMIN( \
Paul Fox72d1a232006-01-13 21:05:41 +0000772 "\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 +0000773) USE_FEATURE_FIND_NEWER( \
Eric Andersen97d86f22003-01-23 05:27:42 +0000774 "\n\t-newer FILE\tModified time is more recent than FILE's" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000775) USE_FEATURE_FIND_INUM( \
Rob Landley5d3a0e82005-10-04 03:34:39 +0000776 "\n\t-inum N\t\tFile has inode number N" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000777) USE_FEATURE_FIND_EXEC( \
Rob Landley5d3a0e82005-10-04 03:34:39 +0000778 "\n\t-exec CMD\tExecute CMD with all instances of {} replaced by the" \
779 "\n\t\t\tfiles matching EXPRESSION")
780
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000781#define find_example_usage \
Eric Andersen75eb90f2004-03-29 08:20:08 +0000782 "$ find / -name passwd\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000783 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000784
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000785#define fold_trivial_usage \
Glenn L McGrath0bd02572005-12-11 03:09:05 +0000786 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000787#define fold_full_usage \
788 "Wrap input lines in each FILE (standard input by default), writing to\n" \
789 "standard output.\n\n" \
790 "Options:\n" \
791 "\t-b\tcount bytes rather than columns\n" \
792 "\t-s\tbreak at spaces\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000793 "\t-w\tuse WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000794
Eric Andersen7e9276b2001-02-22 01:15:47 +0000795#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000796 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000797#define free_full_usage \
798 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000799#define free_example_usage \
800 "$ free\n" \
801 " total used free shared buffers\n" \
802 " Mem: 257628 248724 8904 59644 93124\n" \
803 " Swap: 128516 8404 120112\n" \
804 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000805
Eric Andersen7e9276b2001-02-22 01:15:47 +0000806#define freeramdisk_trivial_usage \
807 "DEVICE"
808#define freeramdisk_full_usage \
809 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000810#define freeramdisk_example_usage \
811 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000812
Mike Frysinger51a43b42005-09-24 07:11:16 +0000813#define fsck_trivial_usage \
814 "[-ANPRTV] [ -C [ fd ] ] [-t fstype] [fs-options] [filesys ...]"
815#define fsck_full_usage \
816 "Check and repair filesystems.\n\n" \
817 "Options:\n" \
818 "\t-A\tWalk /etc/fstab and check all filesystems\n" \
819 "\t-N\tDon't execute, just show what would be done\n" \
820 "\t-P\tWhen using -A, check filesystems in parallel\n" \
821 "\t-R\tWhen using -A, skip the root filesystem\n" \
822 "\t-T\tDon't show title on startup\n" \
823 "\t-V\tVerbose mode\n" \
824 "\t-C\tWrite status information to specified filedescriptor\n" \
825 "\t-t\tList of filesystem types to check"
826
Eric Andersen7e9276b2001-02-22 01:15:47 +0000827#define fsck_minix_trivial_usage \
828 "[-larvsmf] /dev/name"
829#define fsck_minix_full_usage \
830 "Performs a consistency check for MINIX filesystems.\n\n" \
831 "Options:\n" \
832 "\t-l\tLists all filenames\n" \
833 "\t-r\tPerform interactive repairs\n" \
834 "\t-a\tPerform automatic repairs\n" \
835 "\t-v\tverbose\n" \
836 "\t-s\tOutputs super-block information\n" \
837 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000838 "\t-f\tForce file system check"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000839
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000840#define ftpget_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000841 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000842#define ftpget_full_usage \
843 "Retrieve a remote file via FTP.\n\n" \
844 "Options:\n" \
845 "\t-c, --continue Continue a previous transfer\n" \
846 "\t-v, --verbose Verbose\n" \
847 "\t-u, --username Username to be used\n" \
848 "\t-p, --password Password to be used\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000849 "\t-P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000850
851#define ftpput_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000852 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000853#define ftpput_full_usage \
854 "Store a local file on a remote machine via FTP.\n\n" \
855 "Options:\n" \
856 "\t-v, --verbose Verbose\n" \
857 "\t-u, --username Username to be used\n" \
858 "\t-p, --password Password to be used\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000859 "\t-P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000860
Rob Landleyaa872762005-10-28 13:05:12 +0000861#define fuser_trivial_usage \
862 "[options] file OR port/proto"
863#define fuser_full_usage \
864 "Options:\n" \
865 "\t-m Show all processes on the same mounted fs\n" \
866 "\t-k Kill all processes that match.\n" \
867 "\t-s Don't print or kill anything.\n" \
868 "\t-4 When using port/proto only search IPv4 space\n" \
869 "\t-6 When using port/proto only search IPv6 space\n" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +0000870 "\t-SIGNAL When used with -k, this signal will be used to kill"
871
Eric Andersen7e9276b2001-02-22 01:15:47 +0000872#define getopt_trivial_usage \
873 "[OPTIONS]..."
874#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000875 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000876 "\t-a, --alternative Allow long options starting with single -\n" \
877 "\t-l, --longoptions=longopts Long options to be recognized\n" \
878 "\t-n, --name=progname The name under which errors are reported\n" \
879 "\t-o, --options=optstring Short options to be recognized\n" \
880 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
881 "\t-Q, --quiet-output No normal output\n" \
882 "\t-s, --shell=shell Set shell quoting conventions\n" \
883 "\t-T, --test Test for getopt(1) version\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000884 "\t-u, --unquoted Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000885#define getopt_example_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000886 "$ cat getopt.test\n" \
887 "#!/bin/sh\n" \
888 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
889 " -n 'example.busybox' -- \"$@\"`\n" \
890 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000891 "eval set -- \"$GETOPT\"\n" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000892 "while true ; do\n" \
893 " case $1 in\n" \
894 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
895 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
896 " -c|--c-long)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000897 " case \"$2\" in\n" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000898 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
899 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
900 " esac ;;\n" \
901 " --) shift ; break ;;\n" \
902 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
903 " esac\n" \
904 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000905
Eric Andersenf349e972001-08-21 16:18:59 +0000906#define getty_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000907 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +0000908#define getty_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +0000909 "Opens a tty, prompts for a login name, then invokes /bin/login\n\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000910 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000911 "\t-h\t\tEnable hardware (RTS/CTS) flow control\n" \
912 "\t-i\t\tDo not display /etc/issue before running login\n" \
913 "\t-L\t\tLocal line, so do not do carrier detect\n" \
914 "\t-m\t\tGet baud rate from modem's CONNECT status message\n" \
915 "\t-w\t\tWait for a CR or LF before sending /etc/issue\n" \
916 "\t-n\t\tDo not prompt the user for a login name\n" \
917 "\t-f issue_file\tDisplay issue_file instead of /etc/issue\n" \
918 "\t-l login_app\tInvoke login_app instead of /bin/login\n" \
919 "\t-t timeout\tTerminate after timeout if no username is read\n" \
920 "\t-I initstring\tSets the init string to send before anything else\n" \
921 "\t-H login_host\tLog login_host into the utmp file as the hostname"
Eric Andersenf349e972001-08-21 16:18:59 +0000922
Eric Andersen7e9276b2001-02-22 01:15:47 +0000923#define grep_trivial_usage \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000924 "[-ihHnqvs" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000925 USE_FEATURE_GREP_EGREP_ALIAS("E") \
926 USE_FEATURE_GREP_CONTEXT("ABC") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000927 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000928#define grep_full_usage \
929 "Search for PATTERN in each FILE or standard input.\n\n" \
930 "Options:\n" \
931 "\t-H\tprefix output lines with filename where match was found\n" \
932 "\t-h\tsuppress the prefixing filename on output\n" \
933 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000934 "\t-l\tlist names of files that match\n" \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000935 "\t-L\tlist names of files that do not match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000936 "\t-n\tprint line number with output lines\n" \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000937 "\t-q\tbe quiet. Returns 0 if PATTERN was found, 1 otherwise\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000938 "\t-v\tselect non-matching lines\n" \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000939 "\t-s\tsuppress file open/read error messages\n" \
940 "\t-c\tonly print count of matching lines\n" \
941 "\t-f\tread PATTERN from file\n" \
942 "\t-e\tPATTERN is a regular expression\n" \
943 "\t-F\tPATTERN is a set of newline-separated strings" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000944 USE_FEATURE_GREP_EGREP_ALIAS("\n\t-E\tPATTERN is an extended regular expression") \
945 USE_FEATURE_GREP_CONTEXT("\n\t-A\tprint NUM lines of trailing context") \
946 USE_FEATURE_GREP_CONTEXT("\n\t-B\tprint NUM lines of leading context") \
947 USE_FEATURE_GREP_CONTEXT("\n\t-C\tprint NUM lines of output context")
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000948
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000949#define grep_example_usage \
950 "$ grep root /etc/passwd\n" \
951 "root:x:0:0:root:/root:/bin/bash\n" \
952 "$ grep ^[rR]oo. /etc/passwd\n" \
953 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000954
Eric Andersen7e9276b2001-02-22 01:15:47 +0000955#define gunzip_trivial_usage \
956 "[OPTION]... FILE"
957#define gunzip_full_usage \
958 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
959 "Options:\n" \
960 "\t-c\tWrite output to standard output\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000961 "\t-f\tForce read when source is a terminal\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000962 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000963#define gunzip_example_usage \
964 "$ ls -la /tmp/BusyBox*\n" \
965 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
966 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
967 "$ ls -la /tmp/BusyBox*\n" \
968 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000969
970#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000971 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000972#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000973 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +0000974 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000975 "Options:\n" \
976 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000977 "\t-d\tDecompress\n" \
978 "\t-f\tForce write when destination is a terminal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000979#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000980 "$ ls -la /tmp/busybox*\n" \
981 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
982 "$ gzip /tmp/busybox.tar\n" \
983 "$ ls -la /tmp/busybox*\n" \
984 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000985
986#define halt_trivial_usage \
Rob Landley64612912006-01-30 08:31:37 +0000987 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000988#define halt_full_usage \
Glenn L McGrathd2501672004-07-23 05:16:17 +0000989 "Halt the system.\n" \
990 "Options:\n" \
Rob Landley64612912006-01-30 08:31:37 +0000991 "\t-d\t\tdelay interval for halting\n" \
992 "\t-n\t\tno call to sync()\n" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +0000993 "\t-f\t\tforce halt (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000994
Eric Andersen3443bd72003-07-22 07:30:36 +0000995#define hdparm_trivial_usage \
996 "[options] [device] .."
997#define hdparm_full_usage \
Rob Landley6d8ce172006-06-07 21:22:42 +0000998 USE_FEATURE_HDPARM_GET_IDENTITY("\tIf no device name is specified try to read from stdin.\n") \
Rob Landley06208412006-05-31 22:52:57 +0000999 "\nOptions:\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001000 "\t-a get/set fs readahead\n" \
1001 "\t-A set drive read-lookahead flag (0/1)\n" \
1002 "\t-b get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
1003 "\t-B set Advanced Power Management setting (1-255)\n" \
1004 "\t-c get/set IDE 32-bit IO setting\n" \
1005 "\t-C check IDE power mode status\n" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001006 USE_FEATURE_HDPARM_HDIO_GETSET_DMA("\t-d get/set using_dma flag\n") \
Eric Andersen15c03c32004-04-06 17:52:02 +00001007 "\t-D enable/disable drive defect-mgmt\n" \
1008 "\t-f flush buffer cache for device on exit\n" \
1009 "\t-g display drive geometry\n" \
1010 "\t-h display terse usage information\n" \
Rob Landley06208412006-05-31 22:52:57 +00001011 USE_FEATURE_HDPARM_GET_IDENTITY("\t-i display drive identification\n") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001012 USE_FEATURE_HDPARM_GET_IDENTITY("\t-I detailed/current information directly from drive\n") \
Eric Andersen15c03c32004-04-06 17:52:02 +00001013 "\t-k get/set keep_settings_over_reset flag (0/1)\n" \
1014 "\t-K set drive keep_features_over_reset flag (0/1)\n" \
1015 "\t-L set drive doorlock (0/1) (removable harddisks only)\n" \
1016 "\t-m get/set multiple sector count\n" \
1017 "\t-n get/set ignore-write-errors flag (0/1)\n" \
1018 "\t-p set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
1019 "\t-P set drive prefetch count\n" \
1020 "\t-q change next setting quietly\n" \
1021 "\t-Q get/set DMA tagged-queuing depth (if supported)\n" \
1022 "\t-r get/set readonly flag (DANGEROUS to set)\n" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001023 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF("\t-R register an IDE interface (DANGEROUS)\n") \
Eric Andersen15c03c32004-04-06 17:52:02 +00001024 "\t-S set standby (spindown) timeout\n" \
1025 "\t-t perform device read timings\n" \
1026 "\t-T perform cache read timings\n" \
1027 "\t-u get/set unmaskirq flag (0/1)\n" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001028 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF("\t-U un-register an IDE interface (DANGEROUS)\n") \
Eric Andersen15c03c32004-04-06 17:52:02 +00001029 "\t-v defaults; same as -mcudkrag for IDE drives\n" \
1030 "\t-V display program version and exit immediately\n" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001031 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET("\t-w perform device reset (DANGEROUS)\n") \
Eric Andersen15c03c32004-04-06 17:52:02 +00001032 "\t-W set drive write-caching flag (0/1) (DANGEROUS)\n" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001033 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF("\t-x tristate device for hotswap (0/1) (DANGEROUS)\n") \
Eric Andersen15c03c32004-04-06 17:52:02 +00001034 "\t-X set IDE xfer mode (DANGEROUS)\n" \
1035 "\t-y put IDE drive in standby mode\n" \
1036 "\t-Y put IDE drive to sleep\n" \
1037 "\t-Z disable Seagate auto-powersaving mode\n" \
1038 "\t-z re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +00001039
Eric Andersen7e9276b2001-02-22 01:15:47 +00001040#define head_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +00001041 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001042#define head_full_usage \
1043 "Print first 10 lines of each FILE to standard output.\n" \
1044 "With more than one FILE, precede each with a header giving the\n" \
1045 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001046 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001047 "\t-n NUM\t\tPrint first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001048 USE_FEATURE_FANCY_HEAD( \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001049 "\n\t-c NUM\t\toutput the first NUM bytes\n" \
1050 "\t-q\t\tnever output headers giving file names\n" \
1051 "\t-v\t\talways output headers giving file names" )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001052#define head_example_usage \
1053 "$ head -n 2 /etc/passwd\n" \
1054 "root:x:0:0:root:/root:/bin/bash\n" \
1055 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001056
Glenn L McGrath60281112001-11-02 11:39:46 +00001057#define hexdump_trivial_usage \
Paul Fox969af892005-11-28 21:06:00 +00001058 "[-[bcCdefnosvx]] [OPTION] FILE"
Glenn L McGrath60281112001-11-02 11:39:46 +00001059#define hexdump_full_usage \
1060 "The hexdump utility is a filter which displays the specified files,\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001061 "or the standard input, if no files are specified, in a user specified\n" \
Glenn L McGrath60281112001-11-02 11:39:46 +00001062 "format\n" \
1063 "\t-b\t\tOne-byte octal display\n" \
1064 "\t-c\t\tOne-byte character display\n" \
Paul Fox969af892005-11-28 21:06:00 +00001065 "\t-C\t\tCanonical hex+ASCII, 16 bytes per line\n" \
Glenn L McGrath60281112001-11-02 11:39:46 +00001066 "\t-d\t\tTwo-byte decimal display\n" \
1067 "\t-e FORMAT STRING\n" \
1068 "\t-f FORMAT FILE\n" \
1069 "\t-n LENGTH\tInterpret only length bytes of input\n" \
1070 "\t-o\t\tTwo-byte octal display\n" \
1071 "\t-s OFFSET\tSkip offset byte\n" \
1072 "\t-v\t\tdisplay all input data\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001073 "\t-x\t\tTwo-byte hexadecimal display"
Glenn L McGrath60281112001-11-02 11:39:46 +00001074
Eric Andersen7e9276b2001-02-22 01:15:47 +00001075#define hostid_trivial_usage \
1076 ""
1077#define hostid_full_usage \
1078 "Print out a unique 32-bit identifier for the machine."
1079
1080#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001081 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001082#define hostname_full_usage \
1083 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001084 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001085 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +00001086 "\t-s\tShort\n" \
1087 "\t-i\tAddresses for the hostname\n" \
1088 "\t-d\tDNS domain name\n" \
1089 "\t-f\tFully qualified domain name\n" \
1090 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001091#define hostname_example_usage \
1092 "$ hostname\n" \
Eric Andersen08f59e32004-03-12 22:07:10 +00001093 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001094
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001095#define httpd_trivial_usage \
Eric Andersen40520512003-07-28 09:59:05 +00001096 "[-c <conf file>]" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001097 USE_FEATURE_HTTPD_WITHOUT_INETD(" [-p <port>]") \
1098 USE_FEATURE_HTTPD_SETUID(" [-u user]") \
1099 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
1100 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Eric Andersen73afd892004-04-14 17:59:21 +00001101 " [-h home]" \
Eric Andersen40520512003-07-28 09:59:05 +00001102 " [-d/-e <string>]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001103#define httpd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001104 "Listens for incoming http server requests.\n\n" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001105 "Options:\n" \
1106 "\t-c FILE\t\tSpecifies configuration file. (default httpd.conf)\n" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001107 USE_FEATURE_HTTPD_WITHOUT_INETD("\t-p PORT\tServer port (default 80)\n") \
1108 USE_FEATURE_HTTPD_SETUID("\t-u USER\tSet uid to USER after listening privileges port\n") \
1109 USE_FEATURE_HTTPD_BASIC_AUTH("\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
1110 USE_FEATURE_HTTPD_AUTH_MD5("\t-m PASS\t\tCrypt PASS with md5 algorithm\n") \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001111 "\t-h HOME \tSpecifies http HOME directory (default ./)\n" \
1112 "\t-e STRING\tHtml encode STRING\n" \
1113 "\t-d STRING\tURL decode STRING"
Eric Andersen40520512003-07-28 09:59:05 +00001114
Robert Griebl1cd04452002-07-21 16:50:49 +00001115#define hwclock_trivial_usage \
1116 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
1117#define hwclock_full_usage \
1118 "Query and set the hardware clock (RTC)\n\n" \
1119 "Options:\n" \
1120 "\t-r\tread hardware clock and print result\n" \
1121 "\t-s\tset the system time from the hardware clock\n" \
1122 "\t-w\tset the hardware clock to the current system time\n" \
1123 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
1124 "\t-l\tthe hardware clock is kept in local time"
1125
Eric Andersen9e480452003-07-03 10:07:04 +00001126#ifdef CONFIG_SELINUX
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001127# define USAGE_SELINUX(a) a
Eric Andersen9e480452003-07-03 10:07:04 +00001128#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001129# define USAGE_SELINUX(a)
Eric Andersen9e480452003-07-03 10:07:04 +00001130#endif
1131
Eric Andersen7e9276b2001-02-22 01:15:47 +00001132#define id_trivial_usage \
1133 "[OPTIONS]... [USERNAME]"
1134#define id_full_usage \
1135 "Print information for USERNAME or the current user\n\n" \
1136 "Options:\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001137 USAGE_SELINUX("\t-c\tprints only the security context\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001138 "\t-g\tprints only the group ID\n" \
1139 "\t-u\tprints only the user ID\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001140 "\t-n\tprint a name instead of a number\n" \
1141 "\t-r\tprints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001142#define id_example_usage \
1143 "$ id\n" \
1144 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001145
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001146#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001147# define USAGE_SIOCSKEEPALIVE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001148#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001149# define USAGE_SIOCSKEEPALIVE(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001150#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001151#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001152# define USAGE_IFCONFIG_MII(a) a
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001153#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001154# define USAGE_IFCONFIG_MII(a)
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001155#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001156#ifdef CONFIG_FEATURE_IFCONFIG_HW
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001157# define USAGE_IFCONFIG_HW(a) a
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001158#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001159# define USAGE_IFCONFIG_HW(a)
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001160#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001161#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001162# define USAGE_IFCONFIG_OPT_A(a) a
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001163#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001164# define USAGE_IFCONFIG_OPT_A(a)
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001165#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +00001166#ifdef CONFIG_FEATURE_IPV6
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001167# define USAGE_IPV6(a) a
Eric Andersen51b8bd62002-07-03 11:46:38 +00001168#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001169# define USAGE_IPV6(a)
Eric Andersen51b8bd62002-07-03 11:46:38 +00001170#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001171
Eric Andersen7e9276b2001-02-22 01:15:47 +00001172#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001173 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001174#define ifconfig_full_usage \
1175 "configure a network interface\n\n" \
1176 "Options:\n" \
Mike Frysingercf89c372006-05-19 16:14:31 +00001177 USAGE_IPV6("\t[add <address>[/<prefixlen>]]\n") \
1178 USAGE_IPV6("\t[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001179 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001180 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001181 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001182 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001183 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001184 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001185 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
1186 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001187 "\t[up|down] ..."
1188
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001189#define ifup_trivial_usage \
1190 "<-ahinv> <ifaces...>"
1191#define ifup_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001192 "ifup <options> <ifaces...>\n\n" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001193 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001194 "\t-h\tthis help\n" \
1195 "\t-a\tde/configure all interfaces automatically\n" \
1196 "\t-i FILE\tuse FILE for interface definitions\n" \
1197 "\t-n\tprint out what would happen, but don't do it\n" \
1198 "\t\t\t(note that this option doesn't disable mappings)\n" \
1199 "\t-v\tprint out what would happen before doing it\n" \
1200 "\t-m\tdon't run any mappings\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001201 "\t-f\tforce de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001202
1203#define ifdown_trivial_usage \
1204 "<-ahinv> <ifaces...>"
1205#define ifdown_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001206 "ifdown <options> <ifaces...>\n\n" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001207 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001208 "\t-h\tthis help\n" \
1209 "\t-a\tde/configure all interfaces automatically\n" \
1210 "\t-i FILE\tuse FILE for interface definitions\n" \
1211 "\t-n\tprint out what would happen, but don't do it\n" \
1212 "\t\t(note that this option doesn't disable mappings)\n" \
1213 "\t-v\tprint out what would happen before doing it\n" \
1214 "\t-m\tdon't run any mappings\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001215 "\t-f\tforce de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001216
Glenn L McGrath06e95652003-02-09 06:51:14 +00001217#define inetd_trivial_usage \
Paul Foxb8317532005-08-01 19:39:47 +00001218 "[-f] [-q len] [conf]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001219#define inetd_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001220 "Listens for network connections and launches programs\n\n" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001221 "Option:\n" \
Paul Foxb8317532005-08-01 19:39:47 +00001222 "\t-f\tRun as a foreground progress\n" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001223 "\t-q\tSets the size of the socket listen queue to\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001224 "\t\tthe specified value. Default is 128"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001225
Eric Andersen7e9276b2001-02-22 01:15:47 +00001226#define init_trivial_usage \
1227 ""
1228#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001229 "Init is the parent of all processes."
1230#define init_notes_usage \
1231"This version of init is designed to be run only by the kernel.\n" \
1232"\n" \
1233"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
1234"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
1235"runlevels, use sysvinit.\n" \
1236"\n" \
1237"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
1238"it has the following default behavior:\n" \
1239"\n" \
1240" ::sysinit:/etc/init.d/rcS\n" \
1241" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001242" ::ctrlaltdel:/sbin/reboot\n" \
1243" ::shutdown:/sbin/swapoff -a\n" \
1244" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001245" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001246"\n" \
1247"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1248"\n" \
1249" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001250" tty3::askfirst:/bin/sh\n" \
1251" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001252"\n" \
1253"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1254"\n" \
1255" <id>:<runlevels>:<action>:<process>\n" \
1256"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001257" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001258"\n" \
1259" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1260" The id field is used by BusyBox init to specify the controlling tty for\n" \
1261" the specified process to run on. The contents of this field are\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001262" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001263" be unique, although if it isn't you may have strange results. If this\n" \
1264" field is left blank, the controlling tty is set to the console. Also\n" \
1265" note that if BusyBox detects that a serial console is in use, then only\n" \
1266" entries whose controlling tty is either the serial console or /dev/null\n" \
1267" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1268" stinkin' utmp.\n" \
1269"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001270" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001271"\n" \
1272" The runlevels field is completely ignored.\n" \
1273"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001274" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001275"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001276" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001277" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001278"\n" \
1279" The available actions can be classified into two groups: actions\n" \
1280" that are run only once, and actions that are re-run when the specified\n" \
1281" process exits.\n" \
1282"\n" \
1283" Run only-once actions:\n" \
1284"\n" \
1285" 'sysinit' is the first item run on boot. init waits until all\n" \
1286" sysinit actions are completed before continuing. Following the\n" \
1287" completion of all sysinit actions, all 'wait' actions are run.\n" \
1288" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001289" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001290" therefore, init does not wait for them to complete. 'restart' is\n" \
1291" the action taken to restart the init process. By default this should\n" \
1292" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1293" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001294" actions are run when the system detects that someone on the system\n" \
1295" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1296" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1297" Finally the 'shutdown' action specifies the actions to taken when\n" \
1298" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1299" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001300"\n" \
1301" Run repeatedly actions:\n" \
1302"\n" \
1303" 'respawn' actions are run after the 'once' actions. When a process\n" \
1304" started with a 'respawn' action exits, init automatically restarts\n" \
1305" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1306" respawning out of control. The 'askfirst' actions acts just like\n" \
1307" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001308" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001309" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001310" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001311"\n" \
1312" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1313" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001314" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001315"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001316" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001317"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001318" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001319"\n" \
1320"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001321"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001322" # This is run first except when booting in single-user mode.\n" \
1323" #\n" \
1324" ::sysinit:/etc/init.d/rcS\n" \
1325" \n" \
1326" # /bin/sh invocations on selected ttys\n" \
1327" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001328" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001329" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001330" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001331" tty2::askfirst:-/bin/sh\n" \
1332" tty3::askfirst:-/bin/sh\n" \
1333" tty4::askfirst:-/bin/sh\n" \
1334" \n" \
1335" # /sbin/getty invocations for selected ttys\n" \
1336" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001337" tty4::respawn:/sbin/getty 38400 tty4\n" \
1338" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001339" \n" \
1340" \n" \
1341" # Example of how to put a getty on a serial line (for a terminal)\n" \
1342" #\n" \
1343" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1344" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1345" #\n" \
1346" # Example how to put a getty on a modem line.\n" \
1347" #::respawn:/sbin/getty 57600 ttyS2\n" \
1348" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001349" # Stuff to do when restarting the init process\n" \
1350" ::restart:/sbin/init\n" \
1351" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001352" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001353" ::ctrlaltdel:/sbin/reboot\n" \
1354" ::shutdown:/bin/umount -a -r\n" \
1355" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001356
Eric Andersenbe65c352003-01-23 04:57:35 +00001357#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001358# define USAGE_INSMOD_MAP(a) a
Eric Andersenbe65c352003-01-23 04:57:35 +00001359#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001360# define USAGE_INSMOD_MAP(a)
Eric Andersenbe65c352003-01-23 04:57:35 +00001361#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001362#define insmod_trivial_usage \
1363 "[OPTION]... MODULE [symbol=value]..."
1364#define insmod_full_usage \
1365 "Loads the specified kernel modules into the kernel.\n\n" \
1366 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001367 "\t-f\tForce module to load into the wrong kernel version\n" \
1368 "\t-k\tMake module autoclean-able\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001369 "\t-v\tverbose output\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001370 "\t-q\tquiet output\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001371 "\t-L\tLock to prevent simultaneous loads of a module\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001372 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout\n") \
Eric Andersen957879a2004-04-07 15:07:55 +00001373 "\t-o NAME\tSet internal module name to NAME\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001374 "\t-x\tdo not export externs"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001375
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001376#define install_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001377 "[-cgmops] [sources] <dest|directory>"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001378#define install_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001379 "Copies files and set attributes\n\n" \
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001380 "Options:\n" \
1381 "\t-c\tcopy the file, default\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001382 "\t-d\tcreate directories\n" \
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001383 "\t-g\tset group ownership\n" \
1384 "\t-m\tset permission modes\n" \
1385 "\t-o\tset ownership\n" \
1386 "\t-p\tpreserve date\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001387 "\t-s\tstrip symbol tables"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001388
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001389#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001390 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001391#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001392 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1393 "where OBJECT := { link | addr | route | tunnel }\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001394 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001395
1396#define ipaddr_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001397 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
1398 "\t\t[ dev STRING ] [ to PREFIX ] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001399#define ipaddr_full_usage \
Rob Landleydaa4a6d2006-03-30 01:59:30 +00001400 "ipaddr {add|delete} IFADDR dev STRING\n" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001401 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001402 "\t\t\t[ to PREFIX ] [ label PATTERN ]\n" \
1403 "\t\t\tIFADDR := PREFIX | ADDR peer PREFIX\n" \
1404 "\t\t\t[ broadcast ADDR ] [ anycast ADDR ]\n" \
1405 "\t\t\t[ label STRING ] [ scope SCOPE-ID ]\n" \
1406 "\t\t\tSCOPE-ID := [ host | link | global | NUMBER ]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001407
Eric Andersen3561b012004-04-13 19:27:20 +00001408#ifdef CONFIG_FEATURE_IPCALC_FANCY
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001409# define XUSAGE_IPCALC_FANCY(a) a
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001410#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001411# define XUSAGE_IPCALC_FANCY(a)
Eric Andersen3561b012004-04-13 19:27:20 +00001412#endif
Eric Andersende4f07e2003-12-11 01:18:07 +00001413#define ipcalc_trivial_usage \
Eric Andersen3561b012004-04-13 19:27:20 +00001414 "[OPTION]... <ADDRESS>[[/]<NETMASK>] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001415#define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001416 "Calculate IP network settings from a IP address\n\n" \
1417 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001418 "\t-b\t--broadcast\tDisplay calculated broadcast address\n" \
1419 "\t-n\t--network\tDisplay calculated network address\n" \
Mike Frysinger036f2992005-09-24 23:50:14 +00001420 "\t-m\t--netmask\tDisplay default netmask for IP" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001421 XUSAGE_IPCALC_FANCY( \
Mike Frysinger036f2992005-09-24 23:50:14 +00001422 "\n\t-p\t--prefix\tDisplay the prefix for IP/NETMASK\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001423 "\t-h\t--hostname\tDisplay first resolved host name\n" \
Mike Frysinger036f2992005-09-24 23:50:14 +00001424 "\t-s\t--silent\tDon't ever display error messages")
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001425
Rob Landley6eb1e412005-06-20 04:30:36 +00001426#define ipcrm_trivial_usage \
1427 "[-[MQS] key] [-[mqs] id]"
1428#define ipcrm_full_usage \
1429 "The upper-case options MQS are used to remove a shared memory\n" \
1430 "segment by an shmkey value. The lower-case options mqs are used\n" \
1431 "to remove a segment by shmid value.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00001432 "\t-m | -M\tRemove the memory segment after the last detach\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001433 "\t-q | -Q\tRemove the message queue\n" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001434 "\t-s | -S\tRemove the semaphore"
Rob Landley6eb1e412005-06-20 04:30:36 +00001435
1436#define ipcs_trivial_usage \
1437 "[[-smq] -i shmid] | [[-asmq] [-tclup]]"
1438#define ipcs_full_usage \
1439 "\t-i\tspecify a specific resource id\n" \
1440 "Resource specification:\n" \
1441 "\t-m\tshared memory segments\n" \
1442 "\t-q\tmessage queues\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00001443 "\t-s\tsemaphore arrays\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001444 "\t-a\tall (default)\n" \
1445 "Output format:\n" \
1446 "\t-t\ttime\n" \
1447 "\t-p\tpid\n" \
1448 "\t-s\tcreator\n" \
1449 "\t-a\tlimits\n" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001450 "\t-i\tsummary"
Rob Landley6eb1e412005-06-20 04:30:36 +00001451
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001452#define iplink_trivial_usage \
1453 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1454#define iplink_full_usage \
1455 "iplink set DEVICE { up | down | arp { on | off } |\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001456 "\t\t\tdynamic { on | off } |\n" \
1457 "\t\t\tmtu MTU }\n" \
1458 "\tiplink show [ DEVICE ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001459
1460#define iproute_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001461 "{ list | flush | { add | del | change | append |\n" \
1462 "\t\treplace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001463#define iproute_full_usage \
1464 "iproute { list | flush } SELECTOR\n" \
1465 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001466 "\t\t\t[ oif STRING ] [ tos TOS ]\n" \
1467 "\tiproute { add | del | change | append | replace | monitor } ROUTE\n" \
1468 "\t\t\tSELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1469 "\t\t\tROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001470
1471#define iptunnel_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001472 "{ add | change | del | show } [ NAME ]\n" \
1473 "\t\t[ mode { ipip | gre | sit } ]\n" \
1474 "\t\t[ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001475#define iptunnel_full_usage \
1476 "iptunnel { add | change | del | show } [ NAME ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001477 "\t\t\t[ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1478 "\t\t\t[ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1479 "\t\t\t[ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001480
Eric Andersen7e9276b2001-02-22 01:15:47 +00001481#define kill_trivial_usage \
1482 "[-signal] process-id [process-id ...]"
1483#define kill_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001484 "Send a signal (default is SIGTERM) to the specified process(es).\n\n" \
David Kimdon56082dc2001-02-23 06:03:22 +00001485 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001486 "\t-l\tList all signal names and numbers"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001487#define kill_example_usage \
1488 "$ ps | grep apache\n" \
1489 "252 root root S [apache]\n" \
1490 "263 www-data www-data S [apache]\n" \
1491 "264 www-data www-data S [apache]\n" \
1492 "265 www-data www-data S [apache]\n" \
1493 "266 www-data www-data S [apache]\n" \
1494 "267 www-data www-data S [apache]\n" \
1495 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001496
1497#define killall_trivial_usage \
Eric Andersenb131db42004-08-19 18:25:02 +00001498 "[-q] [-signal] process-name [process-name ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001499#define killall_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001500 "Send a signal (default is SIGTERM) to the specified process(es).\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001501 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001502 "\t-l\tList all signal names and numbers\n" \
1503 "\t-q\tDo not complain if no processes were killed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001504#define killall_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001505 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001506
Mark Whitley6317c4b2001-03-12 22:51:50 +00001507#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001508 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001509#define klogd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001510 "Kernel logger.\n" \
1511 "Options:\n" \
1512 "\t-c n\tSets the default log level of console messages to n\n" \
1513 "\t-n\tRun as a foreground process"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001514
Eric Andersen7e9276b2001-02-22 01:15:47 +00001515#define length_trivial_usage \
1516 "STRING"
1517#define length_full_usage \
1518 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001519#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001520 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001521 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001522
Rob Landley9200e792005-09-15 19:26:59 +00001523#define less_trivial_usage \
1524 "[-EMNmh~?] FILE1 FILE2..."
1525#define less_full_usage \
1526 "View a file or list of files. The position within files can be\n" \
1527 "changed, and files can be manipulated in various ways with the\n" \
1528 "following options:\n\n" \
1529 "\t-E\tQuit once the end of a file is reached\n" \
1530 "\t-M\tDisplay a status line containing the current line numbers\n" \
1531 "\t\tand the percentage through the file\n" \
1532 "\t-N\tPrefix line numbers to each line\n" \
1533 "\t-m\tDisplay a status line containing the percentage through the\n" \
1534 "\t\tfile\n" \
1535 "\t-~\tSuppress ~s displayed when input past the end of the file is\n" \
1536 "\t\treached.\n" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001537 "\t-h, -?\tDisplay this help message"
Rob Landley9200e792005-09-15 19:26:59 +00001538
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001539#define setarch_trivial_usage \
1540 "<personality> <program> [args ...]"
1541#define setarch_full_usage \
1542 "Personality may be:\n" \
1543 "\tlinux32\tSet 32bit uname emulation\n" \
1544 "\tlinux64\tSet 64bit uname emulation"
1545
Eric Andersen7e9276b2001-02-22 01:15:47 +00001546#define ln_trivial_usage \
1547 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1548#define ln_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001549 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001550 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1551 "Options:\n" \
1552 "\t-s\tmake symbolic links instead of hard links\n" \
1553 "\t-f\tremove existing destination files\n" \
Rob Landley55b1efc2005-04-29 22:14:28 +00001554 "\t-n\tno dereference symlinks - treat like normal file\n" \
1555 "\t-b\tmake a backup of the target (if exists) before link operation\n" \
1556 "\t-S suffix\tuse suffix instead of ~ when making backup files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001557#define ln_example_usage \
1558 "$ ln -s BusyBox /tmp/ls\n" \
1559 "$ ls -l /tmp/ls\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001560 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001561
Eric Andersen7e9276b2001-02-22 01:15:47 +00001562#define loadfont_trivial_usage \
1563 "< font"
1564#define loadfont_full_usage \
1565 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001566#define loadfont_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001567 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001568
1569#define loadkmap_trivial_usage \
1570 "< keymap"
1571#define loadkmap_full_usage \
1572 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001573#define loadkmap_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001574 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001575
1576#define logger_trivial_usage \
1577 "[OPTION]... [MESSAGE]"
1578#define logger_full_usage \
1579 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1580 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001581 "\t-s\tLog to stderr as well as the system log\n" \
1582 "\t-t TAG\tLog using the specified tag (defaults to user name)\n" \
1583 "\t-p PRIORITY\tEnter the message with the specified priority\n" \
1584 "\t\tThis may be numerical or a ``facility.level'' pair"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001585#define logger_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001586 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001587
Robert Griebl1fca5582002-06-04 20:45:46 +00001588#define login_trivial_usage \
1589 "[OPTION]... [username] [ENV=VAR ...]"
1590#define login_full_usage \
1591 "Begin a new session on the system\n\n" \
1592 "Options:\n" \
1593 "\t-f\tDo not authenticate (user already authenticated)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001594 "\t-h\tName of the remote host for this login\n" \
1595 "\t-p\tPreserve environment"
Robert Griebl1fca5582002-06-04 20:45:46 +00001596
Eric Andersen7e9276b2001-02-22 01:15:47 +00001597#define logname_trivial_usage \
1598 ""
1599#define logname_full_usage \
1600 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001601#define logname_example_usage \
1602 "$ logname\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001603 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001604
Mark Whitley6317c4b2001-03-12 22:51:50 +00001605#define logread_trivial_usage \
Eric Andersend4a5e252003-12-19 11:32:14 +00001606 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001607#define logread_full_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001608 "Shows the messages from syslogd (using circular buffer).\n\n" \
Eric Andersend4a5e252003-12-19 11:32:14 +00001609 "Options:\n" \
1610 "\t-f\t\toutput data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001611
Matt Kraai83788da2002-03-20 17:38:37 +00001612#define losetup_trivial_usage \
Rob Landleyce887932005-12-21 17:00:25 +00001613 "[-od] LOOPDEVICE [FILE]"
Matt Kraai83788da2002-03-20 17:38:37 +00001614#define losetup_full_usage \
Rob Landley1d589b22005-11-29 23:47:10 +00001615 "Associate LOOPDEVICE with FILE, or display current association.\n\n" \
Matt Kraai83788da2002-03-20 17:38:37 +00001616 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001617 "\t-d\t\tDisassociate LOOPDEVICE\n" \
1618 "\t-o OFFSET\tStart OFFSET bytes into FILE"
Rob Landley1d589b22005-11-29 23:47:10 +00001619#define losetup_notes_usage \
1620 "One argument (losetup /dev/loop1) will display the current association\n" \
1621 "(if any), or disassociate it (with -d). The display shows the offset\n" \
1622 "and filename of the file the loop device is currently bound to.\n\n" \
1623 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
1624 "with an optional offset (-o 12345). Encryption is not yet supported.\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00001625
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001626#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001627# define USAGE_LS_TIMESTAMPS(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001628#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001629# define USAGE_LS_TIMESTAMPS(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001630#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001631#ifdef CONFIG_FEATURE_LS_FILETYPES
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001632# define USAGE_LS_FILETYPES(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001633#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001634# define USAGE_LS_FILETYPES(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001635#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001636#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001637# define USAGE_LS_FOLLOWLINKS(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001638#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001639# define USAGE_LS_FOLLOWLINKS(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001640#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001641#ifdef CONFIG_FEATURE_LS_RECURSIVE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001642# define USAGE_LS_RECURSIVE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001643#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001644# define USAGE_LS_RECURSIVE(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001645#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001646#ifdef CONFIG_FEATURE_LS_SORTFILES
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001647# define USAGE_LS_SORTFILES(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001648#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001649# define USAGE_LS_SORTFILES(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001650#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001651#ifdef CONFIG_FEATURE_AUTOWIDTH
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001652# define USAGE_AUTOWIDTH(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001653#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001654# define USAGE_AUTOWIDTH(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001655#endif
Paul Fox156dc412005-08-01 19:33:30 +00001656#ifdef CONFIG_FEATURE_LS_COLOR
1657 #define USAGE_LS_COLOR(a) a
1658#else
1659 #define USAGE_LS_COLOR(a)
1660#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00001661
Eric Andersen7e9276b2001-02-22 01:15:47 +00001662#define ls_trivial_usage \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001663 "[-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 +00001664#define ls_full_usage \
1665 "List directory contents\n\n" \
1666 "Options:\n" \
1667 "\t-1\tlist files in a single column\n" \
1668 "\t-A\tdo not list implied . and ..\n" \
1669 "\t-a\tdo not hide entries starting with .\n" \
1670 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001671 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Paul Fox156dc412005-08-01 19:33:30 +00001672 USAGE_LS_COLOR("\t--color[={always,never,auto}]\tto control coloring\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001673 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001674 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1675 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001676 "\t-i\tlist the i-node for each file\n" \
1677 "\t-l\tuse a long listing format\n" \
1678 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001679 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1680 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1681 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1682 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1683 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001684 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001685 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1686 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1687 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1688 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1689 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001690 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001691 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001692 USE_FEATURE_HUMAN_READABLE( \
Eric Andersen15c03c32004-04-06 17:52:02 +00001693 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n") \
1694 USAGE_SELINUX("\t-k\tprint security context\n") \
1695 USAGE_SELINUX("\t-K\tprint security context in long format\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001696
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001697#define lsattr_trivial_usage \
1698 "[-Radlv] [files...]"
1699#define lsattr_full_usage \
1700 "list file attributes on an ext2 fs\n\n" \
1701 "Options:\n" \
1702 "\t-R\trecursively list subdirectories\n" \
1703 "\t-a\tdo not hide entries starting with .\n" \
1704 "\t-d\tlist directory entries instead of contents\n" \
1705 "\t-l\tprint long flag names\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001706 "\t-v\tlist the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001707
Eric Andersen7e9276b2001-02-22 01:15:47 +00001708#define lsmod_trivial_usage \
1709 ""
1710#define lsmod_full_usage \
1711 "List the currently loaded kernel modules."
1712
Eric Andersen3d925622005-06-09 10:16:02 +00001713#ifdef CONFIG_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00001714#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001715 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001716#define makedevs_full_usage \
1717 "Creates a range of block or character special files\n\n" \
1718 "TYPEs include:\n" \
1719 "\tb:\tMake a block (buffered) device.\n" \
1720 "\tc or u:\tMake a character (un-buffered) device.\n" \
1721 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1722 "FIRST specifies the number appended to NAME to create the first device.\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001723 "LAST specifies the number of the last item that should be created\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001724 "If 's' is the last argument, the base device is created as well.\n\n" \
1725 "For example:\n" \
1726 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001727 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001728#define makedevs_example_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001729 "# makedevs /dev/ttyS c 4 66 2 63\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001730 "[creates ttyS2-ttyS63]\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001731 "# makedevs /dev/hda b 3 0 0 8 s\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001732 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001733#endif
1734
1735#ifdef CONFIG_FEATURE_MAKEDEVS_TABLE
1736#define makedevs_trivial_usage \
Eric Andersene8614db2005-07-18 09:28:36 +00001737 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00001738#define makedevs_full_usage \
Eric Andersene8614db2005-07-18 09:28:36 +00001739 "Creates a range of special files as specified in a device table.\n" \
1740 "Device table entries take the form of:\n" \
Eric Andersene8614db2005-07-18 09:28:36 +00001741 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
1742 "Where name is the file name, type can be one of:\n" \
1743 " f A regular file\n" \
1744 " d Directory\n" \
1745 " c Character special device file\n" \
1746 " b Block special device file\n" \
1747 " p Fifo (named pipe)\n" \
1748 "uid is the user id for the target file, gid is the group id for the\n" \
1749 "target file. The rest of the entries (major, minor, etc) apply to\n" \
Eric Andersen54e57da2005-07-18 09:42:37 +00001750 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00001751#define makedevs_example_usage \
1752 "For example:\n" \
1753 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
1754 "/dev d 755 0 0 - - - - -\n" \
1755 "/dev/console c 666 0 0 5 1 - - -\n" \
1756 "/dev/null c 666 0 0 1 3 0 0 -\n" \
1757 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
1758 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
1759 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
1760 "Will Produce:\n" \
1761 "/dev\n" \
1762 "/dev/console\n" \
1763 "/dev/null\n" \
1764 "/dev/zero\n" \
1765 "/dev/hda\n" \
Eric Andersen54e57da2005-07-18 09:42:37 +00001766 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001767#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001768
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001769#ifdef CONFIG_FEATURE_MD5_SHA1_SUM_CHECK
1770#define USAGE_MD5_SHA1_SUM_CHECK(a) a
1771#else
1772#define USAGE_MD5_SHA1_SUM_CHECK(a)
1773#endif
1774
Eric Andersen7e9276b2001-02-22 01:15:47 +00001775#define md5sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001776 "[OPTION] [FILEs...]" \
1777 USAGE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001778#define md5sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001779 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001780 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001781 "With no FILE, or when FILE is -, read standard input." \
1782 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
1783 "\t-c\tcheck MD5 sums against given list\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001784 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001785 "\t-s\tdon't output anything, status code shows success\n" \
"Robert P. J. Day"eea56182006-07-20 19:02:24 +00001786 "\t-w\twarn about improperly formatted MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001787#define md5sum_example_usage \
1788 "$ md5sum < busybox\n" \
1789 "6fd11e98b98a58f64ff3398d7b324003\n" \
1790 "$ md5sum busybox\n" \
1791 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1792 "$ md5sum -c -\n" \
1793 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1794 "busybox: OK\n" \
1795 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001796
Rob Landley70f7ef72005-12-13 08:21:33 +00001797#define mdev_trivial_usage \
1798 "[-s]"
1799#define mdev_full_usage \
Mike Frysinger35cf19d2006-02-02 22:52:59 +00001800 "\t-s\tScan /sys and populate /dev during system boot\n\n" \
Rob Landley70f7ef72005-12-13 08:21:33 +00001801 "Called with no options (via hotplug) it uses environment variables\n" \
1802 "to determine which device to add/remove."
Rob Landleyef10d522006-06-26 14:11:33 +00001803#define mdev_notes_usage "" \
1804USE_FEATURE_MDEV_CONFIG( \
Rob Landley70f7ef72005-12-13 08:21:33 +00001805 "The mdev config file contains lines that look like:\n" \
Tim Rikerc1ef7bd2006-01-25 00:08:53 +00001806 " hd[a-z][0-9]* 0:3 660\n\n" \
1807 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00001808 USE_FEATURE_MDEV_EXEC( \
1809 "Optionally, that can be followed (on the same line) by a special character\n" \
1810 "and a command line to run after creating/before deleting the corresponding\n" \
1811 "device(s). The environment variable $MDEV indicates the active device node\n" \
1812 "(which is useful if it's a regex match). For example:\n\n" \
1813 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
1814 "The special characters are @ (run after creating), $ (run before deleting),\n" \
1815 "and * (run both after creating and before deleting). The commands run in\n" \
1816 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
1817 ) \
Rob Landley70f7ef72005-12-13 08:21:33 +00001818 "Config file parsing stops on the first matching line. If no config\n"\
1819 "entry is matched, devices are created with default 0:0 660. (Make\n"\
Rob Landleyef10d522006-06-26 14:11:33 +00001820 "the last line match .* to override this.)\n\n" \
1821)
Rob Landley70f7ef72005-12-13 08:21:33 +00001822
Glenn L McGrath061c9002002-09-16 04:21:46 +00001823#define mesg_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001824 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001825#define mesg_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001826 "mesg controls write access to your terminal\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001827 "\ty\tAllow write access to your terminal\n" \
1828 "\tn\tDisallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001829
Eric Andersen7e9276b2001-02-22 01:15:47 +00001830#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001831 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001832#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001833 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001834 "Options:\n" \
1835 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001836 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001837#define mkdir_example_usage \
1838 "$ mkdir /tmp/foo\n" \
1839 "$ mkdir /tmp/foo\n" \
1840 "/tmp/foo: File exists\n" \
1841 "$ mkdir /tmp/foo/bar/baz\n" \
1842 "/tmp/foo/bar/baz: No such file or directory\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001843 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001844
Mike Frysinger6447ac02005-06-11 05:29:40 +00001845#define mke2fs_trivial_usage \
1846 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
1847 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
1848 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
1849 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
1850 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
1851 "device [blocks-count]"
1852#define mke2fs_full_usage \
1853 "\t-b size\tblock size in bytes\n" \
1854 "\t-c\tcheck for bad blocks before creating\n" \
1855 "\t-E opts\tset extended options\n" \
1856 "\t-f size\tfragment size in bytes\n" \
1857 "\t-F\tforce (ignore sanity checks)\n" \
1858 "\t-g num\tnumber of blocks in a block group\n" \
1859 "\t-i ratio\tthe bytes/inode ratio\n" \
1860 "\t-j\tcreate a journal (ext3)\n" \
1861 "\t-J opts\tset journal options (size/device)\n" \
1862 "\t-l file\tread bad blocks list from file\n" \
1863 "\t-L lbl\tset the volume label\n" \
1864 "\t-m percent\tpercent of fs blocks to reserve for admin\n" \
1865 "\t-M dir\tset last mounted directory\n" \
1866 "\t-n\tdo not actually create anything\n" \
1867 "\t-N num\tnumber of inodes to create\n" \
1868 "\t-o os\tset the 'creator os' field\n" \
1869 "\t-O features\tdir_index/filetype/has_journal/journal_dev/sparse_super\n" \
1870 "\t-q\tquiet execution\n" \
1871 "\t-r rev\tset filesystem revision\n" \
1872 "\t-S\twrite superblock and group descriptors only\n" \
1873 "\t-T fs-type\tset usage type (news/largefile/largefile4)\n" \
1874 "\t-v\tverbose execution"
1875
Eric Andersen7e9276b2001-02-22 01:15:47 +00001876#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001877 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001878#define mkfifo_full_usage \
1879 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1880 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001881 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001882
Eric Andersen7e9276b2001-02-22 01:15:47 +00001883#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001884 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001885#define mkfs_minix_full_usage \
1886 "Make a MINIX filesystem.\n\n" \
1887 "Options:\n" \
1888 "\t-c\t\tCheck the device for bad blocks\n" \
1889 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1890 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1891 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001892 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001893
Eric Andersen7e9276b2001-02-22 01:15:47 +00001894#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001895 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001896#define mknod_full_usage \
1897 "Create a special file (block, character, or pipe).\n\n" \
1898 "Options:\n" \
1899 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1900 "TYPEs include:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001901 "\tb:\tMake a block (buffered) device\n" \
1902 "\tc or u:\tMake a character (un-buffered) device\n" \
1903 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001904#define mknod_example_usage \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001905 "$ mknod /dev/fd0 b 2 0\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001906 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001907
Eric Andersen7e9276b2001-02-22 01:15:47 +00001908#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001909 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001910#define mkswap_full_usage \
1911 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001912 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001913 "\t-c\t\tCheck for read-ability\n" \
1914 "\t-v0\t\tMake version 0 swap [max 128 Megs]\n" \
1915 "\t-v1\t\tMake version 1 swap [big!] (default for kernels >\n\t\t\t2.1.117)\n" \
1916 "\tblock-count\tNumber of block to use (default is entire partition)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001917
Eric Andersen7e9276b2001-02-22 01:15:47 +00001918#define mktemp_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001919 "[-dq] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001920#define mktemp_full_usage \
1921 "Creates a temporary file with its name based on TEMPLATE.\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001922 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX).\n\n" \
1923 "Options:\n" \
1924 "\t-d\t\tMake a directory instead of a file\n" \
1925 "\t-q\t\tFail silently if an error occurs"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001926#define mktemp_example_usage \
1927 "$ mktemp /tmp/temp.XXXXXX\n" \
1928 "/tmp/temp.mWiLjM\n" \
1929 "$ ls -la /tmp/temp.mWiLjM\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001930 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001931
Eric Andersen8d79ce82001-07-22 23:00:15 +00001932#define modprobe_trivial_usage \
Rob Landley9c32a152005-12-11 20:12:24 +00001933 "[-knqrsv] MODULE [symbol=value ...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00001934#define modprobe_full_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001935 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001936 "\t-k\tMake module autoclean-able\n" \
1937 "\t-n\tJust show what would be done\n" \
1938 "\t-q\tQuiet output\n" \
1939 "\t-r\tRemove module (stacks) or do autoclean\n" \
1940 "\t-s\tReport via syslog instead of stderr\n" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001941 "\t-v\tVerbose output"
Rob Landley9c32a152005-12-11 20:12:24 +00001942#define modprobe_notes_usage \
1943"modprobe can (un)load a stack of modules, passing each module options (when\n" \
1944"loading). modprobe uses a configuration file to determine what option(s) to\n" \
1945"pass each module it loads.\n" \
1946"\n" \
1947"The configuration file is searched (in order) amongst:\n" \
1948"\n" \
1949" /etc/modprobe.conf (2.6 only)\n" \
1950" /etc/modules.conf\n" \
1951" /etc/conf.modules (deprecated)\n" \
1952"\n" \
1953"They all have the same syntax (see below). If none is present, it is\n" \
1954"_not_ an error; each loaded module is then expected to load without\n" \
1955"options. Once a file is found, the others are tested for.\n" \
1956"\n" \
1957"/etc/modules.conf entry format:\n" \
1958"\n" \
1959" alias <alias_name> <mod_name>\n" \
1960" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00001961" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00001962" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
1963" This makes it also possible to use a different set of options (below) for\n" \
1964" the module and the alias.\n" \
1965" A module can be aliased more than once.\n" \
1966"\n" \
1967" options <mod_name|alias_name> <symbol=value ...>\n" \
1968" When loading module mod_name (or the module aliased by alias_name), pass\n" \
1969" the \"symbol=value\" pairs as option to that module.\n" \
1970"\n" \
1971"Sample /etc/modules.conf file:\n" \
1972"\n" \
1973" options tulip irq=3\n" \
1974" alias tulip tulip2\n" \
1975" options tulip2 irq=4 io=0x308\n" \
1976"\n" \
1977"Other functionality offered by 'classic' modprobe is not available in\n" \
1978"this implementation.\n" \
1979"\n" \
1980"If module options are present both in the config file, and on the command line,\n" \
1981"then the options from the command line will be passed to the module _after_\n" \
1982"the options from the config file. That way, you can have defaults in the config\n" \
1983"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00001984#define modprobe_example_usage \
Rob Landley9c32a152005-12-11 20:12:24 +00001985 "(with the above /etc/modules.conf):\n\n" \
1986 "$ modprobe tulip\n" \
1987 " will load the module 'tulip' with default option 'irq=3'\n\n" \
1988 "$ modprobe tulip irq=5\n" \
1989 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
1990 "$ modprobe tulip2\n" \
1991 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
1992 " which are the default for alias 'tulip2'\n\n" \
1993 "$ modprobe tulip2 irq=8\n" \
1994 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00001995 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00001996 " from the command line\n\n" \
1997 "$ modprobe tulip2 irq=2 io=0x210\n" \
1998 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00001999 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002000 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002001
Eric Andersen7e9276b2001-02-22 01:15:47 +00002002#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002003 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002004#define more_full_usage \
2005 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002006#define more_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002007 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002008
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002009#ifdef CONFIG_FEATURE_MOUNT_LOOP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002010# define USAGE_MOUNT_LOOP(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002011#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002012# define USAGE_MOUNT_LOOP(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00002013#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002014#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002015# define USAGE_MTAB(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002016#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002017# define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002018#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002019#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002020 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002021#define mount_full_usage \
Mike Frysinger29ed59e2006-01-04 00:04:08 +00002022 "Mount a filesystem. Filesystem autodetection requires /proc be mounted.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002023 "Flags:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002024 "\t-a:\t\tMount all filesystems in fstab\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002025 USAGE_MTAB( \
Mike Frysinger058e7402005-04-23 07:00:33 +00002026 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it\n" \
2027 "\t-n:\t\tDon't write a mount table entry\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002028 ) \
Mike Frysinger058e7402005-04-23 07:00:33 +00002029 "\t-o option:\tOne of many filesystem options, listed below\n" \
2030 "\t-r:\t\tMount the filesystem read-only\n" \
2031 "\t-t fs-type:\tSpecify the filesystem type\n" \
2032 "\t-w:\t\tMount for reading and writing (default)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002033 "\n" \
2034 "Options for use with the \"-o\" flag:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002035 "\tasync/sync:\tWrites are asynchronous / synchronous\n" \
2036 "\tatime/noatime:\tEnable / disable updates to inode access times\n" \
2037 "\tdev/nodev:\tAllow use of special device files / disallow them\n" \
2038 "\texec/noexec:\tAllow use of executable files / disallow them\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002039 USAGE_MOUNT_LOOP( \
Rob Landley1d589b22005-11-29 23:47:10 +00002040 "\tloop:\t\t Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002041 ) \
Mike Frysinger058e7402005-04-23 07:00:33 +00002042 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them\n" \
2043 "\tremount:\tRe-mount a mounted filesystem, changing its flags\n" \
2044 "\tro/rw:\t\tMount for read-only / read-write\n" \
Rob Landley1d589b22005-11-29 23:47:10 +00002045 "\tbind:\t\tBind a directory to an additional location\n" \
2046 "\tmove:\t\tRelocate an existing mount point.\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002047 "\nThere are EVEN MORE flags that are specific to each filesystem\n" \
2048 "You'll have to see the written documentation for those filesystems"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002049#define mount_example_usage \
2050 "$ mount\n" \
2051 "/dev/hda3 on / type minix (rw)\n" \
2052 "proc on /proc type proc (rw)\n" \
2053 "devpts on /dev/pts type devpts (rw)\n" \
2054 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
Rob Landley1d589b22005-11-29 23:47:10 +00002055 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2056 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002057#define mount_notes_usage \
2058 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002059
Rob Landleyd00b3a52005-08-20 05:07:08 +00002060#define mountpoint_trivial_usage \
2061 "[-q] <[-d] DIR | -x DEVICE>"
2062#define mountpoint_full_usage \
2063 "mountpoint checks if the directory is a mountpoint\n\n" \
2064 "Options:\n" \
2065 "\t-q:\t\tBe more quiet\n" \
2066 "\t-d:\t\tPrint major/minor device number of the filesystem\n" \
2067 "\t-x:\t\tPrint major/minor device number of the blockdevice"
2068#define mountpoint_example_usage \
2069 "$ mountpoint /proc\n" \
2070 "/proc is not a mountpoint\n" \
2071 "$ mountpoint /sys\n" \
2072 "/sys is a mountpoint\n"
2073
Eric Andersen7e9276b2001-02-22 01:15:47 +00002074#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002075 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002076#define mt_full_usage \
2077 "Control magnetic tape drive operation\n" \
2078 "\nAvailable Opcodes:\n\n" \
2079 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2080 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
Eric Andersen92fb9392003-08-08 20:09:03 +00002081 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002082 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002083
Eric Andersen7e9276b2001-02-22 01:15:47 +00002084#define mv_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002085 "[OPTION]... SOURCE DEST\n" \
2086 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002087#define mv_full_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002088 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY.\n\n" \
2089 "Options:\n" \
2090 "\t-f\tdon't prompt before overwriting\n" \
2091 "\t-i\tinteractive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002092#define mv_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002093 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002094
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002095#define nameif_trivial_usage \
Glenn L McGratha9adef02003-01-19 13:34:21 +00002096 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002097#define nameif_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002098 "Nameif renaming network interface while it in the down state.\n\n" \
2099 "Options:\n" \
2100 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002101 "\t-s\t\tUse syslog (LOCAL0 facility)\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002102 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002103#define nameif_example_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002104 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2105 " or\n" \
2106 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002107
Rob Landley1cca9482006-07-10 19:45:20 +00002108#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
2109#define NC_BR1 "["
2110#define NC_BR2 "]"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002111#else
Rob Landley1cca9482006-07-10 19:45:20 +00002112#define NC_BR1
2113#define NC_BR2
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002114#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002115
Eric Andersen7e9276b2001-02-22 01:15:47 +00002116#define nc_trivial_usage \
Rob Landley1cca9482006-07-10 19:45:20 +00002117 "[" \
2118 NC_BR1 USE_NC_SERVER("-lp")USE_NC_EXTRA("iwf") NC_BR2 \
2119 " ["USE_NC_EXTRA("FILENAME|")"{IPADDR PORTNUM}]"USE_NC_EXTRA(" [-e COMMAND]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002120#define nc_full_usage \
Rob Landley1cca9482006-07-10 19:45:20 +00002121 "Netcat opens a pipe, either to IP:port\n\n" \
2122 "Options:" \
2123 USE_NC_EXTRA( \
2124 "\n\t-e\t\texec rest of command line after connect\n" \
2125 "\t-i SECS\t\tdelay interval for lines sent\n" \
2126 "\t-w SECS\t\ttimeout for connect\n" \
2127 "\t-f filename\tuse file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002128 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002129 USE_NC_SERVER( \
2130 "\n\t-l\t\tlisten mode, for inbound connects\n" \
2131 USE_NC_EXTRA("\t\t\t(use -l twice with -e for persistent server)\n") \
2132 "\t-p PORT\t\tlocal port number" \
2133 )
2134
2135
2136#define nc_notes_usage "" \
2137 USE_NC_EXTRA( \
2138 "To use netcat as a terminal emulator on a serial port:\n\n" \
2139 "$ stty 115200 -F /dev/ttyS0\n" \
2140 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2141 ) ""
2142
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002143#define nc_example_usage \
2144 "$ nc foobar.somedomain.com 25\n" \
2145 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2146 "help\n" \
2147 "214-Commands supported:\n" \
2148 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2149 "214 NOOP QUIT RSET HELP\n" \
2150 "quit\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002151 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002152
Eric Andersen1552ff72001-10-31 11:07:12 +00002153#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00002154 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002155#define netstat_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00002156 "Netstat displays Linux networking information.\n\n" \
2157 "Options:\n" \
2158 "\t-l display listening server sockets\n" \
2159 "\t-a display all sockets (default: connected)\n" \
2160 "\t-e display other/more information\n" \
2161 "\t-n don't resolve names\n" \
2162 "\t-r display routing table\n" \
2163 "\t-t tcp sockets\n" \
2164 "\t-u udp sockets\n" \
2165 "\t-w raw sockets\n" \
2166 "\t-x unix sockets"
Eric Andersen1552ff72001-10-31 11:07:12 +00002167
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002168#define nice_trivial_usage \
2169 "[-n ADJUST] [COMMAND [ARG] ...]"
2170#define nice_full_usage \
2171 "Nice runs a program with modified scheduling priority.\n\n" \
2172 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002173 "\t-n ADJUST\tAdjust the scheduling priority by ADJUST"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002174
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002175#define nohup_trivial_usage \
2176 "COMMAND [ARGS]"
2177#define nohup_full_usage \
2178 "run a command immune to hangups, with output to a non-tty"
2179#define nohup_example_usage \
2180 "$ nohup make &"
2181
Eric Andersen7e9276b2001-02-22 01:15:47 +00002182#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00002183 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002184#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00002185 "Queries the nameserver for the IP address of the given HOST\n" \
2186 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002187#define nslookup_example_usage \
2188 "$ nslookup localhost\n" \
2189 "Server: default\n" \
2190 "Address: default\n" \
2191 "\n" \
2192 "Name: debian\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002193 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002194
Glenn L McGrath60281112001-11-02 11:39:46 +00002195#define od_trivial_usage \
2196 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
2197#define od_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002198 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Glenn L McGrath60281112001-11-02 11:39:46 +00002199 "to standard output. With no FILE, or when FILE is -, read standard input."
2200
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002201#define openvt_trivial_usage \
2202 "<vtnum> <COMMAND> [ARGS...]"
2203#define openvt_full_usage \
2204 "Start a command on a new virtual terminal"
2205#define openvt_example_usage \
2206 "openvt 2 /bin/ash\n"
2207
Eric Andersen27f64e12002-06-23 04:24:25 +00002208#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002209# define PASSWORD_ALG_TYPES(a) a
Tim Riker7b253f82003-12-28 05:02:40 +00002210#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002211# define PASSWORD_ALG_TYPES(a)
Eric Andersen27f64e12002-06-23 04:24:25 +00002212#endif
2213#define passwd_trivial_usage \
2214 "[OPTION] [name]"
2215#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00002216 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00002217 "changes the password for the current user.\n" \
2218 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002219 "\t-a\tDefine which algorithm shall be used for the password\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00002220 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00002221 PASSWORD_ALG_TYPES(", sha1") \
Mike Frysinger058e7402005-04-23 07:00:33 +00002222 ")\n\t-d\tDelete the password for the specified user account\n" \
2223 "\t-l\tLocks (disables) the specified user account\n" \
2224 "\t-u\tUnlocks (re-enables) the specified user account"
Eric Andersen27f64e12002-06-23 04:24:25 +00002225
Glenn L McGrath655d8142003-06-22 15:32:41 +00002226#define patch_trivial_usage \
Mike Frysingercc826d72006-06-28 00:22:32 +00002227 "[-p<num>] [-i <diff>]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002228#define patch_full_usage \
Mike Frysingercc826d72006-06-28 00:22:32 +00002229 "\t-p <num>\tStrip <num> leading components from file names\n" \
2230 "\t-i <diff>\tRead <diff> instead of stdin"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002231#define patch_example_usage \
Mike Frysingercc826d72006-06-28 00:22:32 +00002232 "$ patch -p1 < example.diff\n" \
Rob Landley078bacf2005-09-01 03:02:23 +00002233 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002234
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002235#if ENABLE_FEATURE_PIDOF_SINGLE
2236#define USAGE_FEATURE_PIDOF_SINGLE(a) a
2237#else
2238#define USAGE_FEATURE_PIDOF_SINGLE(a)
2239#endif
2240#if ENABLE_FEATURE_PIDOF_OMIT
2241#define USAGE_FEATURE_PIDOF_OMIT(a) a
2242#else
2243#define USAGE_FEATURE_PIDOF_OMIT(a)
2244#endif
2245#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
2246#define USAGE_PIDOF "Options:"
2247#else
2248#define USAGE_PIDOF "\n\tThis version of pidof accepts no options."
2249#endif
2250
Eric Andersen221b2ea2001-07-31 19:06:07 +00002251#define pidof_trivial_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002252 "process-name [OPTION] [process-name ...]"
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002253
Eric Andersen221b2ea2001-07-31 19:06:07 +00002254#define pidof_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002255 "Lists the PIDs of all processes with names that match the\n" \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002256 "names on the command line.\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002257 USAGE_PIDOF \
2258 USAGE_FEATURE_PIDOF_SINGLE("\n\t-s\t\tdisplay only a single PID") \
2259 USAGE_FEATURE_PIDOF_OMIT("\n\t-o\t\tomit given pid.") \
2260 USAGE_FEATURE_PIDOF_OMIT("\n\t\t\tUse %PPID to omit the parent pid of pidof itself")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002261#define pidof_example_usage \
2262 "$ pidof init\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002263 "1\n" \
2264 USAGE_FEATURE_PIDOF_OMIT("$ pidof /bin/sh\n20351 5973 5950\n") \
2265 USAGE_FEATURE_PIDOF_OMIT("$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002266
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002267#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00002268#define ping_trivial_usage "host"
2269#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
2270#else
2271#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002272 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002273#define ping_full_usage \
2274 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
2275 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002276 "\t-c COUNT\tSend only COUNT pings\n" \
2277 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002278 "\t-q\t\tQuiet mode, only displays output at start\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002279 "\t\t\tand when finished"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002280#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002281#define ping_example_usage \
2282 "$ ping localhost\n" \
2283 "PING slag (127.0.0.1): 56 data bytes\n" \
2284 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2285 "\n" \
2286 "--- debian ping statistics ---\n" \
2287 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002288 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002289
Eric Andersen51b8bd62002-07-03 11:46:38 +00002290#ifndef CONFIG_FEATURE_FANCY_PING6
2291#define ping6_trivial_usage "host"
2292#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
2293#else
2294#define ping6_trivial_usage \
2295 "[OPTION]... host"
2296#define ping6_full_usage \
2297 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
2298 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002299 "\t-c COUNT\tSend only COUNT pings\n" \
2300 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56)\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +00002301 "\t-q\t\tQuiet mode, only displays output at start\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002302 "\t\t\tand when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002303#endif
2304#define ping6_example_usage \
2305 "$ ping6 ip6-localhost\n" \
2306 "PING ip6-localhost (::1): 56 data bytes\n" \
2307 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2308 "\n" \
2309 "--- ip6-localhost ping statistics ---\n" \
2310 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002311 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002312
Eric Andersen7e9276b2001-02-22 01:15:47 +00002313#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002314 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002315#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002316 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002317 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002318
Eric Andersen7e9276b2001-02-22 01:15:47 +00002319#define poweroff_trivial_usage \
Rob Landley64612912006-01-30 08:31:37 +00002320 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002321#define poweroff_full_usage \
Rob Landley64612912006-01-30 08:31:37 +00002322 "Halt and shut off power.\n" \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002323 "Options:\n" \
Rob Landley64612912006-01-30 08:31:37 +00002324 "\t-d\t\tdelay interval for halting\n" \
2325 "\t-n\t\tno call to sync()\n" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00002326 "\t-f\t\tforce power off (don't go through init)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002327
Mike Frysinger95d3c452005-04-21 23:29:24 +00002328#define printenv_trivial_usage \
2329 "[VARIABLES...]"
2330#define printenv_full_usage \
2331 "print all or part of environment\n\n" \
2332 "If no environment VARIABLE specified, print them all."
2333
Eric Andersen7e9276b2001-02-22 01:15:47 +00002334#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002335 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002336#define printf_full_usage \
2337 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002338 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002339#define printf_example_usage \
Mike Frysinger5c63a722005-04-16 04:23:58 +00002340 "$ printf \"Val=%d\\n\" 5\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002341 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002342
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002343#if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE
Rob Landley6eb1e412005-06-20 04:30:36 +00002344#define USAGE_PS "\n\tThis version of ps accepts no options."
2345#else
2346#define USAGE_PS "\nOptions:"
2347#endif
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002348#if ENABLE_FEATURE_PS_WIDE
Rob Landley6eb1e412005-06-20 04:30:36 +00002349#define USAGE_PS_WIDE(a) a
2350#else
2351#define USAGE_PS_WIDE(a)
2352#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002353
Eric Andersen7e9276b2001-02-22 01:15:47 +00002354#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002355 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002356#define ps_full_usage \
2357 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002358 USAGE_PS \
2359 USAGE_SELINUX("\n\t-c\tshow SE Linux context") \
2360 USAGE_PS_WIDE("\n\tw\twide output")
2361
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002362#define ps_example_usage \
2363 "$ ps\n" \
2364 " PID Uid Gid State Command\n" \
2365 " 1 root root S init\n" \
2366 " 2 root root S [kflushd]\n" \
2367 " 3 root root S [kupdate]\n" \
2368 " 4 root root S [kpiod]\n" \
2369 " 5 root root S [kswapd]\n" \
2370 " 742 andersen andersen S [bash]\n" \
2371 " 743 andersen andersen S -bash\n" \
2372 " 745 root root S [getty]\n" \
2373 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002374
Eric Andersen7e9276b2001-02-22 01:15:47 +00002375#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002376 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002377#define pwd_full_usage \
2378 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002379#define pwd_example_usage \
2380 "$ pwd\n" \
2381 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002382
Eric Andersen7e9276b2001-02-22 01:15:47 +00002383#define rdate_trivial_usage \
Eric Andersen725db192003-07-22 08:26:05 +00002384 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002385#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002386 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002387 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002388 "\t-s\tSet the system date and time (default)\n" \
2389 "\t-p\tPrint the date and time"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002390
Ned Luddc6fbed52004-12-08 16:47:28 +00002391#ifdef CONFIG_FEATURE_READLINK_FOLLOW
2392#define USAGE_READLINK_FOLLOW(a) a
2393#else
2394#define USAGE_READLINK_FOLLOW(a)
2395#endif
2396
Eric Andersen7e9276b2001-02-22 01:15:47 +00002397#define readlink_trivial_usage \
Ned Luddc6fbed52004-12-08 16:47:28 +00002398 USAGE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002399#define readlink_full_usage \
Ned Luddc6fbed52004-12-08 16:47:28 +00002400 "Displays the value of a symbolic link." \
2401 USAGE_READLINK_FOLLOW("\n\nOptions:\n" \
2402 "\t-f\tcanonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002403
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002404#define readprofile_trivial_usage \
2405 "[OPTIONS]..."
2406#define readprofile_full_usage \
2407 "Options:\n" \
2408 "\t -m <mapfile> (default: /boot/System.map)\n" \
2409 "\t -p <profile> (default: /proc/profile)\n" \
2410 "\t -M <mult> set the profiling multiplier to <mult>\n" \
2411 "\t -i print only info about the sampling step\n" \
2412 "\t -v print verbose data\n" \
2413 "\t -a print all symbols, even if count is 0\n" \
2414 "\t -b print individual histogram-bin counts\n" \
2415 "\t -s print individual counters within functions\n" \
2416 "\t -r reset all the counters (root only)\n" \
2417 "\t -n disable byte order auto-detection"
2418
Glenn L McGrath62fae302002-12-10 00:14:33 +00002419#define realpath_trivial_usage \
2420 "pathname ..."
2421#define realpath_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002422 "Returns the absolute pathnames of given argument."
Tim Riker7b253f82003-12-28 05:02:40 +00002423
Eric Andersen7e9276b2001-02-22 01:15:47 +00002424#define reboot_trivial_usage \
Rob Landley64612912006-01-30 08:31:37 +00002425 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002426#define reboot_full_usage \
Glenn L McGrath72b14a82004-07-23 03:33:38 +00002427 "Reboot the system.\n" \
2428 "Options:\n" \
Rob Landley64612912006-01-30 08:31:37 +00002429 "\t-d\t\tdelay interval for rebooting\n" \
2430 "\t-n\t\tno call to sync()\n" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00002431 "\t-f\t\tforce reboot (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002432
2433#define renice_trivial_usage \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002434 "{{-n INCREMENT} | PRIORITY} [[ -p | -g | -u ] ID ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002435#define renice_full_usage \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002436 "Changes priority of running processes.\n\n" \
2437 "Options:\n" \
2438 "\t-n\tadjusts current nice value (smaller is faster)\n" \
2439 "\t-p\tprocess id(s) (default)\n" \
2440 "\t-g\tprocess group id(s)\n" \
2441 "\t-u\tprocess user name(s) and/or id(s)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002442
Eric Andersen7e9276b2001-02-22 01:15:47 +00002443#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002444 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002445#define reset_full_usage \
2446 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002447
Eric Andersen7e9276b2001-02-22 01:15:47 +00002448#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002449 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002450#define rm_full_usage \
2451 "Remove (unlink) the FILE(s). You may use '--' to\n" \
2452 "indicate that all following arguments are non-options.\n\n" \
2453 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002454 "\t-i\t\talways prompt before removing each destination\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002455 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002456 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002457#define rm_example_usage \
2458 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002459
Eric Andersen7e9276b2001-02-22 01:15:47 +00002460#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002461 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002462#define rmdir_full_usage \
2463 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002464#define rmdir_example_usage \
2465 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002466
Eric Andersen7e9276b2001-02-22 01:15:47 +00002467#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002468 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002469#define rmmod_full_usage \
2470 "Unloads the specified kernel modules from the kernel.\n\n" \
2471 "Options:\n" \
Tim Rikercf932742002-12-14 01:58:59 +00002472 "\t-a\tRemove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002473#define rmmod_example_usage \
2474 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002475
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002476#ifdef CONFIG_FEATURE_IPV6
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002477# define USAGE_ROUTE_IPV6(a) a
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002478#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002479# define USAGE_ROUTE_IPV6(a) "\t"
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002480#endif
2481
2482
Eric Andersen7e9276b2001-02-22 01:15:47 +00002483#define route_trivial_usage \
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002484 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002485#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002486 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00002487 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002488 "\t-n\t\tDont resolve names\n" \
2489 "\t-e\t\tDisplay other/more information\n" \
2490 "\t-A inet" USAGE_ROUTE_IPV6("{6}") "\tSelect address family"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002491
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002492#define rpm_trivial_usage \
2493 "-i -q[ildc]p package.rpm"
2494#define rpm_full_usage \
2495 "Manipulates RPM packages" \
Eric Andersendfce3532003-06-15 07:00:54 +00002496 "\n\nOptions:" \
2497 "\n\t-i Install package" \
2498 "\n\t-q Query package" \
2499 "\n\t-p Query uninstalled package" \
2500 "\n\t-i Show information" \
2501 "\n\t-l List contents" \
2502 "\n\t-d List documents" \
2503 "\n\t-c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002504
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002505#define rpm2cpio_trivial_usage \
2506 "package.rpm"
2507#define rpm2cpio_full_usage \
2508 "Outputs a cpio archive of the rpm file."
2509
Eric Andersen6cf47a72001-10-31 10:24:36 +00002510#define run_parts_trivial_usage \
2511 "[-t] [-a ARG] [-u MASK] DIRECTORY"
2512#define run_parts_full_usage \
2513 "Run a bunch of scripts in a directory.\n\n" \
2514 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002515 "\t-t\tPrints what would be run, but does not actually run anything\n" \
2516 "\t-a ARG\tPass ARG as an argument for every program invoked\n" \
2517 "\t-u MASK\tSet the umask to MASK before executing every program"
Eric Andersen6cf47a72001-10-31 10:24:36 +00002518
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002519#define runlevel_trivial_usage \
2520 "[utmp]"
2521#define runlevel_full_usage \
2522 "Find the current and previous system runlevel.\n\n" \
2523 "If no utmp file exists or if no runlevel record can be found,\n" \
2524 "runlevel prints \"unknown\""
2525#define runlevel_example_usage \
2526 "$ runlevel /var/run/utmp\n" \
2527 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002528
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002529#define rx_trivial_usage \
2530 "FILE"
2531#define rx_full_usage \
2532 "Receive a file using the xmodem protocol."
2533#define rx_example_usage \
2534 "$ rx /tmp/foo\n"
2535
Eric Andersen7e9276b2001-02-22 01:15:47 +00002536#define sed_trivial_usage \
Rob Landley1ce59682004-05-26 21:59:31 +00002537 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002538#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002539 "Options:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002540 "\t-e script\tadd the script to the commands to be executed\n" \
Eric Andersenf802ff72004-04-12 15:12:06 +00002541 "\t-f scriptfile\tadd script-file contents to the\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002542 "\t\t\tcommands to be executed\n" \
Rob Landley1ce59682004-05-26 21:59:31 +00002543 "\t-i\t\tedit files in-place\n" \
2544 "\t-n\t\tsuppress automatic printing of pattern space\n" \
Rob Landley58b118a2004-05-26 22:09:37 +00002545 "\t-r\t\tuse extended regular expression syntax\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002546 "\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002547 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
2548 "script to interpret. All remaining arguments are names of input files; if no\n" \
Eric Andersenf802ff72004-04-12 15:12:06 +00002549 "input files are specified, then the standard input is read. Source files\n" \
2550 "will not be modified unless -i option is given."
2551
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002552#define sed_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002553 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002554 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002555
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002556#define seq_trivial_usage \
2557 "[first [increment]] last"
2558#define seq_full_usage \
2559 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
2560 "FIRST, INCREMENT default to 1\n" \
2561 "Arguments:\n" \
2562 "\tLAST\n" \
2563 "\tFIRST\tLAST\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002564 "\tFIRST\tINCREMENT\tLAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002565
Paul Foxfc2256a2005-08-01 18:12:30 +00002566#define setconsole_trivial_usage \
2567 "[-r|--reset] [DEVICE]"
2568#define setconsole_full_usage \
2569 "Redirects system console output to DEVICE (default: /dev/tty).\n\n" \
2570 "Options:\n" \
2571 "\t-r\tReset output to /dev/console."
2572
Eric Andersen7e9276b2001-02-22 01:15:47 +00002573#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002574 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002575#define setkeycodes_full_usage \
2576 "Set entries into the kernel's scancode-to-keycode map,\n" \
2577 "allowing unusual keyboards to generate usable keycodes.\n\n" \
2578 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002579 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002580#define setkeycodes_example_usage \
2581 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002582
Rob Landley87848d92006-03-27 23:23:43 +00002583#define setlogcons_trivial_usage \
2584 "N"
2585#define setlogcons_full_usage \
2586 "Redirects the kernel output to console N (0 for current)."
2587
Paul Fox42403642005-08-01 22:52:09 +00002588#define setsid_trivial_usage \
2589 "program [arg ...]"
2590#define setsid_full_usage \
2591 "Runs any program in a new session by calling setsid() before\n" \
2592 "exec'ing the rest of its arguments. See setsid(2) for details."
2593
Matt Kraai2d91deb2001-08-01 17:21:35 +00002594#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002595 "[FILE]...\n" \
2596 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00002597#define lash_full_usage \
Eric Andersen2e9c2572003-08-08 22:26:06 +00002598 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00002599#define lash_notes_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002600 "This command does not yet have proper documentation.\n\n" \
2601 "Use lash just as you would use any other shell. It properly handles pipes,\n" \
2602 "redirects, job control, can be used as the shell for scripts, and has a\n" \
2603 "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002604 "Bourne Shell syntax. If you need things like \"if-then-else\", \"while\", and such\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002605 "use ash or bash. If you just need a very simple and extremely small shell,\n" \
2606 "this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002607
Eric Andersen2e9c2572003-08-08 22:26:06 +00002608#define last_trivial_usage \
2609 ""
2610#define last_full_usage \
2611 "Shows listing of the last users that logged into the system"
2612
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002613#define sha1sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002614 "[OPTION] [FILEs...]" \
2615 USAGE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002616#define sha1sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002617 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n\n" \
2618 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002619 "With no FILE, or when FILE is -, read standard input." \
2620 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
2621 "\t-c\tcheck SHA1 sums against given list\n" \
2622 "\nThe following two options are useful only when verifying checksums:\n" \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002623 "\t-s\tdon't output anything, status code shows success\n" \
"Robert P. J. Day"eea56182006-07-20 19:02:24 +00002624 "\t-w\twarn about improperly formatted SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002625
Manuel Novoa III cad53642003-03-19 09:13:01 +00002626#ifdef CONFIG_FEATURE_FANCY_SLEEP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002627# define USAGE_FANCY_SLEEP(a) a
2628# define USAGE_NOT_FANCY_SLEEP(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +00002629#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002630# define USAGE_FANCY_SLEEP(a)
2631# define USAGE_NOT_FANCY_SLEEP(a) a
Manuel Novoa III cad53642003-03-19 09:13:01 +00002632#endif
2633
Eric Andersen7e9276b2001-02-22 01:15:47 +00002634#define sleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002635 USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002636#define sleep_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002637 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \
2638 USAGE_FANCY_SLEEP( \
Eric Andersen178de172004-04-06 16:36:20 +00002639 "Pause for a time equal to the total of the args given, where each arg can\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00002640 "\t\thave an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002641#define sleep_example_usage \
2642 "$ sleep 2\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002643 "[2 second delay results]\n" \
2644 USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \
2645 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002646
Rob Landley6130b9b2006-01-23 21:10:38 +00002647#if ENABLE_FEATURE_SORT_BIG
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002648# define USAGE_SORT_BIG(a) a
Mark Whitleyfccaa362001-04-17 18:56:18 +00002649#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002650# define USAGE_SORT_BIG(a)
Mark Whitleyfccaa362001-04-17 18:56:18 +00002651#endif
Rob Landleyc0dedd02005-01-24 07:00:02 +00002652
Eric Andersen7e9276b2001-02-22 01:15:47 +00002653#define sort_trivial_usage \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002654 "[-nru" USAGE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002655#define sort_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002656 "Sorts lines of text in the specified files\n\n" \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002657 "Options:\n" \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002658 USAGE_SORT_BIG( \
2659 "\t-b\tignore leading blanks\n" \
2660 "\t-c\tcheck whether input is sorted\n" \
2661 "\t-d\tdictionary order (blank or alphanumeric only)\n" \
2662 "\t-f\tignore case\n" \
2663 "\t-g\tgeneral numerical sort\n" \
2664 "\t-i\tignore unprintable characters\n" \
2665 "\t-k\tspecify sort key\n" \
2666 "\t-M\tsort month\n" \
2667 ) \
2668 "\t-n\tsort numbers\n" \
2669 USAGE_SORT_BIG( \
2670 "\t-o\toutput to file\n" \
2671 "\t-k\tsort by key\n" \
2672 "\t-t\tuse key separator other than whitespace\n" \
2673 ) \
2674 "\t-r\treverse sort order\n" \
2675 USAGE_SORT_BIG("\t-s\tstable (don't sort ties alphabetically)\n") \
2676 "\t-u\tsuppress duplicate lines" \
2677 USAGE_SORT_BIG("\n\t-z\tinput terminated by nulls, not newlines\n") \
Bernhard Reutner-Fischera1bccc02006-04-02 20:17:55 +00002678 USAGE_SORT_BIG("\t-mST\tignored for GNU compatibility") \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002679 ""
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002680#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002681 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002682 "a\n" \
2683 "b\n" \
2684 "c\n" \
2685 "d\n" \
2686 "e\n" \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002687 "f\n" \
2688 USAGE_SORT_BIG( \
2689 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
2690 "d 2\n" \
2691 "b 2\n" \
2692 "c 3\n" \
2693 ) \
2694 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002695
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002696#define start_stop_daemon_trivial_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002697 "[OPTIONS] [--start|--stop] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002698#define start_stop_daemon_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002699 "Program to start and stop services." \
2700 "\n\nOptions:" \
2701 "\n\t-S|--start\t\t\tstart" \
2702 "\n\t-K|--stop\t\t\tstop" \
2703 "\n\t-a|--startas <pathname>\t\tstarts process specified by pathname" \
2704 "\n\t-b|--background\t\t\tforce process into background" \
2705 "\n\t-u|--user <username>|<uid>\tstop this user's processes" \
2706 "\n\t-x|--exec <executable>\t\tprogram to either start or check" \
2707 "\n\t-m|--make-pidfile <filename>\tcreate the -p file and enter pid in it" \
2708 "\n\t-n|--name <process-name>\tstop processes with this name" \
2709 "\n\t-p|--pidfile <pid-file>\t\tsave or load pid using a pid-file" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002710 "\n\t-q|--quiet\t\t\tbe quiet" \
Bernhard Reutner-Fischera926f8e2006-06-11 17:24:01 +00002711USE_FEATURE_START_STOP_DAEMON_FANCY( \
2712 "\n\t-o|--oknodo\t\t\texit status 0 if nothing done" \
2713 "\n\t-v|--verbose\t\t\tbe verbose" \
2714) \
Rob Landleyf0623a22006-07-17 00:35:07 +00002715 "\n\t-s|--signal <signal>\t\tsignal to send (default TERM)" \
2716 "\n\t-U|--chuid <username>|<uid>\tstart process with this name"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002717
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002718#ifdef CONFIG_FEATURE_STAT_FORMAT
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002719# define USAGE_STAT_FORMAT(a) a
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002720#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002721# define USAGE_STAT_FORMAT(a)
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002722#endif
2723#define stat_trivial_usage \
2724 "[OPTION] FILE..."
2725#define stat_full_usage \
2726 "display file (default) or filesystem status.\n\n" \
2727 "Options:\n" \
2728 USAGE_STAT_FORMAT("\t-c fmt\tuse the specified format\n") \
2729 "\t-f\tdisplay filesystem status\n" \
2730 "\t-L,-l\tdereference links\n" \
2731 "\t-t\tdisplay info in terse form\n" \
2732 USAGE_STAT_FORMAT( \
2733 "\nValid format sequences for files:\n" \
2734 " %a Access rights in octal\n" \
2735 " %A Access rights in human readable form\n" \
2736 " %b Number of blocks allocated (see %B)\n" \
2737 " %B The size in bytes of each block reported by %b\n" \
2738 " %d Device number in decimal\n" \
2739 " %D Device number in hex\n" \
2740 " %f Raw mode in hex\n" \
2741 " %F File type\n" \
2742 " %g Group ID of owner\n" \
2743 " %G Group name of owner\n" \
2744 " %h Number of hard links\n" \
2745 " %i Inode number\n" \
2746 " %n File name\n" \
2747 " %N Quoted file name with dereference if symbolic link\n" \
2748 " %o I/O block size\n" \
2749 " %s Total size, in bytes\n" \
2750 " %t Major device type in hex\n" \
2751 " %T Minor device type in hex\n" \
2752 " %u User ID of owner\n" \
2753 " %U User name of owner\n" \
2754 " %x Time of last access\n" \
2755 " %X Time of last access as seconds since Epoch\n" \
2756 " %y Time of last modification\n" \
2757 " %Y Time of last modification as seconds since Epoch\n" \
2758 " %z Time of last change\n" \
2759 " %Z Time of last change as seconds since Epoch\n" \
2760 "\nValid format sequences for file systems:\n" \
2761 " %a Free blocks available to non-superuser\n" \
2762 " %b Total data blocks in file system\n" \
2763 " %c Total file nodes in file system\n" \
2764 " %d Free file nodes in file system\n" \
2765 " %f Free blocks in file system\n" \
2766 " %i File System ID in hex\n" \
2767 " %l Maximum length of filenames\n" \
2768 " %n File name\n" \
2769 " %s Block size (for faster transfers)\n" \
2770 " %S Fundamental block size (for block counts)\n" \
2771 " %t Type in hex\n" \
2772 " %T Type in human readable form\n" \
2773 )
2774
Eric Andersenef5e8f82002-11-07 02:09:37 +00002775#define strings_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002776 "[-afo] [-n length] [file ... ]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002777#define strings_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002778 "Display printable strings in a binary file." \
2779 "\n\nOptions:" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002780 "\n\t-a\tScan the whole files (this is the default)." \
Eric Andersen178de172004-04-06 16:36:20 +00002781 "\n\t-f\tPrecede each string with the name of the file where it was found." \
2782 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002783 "\n\t-o\tEach string is preceded by its decimal offset in the file"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002784
Eric Andersen7e9276b2001-02-22 01:15:47 +00002785#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002786 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002787#define stty_full_usage \
2788 "Without arguments, prints baud rate, line discipline," \
2789 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002790 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00002791 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002792 "\n\t-a\t\tprint all current settings in human-readable form" \
2793 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00002794 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002795
Robert Griebl1fca5582002-06-04 20:45:46 +00002796#define su_trivial_usage \
2797 "[OPTION]... [-] [username]"
2798#define su_full_usage \
2799 "Change user id or become root.\n" \
2800 "Options:\n" \
Bernhard Reutner-Fischer5a620ea2006-01-19 18:04:15 +00002801 "\t-p, -m\tPreserve environment" \
2802 "\n\t-c\tCommand to pass to 'sh -c'" \
2803 "\n\t-s\tShell to use instead of default shell"
Robert Griebl1fca5582002-06-04 20:45:46 +00002804
Eric Andersen27f64e12002-06-23 04:24:25 +00002805#define sulogin_trivial_usage \
2806 "[OPTION]... [tty-device]"
2807#define sulogin_full_usage \
2808 "Single user login\n" \
2809 "Options:\n" \
2810 "\t-f\tDo not authenticate (user already authenticated)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002811 "\t-h\tName of the remote host for this login\n" \
2812 "\t-p\tPreserve environment"
Eric Andersen27f64e12002-06-23 04:24:25 +00002813
Mike Frysinger95d3c452005-04-21 23:29:24 +00002814#define sum_trivial_usage \
2815 "[rs] [files...]"
2816#define sum_full_usage \
2817 "checksum and count the blocks in a file\n\n" \
2818 "Options:\n" \
2819 "\t-r\tuse BSD sum algorithm (1K blocks)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002820 "\t-s\tuse System V sum algorithm (512byte blocks)"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002821
Eric Andersen7e9276b2001-02-22 01:15:47 +00002822#define swapoff_trivial_usage \
Mike Frysinger68071e42005-09-13 02:26:24 +00002823 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002824#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002825 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002826 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002827 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002828
Eric Andersen7e9276b2001-02-22 01:15:47 +00002829#define swapon_trivial_usage \
Mike Frysinger68071e42005-09-13 02:26:24 +00002830 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002831#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002832 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002833 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002834 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002835
Rob Landley0f34a822005-10-27 22:55:50 +00002836#define switch_root_trivial_usage \
Rob Landley70f7ef72005-12-13 08:21:33 +00002837 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00002838#define switch_root_full_usage \
2839 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Rob Landley70f7ef72005-12-13 08:21:33 +00002840 "and exec NEW_INIT.\n\n" \
2841 "Options:\n" \
2842 "\t-c\tRedirect console to device on new root"
Rob Landley0f34a822005-10-27 22:55:50 +00002843
Eric Andersen7e9276b2001-02-22 01:15:47 +00002844#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002845 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002846#define sync_full_usage \
2847 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002848
Eric Andersen7e9276b2001-02-22 01:15:47 +00002849
Eric Andersen29c77f72003-10-09 09:43:18 +00002850#ifdef CONFIG_FEATURE_ROTATE_LOGFILE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002851# define USAGE_ROTATE_LOGFILE(a) a
Eric Andersen29c77f72003-10-09 09:43:18 +00002852#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002853# define USAGE_ROTATE_LOGFILE(a)
Eric Andersen29c77f72003-10-09 09:43:18 +00002854#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002855#ifdef CONFIG_FEATURE_REMOTE_LOG
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002856# define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002857#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002858# define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002859#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00002860#ifdef CONFIG_FEATURE_IPC_SYSLOG
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002861# define USAGE_IPC_LOG(a) a
Robert Griebl65d415d2002-08-07 21:10:19 +00002862#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002863# define USAGE_IPC_LOG(a)
Robert Griebl65d415d2002-08-07 21:10:19 +00002864#endif
2865
Eric Andersenb9050282003-12-24 06:02:11 +00002866#define sysctl_trivial_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002867 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00002868#define sysctl_full_usage \
2869 "configure kernel parameters at runtime\n\n" \
Eric Andersenb9050282003-12-24 06:02:11 +00002870 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002871 "\t-n\tUse this option to disable printing of the key name when printing values\n" \
2872 "\t-w\tUse this option when you want to change a sysctl setting\n" \
2873 "\t-p\tLoad in sysctl settings from the file specified or /etc/sysctl.conf if none given\n" \
2874 "\t-a\tDisplay all values currently available\n" \
2875 "\t-A\tDisplay all values currently available in table form"
Eric Andersen5d38f5b2005-09-12 21:42:48 +00002876#define sysctl_example_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002877 "sysctl [-n] variable ...\n" \
2878 "sysctl [-n] -w variable=value ...\n" \
2879 "sysctl [-n] -a\n" \
2880 "sysctl [-n] -p <file>\t(default /etc/sysctl.conf)\n" \
2881 "sysctl [-n] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00002882
Eric Andersen7e9276b2001-02-22 01:15:47 +00002883#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002884 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002885#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002886 "Linux system and kernel logging utility.\n" \
2887 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002888 "Options:\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002889 "\t-m MIN\t\tMinutes between MARK lines (default=20, 0=off)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002890 "\t-n\t\tRun as a foreground process\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002891 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)\n" \
2892 "\t-S\t\tMake logging output smaller." \
Eric Andersen29c77f72003-10-09 09:43:18 +00002893 USAGE_ROTATE_LOGFILE( \
Eric Andersen178de172004-04-06 16:36:20 +00002894 "\n\t-s SIZE\t\tMax size (KB) before rotate (default=200KB, 0=off)\n" \
2895 "\t-b NUM\t\tNumber of rotated logs to keep (default=1, max=99, 0=purge)") \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002896 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00002897 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00002898 "\t-L\t\tLog locally and via network logging (default is network only)") \
2899 USAGE_IPC_LOG( \
Eric Andersend4a5e252003-12-19 11:32:14 +00002900 "\n\t-C [size(KiB)]\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002901#define syslogd_example_usage \
2902 "$ syslogd -R masterlog:514\n" \
2903 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002904
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002905
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002906#ifndef CONFIG_FEATURE_FANCY_TAIL
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002907# define USAGE_UNSIMPLE_TAIL(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00002908#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002909# define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002910#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002911#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002912 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002913#define tail_full_usage \
2914 "Print last 10 lines of each FILE to standard output.\n" \
2915 "With more than one FILE, precede each with a header giving the\n" \
2916 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
2917 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002918 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002919 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
2920 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002921 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002922 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
2923 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002924 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002925 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002926 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
2927#define tail_example_usage \
2928 "$ tail -n 1 /etc/resolv.conf\n" \
2929 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002930
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002931#ifdef CONFIG_FEATURE_TAR_CREATE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002932# define USAGE_TAR_CREATE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002933#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002934# define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002935#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002936#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002937# define USAGE_TAR_EXCLUDE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002938#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002939# define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002940#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002941#ifdef CONFIG_FEATURE_TAR_GZIP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002942# define USAGE_TAR_GZIP(a) a
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002943#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002944# define USAGE_TAR_GZIP(a)
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002945#endif
2946#ifdef CONFIG_FEATURE_TAR_BZIP2
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002947# define USAGE_TAR_BZIP2(a) a
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002948#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002949# define USAGE_TAR_BZIP2(a)
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002950#endif
Rob Landleyc1d69902006-01-20 18:28:50 +00002951#ifdef CONFIG_FEATURE_TAR_LZMA
2952# define USAGE_TAR_LZMA(a) a
2953#else
2954# define USAGE_TAR_LZMA(a)
2955#endif
Glenn L McGrath7370f622003-11-18 21:49:23 +00002956#ifdef CONFIG_FEATURE_TAR_COMPRESS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002957# define USAGE_TAR_COMPRESS(a) a
Glenn L McGrath7370f622003-11-18 21:49:23 +00002958#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002959# define USAGE_TAR_COMPRESS(a)
Glenn L McGrath7370f622003-11-18 21:49:23 +00002960#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002961
Eric Andersen7e9276b2001-02-22 01:15:47 +00002962#define tar_trivial_usage \
Rob Landleyc1d69902006-01-20 18:28:50 +00002963 "-[" 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 +00002964 USAGE_TAR_EXCLUDE("[-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00002965 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002966#define tar_full_usage \
2967 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00002968 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002969 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002970 "\tx\t\textract\n" \
2971 "\tt\t\tlist\n" \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002972 "\nArchive format selection:\n" \
2973 USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
2974 USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
Rob Landleyc1d69902006-01-20 18:28:50 +00002975 USAGE_TAR_LZMA("\ta\t\tFilter the archive through lzma\n") \
Glenn L McGrath0c5d9c22003-11-18 23:27:49 +00002976 USAGE_TAR_COMPRESS("\tZ\t\tFilter the archive through compress\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002977 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00002978 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002979 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002980 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002981 "\texclude\t\tfile to exclude\n" \
2982 "\tX\t\tfile with names to exclude\n" \
2983 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00002984 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002985 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002986#define tar_example_usage \
2987 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
2988 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002989
Eric Andersen7e9276b2001-02-22 01:15:47 +00002990#define tee_trivial_usage \
2991 "[OPTION]... [FILE]..."
2992#define tee_full_usage \
2993 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002994 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002995 "\t-a\tappend to the given FILEs, do not overwrite\n" \
2996 "\t-i\tignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002997#define tee_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002998 "$ echo \"Hello\" | tee /tmp/foo\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002999 "$ cat /tmp/foo\n" \
3000 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003001
Eric Andersen539ffc92004-02-22 12:25:47 +00003002#ifdef CONFIG_FEATURE_TELNET_AUTOLOGIN
3003#define telnet_trivial_usage \
3004 "[-a] [-l USER] HOST [PORT]"
3005#define telnet_full_usage \
3006 "Telnet is used to establish interactive communication with another\n" \
3007 "computer over a network using the TELNET protocol.\n\n" \
3008 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003009 "\t-a\t\tAttempt an automatic login with the USER variable\n" \
3010 "\t-l USER\t\tAttempt an automatic login with the USER argument\n" \
Eric Andersen539ffc92004-02-22 12:25:47 +00003011 "\tHOST\t\tThe official name, alias or the IP address of the\n" \
3012 "\t\t\tremote host.\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003013 "\tPORT\t\tThe remote port number to connect to. If it is not\n" \
Eric Andersen178de172004-04-06 16:36:20 +00003014 "\t\t\tspecified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00003015#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003016#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003017 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003018#define telnet_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003019 "Telnet is used to establish interactive communication with another\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003020 "computer over a network using the TELNET protocol."
Eric Andersen539ffc92004-02-22 12:25:47 +00003021#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003022
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003023#ifdef CONFIG_FEATURE_TELNETD_INETD
3024#define telnetd_trivial_usage \
3025 "(inetd mode) [OPTION]"
3026#define telnetd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003027 "Telnetd uses incoming TELNET connections via inetd.\n" \
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003028 "Options:\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00003029 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003030 "\t-f issue_file\tDisplay issue_file instead of /etc/issue"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003031#else
Eric Andersen08a72202002-09-30 20:52:10 +00003032#define telnetd_trivial_usage \
3033 "[OPTION]"
3034#define telnetd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003035 "Telnetd listens for incoming TELNET connections on PORT.\n" \
Eric Andersen08a72202002-09-30 20:52:10 +00003036 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003037 "\t-p PORT\tlisten for connections on PORT (default 23)\n" \
3038 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)\n" \
3039 "\t-f issue_file\tDisplay issue_file instead of /etc/issue"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003040#endif
Eric Andersen08a72202002-09-30 20:52:10 +00003041
Eric Andersen7e9276b2001-02-22 01:15:47 +00003042#define test_trivial_usage \
3043 "EXPRESSION\n or [ EXPRESSION ]"
3044#define test_full_usage \
3045 "Checks file types and compares values returning an exit\n" \
3046 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003047#define test_example_usage \
3048 "$ test 1 -eq 2\n" \
3049 "$ echo $?\n" \
3050 "1\n" \
3051 "$ test 1 -eq 1\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00003052 "$ echo $?\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003053 "0\n" \
3054 "$ [ -d /etc ]\n" \
3055 "$ echo $?\n" \
3056 "0\n" \
3057 "$ [ -d /junk ]\n" \
3058 "$ echo $?\n" \
3059 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003060
Eric Andersenbdfd0d72001-10-24 05:00:29 +00003061#ifdef CONFIG_FEATURE_TFTP_GET
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003062# define USAGE_TFTP_GET(a) a
Mark Whitley450736c2001-03-02 19:08:50 +00003063#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003064# define USAGE_TFTP_GET(a)
Mark Whitley450736c2001-03-02 19:08:50 +00003065#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00003066#ifdef CONFIG_FEATURE_TFTP_PUT
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003067# define USAGE_TFTP_PUT(a) a
Mark Whitley450736c2001-03-02 19:08:50 +00003068#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003069# define USAGE_TFTP_PUT(a)
Mark Whitley450736c2001-03-02 19:08:50 +00003070#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00003071#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003072# define USAGE_TFTP_BS(a) a
Glenn L McGrathad117d82001-10-05 04:40:37 +00003073#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003074# define USAGE_TFTP_BS(a)
Glenn L McGrathad117d82001-10-05 04:40:37 +00003075#endif
Mark Whitley450736c2001-03-02 19:08:50 +00003076
3077#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00003078 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00003079#define tftp_full_usage \
3080 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00003081 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003082 "\t-l FILE\tLocal FILE\n" \
3083 "\t-r FILE\tRemote FILE" \
3084 USAGE_TFTP_GET( \
3085 "\n\t-g\tGet file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003086 ) \
Mike Frysinger058e7402005-04-23 07:00:33 +00003087 USAGE_TFTP_PUT( \
3088 "\n\t-p\tPut file" \
Mark Whitley450736c2001-03-02 19:08:50 +00003089 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00003090 USAGE_TFTP_BS( \
Mike Frysinger058e7402005-04-23 07:00:33 +00003091 "\n\t-b SIZE\tTransfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00003092 )
Eric Andersenc3657422001-11-30 07:54:32 +00003093#define time_trivial_usage \
3094 "[OPTION]... COMMAND [ARGS...]"
3095#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00003096 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
3097 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00003098 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003099 "\t-v\tDisplays verbose resource usage information"
Mark Whitley450736c2001-03-02 19:08:50 +00003100
Eric Andersen420b2082002-09-17 22:14:58 +00003101#define top_trivial_usage \
3102 "[-d <seconds>]"
3103#define top_full_usage \
3104 "top provides an view of processor activity in real time.\n" \
3105 "This utility reads the status for all processes in /proc each <seconds>\n" \
3106 "and shows the status for however many processes will fit on the screen.\n" \
3107 "This utility will not show processes that are started after program startup,\n" \
3108 "but it will show the EXIT status for and PIDs that exit while it is running."
3109
Eric Andersen7e9276b2001-02-22 01:15:47 +00003110#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003111 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003112#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003113 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003114 "Options:\n" \
3115 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003116#define touch_example_usage \
3117 "$ ls -l /tmp/foo\n" \
3118 "/bin/ls: /tmp/foo: No such file or directory\n" \
3119 "$ touch /tmp/foo\n" \
3120 "$ ls -l /tmp/foo\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003121 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003122
3123#define tr_trivial_usage \
3124 "[-cds] STRING1 [STRING2]"
3125#define tr_full_usage \
3126 "Translate, squeeze, and/or delete characters from\n" \
3127 "standard input, writing to standard output.\n\n" \
3128 "Options:\n" \
3129 "\t-c\ttake complement of STRING1\n" \
3130 "\t-d\tdelete input characters coded STRING1\n" \
3131 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003132#define tr_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003133 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003134 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003135
Eric Andersen5c58d282001-07-10 16:29:00 +00003136#define traceroute_trivial_usage \
"Vladimir N. Oleynik"45a8ed82005-09-06 16:08:33 +00003137 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
3138 "\t[-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
3139 "\t[-z pausemsecs] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00003140#define traceroute_full_usage \
3141 "trace the route ip packets follow going to \"host\"\n" \
3142 "Options:\n" \
"Vladimir N. Oleynik"45a8ed82005-09-06 16:08:33 +00003143 "\t-F\tSet the don't fragment bit\n" \
3144 "\t-I\tUse ICMP ECHO instead of UDP datagrams\n" \
3145 "\t-l\tDisplay the ttl value of the returned packet\n" \
3146 "\t-d\tSet SO_DEBUG options to socket\n" \
Eric Andersen5c58d282001-07-10 16:29:00 +00003147 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
3148 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
3149 "\t-v\tVerbose output\n" \
3150 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
3151 "\t-p port#\tSet the base UDP port number used in probes\n" \
3152 "\t\t(default is 33434)\n" \
3153 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
3154 "\t\t(default is 3)\n" \
3155 "\t-s src_addr\tUse the following IP address as the source address\n" \
3156 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
3157 "\t\t(default 0)\n" \
3158 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
Mike Frysinger036f2992005-09-24 23:50:14 +00003159 "\t\t(default 3 sec)\n" \
3160 "\t-g\tSpecify a loose source route gateway (8 maximum)"
Eric Andersen5c58d282001-07-10 16:29:00 +00003161
3162
Eric Andersen7e9276b2001-02-22 01:15:47 +00003163#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003164 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003165#define true_full_usage \
3166 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003167#define true_example_usage \
3168 "$ true\n" \
3169 "$ echo $?\n" \
3170 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003171
Eric Andersen7e9276b2001-02-22 01:15:47 +00003172#define tty_trivial_usage \
3173 ""
3174#define tty_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003175 "Print the file name of the terminal connected to standard input.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003176 "Options:\n" \
3177 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003178#define tty_example_usage \
3179 "$ tty\n" \
3180 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003181
Mike Frysinger174808c2005-06-11 01:14:09 +00003182#define tune2fs_trivial_usage \
3183 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
3184 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
3185 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
3186 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
3187 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
3188 "[-T last-check-time] [-U UUID] device"
3189#define tune2fs_full_usage \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00003190 "Adjust filesystem options on ext[23] filesystems."
Mike Frysinger174808c2005-06-11 01:14:09 +00003191
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003192#define udhcpc_trivial_usage \
Rob Landleya2841e62006-02-20 23:26:38 +00003193 "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003194#define udhcpc_full_usage \
Paul Foxa39bba32005-08-01 14:31:13 +00003195 "\t-c,\t--clientid=CLIENTID\tSet client identifier\n" \
3196 "\t-C,\t--clientid-none\tSuppress default client identifier\n" \
Paul Fox28de9512005-09-22 18:59:13 +00003197 "\t-V,\t--vendorclass=CLASSID\tSet vendor class identifier\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003198 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00003199 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003200 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003201 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003202 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003203 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003204 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
3205 "\t-q,\t--quit\tQuit after obtaining lease\n" \
3206 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
3207 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
Rob Landleya2841e62006-02-20 23:26:38 +00003208 "\t-t,\t--retries=NUM\tSend up to NUM request packets\n"\
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003209 "\t-v,\t--version\tDisplay version"
3210
Russ Dill61fb4892002-10-14 21:41:28 +00003211#define udhcpd_trivial_usage \
3212 "[configfile]\n" \
3213
3214#define udhcpd_full_usage \
Glenn L McGrath9130c852002-12-12 12:56:18 +00003215 ""
Russ Dill61fb4892002-10-14 21:41:28 +00003216
Eric Andersenbdfd0d72001-10-24 05:00:29 +00003217#ifdef CONFIG_FEATURE_MOUNT_FORCE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003218# define USAGE_MOUNT_FORCE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00003219#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003220# define USAGE_MOUNT_FORCE(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00003221#endif
3222#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003223 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003224#define umount_full_usage \
3225 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00003226 "\nFlags:\n" "\t-a\tUnmount all file systems" \
3227 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
3228 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Rob Landley16722552005-09-24 22:41:08 +00003229 "\n\t-l\tLazy umount (detach filesystem)" \
3230 "\n\t-f\tForce umount (i.e., unreachable NFS server)" \
3231 USAGE_MOUNT_LOOP("\n\t-D\tDo not free loop device (if a loop device has been used)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003232#define umount_example_usage \
3233 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003234
3235#define uname_trivial_usage \
3236 "[OPTION]..."
3237#define uname_full_usage \
3238 "Print certain system information. With no OPTION, same as -s.\n\n" \
3239 "Options:\n" \
3240 "\t-a\tprint all information\n" \
3241 "\t-m\tthe machine (hardware) type\n" \
3242 "\t-n\tprint the machine's network node hostname\n" \
3243 "\t-r\tprint the operating system release\n" \
3244 "\t-s\tprint the operating system name\n" \
3245 "\t-p\tprint the host processor type\n" \
3246 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003247#define uname_example_usage \
3248 "$ uname -a\n" \
Eric Andersen7f48a952003-12-28 05:06:56 +00003249 "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 +00003250
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003251#define uncompress_trivial_usage \
3252 "[-c] [-f] [ name ... ]"
3253#define uncompress_full_usage \
3254 "Uncompress .Z file[s]\n" \
3255 "Options:\n" \
3256 "\t-c\textract to stdout\n" \
Eric Andersen178de172004-04-06 16:36:20 +00003257 "\t-f\tforce overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00003258
Eric Andersen7e9276b2001-02-22 01:15:47 +00003259#define uniq_trivial_usage \
Rob Landley14efdc52005-09-07 04:18:36 +00003260 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003261#define uniq_full_usage \
3262 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00003263 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003264 "Options:\n" \
3265 "\t-c\tprefix lines by the number of occurrences\n" \
3266 "\t-d\tonly print duplicate lines\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00003267 "\t-u\tonly print unique lines\n" \
3268 "\t-f N\tskip the first N fields\n" \
3269 "\t-s N\tskip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003270#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00003271 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003272 "a\n" \
3273 "b\n" \
3274 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003275
3276#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003277 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003278#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003279 "Converts FILE from unix format to dos format. When no option\n" \
3280 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00003281 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00003282 "Options:\n" \
3283 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00003284 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003285
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003286#define unzip_trivial_usage \
3287 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
3288#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00003289 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003290 "Options:\n" \
3291 "\t-l\tlist archive contents (short form)\n" \
3292 "\t-n\tnever overwrite existing files (default)\n" \
3293 "\t-o\toverwrite files without prompting\n" \
3294 "\t-p\tsend output to stdout\n" \
3295 "\t-q\tbe quiet\n" \
3296 "\t-x\texclude these files\n" \
3297 "\t-d\textract files into this directory"
3298
Eric Andersen7e9276b2001-02-22 01:15:47 +00003299#define uptime_trivial_usage \
3300 ""
3301#define uptime_full_usage \
3302 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003303#define uptime_example_usage \
3304 "$ uptime\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003305 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003306
3307#define usleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00003308 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003309#define usleep_full_usage \
3310 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003311#define usleep_example_usage \
3312 "$ usleep 1000000\n" \
3313 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003314
3315#define uudecode_trivial_usage \
3316 "[FILE]..."
3317#define uudecode_full_usage \
3318 "Uudecode a file that is uuencoded.\n\n" \
3319 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003320 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003321#define uudecode_example_usage \
3322 "$ uudecode -o busybox busybox.uu\n" \
3323 "$ ls -l busybox\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003324 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003325
3326#define uuencode_trivial_usage \
3327 "[OPTION] [INFILE] REMOTEFILE"
3328#define uuencode_full_usage \
3329 "Uuencode a file.\n\n" \
3330 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00003331 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003332#define uuencode_example_usage \
3333 "$ uuencode busybox busybox\n" \
3334 "begin 755 busybox\n" \
3335 "<encoded file snipped>\n" \
3336 "$ uudecode busybox busybox > busybox.uu\n" \
3337 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003338
Eric Andersen853c4942003-01-23 05:59:32 +00003339#define vconfig_trivial_usage \
3340 "COMMAND [OPTIONS] ..."
Eric Andersen853c4942003-01-23 05:59:32 +00003341#define vconfig_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00003342 "vconfig lets you create and remove virtual ethernet devices.\n\n" \
3343 "Options:\n" \
3344 "\tadd [interface-name] [vlan_id]\n" \
3345 "\trem [vlan-name]\n" \
3346 "\tset_flag [interface-name] [flag-num] [0 | 1]\n" \
3347 "\tset_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3348 "\tset_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3349 "\tset_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00003350
Eric Andersen3f980402001-04-04 17:31:15 +00003351#define vi_trivial_usage \
3352 "[OPTION] [FILE]..."
3353#define vi_full_usage \
3354 "edit FILE.\n\n" \
3355 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003356 "\t-R\tRead-only- do not write to the file"
Eric Andersen3f980402001-04-04 17:31:15 +00003357
Eric Andersen27f64e12002-06-23 04:24:25 +00003358#define vlock_trivial_usage \
3359 "[OPTIONS]"
3360#define vlock_full_usage \
3361 "Lock a virtual terminal. A password is required to unlock\n" \
3362 "Options:\n" \
3363 "\t-a\tLock all VTs"
3364
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003365#define watch_trivial_usage \
3366 "[-n <seconds>] COMMAND..."
3367#define watch_full_usage \
3368 "Executes a program periodically.\n" \
3369 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003370 "\t-n\tLoop period in seconds - default is 2"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003371#define watch_example_usage \
3372 "$ watch date\n" \
3373 "Mon Dec 17 10:31:40 GMT 2000\n" \
3374 "Mon Dec 17 10:31:42 GMT 2000\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003375 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003376
Eric Andersen7e9276b2001-02-22 01:15:47 +00003377#define watchdog_trivial_usage \
Mike Frysingercd68a2e2006-06-26 21:31:17 +00003378 "[-t <seconds>] [-F] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003379#define watchdog_full_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00003380 "Periodically write to watchdog device DEV.\n" \
3381 "Options:\n" \
Mike Frysingercd68a2e2006-06-26 21:31:17 +00003382 "\t-t\tTimer period in seconds - default is 30\n" \
3383 "\t-F\tStay in the foreground and don't fork"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003384
3385#define wc_trivial_usage \
3386 "[OPTION]... [FILE]..."
3387#define wc_full_usage \
3388 "Print line, word, and byte counts for each FILE, and a total line if\n" \
3389 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
3390 "Options:\n" \
3391 "\t-c\tprint the byte counts\n" \
3392 "\t-l\tprint the newline counts\n" \
3393 "\t-L\tprint the length of the longest line\n" \
3394 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003395#define wc_example_usage \
3396 "$ wc /etc/passwd\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003397 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003398
3399#define wget_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00003400 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00003401 "\t\t[--header 'header: value'] [-Y|--proxy on/off] [-P DIR] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003402#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00003403 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003404 "Options:\n" \
3405 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00003406 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00003407 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00003408 "\t-O\tsave to filename ('-' for stdout)\n" \
3409 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003410
3411#define which_trivial_usage \
3412 "[COMMAND ...]"
3413#define which_full_usage \
3414 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003415#define which_example_usage \
3416 "$ which login\n" \
3417 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00003418
Eric Andersen00a6a752002-04-26 23:53:10 +00003419#define who_trivial_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003420 " "
Eric Andersen00a6a752002-04-26 23:53:10 +00003421#define who_full_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003422 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003423
3424#define whoami_trivial_usage \
3425 ""
3426#define whoami_full_usage \
3427 "Prints the user name associated with the current effective user id."
3428
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003429#ifdef CONFIG_FEATURE_XARGS_SUPPORT_CONFIRMATION
3430#define USAGE_XARGS_CONFIRMATION(a) a
3431#else
3432#define USAGE_XARGS_CONFIRMATION(a)
3433#endif
3434#ifdef CONFIG_FEATURE_XARGS_SUPPORT_TERMOPT
3435#define USAGE_XARGS_TERMOPT(a) a
3436#else
3437#define USAGE_XARGS_TERMOPT(a)
3438#endif
3439#ifdef CONFIG_FEATURE_XARGS_SUPPORT_ZERO_TERM
3440#define USAGE_XARGS_ZERO_TERM(a) a
3441#else
3442#define USAGE_XARGS_ZERO_TERM(a)
3443#endif
3444
3445
Eric Andersen7e9276b2001-02-22 01:15:47 +00003446#define xargs_trivial_usage \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003447 "[COMMAND] [OPTIONS] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003448#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00003449 "Executes COMMAND on every item given by standard input.\n\n" \
3450 "Options:\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003451 USAGE_XARGS_CONFIRMATION("\t-p\tPrompt the user about whether to run each command\n") \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00003452 "\t-r\tDo not run command for empty read lines\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003453 USAGE_XARGS_TERMOPT("\t-x\tExit if the size is exceeded\n") \
3454 USAGE_XARGS_ZERO_TERM("\t-0\tInput filenames are terminated by a null character\n") \
Mike Frysinger058e7402005-04-23 07:00:33 +00003455 "\t-t\tPrint the command line on stderr before executing it"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003456#define xargs_example_usage \
3457 "$ ls | xargs gzip\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003458 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003459
3460#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003461 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003462#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003463 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003464
Eric Andersen7e9276b2001-02-22 01:15:47 +00003465#define zcat_trivial_usage \
3466 "FILE"
3467#define zcat_full_usage \
3468 "Uncompress to stdout."
Eric Andersen178de172004-04-06 16:36:20 +00003469
Rob Landleyad8071f2005-04-30 03:49:37 +00003470#define zcip_trivial_usage \
3471 "[OPTIONS] ifname script"
3472#define zcip_full_usage \
3473 "zcip manages a ZeroConf IPv4 link-local address.\n" \
3474 "Options:\n" \
3475 "\t-f foreground mode\n" \
3476 "\t-q quit after address (no daemon)\n" \
3477 "\t-r 169.254.x.x request this address first\n" \
Rob Landleye1ee4822006-06-24 22:39:19 +00003478 "\t-v verbose"
Rob Landleyad8071f2005-04-30 03:49:37 +00003479
Eric Andersen178de172004-04-06 16:36:20 +00003480#endif /* __BB_USAGE_H__ */