blob: 63cd79f0eeb9caa53c290d556c9ee0d9a5663ede [file] [log] [blame]
Eric Andersen178de172004-04-06 16:36:20 +00001#ifndef __BB_USAGE_H__
2#define __BB_USAGE_H__
3
Eric Andersenf349e972001-08-21 16:18:59 +00004#define addgroup_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00005 "[-g GID] group_name [user_name]"
Eric Andersenf349e972001-08-21 16:18:59 +00006#define addgroup_full_usage \
Eric Andersen192c35f2004-09-02 22:22:17 +00007 "Adds a group to the system\n\n" \
Eric Andersenf349e972001-08-21 16:18:59 +00008 "Options:\n" \
Eric Andersen178de172004-04-06 16:36:20 +00009 "\t-g GID\t\tspecify gid"
Eric Andersenf349e972001-08-21 16:18:59 +000010
11#define adduser_trivial_usage \
Eric Andersene0716ba2003-01-14 06:42:56 +000012 "[OPTIONS] user_name"
Eric Andersenf349e972001-08-21 16:18:59 +000013#define adduser_full_usage \
Eric Andersen192c35f2004-09-02 22:22:17 +000014 "Adds a user to the system\n\n" \
Eric Andersenf349e972001-08-21 16:18:59 +000015 "Options:\n" \
Eric Andersen178de172004-04-06 16:36:20 +000016 "\t-h DIR\t\tAssign home directory DIR\n" \
17 "\t-g GECOS\tAssign gecos field GECOS\n" \
18 "\t-s SHELL\tAssign login shell SHELL\n" \
19 "\t-G\t\tAdd the user to existing group GROUP\n" \
20 "\t-S\t\tcreate a system user (ignored)\n" \
21 "\t-D\t\tDo not assign a password (logins still possible via ssh)\n" \
22 "\t-H\t\tDo not create the home directory"
Eric Andersenf349e972001-08-21 16:18:59 +000023
Mark Whitley6f932772001-03-20 19:18:10 +000024#define adjtimex_trivial_usage \
25 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
26#define adjtimex_full_usage \
27 "Reads and optionally sets system timebase parameters.\n" \
28 "See adjtimex(2).\n\n" \
29 "Options:\n" \
30 "\t-q\t\tquiet mode - do not print\n" \
31 "\t-o offset\ttime offset, microseconds\n" \
32 "\t-f frequency\tfrequency adjust, integer kernel units (65536 is 1ppm)\n" \
33 "\t\t\t(positive values make the system clock run fast)\n" \
34 "\t-t tick\t\tmicroseconds per tick, usually 10000\n" \
Eric Andersen178de172004-04-06 16:36:20 +000035 "\t-p timeconstant"
Mark Whitley6f932772001-03-20 19:18:10 +000036
Eric Andersen7e9276b2001-02-22 01:15:47 +000037#define ar_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +000038 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Eric Andersen7e9276b2001-02-22 01:15:47 +000039#define ar_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +000040 "Extract or list FILES from an ar archive.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +000041 "Options:\n" \
42 "\t-o\t\tpreserve original dates\n" \
43 "\t-p\t\textract to stdout\n" \
44 "\t-t\t\tlist\n" \
45 "\t-x\t\textract\n" \
Eric Andersen178de172004-04-06 16:36:20 +000046 "\t-v\t\tverbosely list files processed"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000047
Glenn L McGrath9e598412003-01-09 10:06:01 +000048#define arping_trivial_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +000049 "[-fqbDUA] [-c count] [-w timeout] [-I device] [-s sender] target"
Glenn L McGrath9e598412003-01-09 10:06:01 +000050#define arping_full_usage \
51 "Ping hosts by ARP requests/replies.\n\n" \
52 "Options:\n" \
53 "\t-f\t\tQuit on first ARP reply\n" \
54 "\t-q\t\tBe quiet\n" \
55 "\t-b\t\tKeep broadcasting, don't go unicast\n" \
56 "\t-D\t\tDuplicated address detection mode\n" \
57 "\t-U\t\tUnsolicited ARP mode, update your neighbours\n" \
58 "\t-A\t\tARP answer mode, update your neighbours\n" \
59 "\t-c count\tStop after sending count ARP request packets\n" \
60 "\t-w timeout\tTime to wait for ARP reply, in seconds\n" \
61 "\t-I device\tOutgoing interface name, default is eth0\n" \
62 "\t-s sender\tSet specific sender IP address\n" \
Eric Andersen178de172004-04-06 16:36:20 +000063 "\ttarget\t\tTarget IP address of ARP request"
Glenn L McGrath9e598412003-01-09 10:06:01 +000064
Eric Andersen08f59e32004-03-12 22:07:10 +000065#define ash_trivial_usage \
66 "[FILE]...\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +000067 "or: ash -c command [args]..."
Eric Andersen08f59e32004-03-12 22:07:10 +000068#define ash_full_usage \
69 "The ash shell (command interpreter)"
70
71#define awk_trivial_usage \
72 "[OPTION]... [program-text] [FILE ...]"
73#define awk_full_usage \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000074 "Options:\n" \
Mike Frysinger4fcefb92006-02-06 23:38:59 +000075 "\t-v var=val\tassign value 'val' to variable 'var'\n" \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000076 "\t-F sep\t\tuse 'sep' as field separator\n" \
Mike Frysinger4fcefb92006-02-06 23:38:59 +000077 "\t-f progname\tread program source from file 'progname'"
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000078
Eric Andersen7e9276b2001-02-22 01:15:47 +000079#define basename_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000080 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000081#define basename_full_usage \
82 "Strips directory path and suffixes from FILE.\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000083 "If specified, also removes any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000084#define basename_example_usage \
85 "$ basename /usr/local/bin/foo\n" \
86 "foo\n" \
87 "$ basename /usr/local/bin/\n" \
88 "bin\n" \
89 "$ basename /foo/bar.txt .txt\n" \
90 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000091
Glenn L McGrath24e28332001-10-05 03:48:57 +000092#define bunzip2_trivial_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000093 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +000094#define bunzip2_full_usage \
Matt Kraai9cdb0602002-03-27 17:31:01 +000095 "Uncompress FILE (or standard input if FILE is '-' or omitted).\n\n" \
96 "Options:\n" \
97 "\t-c\tWrite output to standard output\n" \
98 "\t-f\tForce"
Glenn L McGrath24e28332001-10-05 03:48:57 +000099
Rob Landley6130b9b2006-01-23 21:10:38 +0000100#define busybox_notes_usage \
101 "Hello world!\n"
102
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000103#define bzcat_trivial_usage \
104 "FILE"
105#define bzcat_full_usage \
106 "Uncompress to stdout."
107
Rob Landleyc1d69902006-01-20 18:28:50 +0000108#define unlzma_trivial_usage \
109 "[OPTION]... [FILE]"
110#define unlzma_full_usage \
111 "Uncompress FILE (or standard input if FILE is '-' or omitted).\n\n" \
112 "Options:\n" \
113 "\t-c\tWrite output to standard output\n" \
114 "\t-f\tForce"
115
116#define lzmacat_trivial_usage \
117 "FILE"
118#define lzmacat_full_usage \
119 "Uncompress to stdout."
120
Eric Andersenc98c0622001-12-06 15:16:43 +0000121#define cal_trivial_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000122 "[-jy] [[month] year]"
Eric Andersenc98c0622001-12-06 15:16:43 +0000123#define cal_full_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000124 "Display a calendar.\n" \
125 "\nOptions:\n" \
126 "\t-j\tUse julian dates\n" \
127 "\t-y\tDisplay the entire year"
Eric Andersenc98c0622001-12-06 15:16:43 +0000128
Eric Andersen7e9276b2001-02-22 01:15:47 +0000129#define cat_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000130 "[-u] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000131#define cat_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000132 "Concatenates FILE(s) and prints them to stdout.\n\n" \
133 "Options:\n" \
134 "\t-u\tignored since unbuffered i/o is always used"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000135#define cat_example_usage \
136 "$ cat /proc/uptime\n" \
137 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000138
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000139#define chattr_trivial_usage \
140 "[-R] [-+=AacDdijsStTu] [-v version] files..."
141#define chattr_full_usage \
142 "change file attributes on an ext2 fs\n\n" \
143 "Modifiers:\n" \
144 "\t-\tremove attributes\n" \
145 "\t+\tadd attributes\n" \
146 "\t=\tset attributes\n" \
147 "Attributes:\n" \
148 "\tA\tdon't track atime\n" \
149 "\ta\tappend mode only\n" \
150 "\tc\tenable compress\n" \
151 "\tD\twrite dir contents synchronously\n" \
152 "\td\tdo not backup with dump\n" \
153 "\ti\tcannot be modified (immutable)\n" \
154 "\tj\twrite all data to journal first\n" \
155 "\ts\tzero disk storage when deleted\n" \
156 "\tS\twrite file contents synchronously\n" \
157 "\tt\tdisable tail-merging of partial blocks with other files\n" \
158 "\tu\tallow file to be undeleted\n" \
159 "Options:\n" \
160 "\t-R\trecursively list subdirectories\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000161 "\t-v\tset the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000162
Eric Andersen7e9276b2001-02-22 01:15:47 +0000163#define chgrp_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000164 "[OPTION]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000165#define chgrp_full_usage \
166 "Change the group membership of each FILE to GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000167 "\nOptions:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000168 "\t-R\tChanges files and directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000169#define chgrp_example_usage \
170 "$ ls -l /tmp/foo\n" \
171 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
172 "$ chgrp root /tmp/foo\n" \
173 "$ ls -l /tmp/foo\n" \
174 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000175
Eric Andersen7e9276b2001-02-22 01:15:47 +0000176#define chmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000177 "[-R] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000178#define chmod_full_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000179 "Each MODE is one or more of the letters ugoa, one of the\n" \
180 "symbols +-= and one or more of the letters rwxst.\n\n" \
181 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000182 "\t-R\tChanges files and directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000183#define chmod_example_usage \
184 "$ ls -l /tmp/foo\n" \
185 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
186 "$ chmod u+x /tmp/foo\n" \
187 "$ ls -l /tmp/foo\n" \
188 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
189 "$ chmod 444 /tmp/foo\n" \
190 "$ ls -l /tmp/foo\n" \
191 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000192
Eric Andersen7e9276b2001-02-22 01:15:47 +0000193#define chown_trivial_usage \
Eric Andersen238da242001-05-11 16:31:46 +0000194 "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000195#define chown_full_usage \
196 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000197 "\nOptions:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000198 "\t-R\tChanges files and directories recursively\n" \
199 "\t-h\tDo not dereference symbolic links"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000200#define chown_example_usage \
201 "$ ls -l /tmp/foo\n" \
202 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
203 "$ chown root /tmp/foo\n" \
204 "$ ls -l /tmp/foo\n" \
205 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
206 "$ chown root.root /tmp/foo\n" \
207 "ls -l /tmp/foo\n" \
208 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000209
Eric Andersen7e9276b2001-02-22 01:15:47 +0000210#define chroot_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000211 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000212#define chroot_full_usage \
213 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000214#define chroot_example_usage \
215 "$ ls -l /bin/ls\n" \
216 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000217 "# mount /dev/hdc1 /mnt -t minix\n" \
218 "# chroot /mnt\n" \
219 "# ls -l /bin/ls\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000220 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000221
Eric Andersen7e9276b2001-02-22 01:15:47 +0000222#define chvt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000223 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000224#define chvt_full_usage \
225 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000226
Eric Andersen7e9276b2001-02-22 01:15:47 +0000227#define clear_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000228 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000229#define clear_full_usage \
230 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000231
Eric Andersen7e9276b2001-02-22 01:15:47 +0000232#define cmp_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000233 "[-l] [-s] FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000234#define cmp_full_usage \
Mike Frysinger4d149202005-05-12 22:36:07 +0000235 "Compares FILE1 vs stdin if FILE2 is not specified.\n\n" \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000236 "Options:\n" \
237 "\t-l\tWrite the byte numbers (decimal) and values (octal)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000238 "\t\t for all differing bytes\n" \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +0000239 "\t-s\tquiet mode - do not print"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000240
Rob Landley2acfd7b2005-05-11 23:12:49 +0000241#define comm_trivial_usage \
242 "[-123] FILE1 FILE2"
243#define comm_full_usage \
Mike Frysinger4d149202005-05-12 22:36:07 +0000244 "Compares FILE1 to FILE2, or to stdin if = is specified.\n\n" \
Rob Landley2acfd7b2005-05-11 23:12:49 +0000245 "Options:\n" \
246 "\t-1\tSuppress lines unique to FILE1\n" \
247 "\t-2\tSuppress lines unique to FILE2\n" \
248 "\t-3\tSuppress lines common to both files"
249
Paul Fox79c142d2005-08-01 16:04:40 +0000250#define bbconfig_trivial_usage \
251 ""
252#define bbconfig_full_usage \
253 "Print the config file which built busybox\n"
Mike Frysinger036f2992005-09-24 23:50:14 +0000254
Eric Andersen7e9276b2001-02-22 01:15:47 +0000255#define cp_trivial_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000256 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000257#define cp_full_usage \
258 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
259 "\n" \
260 "\t-a\tSame as -dpR\n" \
Mike Frysinger6077d902005-01-07 00:56:47 +0000261 "\t-d,-P\tPreserves links\n" \
Mike Frysinger2ed05ab2005-04-14 02:52:50 +0000262 "\t-H,-L\tDereference all symlinks (implied by default)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000263 "\t-p\tPreserves file attributes if possible\n" \
264 "\t-f\tforce (implied; ignored) - always set\n" \
Eric Andersenced97052004-02-20 09:55:37 +0000265 "\t-i\tinteractive, prompt before overwrite\n" \
266 "\t-R,-r\tCopies directories recursively"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000267
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000268#define cpio_trivial_usage \
269 "-[dimtuv][F cpiofile]"
270#define cpio_full_usage \
271 "Extract or list files from a cpio archive\n" \
272 "Main operation mode:\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000273 "\td\t\tmake leading directories\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000274 "\ti\t\textract\n" \
Glenn L McGrath2e6d3cf2001-06-24 12:36:54 +0000275 "\tm\t\tpreserve mtime\n" \
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000276 "\tt\t\tlist\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000277 "\tv\t\tverbose\n" \
Eric Andersen6925d502001-12-16 09:23:09 +0000278 "\tu\t\tunconditional overwrite\n" \
279 "\tF\t\tinput from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000280
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000281#define crond_trivial_usage \
282 "-d[#] -c <crondir> -f -b"
283#define crond_full_usage \
284 "\t-d [#] -l [#] -S -L logfile -f -b -c dir\n" \
285 "\t-d num\tdebug level\n" \
286 "\t-l num\tlog level (8 - default)\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +0000287 "\t-S\tlog to syslogd (default)\n" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000288 "\t-L file\tlog to file\n" \
289 "\t-f\trun in fordeground\n" \
290 "\t-b\trun in background (default)\n" \
291 "\t-c dir\tworking dir"
292
293#define crontab_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000294 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000295#define crontab_full_usage \
296 "\tfile <opts> replace crontab from file\n" \
297 "\t- <opts> replace crontab from stdin\n" \
298 "\t-u user specify user\n" \
299 "\t-l [user] list crontab for user\n" \
300 "\t-e [user] edit crontab for user\n" \
301 "\t-d [user] delete crontab for user\n" \
302 "\t-c dir specify crontab directory"
303
304
Eric Andersen7e9276b2001-02-22 01:15:47 +0000305#define cut_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000306 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000307#define cut_full_usage \
308 "Prints selected fields from each input FILE to standard output.\n\n" \
309 "Options:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000310 "\t-b LIST\t\tOutput only bytes from LIST\n" \
311 "\t-c LIST\t\tOutput only characters from LIST\n" \
312 "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \
313 "\t-s\t\tOutput only the lines containing delimiter\n" \
314 "\t-f N\t\tPrint only these fields\n" \
315 "\t-n\t\tIgnored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000316#define cut_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +0000317 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000318 "Hello\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000319 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000320 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000321
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000322#ifdef CONFIG_FEATURE_DATE_ISOFMT
323#define USAGE_DATE_ISOFMT(a) a
324#else
325#define USAGE_DATE_ISOFMT(a)
326#endif
327
Eric Andersen7e9276b2001-02-22 01:15:47 +0000328#define date_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +0000329 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000330#define date_full_usage \
331 "Displays the current time in the given FORMAT, or sets the system date.\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000332 "\nOptions:\n" \
Eric Andersen41492d62001-02-23 00:05:56 +0000333 "\t-R\t\tOutputs RFC-822 compliant date string\n" \
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000334 "\t-d STRING\tDisplays time described by STRING, not `now'\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000335 USAGE_DATE_ISOFMT("\t-I[TIMESPEC]\tOutputs an ISO-8601 compliant date/time string\n" \
Glenn L McGrath2ce002a2003-08-29 14:18:26 +0000336 "\t\t\tTIMESPEC=`date' (or missing) for date only,\n" \
337 "\t\t\t`hours', `minutes', or `seconds' for date and,\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000338 "\t\t\ttime to the indicated precision\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000339 "\t-s\t\tSets time described by STRING\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000340 "\t-r FILE\t\tDisplays the last modification time of FILE\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000341 "\t-u\t\tPrints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000342#define date_example_usage \
343 "$ date\n" \
344 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000345
Eric Andersen7e9276b2001-02-22 01:15:47 +0000346#define dc_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000347 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000348#define dc_full_usage \
349 "This is a Tiny RPN calculator that understands the\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000350 "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \
Eric Andersena9287742003-10-22 11:24:39 +0000351 "**, exp, and, or, not, eor.\n" \
352 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16.\n" \
353 "\nOptions:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000354 "p - Prints the value on the top of the stack, without altering the stack\n" \
355 "f - Prints the entire contents of the stack without altering anything\n" \
356 "o - Pops the value off the top of the stack and uses it to set the output radix\n" \
357 " Only 10 and 16 are supported"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000358#define dc_example_usage \
Eric Andersen9ab46572004-08-18 17:57:16 +0000359 "$ dc 2 2 + p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000360 "4\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000361 "$ dc 8 8 \\* 2 2 + / p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000362 "16\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000363 "$ dc 0 1 and p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000364 "0\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000365 "$ dc 0 1 or p\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000366 "1\n" \
Eric Andersen9ab46572004-08-18 17:57:16 +0000367 "$ echo 72 9 div 8 mul p | dc\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000368 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000369
Eric Andersen7e9276b2001-02-22 01:15:47 +0000370#define dd_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000371 "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000372 "\t [seek=N] [conv=notrunc|noerror|sync]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000373#define dd_full_usage \
374 "Copy a file, converting and formatting according to options\n\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000375 "\tif=FILE\t\tread from FILE instead of stdin\n" \
376 "\tof=FILE\t\twrite to FILE instead of stdout\n" \
377 "\tbs=N\t\tread and write N bytes at a time\n" \
378 "\tcount=N\t\tcopy only N input blocks\n" \
379 "\tskip=N\t\tskip N input blocks\n" \
380 "\tseek=N\t\tskip N output blocks\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000381 "\tconv=notrunc\tdon't truncate output file\n" \
Eric Andersenef38b392002-04-27 01:31:43 +0000382 "\tconv=noerror\tcontinue after read errors\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000383 "\tconv=sync\tpad blocks with zeros\n" \
384 "\n" \
385 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000386 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000387#define dd_example_usage \
388 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
389 "4+0 records in\n" \
390 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000391
Eric Andersen7e9276b2001-02-22 01:15:47 +0000392#define deallocvt_trivial_usage \
Glenn L McGrath17b4a202004-01-15 11:50:19 +0000393 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000394#define deallocvt_full_usage \
395 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000396
Eric Andersenf349e972001-08-21 16:18:59 +0000397#define delgroup_trivial_usage \
398 "GROUP"
399#define delgroup_full_usage \
400 "Deletes group GROUP from the system"
401
402#define deluser_trivial_usage \
403 "USER"
404#define deluser_full_usage \
405 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000406
Eric Andersenf18bd892003-12-19 11:07:59 +0000407#ifdef CONFIG_DEVFSD_FG_NP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000408# define USAGE_DEVFSD_FG_NP(a) a
Eric Andersenf18bd892003-12-19 11:07:59 +0000409#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000410# define USAGE_DEVFSD_FG_NP(a)
Eric Andersenf18bd892003-12-19 11:07:59 +0000411#endif
412
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000413#define devfsd_trivial_usage \
Mike Frysingerb8d00462005-08-17 01:20:10 +0000414 "mntpnt [-v]" \
Eric Andersenf18bd892003-12-19 11:07:59 +0000415 USAGE_DEVFSD_FG_NP("[-fg][-np]" )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000416#define devfsd_full_usage \
Mike Frysingerb8d00462005-08-17 01:20:10 +0000417 "Optional daemon for managing devfs permissions and old device name symlinks.\n" \
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000418 "\nOptions:\n" \
419 "\tmntpnt\tThe mount point where devfs is mounted.\n\n" \
420 "\t-v\tPrint the protocol version numbers for devfsd\n" \
Eric Andersenf18bd892003-12-19 11:07:59 +0000421 "\t\tand the kernel-side protocol version and exits." \
422 USAGE_DEVFSD_FG_NP( "\n\n\t-fg\tRun the daemon in the foreground.\n\n" \
423 "\t-np\tExit after parsing the configuration file\n" \
424 "\t\tand processing synthetic REGISTER events.\n" \
425 "\t\tDo not poll for events.")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000426
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000427#ifdef CONFIG_FEATURE_HUMAN_READABLE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000428# define USAGE_HUMAN_READABLE(a) a
429# define USAGE_NOT_HUMAN_READABLE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000430#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000431# define USAGE_HUMAN_READABLE(a)
432# define USAGE_NOT_HUMAN_READABLE(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000433#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000434#define df_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000435 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000436#define df_full_usage \
437 "Print the filesystem space used and space available.\n\n" \
438 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000439 USAGE_HUMAN_READABLE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000440 "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
441 "\t-m\tprint sizes in megabytes\n" \
Eric Andersened0d9582001-02-23 13:23:03 +0000442 "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
Eric Andersen77d92682001-05-23 20:32:09 +0000443 "\n\t-k\tprint sizes in kilobytes(compatibility)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000444#define df_example_usage \
445 "$ df\n" \
446 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
447 "/dev/sda3 8690864 8553540 137324 98% /\n" \
448 "/dev/sda1 64216 36364 27852 57% /boot\n" \
449 "$ df /dev/sda3\n" \
450 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
451 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000452
Eric Andersen7e9276b2001-02-22 01:15:47 +0000453#define dirname_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000454 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000455#define dirname_full_usage \
456 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000457#define dirname_example_usage \
458 "$ dirname /tmp/foo\n" \
459 "/tmp\n" \
460 "$ dirname /tmp/foo/\n" \
461 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000462
Eric Andersen7e9276b2001-02-22 01:15:47 +0000463#define dmesg_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000464 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000465#define dmesg_full_usage \
466 "Prints or controls the kernel ring buffer\n\n" \
467 "Options:\n" \
468 "\t-c\t\tClears the ring buffer's contents after printing\n" \
469 "\t-n LEVEL\tSets console logging level\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000470 "\t-s SIZE\t\tUse a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000471
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000472#define dnsd_trivial_usage \
473 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
474#define dnsd_full_usage \
475 "Small and static DNS server daemon\n\n" \
476 "Options:\n" \
477 "\t-c\t\tconfig filename\n" \
478 "\t-t\t\tTTL in seconds\n" \
479 "\t-p\t\tlistening port\n" \
480 "\t-i\t\tlistening iface ip (default all)\n" \
481 "\t-d\t\tdaemonize"
482
Eric Andersen7e9276b2001-02-22 01:15:47 +0000483#define dos2unix_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000484 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000485#define dos2unix_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +0000486 "Converts FILE from dos format to unix format. When no option\n" \
487 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000488 "When no file is given, uses stdin for input and stdout for output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000489 "Options:\n" \
490 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +0000491 "\t-d\toutput will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000492
Eric Andersen7e9276b2001-02-22 01:15:47 +0000493#define dpkg_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000494 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000495#define dpkg_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000496 "dpkg is a utility to install, remove and manage Debian packages.\n\n" \
497 "Options:\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000498 "\t-i\t\tInstall the package\n" \
499 "\t-l\t\tList of installed packages\n" \
500 "\t-C\t\tConfigure an unpackaged package\n" \
501 "\t-F depends\tIgnore depency problems\n" \
502 "\t-P\t\tPurge all files of a package\n" \
503 "\t-r\t\tRemove all but the configuration files for a package\n" \
504 "\t-u\t\tUnpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000505
Eric Andersen7e9276b2001-02-22 01:15:47 +0000506#define dpkg_deb_trivial_usage \
Glenn L McGrathcbc453c2004-05-02 03:01:08 +0000507 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000508#define dpkg_deb_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000509 "Perform actions on Debian packages (.debs)\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000510 "Options:\n" \
Glenn L McGrath3e2ab882001-04-12 13:49:09 +0000511 "\t-c\tList contents of filesystem tree\n" \
Glenn L McGrath31369042001-04-15 12:53:24 +0000512 "\t-e\tExtract control files to [argument] directory\n" \
513 "\t-f\tDisplay control field name starting with [argument]\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000514 "\t-x\tExtract packages filesystem tree to directory\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000515 "\t-X\tVerbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000516#define dpkg_deb_example_usage \
517 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000518
Manuel Novoa III cad53642003-03-19 09:13:01 +0000519#ifdef CONFIG_FEATURE_DU_DEFALT_BLOCKSIZE_1K
520#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a) a
521#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a)
522#else
523#define USAGE_DU_DEFALT_BLOCKSIZE_1k(a)
524#define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a) a
525#endif
526
Eric Andersen7e9276b2001-02-22 01:15:47 +0000527#define du_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000528 "[-aHLdclsx" USAGE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000529#define du_full_usage \
530 "Summarizes disk space used for each FILE and/or directory.\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000531 "Disk space is printed in units of " \
532 USAGE_DU_DEFALT_BLOCKSIZE_1k("1024") USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k("512") \
533 " bytes.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000534 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000535 "\t-a\tshow sizes of files in addition to directories\n" \
536 "\t-H\tfollow symbolic links that are FILE command line args\n" \
537 "\t-L\tfollow all symbolic links encountered\n" \
538 "\t-d N\tlimit output to directories (and files with -a) of depth < N\n" \
539 "\t-c\toutput a grand total\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000540 "\t-l\tcount sizes many times if hard linked\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000541 "\t-s\tdisplay only a total for each argument\n" \
Eric Andersen265d2292002-04-06 23:16:44 +0000542 "\t-x\tskip directories on different filesystems\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000543 USAGE_HUMAN_READABLE( \
544 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
545 "\t-m\tprint sizes in megabytes\n" ) \
546 "\t-k\tprint sizes in kilobytes" USAGE_DU_DEFALT_BLOCKSIZE_1k("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000547#define du_example_usage \
548 "$ du\n" \
549 "16 ./CVS\n" \
550 "12 ./kernel-patches/CVS\n" \
551 "80 ./kernel-patches\n" \
552 "12 ./tests/CVS\n" \
553 "36 ./tests\n" \
554 "12 ./scripts/CVS\n" \
555 "16 ./scripts\n" \
556 "12 ./docs/CVS\n" \
557 "104 ./docs\n" \
558 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000559
Eric Andersen7e9276b2001-02-22 01:15:47 +0000560#define dumpkmap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000561 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000562#define dumpkmap_full_usage \
563 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000564#define dumpkmap_example_usage \
565 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000566
Russ Dill61fb4892002-10-14 21:41:28 +0000567#define dumpleases_trivial_usage \
568 "[-r|-a] [-f LEASEFILE]"
569#define dumpleases_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +0000570 "Displays the DHCP leases granted by udhcpd.\n\n" \
571 "Options:\n" \
Russ Dill61fb4892002-10-14 21:41:28 +0000572 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +0000573 "\t-r,\t--remaining\tInterpret lease times as time remaing\n" \
574 "\t-a,\t--absolute\tInterpret lease times as expire time"
Russ Dill61fb4892002-10-14 21:41:28 +0000575
Mike Frysinger51a43b42005-09-24 07:11:16 +0000576#define e2fsck_trivial_usage \
577 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
578 "[-I inode_buffer_blocks] [-P process_inode_size] " \
579 "[-l|-L bad_blocks_file] [-C fd] [-j ext-journal] " \
580 "[-E extended-options] device"
581#define e2fsck_full_usage \
582 "Check a Linux ext2/ext3 file system.\n\n" \
583 "Options:\n" \
584 "\t-p\tAutomatic repair (no questions)\n" \
585 "\t-n\tMake no changes to the filesystem\n" \
586 "\t-y\tAssume 'yes' to all questions\n" \
587 "\t-c\tCheck for bad blocks and add them to the badblock list\n" \
588 "\t-f\tForce checking even if filesystem is marked clean\n" \
589 "\t-v\tBe verbose\n" \
590 "\t-b superblock\tUse alternative superblock\n" \
591 "\t-B blocksize\tForce blocksize when looking for superblock\n" \
592 "\t-j journal\tSet location of the external journal\n" \
593 "\t-l file\tAdd to badblocks list\n" \
594 "\t-L file\tSet badblocks list"
595
Manuel Novoa III cad53642003-03-19 09:13:01 +0000596#ifdef CONFIG_FEATURE_FANCY_ECHO
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000597# define USAGE_FANCY_ECHO(a) a
Manuel Novoa III cad53642003-03-19 09:13:01 +0000598#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000599# define USAGE_FANCY_ECHO(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +0000600#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000601
Eric Andersen7e9276b2001-02-22 01:15:47 +0000602#define echo_trivial_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000603 USAGE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000604#define echo_full_usage \
605 "Prints the specified ARGs to stdout\n\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000606 USAGE_FANCY_ECHO("Options:\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000607 "\t-n\tsuppress trailing newline\n" \
Eric Andersen77d92682001-05-23 20:32:09 +0000608 "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000609 "\t-E\tdisable interpretation of backslash-escaped characters")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000610#define echo_example_usage \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000611 "$ echo \"Erik is cool\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000612 "Erik is cool\n" \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000613 USAGE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000614 "Erik\n" \
615 "is\n" \
616 "cool\n" \
Mike Frysinger5c63a722005-04-16 04:23:58 +0000617 "$ echo \"Erik\\nis\\ncool\"\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +0000618 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000619
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000620#define eject_trivial_usage \
621 "[-t] [DEVICE]"
622#define eject_full_usage \
623 "Eject specified DEVICE (or default /dev/cdrom).\n\n" \
624 "Options:\n" \
Rob Landley9ea88362005-05-14 00:46:18 +0000625 "\t-t\tclose tray"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000626
Eric Andersen84e229c2001-03-29 22:48:33 +0000627#define env_trivial_usage \
Matt Kraaic96381b2001-05-11 14:28:17 +0000628 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000629#define env_full_usage \
630 "Prints the current environment or runs a program after setting\n" \
631 "up the specified environment.\n\n" \
632 "Options:\n" \
633 "\t-, -i\tstart with an empty environment\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000634 "\t-u\tremove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000635
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000636#define ether_wake_trivial_usage \
637 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
638#define ether_wake_full_usage \
639 "Send a magic packet to wake up sleeping machines.\n" \
640 "MAC must be a station address (00:11:22:33:44:55) or\n" \
641 " a hostname with a known 'ethers' entry.\n\n" \
642 "Options:\n" \
643 "\t-b\t\tSend wake-up packet to the broadcast address\n" \
644 "\t-i iface\tUse interface ifname instead of the default \"eth0\"\n" \
645 "\t-p pass\tAppend the four or six byte password PW to the packet\n"
646
Eric Andersen7e9276b2001-02-22 01:15:47 +0000647#define expr_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000648 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000649#define expr_full_usage \
650 "Prints the value of EXPRESSION to standard output.\n\n" \
651 "EXPRESSION may be:\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000652 "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
653 "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
654 "\tARG1 < ARG2 ARG1 is less than ARG2\n" \
655 "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
656 "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \
657 "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \
658 "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
659 "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \
660 "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
661 "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
662 "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
663 "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
664 "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Eric Andersen3757f982001-02-23 17:47:51 +0000665 "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
666 "\tmatch STRING REGEXP same as STRING : REGEXP\n" \
667 "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
668 "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \
669 "\t or 0\n" \
670 "\tlength STRING length of STRING\n" \
671 "\tquote TOKEN interpret TOKEN as a string, even if\n" \
672 "\t it is a keyword like `match' or an\n" \
673 "\t operator like `/'\n" \
674 "\t( EXPRESSION ) value of EXPRESSION\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000675 "Beware that many operators need to be escaped or quoted for shells.\n" \
676 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
677 "lexicographical. Pattern matches return the string matched between \n" \
678 "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \
679 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000680
Mike Frysingerfa69f112005-04-17 07:24:19 +0000681#define fakeidentd_trivial_usage \
682 "[-b ip] [STRING]"
683#define fakeidentd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +0000684 "Returns a set string to auth requests\n\n" \
685 "\t-b\tBind to ip address\n" \
Mike Frysingerfa69f112005-04-17 07:24:19 +0000686 "\tSTRING\tThe ident answer string (default is nobody)"
687
Eric Andersen7e9276b2001-02-22 01:15:47 +0000688#define false_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000689 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000690#define false_full_usage \
691 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000692#define false_example_usage \
693 "$ false\n" \
694 "$ echo $?\n" \
695 "1\n"
696
697#define fbset_trivial_usage \
698 "[options] [mode]"
699#define fbset_full_usage \
700 "Show and modify frame buffer settings"
701#define fbset_example_usage \
702 "$ fbset\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000703 "mode \"1024x768-76\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000704 "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
705 "\tgeometry 1024 768 1024 768 16\n" \
706 "\ttimings 12714 128 32 16 4 128 4\n" \
707 "\taccel false\n" \
708 "\trgba 5/11,6/5,5/0,0/0\n" \
709 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000710
Eric Andersen7e9276b2001-02-22 01:15:47 +0000711#define fdflush_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000712 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000713#define fdflush_full_usage \
714 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000715
Eric Andersen01c3d402003-07-05 07:51:31 +0000716#define fdformat_trivial_usage \
717 "[-n] DEVICE"
718#define fdformat_full_usage \
719 "Low-level formats a floppy disk\n\n" \
720 "Options:\n" \
721 "\t-n\tDon't verify after format"
722
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000723#define fdisk_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000724 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000725#define fdisk_full_usage \
726 "Change partition table\n" \
727 "Options:\n" \
Eric Andersena151d192004-04-06 17:16:36 +0000728 "\t-l List partition table(s)\n" \
729 "\t-u Give Start and End in sector (instead of cylinder) units\n" \
730 "\t-s PARTITION Give partition size(s) in blocks\n" \
731 "\t-b 2048: (for certain MO disks) use 2048-byte sectors\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000732 "\t-C CYLINDERS Set the number of cylinders\n" \
733 "\t-H HEADS Set the number of heads\n" \
734 "\t-S SECTORS Set the number of sectors\n" \
Eric Andersena151d192004-04-06 17:16:36 +0000735 "\t-v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000736
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000737#ifdef CONFIG_FEATURE_FIND_TYPE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000738# define USAGE_FIND_TYPE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +0000739#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000740# define USAGE_FIND_TYPE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000741#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000742#ifdef CONFIG_FEATURE_FIND_PERM
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000743# define USAGE_FIND_PERM(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +0000744#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000745# define USAGE_FIND_PERM(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000746#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000747#ifdef CONFIG_FEATURE_FIND_MTIME
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000748# define USAGE_FIND_MTIME(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000749#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000750# define USAGE_FIND_MTIME(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000751#endif
Paul Fox72d1a232006-01-13 21:05:41 +0000752#ifdef CONFIG_FEATURE_FIND_MMIN
753 #define USAGE_FIND_MMIN(a) a
754#else
755 #define USAGE_FIND_MMIN(a)
756#endif
Eric Andersen97d86f22003-01-23 05:27:42 +0000757#ifdef CONFIG_FEATURE_FIND_NEWER
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000758# define USAGE_FIND_NEWER(a) a
Eric Andersen97d86f22003-01-23 05:27:42 +0000759#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000760# define USAGE_FIND_NEWER(a)
Eric Andersen97d86f22003-01-23 05:27:42 +0000761#endif
762#ifdef CONFIG_FEATURE_FIND_INUM
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000763# define USAGE_FIND_INUM(a) a
Eric Andersen97d86f22003-01-23 05:27:42 +0000764#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000765# define USAGE_FIND_INUM(a)
Eric Andersen97d86f22003-01-23 05:27:42 +0000766#endif
Rob Landley5d3a0e82005-10-04 03:34:39 +0000767#ifdef CONFIG_FEATURE_FIND_EXEC
768# define USAGE_FIND_EXEC(a) a
769#else
770# define USAGE_FIND_EXEC(a)
771#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000772
Eric Andersen7e9276b2001-02-22 01:15:47 +0000773#define find_trivial_usage \
774 "[PATH...] [EXPRESSION]"
775#define find_full_usage \
776 "Search for files in a directory hierarchy. The default PATH is\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +0000777 "the current directory; default EXPRESSION is '-print'\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000778 "\nEXPRESSION may consist of:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000779 "\t-follow\t\tDereference symbolic links\n" \
780 "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN\n" \
781 "\t-print\t\tPrint (default and assumed)\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +0000782 USAGE_FIND_TYPE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000783 "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
784) USAGE_FIND_PERM( \
785 "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
786) USAGE_FIND_MTIME( \
Paul Fox72d1a232006-01-13 21:05:41 +0000787 "\n\t-mtime DAYS\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \
788) USAGE_FIND_MMIN( \
789 "\n\t-mmin MINS\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) minutes" \
Eric Andersen97d86f22003-01-23 05:27:42 +0000790) USAGE_FIND_NEWER( \
791 "\n\t-newer FILE\tModified time is more recent than FILE's" \
792) USAGE_FIND_INUM( \
Rob Landley5d3a0e82005-10-04 03:34:39 +0000793 "\n\t-inum N\t\tFile has inode number N" \
794) USAGE_FIND_EXEC( \
795 "\n\t-exec CMD\tExecute CMD with all instances of {} replaced by the" \
796 "\n\t\t\tfiles matching EXPRESSION")
797
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000798#define find_example_usage \
Eric Andersen75eb90f2004-03-29 08:20:08 +0000799 "$ find / -name passwd\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000800 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000801
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000802#define fold_trivial_usage \
Glenn L McGrath0bd02572005-12-11 03:09:05 +0000803 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000804#define fold_full_usage \
805 "Wrap input lines in each FILE (standard input by default), writing to\n" \
806 "standard output.\n\n" \
807 "Options:\n" \
808 "\t-b\tcount bytes rather than columns\n" \
809 "\t-s\tbreak at spaces\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000810 "\t-w\tuse WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000811
Eric Andersen7e9276b2001-02-22 01:15:47 +0000812#define free_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000813 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000814#define free_full_usage \
815 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000816#define free_example_usage \
817 "$ free\n" \
818 " total used free shared buffers\n" \
819 " Mem: 257628 248724 8904 59644 93124\n" \
820 " Swap: 128516 8404 120112\n" \
821 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000822
Eric Andersen7e9276b2001-02-22 01:15:47 +0000823#define freeramdisk_trivial_usage \
824 "DEVICE"
825#define freeramdisk_full_usage \
826 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000827#define freeramdisk_example_usage \
828 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000829
Mike Frysinger51a43b42005-09-24 07:11:16 +0000830#define fsck_trivial_usage \
831 "[-ANPRTV] [ -C [ fd ] ] [-t fstype] [fs-options] [filesys ...]"
832#define fsck_full_usage \
833 "Check and repair filesystems.\n\n" \
834 "Options:\n" \
835 "\t-A\tWalk /etc/fstab and check all filesystems\n" \
836 "\t-N\tDon't execute, just show what would be done\n" \
837 "\t-P\tWhen using -A, check filesystems in parallel\n" \
838 "\t-R\tWhen using -A, skip the root filesystem\n" \
839 "\t-T\tDon't show title on startup\n" \
840 "\t-V\tVerbose mode\n" \
841 "\t-C\tWrite status information to specified filedescriptor\n" \
842 "\t-t\tList of filesystem types to check"
843
Eric Andersen7e9276b2001-02-22 01:15:47 +0000844#define fsck_minix_trivial_usage \
845 "[-larvsmf] /dev/name"
846#define fsck_minix_full_usage \
847 "Performs a consistency check for MINIX filesystems.\n\n" \
848 "Options:\n" \
849 "\t-l\tLists all filenames\n" \
850 "\t-r\tPerform interactive repairs\n" \
851 "\t-a\tPerform automatic repairs\n" \
852 "\t-v\tverbose\n" \
853 "\t-s\tOutputs super-block information\n" \
854 "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000855 "\t-f\tForce file system check"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000856
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000857#define ftpget_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000858 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000859#define ftpget_full_usage \
860 "Retrieve a remote file via FTP.\n\n" \
861 "Options:\n" \
862 "\t-c, --continue Continue a previous transfer\n" \
863 "\t-v, --verbose Verbose\n" \
864 "\t-u, --username Username to be used\n" \
865 "\t-p, --password Password to be used\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000866 "\t-P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000867
868#define ftpput_trivial_usage \
Glenn L McGrath58fd67f2004-02-22 04:12:58 +0000869 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000870#define ftpput_full_usage \
871 "Store a local file on a remote machine via FTP.\n\n" \
872 "Options:\n" \
873 "\t-v, --verbose Verbose\n" \
874 "\t-u, --username Username to be used\n" \
875 "\t-p, --password Password to be used\n" \
Eric Andersen178de172004-04-06 16:36:20 +0000876 "\t-P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000877
Rob Landleyaa872762005-10-28 13:05:12 +0000878#define fuser_trivial_usage \
879 "[options] file OR port/proto"
880#define fuser_full_usage \
881 "Options:\n" \
882 "\t-m Show all processes on the same mounted fs\n" \
883 "\t-k Kill all processes that match.\n" \
884 "\t-s Don't print or kill anything.\n" \
885 "\t-4 When using port/proto only search IPv4 space\n" \
886 "\t-6 When using port/proto only search IPv6 space\n" \
Tim Rikerc1ef7bd2006-01-25 00:08:53 +0000887 "\t-SIGNAL When used with -k, this signal will be used to kill\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000888#define getopt_trivial_usage \
889 "[OPTIONS]..."
890#define getopt_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +0000891 "Parse command options\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000892 "\t-a, --alternative Allow long options starting with single -\n" \
893 "\t-l, --longoptions=longopts Long options to be recognized\n" \
894 "\t-n, --name=progname The name under which errors are reported\n" \
895 "\t-o, --options=optstring Short options to be recognized\n" \
896 "\t-q, --quiet Disable error reporting by getopt(3)\n" \
897 "\t-Q, --quiet-output No normal output\n" \
898 "\t-s, --shell=shell Set shell quoting conventions\n" \
899 "\t-T, --test Test for getopt(1) version\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000900 "\t-u, --unquoted Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000901#define getopt_example_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000902 "$ cat getopt.test\n" \
903 "#!/bin/sh\n" \
904 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
905 " -n 'example.busybox' -- \"$@\"`\n" \
906 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000907 "eval set -- \"$GETOPT\"\n" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000908 "while true ; do\n" \
909 " case $1 in\n" \
910 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
911 " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \
912 " -c|--c-long)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000913 " case \"$2\" in\n" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +0000914 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
915 " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \
916 " esac ;;\n" \
917 " --) shift ; break ;;\n" \
918 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
919 " esac\n" \
920 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000921
Eric Andersenf349e972001-08-21 16:18:59 +0000922#define getty_trivial_usage \
Glenn L McGrathd1daf8b2004-02-25 10:35:55 +0000923 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +0000924#define getty_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +0000925 "Opens a tty, prompts for a login name, then invokes /bin/login\n\n" \
Eric Andersenf349e972001-08-21 16:18:59 +0000926 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +0000927 "\t-h\t\tEnable hardware (RTS/CTS) flow control\n" \
928 "\t-i\t\tDo not display /etc/issue before running login\n" \
929 "\t-L\t\tLocal line, so do not do carrier detect\n" \
930 "\t-m\t\tGet baud rate from modem's CONNECT status message\n" \
931 "\t-w\t\tWait for a CR or LF before sending /etc/issue\n" \
932 "\t-n\t\tDo not prompt the user for a login name\n" \
933 "\t-f issue_file\tDisplay issue_file instead of /etc/issue\n" \
934 "\t-l login_app\tInvoke login_app instead of /bin/login\n" \
935 "\t-t timeout\tTerminate after timeout if no username is read\n" \
936 "\t-I initstring\tSets the init string to send before anything else\n" \
937 "\t-H login_host\tLog login_host into the utmp file as the hostname"
Eric Andersenf349e972001-08-21 16:18:59 +0000938
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000939#if ENABLE_FEATURE_GREP_EGREP_ALIAS
940#define USAGE_GREP_E(a) a
941#else
942#define USAGE_GREP_E(a)
943#endif
944#if ENABLE_FEATURE_GREP_CONTEXT
945#define USAGE_GREP_CTX(a) a
946#else
947#define USAGE_GREP_CTX(a)
948#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000949#define grep_trivial_usage \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000950 "[-ihHnqvs" \
951 USAGE_GREP_E("E") \
952 USAGE_GREP_CTX("ABC") \
953 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000954#define grep_full_usage \
955 "Search for PATTERN in each FILE or standard input.\n\n" \
956 "Options:\n" \
957 "\t-H\tprefix output lines with filename where match was found\n" \
958 "\t-h\tsuppress the prefixing filename on output\n" \
959 "\t-i\tignore case distinctions\n" \
Eric Andersen303dd282001-04-09 23:26:31 +0000960 "\t-l\tlist names of files that match\n" \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000961 "\t-L\tlist names of files that do not match\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000962 "\t-n\tprint line number with output lines\n" \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000963 "\t-q\tbe quiet. Returns 0 if PATTERN was found, 1 otherwise\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000964 "\t-v\tselect non-matching lines\n" \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +0000965 "\t-s\tsuppress file open/read error messages\n" \
966 "\t-c\tonly print count of matching lines\n" \
967 "\t-f\tread PATTERN from file\n" \
968 "\t-e\tPATTERN is a regular expression\n" \
969 "\t-F\tPATTERN is a set of newline-separated strings" \
970 USAGE_GREP_E("\n\t-E\tPATTERN is an extended regular expression") \
971 USAGE_GREP_CTX("\n\t-A\tprint NUM lines of trailing context") \
972 USAGE_GREP_CTX("\n\t-B\tprint NUM lines of leading context") \
973 USAGE_GREP_CTX("\n\t-C\tprint NUM lines of output context")
974
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000975#define grep_example_usage \
976 "$ grep root /etc/passwd\n" \
977 "root:x:0:0:root:/root:/bin/bash\n" \
978 "$ grep ^[rR]oo. /etc/passwd\n" \
979 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +0000980
Eric Andersen7e9276b2001-02-22 01:15:47 +0000981#define gunzip_trivial_usage \
982 "[OPTION]... FILE"
983#define gunzip_full_usage \
984 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
985 "Options:\n" \
986 "\t-c\tWrite output to standard output\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +0000987 "\t-f\tForce read when source is a terminal\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +0000988 "\t-t\tTest compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000989#define gunzip_example_usage \
990 "$ ls -la /tmp/BusyBox*\n" \
991 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
992 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
993 "$ ls -la /tmp/BusyBox*\n" \
994 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000995
996#define gzip_trivial_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000997 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000998#define gzip_full_usage \
Matt Kraai9bd49d62002-02-05 22:31:48 +0000999 "Compress FILE(s) with maximum compression.\n" \
Matt Kraai273af732002-02-05 19:25:29 +00001000 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001001 "Options:\n" \
1002 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001003 "\t-d\tDecompress\n" \
1004 "\t-f\tForce write when destination is a terminal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001005#define gzip_example_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001006 "$ ls -la /tmp/busybox*\n" \
1007 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1008 "$ gzip /tmp/busybox.tar\n" \
1009 "$ ls -la /tmp/busybox*\n" \
1010 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001011
1012#define halt_trivial_usage \
Rob Landley64612912006-01-30 08:31:37 +00001013 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001014#define halt_full_usage \
Glenn L McGrathd2501672004-07-23 05:16:17 +00001015 "Halt the system.\n" \
1016 "Options:\n" \
Rob Landley64612912006-01-30 08:31:37 +00001017 "\t-d\t\tdelay interval for halting\n" \
1018 "\t-n\t\tno call to sync()\n" \
1019 "\t-f\t\tforce halt (don't go through init)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001020
Eric Andersen3443bd72003-07-22 07:30:36 +00001021#ifdef CONFIG_FEATURE_HDPARM_GET_IDENTITY
1022#define USAGE_HDPARM_IDENT(a) a
1023#else
1024#define USAGE_HDPARM_IDENT(a)
1025#endif
1026
1027#ifdef CONFIG_FEATURE_HDPARM_HDIO_SCAN_HWIF
1028#define USAGE_SCAN_HWIF(a) a
1029#else
1030#define USAGE_SCAN_HWIF(a)
1031#endif
1032
1033#ifdef CONFIG_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF
1034#define USAGE_UNREGISTER_HWIF(a) a
1035#else
1036#define USAGE_UNREGISTER_HWIF(a)
1037#endif
1038
1039#ifdef CONFIG_FEATURE_HDPARM_HDIO_DRIVE_RESET
1040#define USAGE_DRIVE_RESET(a) a
1041#else
1042#define USAGE_DRIVE_RESET(a)
1043#endif
1044
1045#ifdef CONFIG_FEATURE_HDPARM_HDIO_TRISTATE_HWIF
1046#define USAGE_TRISTATE_HWIF(a) a
1047#else
1048#define USAGE_TRISTATE_HWIF(a)
1049#endif
1050
Eric Andersen0a57a792003-08-06 08:57:35 +00001051#ifdef CONFIG_FEATURE_HDPARM_HDIO_GETSET_DMA
1052#define USAGE_GETSET_DMA(a) a
1053#else
1054#define USAGE_GETSET_DMA(a)
1055#endif
1056
Eric Andersen3443bd72003-07-22 07:30:36 +00001057#define hdparm_trivial_usage \
1058 "[options] [device] .."
1059#define hdparm_full_usage \
1060 "Options:" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001061 "\t-a get/set fs readahead\n" \
1062 "\t-A set drive read-lookahead flag (0/1)\n" \
1063 "\t-b get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
1064 "\t-B set Advanced Power Management setting (1-255)\n" \
1065 "\t-c get/set IDE 32-bit IO setting\n" \
1066 "\t-C check IDE power mode status\n" \
1067 USAGE_GETSET_DMA("\t-d get/set using_dma flag\n") \
1068 "\t-D enable/disable drive defect-mgmt\n" \
1069 "\t-f flush buffer cache for device on exit\n" \
1070 "\t-g display drive geometry\n" \
1071 "\t-h display terse usage information\n" \
1072 "\t-i display drive identification\n" \
1073 USAGE_HDPARM_IDENT("\t-I detailed/current information directly from drive\n") \
1074 USAGE_HDPARM_IDENT("\t-Istdin similar to -I, but wants /proc/ide/" "*" "/hd?/identify as input\n") \
1075 "\t-k get/set keep_settings_over_reset flag (0/1)\n" \
1076 "\t-K set drive keep_features_over_reset flag (0/1)\n" \
1077 "\t-L set drive doorlock (0/1) (removable harddisks only)\n" \
1078 "\t-m get/set multiple sector count\n" \
1079 "\t-n get/set ignore-write-errors flag (0/1)\n" \
1080 "\t-p set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
1081 "\t-P set drive prefetch count\n" \
1082 "\t-q change next setting quietly\n" \
1083 "\t-Q get/set DMA tagged-queuing depth (if supported)\n" \
1084 "\t-r get/set readonly flag (DANGEROUS to set)\n" \
1085 USAGE_SCAN_HWIF("\t-R register an IDE interface (DANGEROUS)\n") \
1086 "\t-S set standby (spindown) timeout\n" \
1087 "\t-t perform device read timings\n" \
1088 "\t-T perform cache read timings\n" \
1089 "\t-u get/set unmaskirq flag (0/1)\n" \
1090 USAGE_UNREGISTER_HWIF("\t-U un-register an IDE interface (DANGEROUS)\n") \
1091 "\t-v defaults; same as -mcudkrag for IDE drives\n" \
1092 "\t-V display program version and exit immediately\n" \
1093 USAGE_DRIVE_RESET("\t-w perform device reset (DANGEROUS)\n") \
1094 "\t-W set drive write-caching flag (0/1) (DANGEROUS)\n" \
1095 USAGE_TRISTATE_HWIF("\t-x tristate device for hotswap (0/1) (DANGEROUS)\n") \
1096 "\t-X set IDE xfer mode (DANGEROUS)\n" \
1097 "\t-y put IDE drive in standby mode\n" \
1098 "\t-Y put IDE drive to sleep\n" \
1099 "\t-Z disable Seagate auto-powersaving mode\n" \
1100 "\t-z re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +00001101
Manuel Novoa III cad53642003-03-19 09:13:01 +00001102#ifdef CONFIG_FEATURE_FANCY_HEAD
1103#define USAGE_FANCY_HEAD(a) a
1104#else
1105#define USAGE_FANCY_HEAD(a)
1106#endif
1107
Eric Andersen7e9276b2001-02-22 01:15:47 +00001108#define head_trivial_usage \
Manuel Novoa III 4baef0c2003-03-19 18:40:42 +00001109 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001110#define head_full_usage \
1111 "Print first 10 lines of each FILE to standard output.\n" \
1112 "With more than one FILE, precede each with a header giving the\n" \
1113 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001114 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001115 "\t-n NUM\t\tPrint first NUM lines instead of first 10" \
1116 USAGE_FANCY_HEAD( \
1117 "\n\t-c NUM\t\toutput the first NUM bytes\n" \
1118 "\t-q\t\tnever output headers giving file names\n" \
1119 "\t-v\t\talways output headers giving file names" )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001120#define head_example_usage \
1121 "$ head -n 2 /etc/passwd\n" \
1122 "root:x:0:0:root:/root:/bin/bash\n" \
1123 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001124
Glenn L McGrath60281112001-11-02 11:39:46 +00001125#define hexdump_trivial_usage \
Paul Fox969af892005-11-28 21:06:00 +00001126 "[-[bcCdefnosvx]] [OPTION] FILE"
Glenn L McGrath60281112001-11-02 11:39:46 +00001127#define hexdump_full_usage \
1128 "The hexdump utility is a filter which displays the specified files,\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001129 "or the standard input, if no files are specified, in a user specified\n" \
Glenn L McGrath60281112001-11-02 11:39:46 +00001130 "format\n" \
1131 "\t-b\t\tOne-byte octal display\n" \
1132 "\t-c\t\tOne-byte character display\n" \
Paul Fox969af892005-11-28 21:06:00 +00001133 "\t-C\t\tCanonical hex+ASCII, 16 bytes per line\n" \
Glenn L McGrath60281112001-11-02 11:39:46 +00001134 "\t-d\t\tTwo-byte decimal display\n" \
1135 "\t-e FORMAT STRING\n" \
1136 "\t-f FORMAT FILE\n" \
1137 "\t-n LENGTH\tInterpret only length bytes of input\n" \
1138 "\t-o\t\tTwo-byte octal display\n" \
1139 "\t-s OFFSET\tSkip offset byte\n" \
1140 "\t-v\t\tdisplay all input data\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001141 "\t-x\t\tTwo-byte hexadecimal display"
Glenn L McGrath60281112001-11-02 11:39:46 +00001142
Eric Andersen7e9276b2001-02-22 01:15:47 +00001143#define hostid_trivial_usage \
1144 ""
1145#define hostid_full_usage \
1146 "Print out a unique 32-bit identifier for the machine."
1147
1148#define hostname_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001149 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001150#define hostname_full_usage \
1151 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00001152 "(or FILE with the -F parameter), the host name will be set.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001153 "Options:\n" \
Matt Kraai54805af2001-12-06 17:37:51 +00001154 "\t-s\tShort\n" \
1155 "\t-i\tAddresses for the hostname\n" \
1156 "\t-d\tDNS domain name\n" \
1157 "\t-f\tFully qualified domain name\n" \
1158 "\t-F FILE\tUse the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001159#define hostname_example_usage \
1160 "$ hostname\n" \
Eric Andersen08f59e32004-03-12 22:07:10 +00001161 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001162
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001163#ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001164# define USAGE_HTTPD_BASIC_AUTH(a) a
1165# ifdef CONFIG_FEATURE_HTTPD_AUTH_MD5
1166# define USAGE_HTTPD_AUTH_MD5(a) a
1167# else
1168# define USAGE_HTTPD_AUTH_MD5(a)
1169# endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001170#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001171# define USAGE_HTTPD_BASIC_AUTH(a)
1172# define USAGE_HTTPD_AUTH_MD5(a)
Eric Andersen40520512003-07-28 09:59:05 +00001173#endif
1174#ifdef CONFIG_FEATURE_HTTPD_USAGE_FROM_INETD_ONLY
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001175# define USAGE_HTTPD_STANDALONE(a)
1176# define USAGE_HTTPD_SETUID(a)
Eric Andersen40520512003-07-28 09:59:05 +00001177#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001178# define USAGE_HTTPD_STANDALONE(a) a
1179# ifdef CONFIG_FEATURE_HTTPD_SETUID
1180# define USAGE_HTTPD_SETUID(a) a
1181# else
1182# define USAGE_HTTPD_SETUID(a)
1183# endif
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001184#endif
1185#define httpd_trivial_usage \
Eric Andersen40520512003-07-28 09:59:05 +00001186 "[-c <conf file>]" \
1187 USAGE_HTTPD_STANDALONE(" [-p <port>]") \
1188 USAGE_HTTPD_SETUID(" [-u user]") \
1189 USAGE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
1190 USAGE_HTTPD_AUTH_MD5(" [-m pass]") \
Eric Andersen73afd892004-04-14 17:59:21 +00001191 " [-h home]" \
Eric Andersen40520512003-07-28 09:59:05 +00001192 " [-d/-e <string>]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001193#define httpd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001194 "Listens for incoming http server requests.\n\n" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001195 "Options:\n" \
1196 "\t-c FILE\t\tSpecifies configuration file. (default httpd.conf)\n" \
1197 USAGE_HTTPD_STANDALONE("\t-p PORT\tServer port (default 80)\n") \
1198 USAGE_HTTPD_SETUID("\t-u USER\tSet uid to USER after listening privileges port\n") \
1199 USAGE_HTTPD_BASIC_AUTH("\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
1200 USAGE_HTTPD_AUTH_MD5("\t-m PASS\t\tCrypt PASS with md5 algorithm\n") \
1201 "\t-h HOME \tSpecifies http HOME directory (default ./)\n" \
1202 "\t-e STRING\tHtml encode STRING\n" \
1203 "\t-d STRING\tURL decode STRING"
Eric Andersen40520512003-07-28 09:59:05 +00001204
Robert Griebl1cd04452002-07-21 16:50:49 +00001205#define hwclock_trivial_usage \
1206 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
1207#define hwclock_full_usage \
1208 "Query and set the hardware clock (RTC)\n\n" \
1209 "Options:\n" \
1210 "\t-r\tread hardware clock and print result\n" \
1211 "\t-s\tset the system time from the hardware clock\n" \
1212 "\t-w\tset the hardware clock to the current system time\n" \
1213 "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
1214 "\t-l\tthe hardware clock is kept in local time"
1215
Eric Andersen9e480452003-07-03 10:07:04 +00001216#ifdef CONFIG_SELINUX
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001217# define USAGE_SELINUX(a) a
Eric Andersen9e480452003-07-03 10:07:04 +00001218#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001219# define USAGE_SELINUX(a)
Eric Andersen9e480452003-07-03 10:07:04 +00001220#endif
1221
Eric Andersen7e9276b2001-02-22 01:15:47 +00001222#define id_trivial_usage \
1223 "[OPTIONS]... [USERNAME]"
1224#define id_full_usage \
1225 "Print information for USERNAME or the current user\n\n" \
1226 "Options:\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001227 USAGE_SELINUX("\t-c\tprints only the security context\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001228 "\t-g\tprints only the group ID\n" \
1229 "\t-u\tprints only the user ID\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001230 "\t-n\tprint a name instead of a number\n" \
1231 "\t-r\tprints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001232#define id_example_usage \
1233 "$ id\n" \
1234 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001235
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001236#ifdef CONFIG_FEATURE_IFCONFIG_SLIP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001237# define USAGE_SIOCSKEEPALIVE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001238#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001239# define USAGE_SIOCSKEEPALIVE(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001240#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001241#ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001242# define USAGE_IFCONFIG_MII(a) a
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001243#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001244# define USAGE_IFCONFIG_MII(a)
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001245#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001246#ifdef CONFIG_FEATURE_IFCONFIG_HW
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001247# define USAGE_IFCONFIG_HW(a) a
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001248#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001249# define USAGE_IFCONFIG_HW(a)
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001250#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001251#ifdef CONFIG_FEATURE_IFCONFIG_STATUS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001252# define USAGE_IFCONFIG_OPT_A(a) a
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001253#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001254# define USAGE_IFCONFIG_OPT_A(a)
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001255#endif
Eric Andersen51b8bd62002-07-03 11:46:38 +00001256#ifdef CONFIG_FEATURE_IPV6
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001257# define USAGE_IPV6(a) a
Eric Andersen51b8bd62002-07-03 11:46:38 +00001258#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001259# define USAGE_IPV6(a)
Eric Andersen51b8bd62002-07-03 11:46:38 +00001260#endif
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001261
Eric Andersen7e9276b2001-02-22 01:15:47 +00001262#define ifconfig_trivial_usage \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001263 USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001264#define ifconfig_full_usage \
1265 "configure a network interface\n\n" \
1266 "Options:\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +00001267 USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \
1268 USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001269 "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001270 "\t[netmask <address>] [dstaddr <address>]\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001271 USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001272 "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001273 "[metric <NN>] [mtu <NN>]\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001274 "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \
Manuel Novoa III 22b889a2001-03-12 09:58:51 +00001275 "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
1276 USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001277 "\t[up|down] ..."
1278
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001279#define ifup_trivial_usage \
1280 "<-ahinv> <ifaces...>"
1281#define ifup_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001282 "ifup <options> <ifaces...>\n\n" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001283 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001284 "\t-h\tthis help\n" \
1285 "\t-a\tde/configure all interfaces automatically\n" \
1286 "\t-i FILE\tuse FILE for interface definitions\n" \
1287 "\t-n\tprint out what would happen, but don't do it\n" \
1288 "\t\t\t(note that this option doesn't disable mappings)\n" \
1289 "\t-v\tprint out what would happen before doing it\n" \
1290 "\t-m\tdon't run any mappings\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001291 "\t-f\tforce de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001292
1293#define ifdown_trivial_usage \
1294 "<-ahinv> <ifaces...>"
1295#define ifdown_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001296 "ifdown <options> <ifaces...>\n\n" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001297 "Options:\n" \
Glenn L McGrathd66370c2003-01-13 21:40:38 +00001298 "\t-h\tthis help\n" \
1299 "\t-a\tde/configure all interfaces automatically\n" \
1300 "\t-i FILE\tuse FILE for interface definitions\n" \
1301 "\t-n\tprint out what would happen, but don't do it\n" \
1302 "\t\t(note that this option doesn't disable mappings)\n" \
1303 "\t-v\tprint out what would happen before doing it\n" \
1304 "\t-m\tdon't run any mappings\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001305 "\t-f\tforce de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001306
Glenn L McGrath06e95652003-02-09 06:51:14 +00001307#define inetd_trivial_usage \
Paul Foxb8317532005-08-01 19:39:47 +00001308 "[-f] [-q len] [conf]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001309#define inetd_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001310 "Listens for network connections and launches programs\n\n" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001311 "Option:\n" \
Paul Foxb8317532005-08-01 19:39:47 +00001312 "\t-f\tRun as a foreground progress\n" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001313 "\t-q\tSets the size of the socket listen queue to\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001314 "\t\tthe specified value. Default is 128"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001315
Eric Andersen7e9276b2001-02-22 01:15:47 +00001316#define init_trivial_usage \
1317 ""
1318#define init_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001319 "Init is the parent of all processes."
1320#define init_notes_usage \
1321"This version of init is designed to be run only by the kernel.\n" \
1322"\n" \
1323"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
1324"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \
1325"runlevels, use sysvinit.\n" \
1326"\n" \
1327"BusyBox init works just fine without an inittab. If no inittab is found, \n" \
1328"it has the following default behavior:\n" \
1329"\n" \
1330" ::sysinit:/etc/init.d/rcS\n" \
1331" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001332" ::ctrlaltdel:/sbin/reboot\n" \
1333" ::shutdown:/sbin/swapoff -a\n" \
1334" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001335" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001336"\n" \
1337"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1338"\n" \
1339" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001340" tty3::askfirst:/bin/sh\n" \
1341" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001342"\n" \
1343"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1344"\n" \
1345" <id>:<runlevels>:<action>:<process>\n" \
1346"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001347" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001348"\n" \
1349" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1350" The id field is used by BusyBox init to specify the controlling tty for\n" \
1351" the specified process to run on. The contents of this field are\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001352" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001353" be unique, although if it isn't you may have strange results. If this\n" \
1354" field is left blank, the controlling tty is set to the console. Also\n" \
1355" note that if BusyBox detects that a serial console is in use, then only\n" \
1356" entries whose controlling tty is either the serial console or /dev/null\n" \
1357" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1358" stinkin' utmp.\n" \
1359"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001360" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001361"\n" \
1362" The runlevels field is completely ignored.\n" \
1363"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001364" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001365"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001366" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001367" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001368"\n" \
1369" The available actions can be classified into two groups: actions\n" \
1370" that are run only once, and actions that are re-run when the specified\n" \
1371" process exits.\n" \
1372"\n" \
1373" Run only-once actions:\n" \
1374"\n" \
1375" 'sysinit' is the first item run on boot. init waits until all\n" \
1376" sysinit actions are completed before continuing. Following the\n" \
1377" completion of all sysinit actions, all 'wait' actions are run.\n" \
1378" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001379" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001380" therefore, init does not wait for them to complete. 'restart' is\n" \
1381" the action taken to restart the init process. By default this should\n" \
1382" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1383" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001384" actions are run when the system detects that someone on the system\n" \
1385" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1386" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1387" Finally the 'shutdown' action specifies the actions to taken when\n" \
1388" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1389" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001390"\n" \
1391" Run repeatedly actions:\n" \
1392"\n" \
1393" 'respawn' actions are run after the 'once' actions. When a process\n" \
1394" started with a 'respawn' action exits, init automatically restarts\n" \
1395" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1396" respawning out of control. The 'askfirst' actions acts just like\n" \
1397" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001398" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001399" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001400" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001401"\n" \
1402" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1403" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001404" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001405"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001406" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001407"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001408" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001409"\n" \
1410"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001411"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001412" # This is run first except when booting in single-user mode.\n" \
1413" #\n" \
1414" ::sysinit:/etc/init.d/rcS\n" \
1415" \n" \
1416" # /bin/sh invocations on selected ttys\n" \
1417" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001418" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001419" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001420" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001421" tty2::askfirst:-/bin/sh\n" \
1422" tty3::askfirst:-/bin/sh\n" \
1423" tty4::askfirst:-/bin/sh\n" \
1424" \n" \
1425" # /sbin/getty invocations for selected ttys\n" \
1426" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001427" tty4::respawn:/sbin/getty 38400 tty4\n" \
1428" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001429" \n" \
1430" \n" \
1431" # Example of how to put a getty on a serial line (for a terminal)\n" \
1432" #\n" \
1433" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1434" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1435" #\n" \
1436" # Example how to put a getty on a modem line.\n" \
1437" #::respawn:/sbin/getty 57600 ttyS2\n" \
1438" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001439" # Stuff to do when restarting the init process\n" \
1440" ::restart:/sbin/init\n" \
1441" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001442" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001443" ::ctrlaltdel:/sbin/reboot\n" \
1444" ::shutdown:/bin/umount -a -r\n" \
1445" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001446
Eric Andersenbe65c352003-01-23 04:57:35 +00001447#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001448# define USAGE_INSMOD_MAP(a) a
Eric Andersenbe65c352003-01-23 04:57:35 +00001449#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001450# define USAGE_INSMOD_MAP(a)
Eric Andersenbe65c352003-01-23 04:57:35 +00001451#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00001452#define insmod_trivial_usage \
1453 "[OPTION]... MODULE [symbol=value]..."
1454#define insmod_full_usage \
1455 "Loads the specified kernel modules into the kernel.\n\n" \
1456 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001457 "\t-f\tForce module to load into the wrong kernel version\n" \
1458 "\t-k\tMake module autoclean-able\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001459 "\t-v\tverbose output\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001460 "\t-q\tquiet output\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001461 "\t-L\tLock to prevent simultaneous loads of a module\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001462 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout\n") \
Eric Andersen957879a2004-04-07 15:07:55 +00001463 "\t-o NAME\tSet internal module name to NAME\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001464 "\t-x\tdo not export externs"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001465
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001466#define install_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001467 "[-cgmops] [sources] <dest|directory>"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001468#define install_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001469 "Copies files and set attributes\n\n" \
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001470 "Options:\n" \
1471 "\t-c\tcopy the file, default\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00001472 "\t-d\tcreate directories\n" \
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001473 "\t-g\tset group ownership\n" \
1474 "\t-m\tset permission modes\n" \
1475 "\t-o\tset ownership\n" \
1476 "\t-p\tpreserve date\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001477 "\t-s\tstrip symbol tables"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001478
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001479#define ip_trivial_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001480 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001481#define ip_full_usage \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001482 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1483 "where OBJECT := { link | addr | route | tunnel }\n" \
Eric Andersen178de172004-04-06 16:36:20 +00001484 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001485
1486#define ipaddr_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001487 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
1488 "\t\t[ dev STRING ] [ to PREFIX ] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001489#define ipaddr_full_usage \
1490 "ipaddr {add|del} IFADDR dev STRING\n" \
1491 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001492 "\t\t\t[ to PREFIX ] [ label PATTERN ]\n" \
1493 "\t\t\tIFADDR := PREFIX | ADDR peer PREFIX\n" \
1494 "\t\t\t[ broadcast ADDR ] [ anycast ADDR ]\n" \
1495 "\t\t\t[ label STRING ] [ scope SCOPE-ID ]\n" \
1496 "\t\t\tSCOPE-ID := [ host | link | global | NUMBER ]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001497
Eric Andersen3561b012004-04-13 19:27:20 +00001498#ifdef CONFIG_FEATURE_IPCALC_FANCY
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001499# define XUSAGE_IPCALC_FANCY(a) a
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001500#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001501# define XUSAGE_IPCALC_FANCY(a)
Eric Andersen3561b012004-04-13 19:27:20 +00001502#endif
Eric Andersende4f07e2003-12-11 01:18:07 +00001503#define ipcalc_trivial_usage \
Eric Andersen3561b012004-04-13 19:27:20 +00001504 "[OPTION]... <ADDRESS>[[/]<NETMASK>] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001505#define ipcalc_full_usage \
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001506 "Calculate IP network settings from a IP address\n\n" \
1507 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001508 "\t-b\t--broadcast\tDisplay calculated broadcast address\n" \
1509 "\t-n\t--network\tDisplay calculated network address\n" \
Mike Frysinger036f2992005-09-24 23:50:14 +00001510 "\t-m\t--netmask\tDisplay default netmask for IP" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001511 XUSAGE_IPCALC_FANCY( \
Mike Frysinger036f2992005-09-24 23:50:14 +00001512 "\n\t-p\t--prefix\tDisplay the prefix for IP/NETMASK\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001513 "\t-h\t--hostname\tDisplay first resolved host name\n" \
Mike Frysinger036f2992005-09-24 23:50:14 +00001514 "\t-s\t--silent\tDon't ever display error messages")
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001515
Rob Landley6eb1e412005-06-20 04:30:36 +00001516#define ipcrm_trivial_usage \
1517 "[-[MQS] key] [-[mqs] id]"
1518#define ipcrm_full_usage \
1519 "The upper-case options MQS are used to remove a shared memory\n" \
1520 "segment by an shmkey value. The lower-case options mqs are used\n" \
1521 "to remove a segment by shmid value.\n" \
1522 "\t-m | -M\tRemove the memory segment after the last detatch\n" \
1523 "\t-q | -Q\tRemove the message queue\n" \
1524 "\t-s | -S\tRemove the semaphore\n"
1525
1526#define ipcs_trivial_usage \
1527 "[[-smq] -i shmid] | [[-asmq] [-tclup]]"
1528#define ipcs_full_usage \
1529 "\t-i\tspecify a specific resource id\n" \
1530 "Resource specification:\n" \
1531 "\t-m\tshared memory segments\n" \
1532 "\t-q\tmessage queues\n" \
1533 "\t-s\tsempahore arrays\n" \
1534 "\t-a\tall (default)\n" \
1535 "Output format:\n" \
1536 "\t-t\ttime\n" \
1537 "\t-p\tpid\n" \
1538 "\t-s\tcreator\n" \
1539 "\t-a\tlimits\n" \
1540 "\t-i\tsummary\n"
1541
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001542#define iplink_trivial_usage \
1543 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1544#define iplink_full_usage \
1545 "iplink set DEVICE { up | down | arp { on | off } |\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001546 "\t\t\tdynamic { on | off } |\n" \
1547 "\t\t\tmtu MTU }\n" \
1548 "\tiplink show [ DEVICE ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001549
1550#define iproute_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001551 "{ list | flush | { add | del | change | append |\n" \
1552 "\t\treplace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001553#define iproute_full_usage \
1554 "iproute { list | flush } SELECTOR\n" \
1555 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001556 "\t\t\t[ oif STRING ] [ tos TOS ]\n" \
1557 "\tiproute { add | del | change | append | replace | monitor } ROUTE\n" \
1558 "\t\t\tSELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1559 "\t\t\tROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001560
1561#define iptunnel_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001562 "{ add | change | del | show } [ NAME ]\n" \
1563 "\t\t[ mode { ipip | gre | sit } ]\n" \
1564 "\t\t[ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001565#define iptunnel_full_usage \
1566 "iptunnel { add | change | del | show } [ NAME ]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00001567 "\t\t\t[ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1568 "\t\t\t[ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1569 "\t\t\t[ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001570
Eric Andersen7e9276b2001-02-22 01:15:47 +00001571#define kill_trivial_usage \
1572 "[-signal] process-id [process-id ...]"
1573#define kill_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001574 "Send a signal (default is SIGTERM) to the specified process(es).\n\n" \
David Kimdon56082dc2001-02-23 06:03:22 +00001575 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001576 "\t-l\tList all signal names and numbers"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001577#define kill_example_usage \
1578 "$ ps | grep apache\n" \
1579 "252 root root S [apache]\n" \
1580 "263 www-data www-data S [apache]\n" \
1581 "264 www-data www-data S [apache]\n" \
1582 "265 www-data www-data S [apache]\n" \
1583 "266 www-data www-data S [apache]\n" \
1584 "267 www-data www-data S [apache]\n" \
1585 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001586
1587#define killall_trivial_usage \
Eric Andersenb131db42004-08-19 18:25:02 +00001588 "[-q] [-signal] process-name [process-name ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001589#define killall_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001590 "Send a signal (default is SIGTERM) to the specified process(es).\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001591 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001592 "\t-l\tList all signal names and numbers\n" \
1593 "\t-q\tDo not complain if no processes were killed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001594#define killall_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001595 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001596
Mark Whitley6317c4b2001-03-12 22:51:50 +00001597#define klogd_trivial_usage \
Glenn L McGrathf0a360e2002-12-05 20:56:31 +00001598 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001599#define klogd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001600 "Kernel logger.\n" \
1601 "Options:\n" \
1602 "\t-c n\tSets the default log level of console messages to n\n" \
1603 "\t-n\tRun as a foreground process"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001604
Eric Andersen7e9276b2001-02-22 01:15:47 +00001605#define length_trivial_usage \
1606 "STRING"
1607#define length_full_usage \
1608 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001609#define length_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00001610 "$ length Hello\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001611 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001612
Rob Landley9200e792005-09-15 19:26:59 +00001613#define less_trivial_usage \
1614 "[-EMNmh~?] FILE1 FILE2..."
1615#define less_full_usage \
1616 "View a file or list of files. The position within files can be\n" \
1617 "changed, and files can be manipulated in various ways with the\n" \
1618 "following options:\n\n" \
1619 "\t-E\tQuit once the end of a file is reached\n" \
1620 "\t-M\tDisplay a status line containing the current line numbers\n" \
1621 "\t\tand the percentage through the file\n" \
1622 "\t-N\tPrefix line numbers to each line\n" \
1623 "\t-m\tDisplay a status line containing the percentage through the\n" \
1624 "\t\tfile\n" \
1625 "\t-~\tSuppress ~s displayed when input past the end of the file is\n" \
1626 "\t\treached.\n" \
1627 "\t-h, -?\tDisplay this help message\n"
1628
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001629#define setarch_trivial_usage \
1630 "<personality> <program> [args ...]"
1631#define setarch_full_usage \
1632 "Personality may be:\n" \
1633 "\tlinux32\tSet 32bit uname emulation\n" \
1634 "\tlinux64\tSet 64bit uname emulation"
1635
Eric Andersen7e9276b2001-02-22 01:15:47 +00001636#define ln_trivial_usage \
1637 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1638#define ln_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001639 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001640 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1641 "Options:\n" \
1642 "\t-s\tmake symbolic links instead of hard links\n" \
1643 "\t-f\tremove existing destination files\n" \
Rob Landley55b1efc2005-04-29 22:14:28 +00001644 "\t-n\tno dereference symlinks - treat like normal file\n" \
1645 "\t-b\tmake a backup of the target (if exists) before link operation\n" \
1646 "\t-S suffix\tuse suffix instead of ~ when making backup files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001647#define ln_example_usage \
1648 "$ ln -s BusyBox /tmp/ls\n" \
1649 "$ ls -l /tmp/ls\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001650 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001651
Eric Andersen7e9276b2001-02-22 01:15:47 +00001652#define loadfont_trivial_usage \
1653 "< font"
1654#define loadfont_full_usage \
1655 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001656#define loadfont_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001657 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001658
1659#define loadkmap_trivial_usage \
1660 "< keymap"
1661#define loadkmap_full_usage \
1662 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001663#define loadkmap_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00001664 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001665
1666#define logger_trivial_usage \
1667 "[OPTION]... [MESSAGE]"
1668#define logger_full_usage \
1669 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1670 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001671 "\t-s\tLog to stderr as well as the system log\n" \
1672 "\t-t TAG\tLog using the specified tag (defaults to user name)\n" \
1673 "\t-p PRIORITY\tEnter the message with the specified priority\n" \
1674 "\t\tThis may be numerical or a ``facility.level'' pair"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001675#define logger_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00001676 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001677
Robert Griebl1fca5582002-06-04 20:45:46 +00001678#define login_trivial_usage \
1679 "[OPTION]... [username] [ENV=VAR ...]"
1680#define login_full_usage \
1681 "Begin a new session on the system\n\n" \
1682 "Options:\n" \
1683 "\t-f\tDo not authenticate (user already authenticated)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001684 "\t-h\tName of the remote host for this login\n" \
1685 "\t-p\tPreserve environment"
Robert Griebl1fca5582002-06-04 20:45:46 +00001686
Eric Andersen7e9276b2001-02-22 01:15:47 +00001687#define logname_trivial_usage \
1688 ""
1689#define logname_full_usage \
1690 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001691#define logname_example_usage \
1692 "$ logname\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001693 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001694
Mark Whitley6317c4b2001-03-12 22:51:50 +00001695#define logread_trivial_usage \
Eric Andersend4a5e252003-12-19 11:32:14 +00001696 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001697#define logread_full_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001698 "Shows the messages from syslogd (using circular buffer).\n\n" \
Eric Andersend4a5e252003-12-19 11:32:14 +00001699 "Options:\n" \
1700 "\t-f\t\toutput data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001701
Matt Kraai83788da2002-03-20 17:38:37 +00001702#define losetup_trivial_usage \
Rob Landleyce887932005-12-21 17:00:25 +00001703 "[-od] LOOPDEVICE [FILE]"
Matt Kraai83788da2002-03-20 17:38:37 +00001704#define losetup_full_usage \
Rob Landley1d589b22005-11-29 23:47:10 +00001705 "Associate LOOPDEVICE with FILE, or display current association.\n\n" \
Matt Kraai83788da2002-03-20 17:38:37 +00001706 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001707 "\t-d\t\tDisassociate LOOPDEVICE\n" \
1708 "\t-o OFFSET\tStart OFFSET bytes into FILE"
Rob Landley1d589b22005-11-29 23:47:10 +00001709#define losetup_notes_usage \
1710 "One argument (losetup /dev/loop1) will display the current association\n" \
1711 "(if any), or disassociate it (with -d). The display shows the offset\n" \
1712 "and filename of the file the loop device is currently bound to.\n\n" \
1713 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
1714 "with an optional offset (-o 12345). Encryption is not yet supported.\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00001715
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001716#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001717# define USAGE_LS_TIMESTAMPS(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001718#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001719# define USAGE_LS_TIMESTAMPS(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001720#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001721#ifdef CONFIG_FEATURE_LS_FILETYPES
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001722# define USAGE_LS_FILETYPES(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001723#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001724# define USAGE_LS_FILETYPES(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001725#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001726#ifdef CONFIG_FEATURE_LS_FOLLOWLINKS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001727# define USAGE_LS_FOLLOWLINKS(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001728#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001729# define USAGE_LS_FOLLOWLINKS(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001730#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001731#ifdef CONFIG_FEATURE_LS_RECURSIVE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001732# define USAGE_LS_RECURSIVE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001733#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001734# define USAGE_LS_RECURSIVE(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001735#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001736#ifdef CONFIG_FEATURE_LS_SORTFILES
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001737# define USAGE_LS_SORTFILES(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001738#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001739# define USAGE_LS_SORTFILES(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001740#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001741#ifdef CONFIG_FEATURE_AUTOWIDTH
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001742# define USAGE_AUTOWIDTH(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00001743#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00001744# define USAGE_AUTOWIDTH(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00001745#endif
Paul Fox156dc412005-08-01 19:33:30 +00001746#ifdef CONFIG_FEATURE_LS_COLOR
1747 #define USAGE_LS_COLOR(a) a
1748#else
1749 #define USAGE_LS_COLOR(a)
1750#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00001751
Eric Andersen7e9276b2001-02-22 01:15:47 +00001752#define ls_trivial_usage \
Eric Andersen15c03c32004-04-06 17:52:02 +00001753 "[-1Aa" USAGE_LS_TIMESTAMPS("c") "Cd" USAGE_LS_TIMESTAMPS("e") USAGE_LS_FILETYPES("F") "iln" USAGE_LS_FILETYPES("p") USAGE_LS_FOLLOWLINKS("L") USAGE_LS_RECURSIVE("R") USAGE_LS_SORTFILES("rS") "s" USAGE_AUTOWIDTH("T") USAGE_LS_TIMESTAMPS("tu") USAGE_LS_SORTFILES("v") USAGE_AUTOWIDTH("w") "x" USAGE_LS_SORTFILES("X") USAGE_HUMAN_READABLE("h") USAGE_NOT_HUMAN_READABLE("") "k" USAGE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001754#define ls_full_usage \
1755 "List directory contents\n\n" \
1756 "Options:\n" \
1757 "\t-1\tlist files in a single column\n" \
1758 "\t-A\tdo not list implied . and ..\n" \
1759 "\t-a\tdo not hide entries starting with .\n" \
1760 "\t-C\tlist entries by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001761 USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \
Paul Fox156dc412005-08-01 19:33:30 +00001762 USAGE_LS_COLOR("\t--color[={always,never,auto}]\tto control coloring\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001763 "\t-d\tlist directory entries instead of contents\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001764 USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \
1765 USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001766 "\t-i\tlist the i-node for each file\n" \
1767 "\t-l\tuse a long listing format\n" \
1768 "\t-n\tlist numeric UIDs and GIDs instead of names\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001769 USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \
1770 USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \
1771 USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \
1772 USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \
1773 USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001774 "\t-s\tlist the size of each file, in blocks\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001775 USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \
1776 USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \
1777 USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \
1778 USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \
1779 USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001780 "\t-x\tlist entries by lines instead of by columns\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001781 USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
1782 USAGE_HUMAN_READABLE( \
Eric Andersen15c03c32004-04-06 17:52:02 +00001783 "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n") \
1784 USAGE_SELINUX("\t-k\tprint security context\n") \
1785 USAGE_SELINUX("\t-K\tprint security context in long format\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001786
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001787#define lsattr_trivial_usage \
1788 "[-Radlv] [files...]"
1789#define lsattr_full_usage \
1790 "list file attributes on an ext2 fs\n\n" \
1791 "Options:\n" \
1792 "\t-R\trecursively list subdirectories\n" \
1793 "\t-a\tdo not hide entries starting with .\n" \
1794 "\t-d\tlist directory entries instead of contents\n" \
1795 "\t-l\tprint long flag names\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001796 "\t-v\tlist the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001797
Eric Andersen7e9276b2001-02-22 01:15:47 +00001798#define lsmod_trivial_usage \
1799 ""
1800#define lsmod_full_usage \
1801 "List the currently loaded kernel modules."
1802
Eric Andersen3d925622005-06-09 10:16:02 +00001803#ifdef CONFIG_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00001804#define makedevs_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001805 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001806#define makedevs_full_usage \
1807 "Creates a range of block or character special files\n\n" \
1808 "TYPEs include:\n" \
1809 "\tb:\tMake a block (buffered) device.\n" \
1810 "\tc or u:\tMake a character (un-buffered) device.\n" \
1811 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1812 "FIRST specifies the number appended to NAME to create the first device.\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001813 "LAST specifies the number of the last item that should be created\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001814 "If 's' is the last argument, the base device is created as well.\n\n" \
1815 "For example:\n" \
1816 "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001817 "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001818#define makedevs_example_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001819 "# makedevs /dev/ttyS c 4 66 2 63\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001820 "[creates ttyS2-ttyS63]\n" \
Eric Andersena151d192004-04-06 17:16:36 +00001821 "# makedevs /dev/hda b 3 0 0 8 s\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001822 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001823#endif
1824
1825#ifdef CONFIG_FEATURE_MAKEDEVS_TABLE
1826#define makedevs_trivial_usage \
Eric Andersene8614db2005-07-18 09:28:36 +00001827 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00001828#define makedevs_full_usage \
Eric Andersene8614db2005-07-18 09:28:36 +00001829 "Creates a range of special files as specified in a device table.\n" \
1830 "Device table entries take the form of:\n" \
Eric Andersene8614db2005-07-18 09:28:36 +00001831 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
1832 "Where name is the file name, type can be one of:\n" \
1833 " f A regular file\n" \
1834 " d Directory\n" \
1835 " c Character special device file\n" \
1836 " b Block special device file\n" \
1837 " p Fifo (named pipe)\n" \
1838 "uid is the user id for the target file, gid is the group id for the\n" \
1839 "target file. The rest of the entries (major, minor, etc) apply to\n" \
Eric Andersen54e57da2005-07-18 09:42:37 +00001840 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00001841#define makedevs_example_usage \
1842 "For example:\n" \
1843 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
1844 "/dev d 755 0 0 - - - - -\n" \
1845 "/dev/console c 666 0 0 5 1 - - -\n" \
1846 "/dev/null c 666 0 0 1 3 0 0 -\n" \
1847 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
1848 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
1849 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
1850 "Will Produce:\n" \
1851 "/dev\n" \
1852 "/dev/console\n" \
1853 "/dev/null\n" \
1854 "/dev/zero\n" \
1855 "/dev/hda\n" \
Eric Andersen54e57da2005-07-18 09:42:37 +00001856 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001857#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001858
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001859#ifdef CONFIG_FEATURE_MD5_SHA1_SUM_CHECK
1860#define USAGE_MD5_SHA1_SUM_CHECK(a) a
1861#else
1862#define USAGE_MD5_SHA1_SUM_CHECK(a)
1863#endif
1864
Eric Andersen7e9276b2001-02-22 01:15:47 +00001865#define md5sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001866 "[OPTION] [FILEs...]" \
1867 USAGE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001868#define md5sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00001869 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001870 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001871 "With no FILE, or when FILE is -, read standard input." \
1872 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
1873 "\t-c\tcheck MD5 sums against given list\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001874 "\nThe following two options are useful only when verifying checksums:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00001875 "\t-s\tdon't output anything, status code shows success\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00001876 "\t-w\twarn about improperly formated MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001877#define md5sum_example_usage \
1878 "$ md5sum < busybox\n" \
1879 "6fd11e98b98a58f64ff3398d7b324003\n" \
1880 "$ md5sum busybox\n" \
1881 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1882 "$ md5sum -c -\n" \
1883 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1884 "busybox: OK\n" \
1885 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001886
Rob Landley70f7ef72005-12-13 08:21:33 +00001887#define mdev_trivial_usage \
1888 "[-s]"
1889#define mdev_full_usage \
Mike Frysinger35cf19d2006-02-02 22:52:59 +00001890 "\t-s\tScan /sys and populate /dev during system boot\n\n" \
Rob Landley70f7ef72005-12-13 08:21:33 +00001891 "Called with no options (via hotplug) it uses environment variables\n" \
1892 "to determine which device to add/remove."
1893#ifdef CONFIG_FEATURE_MDEV_CONFIG
1894#define mdev_notes_usage \
1895 "The mdev config file contains lines that look like:\n" \
Tim Rikerc1ef7bd2006-01-25 00:08:53 +00001896 " hd[a-z][0-9]* 0:3 660\n\n" \
1897 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landley70f7ef72005-12-13 08:21:33 +00001898 "Optionally, that can be followed (on the same line) by an asterisk\n" \
1899 "and a command line to run after creating the corresponding device(s),\n"\
1900 "ala:\n\n" \
1901 " hdc root:cdrom 660 *ln -s hdc cdrom\n\n" \
1902 "Config file parsing stops on the first matching line. If no config\n"\
1903 "entry is matched, devices are created with default 0:0 660. (Make\n"\
1904 "the last line match .* to override this.)\n\n"
1905#endif
1906
Glenn L McGrath061c9002002-09-16 04:21:46 +00001907#define mesg_trivial_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001908 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001909#define mesg_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00001910 "mesg controls write access to your terminal\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001911 "\ty\tAllow write access to your terminal\n" \
1912 "\tn\tDisallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001913
Eric Andersen7e9276b2001-02-22 01:15:47 +00001914#define mkdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001915 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001916#define mkdir_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00001917 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001918 "Options:\n" \
1919 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001920 "\t-p\tno error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001921#define mkdir_example_usage \
1922 "$ mkdir /tmp/foo\n" \
1923 "$ mkdir /tmp/foo\n" \
1924 "/tmp/foo: File exists\n" \
1925 "$ mkdir /tmp/foo/bar/baz\n" \
1926 "/tmp/foo/bar/baz: No such file or directory\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001927 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001928
Mike Frysinger6447ac02005-06-11 05:29:40 +00001929#define mke2fs_trivial_usage \
1930 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
1931 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
1932 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
1933 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
1934 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
1935 "device [blocks-count]"
1936#define mke2fs_full_usage \
1937 "\t-b size\tblock size in bytes\n" \
1938 "\t-c\tcheck for bad blocks before creating\n" \
1939 "\t-E opts\tset extended options\n" \
1940 "\t-f size\tfragment size in bytes\n" \
1941 "\t-F\tforce (ignore sanity checks)\n" \
1942 "\t-g num\tnumber of blocks in a block group\n" \
1943 "\t-i ratio\tthe bytes/inode ratio\n" \
1944 "\t-j\tcreate a journal (ext3)\n" \
1945 "\t-J opts\tset journal options (size/device)\n" \
1946 "\t-l file\tread bad blocks list from file\n" \
1947 "\t-L lbl\tset the volume label\n" \
1948 "\t-m percent\tpercent of fs blocks to reserve for admin\n" \
1949 "\t-M dir\tset last mounted directory\n" \
1950 "\t-n\tdo not actually create anything\n" \
1951 "\t-N num\tnumber of inodes to create\n" \
1952 "\t-o os\tset the 'creator os' field\n" \
1953 "\t-O features\tdir_index/filetype/has_journal/journal_dev/sparse_super\n" \
1954 "\t-q\tquiet execution\n" \
1955 "\t-r rev\tset filesystem revision\n" \
1956 "\t-S\twrite superblock and group descriptors only\n" \
1957 "\t-T fs-type\tset usage type (news/largefile/largefile4)\n" \
1958 "\t-v\tverbose execution"
1959
Eric Andersen7e9276b2001-02-22 01:15:47 +00001960#define mkfifo_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001961 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001962#define mkfifo_full_usage \
1963 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1964 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001965 "\t-m\tcreate the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001966
Eric Andersen7e9276b2001-02-22 01:15:47 +00001967#define mkfs_minix_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001968 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001969#define mkfs_minix_full_usage \
1970 "Make a MINIX filesystem.\n\n" \
1971 "Options:\n" \
1972 "\t-c\t\tCheck the device for bad blocks\n" \
1973 "\t-n [14|30]\tSpecify the maximum length of filenames\n" \
1974 "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \
1975 "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001976 "\t-v\t\tMake a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001977
Eric Andersen7e9276b2001-02-22 01:15:47 +00001978#define mknod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001979 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001980#define mknod_full_usage \
1981 "Create a special file (block, character, or pipe).\n\n" \
1982 "Options:\n" \
1983 "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \
1984 "TYPEs include:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001985 "\tb:\tMake a block (buffered) device\n" \
1986 "\tc or u:\tMake a character (un-buffered) device\n" \
1987 "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001988#define mknod_example_usage \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001989 "$ mknod /dev/fd0 b 2 0\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00001990 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001991
Eric Andersen7e9276b2001-02-22 01:15:47 +00001992#define mkswap_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001993 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001994#define mkswap_full_usage \
1995 "Prepare a disk partition to be used as a swap partition.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00001996 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001997 "\t-c\t\tCheck for read-ability\n" \
1998 "\t-v0\t\tMake version 0 swap [max 128 Megs]\n" \
1999 "\t-v1\t\tMake version 1 swap [big!] (default for kernels >\n\t\t\t2.1.117)\n" \
2000 "\tblock-count\tNumber of block to use (default is entire partition)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002001
Eric Andersen7e9276b2001-02-22 01:15:47 +00002002#define mktemp_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002003 "[-dq] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002004#define mktemp_full_usage \
2005 "Creates a temporary file with its name based on TEMPLATE.\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002006 "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX).\n\n" \
2007 "Options:\n" \
2008 "\t-d\t\tMake a directory instead of a file\n" \
2009 "\t-q\t\tFail silently if an error occurs"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002010#define mktemp_example_usage \
2011 "$ mktemp /tmp/temp.XXXXXX\n" \
2012 "/tmp/temp.mWiLjM\n" \
2013 "$ ls -la /tmp/temp.mWiLjM\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002014 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002015
Eric Andersen8d79ce82001-07-22 23:00:15 +00002016#define modprobe_trivial_usage \
Rob Landley9c32a152005-12-11 20:12:24 +00002017 "[-knqrsv] MODULE [symbol=value ...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002018#define modprobe_full_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002019 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002020 "\t-k\tMake module autoclean-able\n" \
2021 "\t-n\tJust show what would be done\n" \
2022 "\t-q\tQuiet output\n" \
2023 "\t-r\tRemove module (stacks) or do autoclean\n" \
2024 "\t-s\tReport via syslog instead of stderr\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002025 "\t-v\tVerbose output\n\n"
2026#define modprobe_notes_usage \
2027"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2028"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2029"pass each module it loads.\n" \
2030"\n" \
2031"The configuration file is searched (in order) amongst:\n" \
2032"\n" \
2033" /etc/modprobe.conf (2.6 only)\n" \
2034" /etc/modules.conf\n" \
2035" /etc/conf.modules (deprecated)\n" \
2036"\n" \
2037"They all have the same syntax (see below). If none is present, it is\n" \
2038"_not_ an error; each loaded module is then expected to load without\n" \
2039"options. Once a file is found, the others are tested for.\n" \
2040"\n" \
2041"/etc/modules.conf entry format:\n" \
2042"\n" \
2043" alias <alias_name> <mod_name>\n" \
2044" Makes it possible to modprobe alias_name, when there is no such module.\n" \
2045" It makes sense if your mod_name is long, or you want a more reprenstative\n" \
2046" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2047" This makes it also possible to use a different set of options (below) for\n" \
2048" the module and the alias.\n" \
2049" A module can be aliased more than once.\n" \
2050"\n" \
2051" options <mod_name|alias_name> <symbol=value ...>\n" \
2052" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2053" the \"symbol=value\" pairs as option to that module.\n" \
2054"\n" \
2055"Sample /etc/modules.conf file:\n" \
2056"\n" \
2057" options tulip irq=3\n" \
2058" alias tulip tulip2\n" \
2059" options tulip2 irq=4 io=0x308\n" \
2060"\n" \
2061"Other functionality offered by 'classic' modprobe is not available in\n" \
2062"this implementation.\n" \
2063"\n" \
2064"If module options are present both in the config file, and on the command line,\n" \
2065"then the options from the command line will be passed to the module _after_\n" \
2066"the options from the config file. That way, you can have defaults in the config\n" \
2067"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002068#define modprobe_example_usage \
Rob Landley9c32a152005-12-11 20:12:24 +00002069 "(with the above /etc/modules.conf):\n\n" \
2070 "$ modprobe tulip\n" \
2071 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2072 "$ modprobe tulip irq=5\n" \
2073 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2074 "$ modprobe tulip2\n" \
2075 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2076 " which are the default for alias 'tulip2'\n\n" \
2077 "$ modprobe tulip2 irq=8\n" \
2078 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2079 " which are the default for alias 'tulip2' overriden by the option 'irq=8'\n\n" \
2080 " from the command line\n\n" \
2081 "$ modprobe tulip2 irq=2 io=0x210\n" \
2082 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2083 " which are the default for alias 'tulip2' overriden by the options 'irq=2 io=0x210'\n\n" \
2084 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002085
Eric Andersen7e9276b2001-02-22 01:15:47 +00002086#define more_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002087 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002088#define more_full_usage \
2089 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002090#define more_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002091 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002092
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002093#ifdef CONFIG_FEATURE_MOUNT_LOOP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002094# define USAGE_MOUNT_LOOP(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002095#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002096# define USAGE_MOUNT_LOOP(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00002097#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002098#ifdef CONFIG_FEATURE_MTAB_SUPPORT
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002099# define USAGE_MTAB(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002100#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002101# define USAGE_MTAB(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002102#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002103#define mount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002104 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002105#define mount_full_usage \
Mike Frysinger29ed59e2006-01-04 00:04:08 +00002106 "Mount a filesystem. Filesystem autodetection requires /proc be mounted.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002107 "Flags:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002108 "\t-a:\t\tMount all filesystems in fstab\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002109 USAGE_MTAB( \
Mike Frysinger058e7402005-04-23 07:00:33 +00002110 "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it\n" \
2111 "\t-n:\t\tDon't write a mount table entry\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002112 ) \
Mike Frysinger058e7402005-04-23 07:00:33 +00002113 "\t-o option:\tOne of many filesystem options, listed below\n" \
2114 "\t-r:\t\tMount the filesystem read-only\n" \
2115 "\t-t fs-type:\tSpecify the filesystem type\n" \
2116 "\t-w:\t\tMount for reading and writing (default)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002117 "\n" \
2118 "Options for use with the \"-o\" flag:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002119 "\tasync/sync:\tWrites are asynchronous / synchronous\n" \
2120 "\tatime/noatime:\tEnable / disable updates to inode access times\n" \
2121 "\tdev/nodev:\tAllow use of special device files / disallow them\n" \
2122 "\texec/noexec:\tAllow use of executable files / disallow them\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002123 USAGE_MOUNT_LOOP( \
Rob Landley1d589b22005-11-29 23:47:10 +00002124 "\tloop:\t\t Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002125 ) \
Mike Frysinger058e7402005-04-23 07:00:33 +00002126 "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them\n" \
2127 "\tremount:\tRe-mount a mounted filesystem, changing its flags\n" \
2128 "\tro/rw:\t\tMount for read-only / read-write\n" \
Rob Landley1d589b22005-11-29 23:47:10 +00002129 "\tbind:\t\tBind a directory to an additional location\n" \
2130 "\tmove:\t\tRelocate an existing mount point.\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002131 "\nThere are EVEN MORE flags that are specific to each filesystem\n" \
2132 "You'll have to see the written documentation for those filesystems"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002133#define mount_example_usage \
2134 "$ mount\n" \
2135 "/dev/hda3 on / type minix (rw)\n" \
2136 "proc on /proc type proc (rw)\n" \
2137 "devpts on /dev/pts type devpts (rw)\n" \
2138 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
Rob Landley1d589b22005-11-29 23:47:10 +00002139 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2140 "$ mount cd_image.iso mydir\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002141
Rob Landleyd00b3a52005-08-20 05:07:08 +00002142#define mountpoint_trivial_usage \
2143 "[-q] <[-d] DIR | -x DEVICE>"
2144#define mountpoint_full_usage \
2145 "mountpoint checks if the directory is a mountpoint\n\n" \
2146 "Options:\n" \
2147 "\t-q:\t\tBe more quiet\n" \
2148 "\t-d:\t\tPrint major/minor device number of the filesystem\n" \
2149 "\t-x:\t\tPrint major/minor device number of the blockdevice"
2150#define mountpoint_example_usage \
2151 "$ mountpoint /proc\n" \
2152 "/proc is not a mountpoint\n" \
2153 "$ mountpoint /sys\n" \
2154 "/sys is a mountpoint\n"
2155
Eric Andersen7e9276b2001-02-22 01:15:47 +00002156#define mt_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002157 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002158#define mt_full_usage \
2159 "Control magnetic tape drive operation\n" \
2160 "\nAvailable Opcodes:\n\n" \
2161 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2162 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
Eric Andersen92fb9392003-08-08 20:09:03 +00002163 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002164 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002165
Eric Andersen7e9276b2001-02-22 01:15:47 +00002166#define mv_trivial_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002167 "[OPTION]... SOURCE DEST\n" \
2168 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002169#define mv_full_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002170 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY.\n\n" \
2171 "Options:\n" \
2172 "\t-f\tdon't prompt before overwriting\n" \
2173 "\t-i\tinteractive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002174#define mv_example_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002175 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002176
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002177#define nameif_trivial_usage \
Glenn L McGratha9adef02003-01-19 13:34:21 +00002178 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002179#define nameif_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002180 "Nameif renaming network interface while it in the down state.\n\n" \
2181 "Options:\n" \
2182 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002183 "\t-s\t\tUse syslog (LOCAL0 facility)\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002184 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002185#define nameif_example_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002186 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2187 " or\n" \
2188 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002189
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002190#ifdef CONFIG_NC_GAPING_SECURITY_HOLE
2191# define USAGE_NC_EXEC(a) a
2192#else
2193# define USAGE_NC_EXEC(a)
2194#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002195#define nc_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002196 "[OPTIONS] [IP] [port]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002197#define nc_full_usage \
Eric Andersen00a6a752002-04-26 23:53:10 +00002198 "Netcat opens a pipe to IP:port\n\n" \
2199 "Options:\n" \
2200 "\t-l\t\tlisten mode, for inbound connects\n" \
2201 "\t-p PORT\t\tlocal port number\n" \
Eric Andersen1323c942002-04-26 23:59:12 +00002202 "\t-i SECS\t\tdelay interval for lines sent\n" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002203 USAGE_NC_EXEC( \
2204 "\t-e PROG\t\tprogram to exec after connect (dangerous!)\n" \
2205 ) \
2206 "\t-w SECS\t\ttimeout for connects and final net reads"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002207#define nc_example_usage \
2208 "$ nc foobar.somedomain.com 25\n" \
2209 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2210 "help\n" \
2211 "214-Commands supported:\n" \
2212 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2213 "214 NOOP QUIT RSET HELP\n" \
2214 "quit\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002215 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002216
Eric Andersen1552ff72001-10-31 11:07:12 +00002217#define netstat_trivial_usage \
Robert Griebl8187bb42002-05-14 23:10:58 +00002218 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002219#define netstat_full_usage \
Eric Andersena151d192004-04-06 17:16:36 +00002220 "Netstat displays Linux networking information.\n\n" \
2221 "Options:\n" \
2222 "\t-l display listening server sockets\n" \
2223 "\t-a display all sockets (default: connected)\n" \
2224 "\t-e display other/more information\n" \
2225 "\t-n don't resolve names\n" \
2226 "\t-r display routing table\n" \
2227 "\t-t tcp sockets\n" \
2228 "\t-u udp sockets\n" \
2229 "\t-w raw sockets\n" \
2230 "\t-x unix sockets"
Eric Andersen1552ff72001-10-31 11:07:12 +00002231
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002232#define nice_trivial_usage \
2233 "[-n ADJUST] [COMMAND [ARG] ...]"
2234#define nice_full_usage \
2235 "Nice runs a program with modified scheduling priority.\n\n" \
2236 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002237 "\t-n ADJUST\tAdjust the scheduling priority by ADJUST"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002238
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002239#define nohup_trivial_usage \
2240 "COMMAND [ARGS]"
2241#define nohup_full_usage \
2242 "run a command immune to hangups, with output to a non-tty"
2243#define nohup_example_usage \
2244 "$ nohup make &"
2245
Eric Andersen7e9276b2001-02-22 01:15:47 +00002246#define nslookup_trivial_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00002247 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002248#define nslookup_full_usage \
Eric Andersen091781e2001-06-21 19:30:10 +00002249 "Queries the nameserver for the IP address of the given HOST\n" \
2250 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002251#define nslookup_example_usage \
2252 "$ nslookup localhost\n" \
2253 "Server: default\n" \
2254 "Address: default\n" \
2255 "\n" \
2256 "Name: debian\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002257 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002258
Glenn L McGrath60281112001-11-02 11:39:46 +00002259#define od_trivial_usage \
2260 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
2261#define od_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002262 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Glenn L McGrath60281112001-11-02 11:39:46 +00002263 "to standard output. With no FILE, or when FILE is -, read standard input."
2264
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002265#define openvt_trivial_usage \
2266 "<vtnum> <COMMAND> [ARGS...]"
2267#define openvt_full_usage \
2268 "Start a command on a new virtual terminal"
2269#define openvt_example_usage \
2270 "openvt 2 /bin/ash\n"
2271
Eric Andersen27f64e12002-06-23 04:24:25 +00002272#ifdef CONFIG_FEATURE_SHA1_PASSWORDS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002273# define PASSWORD_ALG_TYPES(a) a
Tim Riker7b253f82003-12-28 05:02:40 +00002274#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002275# define PASSWORD_ALG_TYPES(a)
Eric Andersen27f64e12002-06-23 04:24:25 +00002276#endif
2277#define passwd_trivial_usage \
2278 "[OPTION] [name]"
2279#define passwd_full_usage \
Eric Andersenc38678d2002-09-16 06:22:25 +00002280 "Change a user password. If no name is specified,\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00002281 "changes the password for the current user.\n" \
2282 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002283 "\t-a\tDefine which algorithm shall be used for the password\n" \
Eric Andersen27f64e12002-06-23 04:24:25 +00002284 "\t\t\t(Choices: des, md5" \
Eric Andersen7f90ed42002-07-03 05:55:14 +00002285 PASSWORD_ALG_TYPES(", sha1") \
Mike Frysinger058e7402005-04-23 07:00:33 +00002286 ")\n\t-d\tDelete the password for the specified user account\n" \
2287 "\t-l\tLocks (disables) the specified user account\n" \
2288 "\t-u\tUnlocks (re-enables) the specified user account"
Eric Andersen27f64e12002-06-23 04:24:25 +00002289
Glenn L McGrath655d8142003-06-22 15:32:41 +00002290#define patch_trivial_usage \
Rob Landley078bacf2005-09-01 03:02:23 +00002291 "[-p<num>] [-i<patch.diff>]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002292#define patch_full_usage \
Rob Landley078bacf2005-09-01 03:02:23 +00002293 "[-p<num>]\n" \
2294 "[-i<diff>]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002295#define patch_example_usage \
Rob Landley078bacf2005-09-01 03:02:23 +00002296 "$ patch -p1 <example.diff\n" \
2297 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002298
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002299#if ENABLE_FEATURE_PIDOF_SINGLE
2300#define USAGE_FEATURE_PIDOF_SINGLE(a) a
2301#else
2302#define USAGE_FEATURE_PIDOF_SINGLE(a)
2303#endif
2304#if ENABLE_FEATURE_PIDOF_OMIT
2305#define USAGE_FEATURE_PIDOF_OMIT(a) a
2306#else
2307#define USAGE_FEATURE_PIDOF_OMIT(a)
2308#endif
2309#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
2310#define USAGE_PIDOF "Options:"
2311#else
2312#define USAGE_PIDOF "\n\tThis version of pidof accepts no options."
2313#endif
2314
Eric Andersen221b2ea2001-07-31 19:06:07 +00002315#define pidof_trivial_usage \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002316 "process-name [OPTION] [process-name ...]"
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002317
Eric Andersen221b2ea2001-07-31 19:06:07 +00002318#define pidof_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002319 "Lists the PIDs of all processes with names that match the\n" \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002320 "names on the command line.\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002321 USAGE_PIDOF \
2322 USAGE_FEATURE_PIDOF_SINGLE("\n\t-s\t\tdisplay only a single PID") \
2323 USAGE_FEATURE_PIDOF_OMIT("\n\t-o\t\tomit given pid.") \
2324 USAGE_FEATURE_PIDOF_OMIT("\n\t\t\tUse %PPID to omit the parent pid of pidof itself")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002325#define pidof_example_usage \
2326 "$ pidof init\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002327 "1\n" \
2328 USAGE_FEATURE_PIDOF_OMIT("$ pidof /bin/sh\n20351 5973 5950\n") \
2329 USAGE_FEATURE_PIDOF_OMIT("$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002330
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002331#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00002332#define ping_trivial_usage "host"
2333#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
2334#else
2335#define ping_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002336 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002337#define ping_full_usage \
2338 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
2339 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002340 "\t-c COUNT\tSend only COUNT pings\n" \
2341 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002342 "\t-q\t\tQuiet mode, only displays output at start\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002343 "\t\t\tand when finished"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002344#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002345#define ping_example_usage \
2346 "$ ping localhost\n" \
2347 "PING slag (127.0.0.1): 56 data bytes\n" \
2348 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2349 "\n" \
2350 "--- debian ping statistics ---\n" \
2351 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002352 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002353
Eric Andersen51b8bd62002-07-03 11:46:38 +00002354#ifndef CONFIG_FEATURE_FANCY_PING6
2355#define ping6_trivial_usage "host"
2356#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
2357#else
2358#define ping6_trivial_usage \
2359 "[OPTION]... host"
2360#define ping6_full_usage \
2361 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
2362 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002363 "\t-c COUNT\tSend only COUNT pings\n" \
2364 "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56)\n" \
Eric Andersen51b8bd62002-07-03 11:46:38 +00002365 "\t-q\t\tQuiet mode, only displays output at start\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002366 "\t\t\tand when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002367#endif
2368#define ping6_example_usage \
2369 "$ ping6 ip6-localhost\n" \
2370 "PING ip6-localhost (::1): 56 data bytes\n" \
2371 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2372 "\n" \
2373 "--- ip6-localhost ping statistics ---\n" \
2374 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002375 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002376
Eric Andersen7e9276b2001-02-22 01:15:47 +00002377#define pivot_root_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002378 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002379#define pivot_root_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002380 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002381 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002382
Eric Andersen7e9276b2001-02-22 01:15:47 +00002383#define poweroff_trivial_usage \
Rob Landley64612912006-01-30 08:31:37 +00002384 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002385#define poweroff_full_usage \
Rob Landley64612912006-01-30 08:31:37 +00002386 "Halt and shut off power.\n" \
Glenn L McGrathc0dd26f2004-07-23 06:06:21 +00002387 "Options:\n" \
Rob Landley64612912006-01-30 08:31:37 +00002388 "\t-d\t\tdelay interval for halting\n" \
2389 "\t-n\t\tno call to sync()\n" \
2390 "\t-f\t\tforce power off (don't go through init)\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002391
Mike Frysinger95d3c452005-04-21 23:29:24 +00002392#define printenv_trivial_usage \
2393 "[VARIABLES...]"
2394#define printenv_full_usage \
2395 "print all or part of environment\n\n" \
2396 "If no environment VARIABLE specified, print them all."
2397
Eric Andersen7e9276b2001-02-22 01:15:47 +00002398#define printf_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002399 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002400#define printf_full_usage \
2401 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002402 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002403#define printf_example_usage \
Mike Frysinger5c63a722005-04-16 04:23:58 +00002404 "$ printf \"Val=%d\\n\" 5\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00002405 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002406
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002407#if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE
Rob Landley6eb1e412005-06-20 04:30:36 +00002408#define USAGE_PS "\n\tThis version of ps accepts no options."
2409#else
2410#define USAGE_PS "\nOptions:"
2411#endif
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002412#if ENABLE_FEATURE_PS_WIDE
Rob Landley6eb1e412005-06-20 04:30:36 +00002413#define USAGE_PS_WIDE(a) a
2414#else
2415#define USAGE_PS_WIDE(a)
2416#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002417
Eric Andersen7e9276b2001-02-22 01:15:47 +00002418#define ps_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002419 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002420#define ps_full_usage \
2421 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002422 USAGE_PS \
2423 USAGE_SELINUX("\n\t-c\tshow SE Linux context") \
2424 USAGE_PS_WIDE("\n\tw\twide output")
2425
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002426#define ps_example_usage \
2427 "$ ps\n" \
2428 " PID Uid Gid State Command\n" \
2429 " 1 root root S init\n" \
2430 " 2 root root S [kflushd]\n" \
2431 " 3 root root S [kupdate]\n" \
2432 " 4 root root S [kpiod]\n" \
2433 " 5 root root S [kswapd]\n" \
2434 " 742 andersen andersen S [bash]\n" \
2435 " 743 andersen andersen S -bash\n" \
2436 " 745 root root S [getty]\n" \
2437 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002438
Eric Andersen7e9276b2001-02-22 01:15:47 +00002439#define pwd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002440 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002441#define pwd_full_usage \
2442 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002443#define pwd_example_usage \
2444 "$ pwd\n" \
2445 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002446
Eric Andersen7e9276b2001-02-22 01:15:47 +00002447#define rdate_trivial_usage \
Eric Andersen725db192003-07-22 08:26:05 +00002448 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002449#define rdate_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002450 "Get and possibly set the system date and time from a remote HOST.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002451 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002452 "\t-s\tSet the system date and time (default)\n" \
2453 "\t-p\tPrint the date and time"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002454
Ned Luddc6fbed52004-12-08 16:47:28 +00002455#ifdef CONFIG_FEATURE_READLINK_FOLLOW
2456#define USAGE_READLINK_FOLLOW(a) a
2457#else
2458#define USAGE_READLINK_FOLLOW(a)
2459#endif
2460
Eric Andersen7e9276b2001-02-22 01:15:47 +00002461#define readlink_trivial_usage \
Ned Luddc6fbed52004-12-08 16:47:28 +00002462 USAGE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002463#define readlink_full_usage \
Ned Luddc6fbed52004-12-08 16:47:28 +00002464 "Displays the value of a symbolic link." \
2465 USAGE_READLINK_FOLLOW("\n\nOptions:\n" \
2466 "\t-f\tcanonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002467
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002468#define readprofile_trivial_usage \
2469 "[OPTIONS]..."
2470#define readprofile_full_usage \
2471 "Options:\n" \
2472 "\t -m <mapfile> (default: /boot/System.map)\n" \
2473 "\t -p <profile> (default: /proc/profile)\n" \
2474 "\t -M <mult> set the profiling multiplier to <mult>\n" \
2475 "\t -i print only info about the sampling step\n" \
2476 "\t -v print verbose data\n" \
2477 "\t -a print all symbols, even if count is 0\n" \
2478 "\t -b print individual histogram-bin counts\n" \
2479 "\t -s print individual counters within functions\n" \
2480 "\t -r reset all the counters (root only)\n" \
2481 "\t -n disable byte order auto-detection"
2482
Glenn L McGrath62fae302002-12-10 00:14:33 +00002483#define realpath_trivial_usage \
2484 "pathname ..."
2485#define realpath_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002486 "Returns the absolute pathnames of given argument."
Tim Riker7b253f82003-12-28 05:02:40 +00002487
Eric Andersen7e9276b2001-02-22 01:15:47 +00002488#define reboot_trivial_usage \
Rob Landley64612912006-01-30 08:31:37 +00002489 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002490#define reboot_full_usage \
Glenn L McGrath72b14a82004-07-23 03:33:38 +00002491 "Reboot the system.\n" \
2492 "Options:\n" \
Rob Landley64612912006-01-30 08:31:37 +00002493 "\t-d\t\tdelay interval for rebooting\n" \
2494 "\t-n\t\tno call to sync()\n" \
2495 "\t-f\t\tforce reboot (don't go through init)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002496
2497#define renice_trivial_usage \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002498 "{{-n INCREMENT} | PRIORITY} [[ -p | -g | -u ] ID ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002499#define renice_full_usage \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002500 "Changes priority of running processes.\n\n" \
2501 "Options:\n" \
2502 "\t-n\tadjusts current nice value (smaller is faster)\n" \
2503 "\t-p\tprocess id(s) (default)\n" \
2504 "\t-g\tprocess group id(s)\n" \
2505 "\t-u\tprocess user name(s) and/or id(s)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002506
Eric Andersen7e9276b2001-02-22 01:15:47 +00002507#define reset_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002508 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002509#define reset_full_usage \
2510 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002511
Eric Andersen7e9276b2001-02-22 01:15:47 +00002512#define rm_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002513 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002514#define rm_full_usage \
2515 "Remove (unlink) the FILE(s). You may use '--' to\n" \
2516 "indicate that all following arguments are non-options.\n\n" \
2517 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002518 "\t-i\t\talways prompt before removing each destination\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002519 "\t-f\t\tremove existing destinations, never prompt\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002520 "\t-r or -R\tremove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002521#define rm_example_usage \
2522 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002523
Eric Andersen7e9276b2001-02-22 01:15:47 +00002524#define rmdir_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002525 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002526#define rmdir_full_usage \
2527 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002528#define rmdir_example_usage \
2529 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002530
Eric Andersen7e9276b2001-02-22 01:15:47 +00002531#define rmmod_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002532 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002533#define rmmod_full_usage \
2534 "Unloads the specified kernel modules from the kernel.\n\n" \
2535 "Options:\n" \
Tim Rikercf932742002-12-14 01:58:59 +00002536 "\t-a\tRemove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002537#define rmmod_example_usage \
2538 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002539
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002540#ifdef CONFIG_FEATURE_IPV6
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002541# define USAGE_ROUTE_IPV6(a) a
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002542#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002543# define USAGE_ROUTE_IPV6(a) "\t"
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002544#endif
2545
2546
Eric Andersen7e9276b2001-02-22 01:15:47 +00002547#define route_trivial_usage \
Manuel Novoa III 7d0c5192004-03-10 07:42:38 +00002548 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002549#define route_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00002550 "Edit the kernel's routing tables.\n\n" \
Eric Andersenfb74a452001-12-18 14:06:03 +00002551 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002552 "\t-n\t\tDont resolve names\n" \
2553 "\t-e\t\tDisplay other/more information\n" \
2554 "\t-A inet" USAGE_ROUTE_IPV6("{6}") "\tSelect address family"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002555
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002556#define rpm_trivial_usage \
2557 "-i -q[ildc]p package.rpm"
2558#define rpm_full_usage \
2559 "Manipulates RPM packages" \
Eric Andersendfce3532003-06-15 07:00:54 +00002560 "\n\nOptions:" \
2561 "\n\t-i Install package" \
2562 "\n\t-q Query package" \
2563 "\n\t-p Query uninstalled package" \
2564 "\n\t-i Show information" \
2565 "\n\t-l List contents" \
2566 "\n\t-d List documents" \
2567 "\n\t-c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002568
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002569#define rpm2cpio_trivial_usage \
2570 "package.rpm"
2571#define rpm2cpio_full_usage \
2572 "Outputs a cpio archive of the rpm file."
2573
Eric Andersen6cf47a72001-10-31 10:24:36 +00002574#define run_parts_trivial_usage \
2575 "[-t] [-a ARG] [-u MASK] DIRECTORY"
2576#define run_parts_full_usage \
2577 "Run a bunch of scripts in a directory.\n\n" \
2578 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002579 "\t-t\tPrints what would be run, but does not actually run anything\n" \
2580 "\t-a ARG\tPass ARG as an argument for every program invoked\n" \
2581 "\t-u MASK\tSet the umask to MASK before executing every program"
Eric Andersen6cf47a72001-10-31 10:24:36 +00002582
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002583#if BB_APPLET_RUNLEVEL
2584#define runlevel_trivial_usage \
2585 "[utmp]"
2586#define runlevel_full_usage \
2587 "Find the current and previous system runlevel.\n\n" \
2588 "If no utmp file exists or if no runlevel record can be found,\n" \
2589 "runlevel prints \"unknown\""
2590#define runlevel_example_usage \
2591 "$ runlevel /var/run/utmp\n" \
2592 "N 2"
2593#endif
2594
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002595#define rx_trivial_usage \
2596 "FILE"
2597#define rx_full_usage \
2598 "Receive a file using the xmodem protocol."
2599#define rx_example_usage \
2600 "$ rx /tmp/foo\n"
2601
Eric Andersen7e9276b2001-02-22 01:15:47 +00002602#define sed_trivial_usage \
Rob Landley1ce59682004-05-26 21:59:31 +00002603 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002604#define sed_full_usage \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002605 "Options:\n" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002606 "\t-e script\tadd the script to the commands to be executed\n" \
Eric Andersenf802ff72004-04-12 15:12:06 +00002607 "\t-f scriptfile\tadd script-file contents to the\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002608 "\t\t\tcommands to be executed\n" \
Rob Landley1ce59682004-05-26 21:59:31 +00002609 "\t-i\t\tedit files in-place\n" \
2610 "\t-n\t\tsuppress automatic printing of pattern space\n" \
Rob Landley58b118a2004-05-26 22:09:37 +00002611 "\t-r\t\tuse extended regular expression syntax\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002612 "\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002613 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
2614 "script to interpret. All remaining arguments are names of input files; if no\n" \
Eric Andersenf802ff72004-04-12 15:12:06 +00002615 "input files are specified, then the standard input is read. Source files\n" \
2616 "will not be modified unless -i option is given."
2617
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002618#define sed_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002619 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002620 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002621
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002622#define seq_trivial_usage \
2623 "[first [increment]] last"
2624#define seq_full_usage \
2625 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
2626 "FIRST, INCREMENT default to 1\n" \
2627 "Arguments:\n" \
2628 "\tLAST\n" \
2629 "\tFIRST\tLAST\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002630 "\tFIRST\tINCREMENT\tLAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002631
Paul Foxfc2256a2005-08-01 18:12:30 +00002632#define setconsole_trivial_usage \
2633 "[-r|--reset] [DEVICE]"
2634#define setconsole_full_usage \
2635 "Redirects system console output to DEVICE (default: /dev/tty).\n\n" \
2636 "Options:\n" \
2637 "\t-r\tReset output to /dev/console."
2638
Eric Andersen7e9276b2001-02-22 01:15:47 +00002639#define setkeycodes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002640 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002641#define setkeycodes_full_usage \
2642 "Set entries into the kernel's scancode-to-keycode map,\n" \
2643 "allowing unusual keyboards to generate usable keycodes.\n\n" \
2644 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002645 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002646#define setkeycodes_example_usage \
2647 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002648
Paul Fox42403642005-08-01 22:52:09 +00002649#define setsid_trivial_usage \
2650 "program [arg ...]"
2651#define setsid_full_usage \
2652 "Runs any program in a new session by calling setsid() before\n" \
2653 "exec'ing the rest of its arguments. See setsid(2) for details."
2654
Matt Kraai2d91deb2001-08-01 17:21:35 +00002655#define lash_trivial_usage \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002656 "[FILE]...\n" \
2657 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00002658#define lash_full_usage \
Eric Andersen2e9c2572003-08-08 22:26:06 +00002659 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00002660#define lash_notes_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002661 "This command does not yet have proper documentation.\n\n" \
2662 "Use lash just as you would use any other shell. It properly handles pipes,\n" \
2663 "redirects, job control, can be used as the shell for scripts, and has a\n" \
2664 "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002665 "Bourne Shell syntax. If you need things like \"if-then-else\", \"while\", and such\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002666 "use ash or bash. If you just need a very simple and extremely small shell,\n" \
2667 "this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002668
Eric Andersen2e9c2572003-08-08 22:26:06 +00002669#define last_trivial_usage \
2670 ""
2671#define last_full_usage \
2672 "Shows listing of the last users that logged into the system"
2673
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002674#define sha1sum_trivial_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002675 "[OPTION] [FILEs...]" \
2676 USAGE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002677#define sha1sum_full_usage \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002678 "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n\n" \
2679 "Options:\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002680 "With no FILE, or when FILE is -, read standard input." \
2681 USAGE_MD5_SHA1_SUM_CHECK("\n\n" \
2682 "\t-c\tcheck SHA1 sums against given list\n" \
2683 "\nThe following two options are useful only when verifying checksums:\n" \
Glenn L McGrath0b6539f2003-11-18 21:40:30 +00002684 "\t-s\tdon't output anything, status code shows success\n" \
Glenn L McGrathc83e3a62003-12-04 13:06:44 +00002685 "\t-w\twarn about improperly formated SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002686
Manuel Novoa III cad53642003-03-19 09:13:01 +00002687#ifdef CONFIG_FEATURE_FANCY_SLEEP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002688# define USAGE_FANCY_SLEEP(a) a
2689# define USAGE_NOT_FANCY_SLEEP(a)
Manuel Novoa III cad53642003-03-19 09:13:01 +00002690#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002691# define USAGE_FANCY_SLEEP(a)
2692# define USAGE_NOT_FANCY_SLEEP(a) a
Manuel Novoa III cad53642003-03-19 09:13:01 +00002693#endif
2694
Eric Andersen7e9276b2001-02-22 01:15:47 +00002695#define sleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00002696 USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002697#define sleep_full_usage \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002698 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \
2699 USAGE_FANCY_SLEEP( \
Eric Andersen178de172004-04-06 16:36:20 +00002700 "Pause for a time equal to the total of the args given, where each arg can\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00002701 "\t\thave an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002702#define sleep_example_usage \
2703 "$ sleep 2\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00002704 "[2 second delay results]\n" \
2705 USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \
2706 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002707
Rob Landley6130b9b2006-01-23 21:10:38 +00002708#if ENABLE_FEATURE_SORT_BIG
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002709# define USAGE_SORT_BIG(a) a
Mark Whitleyfccaa362001-04-17 18:56:18 +00002710#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002711# define USAGE_SORT_BIG(a)
Mark Whitleyfccaa362001-04-17 18:56:18 +00002712#endif
Rob Landleyc0dedd02005-01-24 07:00:02 +00002713
Eric Andersen7e9276b2001-02-22 01:15:47 +00002714#define sort_trivial_usage \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002715 "[-nru" USAGE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002716#define sort_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002717 "Sorts lines of text in the specified files\n\n" \
Mark Whitleyfccaa362001-04-17 18:56:18 +00002718 "Options:\n" \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002719 USAGE_SORT_BIG( \
2720 "\t-b\tignore leading blanks\n" \
2721 "\t-c\tcheck whether input is sorted\n" \
2722 "\t-d\tdictionary order (blank or alphanumeric only)\n" \
2723 "\t-f\tignore case\n" \
2724 "\t-g\tgeneral numerical sort\n" \
2725 "\t-i\tignore unprintable characters\n" \
2726 "\t-k\tspecify sort key\n" \
2727 "\t-M\tsort month\n" \
2728 ) \
2729 "\t-n\tsort numbers\n" \
2730 USAGE_SORT_BIG( \
2731 "\t-o\toutput to file\n" \
2732 "\t-k\tsort by key\n" \
2733 "\t-t\tuse key separator other than whitespace\n" \
2734 ) \
2735 "\t-r\treverse sort order\n" \
2736 USAGE_SORT_BIG("\t-s\tstable (don't sort ties alphabetically)\n") \
2737 "\t-u\tsuppress duplicate lines" \
2738 USAGE_SORT_BIG("\n\t-z\tinput terminated by nulls, not newlines\n") \
2739 USAGE_SORT_BIG("\t-mST\tignored for GNU compatability") \
2740 ""
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002741#define sort_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00002742 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002743 "a\n" \
2744 "b\n" \
2745 "c\n" \
2746 "d\n" \
2747 "e\n" \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002748 "f\n" \
2749 USAGE_SORT_BIG( \
2750 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
2751 "d 2\n" \
2752 "b 2\n" \
2753 "c 3\n" \
2754 ) \
2755 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002756
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002757#define start_stop_daemon_trivial_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002758 "[OPTIONS] [--start|--stop] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002759#define start_stop_daemon_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002760 "Program to start and stop services." \
2761 "\n\nOptions:" \
2762 "\n\t-S|--start\t\t\tstart" \
2763 "\n\t-K|--stop\t\t\tstop" \
2764 "\n\t-a|--startas <pathname>\t\tstarts process specified by pathname" \
2765 "\n\t-b|--background\t\t\tforce process into background" \
2766 "\n\t-u|--user <username>|<uid>\tstop this user's processes" \
2767 "\n\t-x|--exec <executable>\t\tprogram to either start or check" \
2768 "\n\t-m|--make-pidfile <filename>\tcreate the -p file and enter pid in it" \
2769 "\n\t-n|--name <process-name>\tstop processes with this name" \
2770 "\n\t-p|--pidfile <pid-file>\t\tsave or load pid using a pid-file" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002771 "\n\t-q|--quiet\t\t\tbe quiet" \
Eric Andersen178de172004-04-06 16:36:20 +00002772 "\n\t-s|--signal <signal>\t\tsignal to send (default TERM)"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002773
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002774#ifdef CONFIG_FEATURE_STAT_FORMAT
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002775# define USAGE_STAT_FORMAT(a) a
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002776#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002777# define USAGE_STAT_FORMAT(a)
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002778#endif
2779#define stat_trivial_usage \
2780 "[OPTION] FILE..."
2781#define stat_full_usage \
2782 "display file (default) or filesystem status.\n\n" \
2783 "Options:\n" \
2784 USAGE_STAT_FORMAT("\t-c fmt\tuse the specified format\n") \
2785 "\t-f\tdisplay filesystem status\n" \
2786 "\t-L,-l\tdereference links\n" \
2787 "\t-t\tdisplay info in terse form\n" \
2788 USAGE_STAT_FORMAT( \
2789 "\nValid format sequences for files:\n" \
2790 " %a Access rights in octal\n" \
2791 " %A Access rights in human readable form\n" \
2792 " %b Number of blocks allocated (see %B)\n" \
2793 " %B The size in bytes of each block reported by %b\n" \
2794 " %d Device number in decimal\n" \
2795 " %D Device number in hex\n" \
2796 " %f Raw mode in hex\n" \
2797 " %F File type\n" \
2798 " %g Group ID of owner\n" \
2799 " %G Group name of owner\n" \
2800 " %h Number of hard links\n" \
2801 " %i Inode number\n" \
2802 " %n File name\n" \
2803 " %N Quoted file name with dereference if symbolic link\n" \
2804 " %o I/O block size\n" \
2805 " %s Total size, in bytes\n" \
2806 " %t Major device type in hex\n" \
2807 " %T Minor device type in hex\n" \
2808 " %u User ID of owner\n" \
2809 " %U User name of owner\n" \
2810 " %x Time of last access\n" \
2811 " %X Time of last access as seconds since Epoch\n" \
2812 " %y Time of last modification\n" \
2813 " %Y Time of last modification as seconds since Epoch\n" \
2814 " %z Time of last change\n" \
2815 " %Z Time of last change as seconds since Epoch\n" \
2816 "\nValid format sequences for file systems:\n" \
2817 " %a Free blocks available to non-superuser\n" \
2818 " %b Total data blocks in file system\n" \
2819 " %c Total file nodes in file system\n" \
2820 " %d Free file nodes in file system\n" \
2821 " %f Free blocks in file system\n" \
2822 " %i File System ID in hex\n" \
2823 " %l Maximum length of filenames\n" \
2824 " %n File name\n" \
2825 " %s Block size (for faster transfers)\n" \
2826 " %S Fundamental block size (for block counts)\n" \
2827 " %t Type in hex\n" \
2828 " %T Type in human readable form\n" \
2829 )
2830
Eric Andersenef5e8f82002-11-07 02:09:37 +00002831#define strings_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002832 "[-afo] [-n length] [file ... ]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002833#define strings_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00002834 "Display printable strings in a binary file." \
2835 "\n\nOptions:" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002836 "\n\t-a\tScan the whole files (this is the default)." \
Eric Andersen178de172004-04-06 16:36:20 +00002837 "\n\t-f\tPrecede each string with the name of the file where it was found." \
2838 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002839 "\n\t-o\tEach string is preceded by its decimal offset in the file"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002840
Eric Andersen7e9276b2001-02-22 01:15:47 +00002841#define stty_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002842 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002843#define stty_full_usage \
2844 "Without arguments, prints baud rate, line discipline," \
2845 "\nand deviations from stty sane." \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002846 "\n\nOptions:" \
Eric Andersen317827d2001-05-21 17:50:53 +00002847 "\n\t-F DEVICE\topen device instead of stdin" \
Eric Andersen7a9cc2d2001-02-23 16:58:44 +00002848 "\n\t-a\t\tprint all current settings in human-readable form" \
2849 "\n\t-g\t\tprint in stty-readable form" \
Eric Andersenabec3442001-05-21 17:58:01 +00002850 "\n\t[SETTING]\tsee manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002851
Robert Griebl1fca5582002-06-04 20:45:46 +00002852#define su_trivial_usage \
2853 "[OPTION]... [-] [username]"
2854#define su_full_usage \
2855 "Change user id or become root.\n" \
2856 "Options:\n" \
Bernhard Reutner-Fischer5a620ea2006-01-19 18:04:15 +00002857 "\t-p, -m\tPreserve environment" \
2858 "\n\t-c\tCommand to pass to 'sh -c'" \
2859 "\n\t-s\tShell to use instead of default shell"
Robert Griebl1fca5582002-06-04 20:45:46 +00002860
Eric Andersen27f64e12002-06-23 04:24:25 +00002861#define sulogin_trivial_usage \
2862 "[OPTION]... [tty-device]"
2863#define sulogin_full_usage \
2864 "Single user login\n" \
2865 "Options:\n" \
2866 "\t-f\tDo not authenticate (user already authenticated)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002867 "\t-h\tName of the remote host for this login\n" \
2868 "\t-p\tPreserve environment"
Eric Andersen27f64e12002-06-23 04:24:25 +00002869
Mike Frysinger95d3c452005-04-21 23:29:24 +00002870#define sum_trivial_usage \
2871 "[rs] [files...]"
2872#define sum_full_usage \
2873 "checksum and count the blocks in a file\n\n" \
2874 "Options:\n" \
2875 "\t-r\tuse BSD sum algorithm (1K blocks)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002876 "\t-s\tuse System V sum algorithm (512byte blocks)"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002877
Eric Andersen7e9276b2001-02-22 01:15:47 +00002878#define swapoff_trivial_usage \
Mike Frysinger68071e42005-09-13 02:26:24 +00002879 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002880#define swapoff_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002881 "Stop swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002882 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002883 "\t-a\tStop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002884
Eric Andersen7e9276b2001-02-22 01:15:47 +00002885#define swapon_trivial_usage \
Mike Frysinger68071e42005-09-13 02:26:24 +00002886 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002887#define swapon_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00002888 "Start swapping virtual memory pages on DEVICE.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002889 "Options:\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002890 "\t-a\tStart swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002891
Rob Landley0f34a822005-10-27 22:55:50 +00002892#define switch_root_trivial_usage \
Rob Landley70f7ef72005-12-13 08:21:33 +00002893 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00002894#define switch_root_full_usage \
2895 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Rob Landley70f7ef72005-12-13 08:21:33 +00002896 "and exec NEW_INIT.\n\n" \
2897 "Options:\n" \
2898 "\t-c\tRedirect console to device on new root"
Rob Landley0f34a822005-10-27 22:55:50 +00002899
Eric Andersen7e9276b2001-02-22 01:15:47 +00002900#define sync_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002901 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002902#define sync_full_usage \
2903 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002904
Eric Andersen7e9276b2001-02-22 01:15:47 +00002905
Eric Andersen29c77f72003-10-09 09:43:18 +00002906#ifdef CONFIG_FEATURE_ROTATE_LOGFILE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002907# define USAGE_ROTATE_LOGFILE(a) a
Eric Andersen29c77f72003-10-09 09:43:18 +00002908#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002909# define USAGE_ROTATE_LOGFILE(a)
Eric Andersen29c77f72003-10-09 09:43:18 +00002910#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002911#ifdef CONFIG_FEATURE_REMOTE_LOG
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002912# define USAGE_REMOTE_LOG(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002913#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002914# define USAGE_REMOTE_LOG(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002915#endif
Robert Griebl65d415d2002-08-07 21:10:19 +00002916#ifdef CONFIG_FEATURE_IPC_SYSLOG
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002917# define USAGE_IPC_LOG(a) a
Robert Griebl65d415d2002-08-07 21:10:19 +00002918#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002919# define USAGE_IPC_LOG(a)
Robert Griebl65d415d2002-08-07 21:10:19 +00002920#endif
2921
Eric Andersenb9050282003-12-24 06:02:11 +00002922#define sysctl_trivial_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00002923 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00002924#define sysctl_full_usage \
2925 "configure kernel parameters at runtime\n\n" \
Eric Andersenb9050282003-12-24 06:02:11 +00002926 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002927 "\t-n\tUse this option to disable printing of the key name when printing values\n" \
2928 "\t-w\tUse this option when you want to change a sysctl setting\n" \
2929 "\t-p\tLoad in sysctl settings from the file specified or /etc/sysctl.conf if none given\n" \
2930 "\t-a\tDisplay all values currently available\n" \
2931 "\t-A\tDisplay all values currently available in table form"
Eric Andersen5d38f5b2005-09-12 21:42:48 +00002932#define sysctl_example_usage \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002933 "sysctl [-n] variable ...\n" \
2934 "sysctl [-n] -w variable=value ...\n" \
2935 "sysctl [-n] -a\n" \
2936 "sysctl [-n] -p <file>\t(default /etc/sysctl.conf)\n" \
2937 "sysctl [-n] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00002938
Eric Andersen7e9276b2001-02-22 01:15:47 +00002939#define syslogd_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002940 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002941#define syslogd_full_usage \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002942 "Linux system and kernel logging utility.\n" \
2943 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002944 "Options:\n" \
Eric Andersen178de172004-04-06 16:36:20 +00002945 "\t-m MIN\t\tMinutes between MARK lines (default=20, 0=off)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002946 "\t-n\t\tRun as a foreground process\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00002947 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)\n" \
2948 "\t-S\t\tMake logging output smaller." \
Eric Andersen29c77f72003-10-09 09:43:18 +00002949 USAGE_ROTATE_LOGFILE( \
Eric Andersen178de172004-04-06 16:36:20 +00002950 "\n\t-s SIZE\t\tMax size (KB) before rotate (default=200KB, 0=off)\n" \
2951 "\t-b NUM\t\tNumber of rotated logs to keep (default=1, max=99, 0=purge)") \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002952 USAGE_REMOTE_LOG( \
Eric Andersendc121902001-02-24 18:52:36 +00002953 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
Robert Griebl65d415d2002-08-07 21:10:19 +00002954 "\t-L\t\tLog locally and via network logging (default is network only)") \
2955 USAGE_IPC_LOG( \
Eric Andersend4a5e252003-12-19 11:32:14 +00002956 "\n\t-C [size(KiB)]\tLog to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002957#define syslogd_example_usage \
2958 "$ syslogd -R masterlog:514\n" \
2959 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002960
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002961
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002962#ifndef CONFIG_FEATURE_FANCY_TAIL
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002963# define USAGE_UNSIMPLE_TAIL(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00002964#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002965# define USAGE_UNSIMPLE_TAIL(a) a
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002966#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +00002967#define tail_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002968 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002969#define tail_full_usage \
2970 "Print last 10 lines of each FILE to standard output.\n" \
2971 "With more than one FILE, precede each with a header giving the\n" \
2972 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
2973 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00002974 USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002975 "\t-n N[kbm]\tprint last N lines instead of last 10\n" \
2976 "\t-f\t\toutput data as the file grows" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002977 USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002978 "\t-s SEC\t\twait SEC seconds between reads with -f\n" \
2979 "\t-v\t\talways output headers giving file names\n\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002980 "If the first character of N (bytes or lines) is a '+', output begins with \n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002981 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002982 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
2983#define tail_example_usage \
2984 "$ tail -n 1 /etc/resolv.conf\n" \
2985 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002986
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002987#ifdef CONFIG_FEATURE_TAR_CREATE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002988# define USAGE_TAR_CREATE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002989#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002990# define USAGE_TAR_CREATE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002991#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002992#ifdef CONFIG_FEATURE_TAR_EXCLUDE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002993# define USAGE_TAR_EXCLUDE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00002994#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002995# define USAGE_TAR_EXCLUDE(a)
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002996#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002997#ifdef CONFIG_FEATURE_TAR_GZIP
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00002998# define USAGE_TAR_GZIP(a) a
Glenn L McGrath87444ef2002-12-27 00:45:35 +00002999#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003000# define USAGE_TAR_GZIP(a)
Glenn L McGrath87444ef2002-12-27 00:45:35 +00003001#endif
3002#ifdef CONFIG_FEATURE_TAR_BZIP2
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003003# define USAGE_TAR_BZIP2(a) a
Glenn L McGrath87444ef2002-12-27 00:45:35 +00003004#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003005# define USAGE_TAR_BZIP2(a)
Glenn L McGrath87444ef2002-12-27 00:45:35 +00003006#endif
Rob Landleyc1d69902006-01-20 18:28:50 +00003007#ifdef CONFIG_FEATURE_TAR_LZMA
3008# define USAGE_TAR_LZMA(a) a
3009#else
3010# define USAGE_TAR_LZMA(a)
3011#endif
Glenn L McGrath7370f622003-11-18 21:49:23 +00003012#ifdef CONFIG_FEATURE_TAR_COMPRESS
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003013# define USAGE_TAR_COMPRESS(a) a
Glenn L McGrath7370f622003-11-18 21:49:23 +00003014#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003015# define USAGE_TAR_COMPRESS(a)
Glenn L McGrath7370f622003-11-18 21:49:23 +00003016#endif
Glenn L McGrath87444ef2002-12-27 00:45:35 +00003017
Eric Andersen7e9276b2001-02-22 01:15:47 +00003018#define tar_trivial_usage \
Rob Landleyc1d69902006-01-20 18:28:50 +00003019 "-[" 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 +00003020 USAGE_TAR_EXCLUDE("[-X FILE]") \
Eric Andersen091781e2001-06-21 19:30:10 +00003021 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003022#define tar_full_usage \
3023 "Create, extract, or list files from a tar file.\n\n" \
Eric Andersen091781e2001-06-21 19:30:10 +00003024 "Options:\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00003025 USAGE_TAR_CREATE("\tc\t\tcreate\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003026 "\tx\t\textract\n" \
3027 "\tt\t\tlist\n" \
Glenn L McGrath87444ef2002-12-27 00:45:35 +00003028 "\nArchive format selection:\n" \
3029 USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
3030 USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
Rob Landleyc1d69902006-01-20 18:28:50 +00003031 USAGE_TAR_LZMA("\ta\t\tFilter the archive through lzma\n") \
Glenn L McGrath0c5d9c22003-11-18 23:27:49 +00003032 USAGE_TAR_COMPRESS("\tZ\t\tFilter the archive through compress\n") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003033 "\nFile selection:\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00003034 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003035 "\tO\t\textract to stdout\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00003036 USAGE_TAR_EXCLUDE( \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003037 "\texclude\t\tfile to exclude\n" \
3038 "\tX\t\tfile with names to exclude\n" \
3039 ) \
Eric Andersen091781e2001-06-21 19:30:10 +00003040 "\tC\t\tchange to directory DIR before operation\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003041 "\tv\t\tverbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003042#define tar_example_usage \
3043 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3044 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003045
Eric Andersen7e9276b2001-02-22 01:15:47 +00003046#define tee_trivial_usage \
3047 "[OPTION]... [FILE]..."
3048#define tee_full_usage \
3049 "Copy standard input to each FILE, and also to standard output.\n\n" \
Eric Andersen4b2e69a2001-02-22 23:32:59 +00003050 "Options:\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00003051 "\t-a\tappend to the given FILEs, do not overwrite\n" \
3052 "\t-i\tignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003053#define tee_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003054 "$ echo \"Hello\" | tee /tmp/foo\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003055 "$ cat /tmp/foo\n" \
3056 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003057
Eric Andersen539ffc92004-02-22 12:25:47 +00003058#ifdef CONFIG_FEATURE_TELNET_AUTOLOGIN
3059#define telnet_trivial_usage \
3060 "[-a] [-l USER] HOST [PORT]"
3061#define telnet_full_usage \
3062 "Telnet is used to establish interactive communication with another\n" \
3063 "computer over a network using the TELNET protocol.\n\n" \
3064 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003065 "\t-a\t\tAttempt an automatic login with the USER variable\n" \
3066 "\t-l USER\t\tAttempt an automatic login with the USER argument\n" \
Eric Andersen539ffc92004-02-22 12:25:47 +00003067 "\tHOST\t\tThe official name, alias or the IP address of the\n" \
3068 "\t\t\tremote host.\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003069 "\tPORT\t\tThe remote port number to connect to. If it is not\n" \
Eric Andersen178de172004-04-06 16:36:20 +00003070 "\t\t\tspecified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00003071#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003072#define telnet_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003073 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003074#define telnet_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003075 "Telnet is used to establish interactive communication with another\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003076 "computer over a network using the TELNET protocol."
Eric Andersen539ffc92004-02-22 12:25:47 +00003077#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003078
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003079#ifdef CONFIG_FEATURE_TELNETD_INETD
3080#define telnetd_trivial_usage \
3081 "(inetd mode) [OPTION]"
3082#define telnetd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003083 "Telnetd uses incoming TELNET connections via inetd.\n" \
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003084 "Options:\n" \
Glenn L McGrathab1955c2004-09-14 16:23:56 +00003085 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003086 "\t-f issue_file\tDisplay issue_file instead of /etc/issue"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003087#else
Eric Andersen08a72202002-09-30 20:52:10 +00003088#define telnetd_trivial_usage \
3089 "[OPTION]"
3090#define telnetd_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003091 "Telnetd listens for incoming TELNET connections on PORT.\n" \
Eric Andersen08a72202002-09-30 20:52:10 +00003092 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003093 "\t-p PORT\tlisten for connections on PORT (default 23)\n" \
3094 "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)\n" \
3095 "\t-f issue_file\tDisplay issue_file instead of /etc/issue"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003096#endif
Eric Andersen08a72202002-09-30 20:52:10 +00003097
Eric Andersen7e9276b2001-02-22 01:15:47 +00003098#define test_trivial_usage \
3099 "EXPRESSION\n or [ EXPRESSION ]"
3100#define test_full_usage \
3101 "Checks file types and compares values returning an exit\n" \
3102 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003103#define test_example_usage \
3104 "$ test 1 -eq 2\n" \
3105 "$ echo $?\n" \
3106 "1\n" \
3107 "$ test 1 -eq 1\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00003108 "$ echo $?\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003109 "0\n" \
3110 "$ [ -d /etc ]\n" \
3111 "$ echo $?\n" \
3112 "0\n" \
3113 "$ [ -d /junk ]\n" \
3114 "$ echo $?\n" \
3115 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003116
Eric Andersenbdfd0d72001-10-24 05:00:29 +00003117#ifdef CONFIG_FEATURE_TFTP_GET
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003118# define USAGE_TFTP_GET(a) a
Mark Whitley450736c2001-03-02 19:08:50 +00003119#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003120# define USAGE_TFTP_GET(a)
Mark Whitley450736c2001-03-02 19:08:50 +00003121#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00003122#ifdef CONFIG_FEATURE_TFTP_PUT
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003123# define USAGE_TFTP_PUT(a) a
Mark Whitley450736c2001-03-02 19:08:50 +00003124#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003125# define USAGE_TFTP_PUT(a)
Mark Whitley450736c2001-03-02 19:08:50 +00003126#endif
Eric Andersenbdfd0d72001-10-24 05:00:29 +00003127#ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003128# define USAGE_TFTP_BS(a) a
Glenn L McGrathad117d82001-10-05 04:40:37 +00003129#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003130# define USAGE_TFTP_BS(a)
Glenn L McGrathad117d82001-10-05 04:40:37 +00003131#endif
Mark Whitley450736c2001-03-02 19:08:50 +00003132
3133#define tftp_trivial_usage \
Matt Kraai3be34302001-09-21 14:42:30 +00003134 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00003135#define tftp_full_usage \
3136 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
Matt Kraai3be34302001-09-21 14:42:30 +00003137 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003138 "\t-l FILE\tLocal FILE\n" \
3139 "\t-r FILE\tRemote FILE" \
3140 USAGE_TFTP_GET( \
3141 "\n\t-g\tGet file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003142 ) \
Mike Frysinger058e7402005-04-23 07:00:33 +00003143 USAGE_TFTP_PUT( \
3144 "\n\t-p\tPut file" \
Mark Whitley450736c2001-03-02 19:08:50 +00003145 ) \
Glenn L McGrathad117d82001-10-05 04:40:37 +00003146 USAGE_TFTP_BS( \
Mike Frysinger058e7402005-04-23 07:00:33 +00003147 "\n\t-b SIZE\tTransfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00003148 )
Eric Andersenc3657422001-11-30 07:54:32 +00003149#define time_trivial_usage \
3150 "[OPTION]... COMMAND [ARGS...]"
3151#define time_full_usage \
Eric Andersen356b6db2001-12-06 07:42:04 +00003152 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
3153 "COMMAND's resource usage information is displayed\n\n" \
Eric Andersenc3657422001-11-30 07:54:32 +00003154 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003155 "\t-v\tDisplays verbose resource usage information"
Mark Whitley450736c2001-03-02 19:08:50 +00003156
Eric Andersen420b2082002-09-17 22:14:58 +00003157#define top_trivial_usage \
3158 "[-d <seconds>]"
3159#define top_full_usage \
3160 "top provides an view of processor activity in real time.\n" \
3161 "This utility reads the status for all processes in /proc each <seconds>\n" \
3162 "and shows the status for however many processes will fit on the screen.\n" \
3163 "This utility will not show processes that are started after program startup,\n" \
3164 "but it will show the EXIT status for and PIDs that exit while it is running."
3165
Eric Andersen7e9276b2001-02-22 01:15:47 +00003166#define touch_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003167 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003168#define touch_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003169 "Update the last-modified date on the given FILE[s].\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003170 "Options:\n" \
3171 "\t-c\tDo not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003172#define touch_example_usage \
3173 "$ ls -l /tmp/foo\n" \
3174 "/bin/ls: /tmp/foo: No such file or directory\n" \
3175 "$ touch /tmp/foo\n" \
3176 "$ ls -l /tmp/foo\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003177 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003178
3179#define tr_trivial_usage \
3180 "[-cds] STRING1 [STRING2]"
3181#define tr_full_usage \
3182 "Translate, squeeze, and/or delete characters from\n" \
3183 "standard input, writing to standard output.\n\n" \
3184 "Options:\n" \
3185 "\t-c\ttake complement of STRING1\n" \
3186 "\t-d\tdelete input characters coded STRING1\n" \
3187 "\t-s\tsqueeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003188#define tr_example_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003189 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003190 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003191
Eric Andersen5c58d282001-07-10 16:29:00 +00003192#define traceroute_trivial_usage \
"Vladimir N. Oleynik"45a8ed82005-09-06 16:08:33 +00003193 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
3194 "\t[-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
3195 "\t[-z pausemsecs] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00003196#define traceroute_full_usage \
3197 "trace the route ip packets follow going to \"host\"\n" \
3198 "Options:\n" \
"Vladimir N. Oleynik"45a8ed82005-09-06 16:08:33 +00003199 "\t-F\tSet the don't fragment bit\n" \
3200 "\t-I\tUse ICMP ECHO instead of UDP datagrams\n" \
3201 "\t-l\tDisplay the ttl value of the returned packet\n" \
3202 "\t-d\tSet SO_DEBUG options to socket\n" \
Eric Andersen5c58d282001-07-10 16:29:00 +00003203 "\t-n\tPrint hop addresses numerically rather than symbolically\n" \
3204 "\t-r\tBypass the normal routing tables and send directly to a host\n" \
3205 "\t-v\tVerbose output\n" \
3206 "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \
3207 "\t-p port#\tSet the base UDP port number used in probes\n" \
3208 "\t\t(default is 33434)\n" \
3209 "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \
3210 "\t\t(default is 3)\n" \
3211 "\t-s src_addr\tUse the following IP address as the source address\n" \
3212 "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \
3213 "\t\t(default 0)\n" \
3214 "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \
Mike Frysinger036f2992005-09-24 23:50:14 +00003215 "\t\t(default 3 sec)\n" \
3216 "\t-g\tSpecify a loose source route gateway (8 maximum)"
Eric Andersen5c58d282001-07-10 16:29:00 +00003217
3218
Eric Andersen7e9276b2001-02-22 01:15:47 +00003219#define true_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003220 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003221#define true_full_usage \
3222 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003223#define true_example_usage \
3224 "$ true\n" \
3225 "$ echo $?\n" \
3226 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003227
Eric Andersen7e9276b2001-02-22 01:15:47 +00003228#define tty_trivial_usage \
3229 ""
3230#define tty_full_usage \
Mike Frysinger058e7402005-04-23 07:00:33 +00003231 "Print the file name of the terminal connected to standard input.\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003232 "Options:\n" \
3233 "\t-s\tprint nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003234#define tty_example_usage \
3235 "$ tty\n" \
3236 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003237
Mike Frysinger174808c2005-06-11 01:14:09 +00003238#define tune2fs_trivial_usage \
3239 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
3240 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
3241 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
3242 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
3243 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
3244 "[-T last-check-time] [-U UUID] device"
3245#define tune2fs_full_usage \
3246 "Adjust filesystem options on ext[23] filesystems.\n\n"
3247
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003248#define udhcpc_trivial_usage \
Rob Landleya2841e62006-02-20 23:26:38 +00003249 "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003250#define udhcpc_full_usage \
Paul Foxa39bba32005-08-01 14:31:13 +00003251 "\t-c,\t--clientid=CLIENTID\tSet client identifier\n" \
3252 "\t-C,\t--clientid-none\tSuppress default client identifier\n" \
Paul Fox28de9512005-09-22 18:59:13 +00003253 "\t-V,\t--vendorclass=CLASSID\tSet vendor class identifier\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003254 "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
Russ Dill0288c8e2002-11-05 20:13:41 +00003255 "\t-h,\t \tAlias for -H\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003256 "\t-f,\t--foreground\tDo not fork after getting lease\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003257 "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003258 "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003259 "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated\n" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003260 "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \
3261 "\t-q,\t--quit\tQuit after obtaining lease\n" \
3262 "\t-r,\t--request=IP\tIP address to request (default: none)\n" \
3263 "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
Rob Landleya2841e62006-02-20 23:26:38 +00003264 "\t-t,\t--retries=NUM\tSend up to NUM request packets\n"\
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003265 "\t-v,\t--version\tDisplay version"
3266
Russ Dill61fb4892002-10-14 21:41:28 +00003267#define udhcpd_trivial_usage \
3268 "[configfile]\n" \
3269
3270#define udhcpd_full_usage \
Glenn L McGrath9130c852002-12-12 12:56:18 +00003271 ""
Russ Dill61fb4892002-10-14 21:41:28 +00003272
Eric Andersenbdfd0d72001-10-24 05:00:29 +00003273#ifdef CONFIG_FEATURE_MOUNT_FORCE
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003274# define USAGE_MOUNT_FORCE(a) a
Eric Andersen7e9276b2001-02-22 01:15:47 +00003275#else
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003276# define USAGE_MOUNT_FORCE(a)
Eric Andersen7e9276b2001-02-22 01:15:47 +00003277#endif
3278#define umount_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003279 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003280#define umount_full_usage \
3281 "Unmount file systems\n" \
John Beppu5d817682001-04-17 17:09:34 +00003282 "\nFlags:\n" "\t-a\tUnmount all file systems" \
3283 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
3284 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
Rob Landley16722552005-09-24 22:41:08 +00003285 "\n\t-l\tLazy umount (detach filesystem)" \
3286 "\n\t-f\tForce umount (i.e., unreachable NFS server)" \
3287 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 +00003288#define umount_example_usage \
3289 "$ umount /dev/hdc1 \n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003290
3291#define uname_trivial_usage \
3292 "[OPTION]..."
3293#define uname_full_usage \
3294 "Print certain system information. With no OPTION, same as -s.\n\n" \
3295 "Options:\n" \
3296 "\t-a\tprint all information\n" \
3297 "\t-m\tthe machine (hardware) type\n" \
3298 "\t-n\tprint the machine's network node hostname\n" \
3299 "\t-r\tprint the operating system release\n" \
3300 "\t-s\tprint the operating system name\n" \
3301 "\t-p\tprint the host processor type\n" \
3302 "\t-v\tprint the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003303#define uname_example_usage \
3304 "$ uname -a\n" \
Eric Andersen7f48a952003-12-28 05:06:56 +00003305 "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 +00003306
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003307#define uncompress_trivial_usage \
3308 "[-c] [-f] [ name ... ]"
3309#define uncompress_full_usage \
3310 "Uncompress .Z file[s]\n" \
3311 "Options:\n" \
3312 "\t-c\textract to stdout\n" \
Eric Andersen178de172004-04-06 16:36:20 +00003313 "\t-f\tforce overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00003314
Eric Andersen7e9276b2001-02-22 01:15:47 +00003315#define uniq_trivial_usage \
Rob Landley14efdc52005-09-07 04:18:36 +00003316 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003317#define uniq_full_usage \
3318 "Discard all but one of successive identical lines from INPUT\n" \
Eric Andersena0cfe942001-02-23 10:07:09 +00003319 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003320 "Options:\n" \
3321 "\t-c\tprefix lines by the number of occurrences\n" \
3322 "\t-d\tonly print duplicate lines\n" \
Manuel Novoa III cad53642003-03-19 09:13:01 +00003323 "\t-u\tonly print unique lines\n" \
3324 "\t-f N\tskip the first N fields\n" \
3325 "\t-s N\tskip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003326#define uniq_example_usage \
John Beppu5d817682001-04-17 17:09:34 +00003327 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003328 "a\n" \
3329 "b\n" \
3330 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003331
3332#define unix2dos_trivial_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003333 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003334#define unix2dos_full_usage \
Eric Andersen317827d2001-05-21 17:50:53 +00003335 "Converts FILE from unix format to dos format. When no option\n" \
3336 "is given, the input is converted to the opposite output format.\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00003337 "When no file is given, uses stdin for input and stdout for output.\n" \
Eric Andersen317827d2001-05-21 17:50:53 +00003338 "Options:\n" \
3339 "\t-u\toutput will be in UNIX format\n" \
Eric Andersen3200f5a2001-05-22 22:39:10 +00003340 "\t-d\toutput will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003341
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003342#define unzip_trivial_usage \
3343 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
3344#define unzip_full_usage \
Matt Kraai9758e7d2002-01-03 17:32:29 +00003345 "Extracts files from ZIP archives.\n\n" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003346 "Options:\n" \
3347 "\t-l\tlist archive contents (short form)\n" \
3348 "\t-n\tnever overwrite existing files (default)\n" \
3349 "\t-o\toverwrite files without prompting\n" \
3350 "\t-p\tsend output to stdout\n" \
3351 "\t-q\tbe quiet\n" \
3352 "\t-x\texclude these files\n" \
3353 "\t-d\textract files into this directory"
3354
Eric Andersen7e9276b2001-02-22 01:15:47 +00003355#define uptime_trivial_usage \
3356 ""
3357#define uptime_full_usage \
3358 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003359#define uptime_example_usage \
3360 "$ uptime\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003361 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003362
3363#define usleep_trivial_usage \
Tim Riker7b253f82003-12-28 05:02:40 +00003364 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003365#define usleep_full_usage \
3366 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003367#define usleep_example_usage \
3368 "$ usleep 1000000\n" \
3369 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003370
3371#define uudecode_trivial_usage \
3372 "[FILE]..."
3373#define uudecode_full_usage \
3374 "Uudecode a file that is uuencoded.\n\n" \
3375 "Options:\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003376 "\t-o FILE\tdirect output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003377#define uudecode_example_usage \
3378 "$ uudecode -o busybox busybox.uu\n" \
3379 "$ ls -l busybox\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003380 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003381
3382#define uuencode_trivial_usage \
3383 "[OPTION] [INFILE] REMOTEFILE"
3384#define uuencode_full_usage \
3385 "Uuencode a file.\n\n" \
3386 "Options:\n" \
Eric Andersenabec3442001-05-21 17:58:01 +00003387 "\t-m\tuse base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003388#define uuencode_example_usage \
3389 "$ uuencode busybox busybox\n" \
3390 "begin 755 busybox\n" \
3391 "<encoded file snipped>\n" \
3392 "$ uudecode busybox busybox > busybox.uu\n" \
3393 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003394
Eric Andersen853c4942003-01-23 05:59:32 +00003395#define vconfig_trivial_usage \
3396 "COMMAND [OPTIONS] ..."
Eric Andersen853c4942003-01-23 05:59:32 +00003397#define vconfig_full_usage \
Eric Andersen178de172004-04-06 16:36:20 +00003398 "vconfig lets you create and remove virtual ethernet devices.\n\n" \
3399 "Options:\n" \
3400 "\tadd [interface-name] [vlan_id]\n" \
3401 "\trem [vlan-name]\n" \
3402 "\tset_flag [interface-name] [flag-num] [0 | 1]\n" \
3403 "\tset_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3404 "\tset_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3405 "\tset_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00003406
Eric Andersen3f980402001-04-04 17:31:15 +00003407#define vi_trivial_usage \
3408 "[OPTION] [FILE]..."
3409#define vi_full_usage \
3410 "edit FILE.\n\n" \
3411 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003412 "\t-R\tRead-only- do not write to the file"
Eric Andersen3f980402001-04-04 17:31:15 +00003413
Eric Andersen27f64e12002-06-23 04:24:25 +00003414#define vlock_trivial_usage \
3415 "[OPTIONS]"
3416#define vlock_full_usage \
3417 "Lock a virtual terminal. A password is required to unlock\n" \
3418 "Options:\n" \
3419 "\t-a\tLock all VTs"
3420
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003421#define watch_trivial_usage \
3422 "[-n <seconds>] COMMAND..."
3423#define watch_full_usage \
3424 "Executes a program periodically.\n" \
3425 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003426 "\t-n\tLoop period in seconds - default is 2"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003427#define watch_example_usage \
3428 "$ watch date\n" \
3429 "Mon Dec 17 10:31:40 GMT 2000\n" \
3430 "Mon Dec 17 10:31:42 GMT 2000\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003431 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003432
Eric Andersen7e9276b2001-02-22 01:15:47 +00003433#define watchdog_trivial_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00003434 "[-t <seconds>] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003435#define watchdog_full_usage \
Eric Andersencde8f532003-07-22 07:39:18 +00003436 "Periodically write to watchdog device DEV.\n" \
3437 "Options:\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00003438 "\t-t\tTimer period in seconds - default is 30"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003439
3440#define wc_trivial_usage \
3441 "[OPTION]... [FILE]..."
3442#define wc_full_usage \
3443 "Print line, word, and byte counts for each FILE, and a total line if\n" \
3444 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
3445 "Options:\n" \
3446 "\t-c\tprint the byte counts\n" \
3447 "\t-l\tprint the newline counts\n" \
3448 "\t-L\tprint the length of the longest line\n" \
3449 "\t-w\tprint the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003450#define wc_example_usage \
3451 "$ wc /etc/passwd\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003452 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003453
3454#define wget_trivial_usage \
Eric Andersen178de172004-04-06 16:36:20 +00003455 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n" \
Eric Andersen15c03c32004-04-06 17:52:02 +00003456 "\t\t[--header 'header: value'] [-Y|--proxy on/off] [-P DIR] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003457#define wget_full_usage \
Eric Andersen79757c92001-04-05 21:45:54 +00003458 "wget retrieves files via HTTP or FTP\n\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003459 "Options:\n" \
3460 "\t-c\tcontinue retrieval of aborted transfers\n" \
Eric Andersen79757c92001-04-05 21:45:54 +00003461 "\t-q\tquiet mode - do not print\n" \
Eric Andersen8071c022001-06-21 19:45:06 +00003462 "\t-P\tSet directory prefix to DIR\n" \
Robert Griebld7760112002-05-14 23:36:45 +00003463 "\t-O\tsave to filename ('-' for stdout)\n" \
3464 "\t-Y\tuse proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003465
3466#define which_trivial_usage \
3467 "[COMMAND ...]"
3468#define which_full_usage \
3469 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003470#define which_example_usage \
3471 "$ which login\n" \
3472 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00003473
Eric Andersen00a6a752002-04-26 23:53:10 +00003474#define who_trivial_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003475 " "
Eric Andersen00a6a752002-04-26 23:53:10 +00003476#define who_full_usage \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003477 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003478
3479#define whoami_trivial_usage \
3480 ""
3481#define whoami_full_usage \
3482 "Prints the user name associated with the current effective user id."
3483
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003484#ifdef CONFIG_FEATURE_XARGS_SUPPORT_CONFIRMATION
3485#define USAGE_XARGS_CONFIRMATION(a) a
3486#else
3487#define USAGE_XARGS_CONFIRMATION(a)
3488#endif
3489#ifdef CONFIG_FEATURE_XARGS_SUPPORT_TERMOPT
3490#define USAGE_XARGS_TERMOPT(a) a
3491#else
3492#define USAGE_XARGS_TERMOPT(a)
3493#endif
3494#ifdef CONFIG_FEATURE_XARGS_SUPPORT_ZERO_TERM
3495#define USAGE_XARGS_ZERO_TERM(a) a
3496#else
3497#define USAGE_XARGS_ZERO_TERM(a)
3498#endif
3499
3500
Eric Andersen7e9276b2001-02-22 01:15:47 +00003501#define xargs_trivial_usage \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003502 "[COMMAND] [OPTIONS] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003503#define xargs_full_usage \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00003504 "Executes COMMAND on every item given by standard input.\n\n" \
3505 "Options:\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003506 USAGE_XARGS_CONFIRMATION("\t-p\tPrompt the user about whether to run each command\n") \
Glenn L McGrathf57674e2002-11-10 21:47:17 +00003507 "\t-r\tDo not run command for empty readed lines\n" \
Glenn L McGrathd12061b2003-10-10 23:15:23 +00003508 USAGE_XARGS_TERMOPT("\t-x\tExit if the size is exceeded\n") \
3509 USAGE_XARGS_ZERO_TERM("\t-0\tInput filenames are terminated by a null character\n") \
Mike Frysinger058e7402005-04-23 07:00:33 +00003510 "\t-t\tPrint the command line on stderr before executing it"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003511#define xargs_example_usage \
3512 "$ ls | xargs gzip\n" \
Tim Riker7b253f82003-12-28 05:02:40 +00003513 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003514
3515#define yes_trivial_usage \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003516 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003517#define yes_full_usage \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003518 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003519
Eric Andersen7e9276b2001-02-22 01:15:47 +00003520#define zcat_trivial_usage \
3521 "FILE"
3522#define zcat_full_usage \
3523 "Uncompress to stdout."
Eric Andersen178de172004-04-06 16:36:20 +00003524
Rob Landleyad8071f2005-04-30 03:49:37 +00003525#define zcip_trivial_usage \
3526 "[OPTIONS] ifname script"
3527#define zcip_full_usage \
3528 "zcip manages a ZeroConf IPv4 link-local address.\n" \
3529 "Options:\n" \
3530 "\t-f foreground mode\n" \
3531 "\t-q quit after address (no daemon)\n" \
3532 "\t-r 169.254.x.x request this address first\n" \
3533 "\t-v verbose; show version\n"
3534
Eric Andersen178de172004-04-06 16:36:20 +00003535#endif /* __BB_USAGE_H__ */