blob: 0e606609d32c5a225607d817cd9887a35f54cd79 [file] [log] [blame]
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001/* vi: set sw=8 ts=8: */
Denis Vlasenkoe2d3ded2006-11-27 23:43:28 +00002/*
3 * This file suffers from chronically incorrect tabification
4 * of messages. Before editing this file:
5 * 1. Switch you editor to 8-space tab mode.
6 * 2. Do not use \t in messages, use real tab character.
7 * 3. Start each source line with message as follows:
Denis Vlasenko1fffe382006-11-28 00:06:39 +00008 * |<7 spaces>"text with tabs"....
Denis Vlasenkocdf62772008-03-17 08:42:43 +00009 * or
10 * |<5 spaces>"\ntext with tabs"....
Denis Vlasenkoe2d3ded2006-11-27 23:43:28 +000011 */
12
Eric Andersen178de172004-04-06 16:36:20 +000013#ifndef __BB_USAGE_H__
14#define __BB_USAGE_H__
15
Denis Vlasenko4f98e192008-04-13 22:12:19 +000016
17#define NOUSAGE_STR "\b"
18
Denis Vlasenkod16950d2008-11-29 09:05:50 +000019#define acpid_trivial_usage \
20 "[-d] [-c CONFDIR] [-l LOGFILE] [-e PROC_EVENT_FILE] [EVDEV_EVENT_FILE...]"
21
22#define acpid_full_usage "\n\n" \
23 "Listen to ACPI events and spawn specific helpers on event arrival\n" \
24 "\nOptions:" \
25 "\n -d Do not daemonize and log to stderr" \
26 "\n -c DIR Config directory [/etc/acpi]" \
27 "\n -e FILE /proc event file [/proc/acpi/event]" \
28 "\n -l FILE Log file [/var/log/acpid]" \
29 USE_FEATURE_ACPID_COMPAT( \
30 "\n\nAccept and ignore compatibility options -g -m -s -S -v" \
31 )
32
33#define acpid_example_usage \
34 "# acpid -l /var/log/my-acpi-log\n" \
35 "# acpid -d /dev/input/event*\n"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000036
Eric Andersenf349e972001-08-21 16:18:59 +000037#define addgroup_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +000038 "[-g GID] " USE_FEATURE_ADDUSER_TO_GROUP("[user_name] ") "group_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000039#define addgroup_full_usage "\n\n" \
Denis Vlasenko73ac0562008-12-25 01:01:23 +000040 "Add a group " USE_FEATURE_ADDUSER_TO_GROUP("or add a user to a group") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000041 "\nOptions:" \
Denis Vlasenko4f98e192008-04-13 22:12:19 +000042 "\n -g GID Group id" \
Eric Andersenf349e972001-08-21 16:18:59 +000043
44#define adduser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000045 "[OPTIONS] user_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000046#define adduser_full_usage "\n\n" \
Denis Vlasenko73ac0562008-12-25 01:01:23 +000047 "Add a user\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000048 "\nOptions:" \
49 "\n -h DIR Home directory" \
50 "\n -g GECOS GECOS field" \
51 "\n -s SHELL Login shell" \
52 "\n -G GROUP Add user to existing group" \
53 "\n -S Create a system user" \
54 "\n -D Do not assign a password" \
55 "\n -H Do not create home directory" \
Eric Andersenf349e972001-08-21 16:18:59 +000056
Mark Whitley6f932772001-03-20 19:18:10 +000057#define adjtimex_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000058 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000059#define adjtimex_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000060 "Read and optionally set system timebase parameters. See adjtimex(2).\n" \
61 "\nOptions:" \
62 "\n -q Quiet" \
63 "\n -o offset Time offset, microseconds" \
64 "\n -f frequency Frequency adjust, integer kernel units (65536 is 1ppm)" \
65 "\n (positive values make clock run faster)" \
66 "\n -t tick Microseconds per tick, usually 10000" \
67 "\n -p timeconstant" \
Mark Whitley6f932772001-03-20 19:18:10 +000068
Eric Andersen7e9276b2001-02-22 01:15:47 +000069#define ar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000070 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000071#define ar_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000072 "Extract or list FILES from an ar archive\n" \
73 "\nOptions:" \
74 "\n -o Preserve original dates" \
75 "\n -p Extract to stdout" \
76 "\n -t List" \
77 "\n -x Extract" \
78 "\n -v Verbose" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000079
Denis Vlasenkofa85b862007-01-07 01:24:12 +000080#define arp_trivial_usage \
Denis Vlasenko4d476922008-11-13 00:05:17 +000081 "\n[-vn] [-H type] [-i if] -a [hostname]" \
82 "\n[-v] [-i if] -d hostname [pub]" \
83 "\n[-v] [-H type] [-i if] -s hostname hw_addr [temp]" \
84 "\n[-v] [-H type] [-i if] -s hostname hw_addr [netmask nm] pub" \
85 "\n[-v] [-H type] [-i if] -Ds hostname ifa [netmask nm] pub"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000086#define arp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000087 "Manipulate ARP cache\n" \
88 "\nOptions:" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000089 "\n -a Display (all) hosts" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000090 "\n -s Set new ARP entry" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000091 "\n -d Delete a specified entry" \
92 "\n -v Verbose" \
93 "\n -n Don't resolve names" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000094 "\n -i IF Network interface" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000095 "\n -D Read <hwaddr> from given device" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000096 "\n -A, -p AF Protocol family" \
Denis Vlasenko397de612008-03-17 08:55:44 +000097 "\n -H HWTYPE Hardware address type" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000098
Glenn L McGrath9e598412003-01-09 10:06:01 +000099#define arping_trivial_usage \
Denis Vlasenkof23c3f92007-11-23 09:27:05 +0000100 "[-fqbDUA] [-c count] [-w timeout] [-I dev] [-s sender] target"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000101#define arping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000102 "Send ARP requests/replies\n" \
103 "\nOptions:" \
104 "\n -f Quit on first ARP reply" \
105 "\n -q Quiet" \
106 "\n -b Keep broadcasting, don't go unicast" \
107 "\n -D Duplicated address detection mode" \
108 "\n -U Unsolicited ARP mode, update your neighbors" \
109 "\n -A ARP answer mode, update your neighbors" \
110 "\n -c N Stop after sending N ARP requests" \
111 "\n -w timeout Time to wait for ARP reply, in seconds" \
112 "\n -I dev Interface to use (default eth0)" \
113 "\n -s sender Sender IP address" \
114 "\n target Target IP address" \
Glenn L McGrath9e598412003-01-09 10:06:01 +0000115
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000116#define sh_trivial_usage NOUSAGE_STR
117#define sh_full_usage ""
118#define ash_trivial_usage NOUSAGE_STR
119#define ash_full_usage ""
120#define hush_trivial_usage NOUSAGE_STR
121#define hush_full_usage ""
122#define msh_trivial_usage NOUSAGE_STR
123#define msh_full_usage ""
Eric Andersen08f59e32004-03-12 22:07:10 +0000124
125#define awk_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000126 "[OPTION]... [program-text] [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000127#define awk_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000128 "Options:" \
129 "\n -v var=val Set variable" \
130 "\n -F sep Use sep as field separator" \
131 "\n -f file Read program from file" \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +0000132
Eric Andersen7e9276b2001-02-22 01:15:47 +0000133#define basename_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000134 "FILE [SUFFIX]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000135#define basename_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000136 "Strip directory path and suffixes from FILE.\n" \
137 "If specified, also remove any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000138#define basename_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000139 "$ basename /usr/local/bin/foo\n" \
140 "foo\n" \
141 "$ basename /usr/local/bin/\n" \
142 "bin\n" \
143 "$ basename /foo/bar.txt .txt\n" \
144 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000145
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000146#define fbsplash_trivial_usage \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000147 "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000148#define fbsplash_full_usage "\n\n" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000149 "Options:\n" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000150 "\n -s Image" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000151 "\n -c Hide cursor" \
152 "\n -d Framebuffer device (default /dev/fb0)" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000153 "\n -i Config file (var=value):" \
154 "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT" \
155 "\n BAR_R,BAR_G,BAR_B" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000156 "\n -f Control pipe (else exit after drawing image)" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000157 "\n commands: 'NN' (% for progress bar) or 'exit'" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000158
Bernhard Reutner-Fischerd27d9252008-01-13 15:23:27 +0000159#define brctl_trivial_usage \
160 "COMMAND [BRIDGE [INTERFACE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000161#define brctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000162 "Manage ethernet bridges.\n" \
163 "\nCommands:" \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000164 USE_FEATURE_BRCTL_SHOW( \
165 "\n show Show a list of bridges" \
166 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000167 "\n addbr BRIDGE Create BRIDGE" \
168 "\n delbr BRIDGE Delete BRIDGE" \
169 "\n addif BRIDGE IFACE Add IFACE to BRIDGE" \
170 "\n delif BRIDGE IFACE Delete IFACE from BRIDGE" \
171 USE_FEATURE_BRCTL_FANCY( \
172 "\n setageing BRIDGE TIME Set ageing time" \
173 "\n setfd BRIDGE TIME Set bridge forward delay" \
174 "\n sethello BRIDGE TIME Set hello time" \
175 "\n setmaxage BRIDGE TIME Set max message age" \
176 "\n setpathcost BRIDGE COST Set path cost" \
177 "\n setportprio BRIDGE PRIO Set port priority" \
178 "\n setbridgeprio BRIDGE PRIO Set bridge priority" \
179 "\n stp BRIDGE [1|0] STP on/off" \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000180 ) \
181
Glenn L McGrath24e28332001-10-05 03:48:57 +0000182#define bunzip2_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000183 "[OPTION]... [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000184#define bunzip2_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000185 "Uncompress FILE (or standard input if FILE is '-' or omitted)\n" \
186 "\nOptions:" \
187 "\n -c Write to standard output" \
188 "\n -f Force" \
Glenn L McGrath24e28332001-10-05 03:48:57 +0000189
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000190#define bzip2_trivial_usage \
191 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000192#define bzip2_full_usage "\n\n" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000193 "Compress FILE(s) with bzip2 algorithm.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000194 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n" \
195 "\nOptions:" \
196 "\n -c Write to standard output" \
197 "\n -d Decompress" \
198 "\n -f Force" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000199 "\n -1..-9 Compression level" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000200
Rob Landley6130b9b2006-01-23 21:10:38 +0000201#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000202 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000203
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000204#define bzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000205 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000206#define bzcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000207 "Uncompress to stdout"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000208
Rob Landleyc1d69902006-01-20 18:28:50 +0000209#define unlzma_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000210 "[OPTION]... [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000211#define unlzma_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000212 "Uncompress FILE (or standard input if FILE is '-' or omitted)\n" \
213 "\nOptions:" \
214 "\n -c Write to standard output" \
215 "\n -f Force" \
Rob Landleyc1d69902006-01-20 18:28:50 +0000216
217#define lzmacat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000218 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000219#define lzmacat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000220 "Uncompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000221
Eric Andersenc98c0622001-12-06 15:16:43 +0000222#define cal_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000223 "[-jy] [[month] year]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000224#define cal_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000225 "Display a calendar\n" \
226 "\nOptions:" \
227 "\n -j Use julian dates" \
228 "\n -y Display the entire year" \
Eric Andersenc98c0622001-12-06 15:16:43 +0000229
Eric Andersen7e9276b2001-02-22 01:15:47 +0000230#define cat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000231 "[-u] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000232#define cat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000233 "Concatenate FILE(s) and print them to stdout\n" \
234 "\nOptions:" \
235 "\n -u Use unbuffered i/o (ignored)" \
236
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000237#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000238 "$ cat /proc/uptime\n" \
239 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000240
Rob Landley8abbee42006-05-31 19:36:04 +0000241#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000242 "[-etv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000243#define catv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000244 "Display nonprinting characters as ^x or M-x\n" \
245 "\nOptions:" \
246 "\n -e End each line with $" \
247 "\n -t Show tabs as ^I" \
248 "\n -v Don't use ^x or M-x escapes" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000249
250#define chat_trivial_usage \
251 "EXPECT [SEND [EXPECT [SEND...]]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000252#define chat_full_usage "\n\n" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000253 "Useful for interacting with a modem connected to stdin/stdout.\n" \
254 "A script consists of one or more \"expect-send\" pairs of strings,\n" \
255 "each pair is a pair of arguments. Example:\n" \
256 "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \
257
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000258#define chattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000259 "[-R] [-+=AacDdijsStTu] [-v version] files..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000260#define chattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000261 "Change file attributes on an ext2 fs\n" \
262 "\nModifiers:" \
263 "\n - Remove attributes" \
264 "\n + Add attributes" \
265 "\n = Set attributes" \
266 "\nAttributes:" \
267 "\n A Don't track atime" \
268 "\n a Append mode only" \
269 "\n c Enable compress" \
270 "\n D Write dir contents synchronously" \
271 "\n d Do not backup with dump" \
272 "\n i Cannot be modified (immutable)" \
273 "\n j Write all data to journal first" \
274 "\n s Zero disk storage when deleted" \
275 "\n S Write file contents synchronously" \
276 "\n t Disable tail-merging of partial blocks with other files" \
277 "\n u Allow file to be undeleted" \
278 "\nOptions:" \
279 "\n -R Recursively list subdirectories" \
280 "\n -v Set the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000281
Denis Vlasenko49622d72007-03-10 16:58:49 +0000282#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000283 "[OPTIONS] CONTEXT FILE..." \
284 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
285 USE_FEATURE_CHCON_LONG_OPTIONS( \
286 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
287 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000288#define chcon_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000289 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000290 USE_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000291 "\n -v,--verbose Verbose" \
292 "\n -c,--changes Report changes made" \
293 "\n -h,--no-dereference Affect symlinks instead of their targets" \
294 "\n -f,--silent,--quiet Suppress most error messages" \
295 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
296 "\n -u,--user=USER Set user/role/type/range in the target" \
297 "\n -r,--role=ROLE security context" \
298 "\n -t,--type=TYPE" \
299 "\n -l,--range=RANGE" \
300 "\n -R,--recursive Recurse subdirectories" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000301 ) \
302 SKIP_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000303 "\n -v Verbose" \
304 "\n -c Report changes made" \
305 "\n -h Affect symlinks instead of their targets" \
306 "\n -f Suppress most error messages" \
307 "\n -u USER Set user/role/type/range in the target security context" \
308 "\n -r ROLE" \
309 "\n -t TYPE" \
310 "\n -l RNG" \
311 "\n -R Recurse subdirectories" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000312 )
313
Eric Andersen7e9276b2001-02-22 01:15:47 +0000314#define chmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000315 "[-R"USE_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000316#define chmod_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000317 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000318 "symbols +-= and one or more of the letters rwxst\n" \
319 "\nOptions:" \
320 "\n -R Recurse directories" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000321 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000322 "\n -c List changed files" \
323 "\n -v List all files" \
324 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000325 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000326#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000327 "$ ls -l /tmp/foo\n" \
328 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
329 "$ chmod u+x /tmp/foo\n" \
330 "$ ls -l /tmp/foo\n" \
331 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
332 "$ chmod 444 /tmp/foo\n" \
333 "$ ls -l /tmp/foo\n" \
334 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000335
Denis Vlasenko081ef792007-03-17 16:38:21 +0000336#define chgrp_trivial_usage \
337 "[-RhLHP"USE_DESKTOP("cvf")"]... GROUP FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000338#define chgrp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000339 "Change the group membership of each FILE to GROUP\n" \
340 "\nOptions:" \
341 "\n -R Recurse directories" \
342 "\n -h Affect symlinks instead of symlink targets" \
343 "\n -L Traverse all symlinks to directories" \
344 "\n -H Traverse symlinks on command line only" \
345 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000346 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000347 "\n -c List changed files" \
348 "\n -v Verbose" \
349 "\n -f Hide errors" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000350 )
351#define chgrp_example_usage \
352 "$ ls -l /tmp/foo\n" \
353 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
354 "$ chgrp root /tmp/foo\n" \
355 "$ ls -l /tmp/foo\n" \
356 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
357
Eric Andersen7e9276b2001-02-22 01:15:47 +0000358#define chown_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000359 "[-RhLHP"USE_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000360#define chown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000361 "Change the owner and/or group of each FILE to OWNER and/or GROUP\n" \
362 "\nOptions:" \
363 "\n -R Recurse directories" \
364 "\n -h Affect symlinks instead of symlink targets" \
365 "\n -L Traverse all symlinks to directories" \
366 "\n -H Traverse symlinks on command line only" \
367 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000368 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000369 "\n -c List changed files" \
370 "\n -v List all files" \
371 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000372 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000373#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000374 "$ ls -l /tmp/foo\n" \
375 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
376 "$ chown root /tmp/foo\n" \
377 "$ ls -l /tmp/foo\n" \
378 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
379 "$ chown root.root /tmp/foo\n" \
380 "ls -l /tmp/foo\n" \
381 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000382
Denis Vlasenkofe544582006-10-03 15:57:40 +0000383#define chpst_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000384 "[-vP012] [-u USER[:GRP]] [-U USER[:GRP]] [-e DIR]\n" \
385 " [-/ DIR] [-n NICE] [-m BYTES] [-d BYTES] [-o N]\n" \
386 " [-p N] [-f BYTES] [-c BYTES] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000387#define chpst_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000388 "Change the process state and run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000389 "\nOptions:" \
390 "\n -u USER[:GRP] Set uid and gid" \
391 "\n -U USER[:GRP] Set $UID and $GID in environment" \
392 "\n -e DIR Set environment variables as specified by files" \
393 "\n in DIR: file=1st_line_of_file" \
394 "\n -/ DIR Chroot to DIR" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000395 "\n -n NICE Add NICE to nice value" \
396 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000397 "\n -d BYTES Limit data segment" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000398 "\n -o N Limit number of open files per process" \
399 "\n -p N Limit number of processes per uid" \
400 "\n -f BYTES Limit output file sizes" \
401 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000402 "\n -v Verbose" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000403 "\n -P Create new process group" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000404 "\n -0 Close standard input" \
405 "\n -1 Close standard output" \
406 "\n -2 Close standard error" \
407
Denis Vlasenkofe544582006-10-03 15:57:40 +0000408#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000409 "account prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000410#define setuidgid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000411 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000412 "groups and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000413#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000414 "account prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000415#define envuidgid_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000416 "Set $UID to account's uid and $GID to account's gid and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000417#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000418 "dir prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000419#define envdir_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000420 "Set various environment variables as specified by files\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000421 "in the directory dir and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000422#define softlimit_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000423 "[-a BYTES] [-m BYTES] [-d BYTES] [-s BYTES] [-l BYTES]\n" \
424 " [-f BYTES] [-c BYTES] [-r BYTES] [-o N] [-p N] [-t N]\n" \
425 " PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000426#define softlimit_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000427 "Set soft resource limits, then run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000428 "\nOptions:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000429 "\n -a BYTES Limit total size of all segments" \
430 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES -a BYTES" \
431 "\n -d BYTES Limit data segment" \
432 "\n -s BYTES Limit stack segment" \
433 "\n -l BYTES Limit locked memory size" \
434 "\n -o N Limit number of open files per process" \
435 "\n -p N Limit number of processes per uid" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000436 "\nOptions controlling file sizes:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000437 "\n -f BYTES Limit output file sizes" \
438 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000439 "\nEfficiency opts:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000440 "\n -r BYTES Limit resident set size" \
441 "\n -t N Limit CPU time, process receives" \
442 "\n a SIGXCPU after N seconds" \
Denis Vlasenkofe544582006-10-03 15:57:40 +0000443
Eric Andersen7e9276b2001-02-22 01:15:47 +0000444#define chroot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000445 "NEWROOT [COMMAND...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000446#define chroot_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000447 "Run COMMAND with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000448#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000449 "$ ls -l /bin/ls\n" \
450 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
451 "# mount /dev/hdc1 /mnt -t minix\n" \
452 "# chroot /mnt\n" \
453 "# ls -l /bin/ls\n" \
454 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000455
Eric Andersen7e9276b2001-02-22 01:15:47 +0000456#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000457 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000458#define chvt_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000459 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000460
Rob Landley856489b2006-04-18 20:57:28 +0000461#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000462 "FILES..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000463#define cksum_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000464 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000465
Eric Andersen7e9276b2001-02-22 01:15:47 +0000466#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000467 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000468#define clear_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000469 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000470
Eric Andersen7e9276b2001-02-22 01:15:47 +0000471#define cmp_trivial_usage \
Denis Vlasenko9a1fa8c2007-03-21 22:30:14 +0000472 "[-l] [-s] FILE1 [FILE2" USE_DESKTOP(" [SKIP1 [SKIP2]") "]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000473#define cmp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000474 "Compares FILE1 vs stdin if FILE2 is not specified\n" \
475 "\nOptions:" \
476 "\n -l Write the byte numbers (decimal) and values (octal)" \
477 "\n for all differing bytes" \
478 "\n -s Quiet" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000479
Rob Landley2acfd7b2005-05-11 23:12:49 +0000480#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000481 "[-123] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000482#define comm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000483 "Compare FILE1 to FILE2, or to stdin if - is specified\n" \
484 "\nOptions:" \
485 "\n -1 Suppress lines unique to FILE1" \
486 "\n -2 Suppress lines unique to FILE2" \
487 "\n -3 Suppress lines common to both files" \
Rob Landley2acfd7b2005-05-11 23:12:49 +0000488
Paul Fox79c142d2005-08-01 16:04:40 +0000489#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000490 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000491#define bbconfig_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000492 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000493
Rob Landley69674942006-09-11 00:34:01 +0000494#define bbsh_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000495 "[FILE]...\n" \
496 "or: bbsh -c command [args]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000497#define bbsh_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000498 "The bbsh shell (command interpreter)"
Rob Landley69674942006-09-11 00:34:01 +0000499
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000500#define chrt_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000501 "[OPTION]... [prio] [pid | command [arg]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000502#define chrt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000503 "Manipulate real-time attributes of a process\n" \
504 "\nOptions:" \
505 "\n -p Operate on pid" \
506 "\n -r Set scheduling policy to SCHED_RR" \
507 "\n -f Set scheduling policy to SCHED_FIFO" \
508 "\n -o Set scheduling policy to SCHED_OTHER" \
509 "\n -m Show min and max priorities" \
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000510
511#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000512 "$ chrt -r 4 sleep 900; x=$!\n" \
513 "$ chrt -f -p 3 $x\n" \
514 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000515
Eric Andersen7e9276b2001-02-22 01:15:47 +0000516#define cp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000517 "[OPTION]... SOURCE DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000518#define cp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000519 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY\n" \
520 "\nOptions:" \
521 "\n -a Same as -dpR" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000522 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000523 "\n -c Preserve security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000524 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000525 "\n -d,-P Preserve links" \
526 "\n -H,-L Dereference all symlinks (default)" \
527 "\n -p Preserve file attributes if possible" \
528 "\n -f Force overwrite" \
529 "\n -i Prompt before overwrite" \
530 "\n -R,-r Recurse directories" \
531 "\n -l,-s Create (sym)links" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000532
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000533#define cpio_trivial_usage \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000534 "-[dim" USE_FEATURE_CPIO_O("o") "tuv][F cpiofile]" \
Denis Vlasenko1f228982008-04-22 00:16:29 +0000535 USE_FEATURE_CPIO_O( "[H newc]" )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000536#define cpio_full_usage "\n\n" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000537 "Extract or list files from a cpio archive" \
538 USE_FEATURE_CPIO_O( ", or create a cpio archive" ) \
539 "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000540 "Main operation mode:" \
541 "\n d Make leading directories" \
542 "\n i Extract" \
543 "\n m Preserve mtime" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000544 USE_FEATURE_CPIO_O( \
545 "\n o Create" \
546 "\n H newc Define format" \
547 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000548 "\n t List" \
549 "\n v Verbose" \
550 "\n u Unconditional overwrite" \
551 "\n F Input from file" \
Tim Riker7b253f82003-12-28 05:02:40 +0000552
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000553#define crond_trivial_usage \
Denis Vlasenko35a064b2008-11-06 00:49:59 +0000554 "-fbS -l N " USE_FEATURE_CROND_D("-d N ") "-L LOGFILE -c DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000555#define crond_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000556 " -f Foreground" \
557 "\n -b Background (default)" \
558 "\n -S Log to syslog (default)" \
559 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +0000560 USE_FEATURE_CROND_D( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000561 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000562 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000563 "\n -L Log to file" \
564 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000565
566#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000567 "[-c DIR] [-u USER] [-ler]|[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000568#define crontab_full_usage "\n\n" \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000569 " -c Crontab directory" \
570 "\n -u User" \
571 "\n -l List crontab" \
572 "\n -e Edit crontab" \
573 "\n -r Delete crontab" \
574 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000575
Denis Vlasenko2211d522008-11-10 18:52:35 +0000576#define cryptpw_trivial_usage \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000577 "[OPTIONS] [PASSWORD] [SALT]"
578/* We do support -s, we just don't mention it */
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000579#define cryptpw_full_usage "\n\n" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000580 "Crypt the PASSWORD using crypt(3)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000581 "\nOptions:" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000582 USE_GETOPT_LONG( \
583 "\n -P,--password-fd=NUM Read password from fd NUM" \
584/* "\n -s,--stdin Use stdin; like -P0" */ \
585 "\n -m,--method=TYPE Encryption method TYPE" \
586 "\n -S,--salt=SALT" \
587 ) \
588 SKIP_GETOPT_LONG( \
589 "\n -P NUM Read password from fd NUM" \
590/* "\n -s Use stdin; like -P0" */ \
591 "\n -m TYPE Encryption method TYPE" \
592 "\n -S SALT" \
593 ) \
594
595/* mkpasswd is an alias to cryptpw */
596
597#define mkpasswd_trivial_usage \
598 "[OPTIONS] [PASSWORD] [SALT]"
599/* We do support -s, we just don't mention it */
600#define mkpasswd_full_usage "\n\n" \
601 "Crypt the PASSWORD using crypt(3)\n" \
602 "\nOptions:" \
603 USE_GETOPT_LONG( \
604 "\n -P,--password-fd=NUM Read password from fd NUM" \
605/* "\n -s,--stdin Use stdin; like -P0" */ \
606 "\n -m,--method=TYPE Encryption method TYPE" \
607 "\n -S,--salt=SALT" \
608 ) \
609 SKIP_GETOPT_LONG( \
610 "\n -P NUM Read password from fd NUM" \
611/* "\n -s Use stdin; like -P0" */ \
612 "\n -m TYPE Encryption method TYPE" \
613 "\n -S SALT" \
614 ) \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000615
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000616#define cttyhack_trivial_usage NOUSAGE_STR
617#define cttyhack_full_usage ""
618
Eric Andersen7e9276b2001-02-22 01:15:47 +0000619#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000620 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000621#define cut_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000622 "Print selected fields from each input FILE to standard output\n" \
623 "\nOptions:" \
624 "\n -b LIST Output only bytes from LIST" \
625 "\n -c LIST Output only characters from LIST" \
626 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
627 "\n -s Output only the lines containing delimiter" \
628 "\n -f N Print only these fields" \
629 "\n -n Ignored" \
630
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000631#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000632 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
633 "Hello\n" \
634 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
635 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000636
Eric Andersen7e9276b2001-02-22 01:15:47 +0000637#define date_trivial_usage \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000638 "[OPTION]... [+FMT] [TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000639#define date_full_usage "\n\n" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000640 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000641 "\nOptions:" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000642 "\n -u Work in UTC (don't convert to local time)" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000643 "\n -R Output RFC-822 compliant date string" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000644 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000645 "\n -I[SPEC] Output ISO-8601 compliant date string" \
646 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000647 "\n 'hours', 'minutes', or 'seconds' for date and" \
648 "\n time to the indicated precision" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000649 ) \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000650 "\n -d TIME Display TIME, not 'now'" \
651 "\n -r FILE Display last modification time of FILE" \
652 "\n [-s] TIME Set time to TIME" \
653 USE_FEATURE_DATE_ISOFMT( \
654 "\n -D FMT Use FMT for str->date conversion" \
655 ) \
656 "\n" \
657 "\nRecognized formats for TIME:" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000658 "\n hh:mm[:ss]" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000659 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000660 "\n YYYY-MM-DD hh:mm[:ss]" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000661 "\n MMDDhhmm[[YY]YY][.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000662
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000663#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000664 "$ date\n" \
665 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000666
Eric Andersen7e9276b2001-02-22 01:15:47 +0000667#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000668 "expression..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000669#define dc_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +0000670 "Tiny RPN calculator. Operations:\n" \
671 "+, add, -, sub, *, mul, /, div, %, mod, **, exp, and, or, not, eor,\n" \
672 "p - print top of the stack (without altering the stack),\n" \
673 "f - print entire stack, o - pop the value and set output radix\n" \
674 "(value must be 10 or 16).\n" \
675 "Examples: 'dc 2 2 add' -> 4, 'dc 8 8 * 2 2 + /' -> 16.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000676
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000677#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000678 "$ dc 2 2 + p\n" \
679 "4\n" \
680 "$ dc 8 8 \\* 2 2 + / p\n" \
681 "16\n" \
682 "$ dc 0 1 and p\n" \
683 "0\n" \
684 "$ dc 0 1 or p\n" \
685 "1\n" \
686 "$ echo 72 9 div 8 mul p | dc\n" \
687 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000688
Eric Andersen7e9276b2001-02-22 01:15:47 +0000689#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000690 "[if=FILE] [of=FILE] " USE_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000691 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000692#define dd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000693 "Copy a file with converting and formatting\n" \
694 "\nOptions:" \
695 "\n if=FILE Read from FILE instead of stdin" \
696 "\n of=FILE Write to FILE instead of stdout" \
697 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000698 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000699 "\n ibs=N Read N bytes at a time" \
700 ) \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000701 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000702 "\n obs=N Write N bytes at a time" \
703 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000704 "\n count=N Copy only N input blocks" \
705 "\n skip=N Skip N input blocks" \
706 "\n seek=N Skip N output blocks" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000707 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000708 "\n conv=notrunc Don't truncate output file" \
709 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000710 "\n conv=sync Pad blocks with zeros" \
711 "\n conv=fsync Physically write data out before finishing" \
712 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000713 "\n" \
714 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
715 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
716
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000717#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000718 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
719 "4+0 records in\n" \
720 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000721
Eric Andersen7e9276b2001-02-22 01:15:47 +0000722#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000723 "[N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000724#define deallocvt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000725 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000726
Eric Andersenf349e972001-08-21 16:18:59 +0000727#define delgroup_trivial_usage \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000728 USE_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000729#define delgroup_full_usage "\n\n" \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000730 "Delete group GROUP from the system" \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000731 USE_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000732
733#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000734 "USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000735#define deluser_full_usage "\n\n" \
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000736 "Delete USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000737
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000738#define depmod_trivial_usage NOUSAGE_STR
739#define depmod_full_usage ""
Bernhard Reutner-Fischer55e547e2008-05-26 12:01:49 +0000740
Denis Vlasenkoc94fa562008-10-26 11:08:14 +0000741#define devmem_trivial_usage \
742 "ADDRESS [WIDTH [VALUE]]"
743
744#define devmem_full_usage "\n\n" \
745 "Read/write from physical address\n" \
746 "\n ADDRESS Address to act upon" \
747 "\n WIDTH Width (8/16/...)" \
748 "\n VALUE Data to be written" \
749
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000750#define devfsd_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000751 "mntpnt [-v]" USE_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000752#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000753 "Manage devfs permissions and old device name symlinks\n" \
754 "\nOptions:" \
755 "\n mntpnt The mount point where devfs is mounted" \
756 "\n -v Print the protocol version numbers for devfsd" \
757 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000758 USE_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000759 "\n -fg Run in foreground" \
760 "\n -np Exit after parsing the configuration file" \
761 "\n and processing synthetic REGISTER events," \
762 "\n do not poll for events" \
763 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000764
Eric Andersen7e9276b2001-02-22 01:15:47 +0000765#define df_trivial_usage \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000766 "[-Pk" \
767 USE_FEATURE_HUMAN_READABLE("mh") \
768 USE_FEATURE_DF_FANCY("ai] [-B SIZE") \
769 "] [FILESYSTEM...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000770#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000771 "Print filesystem usage statistics\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000772 "\nOptions:" \
773 "\n -P POSIX output format" \
774 "\n -k 1024-byte blocks (default)" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000775 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000776 "\n -m 1M-byte blocks" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000777 "\n -h Human readable (e.g. 1K 243M 2G)" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000778 ) \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000779 USE_FEATURE_DF_FANCY( \
780 "\n -a Show all filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000781 "\n -i Inodes" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000782 "\n -B SIZE Blocksize" \
783 ) \
784
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000785#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000786 "$ df\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000787 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000788 "/dev/sda3 8690864 8553540 137324 98% /\n" \
789 "/dev/sda1 64216 36364 27852 57% /boot\n" \
790 "$ df /dev/sda3\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000791 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
792 "/dev/sda3 8690864 8553540 137324 98% /\n" \
793 "$ POSIXLY_CORRECT=sure df /dev/sda3\n" \
794 "Filesystem 512B-blocks Used Available Use% Mounted on\n" \
795 "/dev/sda3 17381728 17107080 274648 98% /\n" \
796 "$ POSIXLY_CORRECT=yep df -P /dev/sda3\n" \
797 "Filesystem 512-blocks Used Available Capacity Mounted on\n" \
798 "/dev/sda3 17381728 17107080 274648 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000799
Denis Vlasenko736230e2006-11-20 19:40:36 +0000800#define dhcprelay_trivial_usage \
Bernhard Reutner-Fischer55fb9da2008-05-27 12:42:39 +0000801 "[client1,client2,...] [server_device]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000802#define dhcprelay_full_usage "\n\n" \
Bernhard Reutner-Fischer55fb9da2008-05-27 12:42:39 +0000803 "Relay dhcp requests from client devices to server device.\n" \
804 "Pass clients as CSV"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000805
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000806#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000807 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000808#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000809 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000810 "This implementation supports unified diffs only.\n" \
811 "\nOptions:" \
812 "\n -a Treat all files as text" \
813 "\n -b Ignore changes in the amount of whitespace" \
814 "\n -d Try hard to find a smaller set of changes" \
815 "\n -i Ignore case differences" \
816 "\n -L Use LABEL instead of the filename in the unified header" \
817 "\n -N Treat absent files as empty" \
818 "\n -q Output only whether files differ" \
819 "\n -r Recursively compare subdirectories" \
820 "\n -S Start with FILE when comparing directories" \
821 "\n -T Make tabs line up by prefixing a tab when necessary" \
822 "\n -s Report when two files are the same" \
823 "\n -t Expand tabs to spaces in output" \
824 "\n -U Output LINES lines of context" \
825 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000826
Eric Andersen7e9276b2001-02-22 01:15:47 +0000827#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000828 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000829#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000830 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000831#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000832 "$ dirname /tmp/foo\n" \
833 "/tmp\n" \
834 "$ dirname /tmp/foo/\n" \
835 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000836
Eric Andersen7e9276b2001-02-22 01:15:47 +0000837#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000838 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000839#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000840 "Print or control the kernel ring buffer\n" \
841 "\nOptions:" \
842 "\n -c Clear ring buffer after printing" \
843 "\n -n LEVEL Set console logging level" \
844 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000845
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000846#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000847 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000848#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000849 "Small static DNS server daemon\n" \
850 "\nOptions:" \
851 "\n -c Config filename" \
852 "\n -t TTL in seconds" \
853 "\n -p Listening port" \
854 "\n -i Listening ip (default all)" \
855 "\n -d Daemonize" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000856
Eric Andersen7e9276b2001-02-22 01:15:47 +0000857#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000858 "[option] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000859#define dos2unix_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000860 "Convert FILE from dos to unix format.\n" \
861 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000862 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000863 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000864 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000865
Eric Andersen7e9276b2001-02-22 01:15:47 +0000866#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000867 "[-ilCPru] [-F option] package_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000868#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000869 "Install, remove and manage Debian packages\n" \
870 "\nOptions:" \
871 "\n -i Install the package" \
872 "\n -l List of installed packages" \
873 "\n -C Configure an unpackaged package" \
874 "\n -F depends Ignore dependency problems" \
875 "\n -P Purge all files of a package" \
876 "\n -r Remove all but the configuration files for a package" \
877 "\n -u Unpack a package, but don't configure it" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000878
Eric Andersen7e9276b2001-02-22 01:15:47 +0000879#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000880 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000881#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000882 "Perform actions on Debian packages (.debs)\n" \
883 "\nOptions:" \
884 "\n -c List contents of filesystem tree" \
885 "\n -e Extract control files to [argument] directory" \
886 "\n -f Display control field name starting with [argument]" \
887 "\n -x Extract packages filesystem tree to directory" \
888 "\n -X Verbose extract" \
889
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000890#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000891 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000892
Eric Andersen7e9276b2001-02-22 01:15:47 +0000893#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000894 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000895#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000896 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000897 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000898 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
899 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000900 " bytes.\n" \
901 "\nOptions:" \
902 "\n -a Show file sizes too" \
903 "\n -H Follow symlinks on command line" \
904 "\n -L Follow all symlinks" \
905 "\n -d N Limit output to directories (and files with -a) of depth < N" \
906 "\n -c Show grand total" \
907 "\n -l Count sizes many times if hard linked" \
908 "\n -s Display only a total for each argument" \
909 "\n -x Skip directories on different filesystems" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000910 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000911 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
912 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000913 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000914 "\n -k Sizes in kilobytes" \
915 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
916
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000917#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000918 "$ du\n" \
919 "16 ./CVS\n" \
920 "12 ./kernel-patches/CVS\n" \
921 "80 ./kernel-patches\n" \
922 "12 ./tests/CVS\n" \
923 "36 ./tests\n" \
924 "12 ./scripts/CVS\n" \
925 "16 ./scripts\n" \
926 "12 ./docs/CVS\n" \
927 "104 ./docs\n" \
928 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000929
Eric Andersen7e9276b2001-02-22 01:15:47 +0000930#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000931 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000932#define dumpkmap_full_usage "\n\n" \
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000933 "Print a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000934#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000935 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000936
Russ Dill61fb4892002-10-14 21:41:28 +0000937#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000938 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000939#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000940 "Display DHCP leases granted by udhcpd\n" \
941 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000942 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000943 "\n -f,--file=FILE Leases file to load" \
944 "\n -r,--remaining Interpret lease times as time remaining" \
945 "\n -a,--absolute Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000946 ) \
947 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000948 "\n -f FILE Leases file to load" \
949 "\n -r Interpret lease times as time remaining" \
950 "\n -a Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000951 )
Russ Dill61fb4892002-10-14 21:41:28 +0000952
Mike Frysinger51a43b42005-09-24 07:11:16 +0000953#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000954 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
955 "[-I inode_buffer_blocks] [-P process_inode_size] " \
956 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
957 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000958#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000959 "Check ext2/ext3 file system\n" \
960 "\nOptions:" \
961 "\n -p Automatic repair (no questions)" \
962 "\n -n Make no changes to the filesystem" \
963 "\n -y Assume 'yes' to all questions" \
964 "\n -c Check for bad blocks and add them to the badblock list" \
965 "\n -f Force checking even if filesystem is marked clean" \
966 "\n -v Verbose" \
967 "\n -b superblock Use alternative superblock" \
968 "\n -B blocksize Force blocksize when looking for superblock" \
969 "\n -j journal Set location of the external journal" \
970 "\n -l file Add to badblocks list" \
971 "\n -L file Set badblocks list" \
Mike Frysinger51a43b42005-09-24 07:11:16 +0000972
Eric Andersen7e9276b2001-02-22 01:15:47 +0000973#define echo_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000974 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000975#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000976 "Print the specified ARGs to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000977 USE_FEATURE_FANCY_ECHO( "\n" \
978 "\nOptions:" \
979 "\n -n Suppress trailing newline" \
980 "\n -e Interpret backslash-escaped characters (i.e., \\t=tab)" \
981 "\n -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000982 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000983#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000984 "$ echo \"Erik is cool\"\n" \
985 "Erik is cool\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000986 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000987 "Erik\n" \
988 "is\n" \
989 "cool\n" \
990 "$ echo \"Erik\\nis\\ncool\"\n" \
991 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000992
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000993#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000994 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000995#define eject_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000996 "Eject specified DEVICE (or default /dev/cdrom)\n" \
997 "\nOptions:" \
998 USE_FEATURE_EJECT_SCSI( \
999 "\n -s SCSI device" \
1000 ) \
1001 "\n -t Close tray" \
1002 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001003
Rob Landley3b890392006-05-04 20:56:43 +00001004#define ed_trivial_usage ""
1005#define ed_full_usage ""
1006
Eric Andersen84e229c2001-03-29 22:48:33 +00001007#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001008 "[-iu] [-] [name=value]... [command]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001009#define env_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001010 "Print the current environment or run a program after setting\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001011 "up the specified environment\n" \
1012 "\nOptions:" \
1013 "\n -, -i Start with an empty environment" \
1014 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +00001015
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001016#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001017 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001018#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001019 "Send a magic packet to wake up sleeping machines.\n" \
1020 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001021 "a hostname with a known 'ethers' entry.\n" \
1022 "\nOptions:" \
1023 "\n -b Send wake-up packet to the broadcast address" \
1024 "\n -i iface Interface to use (default eth0)" \
1025 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001026
Denis Vlasenko3952f202007-08-13 14:10:24 +00001027#define expand_trivial_usage \
1028 "[-i] [-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001029#define expand_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001030 "Convert tabs to spaces, writing to standard output.\n" \
1031 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001032 USE_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001033 "\n -i,--initial Do not convert tabs after non blanks" \
1034 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001035 ) \
1036 SKIP_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001037 "\n -i Do not convert tabs after non blanks" \
1038 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001039 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00001040
Eric Andersen7e9276b2001-02-22 01:15:47 +00001041#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001042 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001043#define expr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001044 "Print the value of EXPRESSION to standard output.\n" \
1045 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001046 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001047 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
1048 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1049 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1050 " ARG1 <= ARG2\n" \
1051 " ARG1 = ARG2\n" \
1052 " ARG1 != ARG2\n" \
1053 " ARG1 >= ARG2\n" \
1054 " ARG1 > ARG2\n" \
1055 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1056 " ARG1 - ARG2\n" \
1057 " ARG1 * ARG2\n" \
1058 " ARG1 / ARG2\n" \
1059 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001060 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1061 " match STRING REGEXP Same as STRING : REGEXP\n" \
1062 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1063 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1064 " length STRING Length of STRING\n" \
1065 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001066 " it is a keyword like 'match' or an\n" \
1067 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001068 " (EXPRESSION) Value of EXPRESSION\n" \
1069 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001070 "Beware that many operators need to be escaped or quoted for shells.\n" \
1071 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001072 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001073 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1074 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001075
Mike Frysingerfa69f112005-04-17 07:24:19 +00001076#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001077 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001078#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001079 "Provide fake ident (auth) service\n" \
1080 "\nOptions:" \
1081 "\n -f Run in foreground" \
1082 "\n -i Inetd mode" \
1083 "\n -w Inetd 'wait' mode" \
1084 "\n -b ADDR Bind to specified address" \
1085 "\n STRING Ident answer string (default is 'nobody')" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001086
Eric Andersen7e9276b2001-02-22 01:15:47 +00001087#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001088 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001089#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001090 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001091
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001092#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001093 "$ false\n" \
1094 "$ echo $?\n" \
1095 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001096
1097#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001098 "[options] [mode]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001099#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001100 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001101
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001102#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001103 "$ fbset\n" \
1104 "mode \"1024x768-76\"\n" \
1105 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1106 " geometry 1024 768 1024 768 16\n" \
1107 " timings 12714 128 32 16 4 128 4\n" \
1108 " accel false\n" \
1109 " rgba 5/11,6/5,5/0,0/0\n" \
1110 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001111
Eric Andersen7e9276b2001-02-22 01:15:47 +00001112#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001113 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001114#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001115 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001116
Eric Andersen01c3d402003-07-05 07:51:31 +00001117#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001118 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001119#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001120 "Format floppy disk\n" \
1121 "\nOptions:" \
1122 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001123
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001124/* Looks like someone forgot to add this to config system */
1125#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1126# define ENABLE_FEATURE_FDISK_BLKSIZE 0
1127# define USE_FEATURE_FDISK_BLKSIZE(a)
1128#endif
1129
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001130#define fdisk_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001131 "[-ul" USE_FEATURE_FDISK_BLKSIZE("s") "] " \
1132 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001133#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001134 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001135 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001136 "\n -u Start and End are in sectors (instead of cylinders)" \
1137 "\n -l Show partition table for each DISK, then exit" \
1138 USE_FEATURE_FDISK_BLKSIZE( \
1139 "\n -s Show partition sizes in kb for each DISK, then exit" \
1140 ) \
1141 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1142 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
1143 "\n -H HEADS\n" \
1144 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001145
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001146#define blkid_trivial_usage \
1147 ""
1148#define blkid_full_usage "\n\n" \
1149 "Print UUIDs of all filesystems."
1150
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001151#define findfs_trivial_usage \
1152 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001153#define findfs_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001154 "Find a filesystem device based on a label or UUID."
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001155#define findfs_example_usage \
1156 "$ findfs LABEL=MyDevice"
1157
Eric Andersen7e9276b2001-02-22 01:15:47 +00001158#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001159 "[PATH...] [EXPRESSION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001160#define find_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001161 "Search for files. The default PATH is the current directory,\n" \
1162 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001163 "\nEXPRESSION may consist of:" \
1164 "\n -follow Dereference symlinks" \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001165 USE_FEATURE_FIND_XDEV( \
1166 "\n -xdev Don't descend directories on other filesystems") \
1167 USE_FEATURE_FIND_MAXDEPTH( \
1168 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1169 "\n tests/actions to command line arguments only") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001170 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001171 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001172 USE_FEATURE_FIND_PATH( \
1173 "\n -path PATTERN Path matches PATTERN") \
1174 USE_FEATURE_FIND_REGEX( \
1175 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001176 USE_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001177 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001178 USE_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001179 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001180 "\n or exactly (NNN)") \
1181 USE_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001182 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001183 "\n or exactly (N) days") \
1184 USE_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001185 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001186 "\n or exactly (N) minutes") \
1187 USE_FEATURE_FIND_NEWER( \
1188 "\n -newer FILE Modified time is more recent than FILE's") \
1189 USE_FEATURE_FIND_INUM( \
1190 "\n -inum N File has inode number N") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001191 USE_FEATURE_FIND_USER( \
1192 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
1193 USE_FEATURE_FIND_GROUP( \
1194 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
1195 USE_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001196 "\n -depth Process directory name after traversing it") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001197 USE_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001198 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1199 "\n +/-N: file size is bigger/smaller than N") \
1200 "\n -print Print (default and assumed)" \
1201 USE_FEATURE_FIND_PRINT0( \
1202 "\n -print0 Delimit output with null characters rather than" \
1203 "\n newlines") \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001204 USE_FEATURE_FIND_CONTEXT ( \
1205 "\n -context File has specified security context") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001206 USE_FEATURE_FIND_EXEC( \
1207 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1208 "\n matching files") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001209 USE_FEATURE_FIND_PRUNE( \
1210 "\n -prune Stop traversing current subtree") \
1211 USE_FEATURE_FIND_DELETE( \
1212 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001213 USE_FEATURE_FIND_PAREN( \
1214 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001215
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001216#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001217 "$ find / -name passwd\n" \
1218 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001219
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001220#define flash_eraseall_trivial_usage \
1221 "[-jq] MTD_DEVICE"
1222#define flash_eraseall_full_usage "\n\n" \
1223 "Erase an MTD device\n" \
1224 "\nOptions:" \
1225 "\n -j format the device for jffs2" \
1226 "\n -q don't display progress messages"
1227
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001228#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001229 "[-bs] [-w WIDTH] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001230#define fold_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001231 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001232 "standard output\n" \
1233 "\nOptions:" \
1234 "\n -b Count bytes rather than columns" \
1235 "\n -s Break at spaces" \
1236 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001237
Eric Andersen7e9276b2001-02-22 01:15:47 +00001238#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001239 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001240#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001241 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001242#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001243 "$ free\n" \
1244 " total used free shared buffers\n" \
1245 " Mem: 257628 248724 8904 59644 93124\n" \
1246 " Swap: 128516 8404 120112\n" \
1247 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001248
Eric Andersen7e9276b2001-02-22 01:15:47 +00001249#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001250 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001251#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001252 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001253#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001254 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001255
Mike Frysinger51a43b42005-09-24 07:11:16 +00001256#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001257 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001258#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001259 "Check and repair filesystems\n" \
1260 "\nOptions:" \
1261 "\n -A Walk /etc/fstab and check all filesystems" \
1262 "\n -N Don't execute, just show what would be done" \
1263 "\n -P With -A, check filesystems in parallel" \
1264 "\n -R With -A, skip the root filesystem" \
1265 "\n -T Don't show title on startup" \
1266 "\n -V Verbose" \
1267 "\n -C n Write status information to specified filedescriptor" \
1268 "\n -t type List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001269
Eric Andersen7e9276b2001-02-22 01:15:47 +00001270#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001271 "[-larvsmf] /dev/name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001272#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001273 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001274 "\nOptions:" \
1275 "\n -l List all filenames" \
1276 "\n -r Perform interactive repairs" \
1277 "\n -a Perform automatic repairs" \
1278 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001279 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001280 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001281 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001282
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001283#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001284 "[options] remote-host local-file remote-file"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001285#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001286 "Retrieve a remote file via FTP\n" \
1287 "\nOptions:" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001288 USE_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001289 "\n -c,--continue Continue previous transfer" \
1290 "\n -v,--verbose Verbose" \
1291 "\n -u,--username Username" \
1292 "\n -p,--password Password" \
1293 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001294 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001295 SKIP_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001296 "\n -c Continue previous transfer" \
1297 "\n -v Verbose" \
1298 "\n -u Username" \
1299 "\n -p Password" \
1300 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001301 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001302
1303#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001304 "[options] remote-host remote-file local-file"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001305#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001306 "Store a local file on a remote machine via FTP\n" \
1307 "\nOptions:" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001308 USE_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001309 "\n -v,--verbose Verbose" \
1310 "\n -u,--username Username" \
1311 "\n -p,--password Password" \
1312 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001313 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001314 SKIP_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001315 "\n -v Verbose" \
1316 "\n -u Username" \
1317 "\n -p Password" \
1318 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001319 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001320
Rob Landleyaa872762005-10-28 13:05:12 +00001321#define fuser_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001322 "[options] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001323#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001324 "Find processes which use FILEs or PORTs\n" \
1325 "\nOptions:" \
1326 "\n -m Find processes which use same fs as FILEs" \
1327 "\n -4 Search only IPv4 space" \
1328 "\n -6 Search only IPv6 space" \
1329 "\n -s Silent: just exit with 0 if any processes are found" \
1330 "\n -k Kill found processes (otherwise display PIDs)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001331 "\n -SIGNAL Signal to send (default: TERM)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001332
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001333#define getenforce_trivial_usage NOUSAGE_STR
1334#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001335
Eric Andersen7e9276b2001-02-22 01:15:47 +00001336#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001337 "[OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001338#define getopt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001339 "Parse command options\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001340 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001341 "\n -a,--alternative Allow long options starting with single -" \
1342 "\n -l,--longoptions=longopts Long options to be recognized" \
1343 "\n -n,--name=progname The name under which errors are reported" \
1344 "\n -o,--options=optstring Short options to be recognized" \
1345 "\n -q,--quiet Disable error reporting by getopt(3)" \
1346 "\n -Q,--quiet-output No normal output" \
1347 "\n -s,--shell=shell Set shell quoting conventions" \
1348 "\n -T,--test Test for getopt(1) version" \
1349 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001350 ) \
1351 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001352 "\n -a Allow long options starting with single -" \
1353 "\n -l longopts Long options to be recognized" \
1354 "\n -n progname The name under which errors are reported" \
1355 "\n -o optstring Short options to be recognized" \
1356 "\n -q Disable error reporting by getopt(3)" \
1357 "\n -Q No normal output" \
1358 "\n -s shell Set shell quoting conventions" \
1359 "\n -T Test for getopt(1) version" \
1360 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001361 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001362#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001363 "$ cat getopt.test\n" \
1364 "#!/bin/sh\n" \
1365 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1366 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001367 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001368 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001369 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001370 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001371 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1372 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001373 " -c|--c-long)\n" \
1374 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001375 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1376 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1377 " esac;;\n" \
1378 " --) shift; break;;\n" \
1379 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001380 " esac\n" \
1381 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001382
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001383#define getsebool_trivial_usage \
1384 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001385#define getsebool_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001386 " -a Show all SELinux booleans"
1387
Eric Andersenf349e972001-08-21 16:18:59 +00001388#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001389 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001390#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001391 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1392 "\nOptions:" \
1393 "\n -h Enable hardware (RTS/CTS) flow control" \
1394 "\n -i Do not display /etc/issue before running login" \
1395 "\n -L Local line, do not do carrier detect" \
1396 "\n -m Get baud rate from modem's CONNECT status message" \
1397 "\n -w Wait for a CR or LF before sending /etc/issue" \
1398 "\n -n Do not prompt the user for a login name" \
1399 "\n -f issue_file Display issue_file instead of /etc/issue" \
1400 "\n -l login_app Invoke login_app instead of /bin/login" \
1401 "\n -t timeout Terminate after timeout if no username is read" \
1402 "\n -I initstring Init string to send before anything else" \
1403 "\n -H login_host Log login_host into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001404
Eric Andersen7e9276b2001-02-22 01:15:47 +00001405#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001406 "[-HhrilLnqvso" \
1407 USE_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001408 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001409 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1410 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001411 "] PATTERN [FILEs...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001412#define grep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001413 "Search for PATTERN in each FILE or standard input\n" \
1414 "\nOptions:" \
1415 "\n -H Prefix output lines with filename where match was found" \
1416 "\n -h Suppress the prefixing filename on output" \
1417 "\n -r Recurse subdirectories" \
1418 "\n -i Ignore case distinctions" \
1419 "\n -l List names of files that match" \
1420 "\n -L List names of files that do not match" \
1421 "\n -n Print line number with output lines" \
1422 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1423 "\n -v Select non-matching lines" \
1424 "\n -s Suppress file open/read error messages" \
1425 "\n -c Only print count of matching lines" \
1426 "\n -o Show only the part of a line that matches PATTERN" \
1427 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001428 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001429 "\n -w Match whole words only") \
1430 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001431 USE_FEATURE_GREP_EGREP_ALIAS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001432 "\n -E PATTERN is an extended regular expression") \
1433 "\n -e PTRN Pattern to match" \
1434 "\n -f FILE Read pattern from file" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001435 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001436 "\n -A Print NUM lines of trailing context" \
1437 "\n -B Print NUM lines of leading context" \
1438 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001439
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001440#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001441 "$ grep root /etc/passwd\n" \
1442 "root:x:0:0:root:/root:/bin/bash\n" \
1443 "$ grep ^[rR]oo. /etc/passwd\n" \
1444 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001445
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001446#define egrep_trivial_usage NOUSAGE_STR
1447#define egrep_full_usage ""
1448
1449#define fgrep_trivial_usage NOUSAGE_STR
1450#define fgrep_full_usage ""
1451
Eric Andersen7e9276b2001-02-22 01:15:47 +00001452#define gunzip_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001453 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001454#define gunzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001455 "Uncompress FILEs (or standard input)\n" \
1456 "\nOptions:" \
1457 "\n -c Write to standard output" \
1458 "\n -f Force" \
1459 "\n -t Test file integrity" \
1460
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001461#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001462 "$ ls -la /tmp/BusyBox*\n" \
1463 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1464 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1465 "$ ls -la /tmp/BusyBox*\n" \
1466 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001467
1468#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001469 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001470#define gzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001471 "Compress FILEs (or standard input)\n" \
1472 "\nOptions:" \
1473 "\n -c Write to standard output" \
1474 "\n -d Decompress" \
1475 "\n -f Force" \
1476
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001477#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001478 "$ ls -la /tmp/busybox*\n" \
1479 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1480 "$ gzip /tmp/busybox.tar\n" \
1481 "$ ls -la /tmp/busybox*\n" \
1482 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001483
1484#define halt_trivial_usage \
Bernhard Reutner-Fischerd93179f2008-09-01 15:24:52 +00001485 "[-d delay] [-n] [-f]" USE_FEATURE_WTMP(" [-w]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001486#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001487 "Halt the system\n" \
1488 "\nOptions:" \
1489 "\n -d Delay interval for halting" \
1490 "\n -n No call to sync()" \
1491 "\n -f Force halt (don't go through init)" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001492 USE_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001493 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001494 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001495
Eric Andersen3443bd72003-07-22 07:30:36 +00001496#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001497 "[options] [device] .."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001498#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001499 "Options:" \
1500 "\n -a Get/set fs readahead" \
1501 "\n -A Set drive read-lookahead flag (0/1)" \
1502 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1503 "\n -B Set Advanced Power Management setting (1-255)" \
1504 "\n -c Get/set IDE 32-bit IO setting" \
1505 "\n -C Check IDE power mode status" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001506 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001507 "\n -d Get/set using_dma flag") \
1508 "\n -D Enable/disable drive defect-mgmt" \
1509 "\n -f Flush buffer cache for device on exit" \
1510 "\n -g Display drive geometry" \
1511 "\n -h Display terse usage information" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001512 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001513 "\n -i Display drive identification") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001514 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001515 "\n -I Detailed/current information directly from drive") \
1516 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1517 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1518 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1519 "\n -m Get/set multiple sector count" \
1520 "\n -n Get/set ignore-write-errors flag (0/1)" \
1521 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1522 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001523/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001524 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1525 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001526 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001527 "\n -R Register an IDE interface (DANGEROUS)") \
1528 "\n -S Set standby (spindown) timeout" \
1529 "\n -t Perform device read timings" \
1530 "\n -T Perform cache read timings" \
1531 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001532 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001533 "\n -U Un-register an IDE interface (DANGEROUS)") \
1534 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1535 "\n -V Display program version and exit immediately" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001536 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001537 "\n -w Perform device reset (DANGEROUS)") \
1538 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001539 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001540 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1541 "\n -X Set IDE xfer mode (DANGEROUS)" \
1542 "\n -y Put IDE drive in standby mode" \
1543 "\n -Y Put IDE drive to sleep" \
1544 "\n -Z Disable Seagate auto-powersaving mode" \
1545 "\n -z Re-read partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001546
Eric Andersen7e9276b2001-02-22 01:15:47 +00001547#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001548 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001549#define head_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001550 "Print first 10 lines of each FILE to standard output.\n" \
1551 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001552 "file name. With no FILE, or when FILE is -, read standard input.\n" \
1553 "\nOptions:" \
1554 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001555 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001556 "\n -c NUM Output the first NUM bytes" \
1557 "\n -q Never output headers giving file names" \
1558 "\n -v Always output headers giving file names") \
1559
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001560#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001561 "$ head -n 2 /etc/passwd\n" \
1562 "root:x:0:0:root:/root:/bin/bash\n" \
1563 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001564
Glenn L McGrath60281112001-11-02 11:39:46 +00001565#define hexdump_trivial_usage \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001566 "[-bcCdefnosvx" USE_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001567#define hexdump_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001568 "Display file(s) or standard input in a user specified format\n" \
1569 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001570 "\n -b One-byte octal display" \
1571 "\n -c One-byte character display" \
1572 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1573 "\n -d Two-byte decimal display" \
1574 "\n -e FORMAT STRING" \
1575 "\n -f FORMAT FILE" \
1576 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1577 "\n -o Two-byte octal display" \
1578 "\n -s OFFSET Skip OFFSET bytes" \
1579 "\n -v Display all input data" \
1580 "\n -x Two-byte hexadecimal display" \
1581 USE_FEATURE_HEXDUMP_REVERSE( \
1582 "\n -R Reverse of 'hexdump -Cv'") \
1583
1584#define hd_trivial_usage \
1585 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001586#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001587 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001588
Eric Andersen7e9276b2001-02-22 01:15:47 +00001589#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001590 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001591#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001592 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001593
1594#define hostname_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001595 "[OPTION] [hostname | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001596#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001597 "Get or set hostname or DNS domain name\n" \
1598 "\nOptions:" \
1599 "\n -s Short" \
1600 "\n -i Addresses for the hostname" \
1601 "\n -d DNS domain name" \
1602 "\n -f Fully qualified domain name" \
1603 "\n -F FILE Use the contents of FILE to specify the hostname" \
1604
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001605#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001606 "$ hostname\n" \
1607 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001608
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001609#define httpd_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001610 "[-c conffile]" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001611 " [-p [ip:]port]" \
1612 " [-i] [-f] [-v[v]]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001613 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001614 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001615 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001616 " [-h home]" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001617 " [-d/-e string]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001618#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001619 "Listen for incoming HTTP requests\n" \
1620 "\nOptions:" \
1621 "\n -c FILE Configuration file (default httpd.conf)" \
1622 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
1623 "\n -i Inetd mode" \
1624 "\n -f Do not daemonize" \
1625 "\n -v[v] Verbose" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001626 USE_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001627 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001628 USE_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001629 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001630 USE_FEATURE_HTTPD_AUTH_MD5( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001631 "\n -m PASS Crypt PASS with md5 algorithm") \
1632 "\n -h HOME Home directory (default .)" \
1633 "\n -e STRING HTML encode STRING" \
1634 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001635
Robert Griebl1cd04452002-07-21 16:50:49 +00001636#define hwclock_trivial_usage \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001637 USE_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001638 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1639 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001640 " [-f FILE]" \
1641 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001642 SKIP_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001643 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1644 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001645#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001646 "Query and set hardware clock (RTC)\n" \
1647 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001648 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001649 "\n -s Set system time from hardware clock" \
1650 "\n -w Set hardware clock to system time" \
1651 "\n -u Hardware clock is in UTC" \
1652 "\n -l Hardware clock is in local time" \
1653 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001654
Eric Andersen7e9276b2001-02-22 01:15:47 +00001655#define id_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001656 "[OPTIONS]... [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001657#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001658 "Print information about USER or the current user\n" \
1659 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001660 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001661 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001662 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001663 "\n -u Print user ID" \
Denis Vlasenko4f3209b2008-09-13 12:51:10 +00001664 "\n -g Print group ID" \
1665 "\n -G Print supplementary group IDs" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001666 "\n -n Print name instead of a number" \
1667 "\n -r Print real user ID instead of effective ID" \
1668
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001669#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001670 "$ id\n" \
1671 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001672
Eric Andersen7e9276b2001-02-22 01:15:47 +00001673#define ifconfig_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001674 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001675#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001676 "Configure a network interface\n" \
1677 "\nOptions:" \
1678 "\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001679 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001680 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001681 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001682 " [del ADDRESS[/PREFIXLEN]]\n") \
1683 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1684 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001685 USE_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001686 " [outfill NN] [keepalive NN]\n") \
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001687 " " USE_FEATURE_IFCONFIG_HW("[hw ether" USE_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001688 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001689 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001690 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001691 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001692 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001693
Denis Vlasenko06aed432008-02-26 18:25:24 +00001694#define ifenslave_trivial_usage \
1695 "[-cdf] master-iface <slave-iface...>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001696#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001697 "Configure network interfaces for parallel routing\n" \
1698 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001699 "\n -c, --change-active Change active slave" \
1700 "\n -d, --detach Remove slave interface from bonding device" \
1701 "\n -f, --force Force, even if interface is not Ethernet" \
1702/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001703
Denis Vlasenko06aed432008-02-26 18:25:24 +00001704#define ifenslave_example_usage \
1705 "To create a bond device, simply follow these three steps :\n" \
1706 "- ensure that the required drivers are properly loaded :\n" \
1707 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
1708 "- assign an IP address to the bond device :\n" \
1709 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
1710 "- attach all the interfaces you need to the bond device :\n" \
1711 " # ifenslave bond0 eth0 eth1 eth2\n" \
1712 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1713 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
1714 " To detach a dead interface without setting the bond device down :\n" \
1715 " # ifenslave -d bond0 eth1\n\n" \
1716 " To set the bond device down and automatically release all the slaves :\n" \
1717 " # ifconfig bond0 down\n\n" \
1718 " To change active slave :\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001719 " # ifenslave -c bond0 eth0\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001720
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001721#define ifup_trivial_usage \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001722 "[-ain"USE_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001723#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001724 "Options:" \
1725 "\n -a De/configure all interfaces automatically" \
1726 "\n -i FILE Use FILE for interface definitions" \
1727 "\n -n Print out what would happen, but don't do it" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001728 USE_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001729 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001730 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001731 ) \
1732 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001733 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001734
1735#define ifdown_trivial_usage \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001736 "[-ain"USE_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001737#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001738 "Options:" \
1739 "\n -a De/configure all interfaces automatically" \
1740 "\n -i FILE Use FILE for interface definitions" \
1741 "\n -n Print out what would happen, but don't do it" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001742 USE_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001743 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001744 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001745 ) \
1746 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001747 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001748
Glenn L McGrath06e95652003-02-09 06:51:14 +00001749#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001750 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001751#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001752 "Listen for network connections and launch programs\n" \
1753 "\nOptions:" \
1754 "\n -f Run in foreground" \
1755 "\n -e Log to stderr" \
1756 "\n -q N Socket listen queue (default: 128)" \
1757 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001758 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001759
Eric Andersen7e9276b2001-02-22 01:15:47 +00001760#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001761 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001762#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001763 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001764
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001765#define init_notes_usage \
1766"This version of init is designed to be run only by the kernel.\n" \
1767"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001768"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001769"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001770"runlevels, use sysvinit.\n" \
1771"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001772"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001773"it has the following default behavior:\n" \
1774"\n" \
1775" ::sysinit:/etc/init.d/rcS\n" \
1776" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001777" ::ctrlaltdel:/sbin/reboot\n" \
1778" ::shutdown:/sbin/swapoff -a\n" \
1779" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001780" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001781"\n" \
1782"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1783"\n" \
1784" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001785" tty3::askfirst:/bin/sh\n" \
1786" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001787"\n" \
1788"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1789"\n" \
1790" <id>:<runlevels>:<action>:<process>\n" \
1791"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001792" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001793"\n" \
1794" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1795" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001796" the specified process to run on. The contents of this field are\n" \
1797" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1798" be unique, although if it isn't you may have strange results. If this\n" \
1799" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001800" note that if BusyBox detects that a serial console is in use, then only\n" \
1801" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001802" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001803" stinkin' utmp.\n" \
1804"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001805" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001806"\n" \
1807" The runlevels field is completely ignored.\n" \
1808"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001809" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001810"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001811" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001812" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001813"\n" \
1814" The available actions can be classified into two groups: actions\n" \
1815" that are run only once, and actions that are re-run when the specified\n" \
1816" process exits.\n" \
1817"\n" \
1818" Run only-once actions:\n" \
1819"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001820" 'sysinit' is the first item run on boot. init waits until all\n" \
1821" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001822" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001823" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001824" the specified task completes. 'once' actions are asynchronous,\n" \
1825" therefore, init does not wait for them to complete. 'restart' is\n" \
1826" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001827" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001828" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001829" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001830" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001831" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001832" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001833" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001834" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001835"\n" \
1836" Run repeatedly actions:\n" \
1837"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001838" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001839" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001840" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1841" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001842" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001843" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001844" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001845" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001846"\n" \
1847" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001848" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001849" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001850"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001851" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001852"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001853" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001854"\n" \
1855"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001856"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001857" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001858" #\n" \
1859" ::sysinit:/etc/init.d/rcS\n" \
1860" \n" \
1861" # /bin/sh invocations on selected ttys\n" \
1862" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001863" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001864" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001865" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001866" tty2::askfirst:-/bin/sh\n" \
1867" tty3::askfirst:-/bin/sh\n" \
1868" tty4::askfirst:-/bin/sh\n" \
1869" \n" \
1870" # /sbin/getty invocations for selected ttys\n" \
1871" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001872" tty4::respawn:/sbin/getty 38400 tty4\n" \
1873" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001874" \n" \
1875" \n" \
1876" # Example of how to put a getty on a serial line (for a terminal)\n" \
1877" #\n" \
1878" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1879" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1880" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001881" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001882" #::respawn:/sbin/getty 57600 ttyS2\n" \
1883" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001884" # Stuff to do when restarting the init process\n" \
1885" ::restart:/sbin/init\n" \
1886" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001887" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001888" ::ctrlaltdel:/sbin/reboot\n" \
1889" ::shutdown:/bin/umount -a -r\n" \
1890" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001891
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001892#define inotifyd_trivial_usage \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001893 "PROG FILE1[:MASK] ..."
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001894#define inotifyd_full_usage "\n\n" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001895 "Run PROG on filesystem changes." \
1896 "\nWhen a filesystem event matching MASK occurs on FILEn," \
1897 "\nPROG <actual_event(s)> <FILEn> [<subfile_name>] is run." \
Denis Vlasenko289ff0e2008-11-14 21:52:16 +00001898 "\nEvents:" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001899 "\n a File is accessed" \
1900 "\n c File is modified" \
1901 "\n e Metadata changed" \
1902 "\n w Writtable file is closed" \
1903 "\n 0 Unwrittable file is closed" \
1904 "\n r File is opened" \
Denis Vlasenkoa09a42c2008-11-17 22:19:18 +00001905 "\n D File is deleted" \
1906 "\n M File is moved" \
1907 "\n u Backing fs is unmounted" \
1908 "\n o Event queue overflowed" \
1909 "\n x File can't be watched anymore" \
1910 "\nIf watching a directory:" \
1911 "\n m Subfile is moved into dir" \
1912 "\n y Subfile is moved out of dir" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001913 "\n n Subfile is created" \
1914 "\n d Subfile is deleted" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001915 "\n" \
1916 "\ninotifyd waits for PROG to exit." \
1917 "\nWhen x event happens for all FILEs, inotifyd exits" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001918
Denis Vlasenko36309cf2008-11-22 18:29:01 +00001919/* 2.6 style insmod has no options and required filename
1920 * (not module name - .ko can't be omitted) */
Eric Andersen7e9276b2001-02-22 01:15:47 +00001921#define insmod_trivial_usage \
Denis Vlasenko36309cf2008-11-22 18:29:01 +00001922 USE_FEATURE_2_4_MODULES("[OPTION]... MODULE ") \
1923 SKIP_FEATURE_2_4_MODULES("FILE ") \
1924 "[symbol=value]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001925#define insmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001926 "Load the specified kernel modules into the kernel" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001927 USE_FEATURE_2_4_MODULES( "\n" \
1928 "\nOptions:" \
1929 "\n -f Force module to load into the wrong kernel version" \
1930 "\n -k Make module autoclean-able" \
1931 "\n -v Verbose" \
1932 "\n -q Quiet" \
1933 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001934 USE_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001935 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001936 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001937 "\n -o NAME Set internal module name to NAME" \
1938 "\n -x Do not export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001939 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001940
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00001941/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001942#define install_trivial_usage \
Denis Vlasenko4acdb462009-01-31 21:45:57 +00001943 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [source] dest|directory"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001944#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001945 "Copy files and set attributes\n" \
1946 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001947 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001948 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00001949 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001950 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001951 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001952 "\n -o USER Set ownership" \
1953 "\n -g GRP Set group ownership" \
1954 "\n -m MODE Set permissions" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001955 USE_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001956 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001957 )
Denis Vlasenko397de612008-03-17 08:55:44 +00001958
Denis Vlasenko4acdb462009-01-31 21:45:57 +00001959#define ionice_trivial_usage \
1960 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
1961#define ionice_full_usage "\n\n" \
1962 "Change I/O scheduling class and priority\n" \
1963 "\nOptions:" \
1964 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
1965 "\n -n Priority" \
1966
Denis Vlasenko397de612008-03-17 08:55:44 +00001967/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001968#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001969 "[OPTIONS] {" \
1970 USE_FEATURE_IP_ADDRESS("address | ") \
1971 USE_FEATURE_IP_ROUTE("route | ") \
1972 USE_FEATURE_IP_LINK("link | ") \
1973 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1974 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001975 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001976#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001977 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001978 "where OBJECT := {" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001979 USE_FEATURE_IP_ADDRESS("address | ") \
1980 USE_FEATURE_IP_ROUTE("route | ") \
1981 USE_FEATURE_IP_LINK("link | ") \
1982 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1983 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001984 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001985 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001986
1987#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001988 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001989 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001990#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001991 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001992 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
1993 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001994 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001995 " [broadcast ADDR] [anycast ADDR]\n" \
1996 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001997 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001998
Eric Andersende4f07e2003-12-11 01:18:07 +00001999#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002000 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002001#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002002 "Calculate IP network settings from a IP address\n" \
2003 "\nOptions:" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002004 USE_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002005 "\n -b,--broadcast Display calculated broadcast address" \
2006 "\n -n,--network Display calculated network address" \
2007 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002008 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002009 "\n -p,--prefix Display the prefix for IP/NETMASK" \
2010 "\n -h,--hostname Display first resolved host name" \
2011 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002012 ) \
2013 ) \
2014 SKIP_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002015 "\n -b Display calculated broadcast address" \
2016 "\n -n Display calculated network address" \
2017 "\n -m Display default netmask for IP" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002018 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002019 "\n -p Display the prefix for IP/NETMASK" \
2020 "\n -h Display first resolved host name" \
2021 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002022 ) \
2023 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00002024
Rob Landley6eb1e412005-06-20 04:30:36 +00002025#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002026 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002027#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002028 "Upper-case options MQS remove an object by shmkey value.\n" \
2029 "Lower-case options remove an object by shmid value.\n" \
2030 "\nOptions:" \
2031 "\n -mM Remove memory segment after last detach" \
2032 "\n -qQ Remove message queue" \
2033 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002034
2035#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002036 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002037#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002038 " -i Show specific resource" \
2039 "\nResource specification:" \
2040 "\n -m Shared memory segments" \
2041 "\n -q Message queues" \
2042 "\n -s Semaphore arrays" \
2043 "\n -a All (default)" \
2044 "\nOutput format:" \
2045 "\n -t Time" \
2046 "\n -c Creator" \
2047 "\n -p Pid" \
2048 "\n -l Limits" \
2049 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002050
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002051#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002052 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002053#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00002054 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002055 " dynamic { on | off } |\n" \
2056 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002057 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002058
2059#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002060 "{ list | flush | { add | del | change | append |\n" \
2061 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002062#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002063 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002064 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
2065 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002066 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002067 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00002068 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
2069 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002070
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002071#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002072 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002073#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002074 "iprule [list | add | del] SELECTOR ACTION\n" \
2075 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2076 " [dev STRING] [pref NUMBER]\n" \
2077 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2078 " [prohibit | reject | unreachable]\n" \
2079 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002080 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002081
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002082#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002083 "{ add | change | del | show } [NAME]\n" \
2084 " [mode { ipip | gre | sit }]\n" \
2085 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002086#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002087 "iptunnel { add | change | del | show } [NAME]\n" \
2088 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2089 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002090 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002091
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002092#define kbd_mode_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002093 "[-a|k|s|u] [-C TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002094#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002095 "Report or set the keyboard mode\n" \
2096 "\nOptions set mode:" \
2097 "\n -a Default (ASCII)" \
2098 "\n -k Medium-raw (keyboard)" \
2099 "\n -s Raw (scancode)" \
2100 "\n -u Unicode (utf-8)" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002101 "\n -C TTY Affect TTY instead of /dev/tty" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002102
Eric Andersen7e9276b2001-02-22 01:15:47 +00002103#define kill_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002104 "[-l] [-SIG] PID..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002105#define kill_full_usage "\n\n" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002106 "Send a signal (default is TERM) to given PIDs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002107 "\nOptions:" \
2108 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002109/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002110
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002111#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002112 "$ ps | grep apache\n" \
2113 "252 root root S [apache]\n" \
2114 "263 www-data www-data S [apache]\n" \
2115 "264 www-data www-data S [apache]\n" \
2116 "265 www-data www-data S [apache]\n" \
2117 "266 www-data www-data S [apache]\n" \
2118 "267 www-data www-data S [apache]\n" \
2119 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002120
2121#define killall_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002122 "[-l] [-q] [-SIG] process-name..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002123#define killall_full_usage "\n\n" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002124 "Send a signal (default is TERM) to given processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002125 "\nOptions:" \
2126 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002127/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002128 "\n -q Do not complain if no processes were killed" \
2129
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002130#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002131 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002132
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002133#define killall5_trivial_usage \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002134 "[-l] [-SIG] [-o PID]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002135#define killall5_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002136 "Send a signal (default is TERM) to all processes outside current session\n" \
2137 "\nOptions:" \
2138 "\n -l List all signal names and numbers" \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002139 "\n -o PID Do not signal this PID" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002140/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002141
Mark Whitley6317c4b2001-03-12 22:51:50 +00002142#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002143 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002144#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002145 "Kernel logger\n" \
2146 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002147 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002148 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002149
Eric Andersen7e9276b2001-02-22 01:15:47 +00002150#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002151 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002152#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002153 "Print STRING's length"
2154
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002155#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002156 "$ length Hello\n" \
2157 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002158
Rob Landley9200e792005-09-15 19:26:59 +00002159#define less_trivial_usage \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002160 "[-EMNmh~I?] [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002161#define less_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002162 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002163 "changed, and files can be manipulated in various ways.\n" \
2164 "\nOptions:" \
2165 "\n -E Quit once the end of a file is reached" \
2166 "\n -M,-m Display a status line containing the line numbers" \
2167 "\n and percentage through the file" \
2168 "\n -N Prefix line numbers to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002169 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002170 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002171
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002172#define linux32_trivial_usage NOUSAGE_STR
2173#define linux32_full_usage ""
2174#define linux64_trivial_usage NOUSAGE_STR
2175#define linux64_full_usage ""
2176
2177#define linuxrc_trivial_usage NOUSAGE_STR
2178#define linuxrc_full_usage ""
2179
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002180#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002181 "personality program [args...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002182#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002183 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002184 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002185 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002186
Eric Andersen7e9276b2001-02-22 01:15:47 +00002187#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002188 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002189#define ln_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002190 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002191 "Use '--' to indicate that all following arguments are non-options.\n" \
2192 "\nOptions:" \
2193 "\n -s Make symlinks instead of hardlinks" \
2194 "\n -f Remove existing destination files" \
2195 "\n -n Don't dereference symlinks - treat like normal file" \
2196 "\n -b Make a backup of the target (if exists) before link operation" \
2197 "\n -S suf Use suffix instead of ~ when making backup files" \
2198
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002199#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002200 "$ ln -s BusyBox /tmp/ls\n" \
2201 "$ ls -l /tmp/ls\n" \
2202 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002203
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002204#define load_policy_trivial_usage NOUSAGE_STR
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002205#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002206
Eric Andersen7e9276b2001-02-22 01:15:47 +00002207#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002208 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002209#define loadfont_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002210 "Load a console font from standard input" \
2211/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2212
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002213#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002214 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002215
2216#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002217 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002218#define loadkmap_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002219 "Load a binary keyboard translation table from standard input\n" \
2220/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2221
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002222#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002223 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002224
2225#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002226 "[OPTION]... [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002227#define logger_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002228 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n" \
2229 "\nOptions:" \
2230 "\n -s Log to stderr as well as the system log" \
2231 "\n -t TAG Log using the specified tag (defaults to user name)" \
2232 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002233
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002234#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002235 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002236
Robert Griebl1fca5582002-06-04 20:45:46 +00002237#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002238 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002239#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002240 "Begin a new session on the system\n" \
2241 "\nOptions:" \
2242 "\n -f Do not authenticate (user already authenticated)" \
2243 "\n -h Name of the remote host" \
2244 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002245
Eric Andersen7e9276b2001-02-22 01:15:47 +00002246#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002247 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002248#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002249 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002250#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002251 "$ logname\n" \
2252 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002253
Mark Whitley6317c4b2001-03-12 22:51:50 +00002254#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002255 "[OPTION]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002256#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002257 "Show messages in syslogd's circular buffer\n" \
2258 "\nOptions:" \
2259 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002260
Matt Kraai83788da2002-03-20 17:38:37 +00002261#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002262 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2263 " losetup -d LOOPDEV - disassociate\n" \
2264 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002265#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002266 "Options:" \
2267 "\n -o OFS Start OFS bytes into FILE" \
2268 "\n -f Show first free loop device" \
2269
Rob Landley1d589b22005-11-29 23:47:10 +00002270#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002271 "No arguments will display all current associations.\n" \
2272 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002273 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002274 "and filename of the file the loop device is currently bound to.\n\n" \
2275 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002276 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2277 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002278
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002279#define lpd_trivial_usage \
Denis Vlasenkoa7942892008-03-23 23:40:18 +00002280 "SPOOLDIR [HELPER [ARGS...]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002281#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002282 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2283 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002284 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002285 "\ndirectory and HELPER program is called. Name of file to print" \
2286 "\nis passed in $DATAFILE variable." \
2287 "\nExample:" \
2288 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002289
Denis Vlasenko68444b92008-02-22 22:24:48 +00002290#define lpq_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002291 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID...] [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002292#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002293 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002294 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002295 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002296 "\n -f Force any waiting job to be printed" \
2297 "\n -s Short display" \
2298
2299#define lpr_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002300 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE...]"
2301/* -C CLASS exists too, not shown.
2302 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002303#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002304 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002305 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002306 "\n -m Send mail on completion" \
2307 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002308 "\n -V Verbose" \
2309
Eric Andersen7e9276b2001-02-22 01:15:47 +00002310#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002311 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00002312 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002313 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
2314 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
2315 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
2316 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
2317 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
2318 USE_SELINUX("K") "] [filenames...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002319#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002320 "List directory contents\n" \
2321 "\nOptions:" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002322 "\n -1 List in a single column" \
2323 "\n -A Don't list . and .." \
2324 "\n -a Don't hide entries starting with ." \
2325 "\n -C List by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002326 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002327 "\n -c With -l: sort by ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002328 USE_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002329 "\n --color[={always,never,auto}] Control coloring") \
2330 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002331 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002332 "\n -e List full date and time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002333 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002334 "\n -F Append indicator (one of */=@|) to entries") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002335 "\n -i List inode numbers" \
2336 "\n -l Long listing format" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002337 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002338 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002339 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002340 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002341 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002342 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002343 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002344 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002345 "\n -r Sort in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002346 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002347 "\n -S Sort by file size") \
Denis Vlasenko397de612008-03-17 08:55:44 +00002348 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002349 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002350 "\n -T NUM Assume tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002351 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002352 "\n -t With -l: sort by modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002353 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002354 "\n -u With -l: sort by access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002355 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002356 "\n -v Sort by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002357 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002358 "\n -w NUM Assume the terminal is NUM columns wide") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002359 "\n -x List by lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002360 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002361 "\n -X Sort by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00002362 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002363 "\n -h List sizes in human readable format (1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002364 USE_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002365 "\n -k List security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002366 USE_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002367 "\n -K List security context in long format") \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002368 USE_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002369 "\n -Z List security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002370
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002371#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002372 "[-Radlv] [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002373#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002374 "List file attributes on an ext2 fs\n" \
2375 "\nOptions:" \
2376 "\n -R Recursively list subdirectories" \
2377 "\n -a Do not hide entries starting with ." \
2378 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002379 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002380 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002381
Eric Andersen7e9276b2001-02-22 01:15:47 +00002382#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002383 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002384#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002385 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002386
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002387#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002388#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002389 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002390#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002391 "Create a range of block or character special files" \
2392 "\n" \
2393 "\nTYPE is:" \
2394 "\n b Block device" \
2395 "\n c Character device" \
2396 "\n f FIFO, MAJOR and MINOR are ignored" \
2397 "\n" \
2398 "\nFIRST..LAST specify numbers appended to NAME." \
2399 "\nIf 's' is the last argument, the base device is created as well." \
2400 "\n" \
2401 "\nExamples:" \
2402 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2403 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002404#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002405 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2406 "[creates ttyS2-ttyS63]\n" \
2407 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2408 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002409#endif
2410
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002411#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002412#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002413 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002414#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002415 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002416 "Device table entries take the form of:\n" \
2417 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002418 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002419 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002420 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002421 " c Character device\n" \
2422 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002423 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002424 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002425 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2426 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002427#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002428 "For example:\n" \
2429 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2430 "/dev d 755 0 0 - - - - -\n" \
2431 "/dev/console c 666 0 0 5 1 - - -\n" \
2432 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2433 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2434 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2435 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2436 "Will Produce:\n" \
2437 "/dev\n" \
2438 "/dev/console\n" \
2439 "/dev/null\n" \
2440 "/dev/zero\n" \
2441 "/dev/hda\n" \
2442 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002443#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002444
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002445#define makemime_trivial_usage \
2446 "[OPTION]... [FILE]..."
2447#define makemime_full_usage "\n\n" \
2448 "Create MIME-encoded message\n" \
2449 "\nOptions:" \
2450 "\n -C Charset" \
Denis Vlasenkoc028ec22008-11-10 10:47:47 +00002451 "\n -e Transfer encoding. Ignored. base64 is assumed" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002452 "\n" \
2453 "\nOther options are silently ignored." \
2454
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002455#define man_trivial_usage \
2456 "[OPTION]... [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002457#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002458 "Format and display manual page\n" \
2459 "\nOptions:" \
2460 "\n -a Display all pages" \
2461 "\n -w Show page locations" \
2462
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002463#define matchpathcon_trivial_usage \
2464 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002465#define matchpathcon_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002466 " -n Do not display path" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002467 "\n -N Do not use translations" \
2468 "\n -f Use alternate file_context file" \
2469 "\n -p Use prefix to speed translations" \
2470 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002471
Eric Andersen7e9276b2001-02-22 01:15:47 +00002472#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002473 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002474 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002475#define md5sum_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002476 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002477 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2478 "\nOptions:" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002479 "\n -c Check sums against given list" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002480 "\n -s Don't output anything, status code shows success" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002481 "\n -w Warn about improperly formatted checksum lines" \
2482 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002483
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002484#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002485 "$ md5sum < busybox\n" \
2486 "6fd11e98b98a58f64ff3398d7b324003\n" \
2487 "$ md5sum busybox\n" \
2488 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2489 "$ md5sum -c -\n" \
2490 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2491 "busybox: OK\n" \
2492 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002493
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002494#define sha1sum_trivial_usage \
2495 "[OPTION] [FILEs...]" \
2496 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
2497#define sha1sum_full_usage "\n\n" \
2498 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
2499 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2500 "\nOptions:" \
2501 "\n -c Check sums against given list" \
2502 "\n -s Don't output anything, status code shows success" \
2503 "\n -w Warn about improperly formatted checksum lines" \
2504 )
2505
2506#define sha256sum_trivial_usage \
2507 "[OPTION] [FILEs...]" \
2508 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha256sum [OPTION] -c [FILE]")
2509#define sha256sum_full_usage "\n\n" \
2510 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
2511 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2512 "\nOptions:" \
2513 "\n -c Check sums against given list" \
2514 "\n -s Don't output anything, status code shows success" \
2515 "\n -w Warn about improperly formatted checksum lines" \
2516 )
2517
2518#define sha512sum_trivial_usage \
2519 "[OPTION] [FILEs...]" \
2520 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha512sum [OPTION] -c [FILE]")
2521#define sha512sum_full_usage "\n\n" \
2522 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
2523 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2524 "\nOptions:" \
2525 "\n -c Check sums against given list" \
2526 "\n -s Don't output anything, status code shows success" \
2527 "\n -w Warn about improperly formatted checksum lines" \
2528 )
2529
Rob Landley70f7ef72005-12-13 08:21:33 +00002530#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002531 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002532#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002533 " -s Scan /sys and populate /dev during system boot\n" \
2534 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002535 "Called with no options (via hotplug) it uses environment variables\n" \
2536 "to determine which device to add/remove."
Denis Vlasenko397de612008-03-17 08:55:44 +00002537
Rob Landleyef10d522006-06-26 14:11:33 +00002538#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002539 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002540 "The mdev config file contains lines that look like:\n" \
2541 " hd[a-z][0-9]* 0:3 660\n\n" \
2542 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002543 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002544 "Optionally, that can be followed (on the same line) by a special character\n" \
2545 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002546 "device(s). The environment variable $MDEV indicates the active device node\n" \
2547 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002548 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2549 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002550 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002551 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002552 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002553 "Config file parsing stops on the first matching line. If no config\n" \
2554 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002555 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002556 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002557
Glenn L McGrath061c9002002-09-16 04:21:46 +00002558#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002559 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002560#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002561 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002562 " y Allow write access to your terminal\n" \
2563 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002564
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002565#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002566 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002567#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002568 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2569 "\nOptions:" \
2570 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2571 "\n next byte to it" \
2572 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2573 "\n -s Set serial line to SPEED" \
2574 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002575
Eric Andersen7e9276b2001-02-22 01:15:47 +00002576#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002577 "[OPTION] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002578#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002579 "Create DIRECTORY\n" \
2580 "\nOptions:" \
2581 "\n -m Set permission mode (as in chmod), not rwxrwxrwx - umask" \
2582 "\n -p No error if existing, make parent directories as needed" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002583 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002584 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002585 )
2586
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002587#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002588 "$ mkdir /tmp/foo\n" \
2589 "$ mkdir /tmp/foo\n" \
2590 "/tmp/foo: File exists\n" \
2591 "$ mkdir /tmp/foo/bar/baz\n" \
2592 "/tmp/foo/bar/baz: No such file or directory\n" \
2593 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002594
Mike Frysinger6447ac02005-06-11 05:29:40 +00002595#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002596 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2597 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2598 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2599 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2600 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2601 "device [blocks-count]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002602#define mke2fs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002603 " -b size Block size in bytes" \
2604 "\n -c Check for bad blocks before creating" \
2605 "\n -E opts Set extended options" \
2606 "\n -f size Fragment size in bytes" \
2607 "\n -F Force (ignore sanity checks)" \
2608 "\n -g num Number of blocks in a block group" \
2609 "\n -i ratio The bytes/inode ratio" \
2610 "\n -j Create a journal (ext3)" \
2611 "\n -J opts Set journal options (size/device)" \
2612 "\n -l file Read bad blocks list from file" \
2613 "\n -L lbl Set the volume label" \
2614 "\n -m percent Percent of fs blocks to reserve for admin" \
2615 "\n -M dir Set last mounted directory" \
2616 "\n -n Do not actually create anything" \
2617 "\n -N num Number of inodes to create" \
2618 "\n -o os Set the 'creator os' field" \
2619 "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" \
2620 "\n -q Quiet" \
2621 "\n -r rev Set filesystem revision" \
2622 "\n -S Write superblock and group descriptors only" \
2623 "\n -T fs-type Set usage type (news/largefile/largefile4)" \
2624 "\n -v Verbose" \
Mike Frysinger6447ac02005-06-11 05:29:40 +00002625
Eric Andersen7e9276b2001-02-22 01:15:47 +00002626#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002627 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002628#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002629 "Create named pipe (identical to 'mknod name p')\n" \
2630 "\nOptions:" \
2631 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002632 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002633 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002634 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002635
Eric Andersen7e9276b2001-02-22 01:15:47 +00002636#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002637 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002638#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002639 "Make a MINIX filesystem\n" \
2640 "\nOptions:" \
2641 "\n -c Check device for bad blocks" \
2642 "\n -n [14|30] Maximum length of filenames" \
2643 "\n -i INODES Number of inodes for the filesystem" \
2644 "\n -l FILENAME Read bad blocks list from FILENAME" \
2645 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002646
Eric Andersen7e9276b2001-02-22 01:15:47 +00002647#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002648 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002649#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002650 "Create a special file (block, character, or pipe)\n" \
2651 "\nOptions:" \
2652 "\n -m Create the special file using the specified mode (default a=rw)" \
2653 "\nTYPEs include:" \
2654 "\n b: Make a block device" \
2655 "\n c or u: Make a character device" \
2656 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002657 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002658 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002659 )
2660
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002661#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002662 "$ mknod /dev/fd0 b 2 0\n" \
2663 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002664
Eric Andersen7e9276b2001-02-22 01:15:47 +00002665#define mkswap_trivial_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002666 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002667#define mkswap_full_usage "\n\n" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002668 "Prepare block device to be used as swap partition"
2669#if 0
2670 "[-c] [-v0|-v1] DEVICE [BLOCKS]"
Denis Vlasenko397de612008-03-17 08:55:44 +00002671 "\nOptions:"
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002672 "\n -c Check for readability"
2673 "\n -v0 Make swap version 0 (max 128M)"
2674 "\n -v1 Make swap version 1 (default for kernels > 2.1.117)"
2675 "\n BLOCKS Number of blocks to use (default is entire partition)"
2676#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002677
Eric Andersen7e9276b2001-02-22 01:15:47 +00002678#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002679 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002680#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002681 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002682 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002683 "\nOptions:" \
2684 "\n -d Make a directory instead of a file" \
2685/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2686 "\n -t Generate a path rooted in temporary directory" \
2687 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2688 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002689 "\nFor -t or -p, directory is chosen as follows:" \
2690 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002691
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002692#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002693 "$ mktemp /tmp/temp.XXXXXX\n" \
2694 "/tmp/temp.mWiLjM\n" \
2695 "$ ls -la /tmp/temp.mWiLjM\n" \
2696 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002697
Eric Andersen8d79ce82001-07-22 23:00:15 +00002698#define modprobe_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002699 "[-knqrsv] MODULE [symbol=value...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002700#define modprobe_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002701 "Options:" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002702 USE_FEATURE_2_4_MODULES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002703 "\n -k Make module autoclean-able" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002704 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002705 "\n -n Dry run" \
2706 "\n -q Quiet" \
2707 "\n -r Remove module (stacks) or do autoclean" \
2708 "\n -s Report via syslog instead of stderr" \
2709 "\n -v Verbose" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002710 USE_FEATURE_MODPROBE_BLACKLIST( \
2711 "\n -b Apply blacklist to module names too" \
2712 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002713
Rob Landley9c32a152005-12-11 20:12:24 +00002714#define modprobe_notes_usage \
2715"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2716"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2717"pass each module it loads.\n" \
2718"\n" \
2719"The configuration file is searched (in order) amongst:\n" \
2720"\n" \
2721" /etc/modprobe.conf (2.6 only)\n" \
2722" /etc/modules.conf\n" \
2723" /etc/conf.modules (deprecated)\n" \
2724"\n" \
2725"They all have the same syntax (see below). If none is present, it is\n" \
2726"_not_ an error; each loaded module is then expected to load without\n" \
2727"options. Once a file is found, the others are tested for.\n" \
2728"\n" \
2729"/etc/modules.conf entry format:\n" \
2730"\n" \
2731" alias <alias_name> <mod_name>\n" \
2732" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002733" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002734" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2735" This makes it also possible to use a different set of options (below) for\n" \
2736" the module and the alias.\n" \
2737" A module can be aliased more than once.\n" \
2738"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002739" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002740" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2741" the \"symbol=value\" pairs as option to that module.\n" \
2742"\n" \
2743"Sample /etc/modules.conf file:\n" \
2744"\n" \
2745" options tulip irq=3\n" \
2746" alias tulip tulip2\n" \
2747" options tulip2 irq=4 io=0x308\n" \
2748"\n" \
2749"Other functionality offered by 'classic' modprobe is not available in\n" \
2750"this implementation.\n" \
2751"\n" \
2752"If module options are present both in the config file, and on the command line,\n" \
2753"then the options from the command line will be passed to the module _after_\n" \
2754"the options from the config file. That way, you can have defaults in the config\n" \
2755"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002756#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002757 "(with the above /etc/modules.conf):\n\n" \
2758 "$ modprobe tulip\n" \
2759 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2760 "$ modprobe tulip irq=5\n" \
2761 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2762 "$ modprobe tulip2\n" \
2763 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2764 " which are the default for alias 'tulip2'\n\n" \
2765 "$ modprobe tulip2 irq=8\n" \
2766 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2767 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2768 " from the command line\n\n" \
2769 "$ modprobe tulip2 irq=2 io=0x210\n" \
2770 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2771 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2772 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002773
Eric Andersen7e9276b2001-02-22 01:15:47 +00002774#define more_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002775 "[FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002776#define more_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002777 "View FILE or standard input one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002778
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002779#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002780 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002781
Eric Andersen7e9276b2001-02-22 01:15:47 +00002782#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002783 "[flags] DEVICE NODE [-o options,more-options]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002784#define mount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002785 "Mount a filesystem. Filesystem autodetection requires /proc be mounted.\n" \
2786 "\nOptions:" \
2787 "\n -a Mount all filesystems in fstab" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002788 USE_FEATURE_MOUNT_FAKE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002789 "\n -f "USE_FEATURE_MTAB_SUPPORT("Update /etc/mtab, but ")"don't mount" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002790 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002791 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002792 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002793 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002794 "\n -r Read-only mount" \
2795 "\n -t fs-type Filesystem type" \
2796 "\n -w Read-write mount (default)" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002797 "\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002798 "-o option:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002799 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002800 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002801 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002802 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002803 " [a]sync Writes are asynchronous / synchronous\n" \
2804 " [no]atime Disable / enable updates to inode access times\n" \
2805 " [no]diratime Disable / enable atime updates to directories\n" \
Bernhard Reutner-Fischerfb5902c2008-08-06 18:14:38 +00002806 " [no]relatime Disable / enable atime updates relative to modification time\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002807 " [no]dev Allow use of special device files / disallow them\n" \
2808 " [no]exec Allow use of executable files / disallow them\n" \
2809 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2810 " [r]shared Convert [recursively] to a shared subtree\n" \
2811 " [r]slave Convert [recursively] to a slave subtree\n" \
2812 " [r]private Convert [recursively] to a private subtree\n" \
2813 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2814 " bind Bind a directory to an additional location\n" \
2815 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002816 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002817 " remount Remount a mounted filesystem, changing its flags\n" \
2818 " ro/rw Mount for read-only / read-write\n" \
2819 "\n" \
2820 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002821 "You'll have to see the written documentation for those filesystems" \
2822
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002823#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002824 "$ mount\n" \
2825 "/dev/hda3 on / type minix (rw)\n" \
2826 "proc on /proc type proc (rw)\n" \
2827 "devpts on /dev/pts type devpts (rw)\n" \
2828 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2829 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2830 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002831#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002832 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002833
Rob Landleyd00b3a52005-08-20 05:07:08 +00002834#define mountpoint_trivial_usage \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002835 "[-q] <[-dn] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002836#define mountpoint_full_usage "\n\n" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002837 "Check if the directory is a mountpoint\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002838 "\nOptions:" \
2839 "\n -q Quiet" \
2840 "\n -d Print major/minor device number of the filesystem" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002841 "\n -n Print device name of the filesystem" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002842 "\n -x Print major/minor device number of the blockdevice" \
2843
Rob Landleyd00b3a52005-08-20 05:07:08 +00002844#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002845 "$ mountpoint /proc\n" \
2846 "/proc is not a mountpoint\n" \
2847 "$ mountpoint /sys\n" \
2848 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002849
Eric Andersen7e9276b2001-02-22 01:15:47 +00002850#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002851 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002852#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002853 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002854 "\n" \
2855 "Available Opcodes:\n" \
2856 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002857 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2858 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2859 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002860 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002861
Eric Andersen7e9276b2001-02-22 01:15:47 +00002862#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002863 "[OPTION]... SOURCE DEST\n" \
2864 "or: mv [OPTION]... SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002865#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002866 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
2867 "\nOptions:" \
2868 "\n -f Don't prompt before overwriting" \
2869 "\n -i Interactive, prompt before overwrite" \
2870
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002871#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002872 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002873
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002874#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002875 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002876#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002877 "Rename network interface while it in the down state\n" \
2878 "\nOptions:" \
2879 "\n -c FILE Use configuration file (default is /etc/mactab)" \
2880 "\n -s Use syslog (LOCAL0 facility)" \
2881 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
2882
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002883#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002884 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2885 " or\n" \
2886 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002887
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002888#if !ENABLE_DESKTOP
2889
Rob Landley1cca9482006-07-10 19:45:20 +00002890#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002891#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002892#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002893#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002894#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002895
Eric Andersen7e9276b2001-02-22 01:15:47 +00002896#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002897 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002898 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002899#define nc_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002900 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002901 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002902 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002903 "\n -e Exec rest of command line after connect" \
2904 "\n -i SECS Delay interval for lines sent" \
2905 "\n -w SECS Timeout for connect" \
2906 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002907 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002908 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002909 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002910 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002911 "\n (use -l twice with -e for persistent server)") \
2912 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002913 )
2914
Rob Landley1cca9482006-07-10 19:45:20 +00002915#define nc_notes_usage "" \
2916 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002917 "To use netcat as a terminal emulator on a serial port:\n\n" \
2918 "$ stty 115200 -F /dev/ttyS0\n" \
2919 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2920 )
Rob Landley1cca9482006-07-10 19:45:20 +00002921
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002922#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002923 "$ nc foobar.somedomain.com 25\n" \
2924 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2925 "help\n" \
2926 "214-Commands supported:\n" \
2927 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2928 "214 NOOP QUIT RSET HELP\n" \
2929 "quit\n" \
2930 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002931
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002932#else /* DESKTOP nc - much more compatible with nc 1.10 */
2933
2934#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002935 "[-options] hostname port - connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002936 USE_NC_SERVER("\n" \
2937 "nc [-options] -l -p port [hostname] [port] - listen")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002938#define nc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002939 "Options:" \
2940 "\n -e prog [args] Program to exec after connect (must be last)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002941 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002942 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002943 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002944 "\n -n Don't do DNS resolution" \
2945 "\n -s addr Local address" \
2946 "\n -p port Local port" \
2947 "\n -u UDP mode" \
2948 "\n -v Verbose (cumulative: -vv)" \
2949 "\n -w secs Timeout for connects and final net reads" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002950 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002951 "\n -i sec Delay interval for lines sent" /* ", ports scanned" */ \
2952 "\n -o file Hex dump of traffic" \
2953 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002954 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002955/* "\n -r Randomize local and remote ports" */
2956/* "\n -g gateway Source-routing hop point[s], up to 8" */
2957/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002958/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2959
2960#endif
2961
Eric Andersen1552ff72001-10-31 11:07:12 +00002962#define netstat_trivial_usage \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00002963 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")USE_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002964#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002965 "Display networking information\n" \
2966 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002967 "\n -l Display listening server sockets" \
2968 "\n -a Display all sockets (default: connected)" \
2969 "\n -e Display other/more information" \
2970 "\n -n Don't resolve names" \
2971 "\n -t Tcp sockets" \
2972 "\n -u Udp sockets" \
2973 "\n -w Raw sockets" \
2974 "\n -x Unix sockets" \
2975 "\n -r Display routing table" \
2976 USE_FEATURE_NETSTAT_WIDE( \
2977 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00002978 ) \
2979 USE_FEATURE_NETSTAT_PRG( \
2980 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002981 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002982
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002983#define nice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002984 "[-n ADJUST] [COMMAND [ARG]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002985#define nice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002986 "Run a program with modified scheduling priority\n" \
2987 "\nOptions:" \
2988 "\n -n ADJUST Adjust the scheduling priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002989
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002990#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002991 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002992#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002993 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002994 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002995 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002996 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002997 "%[niface] Monitor network interface 'iface'\n" \
2998 "%m Monitor allocated memory\n" \
2999 "%[mf] Monitor free memory\n" \
3000 "%[mt] Monitor total memory\n" \
3001 "%s Monitor allocated swap\n" \
3002 "%f Monitor number of used file descriptors\n" \
3003 "%Ni Monitor total/specific IRQ rate\n" \
3004 "%x Monitor context switch rate\n" \
3005 "%p Monitor forks\n" \
3006 "%[pn] Monitor # of processes\n" \
3007 "%b Monitor block io\n" \
3008 "%Nt Show time (with N decimal points)\n" \
3009 "%Nd Milliseconds between updates (default=1000)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003010 "%r Print <cr> instead of <lf> at EOL" \
3011
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003012#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003013 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003014
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003015#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003016 "COMMAND [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003017#define nohup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003018 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003019#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003020 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003021
Eric Andersen7e9276b2001-02-22 01:15:47 +00003022#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003023 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003024#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003025 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003026 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003027#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003028 "$ nslookup localhost\n" \
3029 "Server: default\n" \
3030 "Address: default\n" \
3031 "\n" \
3032 "Name: debian\n" \
3033 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003034
Glenn L McGrath60281112001-11-02 11:39:46 +00003035#define od_trivial_usage \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00003036 "[-aBbcDdeFfHhIiLlOovXx] " USE_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003037#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003038 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00003039 "to standard output. With no FILE or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00003040
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003041#define openvt_trivial_usage \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003042 "[-c NUM] [-sw] [COMMAND [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003043#define openvt_full_usage "\n\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003044 "Start COMMAND on a new virtual terminal\n" \
3045 "\nOptions:" \
3046 "\n -c Use specified VT" \
3047 "\n -s Switch to the VT" \
3048/* "\n -l Run COMMAND as login shell (by prepending '-')" */ \
3049 "\n -w Wait for COMMAND to exit" \
3050
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003051#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003052 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003053
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003054#define parse_trivial_usage \
3055 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
3056#define parse_full_usage "\n\n" \
3057 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
3058
Eric Andersen27f64e12002-06-23 04:24:25 +00003059#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003060 "[OPTION] [name]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003061#define passwd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003062 "Change user's password. If no name is specified,\n" \
3063 "changes the password for the current user.\n" \
3064 "\nOptions:" \
3065 "\n -a Algorithm to use for password (choices: des, md5)" /* ", sha1)" */ \
3066 "\n -d Delete password for the account" \
3067 "\n -l Lock (disable) account" \
3068 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003069
Denis Vlasenko21d10142007-07-20 21:28:41 +00003070#define chpasswd_trivial_usage \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003071 USE_GETOPT_LONG("[--md5|--encrypted]") SKIP_GETOPT_LONG("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003072#define chpasswd_full_usage "\n\n" \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003073 "Read user:password information from stdin " \
Denis Vlasenko397de612008-03-17 08:55:44 +00003074 "and update /etc/passwd accordingly.\n" \
3075 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003076 USE_GETOPT_LONG( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003077 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003078 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003079 ) \
3080 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003081 "\n -e Supplied passwords are in encrypted form" \
3082 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003083 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00003084
Glenn L McGrath655d8142003-06-22 15:32:41 +00003085#define patch_trivial_usage \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003086 "[-p NUM] [-i DIFF] [-R]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003087#define patch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003088 " -p NUM Strip NUM leading components from file names" \
3089 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003090 "\n -R Reverse patch" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003091
Glenn L McGrath655d8142003-06-22 15:32:41 +00003092#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003093 "$ patch -p1 < example.diff\n" \
3094 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00003095
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003096#define pgrep_trivial_usage \
3097 "[-flnovx] pattern"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003098#define pgrep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003099 "Display process(es) selected by regex pattern\n" \
3100 "\nOptions:" \
3101 "\n -l Show command name too" \
3102 "\n -f Match against entire command line" \
3103 "\n -n Show the newest process only" \
3104 "\n -o Show the oldest process only" \
3105 "\n -v Negate the matching" \
3106 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003107
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003108#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00003109#define pidof_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003110 "[OPTION] [NAME...]"
3111#define USAGE_PIDOF "\n\nOptions:"
3112#else
3113#define pidof_trivial_usage \
3114 "[NAME...]"
3115#define USAGE_PIDOF /* none */
3116#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003117#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003118 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003119 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003120 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003121 "\n -s Show only one PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003122 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003123 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003124 "\n Use %PPID to omit pid of pidof's parent") \
3125
Eric Andersen221b2ea2001-07-31 19:06:07 +00003126#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003127 "$ pidof init\n" \
3128 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003129 USE_FEATURE_PIDOF_OMIT( \
3130 "$ pidof /bin/sh\n20351 5973 5950\n") \
3131 USE_FEATURE_PIDOF_OMIT( \
3132 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00003133
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003134#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003135#define ping_trivial_usage \
3136 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003137#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003138 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003139#define ping6_trivial_usage \
3140 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003141#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003142 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003143#else
3144#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003145 "[OPTION]... host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003146#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003147 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3148 "\nOptions:" \
3149 "\n -4, -6 Force IPv4 or IPv6 hostname resolution" \
3150 "\n -c CNT Send only CNT pings" \
3151 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
3152 "\n -I iface/IP Use interface or IP address as source" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003153 "\n -W timeout Seconds to wait for the first response (default:10)" \
3154 "\n (after all -c CNT packets are sent)" \
3155 "\n -w deadline Seconds until ping exits (default:infinite)" \
3156 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003157 "\n -q Quiet, only displays output at start" \
3158 "\n and when finished" \
3159
Eric Andersen51b8bd62002-07-03 11:46:38 +00003160#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003161 "[OPTION]... host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003162#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003163 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3164 "\nOptions:" \
3165 "\n -c CNT Send only CNT pings" \
3166 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
3167 "\n -I iface/IP Use interface or IP address as source" \
3168 "\n -q Quiet, only displays output at start" \
3169 "\n and when finished" \
3170
Eric Andersen51b8bd62002-07-03 11:46:38 +00003171#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003172#define ping_example_usage \
3173 "$ ping localhost\n" \
3174 "PING slag (127.0.0.1): 56 data bytes\n" \
3175 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3176 "\n" \
3177 "--- debian ping statistics ---\n" \
3178 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3179 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003180#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003181 "$ ping6 ip6-localhost\n" \
3182 "PING ip6-localhost (::1): 56 data bytes\n" \
3183 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3184 "\n" \
3185 "--- ip6-localhost ping statistics ---\n" \
3186 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3187 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003188
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003189#define pipe_progress_trivial_usage NOUSAGE_STR
3190#define pipe_progress_full_usage ""
3191
Eric Andersen7e9276b2001-02-22 01:15:47 +00003192#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003193 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003194#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003195 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003196 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003197
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003198#define pkill_trivial_usage \
3199 "[-l] | [-fnovx] [-signal] pattern"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003200#define pkill_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003201 "Send a signal to process(es) selected by regex pattern\n" \
3202 "\nOptions:" \
3203 "\n -l List all signals" \
3204 "\n -f Match against entire command line" \
3205 "\n -n Signal the newest process only" \
3206 "\n -o Signal the oldest process only" \
3207 "\n -v Negate the matching" \
3208 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003209
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003210#define popmaildir_trivial_usage \
3211 "[OPTIONS] Maildir [connection-helper ...]"
3212#define popmaildir_full_usage "\n\n" \
3213 "Fetch content of remote mailbox to local maildir\n" \
3214 "\nOptions:" \
3215 "\n -b Binary mode. Ignored" \
3216 "\n -d Debug. Ignored" \
3217 "\n -m Show used memory. Ignored" \
3218 "\n -V Show version. Ignored" \
3219 "\n -c Use tcpclient. Ignored" \
3220 "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" \
3221 "\n -s Skip authorization" \
3222 "\n -T Get messages with TOP instead with RETR" \
3223 "\n -k Keep retrieved messages on the server" \
3224 "\n -t timeout Set network timeout" \
3225 USE_FEATURE_POPMAILDIR_DELIVERY( \
3226 "\n -F \"program arg1 arg2 ...\" Filter by program. May be multiple" \
3227 "\n -M \"program arg1 arg2 ...\" Deliver by program" \
3228 ) \
3229 "\n -R size Remove old messages on the server >= size (in bytes). Ignored" \
3230 "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" \
3231 "\n -L size Do not retrieve new messages >= size (in bytes). Ignored" \
3232 "\n -H lines Type specified number of lines of a message. Ignored"
3233#define popmaildir_example_usage \
3234 "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n" \
3235 "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
3236
Eric Andersen7e9276b2001-02-22 01:15:47 +00003237#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003238 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003239#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003240 "Halt and shut off power\n" \
3241 "\nOptions:" \
3242 "\n -d Delay interval for halting" \
3243 "\n -n No call to sync()" \
3244 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003245
Mike Frysinger95d3c452005-04-21 23:29:24 +00003246#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003247 "[VARIABLES...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003248#define printenv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003249 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003250 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003251
Eric Andersen7e9276b2001-02-22 01:15:47 +00003252#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003253 "FORMAT [ARGUMENT...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003254#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003255 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003256 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003257#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003258 "$ printf \"Val=%d\\n\" 5\n" \
3259 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003260
Denis Vlasenko94949192006-11-05 00:45:47 +00003261
3262#if ENABLE_DESKTOP
3263
3264#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003265 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003266#define ps_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003267 "Report process status\n" \
3268 "\nOptions:" \
3269 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00003270
3271#else /* !ENABLE_DESKTOP */
3272
Denis Vlasenko397de612008-03-17 08:55:44 +00003273#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003274#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003275#else
3276#define USAGE_PS "\nOptions:"
3277#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003278
Eric Andersen7e9276b2001-02-22 01:15:47 +00003279#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003280 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003281#define ps_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003282 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003283 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003284 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003285 "\n -Z Show SE Linux context" \
3286 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003287 USE_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003288 "\n w Wide output" \
3289 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003290
Denis Vlasenko94949192006-11-05 00:45:47 +00003291#endif /* ENABLE_DESKTOP */
3292
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003293#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003294 "$ ps\n" \
3295 " PID Uid Gid State Command\n" \
3296 " 1 root root S init\n" \
3297 " 2 root root S [kflushd]\n" \
3298 " 3 root root S [kupdate]\n" \
3299 " 4 root root S [kpiod]\n" \
3300 " 5 root root S [kswapd]\n" \
3301 " 742 andersen andersen S [bash]\n" \
3302 " 743 andersen andersen S -bash\n" \
3303 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003304 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003305
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003306#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003307 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003308#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003309 "Scan a host, print all open ports\n" \
3310 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003311 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003312 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003313 "\n -p Scan from this port (default 1)" \
3314 "\n -P Scan up to this port (default 1024)" \
3315 "\n -t Timeout (default 5000 ms)" \
3316 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3317
Eric Andersen7e9276b2001-02-22 01:15:47 +00003318#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003319 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003320#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003321 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003322#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003323 "$ pwd\n" \
3324 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003325
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003326#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003327 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003328#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003329 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003330#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003331 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003332
Eric Andersen7e9276b2001-02-22 01:15:47 +00003333#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003334 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003335#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003336 "Get and possibly set the system date and time from a remote HOST\n" \
3337 "\nOptions:" \
3338 "\n -s Set the system date and time (default)" \
3339 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003340
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00003341#define rdev_trivial_usage \
3342 ""
3343#define rdev_full_usage "\n\n" \
3344 "Print the device node associated with the filesystem mounted at '/'"
3345#define rdev_example_usage \
3346 "$ rdev\n" \
3347 "/dev/mtdblock9 /\n"
3348
Rob Landley0e4690d2006-08-20 22:12:18 +00003349#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003350 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003351#define readahead_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003352 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
3353 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00003354
Eric Andersen7e9276b2001-02-22 01:15:47 +00003355#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003356 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003357#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003358 "Display the value of a symlink" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003359 USE_FEATURE_READLINK_FOLLOW( "\n" \
3360 "\nOptions:" \
3361 "\n -f Canonicalize by following all symlinks") \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003362
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003363#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003364 "[OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003365#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003366 "Options:" \
3367 "\n -m mapfile (Default: /boot/System.map)" \
3368 "\n -p profile (Default: /proc/profile)" \
3369 "\n -M mult Set the profiling multiplier to mult" \
3370 "\n -i Print only info about the sampling step" \
3371 "\n -v Verbose" \
3372 "\n -a Print all symbols, even if count is 0" \
3373 "\n -b Print individual histogram-bin counts" \
3374 "\n -s Print individual counters within functions" \
3375 "\n -r Reset all the counters (root only)" \
3376 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003377
Glenn L McGrath62fae302002-12-10 00:14:33 +00003378#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003379 "pathname..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003380#define realpath_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003381 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00003382
Eric Andersen7e9276b2001-02-22 01:15:47 +00003383#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003384 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003385#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003386 "Reboot the system\n" \
3387 "\nOptions:" \
3388 "\n -d Delay interval for rebooting" \
3389 "\n -n No call to sync()" \
3390 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003391
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003392#define reformime_trivial_usage \
3393 "[OPTION]... [FILE]..."
3394#define reformime_full_usage "\n\n" \
3395 "Parse MIME-encoded message\n" \
3396 "\nOptions:" \
3397 "\n -x prefix Extract content of MIME sections to files" \
3398 "\n -X prog [args] Filter content of MIME sections through prog." \
3399 "\n Must be the last option" \
3400 "\n" \
3401 "\nOther options are silently ignored." \
3402
Eric Andersen7e9276b2001-02-22 01:15:47 +00003403#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003404 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003405#define renice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003406 "Change priority of running processes\n" \
3407 "\nOptions:" \
3408 "\n -n Adjust current nice value (smaller is faster)" \
3409 "\n -p Process id(s) (default)" \
3410 "\n -g Process group id(s)" \
3411 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003412
Eric Andersen7e9276b2001-02-22 01:15:47 +00003413#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003414 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003415#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003416 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003417
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003418#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003419 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003420#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003421 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003422
Denis Vlasenko397137b2007-07-23 14:03:30 +00003423#define restorecon_trivial_usage \
3424 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003425#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003426 "Reset security contexts of files in pathname\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003427 "\n -i Ignore files that do not exist" \
3428 "\n -f file File with list of files to process. Use - for stdin" \
3429 "\n -e directory Directory to exclude" \
3430 "\n -R,-r Recurse directories" \
3431 "\n -n Don't change any file labels" \
3432 "\n -o file Save list of files with incorrect context" \
3433 "\n -v Verbose" \
3434 "\n -vv Show changed labels" \
3435 "\n -F Force reset of context to match file_context" \
3436 "\n for customizable files, or the user section," \
3437 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003438
Eric Andersen7e9276b2001-02-22 01:15:47 +00003439#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003440 "[OPTION]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003441#define rm_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003442 "Remove (unlink) the FILE(s). Use '--' to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003443 "indicate that all following arguments are non-options.\n" \
3444 "\nOptions:" \
3445 "\n -i Always prompt before removing" \
3446 "\n -f Never prompt" \
3447 "\n -r,-R Remove directories recursively" \
3448
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003449#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003450 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003451
Eric Andersen7e9276b2001-02-22 01:15:47 +00003452#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003453 "[OPTION]... DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003454#define rmdir_full_usage "\n\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003455 "Remove the DIRECTORY, if it is empty.\n" \
3456 "\nOptions:" \
3457 USE_FEATURE_RMDIR_LONG_OPTIONS( \
3458 "\n -p|--parents Include parents" \
3459 "\n -ignore-fail-on-non-empty" \
3460 ) \
3461 SKIP_FEATURE_RMDIR_LONG_OPTIONS( \
3462 "\n -p Include parents" \
3463 )
3464
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003465#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003466 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003467
Eric Andersen7e9276b2001-02-22 01:15:47 +00003468#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003469 "[OPTION]... [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003470#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003471 "Unload the specified kernel modules from the kernel\n" \
3472 "\nOptions:" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003473 "\n -w Wait until the module is no longer used" \
3474 "\n -f Force unloading" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003475 "\n -a Remove all unused modules (recursively)" \
3476
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003477#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003478 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003479
Eric Andersen7e9276b2001-02-22 01:15:47 +00003480#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003481 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003482#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003483 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003484 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003485 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003486 "\n -e Display other/more information" \
3487 "\n -A inet" USE_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003488
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003489#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003490 "-i -q[ildc]p package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003491#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003492 "Manipulate RPM packages\n" \
3493 "\nOptions:" \
3494 "\n -i Install package" \
3495 "\n -q Query package" \
3496 "\n -p Query uninstalled package" \
3497 "\n -i Show information" \
3498 "\n -l List contents" \
3499 "\n -d List documents" \
3500 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003501
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003502#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003503 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003504#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003505 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003506
Mike Frysinger6b160e42008-02-15 02:27:19 +00003507#define rtcwake_trivial_usage \
3508 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SECS | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003509#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003510 "Enter a system sleep state until specified wakeup time\n" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003511 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003512 "\n -a,--auto Read clock mode from adjtime" \
3513 "\n -l,--local Clock is set to local time" \
3514 "\n -u,--utc Clock is set to UTC time" \
3515 "\n -d,--device=DEV Specify the RTC device" \
Mike Frysinger1e93f3c2008-06-04 10:33:33 +00003516 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003517 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
3518 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003519 ) \
3520 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003521 "\n -a Read clock mode from adjtime" \
3522 "\n -l Clock is set to local time" \
3523 "\n -u Clock is set to UTC time" \
3524 "\n -d DEV Specify the RTC device" \
3525 "\n -m MODE Set the sleep state (default: standby)" \
3526 "\n -s SEC Set the timeout in SEC seconds from now" \
3527 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003528 )
3529
Denis Vlasenko49622d72007-03-10 16:58:49 +00003530#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003531 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3532 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003533#define runcon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003534 "Run a program in a different security context\n" \
3535 "\n CONTEXT Complete security context\n" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003536 USE_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003537 "\n -c,--compute Compute process transition context before modifying" \
3538 "\n -t,--type=TYPE Type (for same role as parent)" \
3539 "\n -u,--user=USER User identity" \
3540 "\n -r,--role=ROLE Role" \
3541 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003542 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003543 SKIP_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003544 "\n -c Compute process transition context before modifying" \
3545 "\n -t TYPE Type (for same role as parent)" \
3546 "\n -u USER User identity" \
3547 "\n -r ROLE Role" \
3548 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003549 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003550
Eric Andersen6cf47a72001-10-31 10:24:36 +00003551#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003552 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003553#define run_parts_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003554 "Run a bunch of scripts in a directory\n" \
3555 "\nOptions:" \
3556 "\n -t Print what would be run, but don't actually run anything" \
3557 "\n -a ARG Pass ARG as argument for every program" \
3558 "\n -u MASK Set the umask to MASK before running every program" \
3559 USE_FEATURE_RUN_PARTS_FANCY( \
3560 "\n -l Print names of all matching files even if they are not executable" \
3561 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003562
3563#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003564 "$ run-parts -a start /etc/init.d\n" \
3565 "$ run-parts -a stop=now /etc/init.d\n\n" \
3566 "Let's assume you have a script foo/dosomething:\n" \
3567 "#!/bin/sh\n" \
3568 "for i in $*; do eval $i; done; unset i\n" \
3569 "case \"$1\" in\n" \
3570 "start*) echo starting something;;\n" \
3571 "stop*) set -x; shutdown -h $stop;;\n" \
3572 "esac\n\n" \
3573 "Running this yields:\n" \
3574 "$run-parts -a stop=+4m foo/\n" \
3575 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003576
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003577#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003578 "[utmp]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003579#define runlevel_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003580 "Find the current and previous system runlevel.\n\n" \
3581 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003582 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003583#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003584 "$ runlevel /var/run/utmp\n" \
3585 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003586
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003587#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003588 "dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003589#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003590 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003591
3592#define runsvdir_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003593 "[-P] [-s SCRIPT] dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003594#define runsvdir_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003595 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
3596 "\n -P Put each runsv in a new session" \
3597 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003598
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003599#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003600 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003601#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003602 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003603#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003604 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003605
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003606#define script_trivial_usage \
3607 "[-afq] [-c COMMAND] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003608#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003609 "Options:" \
3610 "\n -a Append output" \
3611 "\n -c Run COMMAND, not shell" \
3612 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003613 "\n -q Quiet" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003614
Eric Andersen7e9276b2001-02-22 01:15:47 +00003615#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003616 "[-efinr] pattern [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003617#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003618 "Options:" \
3619 "\n -e script Add the script to the commands to be executed" \
3620 "\n -f scriptfile Add scriptfile contents to the" \
3621 "\n commands to be executed" \
3622 "\n -i Edit files in-place" \
3623 "\n -n Suppress automatic printing of pattern space" \
3624 "\n -r Use extended regular expression syntax" \
3625 "\n" \
3626 "\nIf no -e or -f is given, the first non-option argument is taken as the sed" \
3627 "\nscript to interpret. All remaining arguments are names of input files; if no" \
3628 "\ninput files are specified, then the standard input is read. Source files" \
3629 "\nwill not be modified unless -i option is given." \
Eric Andersenf802ff72004-04-12 15:12:06 +00003630
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003631#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003632 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3633 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003634
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003635#define selinuxenabled_trivial_usage NOUSAGE_STR
3636#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003637
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003638#define sendmail_trivial_usage \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003639 "[OPTIONS] [rcpt]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003640#define sendmail_full_usage "\n\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003641 "Send an email\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003642 "\nOptions:" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003643 "\n -w timeout Network timeout" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003644 "\n -N type Request delivery notification. Type is ignored" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003645 "\n -f sender Sender" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003646 "\n -F fullname Sender full name. Overrides $NAME" \
3647 USE_FEATURE_SENDMAIL_MAILX( \
3648 "\n -s subject Subject" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003649 "\n -j charset Assume charset for body and subject (" CONFIG_FEATURE_MIME_CHARSET ")" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003650 "\n -a file File to attach. May be multiple" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003651 "\n -H \"prog args...\" Use external connection helper. E.g. openssl for secure servers" \
3652 "\n -S server[:port] Server" \
3653 ) \
3654 USE_FEATURE_SENDMAIL_MAILXX( \
3655 "\n -c rcpt Cc: recipient. May be multiple" \
Denis Vlasenko2b2d9772008-09-28 13:50:57 +00003656 "\n -e rcpt Errors-To: recipient" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003657 ) \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003658 "\n -t Read recipients and subject from body" \
3659 "\n" \
3660 "\nOther options are silently ignored; -oi is implied" \
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003661
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003662#define seq_trivial_usage \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003663 "[-w] [-s SEP] [FIRST [INC]] LAST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003664#define seq_full_usage "\n\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003665 "Print numbers from FIRST to LAST, in steps of INC.\n" \
3666 "FIRST, INC default to 1\n" \
3667 "\nOptions:" \
3668 "\n -w Pad to last with leading zeros" \
3669 "\n -s SEP String separator" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003670
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003671#define sestatus_trivial_usage \
3672 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003673#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003674 " -v Verbose" \
3675 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003676
Paul Foxfc2256a2005-08-01 18:12:30 +00003677#define setconsole_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003678 "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003679#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003680 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3681 "\nOptions:" \
3682 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003683
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003684#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003685 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003686#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003687
Denis Vlasenko397137b2007-07-23 14:03:30 +00003688#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003689 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003690 USE_FEATURE_SETFILES_CHECK_OPTION( \
3691 " [-c policyfile] spec_file" \
3692 ) \
3693 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003694#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003695 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003696 USE_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003697 "\n -c file Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003698 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003699 "\n -d Show which specification matched each file" \
3700 "\n -l Log changes in file labels to syslog" \
3701 "\n -n Don't change any file labels" \
3702 "\n -q Suppress warnings" \
3703 "\n -r dir Use an altenate root path" \
3704 "\n -e dir Exclude directory" \
3705 "\n -F Force reset of context to match file_context for customizable files" \
3706 "\n -o file Save list of files with incorrect context" \
3707 "\n -s Take a list of files from standard input (instead of command line)" \
3708 "\n -v Show changes in file labels, if type or role are changing" \
3709 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3710 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003711
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003712#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003713 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003714#define setfont_full_usage "\n\n" \
3715 "Load a console font\n" \
3716 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003717 "\n -m MAPFILE Load console screen map" \
3718 "\n -C TTY Affect TTY instead of /dev/tty" \
3719
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003720#define setfont_example_usage \
3721 "$ setfont -m koi8-r /etc/i18n/fontname\n"
3722
Eric Andersen7e9276b2001-02-22 01:15:47 +00003723#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003724 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003725#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003726 "Set entries into the kernel's scancode-to-keycode map,\n" \
3727 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3728 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003729 "and KEYCODE is given in decimal" \
3730
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003731#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003732 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003733
Rob Landley87848d92006-03-27 23:23:43 +00003734#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003735 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003736#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003737 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003738
Denis Vlasenkobe039372007-10-14 04:48:44 +00003739#define setsebool_trivial_usage \
3740 "boolean value"
3741
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003742#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00003743 "Change boolean setting"
3744
Paul Fox42403642005-08-01 22:52:09 +00003745#define setsid_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003746 "PROG [ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003747#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003748 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3749 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3750 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003751
Matt Kraai2d91deb2001-08-01 17:21:35 +00003752#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003753 "[FILE]...\n" \
3754 "or: sh -c command [args]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003755#define lash_full_usage "\n\n" \
Denis Vlasenko96702ca2007-11-23 23:28:55 +00003756 "lash is deprecated, please use hush"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003757
Eric Andersen2e9c2572003-08-08 22:26:06 +00003758#define last_trivial_usage \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003759 ""USE_FEATURE_LAST_FANCY("[-HW] [-f file]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003760#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003761 "Show listing of the last users that logged into the system" \
3762 USE_FEATURE_LAST_FANCY( "\n" \
3763 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00003764/* "\n -H Show header line" */ \
3765 "\n -W Display with no host column truncation" \
3766 "\n -f file Read from file instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003767 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00003768
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00003769#define showkey_trivial_usage \
3770 "[-a | -k | -s]"
3771#define showkey_full_usage "\n\n" \
3772 "Show keys pressed\n" \
3773 "\nOptions:" \
3774 "\n -a Display decimal/octal/hex values of the keys" \
3775 "\n -k Display interpreted keycodes (default)" \
3776 "\n -s Display raw scan-codes" \
3777
Denis Vlasenko14923db2007-06-20 15:23:03 +00003778#define slattach_trivial_usage \
3779 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003780#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003781 "Attach network interface(s) to serial line(s)\n" \
3782 "\nOptions:" \
3783 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3784 "\n -s Set line speed" \
3785 "\n -e Exit after initializing device" \
3786 "\n -h Exit when the carrier is lost" \
3787 "\n -c Execute a command when the line is hung up" \
3788 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3789 "\n -L Enable 3-wire operation" \
3790 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003791
Eric Andersen7e9276b2001-02-22 01:15:47 +00003792#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003793 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003794#define sleep_full_usage "\n\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003795 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003796 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003797 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003798 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003799#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003800 "$ sleep 2\n" \
3801 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003802 USE_FEATURE_FANCY_SLEEP( \
3803 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003804 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003805
Eric Andersen7e9276b2001-02-22 01:15:47 +00003806#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003807 "[-nru" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003808 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003809 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003810#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003811 "Sort lines of text\n" \
3812 "\nOptions:" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003813 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003814 "\n -b Ignore leading blanks" \
3815 "\n -c Check whether input is sorted" \
3816 "\n -d Dictionary order (blank or alphanumeric only)" \
3817 "\n -f Ignore case" \
3818 "\n -g General numerical sort" \
3819 "\n -i Ignore unprintable characters" \
3820 "\n -k Sort key" \
3821 "\n -M Sort month" \
3822 ) \
3823 "\n -n Sort numbers" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003824 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003825 "\n -o Output to file" \
3826 "\n -k Sort by key" \
3827 "\n -t CHAR Key separator" \
3828 ) \
3829 "\n -r Reverse sort order" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003830 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003831 "\n -s Stable (don't sort ties alphabetically)" \
3832 ) \
3833 "\n -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003834 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003835 "\n -z Lines are terminated by NUL, not newline" \
3836 "\n -mST Ignored for GNU compatibility") \
3837
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003838#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003839 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3840 "a\n" \
3841 "b\n" \
3842 "c\n" \
3843 "d\n" \
3844 "e\n" \
3845 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003846 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003847 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3848 "d 2\n" \
3849 "b 2\n" \
3850 "c 3\n" \
3851 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003852 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003853
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003854#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003855 "[OPTION] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003856#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003857 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003858 "\n -b n[k|m] Split by bytes" \
3859 "\n -l n Split by lines" \
3860 "\n -a n Use n letters as suffix" \
3861
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003862#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003863 "$ split TODO foo\n" \
3864 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003865
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003866#define start_stop_daemon_trivial_usage \
Denis Vlasenko7987a182008-07-01 10:00:46 +00003867 "[OPTIONS] [-S|-K] ... [-- arguments...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003868#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003869 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003870 "-K: stop all matching processes.\n" \
3871 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003872 USE_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003873 "\nProcess matching:" \
3874 "\n -u,--user USERNAME|UID Match only this user's processes" \
3875 "\n -n,--name NAME Match processes with NAME" \
3876 "\n in comm field in /proc/PID/stat" \
3877 "\n -x,--exec EXECUTABLE Match processes with this command" \
3878 "\n in /proc/PID/cmdline" \
3879 "\n -p,--pidfile FILE Match a process with PID from the file" \
3880 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003881 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003882 "\n -x,--exec EXECUTABLE Program to run" \
3883 "\n -a,--startas NAME Zeroth argument" \
3884 "\n -b,--background Background" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003885 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003886 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003887 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003888 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
3889 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003890 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003891 "\n -s,--signal SIG Signal to send" \
3892 "\n -t,--test Match only, exit with 0 if a process is found" \
3893 "\nOther:" \
3894 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3895 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003896 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003897 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003898 "\n -q,--quiet Quiet" \
3899 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003900 SKIP_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003901 "\nProcess matching:" \
3902 "\n -u USERNAME|UID Match only this user's processes" \
3903 "\n -n NAME Match processes with NAME" \
3904 "\n in comm field in /proc/PID/stat" \
3905 "\n -x EXECUTABLE Match processes with this command" \
3906 "\n command in /proc/PID/cmdline" \
3907 "\n -p FILE Match a process with PID from the file" \
3908 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003909 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003910 "\n -x EXECUTABLE Program to run" \
3911 "\n -a NAME Zeroth argument" \
3912 "\n -b Background" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003913 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003914 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003915 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003916 "\n -c USER[:[GRP]] Change to user/group" \
3917 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003918 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003919 "\n -s SIG Signal to send" \
3920 "\n -t Match only, exit with 0 if a process is found" \
3921 "\nOther:" \
3922 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3923 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003924 "\n -v Verbose" \
3925 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003926 "\n -q Quiet" \
3927 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003928
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003929#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003930 "[OPTION] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003931#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003932 "Display file (default) or filesystem status\n" \
3933 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003934 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003935 "\n -c fmt Use the specified format" \
3936 ) \
3937 "\n -f Display filesystem status" \
3938 "\n -L Dereference links" \
3939 "\n -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003940 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003941 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003942 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003943 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003944 "\n\nValid format sequences for files:\n" \
3945 " %a Access rights in octal\n" \
3946 " %A Access rights in human readable form\n" \
3947 " %b Number of blocks allocated (see %B)\n" \
3948 " %B The size in bytes of each block reported by %b\n" \
3949 " %d Device number in decimal\n" \
3950 " %D Device number in hex\n" \
3951 " %f Raw mode in hex\n" \
3952 " %F File type\n" \
3953 " %g Group ID of owner\n" \
3954 " %G Group name of owner\n" \
3955 " %h Number of hard links\n" \
3956 " %i Inode number\n" \
3957 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003958 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003959 " %o I/O block size\n" \
3960 " %s Total size, in bytes\n" \
3961 " %t Major device type in hex\n" \
3962 " %T Minor device type in hex\n" \
3963 " %u User ID of owner\n" \
3964 " %U User name of owner\n" \
3965 " %x Time of last access\n" \
3966 " %X Time of last access as seconds since Epoch\n" \
3967 " %y Time of last modification\n" \
3968 " %Y Time of last modification as seconds since Epoch\n" \
3969 " %z Time of last change\n" \
3970 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003971 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003972 " %a Free blocks available to non-superuser\n" \
3973 " %b Total data blocks in file system\n" \
3974 " %c Total file nodes in file system\n" \
3975 " %d Free file nodes in file system\n" \
3976 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003977 USE_SELINUX( \
3978 " %C Security context in SELinux\n" \
3979 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003980 " %i File System ID in hex\n" \
3981 " %l Maximum length of filenames\n" \
3982 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003983 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003984 " %S Fundamental block size (for block counts)\n" \
3985 " %t Type in hex\n" \
3986 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003987 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003988
Eric Andersenef5e8f82002-11-07 02:09:37 +00003989#define strings_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003990 "[-afo] [-n length] [file...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003991#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003992 "Display printable strings in a binary file\n" \
3993 "\nOptions:" \
3994 "\n -a Scan whole file (default)" \
3995 "\n -f Precede strings with filenames" \
3996 "\n -n N At least N characters form a string (default 4)" \
3997 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00003998
Eric Andersen7e9276b2001-02-22 01:15:47 +00003999#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004000 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004001#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004002 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004003 "and deviations from stty sane\n" \
4004 "\nOptions:" \
4005 "\n -F DEVICE Open device instead of stdin" \
4006 "\n -a Print all current settings in human-readable form" \
4007 "\n -g Print in stty-readable form" \
4008 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004009
Robert Griebl1fca5582002-06-04 20:45:46 +00004010#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004011 "[OPTION]... [-] [username]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004012#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004013 "Change user id or become root\n" \
4014 "\nOptions:" \
4015 "\n -p, -m Preserve environment" \
4016 "\n -c Command to pass to 'sh -c'" \
4017 "\n -s Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00004018
Eric Andersen27f64e12002-06-23 04:24:25 +00004019#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004020 "[OPTION]... [tty-device]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004021#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004022 "Single user login\n" \
4023 "\nOptions:" \
4024 "\n -t Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004025
Mike Frysinger95d3c452005-04-21 23:29:24 +00004026#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004027 "[rs] [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004028#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004029 "Checksum and count the blocks in a file\n" \
4030 "\nOptions:" \
4031 "\n -r Use BSD sum algorithm (1K blocks)" \
4032 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00004033
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004034#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004035 "[-v] [-w sec] command service..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004036#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004037 "Control services monitored by runsv supervisor.\n" \
4038 "Commands (only first character is enough):\n" \
4039 "\n" \
4040 "status: query service status\n" \
4041 "up: if service isn't running, start it. If service stops, restart it\n" \
4042 "once: like 'up', but if service stops, don't restart it\n" \
4043 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004044 " if it exists. After it stops, do not restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004045 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004046 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004047 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004048 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004049
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004050#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004051 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004052#define svlogd_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004053 "Continuously read log data from standard input, optionally " \
4054 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko397de612008-03-17 08:55:44 +00004055 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004056
Eric Andersen7e9276b2001-02-22 01:15:47 +00004057#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004058 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004059#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004060 "Stop swapping on DEVICE\n" \
4061 "\nOptions:" \
4062 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004063
Eric Andersen7e9276b2001-02-22 01:15:47 +00004064#define swapon_trivial_usage \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004065 "[-a]" USE_FEATURE_SWAPON_PRI(" [-p pri]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004066#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004067 "Start swapping on DEVICE\n" \
4068 "\nOptions:" \
4069 "\n -a Start swapping on all swap devices" \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004070 USE_FEATURE_SWAPON_PRI( \
4071 "\n -p pri Set swap device priority" \
4072 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004073
Rob Landley0f34a822005-10-27 22:55:50 +00004074#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004075 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004076#define switch_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004077 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004078 "and exec NEW_INIT\n" \
4079 "\nOptions:" \
4080 "\n -c Redirect console to device on new root" \
Rob Landley0f34a822005-10-27 22:55:50 +00004081
Eric Andersen7e9276b2001-02-22 01:15:47 +00004082#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004083 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004084#define sync_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004085 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004086
Eric Andersenb9050282003-12-24 06:02:11 +00004087#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004088 "[OPTIONS]... [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004089#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004090 "Configure kernel parameters at runtime\n" \
4091 "\nOptions:" \
4092 "\n -n Disable printing of key names" \
4093 "\n -e Don't warn about unknown keys" \
4094 "\n -w Change sysctl setting" \
4095 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
4096 "\n -a Display all values" \
4097 "\n -A Display all values in table form" \
4098
Eric Andersen5d38f5b2005-09-12 21:42:48 +00004099#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00004100 "sysctl [-n] [-e] variable...\n" \
4101 "sysctl [-n] [-e] -w variable=value...\n" \
4102 "sysctl [-n] [-e] -a\n" \
4103 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
4104 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00004105
Eric Andersen7e9276b2001-02-22 01:15:47 +00004106#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004107 "[OPTION]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004108#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004109 "System logging utility.\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004110 "Note that this version of syslogd ignores /etc/syslog.conf.\n" \
4111 "\nOptions:" \
4112 "\n -n Run in foreground" \
4113 "\n -O FILE Log to given file (default=/var/log/messages)" \
4114 "\n -l n Set local log level" \
4115 "\n -S Smaller logging output" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004116 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004117 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
4118 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004119 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004120 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
4121 "\n -L Log locally and via network (default is network only if -R)") \
4122 USE_FEATURE_SYSLOGD_DUP( \
4123 "\n -D Drop duplicates") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004124 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004125 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00004126 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004127/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00004128
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004129#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004130 "$ syslogd -R masterlog:514\n" \
4131 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004132
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004133#define tac_trivial_usage \
4134 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004135#define tac_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004136 "Concatenate FILE(s) and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004137
Eric Andersen7e9276b2001-02-22 01:15:47 +00004138#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004139 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004140#define tail_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004141 "Print last 10 lines of each FILE to standard output.\n" \
4142 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004143 "file name. With no FILE, or when FILE is -, read standard input.\n" \
4144 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004145 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004146 "\n -c N[kbm] Output the last N bytes") \
4147 "\n -n N[kbm] Print last N lines instead of last 10" \
4148 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004149 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004150 "\n -q Never output headers giving file names" \
4151 "\n -s SEC Wait SEC seconds between reads with -f" \
4152 "\n -v Always output headers giving file names" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004153 "\n" \
4154 "\nIf the first character of N (bytes or lines) is a '+', output begins with" \
4155 "\nthe Nth item from the start of each file, otherwise, print the last N items" \
4156 "\nin the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004157
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004158#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004159 "$ tail -n 1 /etc/resolv.conf\n" \
4160 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004161
Eric Andersen7e9276b2001-02-22 01:15:47 +00004162#define tar_trivial_usage \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004163 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_SEAMLESS_GZ("z") \
4164 USE_FEATURE_SEAMLESS_BZ2("j") USE_FEATURE_SEAMLESS_LZMA("a") \
4165 USE_FEATURE_SEAMLESS_Z("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00004166 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004167 "[-f TARFILE] [-C DIR] [FILE(s)]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004168#define tar_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004169 "Create, extract, or list files from a tar file\n" \
4170 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004171 USE_FEATURE_TAR_CREATE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004172 "\n c Create") \
4173 "\n x Extract" \
4174 "\n t List" \
4175 "\nArchive format selection:" \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004176 USE_FEATURE_SEAMLESS_GZ( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004177 "\n z Filter the archive through gzip" \
4178 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004179 USE_FEATURE_SEAMLESS_BZ2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004180 "\n j Filter the archive through bzip2" \
4181 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004182 USE_FEATURE_SEAMLESS_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004183 "\n a Filter the archive through lzma" \
4184 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004185 USE_FEATURE_SEAMLESS_Z( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004186 "\n Z Filter the archive through compress" \
4187 ) \
4188 "\nFile selection:" \
4189 "\n f Name of TARFILE or \"-\" for stdin" \
4190 "\n O Extract to stdout" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004191 USE_FEATURE_TAR_FROM( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004192 "\n exclude File to exclude" \
4193 "\n X File with names to exclude" \
4194 ) \
4195 "\n C Change to directory DIR before operation" \
4196 "\n v Verbose" \
4197
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004198#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004199 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
4200 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004201
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004202#define taskset_trivial_usage \
Denis Vlasenkob44c7902008-03-17 09:29:43 +00004203 "[-p] [mask] [pid | command [arg]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004204#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004205 "Set or get CPU affinity\n" \
4206 "\nOptions:" \
4207 "\n -p Operate on an existing PID" \
4208
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004209#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004210 "$ taskset 0x7 ./dgemm_test&\n" \
4211 "$ taskset -p 0x1 $!\n" \
4212 "pid 4790's current affinity mask: 7\n" \
4213 "pid 4790's new affinity mask: 1\n" \
4214 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4215 "pid 6671's current affinity mask: 1\n" \
4216 "pid 6671's new affinity mask: 1\n" \
4217 "$ taskset -p 1\n" \
4218 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004219
Eric Andersen7e9276b2001-02-22 01:15:47 +00004220#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004221 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004222#define tee_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004223 "Copy standard input to each FILE, and also to standard output\n" \
4224 "\nOptions:" \
4225 "\n -a Append to the given FILEs, do not overwrite" \
4226 "\n -i Ignore interrupt signals (SIGINT)" \
4227
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004228#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004229 "$ echo \"Hello\" | tee /tmp/foo\n" \
4230 "$ cat /tmp/foo\n" \
4231 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004232
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004233#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004234#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004235 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004236#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004237 "Connect to telnet server\n" \
4238 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004239 "\n -a Automatic login with $USER variable" \
4240 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004241
Eric Andersen539ffc92004-02-22 12:25:47 +00004242#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004243#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004244 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004245#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004246 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004247#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004248
Eric Andersen08a72202002-09-30 20:52:10 +00004249#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004250 "[OPTION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004251#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004252 "Handle incoming telnet connections" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004253 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
4254 "\nOptions:" \
4255 "\n -l LOGIN Exec LOGIN on connect" \
4256 "\n -f issue_file Display issue_file instead of /etc/issue" \
4257 "\n -K Close connection as soon as login exits" \
4258 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004259 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004260 "\n -p PORT Port to listen on" \
4261 "\n -b ADDR Address to bind to" \
4262 "\n -F Run in foreground" \
4263 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004264 )
Eric Andersen08a72202002-09-30 20:52:10 +00004265
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004266/* "test --help" does not print help (POSIX compat), only "[ --help" does.
4267 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION") */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004268#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004269 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004270#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004271 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4272 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004273#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004274 "$ test 1 -eq 2\n" \
4275 "$ echo $?\n" \
4276 "1\n" \
4277 "$ test 1 -eq 1\n" \
4278 "$ echo $?\n" \
4279 "0\n" \
4280 "$ [ -d /etc ]\n" \
4281 "$ echo $?\n" \
4282 "0\n" \
4283 "$ [ -d /junk ]\n" \
4284 "$ echo $?\n" \
4285 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004286
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004287#define tc_trivial_usage \
4288 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
4289#define tc_full_usage "\n\n" \
4290 "OBJECT: {qdisc|class|filter}\n" \
4291 "CMD: {add|del|change|replace|show}\n" \
4292 "\n" \
4293 "qdisc [ handle QHANDLE ] [ root |"USE_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
4294 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4295 "\t[ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4296 "\tQDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
4297 "qdisc show [ dev STRING ]"USE_FEATURE_TC_INGRESS(" [ingress]")"\n" \
4298 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
4299 "\t[ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4300 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
4301 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
4302 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4303 "\t[ root | classid CLASSID ] [ handle FILTERID ]\n" \
4304 "\t[ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
4305 "filter show [ dev STRING ] [ root | parent CLASSID ]"
4306
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004307#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004308 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004309/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004310/* "[-hpEvv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] [-i dir|-x cdb] [-t sec] ip port prog..." */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004311#define tcpsvd_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004312 "Create TCP socket, bind it to ip:port and listen\n" \
4313 "for incoming connection. Run PROG for each connection.\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004314 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004315 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004316 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004317 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4318 "\n-u user[:group] Change to user/group after bind" \
4319 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004320 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004321 "\n-C n[:msg] Allow only up to n connections from the same IP" \
4322 "\n New connections from this IP address are closed" \
4323 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004324 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004325 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004326 "\n-v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004327
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004328#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00004329 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004330#define udpsvd_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004331 "Create UDP socket, bind it to ip:port and wait\n" \
4332 "for incoming packets. Run PROG for each packet,\n" \
4333 "redirecting all further packets with same peer ip:port to it\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004334 "\nip IP to listen on. '0' = all" \
4335 "\nport Port to listen on" \
4336 "\nprog [arg] Program to run" \
4337 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4338 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004339 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004340 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004341 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004342 "\n-v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004343
Mark Whitley450736c2001-03-02 19:08:50 +00004344#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004345 "[OPTION]... HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004346#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004347 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004348 "\nOptions:" \
4349 "\n -l FILE Local FILE" \
4350 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004351 USE_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004352 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004353 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004354 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004355 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004356 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004357 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004358 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004359 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004360
4361#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004362 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004363#define tftpd_full_usage "\n\n" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004364 "Transfer a file on tftp client's request.\n" \
Denis Vlasenko91f8f822008-10-30 23:42:37 +00004365 "\n" \
4366 "tftpd should be used as an inetd service.\n" \
4367 "tftpd's line for inetd.conf:\n" \
4368 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
4369 "It also can be ran from udpsvd:\n" \
4370 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004371 "\nOptions:" \
4372 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004373 "\n -c Allow file creation via upload" \
4374 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004375
Eric Andersenc3657422001-11-30 07:54:32 +00004376#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004377 "[OPTION]... COMMAND [ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004378#define time_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004379 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004380 "COMMAND's resource usage information is displayed.\n" \
4381 "\nOptions:" \
4382 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004383
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004384#define timeout_trivial_usage \
4385 "[-t SECS] [-s SIG] PROG [ARGS]"
4386#define timeout_full_usage "\n\n" \
4387 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
Denis Vlasenko42404082008-11-24 13:42:24 +00004388 "Defaults: SECS: 10, SIG: TERM." \
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004389
Eric Andersen420b2082002-09-17 22:14:58 +00004390#define top_trivial_usage \
Denis Vlasenko42cc6ba2008-09-25 11:17:10 +00004391 "[-b] [-nCOUNT] [-dSECONDS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004392#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004393 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004394 "Read the status of all processes from /proc each SECONDS\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004395 "and show the status for however many processes will fit on the screen." \
Eric Andersen420b2082002-09-17 22:14:58 +00004396
Eric Andersen7e9276b2001-02-22 01:15:47 +00004397#define touch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004398 "[-c] FILE [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004399#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004400 "Update the last-modified date on the given FILE[s]\n" \
4401 "\nOptions:" \
4402 "\n -c Do not create any files" \
4403
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004404#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004405 "$ ls -l /tmp/foo\n" \
4406 "/bin/ls: /tmp/foo: No such file or directory\n" \
4407 "$ touch /tmp/foo\n" \
4408 "$ ls -l /tmp/foo\n" \
4409 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004410
4411#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004412 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004413#define tr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004414 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004415 "standard input, writing to standard output\n" \
4416 "\nOptions:" \
4417 "\n -c Take complement of STRING1" \
4418 "\n -d Delete input characters coded STRING1" \
4419 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4420
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004421#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004422 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4423 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004424
Eric Andersen5c58d282001-07-10 16:29:00 +00004425#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004426 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
4427 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004428 " [-z pausemsecs] HOST [data size]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004429#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004430 "Trace the route to HOST\n" \
4431 "\nOptions:" \
4432 "\n -F Set the don't fragment bit" \
4433 "\n -I Use ICMP ECHO instead of UDP datagrams" \
4434 "\n -l Display the ttl value of the returned packet" \
4435 "\n -d Set SO_DEBUG options to socket" \
4436 "\n -n Print hop addresses numerically rather than symbolically" \
4437 "\n -r Bypass the normal routing tables and send directly to a host" \
4438 "\n -v Verbose" \
4439 "\n -m max_ttl Max time-to-live (max number of hops)" \
4440 "\n -p port# Base UDP port number used in probes" \
4441 "\n (default is 33434)" \
4442 "\n -q nqueries Number of probes per 'ttl' (default 3)" \
4443 "\n -s src_addr IP address to use as the source address" \
4444 "\n -t tos Type-of-service in probe packets (default 0)" \
4445 "\n -w wait Time in seconds to wait for a response" \
4446 "\n (default 3 sec)" \
4447 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004448
Eric Andersen7e9276b2001-02-22 01:15:47 +00004449#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004450 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004451#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004452 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004453#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004454 "$ true\n" \
4455 "$ echo $?\n" \
4456 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004457
Eric Andersen7e9276b2001-02-22 01:15:47 +00004458#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004459 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004460#define tty_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004461 "Print file name of standard input's terminal" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004462 USE_INCLUDE_SUSv2( "\n" \
4463 "\nOptions:" \
4464 "\n -s Print nothing, only return exit status" \
4465 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004466#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004467 "$ tty\n" \
4468 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004469
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004470#define ttysize_trivial_usage \
4471 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004472#define ttysize_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004473 "Print dimension(s) of standard input's terminal, on error return 80x25"
4474
Denis Vlasenko39b68132009-01-23 02:07:14 +00004475#define tunctl_trivial_usage \
4476 "[-f device] ([-t name] | -d name)" USE_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]")
4477#define tunctl_full_usage "\n\n" \
4478 "Create or delete tun interfaces" \
4479 "\nOptions:" \
4480 "\n -f name tun device (/dev/net/tun)" \
4481 "\n -t name Create iface 'name'" \
4482 "\n -d name Delete iface 'name'" \
4483USE_FEATURE_TUNCTL_UG( \
4484 "\n -u owner Set iface owner" \
4485 "\n -g group Set iface group" \
4486 "\n -b Brief output" \
4487)
4488#define tunctl_example_usage \
4489 "# tunctl\n" \
4490 "# tunctl -d tun0\n"
4491
Mike Frysinger174808c2005-06-11 01:14:09 +00004492#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004493 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
4494 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
4495 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
4496 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
4497 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
4498 "[-T last-check-time] [-U UUID] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004499#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004500 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004501
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004502#define udhcpc_trivial_usage \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004503 "[-Cfbnqtvo] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004504 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." USE_FEATURE_UDHCP_PORT(" [-P N]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004505#define udhcpc_full_usage "\n\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004506 USE_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004507 " -V,--vendorclass=CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004508 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
4509 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
4510 "\n -c,--clientid=CLIENTID Client identifier" \
4511 "\n -C,--clientid-none Suppress default client identifier" \
4512 "\n -p,--pidfile=file Create pidfile" \
4513 "\n -r,--request=IP IP address to request" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +00004514 "\n -s,--script=file Run file at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004515 "\n -t,--retries=N Send up to N request packets" \
4516 "\n -T,--timeout=N Try to get a lease for N seconds (default 3)" \
4517 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004518 "\n -O,--request-option=OPT Request DHCP option OPT (cumulative)" \
4519 "\n -o,--no-default-options Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004520 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004521 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004522 "\n -b,--background Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004523 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004524 "\n -S,--syslog Log to syslog too" \
4525 "\n -n,--now Exit with failure if lease is not immediately obtained" \
4526 "\n -q,--quit Quit after obtaining lease" \
4527 "\n -R,--release Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004528 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004529 "\n -P,--client-port N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004530 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004531 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004532 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004533 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004534 ) \
4535 SKIP_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004536 " -V CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004537 "\n -i INTERFACE Interface to use (default: eth0)" \
4538 "\n -H,-h HOSTNAME Client hostname" \
4539 "\n -c CLIENTID Client identifier" \
4540 "\n -C Suppress default client identifier" \
4541 "\n -p file Create pidfile" \
4542 "\n -r IP IP address to request" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +00004543 "\n -s file Run file at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004544 "\n -t N Send up to N request packets" \
4545 "\n -T N Try to get a lease for N seconds (default 3)" \
4546 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004547 "\n -O OPT Request DHCP option OPT (cumulative)" \
4548 "\n -o Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004549 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004550 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004551 "\n -b Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004552 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004553 "\n -S Log to syslog too" \
4554 "\n -n Exit with failure if lease is not immediately obtained" \
4555 "\n -q Quit after obtaining lease" \
4556 "\n -R Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004557 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004558 "\n -P N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004559 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004560 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004561 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004562 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004563 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004564
Russ Dill61fb4892002-10-14 21:41:28 +00004565#define udhcpd_trivial_usage \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004566 "[-fS]" USE_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004567
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004568#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004569 "DHCP server\n" \
4570 "\n -f Run in foreground" \
4571 "\n -S Log to syslog too" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004572 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004573 "\n -P N Use port N instead of default 67" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004574 )
Russ Dill61fb4892002-10-14 21:41:28 +00004575
Eric Andersen7e9276b2001-02-22 01:15:47 +00004576#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004577 "[flags] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004578#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004579 "Unmount file systems\n" \
4580 "\nOptions:" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00004581 USE_FEATURE_UMOUNT_ALL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004582 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
4583 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004584 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004585 "\n -n Don't erase /etc/mtab entries" \
4586 ) \
4587 "\n -r Try to remount devices as read-only if mount is busy" \
4588 "\n -l Lazy umount (detach filesystem)" \
4589 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004590 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004591 "\n -d Free loop device if it has been used" \
4592 )
4593
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004594#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004595 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004596
4597#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004598 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004599#define uname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004600 "Print system information.\n" \
4601 "\nOptions:" \
4602 "\n -a Print all" \
4603 "\n -m The machine (hardware) type" \
4604 "\n -n Hostname" \
4605 "\n -r OS release" \
4606 "\n -s OS name (default)" \
4607 "\n -p Processor type" \
4608 "\n -v OS version" \
4609
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004610#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004611 "$ uname -a\n" \
4612 "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 +00004613
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004614#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004615 "[-c] [-f] [name...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004616#define uncompress_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004617 "Uncompress .Z file[s]\n" \
4618 "\nOptions:" \
4619 "\n -c Extract to stdout" \
4620 "\n -f Overwrite an existing file" \
Tim Riker7b253f82003-12-28 05:02:40 +00004621
Denis Vlasenko3952f202007-08-13 14:10:24 +00004622#define unexpand_trivial_usage \
4623 "[-f][-a][-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004624#define unexpand_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004625 "Convert spaces to tabs, writing to standard output.\n" \
4626 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004627 USE_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004628 "\n -a,--all Convert all blanks" \
4629 "\n -f,--first-only Convert only leading blanks" \
4630 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004631 ) \
4632 SKIP_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004633 "\n -a Convert all blanks" \
4634 "\n -f Convert only leading blanks" \
4635 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004636 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004637
Eric Andersen7e9276b2001-02-22 01:15:47 +00004638#define uniq_trivial_usage \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004639 "[-fscduw]... [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004640#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004641 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004642 "\nOptions:" \
4643 "\n -c Prefix lines by the number of occurrences" \
4644 "\n -d Only print duplicate lines" \
4645 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004646 "\n -f N Skip first N fields" \
4647 "\n -s N Skip first N chars (after any skipped fields)" \
4648 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004649
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004650#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004651 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4652 "a\n" \
4653 "b\n" \
4654 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004655
4656#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004657 "[option] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004658#define unix2dos_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004659 "Convert FILE from unix to dos format.\n" \
4660 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00004661 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004662 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004663 "\n -d unix2dos" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004664
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004665#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004666 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004667#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004668 "Extract files from ZIP archives\n" \
4669 "\nOptions:" \
4670 "\n -l List archive contents (with -q for short form)" \
4671 "\n -n Never overwrite existing files (default)" \
4672 "\n -o Overwrite files without prompting" \
4673 "\n -p Send output to stdout" \
4674 "\n -q Quiet" \
4675 "\n -x Exclude these files" \
4676 "\n -d Extract files into this directory" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004677
Eric Andersen7e9276b2001-02-22 01:15:47 +00004678#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004679 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004680#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004681 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004682
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004683#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004684 "$ uptime\n" \
4685 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004686
4687#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004688 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004689#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004690 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004691
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004692#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004693 "$ usleep 1000000\n" \
4694 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004695
4696#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004697 "[-o outfile] [infile]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004698#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004699 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004700 "Finds outfile name in uuencoded source unless -o is given"
4701
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004702#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004703 "$ uudecode -o busybox busybox.uu\n" \
4704 "$ ls -l busybox\n" \
4705 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004706
4707#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004708 "[-m] [infile] stored_filename"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004709#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004710 "Uuencode a file to stdout\n" \
4711 "\nOptions:" \
4712 "\n -m Use base64 encoding per RFC1521" \
4713
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004714#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004715 "$ uuencode busybox busybox\n" \
4716 "begin 755 busybox\n" \
4717 "<encoded file snipped>\n" \
4718 "$ uudecode busybox busybox > busybox.uu\n" \
4719 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004720
Eric Andersen853c4942003-01-23 05:59:32 +00004721#define vconfig_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004722 "COMMAND [OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004723#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004724 "Create and remove virtual ethernet devices\n" \
4725 "\nOptions:" \
4726 "\n add [interface-name] [vlan_id]" \
4727 "\n rem [vlan-name]" \
4728 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4729 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4730 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4731 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004732
Eric Andersen3f980402001-04-04 17:31:15 +00004733#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004734 "[OPTION] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004735#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004736 "Edit FILE\n" \
4737 "\nOptions:" \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004738 USE_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004739 "\n -c Initial command to run ($EXINIT also available)") \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004740 USE_FEATURE_VI_READONLY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004741 "\n -R Read-only - do not write to the file") \
4742 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00004743
Eric Andersen27f64e12002-06-23 04:24:25 +00004744#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004745 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004746#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004747 "Lock a virtual terminal. A password is required to unlock.\n" \
4748 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00004749 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004750
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004751#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00004752 "[-n seconds] [-t] COMMAND..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004753#define watch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004754 "Execute a program periodically\n" \
4755 "\nOptions:" \
4756 "\n -n Loop period in seconds (default 2)" \
4757 "\n -t Don't print header" \
4758
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004759#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004760 "$ watch date\n" \
4761 "Mon Dec 17 10:31:40 GMT 2000\n" \
4762 "Mon Dec 17 10:31:42 GMT 2000\n" \
4763 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004764
Eric Andersen7e9276b2001-02-22 01:15:47 +00004765#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004766 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004767#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004768 "Periodically write to watchdog device DEV\n" \
4769 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004770 "\n -T N Reboot after N seconds if not reset (default 60)" \
4771 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004772 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004773 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004774 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004775
4776#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004777 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004778#define wc_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004779 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004780 "more than one FILE is specified. With no FILE, read standard input.\n" \
4781 "\nOptions:" \
4782 "\n -c Print the byte counts" \
4783 "\n -l Print the newline counts" \
4784 "\n -L Print the length of the longest line" \
4785 "\n -w Print the word counts" \
4786
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004787#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004788 "$ wc /etc/passwd\n" \
4789 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004790
4791#define wget_trivial_usage \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00004792 USE_FEATURE_WGET_LONG_OPTIONS( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004793 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004794 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4795 " [-U|--user-agent agent] url" \
4796 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00004797 SKIP_FEATURE_WGET_LONG_OPTIONS( \
Denis Vlasenko03630782007-10-18 11:11:12 +00004798 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4799 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004800#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004801 "Retrieve files via HTTP or FTP\n" \
4802 "\nOptions:" \
4803 "\n -s Spider mode - only check file existence" \
4804 "\n -c Continue retrieval of aborted transfer" \
4805 "\n -q Quiet" \
4806 "\n -P Set directory prefix to DIR" \
4807 "\n -O Save to filename ('-' for stdout)" \
4808 "\n -U Adjust 'User-Agent' field" \
4809 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004810
4811#define which_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004812 "[COMMAND...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004813#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004814 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004815#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004816 "$ which login\n" \
4817 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004818
Eric Andersen00a6a752002-04-26 23:53:10 +00004819#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004820 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004821#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004822 "Show who is logged on\n" \
4823 "\nOptions:" \
4824 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004825
4826#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004827 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004828#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004829 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004830
4831#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004832 "[OPTIONS] [COMMAND] [ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004833#define xargs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004834 "Execute COMMAND on every item given by standard input\n" \
4835 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004836 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004837 "\n -p Ask user whether to run each command") \
4838 "\n -r Do not run command if input is empty" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004839 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004840 "\n -0 Input is separated by NUL characters") \
4841 "\n -t Print the command on stderr before execution" \
Denis Vlasenkoe82da4d2008-08-21 19:59:30 +00004842 "\n -e[STR] STR stops input processing" \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004843 "\n -n N Pass no more than N args to COMMAND" \
4844 "\n -s N Pass command line of no more than N bytes" \
4845 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
4846 "\n -x Exit if size is exceeded") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004847
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004848#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004849 "$ ls | xargs gzip\n" \
4850 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004851
4852#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004853 "[OPTION]... [STRING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004854#define yes_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004855 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004856
Eric Andersen7e9276b2001-02-22 01:15:47 +00004857#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004858 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004859#define zcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004860 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004861
Rob Landleyad8071f2005-04-30 03:49:37 +00004862#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004863 "[OPTIONS] ifname script"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004864#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004865 "Manage a ZeroConf IPv4 link-local address\n" \
4866 "\nOptions:" \
4867 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004868 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004869 "\n -r 169.254.x.x Request this address first" \
4870 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004871 "\n" \
4872 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
4873 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00004874
Eric Andersen178de172004-04-06 16:36:20 +00004875#endif /* __BB_USAGE_H__ */