blob: 16d5eec9ff567688b867529cac0485088890b303 [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 Vlasenko83518d12009-03-20 22:17:13 +0000534 "-[ti" USE_FEATURE_CPIO_O("o") USE_FEATURE_CPIO_P("p") "dmvu] [-F FILE]" \
535 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" ) \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000539 "\nMain operation mode:" \
540 "\n -t List" \
541 "\n -i Extract" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000542 USE_FEATURE_CPIO_O( \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000543 "\n -o Create" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000544 ) \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000545 USE_FEATURE_CPIO_P( \
546 "\n -p Passthrough" \
547 ) \
548 "\nOptions:" \
549 "\n -d Make leading directories" \
550 "\n -m Preserve mtime" \
551 "\n -v Verbose" \
552 "\n -u Overwrite" \
553 "\n -F Input file" \
554 USE_FEATURE_CPIO_O( \
555 "\n -H Define format" \
556 ) \
Tim Riker7b253f82003-12-28 05:02:40 +0000557
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000558#define crond_trivial_usage \
Denis Vlasenko35a064b2008-11-06 00:49:59 +0000559 "-fbS -l N " USE_FEATURE_CROND_D("-d N ") "-L LOGFILE -c DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000560#define crond_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000561 " -f Foreground" \
562 "\n -b Background (default)" \
563 "\n -S Log to syslog (default)" \
564 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +0000565 USE_FEATURE_CROND_D( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000566 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000567 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000568 "\n -L Log to file" \
569 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000570
571#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000572 "[-c DIR] [-u USER] [-ler]|[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000573#define crontab_full_usage "\n\n" \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000574 " -c Crontab directory" \
575 "\n -u User" \
576 "\n -l List crontab" \
577 "\n -e Edit crontab" \
578 "\n -r Delete crontab" \
579 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000580
Denis Vlasenko2211d522008-11-10 18:52:35 +0000581#define cryptpw_trivial_usage \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000582 "[OPTIONS] [PASSWORD] [SALT]"
583/* We do support -s, we just don't mention it */
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000584#define cryptpw_full_usage "\n\n" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000585 "Crypt the PASSWORD using crypt(3)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000586 "\nOptions:" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000587 USE_GETOPT_LONG( \
588 "\n -P,--password-fd=NUM Read password from fd NUM" \
589/* "\n -s,--stdin Use stdin; like -P0" */ \
590 "\n -m,--method=TYPE Encryption method TYPE" \
591 "\n -S,--salt=SALT" \
592 ) \
593 SKIP_GETOPT_LONG( \
594 "\n -P NUM Read password from fd NUM" \
595/* "\n -s Use stdin; like -P0" */ \
596 "\n -m TYPE Encryption method TYPE" \
597 "\n -S SALT" \
598 ) \
599
600/* mkpasswd is an alias to cryptpw */
601
602#define mkpasswd_trivial_usage \
603 "[OPTIONS] [PASSWORD] [SALT]"
604/* We do support -s, we just don't mention it */
605#define mkpasswd_full_usage "\n\n" \
606 "Crypt the PASSWORD using crypt(3)\n" \
607 "\nOptions:" \
608 USE_GETOPT_LONG( \
609 "\n -P,--password-fd=NUM Read password from fd NUM" \
610/* "\n -s,--stdin Use stdin; like -P0" */ \
611 "\n -m,--method=TYPE Encryption method TYPE" \
612 "\n -S,--salt=SALT" \
613 ) \
614 SKIP_GETOPT_LONG( \
615 "\n -P NUM Read password from fd NUM" \
616/* "\n -s Use stdin; like -P0" */ \
617 "\n -m TYPE Encryption method TYPE" \
618 "\n -S SALT" \
619 ) \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000620
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000621#define cttyhack_trivial_usage NOUSAGE_STR
622#define cttyhack_full_usage ""
623
Eric Andersen7e9276b2001-02-22 01:15:47 +0000624#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000625 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000626#define cut_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000627 "Print selected fields from each input FILE to standard output\n" \
628 "\nOptions:" \
629 "\n -b LIST Output only bytes from LIST" \
630 "\n -c LIST Output only characters from LIST" \
631 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
632 "\n -s Output only the lines containing delimiter" \
633 "\n -f N Print only these fields" \
634 "\n -n Ignored" \
635
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000636#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000637 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
638 "Hello\n" \
639 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
640 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000641
Eric Andersen7e9276b2001-02-22 01:15:47 +0000642#define date_trivial_usage \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000643 "[OPTION]... [+FMT] [TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000644#define date_full_usage "\n\n" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000645 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000646 "\nOptions:" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000647 "\n -u Work in UTC (don't convert to local time)" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000648 "\n -R Output RFC-822 compliant date string" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000649 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000650 "\n -I[SPEC] Output ISO-8601 compliant date string" \
651 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000652 "\n 'hours', 'minutes', or 'seconds' for date and" \
653 "\n time to the indicated precision" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000654 ) \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000655 "\n -d TIME Display TIME, not 'now'" \
656 "\n -r FILE Display last modification time of FILE" \
657 "\n [-s] TIME Set time to TIME" \
658 USE_FEATURE_DATE_ISOFMT( \
659 "\n -D FMT Use FMT for str->date conversion" \
660 ) \
661 "\n" \
662 "\nRecognized formats for TIME:" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000663 "\n hh:mm[:ss]" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000664 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000665 "\n YYYY-MM-DD hh:mm[:ss]" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000666 "\n MMDDhhmm[[YY]YY][.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000667
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000668#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000669 "$ date\n" \
670 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000671
Eric Andersen7e9276b2001-02-22 01:15:47 +0000672#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000673 "expression..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000674#define dc_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +0000675 "Tiny RPN calculator. Operations:\n" \
676 "+, add, -, sub, *, mul, /, div, %, mod, **, exp, and, or, not, eor,\n" \
677 "p - print top of the stack (without altering the stack),\n" \
678 "f - print entire stack, o - pop the value and set output radix\n" \
679 "(value must be 10 or 16).\n" \
680 "Examples: 'dc 2 2 add' -> 4, 'dc 8 8 * 2 2 + /' -> 16.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000681
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000682#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000683 "$ dc 2 2 + p\n" \
684 "4\n" \
685 "$ dc 8 8 \\* 2 2 + / p\n" \
686 "16\n" \
687 "$ dc 0 1 and p\n" \
688 "0\n" \
689 "$ dc 0 1 or p\n" \
690 "1\n" \
691 "$ echo 72 9 div 8 mul p | dc\n" \
692 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000693
Eric Andersen7e9276b2001-02-22 01:15:47 +0000694#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000695 "[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 +0000696 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000697#define dd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000698 "Copy a file with converting and formatting\n" \
699 "\nOptions:" \
700 "\n if=FILE Read from FILE instead of stdin" \
701 "\n of=FILE Write to FILE instead of stdout" \
702 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000703 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000704 "\n ibs=N Read N bytes at a time" \
705 ) \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000706 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000707 "\n obs=N Write N bytes at a time" \
708 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000709 "\n count=N Copy only N input blocks" \
710 "\n skip=N Skip N input blocks" \
711 "\n seek=N Skip N output blocks" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000712 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000713 "\n conv=notrunc Don't truncate output file" \
714 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000715 "\n conv=sync Pad blocks with zeros" \
716 "\n conv=fsync Physically write data out before finishing" \
717 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000718 "\n" \
719 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
720 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
721
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000722#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000723 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
724 "4+0 records in\n" \
725 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000726
Eric Andersen7e9276b2001-02-22 01:15:47 +0000727#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000728 "[N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000729#define deallocvt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000730 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000731
Eric Andersenf349e972001-08-21 16:18:59 +0000732#define delgroup_trivial_usage \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000733 USE_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000734#define delgroup_full_usage "\n\n" \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000735 "Delete group GROUP from the system" \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000736 USE_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000737
738#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000739 "USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000740#define deluser_full_usage "\n\n" \
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000741 "Delete USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000742
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000743#define depmod_trivial_usage NOUSAGE_STR
744#define depmod_full_usage ""
Bernhard Reutner-Fischer55e547e2008-05-26 12:01:49 +0000745
Denis Vlasenkoc94fa562008-10-26 11:08:14 +0000746#define devmem_trivial_usage \
747 "ADDRESS [WIDTH [VALUE]]"
748
749#define devmem_full_usage "\n\n" \
750 "Read/write from physical address\n" \
751 "\n ADDRESS Address to act upon" \
752 "\n WIDTH Width (8/16/...)" \
753 "\n VALUE Data to be written" \
754
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000755#define devfsd_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000756 "mntpnt [-v]" USE_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000757#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000758 "Manage devfs permissions and old device name symlinks\n" \
759 "\nOptions:" \
760 "\n mntpnt The mount point where devfs is mounted" \
761 "\n -v Print the protocol version numbers for devfsd" \
762 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000763 USE_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000764 "\n -fg Run in foreground" \
765 "\n -np Exit after parsing the configuration file" \
766 "\n and processing synthetic REGISTER events," \
767 "\n do not poll for events" \
768 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000769
Eric Andersen7e9276b2001-02-22 01:15:47 +0000770#define df_trivial_usage \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000771 "[-Pk" \
772 USE_FEATURE_HUMAN_READABLE("mh") \
773 USE_FEATURE_DF_FANCY("ai] [-B SIZE") \
774 "] [FILESYSTEM...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000775#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000776 "Print filesystem usage statistics\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000777 "\nOptions:" \
778 "\n -P POSIX output format" \
779 "\n -k 1024-byte blocks (default)" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000780 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000781 "\n -m 1M-byte blocks" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000782 "\n -h Human readable (e.g. 1K 243M 2G)" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000783 ) \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000784 USE_FEATURE_DF_FANCY( \
785 "\n -a Show all filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000786 "\n -i Inodes" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000787 "\n -B SIZE Blocksize" \
788 ) \
789
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000790#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000791 "$ df\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000792 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000793 "/dev/sda3 8690864 8553540 137324 98% /\n" \
794 "/dev/sda1 64216 36364 27852 57% /boot\n" \
795 "$ df /dev/sda3\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000796 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
797 "/dev/sda3 8690864 8553540 137324 98% /\n" \
798 "$ POSIXLY_CORRECT=sure df /dev/sda3\n" \
799 "Filesystem 512B-blocks Used Available Use% Mounted on\n" \
800 "/dev/sda3 17381728 17107080 274648 98% /\n" \
801 "$ POSIXLY_CORRECT=yep df -P /dev/sda3\n" \
802 "Filesystem 512-blocks Used Available Capacity Mounted on\n" \
803 "/dev/sda3 17381728 17107080 274648 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000804
Denis Vlasenko736230e2006-11-20 19:40:36 +0000805#define dhcprelay_trivial_usage \
Bernhard Reutner-Fischer55fb9da2008-05-27 12:42:39 +0000806 "[client1,client2,...] [server_device]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000807#define dhcprelay_full_usage "\n\n" \
Bernhard Reutner-Fischer55fb9da2008-05-27 12:42:39 +0000808 "Relay dhcp requests from client devices to server device.\n" \
809 "Pass clients as CSV"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000810
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000811#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000812 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000813#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000814 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000815 "This implementation supports unified diffs only.\n" \
816 "\nOptions:" \
817 "\n -a Treat all files as text" \
818 "\n -b Ignore changes in the amount of whitespace" \
819 "\n -d Try hard to find a smaller set of changes" \
820 "\n -i Ignore case differences" \
821 "\n -L Use LABEL instead of the filename in the unified header" \
822 "\n -N Treat absent files as empty" \
823 "\n -q Output only whether files differ" \
824 "\n -r Recursively compare subdirectories" \
825 "\n -S Start with FILE when comparing directories" \
826 "\n -T Make tabs line up by prefixing a tab when necessary" \
827 "\n -s Report when two files are the same" \
828 "\n -t Expand tabs to spaces in output" \
829 "\n -U Output LINES lines of context" \
830 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000831
Eric Andersen7e9276b2001-02-22 01:15:47 +0000832#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000833 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000834#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000835 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000836#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000837 "$ dirname /tmp/foo\n" \
838 "/tmp\n" \
839 "$ dirname /tmp/foo/\n" \
840 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000841
Eric Andersen7e9276b2001-02-22 01:15:47 +0000842#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000843 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000844#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000845 "Print or control the kernel ring buffer\n" \
846 "\nOptions:" \
847 "\n -c Clear ring buffer after printing" \
848 "\n -n LEVEL Set console logging level" \
849 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000850
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000851#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000852 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000853#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000854 "Small static DNS server daemon\n" \
855 "\nOptions:" \
856 "\n -c Config filename" \
857 "\n -t TTL in seconds" \
858 "\n -p Listening port" \
859 "\n -i Listening ip (default all)" \
860 "\n -d Daemonize" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000861
Eric Andersen7e9276b2001-02-22 01:15:47 +0000862#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000863 "[option] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000864#define dos2unix_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000865 "Convert FILE from dos to unix format.\n" \
866 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000867 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000868 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000869 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000870
Eric Andersen7e9276b2001-02-22 01:15:47 +0000871#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000872 "[-ilCPru] [-F option] package_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000873#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000874 "Install, remove and manage Debian packages\n" \
875 "\nOptions:" \
876 "\n -i Install the package" \
877 "\n -l List of installed packages" \
878 "\n -C Configure an unpackaged package" \
879 "\n -F depends Ignore dependency problems" \
880 "\n -P Purge all files of a package" \
881 "\n -r Remove all but the configuration files for a package" \
882 "\n -u Unpack a package, but don't configure it" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000883
Eric Andersen7e9276b2001-02-22 01:15:47 +0000884#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000885 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000886#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000887 "Perform actions on Debian packages (.debs)\n" \
888 "\nOptions:" \
889 "\n -c List contents of filesystem tree" \
890 "\n -e Extract control files to [argument] directory" \
891 "\n -f Display control field name starting with [argument]" \
892 "\n -x Extract packages filesystem tree to directory" \
893 "\n -X Verbose extract" \
894
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000895#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000896 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000897
Eric Andersen7e9276b2001-02-22 01:15:47 +0000898#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000899 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000900#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000901 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000902 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000903 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
904 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000905 " bytes.\n" \
906 "\nOptions:" \
907 "\n -a Show file sizes too" \
908 "\n -H Follow symlinks on command line" \
909 "\n -L Follow all symlinks" \
910 "\n -d N Limit output to directories (and files with -a) of depth < N" \
911 "\n -c Show grand total" \
912 "\n -l Count sizes many times if hard linked" \
913 "\n -s Display only a total for each argument" \
914 "\n -x Skip directories on different filesystems" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000915 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000916 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
917 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000918 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000919 "\n -k Sizes in kilobytes" \
920 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
921
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000922#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000923 "$ du\n" \
924 "16 ./CVS\n" \
925 "12 ./kernel-patches/CVS\n" \
926 "80 ./kernel-patches\n" \
927 "12 ./tests/CVS\n" \
928 "36 ./tests\n" \
929 "12 ./scripts/CVS\n" \
930 "16 ./scripts\n" \
931 "12 ./docs/CVS\n" \
932 "104 ./docs\n" \
933 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000934
Eric Andersen7e9276b2001-02-22 01:15:47 +0000935#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000936 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000937#define dumpkmap_full_usage "\n\n" \
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000938 "Print a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000939#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000940 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000941
Russ Dill61fb4892002-10-14 21:41:28 +0000942#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000943 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000944#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000945 "Display DHCP leases granted by udhcpd\n" \
946 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000947 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000948 "\n -f,--file=FILE Leases file to load" \
949 "\n -r,--remaining Interpret lease times as time remaining" \
950 "\n -a,--absolute Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000951 ) \
952 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000953 "\n -f FILE Leases file to load" \
954 "\n -r Interpret lease times as time remaining" \
955 "\n -a Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000956 )
Russ Dill61fb4892002-10-14 21:41:28 +0000957
Mike Frysinger51a43b42005-09-24 07:11:16 +0000958#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000959 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
960 "[-I inode_buffer_blocks] [-P process_inode_size] " \
961 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
962 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000963#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000964 "Check ext2/ext3 file system\n" \
965 "\nOptions:" \
966 "\n -p Automatic repair (no questions)" \
967 "\n -n Make no changes to the filesystem" \
968 "\n -y Assume 'yes' to all questions" \
969 "\n -c Check for bad blocks and add them to the badblock list" \
970 "\n -f Force checking even if filesystem is marked clean" \
971 "\n -v Verbose" \
972 "\n -b superblock Use alternative superblock" \
973 "\n -B blocksize Force blocksize when looking for superblock" \
974 "\n -j journal Set location of the external journal" \
975 "\n -l file Add to badblocks list" \
976 "\n -L file Set badblocks list" \
Mike Frysinger51a43b42005-09-24 07:11:16 +0000977
Eric Andersen7e9276b2001-02-22 01:15:47 +0000978#define echo_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000979 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000980#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000981 "Print the specified ARGs to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000982 USE_FEATURE_FANCY_ECHO( "\n" \
983 "\nOptions:" \
984 "\n -n Suppress trailing newline" \
985 "\n -e Interpret backslash-escaped characters (i.e., \\t=tab)" \
986 "\n -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000987 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000988#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000989 "$ echo \"Erik is cool\"\n" \
990 "Erik is cool\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000991 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000992 "Erik\n" \
993 "is\n" \
994 "cool\n" \
995 "$ echo \"Erik\\nis\\ncool\"\n" \
996 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000997
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000998#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000999 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001000#define eject_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001001 "Eject specified DEVICE (or default /dev/cdrom)\n" \
1002 "\nOptions:" \
1003 USE_FEATURE_EJECT_SCSI( \
1004 "\n -s SCSI device" \
1005 ) \
1006 "\n -t Close tray" \
1007 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001008
Rob Landley3b890392006-05-04 20:56:43 +00001009#define ed_trivial_usage ""
1010#define ed_full_usage ""
1011
Eric Andersen84e229c2001-03-29 22:48:33 +00001012#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001013 "[-iu] [-] [name=value]... [command]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001014#define env_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001015 "Print the current environment or run a program after setting\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001016 "up the specified environment\n" \
1017 "\nOptions:" \
1018 "\n -, -i Start with an empty environment" \
1019 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +00001020
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001021#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001022 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001023#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001024 "Send a magic packet to wake up sleeping machines.\n" \
1025 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001026 "a hostname with a known 'ethers' entry.\n" \
1027 "\nOptions:" \
1028 "\n -b Send wake-up packet to the broadcast address" \
1029 "\n -i iface Interface to use (default eth0)" \
1030 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001031
Denis Vlasenko3952f202007-08-13 14:10:24 +00001032#define expand_trivial_usage \
1033 "[-i] [-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001034#define expand_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001035 "Convert tabs to spaces, writing to standard output.\n" \
1036 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001037 USE_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001038 "\n -i,--initial Do not convert tabs after non blanks" \
1039 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001040 ) \
1041 SKIP_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001042 "\n -i Do not convert tabs after non blanks" \
1043 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001044 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00001045
Eric Andersen7e9276b2001-02-22 01:15:47 +00001046#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001047 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001048#define expr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001049 "Print the value of EXPRESSION to standard output.\n" \
1050 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001051 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001052 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
1053 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1054 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1055 " ARG1 <= ARG2\n" \
1056 " ARG1 = ARG2\n" \
1057 " ARG1 != ARG2\n" \
1058 " ARG1 >= ARG2\n" \
1059 " ARG1 > ARG2\n" \
1060 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1061 " ARG1 - ARG2\n" \
1062 " ARG1 * ARG2\n" \
1063 " ARG1 / ARG2\n" \
1064 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001065 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1066 " match STRING REGEXP Same as STRING : REGEXP\n" \
1067 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1068 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1069 " length STRING Length of STRING\n" \
1070 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001071 " it is a keyword like 'match' or an\n" \
1072 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001073 " (EXPRESSION) Value of EXPRESSION\n" \
1074 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001075 "Beware that many operators need to be escaped or quoted for shells.\n" \
1076 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001077 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001078 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1079 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001080
Mike Frysingerfa69f112005-04-17 07:24:19 +00001081#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001082 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001083#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001084 "Provide fake ident (auth) service\n" \
1085 "\nOptions:" \
1086 "\n -f Run in foreground" \
1087 "\n -i Inetd mode" \
1088 "\n -w Inetd 'wait' mode" \
1089 "\n -b ADDR Bind to specified address" \
1090 "\n STRING Ident answer string (default is 'nobody')" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001091
Eric Andersen7e9276b2001-02-22 01:15:47 +00001092#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001093 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001094#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001095 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001096
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001097#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001098 "$ false\n" \
1099 "$ echo $?\n" \
1100 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001101
1102#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001103 "[options] [mode]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001104#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001105 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001106
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001107#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001108 "$ fbset\n" \
1109 "mode \"1024x768-76\"\n" \
1110 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1111 " geometry 1024 768 1024 768 16\n" \
1112 " timings 12714 128 32 16 4 128 4\n" \
1113 " accel false\n" \
1114 " rgba 5/11,6/5,5/0,0/0\n" \
1115 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001116
Eric Andersen7e9276b2001-02-22 01:15:47 +00001117#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001118 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001119#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001120 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001121
Eric Andersen01c3d402003-07-05 07:51:31 +00001122#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001123 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001124#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001125 "Format floppy disk\n" \
1126 "\nOptions:" \
1127 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001128
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001129/* Looks like someone forgot to add this to config system */
1130#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1131# define ENABLE_FEATURE_FDISK_BLKSIZE 0
1132# define USE_FEATURE_FDISK_BLKSIZE(a)
1133#endif
1134
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001135#define fdisk_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001136 "[-ul" USE_FEATURE_FDISK_BLKSIZE("s") "] " \
1137 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001138#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001139 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001140 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001141 "\n -u Start and End are in sectors (instead of cylinders)" \
1142 "\n -l Show partition table for each DISK, then exit" \
1143 USE_FEATURE_FDISK_BLKSIZE( \
1144 "\n -s Show partition sizes in kb for each DISK, then exit" \
1145 ) \
1146 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1147 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
1148 "\n -H HEADS\n" \
1149 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001150
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001151#define blkid_trivial_usage \
1152 ""
1153#define blkid_full_usage "\n\n" \
1154 "Print UUIDs of all filesystems."
1155
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001156#define findfs_trivial_usage \
1157 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001158#define findfs_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001159 "Find a filesystem device based on a label or UUID."
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001160#define findfs_example_usage \
1161 "$ findfs LABEL=MyDevice"
1162
Eric Andersen7e9276b2001-02-22 01:15:47 +00001163#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001164 "[PATH...] [EXPRESSION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001165#define find_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001166 "Search for files. The default PATH is the current directory,\n" \
1167 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001168 "\nEXPRESSION may consist of:" \
1169 "\n -follow Dereference symlinks" \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001170 USE_FEATURE_FIND_XDEV( \
1171 "\n -xdev Don't descend directories on other filesystems") \
1172 USE_FEATURE_FIND_MAXDEPTH( \
1173 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1174 "\n tests/actions to command line arguments only") \
Denis Vlasenko83518d12009-03-20 22:17:13 +00001175 "\n -mindepth N Do not act on first N levels" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001176 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001177 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001178 USE_FEATURE_FIND_PATH( \
1179 "\n -path PATTERN Path matches PATTERN") \
1180 USE_FEATURE_FIND_REGEX( \
1181 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001182 USE_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001183 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001184 USE_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001185 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001186 "\n or exactly (NNN)") \
1187 USE_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001188 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001189 "\n or exactly (N) days") \
1190 USE_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001191 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001192 "\n or exactly (N) minutes") \
1193 USE_FEATURE_FIND_NEWER( \
1194 "\n -newer FILE Modified time is more recent than FILE's") \
1195 USE_FEATURE_FIND_INUM( \
1196 "\n -inum N File has inode number N") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001197 USE_FEATURE_FIND_USER( \
1198 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
1199 USE_FEATURE_FIND_GROUP( \
1200 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
1201 USE_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001202 "\n -depth Process directory name after traversing it") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001203 USE_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001204 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1205 "\n +/-N: file size is bigger/smaller than N") \
1206 "\n -print Print (default and assumed)" \
1207 USE_FEATURE_FIND_PRINT0( \
1208 "\n -print0 Delimit output with null characters rather than" \
1209 "\n newlines") \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001210 USE_FEATURE_FIND_CONTEXT ( \
1211 "\n -context File has specified security context") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001212 USE_FEATURE_FIND_EXEC( \
1213 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1214 "\n matching files") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001215 USE_FEATURE_FIND_PRUNE( \
1216 "\n -prune Stop traversing current subtree") \
1217 USE_FEATURE_FIND_DELETE( \
1218 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001219 USE_FEATURE_FIND_PAREN( \
1220 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001221
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001222#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001223 "$ find / -name passwd\n" \
1224 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001225
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001226#define flash_eraseall_trivial_usage \
1227 "[-jq] MTD_DEVICE"
1228#define flash_eraseall_full_usage "\n\n" \
1229 "Erase an MTD device\n" \
1230 "\nOptions:" \
1231 "\n -j format the device for jffs2" \
1232 "\n -q don't display progress messages"
1233
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001234#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001235 "[-bs] [-w WIDTH] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001236#define fold_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001237 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001238 "standard output\n" \
1239 "\nOptions:" \
1240 "\n -b Count bytes rather than columns" \
1241 "\n -s Break at spaces" \
1242 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001243
Eric Andersen7e9276b2001-02-22 01:15:47 +00001244#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001245 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001246#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001247 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001248#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001249 "$ free\n" \
1250 " total used free shared buffers\n" \
1251 " Mem: 257628 248724 8904 59644 93124\n" \
1252 " Swap: 128516 8404 120112\n" \
1253 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001254
Eric Andersen7e9276b2001-02-22 01:15:47 +00001255#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001256 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001257#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001258 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001259#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001260 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001261
Mike Frysinger51a43b42005-09-24 07:11:16 +00001262#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001263 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001264#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001265 "Check and repair filesystems\n" \
1266 "\nOptions:" \
1267 "\n -A Walk /etc/fstab and check all filesystems" \
1268 "\n -N Don't execute, just show what would be done" \
1269 "\n -P With -A, check filesystems in parallel" \
1270 "\n -R With -A, skip the root filesystem" \
1271 "\n -T Don't show title on startup" \
1272 "\n -V Verbose" \
1273 "\n -C n Write status information to specified filedescriptor" \
1274 "\n -t type List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001275
Eric Andersen7e9276b2001-02-22 01:15:47 +00001276#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001277 "[-larvsmf] /dev/name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001278#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001279 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001280 "\nOptions:" \
1281 "\n -l List all filenames" \
1282 "\n -r Perform interactive repairs" \
1283 "\n -a Perform automatic repairs" \
1284 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001285 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001286 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001287 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001288
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001289#define ftpd_trivial_usage \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001290 "[-wvS] [-t N] [-T N] [DIR]"
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001291#define ftpd_full_usage "\n\n" \
1292 "FTP server\n" \
1293 "\n" \
1294 "ftpd should be used as an inetd service.\n" \
1295 "ftpd's line for inetd.conf:\n" \
1296 " 21 stream tcp nowait root ftpd ftpd /files/to/serve\n" \
1297 "It also can be ran from tcpsvd:\n" \
1298 " tcpsvd -vE 0.0.0.0 21 ftpd /files/to/serve\n" \
1299 "\nOptions:" \
1300 "\n -w Allow upload" \
Denis Vlasenko4221e902009-03-11 15:07:44 +00001301 "\n -v Log to stderr" \
1302 "\n -S Log to syslog" \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001303 "\n -t,-T Idle and absolute timeouts" \
Denis Vlasenko92576712009-03-09 16:25:33 +00001304 "\n DIR Change root to this directory" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001305
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001306#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001307 "[options] remote-host local-file remote-file"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001308#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001309 "Retrieve a remote file via FTP\n" \
1310 "\nOptions:" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001311 USE_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001312 "\n -c,--continue Continue previous transfer" \
1313 "\n -v,--verbose Verbose" \
1314 "\n -u,--username Username" \
1315 "\n -p,--password Password" \
1316 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001317 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001318 SKIP_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001319 "\n -c Continue previous transfer" \
1320 "\n -v Verbose" \
1321 "\n -u Username" \
1322 "\n -p Password" \
1323 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001324 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001325
1326#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001327 "[options] remote-host remote-file local-file"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001328#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001329 "Store a local file on a remote machine via FTP\n" \
1330 "\nOptions:" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001331 USE_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001332 "\n -v,--verbose Verbose" \
1333 "\n -u,--username Username" \
1334 "\n -p,--password Password" \
1335 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001336 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001337 SKIP_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001338 "\n -v Verbose" \
1339 "\n -u Username" \
1340 "\n -p Password" \
1341 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001342 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001343
Rob Landleyaa872762005-10-28 13:05:12 +00001344#define fuser_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001345 "[options] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001346#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001347 "Find processes which use FILEs or PORTs\n" \
1348 "\nOptions:" \
1349 "\n -m Find processes which use same fs as FILEs" \
1350 "\n -4 Search only IPv4 space" \
1351 "\n -6 Search only IPv6 space" \
1352 "\n -s Silent: just exit with 0 if any processes are found" \
1353 "\n -k Kill found processes (otherwise display PIDs)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001354 "\n -SIGNAL Signal to send (default: TERM)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001355
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001356#define getenforce_trivial_usage NOUSAGE_STR
1357#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001358
Eric Andersen7e9276b2001-02-22 01:15:47 +00001359#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001360 "[OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001361#define getopt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001362 "Parse command options\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001363 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001364 "\n -a,--alternative Allow long options starting with single -" \
1365 "\n -l,--longoptions=longopts Long options to be recognized" \
1366 "\n -n,--name=progname The name under which errors are reported" \
1367 "\n -o,--options=optstring Short options to be recognized" \
1368 "\n -q,--quiet Disable error reporting by getopt(3)" \
1369 "\n -Q,--quiet-output No normal output" \
1370 "\n -s,--shell=shell Set shell quoting conventions" \
1371 "\n -T,--test Test for getopt(1) version" \
1372 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001373 ) \
1374 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001375 "\n -a Allow long options starting with single -" \
1376 "\n -l longopts Long options to be recognized" \
1377 "\n -n progname The name under which errors are reported" \
1378 "\n -o optstring Short options to be recognized" \
1379 "\n -q Disable error reporting by getopt(3)" \
1380 "\n -Q No normal output" \
1381 "\n -s shell Set shell quoting conventions" \
1382 "\n -T Test for getopt(1) version" \
1383 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001384 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001385#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001386 "$ cat getopt.test\n" \
1387 "#!/bin/sh\n" \
1388 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1389 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001390 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001391 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001392 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001393 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001394 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1395 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001396 " -c|--c-long)\n" \
1397 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001398 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1399 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1400 " esac;;\n" \
1401 " --) shift; break;;\n" \
1402 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001403 " esac\n" \
1404 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001405
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001406#define getsebool_trivial_usage \
1407 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001408#define getsebool_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001409 " -a Show all SELinux booleans"
1410
Eric Andersenf349e972001-08-21 16:18:59 +00001411#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001412 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001413#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001414 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1415 "\nOptions:" \
1416 "\n -h Enable hardware (RTS/CTS) flow control" \
1417 "\n -i Do not display /etc/issue before running login" \
1418 "\n -L Local line, do not do carrier detect" \
1419 "\n -m Get baud rate from modem's CONNECT status message" \
1420 "\n -w Wait for a CR or LF before sending /etc/issue" \
1421 "\n -n Do not prompt the user for a login name" \
1422 "\n -f issue_file Display issue_file instead of /etc/issue" \
1423 "\n -l login_app Invoke login_app instead of /bin/login" \
1424 "\n -t timeout Terminate after timeout if no username is read" \
1425 "\n -I initstring Init string to send before anything else" \
1426 "\n -H login_host Log login_host into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001427
Eric Andersen7e9276b2001-02-22 01:15:47 +00001428#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001429 "[-HhrilLnqvso" \
1430 USE_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001431 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001432 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1433 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko83518d12009-03-20 22:17:13 +00001434 USE_EXTRA_COMPAT("z") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001435 "] PATTERN [FILEs...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001436#define grep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001437 "Search for PATTERN in each FILE or standard input\n" \
1438 "\nOptions:" \
1439 "\n -H Prefix output lines with filename where match was found" \
1440 "\n -h Suppress the prefixing filename on output" \
1441 "\n -r Recurse subdirectories" \
1442 "\n -i Ignore case distinctions" \
1443 "\n -l List names of files that match" \
1444 "\n -L List names of files that do not match" \
1445 "\n -n Print line number with output lines" \
1446 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1447 "\n -v Select non-matching lines" \
1448 "\n -s Suppress file open/read error messages" \
1449 "\n -c Only print count of matching lines" \
1450 "\n -o Show only the part of a line that matches PATTERN" \
1451 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001452 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001453 "\n -w Match whole words only") \
1454 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001455 USE_FEATURE_GREP_EGREP_ALIAS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001456 "\n -E PATTERN is an extended regular expression") \
1457 "\n -e PTRN Pattern to match" \
1458 "\n -f FILE Read pattern from file" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001459 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001460 "\n -A Print NUM lines of trailing context" \
1461 "\n -B Print NUM lines of leading context" \
1462 "\n -C Print NUM lines of output context") \
Denis Vlasenko83518d12009-03-20 22:17:13 +00001463 USE_EXTRA_COMPAT( \
1464 "\n -z Input is NUL terminated") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001465
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001466#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001467 "$ grep root /etc/passwd\n" \
1468 "root:x:0:0:root:/root:/bin/bash\n" \
1469 "$ grep ^[rR]oo. /etc/passwd\n" \
1470 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001471
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001472#define egrep_trivial_usage NOUSAGE_STR
1473#define egrep_full_usage ""
1474
1475#define fgrep_trivial_usage NOUSAGE_STR
1476#define fgrep_full_usage ""
1477
Eric Andersen7e9276b2001-02-22 01:15:47 +00001478#define gunzip_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001479 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001480#define gunzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001481 "Uncompress FILEs (or standard input)\n" \
1482 "\nOptions:" \
1483 "\n -c Write to standard output" \
1484 "\n -f Force" \
1485 "\n -t Test file integrity" \
1486
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001487#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001488 "$ ls -la /tmp/BusyBox*\n" \
1489 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1490 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1491 "$ ls -la /tmp/BusyBox*\n" \
1492 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001493
1494#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001495 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001496#define gzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001497 "Compress FILEs (or standard input)\n" \
1498 "\nOptions:" \
1499 "\n -c Write to standard output" \
1500 "\n -d Decompress" \
1501 "\n -f Force" \
1502
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001503#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001504 "$ ls -la /tmp/busybox*\n" \
1505 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1506 "$ gzip /tmp/busybox.tar\n" \
1507 "$ ls -la /tmp/busybox*\n" \
1508 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001509
1510#define halt_trivial_usage \
Bernhard Reutner-Fischerd93179f2008-09-01 15:24:52 +00001511 "[-d delay] [-n] [-f]" USE_FEATURE_WTMP(" [-w]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001512#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001513 "Halt the system\n" \
1514 "\nOptions:" \
1515 "\n -d Delay interval for halting" \
1516 "\n -n No call to sync()" \
1517 "\n -f Force halt (don't go through init)" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001518 USE_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001519 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001520 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001521
Eric Andersen3443bd72003-07-22 07:30:36 +00001522#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001523 "[options] [device] .."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001524#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001525 "Options:" \
1526 "\n -a Get/set fs readahead" \
1527 "\n -A Set drive read-lookahead flag (0/1)" \
1528 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1529 "\n -B Set Advanced Power Management setting (1-255)" \
1530 "\n -c Get/set IDE 32-bit IO setting" \
1531 "\n -C Check IDE power mode status" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001532 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001533 "\n -d Get/set using_dma flag") \
1534 "\n -D Enable/disable drive defect-mgmt" \
1535 "\n -f Flush buffer cache for device on exit" \
1536 "\n -g Display drive geometry" \
1537 "\n -h Display terse usage information" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001538 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001539 "\n -i Display drive identification") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001540 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001541 "\n -I Detailed/current information directly from drive") \
1542 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1543 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1544 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1545 "\n -m Get/set multiple sector count" \
1546 "\n -n Get/set ignore-write-errors flag (0/1)" \
1547 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1548 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001549/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001550 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1551 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001552 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001553 "\n -R Register an IDE interface (DANGEROUS)") \
1554 "\n -S Set standby (spindown) timeout" \
1555 "\n -t Perform device read timings" \
1556 "\n -T Perform cache read timings" \
1557 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001558 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001559 "\n -U Un-register an IDE interface (DANGEROUS)") \
1560 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1561 "\n -V Display program version and exit immediately" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001562 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001563 "\n -w Perform device reset (DANGEROUS)") \
1564 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001565 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001566 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1567 "\n -X Set IDE xfer mode (DANGEROUS)" \
1568 "\n -y Put IDE drive in standby mode" \
1569 "\n -Y Put IDE drive to sleep" \
1570 "\n -Z Disable Seagate auto-powersaving mode" \
1571 "\n -z Re-read partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001572
Eric Andersen7e9276b2001-02-22 01:15:47 +00001573#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001574 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001575#define head_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001576 "Print first 10 lines of each FILE to standard output.\n" \
1577 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001578 "file name. With no FILE, or when FILE is -, read standard input.\n" \
1579 "\nOptions:" \
1580 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001581 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001582 "\n -c NUM Output the first NUM bytes" \
1583 "\n -q Never output headers giving file names" \
1584 "\n -v Always output headers giving file names") \
1585
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001586#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001587 "$ head -n 2 /etc/passwd\n" \
1588 "root:x:0:0:root:/root:/bin/bash\n" \
1589 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001590
Glenn L McGrath60281112001-11-02 11:39:46 +00001591#define hexdump_trivial_usage \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001592 "[-bcCdefnosvx" USE_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001593#define hexdump_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001594 "Display file(s) or standard input in a user specified format\n" \
1595 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001596 "\n -b One-byte octal display" \
1597 "\n -c One-byte character display" \
1598 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1599 "\n -d Two-byte decimal display" \
1600 "\n -e FORMAT STRING" \
1601 "\n -f FORMAT FILE" \
1602 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1603 "\n -o Two-byte octal display" \
1604 "\n -s OFFSET Skip OFFSET bytes" \
1605 "\n -v Display all input data" \
1606 "\n -x Two-byte hexadecimal display" \
1607 USE_FEATURE_HEXDUMP_REVERSE( \
1608 "\n -R Reverse of 'hexdump -Cv'") \
1609
1610#define hd_trivial_usage \
1611 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001612#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001613 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001614
Eric Andersen7e9276b2001-02-22 01:15:47 +00001615#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001616 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001617#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001618 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001619
1620#define hostname_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001621 "[OPTION] [hostname | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001622#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001623 "Get or set hostname or DNS domain name\n" \
1624 "\nOptions:" \
1625 "\n -s Short" \
1626 "\n -i Addresses for the hostname" \
1627 "\n -d DNS domain name" \
1628 "\n -f Fully qualified domain name" \
1629 "\n -F FILE Use the contents of FILE to specify the hostname" \
1630
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001631#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001632 "$ hostname\n" \
1633 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001634
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001635#define httpd_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001636 "[-c conffile]" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001637 " [-p [ip:]port]" \
1638 " [-i] [-f] [-v[v]]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001639 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001640 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001641 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001642 " [-h home]" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001643 " [-d/-e string]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001644#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001645 "Listen for incoming HTTP requests\n" \
1646 "\nOptions:" \
1647 "\n -c FILE Configuration file (default httpd.conf)" \
1648 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
1649 "\n -i Inetd mode" \
1650 "\n -f Do not daemonize" \
1651 "\n -v[v] Verbose" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001652 USE_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001653 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001654 USE_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001655 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001656 USE_FEATURE_HTTPD_AUTH_MD5( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001657 "\n -m PASS Crypt PASS with md5 algorithm") \
1658 "\n -h HOME Home directory (default .)" \
1659 "\n -e STRING HTML encode STRING" \
1660 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001661
Robert Griebl1cd04452002-07-21 16:50:49 +00001662#define hwclock_trivial_usage \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001663 USE_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001664 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1665 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001666 " [-f FILE]" \
1667 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001668 SKIP_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001669 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1670 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001671#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001672 "Query and set hardware clock (RTC)\n" \
1673 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001674 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001675 "\n -s Set system time from hardware clock" \
1676 "\n -w Set hardware clock to system time" \
1677 "\n -u Hardware clock is in UTC" \
1678 "\n -l Hardware clock is in local time" \
1679 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001680
Eric Andersen7e9276b2001-02-22 01:15:47 +00001681#define id_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001682 "[OPTIONS]... [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001683#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001684 "Print information about USER or the current user\n" \
1685 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001686 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001687 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001688 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001689 "\n -u Print user ID" \
Denis Vlasenko4f3209b2008-09-13 12:51:10 +00001690 "\n -g Print group ID" \
1691 "\n -G Print supplementary group IDs" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001692 "\n -n Print name instead of a number" \
1693 "\n -r Print real user ID instead of effective ID" \
1694
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001695#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001696 "$ id\n" \
1697 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001698
Eric Andersen7e9276b2001-02-22 01:15:47 +00001699#define ifconfig_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001700 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001701#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001702 "Configure a network interface\n" \
1703 "\nOptions:" \
1704 "\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001705 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001706 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001707 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001708 " [del ADDRESS[/PREFIXLEN]]\n") \
1709 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1710 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001711 USE_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001712 " [outfill NN] [keepalive NN]\n") \
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001713 " " USE_FEATURE_IFCONFIG_HW("[hw ether" USE_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001714 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001715 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001716 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001717 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001718 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001719
Denis Vlasenko06aed432008-02-26 18:25:24 +00001720#define ifenslave_trivial_usage \
1721 "[-cdf] master-iface <slave-iface...>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001722#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001723 "Configure network interfaces for parallel routing\n" \
1724 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001725 "\n -c, --change-active Change active slave" \
1726 "\n -d, --detach Remove slave interface from bonding device" \
1727 "\n -f, --force Force, even if interface is not Ethernet" \
1728/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001729
Denis Vlasenko06aed432008-02-26 18:25:24 +00001730#define ifenslave_example_usage \
1731 "To create a bond device, simply follow these three steps :\n" \
1732 "- ensure that the required drivers are properly loaded :\n" \
1733 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
1734 "- assign an IP address to the bond device :\n" \
1735 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
1736 "- attach all the interfaces you need to the bond device :\n" \
1737 " # ifenslave bond0 eth0 eth1 eth2\n" \
1738 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1739 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
1740 " To detach a dead interface without setting the bond device down :\n" \
1741 " # ifenslave -d bond0 eth1\n\n" \
1742 " To set the bond device down and automatically release all the slaves :\n" \
1743 " # ifconfig bond0 down\n\n" \
1744 " To change active slave :\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001745 " # ifenslave -c bond0 eth0\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001746
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001747#define ifup_trivial_usage \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001748 "[-ain"USE_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001749#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001750 "Options:" \
1751 "\n -a De/configure all interfaces automatically" \
1752 "\n -i FILE Use FILE for interface definitions" \
1753 "\n -n Print out what would happen, but don't do it" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001754 USE_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001755 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001756 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001757 ) \
1758 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001759 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001760
1761#define ifdown_trivial_usage \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001762 "[-ain"USE_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001763#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001764 "Options:" \
1765 "\n -a De/configure all interfaces automatically" \
1766 "\n -i FILE Use FILE for interface definitions" \
1767 "\n -n Print out what would happen, but don't do it" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001768 USE_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001769 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001770 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001771 ) \
1772 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001773 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001774
Glenn L McGrath06e95652003-02-09 06:51:14 +00001775#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001776 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001777#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001778 "Listen for network connections and launch programs\n" \
1779 "\nOptions:" \
1780 "\n -f Run in foreground" \
1781 "\n -e Log to stderr" \
1782 "\n -q N Socket listen queue (default: 128)" \
1783 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001784 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001785
Eric Andersen7e9276b2001-02-22 01:15:47 +00001786#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001787 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001788#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001789 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001790
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001791#define init_notes_usage \
1792"This version of init is designed to be run only by the kernel.\n" \
1793"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001794"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001795"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001796"runlevels, use sysvinit.\n" \
1797"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001798"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001799"it has the following default behavior:\n" \
1800"\n" \
1801" ::sysinit:/etc/init.d/rcS\n" \
1802" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001803" ::ctrlaltdel:/sbin/reboot\n" \
1804" ::shutdown:/sbin/swapoff -a\n" \
1805" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001806" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001807"\n" \
1808"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1809"\n" \
1810" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001811" tty3::askfirst:/bin/sh\n" \
1812" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001813"\n" \
1814"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1815"\n" \
1816" <id>:<runlevels>:<action>:<process>\n" \
1817"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001818" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001819"\n" \
1820" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1821" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001822" the specified process to run on. The contents of this field are\n" \
1823" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1824" be unique, although if it isn't you may have strange results. If this\n" \
1825" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001826" note that if BusyBox detects that a serial console is in use, then only\n" \
1827" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001828" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001829" stinkin' utmp.\n" \
1830"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001831" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001832"\n" \
1833" The runlevels field is completely ignored.\n" \
1834"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001835" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001836"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001837" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001838" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001839"\n" \
1840" The available actions can be classified into two groups: actions\n" \
1841" that are run only once, and actions that are re-run when the specified\n" \
1842" process exits.\n" \
1843"\n" \
1844" Run only-once actions:\n" \
1845"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001846" 'sysinit' is the first item run on boot. init waits until all\n" \
1847" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001848" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001849" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001850" the specified task completes. 'once' actions are asynchronous,\n" \
1851" therefore, init does not wait for them to complete. 'restart' is\n" \
1852" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001853" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001854" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001855" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001856" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001857" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001858" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001859" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001860" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001861"\n" \
1862" Run repeatedly actions:\n" \
1863"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001864" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001865" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001866" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1867" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001868" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001869" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001870" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001871" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001872"\n" \
1873" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001874" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001875" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001876"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001877" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001878"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001879" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001880"\n" \
1881"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001882"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001883" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001884" #\n" \
1885" ::sysinit:/etc/init.d/rcS\n" \
1886" \n" \
1887" # /bin/sh invocations on selected ttys\n" \
1888" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001889" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001890" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001891" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001892" tty2::askfirst:-/bin/sh\n" \
1893" tty3::askfirst:-/bin/sh\n" \
1894" tty4::askfirst:-/bin/sh\n" \
1895" \n" \
1896" # /sbin/getty invocations for selected ttys\n" \
1897" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001898" tty4::respawn:/sbin/getty 38400 tty4\n" \
1899" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001900" \n" \
1901" \n" \
1902" # Example of how to put a getty on a serial line (for a terminal)\n" \
1903" #\n" \
1904" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1905" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1906" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001907" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001908" #::respawn:/sbin/getty 57600 ttyS2\n" \
1909" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001910" # Stuff to do when restarting the init process\n" \
1911" ::restart:/sbin/init\n" \
1912" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001913" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001914" ::ctrlaltdel:/sbin/reboot\n" \
1915" ::shutdown:/bin/umount -a -r\n" \
1916" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001917
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001918#define inotifyd_trivial_usage \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001919 "PROG FILE1[:MASK] ..."
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001920#define inotifyd_full_usage "\n\n" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001921 "Run PROG on filesystem changes." \
1922 "\nWhen a filesystem event matching MASK occurs on FILEn," \
1923 "\nPROG <actual_event(s)> <FILEn> [<subfile_name>] is run." \
Denis Vlasenko289ff0e2008-11-14 21:52:16 +00001924 "\nEvents:" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001925 "\n a File is accessed" \
1926 "\n c File is modified" \
1927 "\n e Metadata changed" \
1928 "\n w Writtable file is closed" \
1929 "\n 0 Unwrittable file is closed" \
1930 "\n r File is opened" \
Denis Vlasenkoa09a42c2008-11-17 22:19:18 +00001931 "\n D File is deleted" \
1932 "\n M File is moved" \
1933 "\n u Backing fs is unmounted" \
1934 "\n o Event queue overflowed" \
1935 "\n x File can't be watched anymore" \
1936 "\nIf watching a directory:" \
1937 "\n m Subfile is moved into dir" \
1938 "\n y Subfile is moved out of dir" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001939 "\n n Subfile is created" \
1940 "\n d Subfile is deleted" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001941 "\n" \
1942 "\ninotifyd waits for PROG to exit." \
1943 "\nWhen x event happens for all FILEs, inotifyd exits" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001944
Denis Vlasenko36309cf2008-11-22 18:29:01 +00001945/* 2.6 style insmod has no options and required filename
1946 * (not module name - .ko can't be omitted) */
Eric Andersen7e9276b2001-02-22 01:15:47 +00001947#define insmod_trivial_usage \
Denis Vlasenko36309cf2008-11-22 18:29:01 +00001948 USE_FEATURE_2_4_MODULES("[OPTION]... MODULE ") \
1949 SKIP_FEATURE_2_4_MODULES("FILE ") \
1950 "[symbol=value]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001951#define insmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001952 "Load the specified kernel modules into the kernel" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001953 USE_FEATURE_2_4_MODULES( "\n" \
1954 "\nOptions:" \
1955 "\n -f Force module to load into the wrong kernel version" \
1956 "\n -k Make module autoclean-able" \
1957 "\n -v Verbose" \
1958 "\n -q Quiet" \
1959 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001960 USE_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001961 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001962 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001963 "\n -o NAME Set internal module name to NAME" \
1964 "\n -x Do not export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001965 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001966
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00001967/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001968#define install_trivial_usage \
Denis Vlasenko4acdb462009-01-31 21:45:57 +00001969 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [source] dest|directory"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001970#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001971 "Copy files and set attributes\n" \
1972 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001973 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001974 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00001975 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001976 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001977 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001978 "\n -o USER Set ownership" \
1979 "\n -g GRP Set group ownership" \
1980 "\n -m MODE Set permissions" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001981 USE_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001982 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001983 )
Denis Vlasenko397de612008-03-17 08:55:44 +00001984
Denis Vlasenko4acdb462009-01-31 21:45:57 +00001985#define ionice_trivial_usage \
1986 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
1987#define ionice_full_usage "\n\n" \
1988 "Change I/O scheduling class and priority\n" \
1989 "\nOptions:" \
1990 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
1991 "\n -n Priority" \
1992
Denis Vlasenko397de612008-03-17 08:55:44 +00001993/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001994#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001995 "[OPTIONS] {" \
1996 USE_FEATURE_IP_ADDRESS("address | ") \
1997 USE_FEATURE_IP_ROUTE("route | ") \
1998 USE_FEATURE_IP_LINK("link | ") \
1999 USE_FEATURE_IP_TUNNEL("tunnel | ") \
2000 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002001 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002002#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002003 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002004 "where OBJECT := {" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00002005 USE_FEATURE_IP_ADDRESS("address | ") \
2006 USE_FEATURE_IP_ROUTE("route | ") \
2007 USE_FEATURE_IP_LINK("link | ") \
2008 USE_FEATURE_IP_TUNNEL("tunnel | ") \
2009 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002010 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002011 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002012
2013#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002014 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002015 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002016#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002017 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002018 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
2019 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002020 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002021 " [broadcast ADDR] [anycast ADDR]\n" \
2022 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002023 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002024
Eric Andersende4f07e2003-12-11 01:18:07 +00002025#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002026 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002027#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002028 "Calculate IP network settings from a IP address\n" \
2029 "\nOptions:" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002030 USE_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002031 "\n -b,--broadcast Display calculated broadcast address" \
2032 "\n -n,--network Display calculated network address" \
2033 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002034 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002035 "\n -p,--prefix Display the prefix for IP/NETMASK" \
2036 "\n -h,--hostname Display first resolved host name" \
2037 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002038 ) \
2039 ) \
2040 SKIP_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002041 "\n -b Display calculated broadcast address" \
2042 "\n -n Display calculated network address" \
2043 "\n -m Display default netmask for IP" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002044 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002045 "\n -p Display the prefix for IP/NETMASK" \
2046 "\n -h Display first resolved host name" \
2047 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002048 ) \
2049 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00002050
Rob Landley6eb1e412005-06-20 04:30:36 +00002051#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002052 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002053#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002054 "Upper-case options MQS remove an object by shmkey value.\n" \
2055 "Lower-case options remove an object by shmid value.\n" \
2056 "\nOptions:" \
2057 "\n -mM Remove memory segment after last detach" \
2058 "\n -qQ Remove message queue" \
2059 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002060
2061#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002062 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002063#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002064 " -i Show specific resource" \
2065 "\nResource specification:" \
2066 "\n -m Shared memory segments" \
2067 "\n -q Message queues" \
2068 "\n -s Semaphore arrays" \
2069 "\n -a All (default)" \
2070 "\nOutput format:" \
2071 "\n -t Time" \
2072 "\n -c Creator" \
2073 "\n -p Pid" \
2074 "\n -l Limits" \
2075 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002076
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002077#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002078 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002079#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00002080 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002081 " dynamic { on | off } |\n" \
2082 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002083 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002084
2085#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002086 "{ list | flush | { add | del | change | append |\n" \
2087 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002088#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002089 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002090 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
2091 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002092 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002093 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00002094 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
2095 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002096
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002097#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002098 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002099#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002100 "iprule [list | add | del] SELECTOR ACTION\n" \
2101 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2102 " [dev STRING] [pref NUMBER]\n" \
2103 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2104 " [prohibit | reject | unreachable]\n" \
2105 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002106 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002107
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002108#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002109 "{ add | change | del | show } [NAME]\n" \
2110 " [mode { ipip | gre | sit }]\n" \
2111 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002112#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002113 "iptunnel { add | change | del | show } [NAME]\n" \
2114 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2115 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002116 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002117
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002118#define kbd_mode_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002119 "[-a|k|s|u] [-C TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002120#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002121 "Report or set the keyboard mode\n" \
2122 "\nOptions set mode:" \
2123 "\n -a Default (ASCII)" \
2124 "\n -k Medium-raw (keyboard)" \
2125 "\n -s Raw (scancode)" \
2126 "\n -u Unicode (utf-8)" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002127 "\n -C TTY Affect TTY instead of /dev/tty" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002128
Eric Andersen7e9276b2001-02-22 01:15:47 +00002129#define kill_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002130 "[-l] [-SIG] PID..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002131#define kill_full_usage "\n\n" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002132 "Send a signal (default is TERM) to given PIDs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002133 "\nOptions:" \
2134 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002135/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002136
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002137#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002138 "$ ps | grep apache\n" \
2139 "252 root root S [apache]\n" \
2140 "263 www-data www-data S [apache]\n" \
2141 "264 www-data www-data S [apache]\n" \
2142 "265 www-data www-data S [apache]\n" \
2143 "266 www-data www-data S [apache]\n" \
2144 "267 www-data www-data S [apache]\n" \
2145 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002146
2147#define killall_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002148 "[-l] [-q] [-SIG] process-name..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002149#define killall_full_usage "\n\n" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002150 "Send a signal (default is TERM) to given processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002151 "\nOptions:" \
2152 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002153/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002154 "\n -q Do not complain if no processes were killed" \
2155
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002156#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002157 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002158
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002159#define killall5_trivial_usage \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002160 "[-l] [-SIG] [-o PID]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002161#define killall5_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002162 "Send a signal (default is TERM) to all processes outside current session\n" \
2163 "\nOptions:" \
2164 "\n -l List all signal names and numbers" \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002165 "\n -o PID Do not signal this PID" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002166/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002167
Mark Whitley6317c4b2001-03-12 22:51:50 +00002168#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002169 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002170#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002171 "Kernel logger\n" \
2172 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002173 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002174 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002175
Eric Andersen7e9276b2001-02-22 01:15:47 +00002176#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002177 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002178#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002179 "Print STRING's length"
2180
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002181#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002182 "$ length Hello\n" \
2183 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002184
Rob Landley9200e792005-09-15 19:26:59 +00002185#define less_trivial_usage \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002186 "[-EMNmh~I?] [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002187#define less_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002188 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002189 "changed, and files can be manipulated in various ways.\n" \
2190 "\nOptions:" \
2191 "\n -E Quit once the end of a file is reached" \
2192 "\n -M,-m Display a status line containing the line numbers" \
2193 "\n and percentage through the file" \
2194 "\n -N Prefix line numbers to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002195 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002196 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002197
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002198#define linux32_trivial_usage NOUSAGE_STR
2199#define linux32_full_usage ""
2200#define linux64_trivial_usage NOUSAGE_STR
2201#define linux64_full_usage ""
2202
2203#define linuxrc_trivial_usage NOUSAGE_STR
2204#define linuxrc_full_usage ""
2205
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002206#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002207 "personality program [args...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002208#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002209 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002210 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002211 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002212
Eric Andersen7e9276b2001-02-22 01:15:47 +00002213#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002214 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002215#define ln_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002216 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002217 "Use '--' to indicate that all following arguments are non-options.\n" \
2218 "\nOptions:" \
2219 "\n -s Make symlinks instead of hardlinks" \
2220 "\n -f Remove existing destination files" \
2221 "\n -n Don't dereference symlinks - treat like normal file" \
2222 "\n -b Make a backup of the target (if exists) before link operation" \
2223 "\n -S suf Use suffix instead of ~ when making backup files" \
2224
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002225#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002226 "$ ln -s BusyBox /tmp/ls\n" \
2227 "$ ls -l /tmp/ls\n" \
2228 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002229
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002230#define load_policy_trivial_usage NOUSAGE_STR
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002231#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002232
Eric Andersen7e9276b2001-02-22 01:15:47 +00002233#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002234 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002235#define loadfont_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002236 "Load a console font from standard input" \
2237/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2238
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002239#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002240 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002241
2242#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002243 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002244#define loadkmap_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002245 "Load a binary keyboard translation table from standard input\n" \
2246/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2247
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002248#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002249 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002250
2251#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002252 "[OPTION]... [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002253#define logger_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002254 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n" \
2255 "\nOptions:" \
2256 "\n -s Log to stderr as well as the system log" \
2257 "\n -t TAG Log using the specified tag (defaults to user name)" \
2258 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002259
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002260#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002261 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002262
Robert Griebl1fca5582002-06-04 20:45:46 +00002263#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002264 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002265#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002266 "Begin a new session on the system\n" \
2267 "\nOptions:" \
2268 "\n -f Do not authenticate (user already authenticated)" \
2269 "\n -h Name of the remote host" \
2270 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002271
Eric Andersen7e9276b2001-02-22 01:15:47 +00002272#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002273 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002274#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002275 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002276#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002277 "$ logname\n" \
2278 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002279
Mark Whitley6317c4b2001-03-12 22:51:50 +00002280#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002281 "[OPTION]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002282#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002283 "Show messages in syslogd's circular buffer\n" \
2284 "\nOptions:" \
2285 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002286
Matt Kraai83788da2002-03-20 17:38:37 +00002287#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002288 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2289 " losetup -d LOOPDEV - disassociate\n" \
2290 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002291#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002292 "Options:" \
2293 "\n -o OFS Start OFS bytes into FILE" \
2294 "\n -f Show first free loop device" \
2295
Rob Landley1d589b22005-11-29 23:47:10 +00002296#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002297 "No arguments will display all current associations.\n" \
2298 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002299 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002300 "and filename of the file the loop device is currently bound to.\n\n" \
2301 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002302 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2303 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002304
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002305#define lpd_trivial_usage \
Denis Vlasenkoa7942892008-03-23 23:40:18 +00002306 "SPOOLDIR [HELPER [ARGS...]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002307#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002308 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2309 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002310 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002311 "\ndirectory and HELPER program is called. Name of file to print" \
2312 "\nis passed in $DATAFILE variable." \
2313 "\nExample:" \
2314 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002315
Denis Vlasenko68444b92008-02-22 22:24:48 +00002316#define lpq_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002317 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID...] [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002318#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002319 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002320 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002321 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002322 "\n -f Force any waiting job to be printed" \
2323 "\n -s Short display" \
2324
2325#define lpr_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002326 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE...]"
2327/* -C CLASS exists too, not shown.
2328 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002329#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002330 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002331 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002332 "\n -m Send mail on completion" \
2333 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002334 "\n -V Verbose" \
2335
Eric Andersen7e9276b2001-02-22 01:15:47 +00002336#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002337 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00002338 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002339 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
2340 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
2341 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
2342 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
2343 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
2344 USE_SELINUX("K") "] [filenames...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002345#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002346 "List directory contents\n" \
2347 "\nOptions:" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002348 "\n -1 List in a single column" \
2349 "\n -A Don't list . and .." \
2350 "\n -a Don't hide entries starting with ." \
2351 "\n -C List by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002352 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002353 "\n -c With -l: sort by ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002354 USE_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002355 "\n --color[={always,never,auto}] Control coloring") \
2356 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002357 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002358 "\n -e List full date and time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002359 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002360 "\n -F Append indicator (one of */=@|) to entries") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002361 "\n -i List inode numbers" \
2362 "\n -l Long listing format" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002363 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002364 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002365 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002366 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002367 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002368 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002369 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002370 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002371 "\n -r Sort in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002372 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002373 "\n -S Sort by file size") \
Denis Vlasenko397de612008-03-17 08:55:44 +00002374 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002375 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002376 "\n -T NUM Assume tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002377 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002378 "\n -t With -l: sort by modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002379 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002380 "\n -u With -l: sort by access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002381 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002382 "\n -v Sort by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002383 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002384 "\n -w NUM Assume the terminal is NUM columns wide") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002385 "\n -x List by lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002386 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002387 "\n -X Sort by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00002388 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002389 "\n -h List sizes in human readable format (1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002390 USE_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002391 "\n -k List security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002392 USE_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002393 "\n -K List security context in long format") \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002394 USE_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002395 "\n -Z List security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002396
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002397#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002398 "[-Radlv] [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002399#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002400 "List file attributes on an ext2 fs\n" \
2401 "\nOptions:" \
2402 "\n -R Recursively list subdirectories" \
2403 "\n -a Do not hide entries starting with ." \
2404 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002405 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002406 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002407
Eric Andersen7e9276b2001-02-22 01:15:47 +00002408#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002409 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002410#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002411 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002412
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002413#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002414#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002415 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002416#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002417 "Create a range of block or character special files" \
2418 "\n" \
2419 "\nTYPE is:" \
2420 "\n b Block device" \
2421 "\n c Character device" \
2422 "\n f FIFO, MAJOR and MINOR are ignored" \
2423 "\n" \
2424 "\nFIRST..LAST specify numbers appended to NAME." \
2425 "\nIf 's' is the last argument, the base device is created as well." \
2426 "\n" \
2427 "\nExamples:" \
2428 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2429 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002430#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002431 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2432 "[creates ttyS2-ttyS63]\n" \
2433 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2434 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002435#endif
2436
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002437#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002438#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002439 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002440#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002441 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002442 "Device table entries take the form of:\n" \
2443 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002444 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002445 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002446 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002447 " c Character device\n" \
2448 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002449 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002450 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002451 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2452 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002453#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002454 "For example:\n" \
2455 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2456 "/dev d 755 0 0 - - - - -\n" \
2457 "/dev/console c 666 0 0 5 1 - - -\n" \
2458 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2459 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2460 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2461 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2462 "Will Produce:\n" \
2463 "/dev\n" \
2464 "/dev/console\n" \
2465 "/dev/null\n" \
2466 "/dev/zero\n" \
2467 "/dev/hda\n" \
2468 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002469#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002470
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002471#define makemime_trivial_usage \
2472 "[OPTION]... [FILE]..."
2473#define makemime_full_usage "\n\n" \
2474 "Create MIME-encoded message\n" \
2475 "\nOptions:" \
2476 "\n -C Charset" \
Denis Vlasenkoc028ec22008-11-10 10:47:47 +00002477 "\n -e Transfer encoding. Ignored. base64 is assumed" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002478 "\n" \
2479 "\nOther options are silently ignored." \
2480
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002481#define man_trivial_usage \
2482 "[OPTION]... [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002483#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002484 "Format and display manual page\n" \
2485 "\nOptions:" \
2486 "\n -a Display all pages" \
2487 "\n -w Show page locations" \
2488
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002489#define matchpathcon_trivial_usage \
2490 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002491#define matchpathcon_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002492 " -n Do not display path" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002493 "\n -N Do not use translations" \
2494 "\n -f Use alternate file_context file" \
2495 "\n -p Use prefix to speed translations" \
2496 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002497
Eric Andersen7e9276b2001-02-22 01:15:47 +00002498#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002499 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002500 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002501#define md5sum_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002502 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002503 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2504 "\nOptions:" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002505 "\n -c Check sums against given list" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002506 "\n -s Don't output anything, status code shows success" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002507 "\n -w Warn about improperly formatted checksum lines" \
2508 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002509
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002510#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002511 "$ md5sum < busybox\n" \
2512 "6fd11e98b98a58f64ff3398d7b324003\n" \
2513 "$ md5sum busybox\n" \
2514 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2515 "$ md5sum -c -\n" \
2516 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2517 "busybox: OK\n" \
2518 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002519
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002520#define sha1sum_trivial_usage \
2521 "[OPTION] [FILEs...]" \
2522 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
2523#define sha1sum_full_usage "\n\n" \
2524 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
2525 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2526 "\nOptions:" \
2527 "\n -c Check sums against given list" \
2528 "\n -s Don't output anything, status code shows success" \
2529 "\n -w Warn about improperly formatted checksum lines" \
2530 )
2531
2532#define sha256sum_trivial_usage \
2533 "[OPTION] [FILEs...]" \
2534 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha256sum [OPTION] -c [FILE]")
2535#define sha256sum_full_usage "\n\n" \
2536 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
2537 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2538 "\nOptions:" \
2539 "\n -c Check sums against given list" \
2540 "\n -s Don't output anything, status code shows success" \
2541 "\n -w Warn about improperly formatted checksum lines" \
2542 )
2543
2544#define sha512sum_trivial_usage \
2545 "[OPTION] [FILEs...]" \
2546 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha512sum [OPTION] -c [FILE]")
2547#define sha512sum_full_usage "\n\n" \
2548 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
2549 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2550 "\nOptions:" \
2551 "\n -c Check sums against given list" \
2552 "\n -s Don't output anything, status code shows success" \
2553 "\n -w Warn about improperly formatted checksum lines" \
2554 )
2555
Rob Landley70f7ef72005-12-13 08:21:33 +00002556#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002557 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002558#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002559 " -s Scan /sys and populate /dev during system boot\n" \
2560 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002561 "Called with no options (via hotplug) it uses environment variables\n" \
2562 "to determine which device to add/remove."
Denis Vlasenko397de612008-03-17 08:55:44 +00002563
Rob Landleyef10d522006-06-26 14:11:33 +00002564#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002565 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002566 "The mdev config file contains lines that look like:\n" \
2567 " hd[a-z][0-9]* 0:3 660\n\n" \
2568 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002569 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002570 "Optionally, that can be followed (on the same line) by a special character\n" \
2571 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002572 "device(s). The environment variable $MDEV indicates the active device node\n" \
2573 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002574 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2575 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002576 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002577 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002578 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002579 "Config file parsing stops on the first matching line. If no config\n" \
2580 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002581 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002582 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002583
Glenn L McGrath061c9002002-09-16 04:21:46 +00002584#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002585 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002586#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002587 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002588 " y Allow write access to your terminal\n" \
2589 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002590
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002591#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002592 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002593#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002594 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2595 "\nOptions:" \
2596 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2597 "\n next byte to it" \
2598 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2599 "\n -s Set serial line to SPEED" \
2600 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002601
Eric Andersen7e9276b2001-02-22 01:15:47 +00002602#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002603 "[OPTION] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002604#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002605 "Create DIRECTORY\n" \
2606 "\nOptions:" \
2607 "\n -m Set permission mode (as in chmod), not rwxrwxrwx - umask" \
2608 "\n -p No error if existing, make parent directories as needed" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002609 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002610 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002611 )
2612
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002613#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002614 "$ mkdir /tmp/foo\n" \
2615 "$ mkdir /tmp/foo\n" \
2616 "/tmp/foo: File exists\n" \
2617 "$ mkdir /tmp/foo/bar/baz\n" \
2618 "/tmp/foo/bar/baz: No such file or directory\n" \
2619 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002620
Mike Frysinger6447ac02005-06-11 05:29:40 +00002621#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002622 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2623 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2624 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2625 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2626 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2627 "device [blocks-count]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002628#define mke2fs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002629 " -b size Block size in bytes" \
2630 "\n -c Check for bad blocks before creating" \
2631 "\n -E opts Set extended options" \
2632 "\n -f size Fragment size in bytes" \
2633 "\n -F Force (ignore sanity checks)" \
2634 "\n -g num Number of blocks in a block group" \
2635 "\n -i ratio The bytes/inode ratio" \
2636 "\n -j Create a journal (ext3)" \
2637 "\n -J opts Set journal options (size/device)" \
2638 "\n -l file Read bad blocks list from file" \
2639 "\n -L lbl Set the volume label" \
2640 "\n -m percent Percent of fs blocks to reserve for admin" \
2641 "\n -M dir Set last mounted directory" \
2642 "\n -n Do not actually create anything" \
2643 "\n -N num Number of inodes to create" \
2644 "\n -o os Set the 'creator os' field" \
2645 "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" \
2646 "\n -q Quiet" \
2647 "\n -r rev Set filesystem revision" \
2648 "\n -S Write superblock and group descriptors only" \
2649 "\n -T fs-type Set usage type (news/largefile/largefile4)" \
2650 "\n -v Verbose" \
Mike Frysinger6447ac02005-06-11 05:29:40 +00002651
Eric Andersen7e9276b2001-02-22 01:15:47 +00002652#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002653 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002654#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002655 "Create named pipe (identical to 'mknod name p')\n" \
2656 "\nOptions:" \
2657 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002658 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002659 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002660 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002661
Eric Andersen7e9276b2001-02-22 01:15:47 +00002662#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002663 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002664#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002665 "Make a MINIX filesystem\n" \
2666 "\nOptions:" \
2667 "\n -c Check device for bad blocks" \
2668 "\n -n [14|30] Maximum length of filenames" \
2669 "\n -i INODES Number of inodes for the filesystem" \
2670 "\n -l FILENAME Read bad blocks list from FILENAME" \
2671 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002672
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002673#define mkfs_vfat_trivial_usage \
2674 "[-v] [-n LABEL] FILE_OR_DEVICE [SIZE_IN_KB]"
2675/* Accepted but ignored:
2676 "[-c] [-C] [-I] [-l bad-block-file] [-b backup-boot-sector] "
2677 "[-m boot-msg-file] [-i volume-id] "
2678 "[-s sectors-per-cluster] [-S logical-sector-size] [-f number-of-FATs] "
2679 "[-h hidden-sectors] [-F fat-size] [-r root-dir-entries] [-R reserved-sectors] "
2680*/
2681#define mkfs_vfat_full_usage "\n\n" \
2682 "Make a FAT32 filesystem\n" \
2683 "\nOptions:" \
2684/* "\n -c Check device for bad blocks" */ \
2685 "\n -v Verbose" \
2686/* "\n -I Allow to use entire disk device (e.g. /dev/hda)" */ \
2687 "\n -n LBL Volume label" \
2688
Eric Andersen7e9276b2001-02-22 01:15:47 +00002689#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002690 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002691#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002692 "Create a special file (block, character, or pipe)\n" \
2693 "\nOptions:" \
2694 "\n -m Create the special file using the specified mode (default a=rw)" \
2695 "\nTYPEs include:" \
2696 "\n b: Make a block device" \
2697 "\n c or u: Make a character device" \
2698 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002699 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002700 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002701 )
2702
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002703#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002704 "$ mknod /dev/fd0 b 2 0\n" \
2705 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002706
Eric Andersen7e9276b2001-02-22 01:15:47 +00002707#define mkswap_trivial_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002708 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002709#define mkswap_full_usage "\n\n" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002710 "Prepare block device to be used as swap partition"
2711#if 0
2712 "[-c] [-v0|-v1] DEVICE [BLOCKS]"
Denis Vlasenko397de612008-03-17 08:55:44 +00002713 "\nOptions:"
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002714 "\n -c Check for readability"
2715 "\n -v0 Make swap version 0 (max 128M)"
2716 "\n -v1 Make swap version 1 (default for kernels > 2.1.117)"
2717 "\n BLOCKS Number of blocks to use (default is entire partition)"
2718#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002719
Eric Andersen7e9276b2001-02-22 01:15:47 +00002720#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002721 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002722#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002723 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002724 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002725 "\nOptions:" \
2726 "\n -d Make a directory instead of a file" \
2727/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2728 "\n -t Generate a path rooted in temporary directory" \
2729 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2730 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002731 "\nFor -t or -p, directory is chosen as follows:" \
2732 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002733
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002734#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002735 "$ mktemp /tmp/temp.XXXXXX\n" \
2736 "/tmp/temp.mWiLjM\n" \
2737 "$ ls -la /tmp/temp.mWiLjM\n" \
2738 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002739
Eric Andersen8d79ce82001-07-22 23:00:15 +00002740#define modprobe_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002741 "[-knqrsv] MODULE [symbol=value...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002742#define modprobe_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002743 "Options:" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002744 USE_FEATURE_2_4_MODULES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002745 "\n -k Make module autoclean-able" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002746 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002747 "\n -n Dry run" \
2748 "\n -q Quiet" \
2749 "\n -r Remove module (stacks) or do autoclean" \
2750 "\n -s Report via syslog instead of stderr" \
2751 "\n -v Verbose" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002752 USE_FEATURE_MODPROBE_BLACKLIST( \
2753 "\n -b Apply blacklist to module names too" \
2754 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002755
Rob Landley9c32a152005-12-11 20:12:24 +00002756#define modprobe_notes_usage \
2757"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2758"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2759"pass each module it loads.\n" \
2760"\n" \
Bernhard Reutner-Fischer12aca792009-02-24 10:03:22 +00002761"The configuration file is searched (in this order):\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002762"\n" \
2763" /etc/modprobe.conf (2.6 only)\n" \
2764" /etc/modules.conf\n" \
2765" /etc/conf.modules (deprecated)\n" \
2766"\n" \
2767"They all have the same syntax (see below). If none is present, it is\n" \
2768"_not_ an error; each loaded module is then expected to load without\n" \
2769"options. Once a file is found, the others are tested for.\n" \
2770"\n" \
2771"/etc/modules.conf entry format:\n" \
2772"\n" \
2773" alias <alias_name> <mod_name>\n" \
2774" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002775" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002776" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2777" This makes it also possible to use a different set of options (below) for\n" \
2778" the module and the alias.\n" \
2779" A module can be aliased more than once.\n" \
2780"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002781" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002782" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2783" the \"symbol=value\" pairs as option to that module.\n" \
2784"\n" \
2785"Sample /etc/modules.conf file:\n" \
2786"\n" \
2787" options tulip irq=3\n" \
2788" alias tulip tulip2\n" \
2789" options tulip2 irq=4 io=0x308\n" \
2790"\n" \
2791"Other functionality offered by 'classic' modprobe is not available in\n" \
2792"this implementation.\n" \
2793"\n" \
2794"If module options are present both in the config file, and on the command line,\n" \
2795"then the options from the command line will be passed to the module _after_\n" \
2796"the options from the config file. That way, you can have defaults in the config\n" \
2797"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002798#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002799 "(with the above /etc/modules.conf):\n\n" \
2800 "$ modprobe tulip\n" \
2801 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2802 "$ modprobe tulip irq=5\n" \
2803 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2804 "$ modprobe tulip2\n" \
2805 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2806 " which are the default for alias 'tulip2'\n\n" \
2807 "$ modprobe tulip2 irq=8\n" \
2808 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2809 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2810 " from the command line\n\n" \
2811 "$ modprobe tulip2 irq=2 io=0x210\n" \
2812 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2813 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2814 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002815
Eric Andersen7e9276b2001-02-22 01:15:47 +00002816#define more_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002817 "[FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002818#define more_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002819 "View FILE or standard input one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002820
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002821#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002822 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002823
Eric Andersen7e9276b2001-02-22 01:15:47 +00002824#define mount_trivial_usage \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002825 "[flags] DEVICE NODE [-o OPT,OPT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002826#define mount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002827 "Mount a filesystem. Filesystem autodetection requires /proc be mounted.\n" \
2828 "\nOptions:" \
2829 "\n -a Mount all filesystems in fstab" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002830 USE_FEATURE_MOUNT_FAKE( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002831 USE_FEATURE_MTAB_SUPPORT( \
2832 "\n -f Update /etc/mtab, but don't mount" \
2833 ) \
2834 SKIP_FEATURE_MTAB_SUPPORT( \
2835 "\n -f Dry run" \
2836 ) \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002837 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002838 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002839 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002840 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002841 "\n -r Read-only mount" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002842 "\n -w Read-write mount (default)" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002843 "\n -t FSTYPE Filesystem type" \
2844 "\n -O OPT Mount only filesystems with option OPT (-a only)" \
2845 "\n-o OPT:" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002846 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002847 "\n loop Ignored (loop devices are autodetected)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002848 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002849 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002850 "\n [a]sync Writes are [a]synchronous" \
2851 "\n [no]atime Disable/enable updates to inode access times" \
2852 "\n [no]diratime Disable/enable atime updates to directories" \
2853 "\n [no]relatime Disable/enable atime updates relative to modification time" \
2854 "\n [no]dev (Dis)allow use of special device files" \
2855 "\n [no]exec (Dis)allow use of executable files" \
2856 "\n [no]suid (Dis)allow set-user-id-root programs" \
2857 "\n [r]shared Convert [recursively] to a shared subtree" \
2858 "\n [r]slave Convert [recursively] to a slave subtree" \
2859 "\n [r]private Convert [recursively] to a private subtree" \
2860 "\n [un]bindable Make mount point [un]able to be bind mounted" \
2861 "\n bind Bind a directory to an additional location" \
2862 "\n move Relocate an existing mount point" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002863 ) \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002864 "\n remount Remount a mounted filesystem, changing its flags" \
2865 "\n ro/rw Read-only/read-write mount" \
2866 "\n" \
2867 "\nThere are EVEN MORE flags that are specific to each filesystem" \
2868 "\nYou'll have to see the written documentation for those filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002869
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002870#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002871 "$ mount\n" \
2872 "/dev/hda3 on / type minix (rw)\n" \
2873 "proc on /proc type proc (rw)\n" \
2874 "devpts on /dev/pts type devpts (rw)\n" \
2875 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2876 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2877 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002878#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002879 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002880
Rob Landleyd00b3a52005-08-20 05:07:08 +00002881#define mountpoint_trivial_usage \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002882 "[-q] <[-dn] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002883#define mountpoint_full_usage "\n\n" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002884 "Check if the directory is a mountpoint\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002885 "\nOptions:" \
2886 "\n -q Quiet" \
2887 "\n -d Print major/minor device number of the filesystem" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002888 "\n -n Print device name of the filesystem" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002889 "\n -x Print major/minor device number of the blockdevice" \
2890
Rob Landleyd00b3a52005-08-20 05:07:08 +00002891#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002892 "$ mountpoint /proc\n" \
2893 "/proc is not a mountpoint\n" \
2894 "$ mountpoint /sys\n" \
2895 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002896
Eric Andersen7e9276b2001-02-22 01:15:47 +00002897#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002898 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002899#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002900 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002901 "\n" \
2902 "Available Opcodes:\n" \
2903 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002904 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2905 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2906 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002907 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002908
Eric Andersen7e9276b2001-02-22 01:15:47 +00002909#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002910 "[OPTION]... SOURCE DEST\n" \
2911 "or: mv [OPTION]... SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002912#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002913 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
2914 "\nOptions:" \
2915 "\n -f Don't prompt before overwriting" \
2916 "\n -i Interactive, prompt before overwrite" \
2917
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002918#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002919 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002920
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002921#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002922 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002923#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002924 "Rename network interface while it in the down state\n" \
2925 "\nOptions:" \
2926 "\n -c FILE Use configuration file (default is /etc/mactab)" \
2927 "\n -s Use syslog (LOCAL0 facility)" \
2928 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
2929
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002930#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002931 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2932 " or\n" \
2933 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002934
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002935#if !ENABLE_DESKTOP
2936
Rob Landley1cca9482006-07-10 19:45:20 +00002937#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002938#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002939#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002940#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002941#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002942
Eric Andersen7e9276b2001-02-22 01:15:47 +00002943#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002944 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002945 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002946#define nc_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002947 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002948 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002949 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002950 "\n -e Exec rest of command line after connect" \
2951 "\n -i SECS Delay interval for lines sent" \
2952 "\n -w SECS Timeout for connect" \
2953 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002954 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002955 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002956 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002957 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002958 "\n (use -l twice with -e for persistent server)") \
2959 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002960 )
2961
Rob Landley1cca9482006-07-10 19:45:20 +00002962#define nc_notes_usage "" \
2963 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002964 "To use netcat as a terminal emulator on a serial port:\n\n" \
2965 "$ stty 115200 -F /dev/ttyS0\n" \
2966 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2967 )
Rob Landley1cca9482006-07-10 19:45:20 +00002968
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002969#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002970 "$ nc foobar.somedomain.com 25\n" \
2971 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2972 "help\n" \
2973 "214-Commands supported:\n" \
2974 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2975 "214 NOOP QUIT RSET HELP\n" \
2976 "quit\n" \
2977 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002978
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002979#else /* DESKTOP nc - much more compatible with nc 1.10 */
2980
2981#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002982 "[-options] hostname port - connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002983 USE_NC_SERVER("\n" \
2984 "nc [-options] -l -p port [hostname] [port] - listen")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002985#define nc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002986 "Options:" \
2987 "\n -e prog [args] Program to exec after connect (must be last)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002988 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002989 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002990 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002991 "\n -n Don't do DNS resolution" \
2992 "\n -s addr Local address" \
2993 "\n -p port Local port" \
2994 "\n -u UDP mode" \
2995 "\n -v Verbose (cumulative: -vv)" \
2996 "\n -w secs Timeout for connects and final net reads" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002997 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002998 "\n -i sec Delay interval for lines sent" /* ", ports scanned" */ \
2999 "\n -o file Hex dump of traffic" \
3000 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003001 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003002/* "\n -r Randomize local and remote ports" */
3003/* "\n -g gateway Source-routing hop point[s], up to 8" */
3004/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003005/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
3006
3007#endif
3008
Eric Andersen1552ff72001-10-31 11:07:12 +00003009#define netstat_trivial_usage \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003010 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")USE_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003011#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003012 "Display networking information\n" \
3013 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003014 "\n -l Display listening server sockets" \
3015 "\n -a Display all sockets (default: connected)" \
3016 "\n -e Display other/more information" \
3017 "\n -n Don't resolve names" \
3018 "\n -t Tcp sockets" \
3019 "\n -u Udp sockets" \
3020 "\n -w Raw sockets" \
3021 "\n -x Unix sockets" \
3022 "\n -r Display routing table" \
3023 USE_FEATURE_NETSTAT_WIDE( \
3024 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003025 ) \
3026 USE_FEATURE_NETSTAT_PRG( \
3027 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003028 )
Eric Andersen1552ff72001-10-31 11:07:12 +00003029
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003030#define nice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003031 "[-n ADJUST] [COMMAND [ARG]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003032#define nice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003033 "Run a program with modified scheduling priority\n" \
3034 "\nOptions:" \
3035 "\n -n ADJUST Adjust the scheduling priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003036
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003037#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003038 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003039#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003040 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003041 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003042 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003043 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003044 "%[niface] Monitor network interface 'iface'\n" \
3045 "%m Monitor allocated memory\n" \
3046 "%[mf] Monitor free memory\n" \
3047 "%[mt] Monitor total memory\n" \
3048 "%s Monitor allocated swap\n" \
3049 "%f Monitor number of used file descriptors\n" \
3050 "%Ni Monitor total/specific IRQ rate\n" \
3051 "%x Monitor context switch rate\n" \
3052 "%p Monitor forks\n" \
3053 "%[pn] Monitor # of processes\n" \
3054 "%b Monitor block io\n" \
3055 "%Nt Show time (with N decimal points)\n" \
3056 "%Nd Milliseconds between updates (default=1000)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003057 "%r Print <cr> instead of <lf> at EOL" \
3058
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003059#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003060 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003061
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003062#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003063 "COMMAND [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003064#define nohup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003065 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003066#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003067 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003068
Eric Andersen7e9276b2001-02-22 01:15:47 +00003069#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003070 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003071#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003072 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003073 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003074#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003075 "$ nslookup localhost\n" \
3076 "Server: default\n" \
3077 "Address: default\n" \
3078 "\n" \
3079 "Name: debian\n" \
3080 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003081
Glenn L McGrath60281112001-11-02 11:39:46 +00003082#define od_trivial_usage \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00003083 "[-aBbcDdeFfHhIiLlOovXx] " USE_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003084#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003085 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00003086 "to standard output. With no FILE or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00003087
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003088#define openvt_trivial_usage \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003089 "[-c NUM] [-sw] [COMMAND [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003090#define openvt_full_usage "\n\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003091 "Start COMMAND on a new virtual terminal\n" \
3092 "\nOptions:" \
3093 "\n -c Use specified VT" \
3094 "\n -s Switch to the VT" \
3095/* "\n -l Run COMMAND as login shell (by prepending '-')" */ \
3096 "\n -w Wait for COMMAND to exit" \
3097
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003098#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003099 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003100
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003101#define parse_trivial_usage \
3102 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
3103#define parse_full_usage "\n\n" \
3104 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
3105
Eric Andersen27f64e12002-06-23 04:24:25 +00003106#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003107 "[OPTION] [name]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003108#define passwd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003109 "Change user's password. If no name is specified,\n" \
3110 "changes the password for the current user.\n" \
3111 "\nOptions:" \
3112 "\n -a Algorithm to use for password (choices: des, md5)" /* ", sha1)" */ \
3113 "\n -d Delete password for the account" \
3114 "\n -l Lock (disable) account" \
3115 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003116
Denis Vlasenko21d10142007-07-20 21:28:41 +00003117#define chpasswd_trivial_usage \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003118 USE_GETOPT_LONG("[--md5|--encrypted]") SKIP_GETOPT_LONG("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003119#define chpasswd_full_usage "\n\n" \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003120 "Read user:password information from stdin " \
Denis Vlasenko397de612008-03-17 08:55:44 +00003121 "and update /etc/passwd accordingly.\n" \
3122 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003123 USE_GETOPT_LONG( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003124 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003125 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003126 ) \
3127 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003128 "\n -e Supplied passwords are in encrypted form" \
3129 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003130 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00003131
Glenn L McGrath655d8142003-06-22 15:32:41 +00003132#define patch_trivial_usage \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003133 "[-p NUM] [-i DIFF] [-R]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003134#define patch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003135 " -p NUM Strip NUM leading components from file names" \
3136 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003137 "\n -R Reverse patch" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003138
Glenn L McGrath655d8142003-06-22 15:32:41 +00003139#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003140 "$ patch -p1 < example.diff\n" \
3141 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00003142
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003143#define pgrep_trivial_usage \
3144 "[-flnovx] pattern"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003145#define pgrep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003146 "Display process(es) selected by regex pattern\n" \
3147 "\nOptions:" \
3148 "\n -l Show command name too" \
3149 "\n -f Match against entire command line" \
3150 "\n -n Show the newest process only" \
3151 "\n -o Show the oldest process only" \
3152 "\n -v Negate the matching" \
3153 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003154
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003155#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00003156#define pidof_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003157 "[OPTION] [NAME...]"
3158#define USAGE_PIDOF "\n\nOptions:"
3159#else
3160#define pidof_trivial_usage \
3161 "[NAME...]"
3162#define USAGE_PIDOF /* none */
3163#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003164#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003165 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003166 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003167 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003168 "\n -s Show only one PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003169 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003170 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003171 "\n Use %PPID to omit pid of pidof's parent") \
3172
Eric Andersen221b2ea2001-07-31 19:06:07 +00003173#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003174 "$ pidof init\n" \
3175 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003176 USE_FEATURE_PIDOF_OMIT( \
3177 "$ pidof /bin/sh\n20351 5973 5950\n") \
3178 USE_FEATURE_PIDOF_OMIT( \
3179 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00003180
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003181#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003182#define ping_trivial_usage \
3183 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003184#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003185 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003186#define ping6_trivial_usage \
3187 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003188#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003189 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003190#else
3191#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003192 "[OPTION]... host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003193#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003194 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3195 "\nOptions:" \
3196 "\n -4, -6 Force IPv4 or IPv6 hostname resolution" \
3197 "\n -c CNT Send only CNT pings" \
3198 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
3199 "\n -I iface/IP Use interface or IP address as source" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003200 "\n -W timeout Seconds to wait for the first response (default:10)" \
3201 "\n (after all -c CNT packets are sent)" \
3202 "\n -w deadline Seconds until ping exits (default:infinite)" \
3203 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003204 "\n -q Quiet, only displays output at start" \
3205 "\n and when finished" \
3206
Eric Andersen51b8bd62002-07-03 11:46:38 +00003207#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003208 "[OPTION]... host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003209#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003210 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3211 "\nOptions:" \
3212 "\n -c CNT Send only CNT pings" \
3213 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
3214 "\n -I iface/IP Use interface or IP address as source" \
3215 "\n -q Quiet, only displays output at start" \
3216 "\n and when finished" \
3217
Eric Andersen51b8bd62002-07-03 11:46:38 +00003218#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003219#define ping_example_usage \
3220 "$ ping localhost\n" \
3221 "PING slag (127.0.0.1): 56 data bytes\n" \
3222 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3223 "\n" \
3224 "--- debian ping statistics ---\n" \
3225 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3226 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003227#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003228 "$ ping6 ip6-localhost\n" \
3229 "PING ip6-localhost (::1): 56 data bytes\n" \
3230 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3231 "\n" \
3232 "--- ip6-localhost ping statistics ---\n" \
3233 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3234 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003235
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003236#define pipe_progress_trivial_usage NOUSAGE_STR
3237#define pipe_progress_full_usage ""
3238
Eric Andersen7e9276b2001-02-22 01:15:47 +00003239#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003240 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003241#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003242 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003243 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003244
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003245#define pkill_trivial_usage \
3246 "[-l] | [-fnovx] [-signal] pattern"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003247#define pkill_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003248 "Send a signal to process(es) selected by regex pattern\n" \
3249 "\nOptions:" \
3250 "\n -l List all signals" \
3251 "\n -f Match against entire command line" \
3252 "\n -n Signal the newest process only" \
3253 "\n -o Signal the oldest process only" \
3254 "\n -v Negate the matching" \
3255 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003256
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003257#define popmaildir_trivial_usage \
3258 "[OPTIONS] Maildir [connection-helper ...]"
3259#define popmaildir_full_usage "\n\n" \
3260 "Fetch content of remote mailbox to local maildir\n" \
3261 "\nOptions:" \
3262 "\n -b Binary mode. Ignored" \
3263 "\n -d Debug. Ignored" \
3264 "\n -m Show used memory. Ignored" \
3265 "\n -V Show version. Ignored" \
3266 "\n -c Use tcpclient. Ignored" \
3267 "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" \
3268 "\n -s Skip authorization" \
3269 "\n -T Get messages with TOP instead with RETR" \
3270 "\n -k Keep retrieved messages on the server" \
3271 "\n -t timeout Set network timeout" \
3272 USE_FEATURE_POPMAILDIR_DELIVERY( \
3273 "\n -F \"program arg1 arg2 ...\" Filter by program. May be multiple" \
3274 "\n -M \"program arg1 arg2 ...\" Deliver by program" \
3275 ) \
3276 "\n -R size Remove old messages on the server >= size (in bytes). Ignored" \
3277 "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" \
3278 "\n -L size Do not retrieve new messages >= size (in bytes). Ignored" \
3279 "\n -H lines Type specified number of lines of a message. Ignored"
3280#define popmaildir_example_usage \
3281 "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n" \
3282 "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
3283
Eric Andersen7e9276b2001-02-22 01:15:47 +00003284#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003285 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003286#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003287 "Halt and shut off power\n" \
3288 "\nOptions:" \
3289 "\n -d Delay interval for halting" \
3290 "\n -n No call to sync()" \
3291 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003292
Mike Frysinger95d3c452005-04-21 23:29:24 +00003293#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003294 "[VARIABLES...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003295#define printenv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003296 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003297 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003298
Eric Andersen7e9276b2001-02-22 01:15:47 +00003299#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003300 "FORMAT [ARGUMENT...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003301#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003302 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003303 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003304#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003305 "$ printf \"Val=%d\\n\" 5\n" \
3306 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003307
Denis Vlasenko94949192006-11-05 00:45:47 +00003308
3309#if ENABLE_DESKTOP
3310
3311#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003312 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003313#define ps_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003314 "Report process status\n" \
3315 "\nOptions:" \
3316 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00003317
3318#else /* !ENABLE_DESKTOP */
3319
Denis Vlasenko397de612008-03-17 08:55:44 +00003320#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003321#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003322#else
3323#define USAGE_PS "\nOptions:"
3324#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003325
Eric Andersen7e9276b2001-02-22 01:15:47 +00003326#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003327 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003328#define ps_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003329 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003330 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003331 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003332 "\n -Z Show SE Linux context" \
3333 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003334 USE_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003335 "\n w Wide output" \
3336 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003337
Denis Vlasenko94949192006-11-05 00:45:47 +00003338#endif /* ENABLE_DESKTOP */
3339
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003340#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003341 "$ ps\n" \
3342 " PID Uid Gid State Command\n" \
3343 " 1 root root S init\n" \
3344 " 2 root root S [kflushd]\n" \
3345 " 3 root root S [kupdate]\n" \
3346 " 4 root root S [kpiod]\n" \
3347 " 5 root root S [kswapd]\n" \
3348 " 742 andersen andersen S [bash]\n" \
3349 " 743 andersen andersen S -bash\n" \
3350 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003351 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003352
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003353#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003354 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003355#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003356 "Scan a host, print all open ports\n" \
3357 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003358 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003359 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003360 "\n -p Scan from this port (default 1)" \
3361 "\n -P Scan up to this port (default 1024)" \
3362 "\n -t Timeout (default 5000 ms)" \
3363 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3364
Eric Andersen7e9276b2001-02-22 01:15:47 +00003365#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003366 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003367#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003368 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003369#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003370 "$ pwd\n" \
3371 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003372
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003373#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003374 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003375#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003376 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003377#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003378 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003379
Eric Andersen7e9276b2001-02-22 01:15:47 +00003380#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003381 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003382#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003383 "Get and possibly set the system date and time from a remote HOST\n" \
3384 "\nOptions:" \
3385 "\n -s Set the system date and time (default)" \
3386 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003387
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00003388#define rdev_trivial_usage \
3389 ""
3390#define rdev_full_usage "\n\n" \
3391 "Print the device node associated with the filesystem mounted at '/'"
3392#define rdev_example_usage \
3393 "$ rdev\n" \
3394 "/dev/mtdblock9 /\n"
3395
Rob Landley0e4690d2006-08-20 22:12:18 +00003396#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003397 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003398#define readahead_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003399 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
3400 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00003401
Eric Andersen7e9276b2001-02-22 01:15:47 +00003402#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003403 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003404#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003405 "Display the value of a symlink" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003406 USE_FEATURE_READLINK_FOLLOW( "\n" \
3407 "\nOptions:" \
3408 "\n -f Canonicalize by following all symlinks") \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003409
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003410#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003411 "[OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003412#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003413 "Options:" \
3414 "\n -m mapfile (Default: /boot/System.map)" \
3415 "\n -p profile (Default: /proc/profile)" \
3416 "\n -M mult Set the profiling multiplier to mult" \
3417 "\n -i Print only info about the sampling step" \
3418 "\n -v Verbose" \
3419 "\n -a Print all symbols, even if count is 0" \
3420 "\n -b Print individual histogram-bin counts" \
3421 "\n -s Print individual counters within functions" \
3422 "\n -r Reset all the counters (root only)" \
3423 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003424
Glenn L McGrath62fae302002-12-10 00:14:33 +00003425#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003426 "pathname..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003427#define realpath_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003428 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00003429
Eric Andersen7e9276b2001-02-22 01:15:47 +00003430#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003431 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003432#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003433 "Reboot the system\n" \
3434 "\nOptions:" \
3435 "\n -d Delay interval for rebooting" \
3436 "\n -n No call to sync()" \
3437 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003438
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003439#define reformime_trivial_usage \
3440 "[OPTION]... [FILE]..."
3441#define reformime_full_usage "\n\n" \
3442 "Parse MIME-encoded message\n" \
3443 "\nOptions:" \
3444 "\n -x prefix Extract content of MIME sections to files" \
3445 "\n -X prog [args] Filter content of MIME sections through prog." \
3446 "\n Must be the last option" \
3447 "\n" \
3448 "\nOther options are silently ignored." \
3449
Eric Andersen7e9276b2001-02-22 01:15:47 +00003450#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003451 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003452#define renice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003453 "Change priority of running processes\n" \
3454 "\nOptions:" \
3455 "\n -n Adjust current nice value (smaller is faster)" \
3456 "\n -p Process id(s) (default)" \
3457 "\n -g Process group id(s)" \
3458 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003459
Eric Andersen7e9276b2001-02-22 01:15:47 +00003460#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003461 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003462#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003463 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003464
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003465#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003466 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003467#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003468 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003469
Denis Vlasenko397137b2007-07-23 14:03:30 +00003470#define restorecon_trivial_usage \
3471 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003472#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003473 "Reset security contexts of files in pathname\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003474 "\n -i Ignore files that do not exist" \
3475 "\n -f file File with list of files to process. Use - for stdin" \
3476 "\n -e directory Directory to exclude" \
3477 "\n -R,-r Recurse directories" \
3478 "\n -n Don't change any file labels" \
3479 "\n -o file Save list of files with incorrect context" \
3480 "\n -v Verbose" \
3481 "\n -vv Show changed labels" \
3482 "\n -F Force reset of context to match file_context" \
3483 "\n for customizable files, or the user section," \
3484 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003485
Eric Andersen7e9276b2001-02-22 01:15:47 +00003486#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003487 "[OPTION]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003488#define rm_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003489 "Remove (unlink) the FILE(s). Use '--' to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003490 "indicate that all following arguments are non-options.\n" \
3491 "\nOptions:" \
3492 "\n -i Always prompt before removing" \
3493 "\n -f Never prompt" \
3494 "\n -r,-R Remove directories recursively" \
3495
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003496#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003497 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003498
Eric Andersen7e9276b2001-02-22 01:15:47 +00003499#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003500 "[OPTION]... DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003501#define rmdir_full_usage "\n\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003502 "Remove the DIRECTORY, if it is empty.\n" \
3503 "\nOptions:" \
3504 USE_FEATURE_RMDIR_LONG_OPTIONS( \
3505 "\n -p|--parents Include parents" \
3506 "\n -ignore-fail-on-non-empty" \
3507 ) \
3508 SKIP_FEATURE_RMDIR_LONG_OPTIONS( \
3509 "\n -p Include parents" \
3510 )
3511
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003512#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003513 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003514
Eric Andersen7e9276b2001-02-22 01:15:47 +00003515#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003516 "[OPTION]... [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003517#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003518 "Unload the specified kernel modules from the kernel\n" \
3519 "\nOptions:" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003520 "\n -w Wait until the module is no longer used" \
3521 "\n -f Force unloading" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003522 "\n -a Remove all unused modules (recursively)" \
3523
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003524#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003525 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003526
Eric Andersen7e9276b2001-02-22 01:15:47 +00003527#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003528 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003529#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003530 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003531 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003532 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003533 "\n -e Display other/more information" \
3534 "\n -A inet" USE_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003535
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003536#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003537 "-i -q[ildc]p package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003538#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003539 "Manipulate RPM packages\n" \
3540 "\nOptions:" \
3541 "\n -i Install package" \
3542 "\n -q Query package" \
3543 "\n -p Query uninstalled package" \
3544 "\n -i Show information" \
3545 "\n -l List contents" \
3546 "\n -d List documents" \
3547 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003548
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003549#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003550 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003551#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003552 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003553
Mike Frysinger6b160e42008-02-15 02:27:19 +00003554#define rtcwake_trivial_usage \
3555 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SECS | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003556#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003557 "Enter a system sleep state until specified wakeup time\n" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003558 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003559 "\n -a,--auto Read clock mode from adjtime" \
3560 "\n -l,--local Clock is set to local time" \
3561 "\n -u,--utc Clock is set to UTC time" \
3562 "\n -d,--device=DEV Specify the RTC device" \
Mike Frysinger1e93f3c2008-06-04 10:33:33 +00003563 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003564 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
3565 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003566 ) \
3567 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003568 "\n -a Read clock mode from adjtime" \
3569 "\n -l Clock is set to local time" \
3570 "\n -u Clock is set to UTC time" \
3571 "\n -d DEV Specify the RTC device" \
3572 "\n -m MODE Set the sleep state (default: standby)" \
3573 "\n -s SEC Set the timeout in SEC seconds from now" \
3574 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003575 )
3576
Denis Vlasenko49622d72007-03-10 16:58:49 +00003577#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003578 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3579 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003580#define runcon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003581 "Run a program in a different security context\n" \
3582 "\n CONTEXT Complete security context\n" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003583 USE_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003584 "\n -c,--compute Compute process transition context before modifying" \
3585 "\n -t,--type=TYPE Type (for same role as parent)" \
3586 "\n -u,--user=USER User identity" \
3587 "\n -r,--role=ROLE Role" \
3588 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003589 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003590 SKIP_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003591 "\n -c Compute process transition context before modifying" \
3592 "\n -t TYPE Type (for same role as parent)" \
3593 "\n -u USER User identity" \
3594 "\n -r ROLE Role" \
3595 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003596 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003597
Eric Andersen6cf47a72001-10-31 10:24:36 +00003598#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003599 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003600#define run_parts_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003601 "Run a bunch of scripts in a directory\n" \
3602 "\nOptions:" \
3603 "\n -t Print what would be run, but don't actually run anything" \
3604 "\n -a ARG Pass ARG as argument for every program" \
3605 "\n -u MASK Set the umask to MASK before running every program" \
3606 USE_FEATURE_RUN_PARTS_FANCY( \
3607 "\n -l Print names of all matching files even if they are not executable" \
3608 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003609
3610#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003611 "$ run-parts -a start /etc/init.d\n" \
3612 "$ run-parts -a stop=now /etc/init.d\n\n" \
3613 "Let's assume you have a script foo/dosomething:\n" \
3614 "#!/bin/sh\n" \
3615 "for i in $*; do eval $i; done; unset i\n" \
3616 "case \"$1\" in\n" \
3617 "start*) echo starting something;;\n" \
3618 "stop*) set -x; shutdown -h $stop;;\n" \
3619 "esac\n\n" \
3620 "Running this yields:\n" \
3621 "$run-parts -a stop=+4m foo/\n" \
3622 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003623
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003624#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003625 "[utmp]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003626#define runlevel_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003627 "Find the current and previous system runlevel.\n\n" \
3628 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003629 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003630#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003631 "$ runlevel /var/run/utmp\n" \
3632 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003633
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003634#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003635 "dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003636#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003637 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003638
3639#define runsvdir_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003640 "[-P] [-s SCRIPT] dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003641#define runsvdir_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003642 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
3643 "\n -P Put each runsv in a new session" \
3644 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003645
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003646#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003647 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003648#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003649 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003650#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003651 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003652
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003653#define script_trivial_usage \
3654 "[-afq] [-c COMMAND] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003655#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003656 "Options:" \
3657 "\n -a Append output" \
3658 "\n -c Run COMMAND, not shell" \
3659 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003660 "\n -q Quiet" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003661
Eric Andersen7e9276b2001-02-22 01:15:47 +00003662#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003663 "[-efinr] pattern [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003664#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003665 "Options:" \
3666 "\n -e script Add the script to the commands to be executed" \
3667 "\n -f scriptfile Add scriptfile contents to the" \
3668 "\n commands to be executed" \
3669 "\n -i Edit files in-place" \
3670 "\n -n Suppress automatic printing of pattern space" \
3671 "\n -r Use extended regular expression syntax" \
3672 "\n" \
3673 "\nIf no -e or -f is given, the first non-option argument is taken as the sed" \
3674 "\nscript to interpret. All remaining arguments are names of input files; if no" \
3675 "\ninput files are specified, then the standard input is read. Source files" \
3676 "\nwill not be modified unless -i option is given." \
Eric Andersenf802ff72004-04-12 15:12:06 +00003677
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003678#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003679 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3680 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003681
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003682#define selinuxenabled_trivial_usage NOUSAGE_STR
3683#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003684
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003685#define sendmail_trivial_usage \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003686 "[OPTIONS] [rcpt]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003687#define sendmail_full_usage "\n\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003688 "Send an email\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003689 "\nOptions:" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003690 "\n -w timeout Network timeout" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003691 "\n -N type Request delivery notification. Type is ignored" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003692 "\n -f sender Sender" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003693 "\n -F fullname Sender full name. Overrides $NAME" \
3694 USE_FEATURE_SENDMAIL_MAILX( \
3695 "\n -s subject Subject" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003696 "\n -j charset Assume charset for body and subject (" CONFIG_FEATURE_MIME_CHARSET ")" \
Denis Vlasenko7e0c2432009-03-02 16:12:00 +00003697 "\n -a file File to attach. May be repeated" \
3698 "\n -H 'prog args' Run connection helper. E.g. openssl for encryption:" \
3699 "\n -H 'exec openssl s_client -quiet -tls1 -starttls smtp" \
3700 "\n -connect smtp.gmail.com:25' <email.txt" \
Denis Vlasenko021de3f2009-03-04 17:56:00 +00003701 "\n [4<username_and_passwd.txt]" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003702 "\n -S server[:port] Server" \
3703 ) \
3704 USE_FEATURE_SENDMAIL_MAILXX( \
Denis Vlasenko7e0c2432009-03-02 16:12:00 +00003705 "\n -c rcpt Cc: recipient. May be repeated" \
Denis Vlasenko2b2d9772008-09-28 13:50:57 +00003706 "\n -e rcpt Errors-To: recipient" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003707 ) \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003708 "\n -t Read recipients and subject from body" \
3709 "\n" \
3710 "\nOther options are silently ignored; -oi is implied" \
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003711
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003712#define seq_trivial_usage \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003713 "[-w] [-s SEP] [FIRST [INC]] LAST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003714#define seq_full_usage "\n\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003715 "Print numbers from FIRST to LAST, in steps of INC.\n" \
3716 "FIRST, INC default to 1\n" \
3717 "\nOptions:" \
3718 "\n -w Pad to last with leading zeros" \
3719 "\n -s SEP String separator" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003720
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003721#define sestatus_trivial_usage \
3722 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003723#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003724 " -v Verbose" \
3725 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003726
Paul Foxfc2256a2005-08-01 18:12:30 +00003727#define setconsole_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003728 "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003729#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003730 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3731 "\nOptions:" \
3732 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003733
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003734#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003735 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003736#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003737
Denis Vlasenko397137b2007-07-23 14:03:30 +00003738#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003739 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003740 USE_FEATURE_SETFILES_CHECK_OPTION( \
3741 " [-c policyfile] spec_file" \
3742 ) \
3743 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003744#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003745 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003746 USE_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003747 "\n -c file Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003748 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003749 "\n -d Show which specification matched each file" \
3750 "\n -l Log changes in file labels to syslog" \
3751 "\n -n Don't change any file labels" \
3752 "\n -q Suppress warnings" \
3753 "\n -r dir Use an altenate root path" \
3754 "\n -e dir Exclude directory" \
3755 "\n -F Force reset of context to match file_context for customizable files" \
3756 "\n -o file Save list of files with incorrect context" \
3757 "\n -s Take a list of files from standard input (instead of command line)" \
3758 "\n -v Show changes in file labels, if type or role are changing" \
3759 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3760 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003761
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003762#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003763 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003764#define setfont_full_usage "\n\n" \
3765 "Load a console font\n" \
3766 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003767 "\n -m MAPFILE Load console screen map" \
3768 "\n -C TTY Affect TTY instead of /dev/tty" \
3769
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003770#define setfont_example_usage \
3771 "$ setfont -m koi8-r /etc/i18n/fontname\n"
3772
Eric Andersen7e9276b2001-02-22 01:15:47 +00003773#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003774 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003775#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003776 "Set entries into the kernel's scancode-to-keycode map,\n" \
3777 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3778 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003779 "and KEYCODE is given in decimal" \
3780
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003781#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003782 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003783
Rob Landley87848d92006-03-27 23:23:43 +00003784#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003785 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003786#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003787 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003788
Denis Vlasenkobe039372007-10-14 04:48:44 +00003789#define setsebool_trivial_usage \
3790 "boolean value"
3791
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003792#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00003793 "Change boolean setting"
3794
Paul Fox42403642005-08-01 22:52:09 +00003795#define setsid_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003796 "PROG [ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003797#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003798 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3799 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3800 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003801
Matt Kraai2d91deb2001-08-01 17:21:35 +00003802#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003803 "[FILE]...\n" \
3804 "or: sh -c command [args]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003805#define lash_full_usage "\n\n" \
Denis Vlasenko96702ca2007-11-23 23:28:55 +00003806 "lash is deprecated, please use hush"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003807
Eric Andersen2e9c2572003-08-08 22:26:06 +00003808#define last_trivial_usage \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003809 ""USE_FEATURE_LAST_FANCY("[-HW] [-f file]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003810#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003811 "Show listing of the last users that logged into the system" \
3812 USE_FEATURE_LAST_FANCY( "\n" \
3813 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00003814/* "\n -H Show header line" */ \
3815 "\n -W Display with no host column truncation" \
3816 "\n -f file Read from file instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003817 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00003818
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00003819#define showkey_trivial_usage \
3820 "[-a | -k | -s]"
3821#define showkey_full_usage "\n\n" \
3822 "Show keys pressed\n" \
3823 "\nOptions:" \
3824 "\n -a Display decimal/octal/hex values of the keys" \
3825 "\n -k Display interpreted keycodes (default)" \
3826 "\n -s Display raw scan-codes" \
3827
Denis Vlasenko14923db2007-06-20 15:23:03 +00003828#define slattach_trivial_usage \
3829 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003830#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003831 "Attach network interface(s) to serial line(s)\n" \
3832 "\nOptions:" \
3833 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3834 "\n -s Set line speed" \
3835 "\n -e Exit after initializing device" \
3836 "\n -h Exit when the carrier is lost" \
3837 "\n -c Execute a command when the line is hung up" \
3838 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3839 "\n -L Enable 3-wire operation" \
3840 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003841
Eric Andersen7e9276b2001-02-22 01:15:47 +00003842#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003843 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003844#define sleep_full_usage "\n\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003845 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003846 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003847 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003848 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003849#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003850 "$ sleep 2\n" \
3851 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003852 USE_FEATURE_FANCY_SLEEP( \
3853 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003854 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003855
Eric Andersen7e9276b2001-02-22 01:15:47 +00003856#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003857 "[-nru" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003858 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003859 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003860#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003861 "Sort lines of text\n" \
3862 "\nOptions:" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003863 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003864 "\n -b Ignore leading blanks" \
3865 "\n -c Check whether input is sorted" \
3866 "\n -d Dictionary order (blank or alphanumeric only)" \
3867 "\n -f Ignore case" \
3868 "\n -g General numerical sort" \
3869 "\n -i Ignore unprintable characters" \
3870 "\n -k Sort key" \
3871 "\n -M Sort month" \
3872 ) \
3873 "\n -n Sort numbers" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003874 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003875 "\n -o Output to file" \
3876 "\n -k Sort by key" \
3877 "\n -t CHAR Key separator" \
3878 ) \
3879 "\n -r Reverse sort order" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003880 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003881 "\n -s Stable (don't sort ties alphabetically)" \
3882 ) \
3883 "\n -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003884 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003885 "\n -z Lines are terminated by NUL, not newline" \
3886 "\n -mST Ignored for GNU compatibility") \
3887
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003888#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003889 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3890 "a\n" \
3891 "b\n" \
3892 "c\n" \
3893 "d\n" \
3894 "e\n" \
3895 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003896 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003897 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3898 "d 2\n" \
3899 "b 2\n" \
3900 "c 3\n" \
3901 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003902 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003903
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003904#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003905 "[OPTION] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003906#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003907 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003908 "\n -b n[k|m] Split by bytes" \
3909 "\n -l n Split by lines" \
3910 "\n -a n Use n letters as suffix" \
3911
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003912#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003913 "$ split TODO foo\n" \
3914 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003915
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003916#define start_stop_daemon_trivial_usage \
Denis Vlasenko7987a182008-07-01 10:00:46 +00003917 "[OPTIONS] [-S|-K] ... [-- arguments...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003918#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003919 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003920 "-K: stop all matching processes.\n" \
3921 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003922 USE_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003923 "\nProcess matching:" \
3924 "\n -u,--user USERNAME|UID Match only this user's processes" \
3925 "\n -n,--name NAME Match processes with NAME" \
3926 "\n in comm field in /proc/PID/stat" \
3927 "\n -x,--exec EXECUTABLE Match processes with this command" \
3928 "\n in /proc/PID/cmdline" \
3929 "\n -p,--pidfile FILE Match a process with PID from the file" \
3930 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003931 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003932 "\n -x,--exec EXECUTABLE Program to run" \
3933 "\n -a,--startas NAME Zeroth argument" \
3934 "\n -b,--background Background" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003935 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003936 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003937 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003938 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
3939 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003940 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003941 "\n -s,--signal SIG Signal to send" \
3942 "\n -t,--test Match only, exit with 0 if a process is found" \
3943 "\nOther:" \
3944 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3945 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003946 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003947 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003948 "\n -q,--quiet Quiet" \
3949 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003950 SKIP_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003951 "\nProcess matching:" \
3952 "\n -u USERNAME|UID Match only this user's processes" \
3953 "\n -n NAME Match processes with NAME" \
3954 "\n in comm field in /proc/PID/stat" \
3955 "\n -x EXECUTABLE Match processes with this command" \
3956 "\n command in /proc/PID/cmdline" \
3957 "\n -p FILE Match a process with PID from the file" \
3958 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003959 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003960 "\n -x EXECUTABLE Program to run" \
3961 "\n -a NAME Zeroth argument" \
3962 "\n -b Background" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003963 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003964 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003965 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003966 "\n -c USER[:[GRP]] Change to user/group" \
3967 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003968 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003969 "\n -s SIG Signal to send" \
3970 "\n -t Match only, exit with 0 if a process is found" \
3971 "\nOther:" \
3972 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3973 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003974 "\n -v Verbose" \
3975 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003976 "\n -q Quiet" \
3977 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003978
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003979#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003980 "[OPTION] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003981#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003982 "Display file (default) or filesystem status\n" \
3983 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003984 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003985 "\n -c fmt Use the specified format" \
3986 ) \
3987 "\n -f Display filesystem status" \
3988 "\n -L Dereference links" \
3989 "\n -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003990 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003991 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003992 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003993 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003994 "\n\nValid format sequences for files:\n" \
3995 " %a Access rights in octal\n" \
3996 " %A Access rights in human readable form\n" \
3997 " %b Number of blocks allocated (see %B)\n" \
3998 " %B The size in bytes of each block reported by %b\n" \
3999 " %d Device number in decimal\n" \
4000 " %D Device number in hex\n" \
4001 " %f Raw mode in hex\n" \
4002 " %F File type\n" \
4003 " %g Group ID of owner\n" \
4004 " %G Group name of owner\n" \
4005 " %h Number of hard links\n" \
4006 " %i Inode number\n" \
4007 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00004008 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004009 " %o I/O block size\n" \
4010 " %s Total size, in bytes\n" \
4011 " %t Major device type in hex\n" \
4012 " %T Minor device type in hex\n" \
4013 " %u User ID of owner\n" \
4014 " %U User name of owner\n" \
4015 " %x Time of last access\n" \
4016 " %X Time of last access as seconds since Epoch\n" \
4017 " %y Time of last modification\n" \
4018 " %Y Time of last modification as seconds since Epoch\n" \
4019 " %z Time of last change\n" \
4020 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004021 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004022 " %a Free blocks available to non-superuser\n" \
4023 " %b Total data blocks in file system\n" \
4024 " %c Total file nodes in file system\n" \
4025 " %d Free file nodes in file system\n" \
4026 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004027 USE_SELINUX( \
4028 " %C Security context in SELinux\n" \
4029 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004030 " %i File System ID in hex\n" \
4031 " %l Maximum length of filenames\n" \
4032 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004033 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004034 " %S Fundamental block size (for block counts)\n" \
4035 " %t Type in hex\n" \
4036 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004037 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004038
Eric Andersenef5e8f82002-11-07 02:09:37 +00004039#define strings_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004040 "[-afo] [-n length] [file...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004041#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004042 "Display printable strings in a binary file\n" \
4043 "\nOptions:" \
4044 "\n -a Scan whole file (default)" \
4045 "\n -f Precede strings with filenames" \
4046 "\n -n N At least N characters form a string (default 4)" \
4047 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00004048
Eric Andersen7e9276b2001-02-22 01:15:47 +00004049#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004050 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004051#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004052 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004053 "and deviations from stty sane\n" \
4054 "\nOptions:" \
4055 "\n -F DEVICE Open device instead of stdin" \
4056 "\n -a Print all current settings in human-readable form" \
4057 "\n -g Print in stty-readable form" \
4058 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004059
Robert Griebl1fca5582002-06-04 20:45:46 +00004060#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004061 "[OPTION]... [-] [username]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004062#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004063 "Change user id or become root\n" \
4064 "\nOptions:" \
4065 "\n -p, -m Preserve environment" \
4066 "\n -c Command to pass to 'sh -c'" \
4067 "\n -s Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00004068
Eric Andersen27f64e12002-06-23 04:24:25 +00004069#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004070 "[OPTION]... [tty-device]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004071#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004072 "Single user login\n" \
4073 "\nOptions:" \
4074 "\n -t Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004075
Mike Frysinger95d3c452005-04-21 23:29:24 +00004076#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004077 "[rs] [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004078#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004079 "Checksum and count the blocks in a file\n" \
4080 "\nOptions:" \
4081 "\n -r Use BSD sum algorithm (1K blocks)" \
4082 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00004083
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004084#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004085 "[-v] [-w sec] command service..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004086#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004087 "Control services monitored by runsv supervisor.\n" \
4088 "Commands (only first character is enough):\n" \
4089 "\n" \
4090 "status: query service status\n" \
4091 "up: if service isn't running, start it. If service stops, restart it\n" \
4092 "once: like 'up', but if service stops, don't restart it\n" \
4093 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004094 " if it exists. After it stops, do not restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004095 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004096 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004097 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004098 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004099
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004100#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004101 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004102#define svlogd_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004103 "Continuously read log data from standard input, optionally " \
4104 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko397de612008-03-17 08:55:44 +00004105 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004106
Eric Andersen7e9276b2001-02-22 01:15:47 +00004107#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004108 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004109#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004110 "Stop swapping on DEVICE\n" \
4111 "\nOptions:" \
4112 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004113
Eric Andersen7e9276b2001-02-22 01:15:47 +00004114#define swapon_trivial_usage \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004115 "[-a]" USE_FEATURE_SWAPON_PRI(" [-p pri]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004116#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004117 "Start swapping on DEVICE\n" \
4118 "\nOptions:" \
4119 "\n -a Start swapping on all swap devices" \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004120 USE_FEATURE_SWAPON_PRI( \
4121 "\n -p pri Set swap device priority" \
4122 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004123
Rob Landley0f34a822005-10-27 22:55:50 +00004124#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004125 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004126#define switch_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004127 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004128 "and exec NEW_INIT\n" \
4129 "\nOptions:" \
4130 "\n -c Redirect console to device on new root" \
Rob Landley0f34a822005-10-27 22:55:50 +00004131
Eric Andersen7e9276b2001-02-22 01:15:47 +00004132#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004133 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004134#define sync_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004135 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004136
Eric Andersenb9050282003-12-24 06:02:11 +00004137#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004138 "[OPTIONS]... [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004139#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004140 "Configure kernel parameters at runtime\n" \
4141 "\nOptions:" \
4142 "\n -n Disable printing of key names" \
4143 "\n -e Don't warn about unknown keys" \
4144 "\n -w Change sysctl setting" \
4145 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
4146 "\n -a Display all values" \
4147 "\n -A Display all values in table form" \
4148
Eric Andersen5d38f5b2005-09-12 21:42:48 +00004149#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00004150 "sysctl [-n] [-e] variable...\n" \
4151 "sysctl [-n] [-e] -w variable=value...\n" \
4152 "sysctl [-n] [-e] -a\n" \
4153 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
4154 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00004155
Eric Andersen7e9276b2001-02-22 01:15:47 +00004156#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004157 "[OPTION]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004158#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004159 "System logging utility.\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004160 "Note that this version of syslogd ignores /etc/syslog.conf.\n" \
4161 "\nOptions:" \
4162 "\n -n Run in foreground" \
4163 "\n -O FILE Log to given file (default=/var/log/messages)" \
4164 "\n -l n Set local log level" \
4165 "\n -S Smaller logging output" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004166 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004167 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
4168 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004169 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004170 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
4171 "\n -L Log locally and via network (default is network only if -R)") \
4172 USE_FEATURE_SYSLOGD_DUP( \
4173 "\n -D Drop duplicates") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004174 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004175 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00004176 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004177/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00004178
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004179#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004180 "$ syslogd -R masterlog:514\n" \
4181 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004182
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004183#define tac_trivial_usage \
4184 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004185#define tac_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004186 "Concatenate FILE(s) and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004187
Eric Andersen7e9276b2001-02-22 01:15:47 +00004188#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004189 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004190#define tail_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004191 "Print last 10 lines of each FILE to standard output.\n" \
4192 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004193 "file name. With no FILE, or when FILE is -, read standard input.\n" \
4194 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004195 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004196 "\n -c N[kbm] Output the last N bytes") \
4197 "\n -n N[kbm] Print last N lines instead of last 10" \
4198 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004199 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004200 "\n -q Never output headers giving file names" \
4201 "\n -s SEC Wait SEC seconds between reads with -f" \
4202 "\n -v Always output headers giving file names" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004203 "\n" \
4204 "\nIf the first character of N (bytes or lines) is a '+', output begins with" \
4205 "\nthe Nth item from the start of each file, otherwise, print the last N items" \
4206 "\nin the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004207
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004208#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004209 "$ tail -n 1 /etc/resolv.conf\n" \
4210 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004211
Eric Andersen7e9276b2001-02-22 01:15:47 +00004212#define tar_trivial_usage \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004213 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_SEAMLESS_GZ("z") \
4214 USE_FEATURE_SEAMLESS_BZ2("j") USE_FEATURE_SEAMLESS_LZMA("a") \
4215 USE_FEATURE_SEAMLESS_Z("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00004216 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004217 "[-f TARFILE] [-C DIR] [FILE(s)]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004218#define tar_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004219 "Create, extract, or list files from a tar file\n" \
4220 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004221 USE_FEATURE_TAR_CREATE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004222 "\n c Create") \
4223 "\n x Extract" \
4224 "\n t List" \
4225 "\nArchive format selection:" \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004226 USE_FEATURE_SEAMLESS_GZ( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004227 "\n z Filter the archive through gzip" \
4228 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004229 USE_FEATURE_SEAMLESS_BZ2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004230 "\n j Filter the archive through bzip2" \
4231 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004232 USE_FEATURE_SEAMLESS_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004233 "\n a Filter the archive through lzma" \
4234 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004235 USE_FEATURE_SEAMLESS_Z( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004236 "\n Z Filter the archive through compress" \
4237 ) \
4238 "\nFile selection:" \
4239 "\n f Name of TARFILE or \"-\" for stdin" \
4240 "\n O Extract to stdout" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004241 USE_FEATURE_TAR_FROM( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004242 "\n exclude File to exclude" \
4243 "\n X File with names to exclude" \
4244 ) \
4245 "\n C Change to directory DIR before operation" \
4246 "\n v Verbose" \
4247
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004248#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004249 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
4250 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004251
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004252#define taskset_trivial_usage \
Denis Vlasenkob44c7902008-03-17 09:29:43 +00004253 "[-p] [mask] [pid | command [arg]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004254#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004255 "Set or get CPU affinity\n" \
4256 "\nOptions:" \
4257 "\n -p Operate on an existing PID" \
4258
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004259#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004260 "$ taskset 0x7 ./dgemm_test&\n" \
4261 "$ taskset -p 0x1 $!\n" \
4262 "pid 4790's current affinity mask: 7\n" \
4263 "pid 4790's new affinity mask: 1\n" \
4264 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4265 "pid 6671's current affinity mask: 1\n" \
4266 "pid 6671's new affinity mask: 1\n" \
4267 "$ taskset -p 1\n" \
4268 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004269
Eric Andersen7e9276b2001-02-22 01:15:47 +00004270#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004271 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004272#define tee_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004273 "Copy standard input to each FILE, and also to standard output\n" \
4274 "\nOptions:" \
4275 "\n -a Append to the given FILEs, do not overwrite" \
4276 "\n -i Ignore interrupt signals (SIGINT)" \
4277
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004278#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004279 "$ echo \"Hello\" | tee /tmp/foo\n" \
4280 "$ cat /tmp/foo\n" \
4281 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004282
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004283#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004284#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004285 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004286#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004287 "Connect to telnet server\n" \
4288 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004289 "\n -a Automatic login with $USER variable" \
4290 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004291
Eric Andersen539ffc92004-02-22 12:25:47 +00004292#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004293#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004294 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004295#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004296 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004297#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004298
Eric Andersen08a72202002-09-30 20:52:10 +00004299#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004300 "[OPTION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004301#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004302 "Handle incoming telnet connections" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004303 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
4304 "\nOptions:" \
4305 "\n -l LOGIN Exec LOGIN on connect" \
4306 "\n -f issue_file Display issue_file instead of /etc/issue" \
4307 "\n -K Close connection as soon as login exits" \
4308 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004309 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004310 "\n -p PORT Port to listen on" \
4311 "\n -b ADDR Address to bind to" \
4312 "\n -F Run in foreground" \
4313 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004314 )
Eric Andersen08a72202002-09-30 20:52:10 +00004315
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004316/* "test --help" does not print help (POSIX compat), only "[ --help" does.
4317 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION") */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004318#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004319 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004320#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004321 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4322 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004323#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004324 "$ test 1 -eq 2\n" \
4325 "$ echo $?\n" \
4326 "1\n" \
4327 "$ test 1 -eq 1\n" \
4328 "$ echo $?\n" \
4329 "0\n" \
4330 "$ [ -d /etc ]\n" \
4331 "$ echo $?\n" \
4332 "0\n" \
4333 "$ [ -d /junk ]\n" \
4334 "$ echo $?\n" \
4335 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004336
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004337#define tc_trivial_usage \
4338 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
4339#define tc_full_usage "\n\n" \
4340 "OBJECT: {qdisc|class|filter}\n" \
4341 "CMD: {add|del|change|replace|show}\n" \
4342 "\n" \
4343 "qdisc [ handle QHANDLE ] [ root |"USE_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
4344 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4345 "\t[ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4346 "\tQDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
4347 "qdisc show [ dev STRING ]"USE_FEATURE_TC_INGRESS(" [ingress]")"\n" \
4348 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
4349 "\t[ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4350 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
4351 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
4352 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4353 "\t[ root | classid CLASSID ] [ handle FILTERID ]\n" \
4354 "\t[ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
4355 "filter show [ dev STRING ] [ root | parent CLASSID ]"
4356
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004357#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004358 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004359/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004360/* "[-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 +00004361#define tcpsvd_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004362 "Create TCP socket, bind it to ip:port and listen\n" \
4363 "for incoming connection. Run PROG for each connection.\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004364 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004365 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004366 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004367 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4368 "\n-u user[:group] Change to user/group after bind" \
4369 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004370 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004371 "\n-C n[:msg] Allow only up to n connections from the same IP" \
4372 "\n New connections from this IP address are closed" \
4373 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004374 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004375 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004376 "\n-v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004377
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004378#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00004379 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004380#define udpsvd_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004381 "Create UDP socket, bind it to ip:port and wait\n" \
4382 "for incoming packets. Run PROG for each packet,\n" \
4383 "redirecting all further packets with same peer ip:port to it\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004384 "\nip IP to listen on. '0' = all" \
4385 "\nport Port to listen on" \
4386 "\nprog [arg] Program to run" \
4387 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4388 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004389 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004390 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004391 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004392 "\n-v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004393
Mark Whitley450736c2001-03-02 19:08:50 +00004394#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004395 "[OPTION]... HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004396#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004397 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004398 "\nOptions:" \
4399 "\n -l FILE Local FILE" \
4400 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004401 USE_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004402 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004403 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004404 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004405 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004406 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004407 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004408 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004409 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004410
4411#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004412 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004413#define tftpd_full_usage "\n\n" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004414 "Transfer a file on tftp client's request.\n" \
Denis Vlasenko91f8f822008-10-30 23:42:37 +00004415 "\n" \
4416 "tftpd should be used as an inetd service.\n" \
4417 "tftpd's line for inetd.conf:\n" \
4418 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
4419 "It also can be ran from udpsvd:\n" \
4420 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004421 "\nOptions:" \
4422 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004423 "\n -c Allow file creation via upload" \
4424 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004425
Eric Andersenc3657422001-11-30 07:54:32 +00004426#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004427 "[OPTION]... COMMAND [ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004428#define time_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004429 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004430 "COMMAND's resource usage information is displayed.\n" \
4431 "\nOptions:" \
4432 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004433
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004434#define timeout_trivial_usage \
4435 "[-t SECS] [-s SIG] PROG [ARGS]"
4436#define timeout_full_usage "\n\n" \
4437 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
Denis Vlasenko42404082008-11-24 13:42:24 +00004438 "Defaults: SECS: 10, SIG: TERM." \
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004439
Eric Andersen420b2082002-09-17 22:14:58 +00004440#define top_trivial_usage \
Denis Vlasenko42cc6ba2008-09-25 11:17:10 +00004441 "[-b] [-nCOUNT] [-dSECONDS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004442#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004443 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004444 "Read the status of all processes from /proc each SECONDS\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004445 "and show the status for however many processes will fit on the screen." \
Eric Andersen420b2082002-09-17 22:14:58 +00004446
Eric Andersen7e9276b2001-02-22 01:15:47 +00004447#define touch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004448 "[-c] FILE [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004449#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004450 "Update the last-modified date on the given FILE[s]\n" \
4451 "\nOptions:" \
4452 "\n -c Do not create any files" \
4453
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004454#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004455 "$ ls -l /tmp/foo\n" \
4456 "/bin/ls: /tmp/foo: No such file or directory\n" \
4457 "$ touch /tmp/foo\n" \
4458 "$ ls -l /tmp/foo\n" \
4459 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004460
4461#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004462 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004463#define tr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004464 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004465 "standard input, writing to standard output\n" \
4466 "\nOptions:" \
4467 "\n -c Take complement of STRING1" \
4468 "\n -d Delete input characters coded STRING1" \
4469 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4470
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004471#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004472 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4473 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004474
Eric Andersen5c58d282001-07-10 16:29:00 +00004475#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004476 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
4477 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004478 " [-z pausemsecs] HOST [data size]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004479#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004480 "Trace the route to HOST\n" \
4481 "\nOptions:" \
4482 "\n -F Set the don't fragment bit" \
4483 "\n -I Use ICMP ECHO instead of UDP datagrams" \
4484 "\n -l Display the ttl value of the returned packet" \
4485 "\n -d Set SO_DEBUG options to socket" \
4486 "\n -n Print hop addresses numerically rather than symbolically" \
4487 "\n -r Bypass the normal routing tables and send directly to a host" \
4488 "\n -v Verbose" \
4489 "\n -m max_ttl Max time-to-live (max number of hops)" \
4490 "\n -p port# Base UDP port number used in probes" \
4491 "\n (default is 33434)" \
4492 "\n -q nqueries Number of probes per 'ttl' (default 3)" \
4493 "\n -s src_addr IP address to use as the source address" \
4494 "\n -t tos Type-of-service in probe packets (default 0)" \
4495 "\n -w wait Time in seconds to wait for a response" \
4496 "\n (default 3 sec)" \
4497 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004498
Eric Andersen7e9276b2001-02-22 01:15:47 +00004499#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004500 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004501#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004502 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004503#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004504 "$ true\n" \
4505 "$ echo $?\n" \
4506 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004507
Eric Andersen7e9276b2001-02-22 01:15:47 +00004508#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004509 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004510#define tty_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004511 "Print file name of standard input's terminal" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004512 USE_INCLUDE_SUSv2( "\n" \
4513 "\nOptions:" \
4514 "\n -s Print nothing, only return exit status" \
4515 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004516#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004517 "$ tty\n" \
4518 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004519
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004520#define ttysize_trivial_usage \
4521 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004522#define ttysize_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004523 "Print dimension(s) of standard input's terminal, on error return 80x25"
4524
Denis Vlasenko39b68132009-01-23 02:07:14 +00004525#define tunctl_trivial_usage \
4526 "[-f device] ([-t name] | -d name)" USE_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]")
4527#define tunctl_full_usage "\n\n" \
4528 "Create or delete tun interfaces" \
4529 "\nOptions:" \
4530 "\n -f name tun device (/dev/net/tun)" \
4531 "\n -t name Create iface 'name'" \
4532 "\n -d name Delete iface 'name'" \
4533USE_FEATURE_TUNCTL_UG( \
4534 "\n -u owner Set iface owner" \
4535 "\n -g group Set iface group" \
4536 "\n -b Brief output" \
4537)
4538#define tunctl_example_usage \
4539 "# tunctl\n" \
4540 "# tunctl -d tun0\n"
4541
Mike Frysinger174808c2005-06-11 01:14:09 +00004542#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004543 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
4544 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
4545 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
4546 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
4547 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
4548 "[-T last-check-time] [-U UUID] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004549#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004550 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004551
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004552#define udhcpc_trivial_usage \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004553 "[-Cfbnqtvo] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004554 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." USE_FEATURE_UDHCP_PORT(" [-P N]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004555#define udhcpc_full_usage "\n\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004556 USE_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004557 " -V,--vendorclass=CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004558 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
4559 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
4560 "\n -c,--clientid=CLIENTID Client identifier" \
4561 "\n -C,--clientid-none Suppress default client identifier" \
4562 "\n -p,--pidfile=file Create pidfile" \
4563 "\n -r,--request=IP IP address to request" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +00004564 "\n -s,--script=file Run file at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004565 "\n -t,--retries=N Send up to N request packets" \
4566 "\n -T,--timeout=N Try to get a lease for N seconds (default 3)" \
4567 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004568 "\n -O,--request-option=OPT Request DHCP option OPT (cumulative)" \
4569 "\n -o,--no-default-options Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004570 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004571 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004572 "\n -b,--background Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004573 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004574 "\n -S,--syslog Log to syslog too" \
4575 "\n -n,--now Exit with failure if lease is not immediately obtained" \
4576 "\n -q,--quit Quit after obtaining lease" \
4577 "\n -R,--release Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004578 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004579 "\n -P,--client-port N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004580 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004581 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004582 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004583 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004584 ) \
4585 SKIP_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004586 " -V CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004587 "\n -i INTERFACE Interface to use (default: eth0)" \
4588 "\n -H,-h HOSTNAME Client hostname" \
4589 "\n -c CLIENTID Client identifier" \
4590 "\n -C Suppress default client identifier" \
4591 "\n -p file Create pidfile" \
4592 "\n -r IP IP address to request" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +00004593 "\n -s file Run file at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004594 "\n -t N Send up to N request packets" \
4595 "\n -T N Try to get a lease for N seconds (default 3)" \
4596 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004597 "\n -O OPT Request DHCP option OPT (cumulative)" \
4598 "\n -o Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004599 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004600 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004601 "\n -b Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004602 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004603 "\n -S Log to syslog too" \
4604 "\n -n Exit with failure if lease is not immediately obtained" \
4605 "\n -q Quit after obtaining lease" \
4606 "\n -R Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004607 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004608 "\n -P N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004609 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004610 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004611 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004612 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004613 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004614
Russ Dill61fb4892002-10-14 21:41:28 +00004615#define udhcpd_trivial_usage \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004616 "[-fS]" USE_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004617
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004618#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004619 "DHCP server\n" \
4620 "\n -f Run in foreground" \
4621 "\n -S Log to syslog too" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004622 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004623 "\n -P N Use port N instead of default 67" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004624 )
Russ Dill61fb4892002-10-14 21:41:28 +00004625
Eric Andersen7e9276b2001-02-22 01:15:47 +00004626#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004627 "[flags] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004628#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004629 "Unmount file systems\n" \
4630 "\nOptions:" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00004631 USE_FEATURE_UMOUNT_ALL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004632 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
4633 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004634 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004635 "\n -n Don't erase /etc/mtab entries" \
4636 ) \
4637 "\n -r Try to remount devices as read-only if mount is busy" \
4638 "\n -l Lazy umount (detach filesystem)" \
4639 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004640 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004641 "\n -d Free loop device if it has been used" \
4642 )
4643
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004644#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004645 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004646
4647#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004648 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004649#define uname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004650 "Print system information.\n" \
4651 "\nOptions:" \
4652 "\n -a Print all" \
4653 "\n -m The machine (hardware) type" \
4654 "\n -n Hostname" \
4655 "\n -r OS release" \
4656 "\n -s OS name (default)" \
4657 "\n -p Processor type" \
4658 "\n -v OS version" \
4659
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004660#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004661 "$ uname -a\n" \
4662 "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 +00004663
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004664#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004665 "[-c] [-f] [name...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004666#define uncompress_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004667 "Uncompress .Z file[s]\n" \
4668 "\nOptions:" \
4669 "\n -c Extract to stdout" \
4670 "\n -f Overwrite an existing file" \
Tim Riker7b253f82003-12-28 05:02:40 +00004671
Denis Vlasenko3952f202007-08-13 14:10:24 +00004672#define unexpand_trivial_usage \
4673 "[-f][-a][-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004674#define unexpand_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004675 "Convert spaces to tabs, writing to standard output.\n" \
4676 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004677 USE_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004678 "\n -a,--all Convert all blanks" \
4679 "\n -f,--first-only Convert only leading blanks" \
4680 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004681 ) \
4682 SKIP_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004683 "\n -a Convert all blanks" \
4684 "\n -f Convert only leading blanks" \
4685 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004686 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004687
Eric Andersen7e9276b2001-02-22 01:15:47 +00004688#define uniq_trivial_usage \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004689 "[-fscduw]... [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004690#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004691 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004692 "\nOptions:" \
4693 "\n -c Prefix lines by the number of occurrences" \
4694 "\n -d Only print duplicate lines" \
4695 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004696 "\n -f N Skip first N fields" \
4697 "\n -s N Skip first N chars (after any skipped fields)" \
4698 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004699
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004700#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004701 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4702 "a\n" \
4703 "b\n" \
4704 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004705
4706#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004707 "[option] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004708#define unix2dos_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004709 "Convert FILE from unix to dos format.\n" \
4710 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00004711 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004712 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004713 "\n -d unix2dos" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004714
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004715#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004716 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004717#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004718 "Extract files from ZIP archives\n" \
4719 "\nOptions:" \
4720 "\n -l List archive contents (with -q for short form)" \
4721 "\n -n Never overwrite existing files (default)" \
4722 "\n -o Overwrite files without prompting" \
4723 "\n -p Send output to stdout" \
4724 "\n -q Quiet" \
4725 "\n -x Exclude these files" \
4726 "\n -d Extract files into this directory" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004727
Eric Andersen7e9276b2001-02-22 01:15:47 +00004728#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004729 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004730#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004731 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004732
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004733#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004734 "$ uptime\n" \
4735 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004736
4737#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004738 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004739#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004740 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004741
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004742#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004743 "$ usleep 1000000\n" \
4744 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004745
4746#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004747 "[-o outfile] [infile]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004748#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004749 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004750 "Finds outfile name in uuencoded source unless -o is given"
4751
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004752#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004753 "$ uudecode -o busybox busybox.uu\n" \
4754 "$ ls -l busybox\n" \
4755 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004756
4757#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004758 "[-m] [infile] stored_filename"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004759#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004760 "Uuencode a file to stdout\n" \
4761 "\nOptions:" \
4762 "\n -m Use base64 encoding per RFC1521" \
4763
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004764#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004765 "$ uuencode busybox busybox\n" \
4766 "begin 755 busybox\n" \
4767 "<encoded file snipped>\n" \
4768 "$ uudecode busybox busybox > busybox.uu\n" \
4769 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004770
Eric Andersen853c4942003-01-23 05:59:32 +00004771#define vconfig_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004772 "COMMAND [OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004773#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004774 "Create and remove virtual ethernet devices\n" \
4775 "\nOptions:" \
4776 "\n add [interface-name] [vlan_id]" \
4777 "\n rem [vlan-name]" \
4778 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4779 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4780 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4781 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004782
Eric Andersen3f980402001-04-04 17:31:15 +00004783#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004784 "[OPTION] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004785#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004786 "Edit FILE\n" \
4787 "\nOptions:" \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004788 USE_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004789 "\n -c Initial command to run ($EXINIT also available)") \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004790 USE_FEATURE_VI_READONLY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004791 "\n -R Read-only - do not write to the file") \
4792 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00004793
Eric Andersen27f64e12002-06-23 04:24:25 +00004794#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004795 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004796#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004797 "Lock a virtual terminal. A password is required to unlock.\n" \
4798 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00004799 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004800
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004801#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00004802 "[-n seconds] [-t] COMMAND..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004803#define watch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004804 "Execute a program periodically\n" \
4805 "\nOptions:" \
4806 "\n -n Loop period in seconds (default 2)" \
4807 "\n -t Don't print header" \
4808
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004809#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004810 "$ watch date\n" \
4811 "Mon Dec 17 10:31:40 GMT 2000\n" \
4812 "Mon Dec 17 10:31:42 GMT 2000\n" \
4813 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004814
Eric Andersen7e9276b2001-02-22 01:15:47 +00004815#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004816 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004817#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004818 "Periodically write to watchdog device DEV\n" \
4819 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004820 "\n -T N Reboot after N seconds if not reset (default 60)" \
4821 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004822 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004823 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004824 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004825
4826#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004827 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004828#define wc_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004829 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004830 "more than one FILE is specified. With no FILE, read standard input.\n" \
4831 "\nOptions:" \
4832 "\n -c Print the byte counts" \
4833 "\n -l Print the newline counts" \
4834 "\n -L Print the length of the longest line" \
4835 "\n -w Print the word counts" \
4836
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004837#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004838 "$ wc /etc/passwd\n" \
4839 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004840
4841#define wget_trivial_usage \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00004842 USE_FEATURE_WGET_LONG_OPTIONS( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004843 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004844 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4845 " [-U|--user-agent agent] url" \
4846 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00004847 SKIP_FEATURE_WGET_LONG_OPTIONS( \
Denis Vlasenko03630782007-10-18 11:11:12 +00004848 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4849 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004850#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004851 "Retrieve files via HTTP or FTP\n" \
4852 "\nOptions:" \
4853 "\n -s Spider mode - only check file existence" \
4854 "\n -c Continue retrieval of aborted transfer" \
4855 "\n -q Quiet" \
4856 "\n -P Set directory prefix to DIR" \
4857 "\n -O Save to filename ('-' for stdout)" \
4858 "\n -U Adjust 'User-Agent' field" \
4859 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004860
4861#define which_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004862 "[COMMAND...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004863#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004864 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004865#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004866 "$ which login\n" \
4867 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004868
Eric Andersen00a6a752002-04-26 23:53:10 +00004869#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004870 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004871#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004872 "Show who is logged on\n" \
4873 "\nOptions:" \
4874 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004875
4876#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004877 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004878#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004879 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004880
4881#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004882 "[OPTIONS] [COMMAND] [ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004883#define xargs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004884 "Execute COMMAND on every item given by standard input\n" \
4885 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004886 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004887 "\n -p Ask user whether to run each command") \
4888 "\n -r Do not run command if input is empty" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004889 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004890 "\n -0 Input is separated by NUL characters") \
4891 "\n -t Print the command on stderr before execution" \
Denis Vlasenkoe82da4d2008-08-21 19:59:30 +00004892 "\n -e[STR] STR stops input processing" \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004893 "\n -n N Pass no more than N args to COMMAND" \
4894 "\n -s N Pass command line of no more than N bytes" \
4895 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
4896 "\n -x Exit if size is exceeded") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004897
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004898#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004899 "$ ls | xargs gzip\n" \
4900 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004901
4902#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004903 "[OPTION]... [STRING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004904#define yes_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004905 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004906
Eric Andersen7e9276b2001-02-22 01:15:47 +00004907#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004908 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004909#define zcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004910 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004911
Rob Landleyad8071f2005-04-30 03:49:37 +00004912#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004913 "[OPTIONS] ifname script"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004914#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004915 "Manage a ZeroConf IPv4 link-local address\n" \
4916 "\nOptions:" \
4917 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004918 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004919 "\n -r 169.254.x.x Request this address first" \
4920 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004921 "\n" \
4922 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
4923 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00004924
Eric Andersen178de172004-04-06 16:36:20 +00004925#endif /* __BB_USAGE_H__ */