blob: e945840b846ab28d42049bffd5cadf895764a523 [file] [log] [blame]
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001/* vi: set sw=8 ts=8: */
Denis Vlasenkoe2d3ded2006-11-27 23:43:28 +00002/*
3 * This file suffers from chronically incorrect tabification
4 * of messages. Before editing this file:
5 * 1. Switch you editor to 8-space tab mode.
6 * 2. Do not use \t in messages, use real tab character.
7 * 3. Start each source line with message as follows:
Denis Vlasenko1fffe382006-11-28 00:06:39 +00008 * |<7 spaces>"text with tabs"....
Denis Vlasenkocdf62772008-03-17 08:42:43 +00009 * or
10 * |<5 spaces>"\ntext with tabs"....
Denis Vlasenkoe2d3ded2006-11-27 23:43:28 +000011 */
12
Eric Andersen178de172004-04-06 16:36:20 +000013#ifndef __BB_USAGE_H__
14#define __BB_USAGE_H__
15
Denis Vlasenko4f98e192008-04-13 22:12:19 +000016
17#define NOUSAGE_STR "\b"
18
Denis Vlasenkod16950d2008-11-29 09:05:50 +000019#define acpid_trivial_usage \
20 "[-d] [-c CONFDIR] [-l LOGFILE] [-e PROC_EVENT_FILE] [EVDEV_EVENT_FILE...]"
21
22#define acpid_full_usage "\n\n" \
23 "Listen to ACPI events and spawn specific helpers on event arrival\n" \
24 "\nOptions:" \
25 "\n -d Do not daemonize and log to stderr" \
26 "\n -c DIR Config directory [/etc/acpi]" \
27 "\n -e FILE /proc event file [/proc/acpi/event]" \
28 "\n -l FILE Log file [/var/log/acpid]" \
29 USE_FEATURE_ACPID_COMPAT( \
30 "\n\nAccept and ignore compatibility options -g -m -s -S -v" \
31 )
32
33#define acpid_example_usage \
34 "# acpid -l /var/log/my-acpi-log\n" \
35 "# acpid -d /dev/input/event*\n"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000036
Eric Andersenf349e972001-08-21 16:18:59 +000037#define addgroup_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +000038 "[-g GID] " USE_FEATURE_ADDUSER_TO_GROUP("[user_name] ") "group_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000039#define addgroup_full_usage "\n\n" \
Denis Vlasenko73ac0562008-12-25 01:01:23 +000040 "Add a group " USE_FEATURE_ADDUSER_TO_GROUP("or add a user to a group") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000041 "\nOptions:" \
Denis Vlasenko4f98e192008-04-13 22:12:19 +000042 "\n -g GID Group id" \
Eric Andersenf349e972001-08-21 16:18:59 +000043
44#define adduser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000045 "[OPTIONS] user_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000046#define adduser_full_usage "\n\n" \
Denis Vlasenko73ac0562008-12-25 01:01:23 +000047 "Add a user\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000048 "\nOptions:" \
49 "\n -h DIR Home directory" \
50 "\n -g GECOS GECOS field" \
51 "\n -s SHELL Login shell" \
52 "\n -G GROUP Add user to existing group" \
53 "\n -S Create a system user" \
54 "\n -D Do not assign a password" \
55 "\n -H Do not create home directory" \
Eric Andersenf349e972001-08-21 16:18:59 +000056
Mark Whitley6f932772001-03-20 19:18:10 +000057#define adjtimex_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000058 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000059#define adjtimex_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000060 "Read and optionally set system timebase parameters. See adjtimex(2).\n" \
61 "\nOptions:" \
62 "\n -q Quiet" \
63 "\n -o offset Time offset, microseconds" \
64 "\n -f frequency Frequency adjust, integer kernel units (65536 is 1ppm)" \
65 "\n (positive values make clock run faster)" \
66 "\n -t tick Microseconds per tick, usually 10000" \
67 "\n -p timeconstant" \
Mark Whitley6f932772001-03-20 19:18:10 +000068
Eric Andersen7e9276b2001-02-22 01:15:47 +000069#define ar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000070 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000071#define ar_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000072 "Extract or list FILES from an ar archive\n" \
73 "\nOptions:" \
74 "\n -o Preserve original dates" \
75 "\n -p Extract to stdout" \
76 "\n -t List" \
77 "\n -x Extract" \
78 "\n -v Verbose" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000079
Denis Vlasenkofa85b862007-01-07 01:24:12 +000080#define arp_trivial_usage \
Denis Vlasenko4d476922008-11-13 00:05:17 +000081 "\n[-vn] [-H type] [-i if] -a [hostname]" \
82 "\n[-v] [-i if] -d hostname [pub]" \
83 "\n[-v] [-H type] [-i if] -s hostname hw_addr [temp]" \
84 "\n[-v] [-H type] [-i if] -s hostname hw_addr [netmask nm] pub" \
85 "\n[-v] [-H type] [-i if] -Ds hostname ifa [netmask nm] pub"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000086#define arp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000087 "Manipulate ARP cache\n" \
88 "\nOptions:" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000089 "\n -a Display (all) hosts" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000090 "\n -s Set new ARP entry" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000091 "\n -d Delete a specified entry" \
92 "\n -v Verbose" \
93 "\n -n Don't resolve names" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000094 "\n -i IF Network interface" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000095 "\n -D Read <hwaddr> from given device" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000096 "\n -A, -p AF Protocol family" \
Denis Vlasenko397de612008-03-17 08:55:44 +000097 "\n -H HWTYPE Hardware address type" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000098
Glenn L McGrath9e598412003-01-09 10:06:01 +000099#define arping_trivial_usage \
Denis Vlasenkof23c3f92007-11-23 09:27:05 +0000100 "[-fqbDUA] [-c count] [-w timeout] [-I dev] [-s sender] target"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000101#define arping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000102 "Send ARP requests/replies\n" \
103 "\nOptions:" \
104 "\n -f Quit on first ARP reply" \
105 "\n -q Quiet" \
106 "\n -b Keep broadcasting, don't go unicast" \
107 "\n -D Duplicated address detection mode" \
108 "\n -U Unsolicited ARP mode, update your neighbors" \
109 "\n -A ARP answer mode, update your neighbors" \
110 "\n -c N Stop after sending N ARP requests" \
111 "\n -w timeout Time to wait for ARP reply, in seconds" \
112 "\n -I dev Interface to use (default eth0)" \
113 "\n -s sender Sender IP address" \
114 "\n target Target IP address" \
Glenn L McGrath9e598412003-01-09 10:06:01 +0000115
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000116#define sh_trivial_usage NOUSAGE_STR
117#define sh_full_usage ""
118#define ash_trivial_usage NOUSAGE_STR
119#define ash_full_usage ""
120#define hush_trivial_usage NOUSAGE_STR
121#define hush_full_usage ""
122#define msh_trivial_usage NOUSAGE_STR
123#define msh_full_usage ""
Eric Andersen08f59e32004-03-12 22:07:10 +0000124
125#define awk_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000126 "[OPTION]... [program-text] [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000127#define awk_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000128 "Options:" \
129 "\n -v var=val Set variable" \
130 "\n -F sep Use sep as field separator" \
131 "\n -f file Read program from file" \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +0000132
Eric Andersen7e9276b2001-02-22 01:15:47 +0000133#define basename_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000134 "FILE [SUFFIX]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000135#define basename_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000136 "Strip directory path and suffixes from FILE.\n" \
137 "If specified, also remove any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000138#define basename_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000139 "$ basename /usr/local/bin/foo\n" \
140 "foo\n" \
141 "$ basename /usr/local/bin/\n" \
142 "bin\n" \
143 "$ basename /foo/bar.txt .txt\n" \
144 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000145
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000146#define fbsplash_trivial_usage \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000147 "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000148#define fbsplash_full_usage "\n\n" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000149 "Options:\n" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000150 "\n -s Image" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000151 "\n -c Hide cursor" \
152 "\n -d Framebuffer device (default /dev/fb0)" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000153 "\n -i Config file (var=value):" \
154 "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT" \
155 "\n BAR_R,BAR_G,BAR_B" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000156 "\n -f Control pipe (else exit after drawing image)" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000157 "\n commands: 'NN' (% for progress bar) or 'exit'" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000158
Bernhard Reutner-Fischerd27d9252008-01-13 15:23:27 +0000159#define brctl_trivial_usage \
160 "COMMAND [BRIDGE [INTERFACE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000161#define brctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000162 "Manage ethernet bridges.\n" \
163 "\nCommands:" \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000164 USE_FEATURE_BRCTL_SHOW( \
165 "\n show Show a list of bridges" \
166 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000167 "\n addbr BRIDGE Create BRIDGE" \
168 "\n delbr BRIDGE Delete BRIDGE" \
169 "\n addif BRIDGE IFACE Add IFACE to BRIDGE" \
170 "\n delif BRIDGE IFACE Delete IFACE from BRIDGE" \
171 USE_FEATURE_BRCTL_FANCY( \
172 "\n setageing BRIDGE TIME Set ageing time" \
173 "\n setfd BRIDGE TIME Set bridge forward delay" \
174 "\n sethello BRIDGE TIME Set hello time" \
175 "\n setmaxage BRIDGE TIME Set max message age" \
176 "\n setpathcost BRIDGE COST Set path cost" \
177 "\n setportprio BRIDGE PRIO Set port priority" \
178 "\n setbridgeprio BRIDGE PRIO Set bridge priority" \
179 "\n stp BRIDGE [1|0] STP on/off" \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000180 ) \
181
Glenn L McGrath24e28332001-10-05 03:48:57 +0000182#define bunzip2_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000183 "[OPTION]... [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000184#define bunzip2_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000185 "Uncompress FILE (or standard input if FILE is '-' or omitted)\n" \
186 "\nOptions:" \
187 "\n -c Write to standard output" \
188 "\n -f Force" \
Glenn L McGrath24e28332001-10-05 03:48:57 +0000189
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000190#define bzip2_trivial_usage \
191 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000192#define bzip2_full_usage "\n\n" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000193 "Compress FILE(s) with bzip2 algorithm.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000194 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n" \
195 "\nOptions:" \
196 "\n -c Write to standard output" \
197 "\n -d Decompress" \
198 "\n -f Force" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000199 "\n -1..-9 Compression level" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000200
Rob Landley6130b9b2006-01-23 21:10:38 +0000201#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000202 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000203
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000204#define bzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000205 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000206#define bzcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000207 "Uncompress to stdout"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000208
Rob Landleyc1d69902006-01-20 18:28:50 +0000209#define unlzma_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000210 "[OPTION]... [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000211#define unlzma_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000212 "Uncompress FILE (or standard input if FILE is '-' or omitted)\n" \
213 "\nOptions:" \
214 "\n -c Write to standard output" \
215 "\n -f Force" \
Rob Landleyc1d69902006-01-20 18:28:50 +0000216
217#define lzmacat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000218 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000219#define lzmacat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000220 "Uncompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000221
Eric Andersenc98c0622001-12-06 15:16:43 +0000222#define cal_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000223 "[-jy] [[month] year]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000224#define cal_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000225 "Display a calendar\n" \
226 "\nOptions:" \
227 "\n -j Use julian dates" \
228 "\n -y Display the entire year" \
Eric Andersenc98c0622001-12-06 15:16:43 +0000229
Eric Andersen7e9276b2001-02-22 01:15:47 +0000230#define cat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000231 "[-u] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000232#define cat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000233 "Concatenate FILE(s) and print them to stdout\n" \
234 "\nOptions:" \
235 "\n -u Use unbuffered i/o (ignored)" \
236
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000237#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000238 "$ cat /proc/uptime\n" \
239 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000240
Rob Landley8abbee42006-05-31 19:36:04 +0000241#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000242 "[-etv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000243#define catv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000244 "Display nonprinting characters as ^x or M-x\n" \
245 "\nOptions:" \
246 "\n -e End each line with $" \
247 "\n -t Show tabs as ^I" \
248 "\n -v Don't use ^x or M-x escapes" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000249
250#define chat_trivial_usage \
251 "EXPECT [SEND [EXPECT [SEND...]]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000252#define chat_full_usage "\n\n" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000253 "Useful for interacting with a modem connected to stdin/stdout.\n" \
254 "A script consists of one or more \"expect-send\" pairs of strings,\n" \
255 "each pair is a pair of arguments. Example:\n" \
256 "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \
257
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000258#define chattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000259 "[-R] [-+=AacDdijsStTu] [-v version] files..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000260#define chattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000261 "Change file attributes on an ext2 fs\n" \
262 "\nModifiers:" \
263 "\n - Remove attributes" \
264 "\n + Add attributes" \
265 "\n = Set attributes" \
266 "\nAttributes:" \
267 "\n A Don't track atime" \
268 "\n a Append mode only" \
269 "\n c Enable compress" \
270 "\n D Write dir contents synchronously" \
271 "\n d Do not backup with dump" \
272 "\n i Cannot be modified (immutable)" \
273 "\n j Write all data to journal first" \
274 "\n s Zero disk storage when deleted" \
275 "\n S Write file contents synchronously" \
276 "\n t Disable tail-merging of partial blocks with other files" \
277 "\n u Allow file to be undeleted" \
278 "\nOptions:" \
279 "\n -R Recursively list subdirectories" \
280 "\n -v Set the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000281
Denis Vlasenko49622d72007-03-10 16:58:49 +0000282#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000283 "[OPTIONS] CONTEXT FILE..." \
284 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
285 USE_FEATURE_CHCON_LONG_OPTIONS( \
286 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
287 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000288#define chcon_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000289 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000290 USE_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000291 "\n -v,--verbose Verbose" \
292 "\n -c,--changes Report changes made" \
293 "\n -h,--no-dereference Affect symlinks instead of their targets" \
294 "\n -f,--silent,--quiet Suppress most error messages" \
295 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
296 "\n -u,--user=USER Set user/role/type/range in the target" \
297 "\n -r,--role=ROLE security context" \
298 "\n -t,--type=TYPE" \
299 "\n -l,--range=RANGE" \
300 "\n -R,--recursive Recurse subdirectories" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000301 ) \
302 SKIP_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000303 "\n -v Verbose" \
304 "\n -c Report changes made" \
305 "\n -h Affect symlinks instead of their targets" \
306 "\n -f Suppress most error messages" \
307 "\n -u USER Set user/role/type/range in the target security context" \
308 "\n -r ROLE" \
309 "\n -t TYPE" \
310 "\n -l RNG" \
311 "\n -R Recurse subdirectories" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000312 )
313
Eric Andersen7e9276b2001-02-22 01:15:47 +0000314#define chmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000315 "[-R"USE_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000316#define chmod_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000317 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000318 "symbols +-= and one or more of the letters rwxst\n" \
319 "\nOptions:" \
320 "\n -R Recurse directories" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000321 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000322 "\n -c List changed files" \
323 "\n -v List all files" \
324 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000325 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000326#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000327 "$ ls -l /tmp/foo\n" \
328 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
329 "$ chmod u+x /tmp/foo\n" \
330 "$ ls -l /tmp/foo\n" \
331 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
332 "$ chmod 444 /tmp/foo\n" \
333 "$ ls -l /tmp/foo\n" \
334 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000335
Denis Vlasenko081ef792007-03-17 16:38:21 +0000336#define chgrp_trivial_usage \
337 "[-RhLHP"USE_DESKTOP("cvf")"]... GROUP FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000338#define chgrp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000339 "Change the group membership of each FILE to GROUP\n" \
340 "\nOptions:" \
341 "\n -R Recurse directories" \
342 "\n -h Affect symlinks instead of symlink targets" \
343 "\n -L Traverse all symlinks to directories" \
344 "\n -H Traverse symlinks on command line only" \
345 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000346 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000347 "\n -c List changed files" \
348 "\n -v Verbose" \
349 "\n -f Hide errors" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000350 )
351#define chgrp_example_usage \
352 "$ ls -l /tmp/foo\n" \
353 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
354 "$ chgrp root /tmp/foo\n" \
355 "$ ls -l /tmp/foo\n" \
356 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
357
Eric Andersen7e9276b2001-02-22 01:15:47 +0000358#define chown_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000359 "[-RhLHP"USE_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000360#define chown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000361 "Change the owner and/or group of each FILE to OWNER and/or GROUP\n" \
362 "\nOptions:" \
363 "\n -R Recurse directories" \
364 "\n -h Affect symlinks instead of symlink targets" \
365 "\n -L Traverse all symlinks to directories" \
366 "\n -H Traverse symlinks on command line only" \
367 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000368 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000369 "\n -c List changed files" \
370 "\n -v List all files" \
371 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000372 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000373#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000374 "$ ls -l /tmp/foo\n" \
375 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
376 "$ chown root /tmp/foo\n" \
377 "$ ls -l /tmp/foo\n" \
378 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
379 "$ chown root.root /tmp/foo\n" \
380 "ls -l /tmp/foo\n" \
381 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000382
Denis Vlasenkofe544582006-10-03 15:57:40 +0000383#define chpst_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000384 "[-vP012] [-u USER[:GRP]] [-U USER[:GRP]] [-e DIR]\n" \
385 " [-/ DIR] [-n NICE] [-m BYTES] [-d BYTES] [-o N]\n" \
386 " [-p N] [-f BYTES] [-c BYTES] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000387#define chpst_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000388 "Change the process state and run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000389 "\nOptions:" \
390 "\n -u USER[:GRP] Set uid and gid" \
391 "\n -U USER[:GRP] Set $UID and $GID in environment" \
392 "\n -e DIR Set environment variables as specified by files" \
393 "\n in DIR: file=1st_line_of_file" \
394 "\n -/ DIR Chroot to DIR" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000395 "\n -n NICE Add NICE to nice value" \
396 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000397 "\n -d BYTES Limit data segment" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000398 "\n -o N Limit number of open files per process" \
399 "\n -p N Limit number of processes per uid" \
400 "\n -f BYTES Limit output file sizes" \
401 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000402 "\n -v Verbose" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000403 "\n -P Create new process group" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000404 "\n -0 Close standard input" \
405 "\n -1 Close standard output" \
406 "\n -2 Close standard error" \
407
Denis Vlasenkofe544582006-10-03 15:57:40 +0000408#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000409 "account prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000410#define setuidgid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000411 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000412 "groups and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000413#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000414 "account prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000415#define envuidgid_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000416 "Set $UID to account's uid and $GID to account's gid and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000417#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000418 "dir prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000419#define envdir_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000420 "Set various environment variables as specified by files\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000421 "in the directory dir and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000422#define softlimit_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000423 "[-a BYTES] [-m BYTES] [-d BYTES] [-s BYTES] [-l BYTES]\n" \
424 " [-f BYTES] [-c BYTES] [-r BYTES] [-o N] [-p N] [-t N]\n" \
425 " PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000426#define softlimit_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000427 "Set soft resource limits, then run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000428 "\nOptions:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000429 "\n -a BYTES Limit total size of all segments" \
430 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES -a BYTES" \
431 "\n -d BYTES Limit data segment" \
432 "\n -s BYTES Limit stack segment" \
433 "\n -l BYTES Limit locked memory size" \
434 "\n -o N Limit number of open files per process" \
435 "\n -p N Limit number of processes per uid" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000436 "\nOptions controlling file sizes:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000437 "\n -f BYTES Limit output file sizes" \
438 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000439 "\nEfficiency opts:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000440 "\n -r BYTES Limit resident set size" \
441 "\n -t N Limit CPU time, process receives" \
442 "\n a SIGXCPU after N seconds" \
Denis Vlasenkofe544582006-10-03 15:57:40 +0000443
Eric Andersen7e9276b2001-02-22 01:15:47 +0000444#define chroot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000445 "NEWROOT [COMMAND...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000446#define chroot_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000447 "Run COMMAND with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000448#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000449 "$ ls -l /bin/ls\n" \
450 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
451 "# mount /dev/hdc1 /mnt -t minix\n" \
452 "# chroot /mnt\n" \
453 "# ls -l /bin/ls\n" \
454 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000455
Eric Andersen7e9276b2001-02-22 01:15:47 +0000456#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000457 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000458#define chvt_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000459 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000460
Rob Landley856489b2006-04-18 20:57:28 +0000461#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000462 "FILES..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000463#define cksum_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000464 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000465
Eric Andersen7e9276b2001-02-22 01:15:47 +0000466#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000467 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000468#define clear_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000469 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000470
Eric Andersen7e9276b2001-02-22 01:15:47 +0000471#define cmp_trivial_usage \
Denis Vlasenko9a1fa8c2007-03-21 22:30:14 +0000472 "[-l] [-s] FILE1 [FILE2" USE_DESKTOP(" [SKIP1 [SKIP2]") "]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000473#define cmp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000474 "Compares FILE1 vs stdin if FILE2 is not specified\n" \
475 "\nOptions:" \
476 "\n -l Write the byte numbers (decimal) and values (octal)" \
477 "\n for all differing bytes" \
478 "\n -s Quiet" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000479
Rob Landley2acfd7b2005-05-11 23:12:49 +0000480#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000481 "[-123] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000482#define comm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000483 "Compare FILE1 to FILE2, or to stdin if - is specified\n" \
484 "\nOptions:" \
485 "\n -1 Suppress lines unique to FILE1" \
486 "\n -2 Suppress lines unique to FILE2" \
487 "\n -3 Suppress lines common to both files" \
Rob Landley2acfd7b2005-05-11 23:12:49 +0000488
Paul Fox79c142d2005-08-01 16:04:40 +0000489#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000490 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000491#define bbconfig_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000492 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000493
Rob Landley69674942006-09-11 00:34:01 +0000494#define bbsh_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000495 "[FILE]...\n" \
496 "or: bbsh -c command [args]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000497#define bbsh_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000498 "The bbsh shell (command interpreter)"
Rob Landley69674942006-09-11 00:34:01 +0000499
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000500#define chrt_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000501 "[OPTION]... [prio] [pid | command [arg]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000502#define chrt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000503 "Manipulate real-time attributes of a process\n" \
504 "\nOptions:" \
505 "\n -p Operate on pid" \
506 "\n -r Set scheduling policy to SCHED_RR" \
507 "\n -f Set scheduling policy to SCHED_FIFO" \
508 "\n -o Set scheduling policy to SCHED_OTHER" \
509 "\n -m Show min and max priorities" \
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000510
511#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000512 "$ chrt -r 4 sleep 900; x=$!\n" \
513 "$ chrt -f -p 3 $x\n" \
514 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000515
Eric Andersen7e9276b2001-02-22 01:15:47 +0000516#define cp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000517 "[OPTION]... SOURCE DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000518#define cp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000519 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY\n" \
520 "\nOptions:" \
521 "\n -a Same as -dpR" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000522 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000523 "\n -c Preserve security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000524 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000525 "\n -d,-P Preserve links" \
526 "\n -H,-L Dereference all symlinks (default)" \
527 "\n -p Preserve file attributes if possible" \
528 "\n -f Force overwrite" \
529 "\n -i Prompt before overwrite" \
530 "\n -R,-r Recurse directories" \
531 "\n -l,-s Create (sym)links" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000532
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000533#define cpio_trivial_usage \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000534 "-[dim" USE_FEATURE_CPIO_O("o") "tuv][F cpiofile]" \
Denis Vlasenko1f228982008-04-22 00:16:29 +0000535 USE_FEATURE_CPIO_O( "[H newc]" )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000536#define cpio_full_usage "\n\n" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000537 "Extract or list files from a cpio archive" \
538 USE_FEATURE_CPIO_O( ", or create a cpio archive" ) \
539 "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000540 "Main operation mode:" \
541 "\n d Make leading directories" \
542 "\n i Extract" \
543 "\n m Preserve mtime" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000544 USE_FEATURE_CPIO_O( \
545 "\n o Create" \
546 "\n H newc Define format" \
547 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000548 "\n t List" \
549 "\n v Verbose" \
550 "\n u Unconditional overwrite" \
551 "\n F Input from file" \
Tim Riker7b253f82003-12-28 05:02:40 +0000552
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000553#define crond_trivial_usage \
Denis Vlasenko35a064b2008-11-06 00:49:59 +0000554 "-fbS -l N " USE_FEATURE_CROND_D("-d N ") "-L LOGFILE -c DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000555#define crond_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000556 " -f Foreground" \
557 "\n -b Background (default)" \
558 "\n -S Log to syslog (default)" \
559 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +0000560 USE_FEATURE_CROND_D( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000561 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000562 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000563 "\n -L Log to file" \
564 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000565
566#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000567 "[-c DIR] [-u USER] [-ler]|[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000568#define crontab_full_usage "\n\n" \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000569 " -c Crontab directory" \
570 "\n -u User" \
571 "\n -l List crontab" \
572 "\n -e Edit crontab" \
573 "\n -r Delete crontab" \
574 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000575
Denis Vlasenko2211d522008-11-10 18:52:35 +0000576#define cryptpw_trivial_usage \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000577 "[OPTIONS] [PASSWORD] [SALT]"
578/* We do support -s, we just don't mention it */
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000579#define cryptpw_full_usage "\n\n" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000580 "Crypt the PASSWORD using crypt(3)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000581 "\nOptions:" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000582 USE_GETOPT_LONG( \
583 "\n -P,--password-fd=NUM Read password from fd NUM" \
584/* "\n -s,--stdin Use stdin; like -P0" */ \
585 "\n -m,--method=TYPE Encryption method TYPE" \
586 "\n -S,--salt=SALT" \
587 ) \
588 SKIP_GETOPT_LONG( \
589 "\n -P NUM Read password from fd NUM" \
590/* "\n -s Use stdin; like -P0" */ \
591 "\n -m TYPE Encryption method TYPE" \
592 "\n -S SALT" \
593 ) \
594
595/* mkpasswd is an alias to cryptpw */
596
597#define mkpasswd_trivial_usage \
598 "[OPTIONS] [PASSWORD] [SALT]"
599/* We do support -s, we just don't mention it */
600#define mkpasswd_full_usage "\n\n" \
601 "Crypt the PASSWORD using crypt(3)\n" \
602 "\nOptions:" \
603 USE_GETOPT_LONG( \
604 "\n -P,--password-fd=NUM Read password from fd NUM" \
605/* "\n -s,--stdin Use stdin; like -P0" */ \
606 "\n -m,--method=TYPE Encryption method TYPE" \
607 "\n -S,--salt=SALT" \
608 ) \
609 SKIP_GETOPT_LONG( \
610 "\n -P NUM Read password from fd NUM" \
611/* "\n -s Use stdin; like -P0" */ \
612 "\n -m TYPE Encryption method TYPE" \
613 "\n -S SALT" \
614 ) \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000615
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000616#define cttyhack_trivial_usage NOUSAGE_STR
617#define cttyhack_full_usage ""
618
Eric Andersen7e9276b2001-02-22 01:15:47 +0000619#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000620 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000621#define cut_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000622 "Print selected fields from each input FILE to standard output\n" \
623 "\nOptions:" \
624 "\n -b LIST Output only bytes from LIST" \
625 "\n -c LIST Output only characters from LIST" \
626 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
627 "\n -s Output only the lines containing delimiter" \
628 "\n -f N Print only these fields" \
629 "\n -n Ignored" \
630
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000631#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000632 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
633 "Hello\n" \
634 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
635 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000636
Eric Andersen7e9276b2001-02-22 01:15:47 +0000637#define date_trivial_usage \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000638 "[OPTION]... [+FMT] [TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000639#define date_full_usage "\n\n" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000640 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000641 "\nOptions:" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000642 "\n -u Work in UTC (don't convert to local time)" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000643 "\n -R Output RFC-822 compliant date string" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000644 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000645 "\n -I[SPEC] Output ISO-8601 compliant date string" \
646 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000647 "\n 'hours', 'minutes', or 'seconds' for date and" \
648 "\n time to the indicated precision" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000649 ) \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000650 "\n -d TIME Display TIME, not 'now'" \
651 "\n -r FILE Display last modification time of FILE" \
652 "\n [-s] TIME Set time to TIME" \
653 USE_FEATURE_DATE_ISOFMT( \
654 "\n -D FMT Use FMT for str->date conversion" \
655 ) \
656 "\n" \
657 "\nRecognized formats for TIME:" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000658 "\n hh:mm[:ss]" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000659 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000660 "\n YYYY-MM-DD hh:mm[:ss]" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000661 "\n MMDDhhmm[[YY]YY][.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000662
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000663#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000664 "$ date\n" \
665 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000666
Eric Andersen7e9276b2001-02-22 01:15:47 +0000667#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000668 "expression..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000669#define dc_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +0000670 "Tiny RPN calculator. Operations:\n" \
671 "+, add, -, sub, *, mul, /, div, %, mod, **, exp, and, or, not, eor,\n" \
672 "p - print top of the stack (without altering the stack),\n" \
673 "f - print entire stack, o - pop the value and set output radix\n" \
674 "(value must be 10 or 16).\n" \
675 "Examples: 'dc 2 2 add' -> 4, 'dc 8 8 * 2 2 + /' -> 16.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000676
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000677#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000678 "$ dc 2 2 + p\n" \
679 "4\n" \
680 "$ dc 8 8 \\* 2 2 + / p\n" \
681 "16\n" \
682 "$ dc 0 1 and p\n" \
683 "0\n" \
684 "$ dc 0 1 or p\n" \
685 "1\n" \
686 "$ echo 72 9 div 8 mul p | dc\n" \
687 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000688
Eric Andersen7e9276b2001-02-22 01:15:47 +0000689#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000690 "[if=FILE] [of=FILE] " USE_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000691 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000692#define dd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000693 "Copy a file with converting and formatting\n" \
694 "\nOptions:" \
695 "\n if=FILE Read from FILE instead of stdin" \
696 "\n of=FILE Write to FILE instead of stdout" \
697 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000698 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000699 "\n ibs=N Read N bytes at a time" \
700 ) \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000701 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000702 "\n obs=N Write N bytes at a time" \
703 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000704 "\n count=N Copy only N input blocks" \
705 "\n skip=N Skip N input blocks" \
706 "\n seek=N Skip N output blocks" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000707 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000708 "\n conv=notrunc Don't truncate output file" \
709 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000710 "\n conv=sync Pad blocks with zeros" \
711 "\n conv=fsync Physically write data out before finishing" \
712 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000713 "\n" \
714 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
715 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
716
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000717#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000718 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
719 "4+0 records in\n" \
720 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000721
Eric Andersen7e9276b2001-02-22 01:15:47 +0000722#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000723 "[N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000724#define deallocvt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000725 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000726
Eric Andersenf349e972001-08-21 16:18:59 +0000727#define delgroup_trivial_usage \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000728 USE_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000729#define delgroup_full_usage "\n\n" \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000730 "Delete group GROUP from the system" \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000731 USE_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000732
733#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000734 "USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000735#define deluser_full_usage "\n\n" \
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000736 "Delete USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000737
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000738#define depmod_trivial_usage NOUSAGE_STR
739#define depmod_full_usage ""
Bernhard Reutner-Fischer55e547e2008-05-26 12:01:49 +0000740
Denis Vlasenkoc94fa562008-10-26 11:08:14 +0000741#define devmem_trivial_usage \
742 "ADDRESS [WIDTH [VALUE]]"
743
744#define devmem_full_usage "\n\n" \
745 "Read/write from physical address\n" \
746 "\n ADDRESS Address to act upon" \
747 "\n WIDTH Width (8/16/...)" \
748 "\n VALUE Data to be written" \
749
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000750#define devfsd_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000751 "mntpnt [-v]" USE_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000752#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000753 "Manage devfs permissions and old device name symlinks\n" \
754 "\nOptions:" \
755 "\n mntpnt The mount point where devfs is mounted" \
756 "\n -v Print the protocol version numbers for devfsd" \
757 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000758 USE_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000759 "\n -fg Run in foreground" \
760 "\n -np Exit after parsing the configuration file" \
761 "\n and processing synthetic REGISTER events," \
762 "\n do not poll for events" \
763 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000764
Eric Andersen7e9276b2001-02-22 01:15:47 +0000765#define df_trivial_usage \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000766 "[-Pk" \
767 USE_FEATURE_HUMAN_READABLE("mh") \
768 USE_FEATURE_DF_FANCY("ai] [-B SIZE") \
769 "] [FILESYSTEM...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000770#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000771 "Print filesystem usage statistics\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000772 "\nOptions:" \
773 "\n -P POSIX output format" \
774 "\n -k 1024-byte blocks (default)" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000775 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000776 "\n -m 1M-byte blocks" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000777 "\n -h Human readable (e.g. 1K 243M 2G)" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000778 ) \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000779 USE_FEATURE_DF_FANCY( \
780 "\n -a Show all filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000781 "\n -i Inodes" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000782 "\n -B SIZE Blocksize" \
783 ) \
784
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000785#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000786 "$ df\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000787 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000788 "/dev/sda3 8690864 8553540 137324 98% /\n" \
789 "/dev/sda1 64216 36364 27852 57% /boot\n" \
790 "$ df /dev/sda3\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000791 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
792 "/dev/sda3 8690864 8553540 137324 98% /\n" \
793 "$ POSIXLY_CORRECT=sure df /dev/sda3\n" \
794 "Filesystem 512B-blocks Used Available Use% Mounted on\n" \
795 "/dev/sda3 17381728 17107080 274648 98% /\n" \
796 "$ POSIXLY_CORRECT=yep df -P /dev/sda3\n" \
797 "Filesystem 512-blocks Used Available Capacity Mounted on\n" \
798 "/dev/sda3 17381728 17107080 274648 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000799
Denis Vlasenko736230e2006-11-20 19:40:36 +0000800#define dhcprelay_trivial_usage \
Bernhard Reutner-Fischer55fb9da2008-05-27 12:42:39 +0000801 "[client1,client2,...] [server_device]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000802#define dhcprelay_full_usage "\n\n" \
Bernhard Reutner-Fischer55fb9da2008-05-27 12:42:39 +0000803 "Relay dhcp requests from client devices to server device.\n" \
804 "Pass clients as CSV"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000805
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000806#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000807 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000808#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000809 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000810 "This implementation supports unified diffs only.\n" \
811 "\nOptions:" \
812 "\n -a Treat all files as text" \
813 "\n -b Ignore changes in the amount of whitespace" \
814 "\n -d Try hard to find a smaller set of changes" \
815 "\n -i Ignore case differences" \
816 "\n -L Use LABEL instead of the filename in the unified header" \
817 "\n -N Treat absent files as empty" \
818 "\n -q Output only whether files differ" \
819 "\n -r Recursively compare subdirectories" \
820 "\n -S Start with FILE when comparing directories" \
821 "\n -T Make tabs line up by prefixing a tab when necessary" \
822 "\n -s Report when two files are the same" \
823 "\n -t Expand tabs to spaces in output" \
824 "\n -U Output LINES lines of context" \
825 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000826
Eric Andersen7e9276b2001-02-22 01:15:47 +0000827#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000828 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000829#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000830 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000831#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000832 "$ dirname /tmp/foo\n" \
833 "/tmp\n" \
834 "$ dirname /tmp/foo/\n" \
835 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000836
Eric Andersen7e9276b2001-02-22 01:15:47 +0000837#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000838 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000839#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000840 "Print or control the kernel ring buffer\n" \
841 "\nOptions:" \
842 "\n -c Clear ring buffer after printing" \
843 "\n -n LEVEL Set console logging level" \
844 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000845
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000846#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000847 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000848#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000849 "Small static DNS server daemon\n" \
850 "\nOptions:" \
851 "\n -c Config filename" \
852 "\n -t TTL in seconds" \
853 "\n -p Listening port" \
854 "\n -i Listening ip (default all)" \
855 "\n -d Daemonize" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000856
Eric Andersen7e9276b2001-02-22 01:15:47 +0000857#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000858 "[option] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000859#define dos2unix_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000860 "Convert FILE from dos to unix format.\n" \
861 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000862 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000863 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000864 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000865
Eric Andersen7e9276b2001-02-22 01:15:47 +0000866#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000867 "[-ilCPru] [-F option] package_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000868#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000869 "Install, remove and manage Debian packages\n" \
870 "\nOptions:" \
871 "\n -i Install the package" \
872 "\n -l List of installed packages" \
873 "\n -C Configure an unpackaged package" \
874 "\n -F depends Ignore dependency problems" \
875 "\n -P Purge all files of a package" \
876 "\n -r Remove all but the configuration files for a package" \
877 "\n -u Unpack a package, but don't configure it" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000878
Eric Andersen7e9276b2001-02-22 01:15:47 +0000879#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000880 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000881#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000882 "Perform actions on Debian packages (.debs)\n" \
883 "\nOptions:" \
884 "\n -c List contents of filesystem tree" \
885 "\n -e Extract control files to [argument] directory" \
886 "\n -f Display control field name starting with [argument]" \
887 "\n -x Extract packages filesystem tree to directory" \
888 "\n -X Verbose extract" \
889
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000890#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000891 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000892
Eric Andersen7e9276b2001-02-22 01:15:47 +0000893#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000894 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000895#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000896 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000897 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000898 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
899 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000900 " bytes.\n" \
901 "\nOptions:" \
902 "\n -a Show file sizes too" \
903 "\n -H Follow symlinks on command line" \
904 "\n -L Follow all symlinks" \
905 "\n -d N Limit output to directories (and files with -a) of depth < N" \
906 "\n -c Show grand total" \
907 "\n -l Count sizes many times if hard linked" \
908 "\n -s Display only a total for each argument" \
909 "\n -x Skip directories on different filesystems" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000910 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000911 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
912 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000913 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000914 "\n -k Sizes in kilobytes" \
915 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
916
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000917#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000918 "$ du\n" \
919 "16 ./CVS\n" \
920 "12 ./kernel-patches/CVS\n" \
921 "80 ./kernel-patches\n" \
922 "12 ./tests/CVS\n" \
923 "36 ./tests\n" \
924 "12 ./scripts/CVS\n" \
925 "16 ./scripts\n" \
926 "12 ./docs/CVS\n" \
927 "104 ./docs\n" \
928 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000929
Eric Andersen7e9276b2001-02-22 01:15:47 +0000930#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000931 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000932#define dumpkmap_full_usage "\n\n" \
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000933 "Print a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000934#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000935 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000936
Russ Dill61fb4892002-10-14 21:41:28 +0000937#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000938 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000939#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000940 "Display DHCP leases granted by udhcpd\n" \
941 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000942 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000943 "\n -f,--file=FILE Leases file to load" \
944 "\n -r,--remaining Interpret lease times as time remaining" \
945 "\n -a,--absolute Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000946 ) \
947 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000948 "\n -f FILE Leases file to load" \
949 "\n -r Interpret lease times as time remaining" \
950 "\n -a Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000951 )
Russ Dill61fb4892002-10-14 21:41:28 +0000952
Mike Frysinger51a43b42005-09-24 07:11:16 +0000953#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000954 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
955 "[-I inode_buffer_blocks] [-P process_inode_size] " \
956 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
957 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000958#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000959 "Check ext2/ext3 file system\n" \
960 "\nOptions:" \
961 "\n -p Automatic repair (no questions)" \
962 "\n -n Make no changes to the filesystem" \
963 "\n -y Assume 'yes' to all questions" \
964 "\n -c Check for bad blocks and add them to the badblock list" \
965 "\n -f Force checking even if filesystem is marked clean" \
966 "\n -v Verbose" \
967 "\n -b superblock Use alternative superblock" \
968 "\n -B blocksize Force blocksize when looking for superblock" \
969 "\n -j journal Set location of the external journal" \
970 "\n -l file Add to badblocks list" \
971 "\n -L file Set badblocks list" \
Mike Frysinger51a43b42005-09-24 07:11:16 +0000972
Eric Andersen7e9276b2001-02-22 01:15:47 +0000973#define echo_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000974 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000975#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000976 "Print the specified ARGs to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000977 USE_FEATURE_FANCY_ECHO( "\n" \
978 "\nOptions:" \
979 "\n -n Suppress trailing newline" \
980 "\n -e Interpret backslash-escaped characters (i.e., \\t=tab)" \
981 "\n -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000982 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000983#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000984 "$ echo \"Erik is cool\"\n" \
985 "Erik is cool\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000986 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000987 "Erik\n" \
988 "is\n" \
989 "cool\n" \
990 "$ echo \"Erik\\nis\\ncool\"\n" \
991 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000992
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000993#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000994 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000995#define eject_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000996 "Eject specified DEVICE (or default /dev/cdrom)\n" \
997 "\nOptions:" \
998 USE_FEATURE_EJECT_SCSI( \
999 "\n -s SCSI device" \
1000 ) \
1001 "\n -t Close tray" \
1002 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001003
Rob Landley3b890392006-05-04 20:56:43 +00001004#define ed_trivial_usage ""
1005#define ed_full_usage ""
1006
Eric Andersen84e229c2001-03-29 22:48:33 +00001007#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001008 "[-iu] [-] [name=value]... [command]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001009#define env_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001010 "Print the current environment or run a program after setting\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001011 "up the specified environment\n" \
1012 "\nOptions:" \
1013 "\n -, -i Start with an empty environment" \
1014 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +00001015
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001016#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001017 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001018#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001019 "Send a magic packet to wake up sleeping machines.\n" \
1020 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001021 "a hostname with a known 'ethers' entry.\n" \
1022 "\nOptions:" \
1023 "\n -b Send wake-up packet to the broadcast address" \
1024 "\n -i iface Interface to use (default eth0)" \
1025 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001026
Denis Vlasenko3952f202007-08-13 14:10:24 +00001027#define expand_trivial_usage \
1028 "[-i] [-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001029#define expand_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001030 "Convert tabs to spaces, writing to standard output.\n" \
1031 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001032 USE_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001033 "\n -i,--initial Do not convert tabs after non blanks" \
1034 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001035 ) \
1036 SKIP_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001037 "\n -i Do not convert tabs after non blanks" \
1038 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001039 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00001040
Eric Andersen7e9276b2001-02-22 01:15:47 +00001041#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001042 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001043#define expr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001044 "Print the value of EXPRESSION to standard output.\n" \
1045 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001046 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001047 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
1048 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1049 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1050 " ARG1 <= ARG2\n" \
1051 " ARG1 = ARG2\n" \
1052 " ARG1 != ARG2\n" \
1053 " ARG1 >= ARG2\n" \
1054 " ARG1 > ARG2\n" \
1055 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1056 " ARG1 - ARG2\n" \
1057 " ARG1 * ARG2\n" \
1058 " ARG1 / ARG2\n" \
1059 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001060 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1061 " match STRING REGEXP Same as STRING : REGEXP\n" \
1062 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1063 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1064 " length STRING Length of STRING\n" \
1065 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001066 " it is a keyword like 'match' or an\n" \
1067 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001068 " (EXPRESSION) Value of EXPRESSION\n" \
1069 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001070 "Beware that many operators need to be escaped or quoted for shells.\n" \
1071 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001072 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001073 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1074 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001075
Mike Frysingerfa69f112005-04-17 07:24:19 +00001076#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001077 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001078#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001079 "Provide fake ident (auth) service\n" \
1080 "\nOptions:" \
1081 "\n -f Run in foreground" \
1082 "\n -i Inetd mode" \
1083 "\n -w Inetd 'wait' mode" \
1084 "\n -b ADDR Bind to specified address" \
1085 "\n STRING Ident answer string (default is 'nobody')" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001086
Eric Andersen7e9276b2001-02-22 01:15:47 +00001087#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001088 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001089#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001090 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001091
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001092#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001093 "$ false\n" \
1094 "$ echo $?\n" \
1095 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001096
1097#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001098 "[options] [mode]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001099#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001100 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001101
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001102#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001103 "$ fbset\n" \
1104 "mode \"1024x768-76\"\n" \
1105 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1106 " geometry 1024 768 1024 768 16\n" \
1107 " timings 12714 128 32 16 4 128 4\n" \
1108 " accel false\n" \
1109 " rgba 5/11,6/5,5/0,0/0\n" \
1110 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001111
Eric Andersen7e9276b2001-02-22 01:15:47 +00001112#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001113 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001114#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001115 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001116
Eric Andersen01c3d402003-07-05 07:51:31 +00001117#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001118 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001119#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001120 "Format floppy disk\n" \
1121 "\nOptions:" \
1122 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001123
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001124/* Looks like someone forgot to add this to config system */
1125#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1126# define ENABLE_FEATURE_FDISK_BLKSIZE 0
1127# define USE_FEATURE_FDISK_BLKSIZE(a)
1128#endif
1129
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001130#define fdisk_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001131 "[-ul" USE_FEATURE_FDISK_BLKSIZE("s") "] " \
1132 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001133#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001134 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001135 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001136 "\n -u Start and End are in sectors (instead of cylinders)" \
1137 "\n -l Show partition table for each DISK, then exit" \
1138 USE_FEATURE_FDISK_BLKSIZE( \
1139 "\n -s Show partition sizes in kb for each DISK, then exit" \
1140 ) \
1141 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1142 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
1143 "\n -H HEADS\n" \
1144 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001145
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001146#define blkid_trivial_usage \
1147 ""
1148#define blkid_full_usage "\n\n" \
1149 "Print UUIDs of all filesystems."
1150
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001151#define findfs_trivial_usage \
1152 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001153#define findfs_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001154 "Find a filesystem device based on a label or UUID."
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001155#define findfs_example_usage \
1156 "$ findfs LABEL=MyDevice"
1157
Eric Andersen7e9276b2001-02-22 01:15:47 +00001158#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001159 "[PATH...] [EXPRESSION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001160#define find_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001161 "Search for files. The default PATH is the current directory,\n" \
1162 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001163 "\nEXPRESSION may consist of:" \
1164 "\n -follow Dereference symlinks" \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001165 USE_FEATURE_FIND_XDEV( \
1166 "\n -xdev Don't descend directories on other filesystems") \
1167 USE_FEATURE_FIND_MAXDEPTH( \
1168 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1169 "\n tests/actions to command line arguments only") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001170 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001171 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001172 USE_FEATURE_FIND_PATH( \
1173 "\n -path PATTERN Path matches PATTERN") \
1174 USE_FEATURE_FIND_REGEX( \
1175 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001176 USE_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001177 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001178 USE_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001179 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001180 "\n or exactly (NNN)") \
1181 USE_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001182 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001183 "\n or exactly (N) days") \
1184 USE_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001185 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001186 "\n or exactly (N) minutes") \
1187 USE_FEATURE_FIND_NEWER( \
1188 "\n -newer FILE Modified time is more recent than FILE's") \
1189 USE_FEATURE_FIND_INUM( \
1190 "\n -inum N File has inode number N") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001191 USE_FEATURE_FIND_USER( \
1192 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
1193 USE_FEATURE_FIND_GROUP( \
1194 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
1195 USE_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001196 "\n -depth Process directory name after traversing it") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001197 USE_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001198 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1199 "\n +/-N: file size is bigger/smaller than N") \
1200 "\n -print Print (default and assumed)" \
1201 USE_FEATURE_FIND_PRINT0( \
1202 "\n -print0 Delimit output with null characters rather than" \
1203 "\n newlines") \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001204 USE_FEATURE_FIND_CONTEXT ( \
1205 "\n -context File has specified security context") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001206 USE_FEATURE_FIND_EXEC( \
1207 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1208 "\n matching files") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001209 USE_FEATURE_FIND_PRUNE( \
1210 "\n -prune Stop traversing current subtree") \
1211 USE_FEATURE_FIND_DELETE( \
1212 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001213 USE_FEATURE_FIND_PAREN( \
1214 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001215
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001216#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001217 "$ find / -name passwd\n" \
1218 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001219
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001220#define flash_eraseall_trivial_usage \
1221 "[-jq] MTD_DEVICE"
1222#define flash_eraseall_full_usage "\n\n" \
1223 "Erase an MTD device\n" \
1224 "\nOptions:" \
1225 "\n -j format the device for jffs2" \
1226 "\n -q don't display progress messages"
1227
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001228#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001229 "[-bs] [-w WIDTH] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001230#define fold_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001231 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001232 "standard output\n" \
1233 "\nOptions:" \
1234 "\n -b Count bytes rather than columns" \
1235 "\n -s Break at spaces" \
1236 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001237
Eric Andersen7e9276b2001-02-22 01:15:47 +00001238#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001239 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001240#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001241 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001242#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001243 "$ free\n" \
1244 " total used free shared buffers\n" \
1245 " Mem: 257628 248724 8904 59644 93124\n" \
1246 " Swap: 128516 8404 120112\n" \
1247 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001248
Eric Andersen7e9276b2001-02-22 01:15:47 +00001249#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001250 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001251#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001252 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001253#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001254 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001255
Mike Frysinger51a43b42005-09-24 07:11:16 +00001256#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001257 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001258#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001259 "Check and repair filesystems\n" \
1260 "\nOptions:" \
1261 "\n -A Walk /etc/fstab and check all filesystems" \
1262 "\n -N Don't execute, just show what would be done" \
1263 "\n -P With -A, check filesystems in parallel" \
1264 "\n -R With -A, skip the root filesystem" \
1265 "\n -T Don't show title on startup" \
1266 "\n -V Verbose" \
1267 "\n -C n Write status information to specified filedescriptor" \
1268 "\n -t type List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001269
Eric Andersen7e9276b2001-02-22 01:15:47 +00001270#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001271 "[-larvsmf] /dev/name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001272#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001273 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001274 "\nOptions:" \
1275 "\n -l List all filenames" \
1276 "\n -r Perform interactive repairs" \
1277 "\n -a Perform automatic repairs" \
1278 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001279 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001280 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001281 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001282
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001283#define ftpd_trivial_usage \
Denis Vlasenko4221e902009-03-11 15:07:44 +00001284 "[-wvS] [DIR]"
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001285#define ftpd_full_usage "\n\n" \
1286 "FTP server\n" \
1287 "\n" \
1288 "ftpd should be used as an inetd service.\n" \
1289 "ftpd's line for inetd.conf:\n" \
1290 " 21 stream tcp nowait root ftpd ftpd /files/to/serve\n" \
1291 "It also can be ran from tcpsvd:\n" \
1292 " tcpsvd -vE 0.0.0.0 21 ftpd /files/to/serve\n" \
1293 "\nOptions:" \
1294 "\n -w Allow upload" \
Denis Vlasenko4221e902009-03-11 15:07:44 +00001295 "\n -v Log to stderr" \
1296 "\n -S Log to syslog" \
Denis Vlasenko92576712009-03-09 16:25:33 +00001297 "\n DIR Change root to this directory" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001298
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001299#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001300 "[options] remote-host local-file remote-file"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001301#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001302 "Retrieve a remote file via FTP\n" \
1303 "\nOptions:" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001304 USE_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001305 "\n -c,--continue Continue previous transfer" \
1306 "\n -v,--verbose Verbose" \
1307 "\n -u,--username Username" \
1308 "\n -p,--password Password" \
1309 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001310 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001311 SKIP_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001312 "\n -c Continue previous transfer" \
1313 "\n -v Verbose" \
1314 "\n -u Username" \
1315 "\n -p Password" \
1316 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001317 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001318
1319#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001320 "[options] remote-host remote-file local-file"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001321#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001322 "Store a local file on a remote machine via FTP\n" \
1323 "\nOptions:" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001324 USE_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001325 "\n -v,--verbose Verbose" \
1326 "\n -u,--username Username" \
1327 "\n -p,--password Password" \
1328 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001329 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001330 SKIP_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001331 "\n -v Verbose" \
1332 "\n -u Username" \
1333 "\n -p Password" \
1334 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001335 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001336
Rob Landleyaa872762005-10-28 13:05:12 +00001337#define fuser_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001338 "[options] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001339#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001340 "Find processes which use FILEs or PORTs\n" \
1341 "\nOptions:" \
1342 "\n -m Find processes which use same fs as FILEs" \
1343 "\n -4 Search only IPv4 space" \
1344 "\n -6 Search only IPv6 space" \
1345 "\n -s Silent: just exit with 0 if any processes are found" \
1346 "\n -k Kill found processes (otherwise display PIDs)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001347 "\n -SIGNAL Signal to send (default: TERM)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001348
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001349#define getenforce_trivial_usage NOUSAGE_STR
1350#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001351
Eric Andersen7e9276b2001-02-22 01:15:47 +00001352#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001353 "[OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001354#define getopt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001355 "Parse command options\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001356 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001357 "\n -a,--alternative Allow long options starting with single -" \
1358 "\n -l,--longoptions=longopts Long options to be recognized" \
1359 "\n -n,--name=progname The name under which errors are reported" \
1360 "\n -o,--options=optstring Short options to be recognized" \
1361 "\n -q,--quiet Disable error reporting by getopt(3)" \
1362 "\n -Q,--quiet-output No normal output" \
1363 "\n -s,--shell=shell Set shell quoting conventions" \
1364 "\n -T,--test Test for getopt(1) version" \
1365 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001366 ) \
1367 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001368 "\n -a Allow long options starting with single -" \
1369 "\n -l longopts Long options to be recognized" \
1370 "\n -n progname The name under which errors are reported" \
1371 "\n -o optstring Short options to be recognized" \
1372 "\n -q Disable error reporting by getopt(3)" \
1373 "\n -Q No normal output" \
1374 "\n -s shell Set shell quoting conventions" \
1375 "\n -T Test for getopt(1) version" \
1376 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001377 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001378#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001379 "$ cat getopt.test\n" \
1380 "#!/bin/sh\n" \
1381 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1382 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001383 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001384 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001385 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001386 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001387 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1388 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001389 " -c|--c-long)\n" \
1390 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001391 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1392 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1393 " esac;;\n" \
1394 " --) shift; break;;\n" \
1395 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001396 " esac\n" \
1397 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001398
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001399#define getsebool_trivial_usage \
1400 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001401#define getsebool_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001402 " -a Show all SELinux booleans"
1403
Eric Andersenf349e972001-08-21 16:18:59 +00001404#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001405 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001406#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001407 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1408 "\nOptions:" \
1409 "\n -h Enable hardware (RTS/CTS) flow control" \
1410 "\n -i Do not display /etc/issue before running login" \
1411 "\n -L Local line, do not do carrier detect" \
1412 "\n -m Get baud rate from modem's CONNECT status message" \
1413 "\n -w Wait for a CR or LF before sending /etc/issue" \
1414 "\n -n Do not prompt the user for a login name" \
1415 "\n -f issue_file Display issue_file instead of /etc/issue" \
1416 "\n -l login_app Invoke login_app instead of /bin/login" \
1417 "\n -t timeout Terminate after timeout if no username is read" \
1418 "\n -I initstring Init string to send before anything else" \
1419 "\n -H login_host Log login_host into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001420
Eric Andersen7e9276b2001-02-22 01:15:47 +00001421#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001422 "[-HhrilLnqvso" \
1423 USE_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001424 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001425 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1426 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001427 "] PATTERN [FILEs...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001428#define grep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001429 "Search for PATTERN in each FILE or standard input\n" \
1430 "\nOptions:" \
1431 "\n -H Prefix output lines with filename where match was found" \
1432 "\n -h Suppress the prefixing filename on output" \
1433 "\n -r Recurse subdirectories" \
1434 "\n -i Ignore case distinctions" \
1435 "\n -l List names of files that match" \
1436 "\n -L List names of files that do not match" \
1437 "\n -n Print line number with output lines" \
1438 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1439 "\n -v Select non-matching lines" \
1440 "\n -s Suppress file open/read error messages" \
1441 "\n -c Only print count of matching lines" \
1442 "\n -o Show only the part of a line that matches PATTERN" \
1443 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001444 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001445 "\n -w Match whole words only") \
1446 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001447 USE_FEATURE_GREP_EGREP_ALIAS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001448 "\n -E PATTERN is an extended regular expression") \
1449 "\n -e PTRN Pattern to match" \
1450 "\n -f FILE Read pattern from file" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001451 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001452 "\n -A Print NUM lines of trailing context" \
1453 "\n -B Print NUM lines of leading context" \
1454 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001455
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001456#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001457 "$ grep root /etc/passwd\n" \
1458 "root:x:0:0:root:/root:/bin/bash\n" \
1459 "$ grep ^[rR]oo. /etc/passwd\n" \
1460 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001461
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001462#define egrep_trivial_usage NOUSAGE_STR
1463#define egrep_full_usage ""
1464
1465#define fgrep_trivial_usage NOUSAGE_STR
1466#define fgrep_full_usage ""
1467
Eric Andersen7e9276b2001-02-22 01:15:47 +00001468#define gunzip_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001469 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001470#define gunzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001471 "Uncompress FILEs (or standard input)\n" \
1472 "\nOptions:" \
1473 "\n -c Write to standard output" \
1474 "\n -f Force" \
1475 "\n -t Test file integrity" \
1476
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001477#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001478 "$ ls -la /tmp/BusyBox*\n" \
1479 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1480 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1481 "$ ls -la /tmp/BusyBox*\n" \
1482 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001483
1484#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001485 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001486#define gzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001487 "Compress FILEs (or standard input)\n" \
1488 "\nOptions:" \
1489 "\n -c Write to standard output" \
1490 "\n -d Decompress" \
1491 "\n -f Force" \
1492
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001493#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001494 "$ ls -la /tmp/busybox*\n" \
1495 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1496 "$ gzip /tmp/busybox.tar\n" \
1497 "$ ls -la /tmp/busybox*\n" \
1498 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001499
1500#define halt_trivial_usage \
Bernhard Reutner-Fischerd93179f2008-09-01 15:24:52 +00001501 "[-d delay] [-n] [-f]" USE_FEATURE_WTMP(" [-w]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001502#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001503 "Halt the system\n" \
1504 "\nOptions:" \
1505 "\n -d Delay interval for halting" \
1506 "\n -n No call to sync()" \
1507 "\n -f Force halt (don't go through init)" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001508 USE_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001509 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001510 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001511
Eric Andersen3443bd72003-07-22 07:30:36 +00001512#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001513 "[options] [device] .."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001514#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001515 "Options:" \
1516 "\n -a Get/set fs readahead" \
1517 "\n -A Set drive read-lookahead flag (0/1)" \
1518 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1519 "\n -B Set Advanced Power Management setting (1-255)" \
1520 "\n -c Get/set IDE 32-bit IO setting" \
1521 "\n -C Check IDE power mode status" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001522 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001523 "\n -d Get/set using_dma flag") \
1524 "\n -D Enable/disable drive defect-mgmt" \
1525 "\n -f Flush buffer cache for device on exit" \
1526 "\n -g Display drive geometry" \
1527 "\n -h Display terse usage information" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001528 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001529 "\n -i Display drive identification") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001530 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001531 "\n -I Detailed/current information directly from drive") \
1532 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1533 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1534 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1535 "\n -m Get/set multiple sector count" \
1536 "\n -n Get/set ignore-write-errors flag (0/1)" \
1537 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1538 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001539/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001540 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1541 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001542 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001543 "\n -R Register an IDE interface (DANGEROUS)") \
1544 "\n -S Set standby (spindown) timeout" \
1545 "\n -t Perform device read timings" \
1546 "\n -T Perform cache read timings" \
1547 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001548 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001549 "\n -U Un-register an IDE interface (DANGEROUS)") \
1550 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1551 "\n -V Display program version and exit immediately" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001552 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001553 "\n -w Perform device reset (DANGEROUS)") \
1554 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001555 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001556 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1557 "\n -X Set IDE xfer mode (DANGEROUS)" \
1558 "\n -y Put IDE drive in standby mode" \
1559 "\n -Y Put IDE drive to sleep" \
1560 "\n -Z Disable Seagate auto-powersaving mode" \
1561 "\n -z Re-read partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001562
Eric Andersen7e9276b2001-02-22 01:15:47 +00001563#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001564 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001565#define head_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001566 "Print first 10 lines of each FILE to standard output.\n" \
1567 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001568 "file name. With no FILE, or when FILE is -, read standard input.\n" \
1569 "\nOptions:" \
1570 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001571 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001572 "\n -c NUM Output the first NUM bytes" \
1573 "\n -q Never output headers giving file names" \
1574 "\n -v Always output headers giving file names") \
1575
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001576#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001577 "$ head -n 2 /etc/passwd\n" \
1578 "root:x:0:0:root:/root:/bin/bash\n" \
1579 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001580
Glenn L McGrath60281112001-11-02 11:39:46 +00001581#define hexdump_trivial_usage \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001582 "[-bcCdefnosvx" USE_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001583#define hexdump_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001584 "Display file(s) or standard input in a user specified format\n" \
1585 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001586 "\n -b One-byte octal display" \
1587 "\n -c One-byte character display" \
1588 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1589 "\n -d Two-byte decimal display" \
1590 "\n -e FORMAT STRING" \
1591 "\n -f FORMAT FILE" \
1592 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1593 "\n -o Two-byte octal display" \
1594 "\n -s OFFSET Skip OFFSET bytes" \
1595 "\n -v Display all input data" \
1596 "\n -x Two-byte hexadecimal display" \
1597 USE_FEATURE_HEXDUMP_REVERSE( \
1598 "\n -R Reverse of 'hexdump -Cv'") \
1599
1600#define hd_trivial_usage \
1601 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001602#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001603 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001604
Eric Andersen7e9276b2001-02-22 01:15:47 +00001605#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001606 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001607#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001608 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001609
1610#define hostname_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001611 "[OPTION] [hostname | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001612#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001613 "Get or set hostname or DNS domain name\n" \
1614 "\nOptions:" \
1615 "\n -s Short" \
1616 "\n -i Addresses for the hostname" \
1617 "\n -d DNS domain name" \
1618 "\n -f Fully qualified domain name" \
1619 "\n -F FILE Use the contents of FILE to specify the hostname" \
1620
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001621#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001622 "$ hostname\n" \
1623 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001624
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001625#define httpd_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001626 "[-c conffile]" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001627 " [-p [ip:]port]" \
1628 " [-i] [-f] [-v[v]]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001629 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001630 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001631 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001632 " [-h home]" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001633 " [-d/-e string]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001634#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001635 "Listen for incoming HTTP requests\n" \
1636 "\nOptions:" \
1637 "\n -c FILE Configuration file (default httpd.conf)" \
1638 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
1639 "\n -i Inetd mode" \
1640 "\n -f Do not daemonize" \
1641 "\n -v[v] Verbose" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001642 USE_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001643 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001644 USE_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001645 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001646 USE_FEATURE_HTTPD_AUTH_MD5( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001647 "\n -m PASS Crypt PASS with md5 algorithm") \
1648 "\n -h HOME Home directory (default .)" \
1649 "\n -e STRING HTML encode STRING" \
1650 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001651
Robert Griebl1cd04452002-07-21 16:50:49 +00001652#define hwclock_trivial_usage \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001653 USE_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001654 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1655 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001656 " [-f FILE]" \
1657 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001658 SKIP_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001659 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1660 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001661#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001662 "Query and set hardware clock (RTC)\n" \
1663 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001664 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001665 "\n -s Set system time from hardware clock" \
1666 "\n -w Set hardware clock to system time" \
1667 "\n -u Hardware clock is in UTC" \
1668 "\n -l Hardware clock is in local time" \
1669 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001670
Eric Andersen7e9276b2001-02-22 01:15:47 +00001671#define id_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001672 "[OPTIONS]... [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001673#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001674 "Print information about USER or the current user\n" \
1675 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001676 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001677 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001678 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001679 "\n -u Print user ID" \
Denis Vlasenko4f3209b2008-09-13 12:51:10 +00001680 "\n -g Print group ID" \
1681 "\n -G Print supplementary group IDs" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001682 "\n -n Print name instead of a number" \
1683 "\n -r Print real user ID instead of effective ID" \
1684
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001685#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001686 "$ id\n" \
1687 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001688
Eric Andersen7e9276b2001-02-22 01:15:47 +00001689#define ifconfig_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001690 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001691#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001692 "Configure a network interface\n" \
1693 "\nOptions:" \
1694 "\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001695 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001696 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001697 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001698 " [del ADDRESS[/PREFIXLEN]]\n") \
1699 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1700 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001701 USE_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001702 " [outfill NN] [keepalive NN]\n") \
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001703 " " USE_FEATURE_IFCONFIG_HW("[hw ether" USE_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001704 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001705 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001706 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001707 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001708 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001709
Denis Vlasenko06aed432008-02-26 18:25:24 +00001710#define ifenslave_trivial_usage \
1711 "[-cdf] master-iface <slave-iface...>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001712#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001713 "Configure network interfaces for parallel routing\n" \
1714 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001715 "\n -c, --change-active Change active slave" \
1716 "\n -d, --detach Remove slave interface from bonding device" \
1717 "\n -f, --force Force, even if interface is not Ethernet" \
1718/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001719
Denis Vlasenko06aed432008-02-26 18:25:24 +00001720#define ifenslave_example_usage \
1721 "To create a bond device, simply follow these three steps :\n" \
1722 "- ensure that the required drivers are properly loaded :\n" \
1723 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
1724 "- assign an IP address to the bond device :\n" \
1725 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
1726 "- attach all the interfaces you need to the bond device :\n" \
1727 " # ifenslave bond0 eth0 eth1 eth2\n" \
1728 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1729 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
1730 " To detach a dead interface without setting the bond device down :\n" \
1731 " # ifenslave -d bond0 eth1\n\n" \
1732 " To set the bond device down and automatically release all the slaves :\n" \
1733 " # ifconfig bond0 down\n\n" \
1734 " To change active slave :\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001735 " # ifenslave -c bond0 eth0\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001736
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001737#define ifup_trivial_usage \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001738 "[-ain"USE_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001739#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001740 "Options:" \
1741 "\n -a De/configure all interfaces automatically" \
1742 "\n -i FILE Use FILE for interface definitions" \
1743 "\n -n Print out what would happen, but don't do it" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001744 USE_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001745 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001746 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001747 ) \
1748 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001749 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001750
1751#define ifdown_trivial_usage \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001752 "[-ain"USE_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001753#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001754 "Options:" \
1755 "\n -a De/configure all interfaces automatically" \
1756 "\n -i FILE Use FILE for interface definitions" \
1757 "\n -n Print out what would happen, but don't do it" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001758 USE_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001759 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001760 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001761 ) \
1762 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001763 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001764
Glenn L McGrath06e95652003-02-09 06:51:14 +00001765#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001766 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001767#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001768 "Listen for network connections and launch programs\n" \
1769 "\nOptions:" \
1770 "\n -f Run in foreground" \
1771 "\n -e Log to stderr" \
1772 "\n -q N Socket listen queue (default: 128)" \
1773 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001774 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001775
Eric Andersen7e9276b2001-02-22 01:15:47 +00001776#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001777 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001778#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001779 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001780
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001781#define init_notes_usage \
1782"This version of init is designed to be run only by the kernel.\n" \
1783"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001784"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001785"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001786"runlevels, use sysvinit.\n" \
1787"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001788"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001789"it has the following default behavior:\n" \
1790"\n" \
1791" ::sysinit:/etc/init.d/rcS\n" \
1792" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001793" ::ctrlaltdel:/sbin/reboot\n" \
1794" ::shutdown:/sbin/swapoff -a\n" \
1795" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001796" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001797"\n" \
1798"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1799"\n" \
1800" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001801" tty3::askfirst:/bin/sh\n" \
1802" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001803"\n" \
1804"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1805"\n" \
1806" <id>:<runlevels>:<action>:<process>\n" \
1807"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001808" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001809"\n" \
1810" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1811" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001812" the specified process to run on. The contents of this field are\n" \
1813" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1814" be unique, although if it isn't you may have strange results. If this\n" \
1815" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001816" note that if BusyBox detects that a serial console is in use, then only\n" \
1817" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001818" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001819" stinkin' utmp.\n" \
1820"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001821" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001822"\n" \
1823" The runlevels field is completely ignored.\n" \
1824"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001825" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001826"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001827" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001828" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001829"\n" \
1830" The available actions can be classified into two groups: actions\n" \
1831" that are run only once, and actions that are re-run when the specified\n" \
1832" process exits.\n" \
1833"\n" \
1834" Run only-once actions:\n" \
1835"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001836" 'sysinit' is the first item run on boot. init waits until all\n" \
1837" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001838" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001839" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001840" the specified task completes. 'once' actions are asynchronous,\n" \
1841" therefore, init does not wait for them to complete. 'restart' is\n" \
1842" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001843" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001844" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001845" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001846" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001847" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001848" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001849" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001850" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001851"\n" \
1852" Run repeatedly actions:\n" \
1853"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001854" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001855" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001856" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1857" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001858" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001859" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001860" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001861" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001862"\n" \
1863" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001864" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001865" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001866"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001867" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001868"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001869" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001870"\n" \
1871"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001872"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001873" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001874" #\n" \
1875" ::sysinit:/etc/init.d/rcS\n" \
1876" \n" \
1877" # /bin/sh invocations on selected ttys\n" \
1878" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001879" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001880" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001881" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001882" tty2::askfirst:-/bin/sh\n" \
1883" tty3::askfirst:-/bin/sh\n" \
1884" tty4::askfirst:-/bin/sh\n" \
1885" \n" \
1886" # /sbin/getty invocations for selected ttys\n" \
1887" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001888" tty4::respawn:/sbin/getty 38400 tty4\n" \
1889" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001890" \n" \
1891" \n" \
1892" # Example of how to put a getty on a serial line (for a terminal)\n" \
1893" #\n" \
1894" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1895" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1896" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001897" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001898" #::respawn:/sbin/getty 57600 ttyS2\n" \
1899" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001900" # Stuff to do when restarting the init process\n" \
1901" ::restart:/sbin/init\n" \
1902" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001903" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001904" ::ctrlaltdel:/sbin/reboot\n" \
1905" ::shutdown:/bin/umount -a -r\n" \
1906" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001907
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001908#define inotifyd_trivial_usage \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001909 "PROG FILE1[:MASK] ..."
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001910#define inotifyd_full_usage "\n\n" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001911 "Run PROG on filesystem changes." \
1912 "\nWhen a filesystem event matching MASK occurs on FILEn," \
1913 "\nPROG <actual_event(s)> <FILEn> [<subfile_name>] is run." \
Denis Vlasenko289ff0e2008-11-14 21:52:16 +00001914 "\nEvents:" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001915 "\n a File is accessed" \
1916 "\n c File is modified" \
1917 "\n e Metadata changed" \
1918 "\n w Writtable file is closed" \
1919 "\n 0 Unwrittable file is closed" \
1920 "\n r File is opened" \
Denis Vlasenkoa09a42c2008-11-17 22:19:18 +00001921 "\n D File is deleted" \
1922 "\n M File is moved" \
1923 "\n u Backing fs is unmounted" \
1924 "\n o Event queue overflowed" \
1925 "\n x File can't be watched anymore" \
1926 "\nIf watching a directory:" \
1927 "\n m Subfile is moved into dir" \
1928 "\n y Subfile is moved out of dir" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001929 "\n n Subfile is created" \
1930 "\n d Subfile is deleted" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001931 "\n" \
1932 "\ninotifyd waits for PROG to exit." \
1933 "\nWhen x event happens for all FILEs, inotifyd exits" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001934
Denis Vlasenko36309cf2008-11-22 18:29:01 +00001935/* 2.6 style insmod has no options and required filename
1936 * (not module name - .ko can't be omitted) */
Eric Andersen7e9276b2001-02-22 01:15:47 +00001937#define insmod_trivial_usage \
Denis Vlasenko36309cf2008-11-22 18:29:01 +00001938 USE_FEATURE_2_4_MODULES("[OPTION]... MODULE ") \
1939 SKIP_FEATURE_2_4_MODULES("FILE ") \
1940 "[symbol=value]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001941#define insmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001942 "Load the specified kernel modules into the kernel" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001943 USE_FEATURE_2_4_MODULES( "\n" \
1944 "\nOptions:" \
1945 "\n -f Force module to load into the wrong kernel version" \
1946 "\n -k Make module autoclean-able" \
1947 "\n -v Verbose" \
1948 "\n -q Quiet" \
1949 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001950 USE_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001951 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001952 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001953 "\n -o NAME Set internal module name to NAME" \
1954 "\n -x Do not export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001955 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001956
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00001957/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001958#define install_trivial_usage \
Denis Vlasenko4acdb462009-01-31 21:45:57 +00001959 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [source] dest|directory"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001960#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001961 "Copy files and set attributes\n" \
1962 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001963 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001964 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00001965 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001966 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001967 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001968 "\n -o USER Set ownership" \
1969 "\n -g GRP Set group ownership" \
1970 "\n -m MODE Set permissions" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001971 USE_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001972 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001973 )
Denis Vlasenko397de612008-03-17 08:55:44 +00001974
Denis Vlasenko4acdb462009-01-31 21:45:57 +00001975#define ionice_trivial_usage \
1976 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
1977#define ionice_full_usage "\n\n" \
1978 "Change I/O scheduling class and priority\n" \
1979 "\nOptions:" \
1980 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
1981 "\n -n Priority" \
1982
Denis Vlasenko397de612008-03-17 08:55:44 +00001983/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001984#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001985 "[OPTIONS] {" \
1986 USE_FEATURE_IP_ADDRESS("address | ") \
1987 USE_FEATURE_IP_ROUTE("route | ") \
1988 USE_FEATURE_IP_LINK("link | ") \
1989 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1990 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001991 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001992#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001993 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001994 "where OBJECT := {" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001995 USE_FEATURE_IP_ADDRESS("address | ") \
1996 USE_FEATURE_IP_ROUTE("route | ") \
1997 USE_FEATURE_IP_LINK("link | ") \
1998 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1999 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002000 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002001 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002002
2003#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002004 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002005 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002006#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002007 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002008 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
2009 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002010 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002011 " [broadcast ADDR] [anycast ADDR]\n" \
2012 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002013 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002014
Eric Andersende4f07e2003-12-11 01:18:07 +00002015#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002016 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002017#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002018 "Calculate IP network settings from a IP address\n" \
2019 "\nOptions:" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002020 USE_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002021 "\n -b,--broadcast Display calculated broadcast address" \
2022 "\n -n,--network Display calculated network address" \
2023 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002024 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002025 "\n -p,--prefix Display the prefix for IP/NETMASK" \
2026 "\n -h,--hostname Display first resolved host name" \
2027 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002028 ) \
2029 ) \
2030 SKIP_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002031 "\n -b Display calculated broadcast address" \
2032 "\n -n Display calculated network address" \
2033 "\n -m Display default netmask for IP" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002034 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002035 "\n -p Display the prefix for IP/NETMASK" \
2036 "\n -h Display first resolved host name" \
2037 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002038 ) \
2039 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00002040
Rob Landley6eb1e412005-06-20 04:30:36 +00002041#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002042 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002043#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002044 "Upper-case options MQS remove an object by shmkey value.\n" \
2045 "Lower-case options remove an object by shmid value.\n" \
2046 "\nOptions:" \
2047 "\n -mM Remove memory segment after last detach" \
2048 "\n -qQ Remove message queue" \
2049 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002050
2051#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002052 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002053#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002054 " -i Show specific resource" \
2055 "\nResource specification:" \
2056 "\n -m Shared memory segments" \
2057 "\n -q Message queues" \
2058 "\n -s Semaphore arrays" \
2059 "\n -a All (default)" \
2060 "\nOutput format:" \
2061 "\n -t Time" \
2062 "\n -c Creator" \
2063 "\n -p Pid" \
2064 "\n -l Limits" \
2065 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002066
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002067#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002068 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002069#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00002070 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002071 " dynamic { on | off } |\n" \
2072 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002073 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002074
2075#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002076 "{ list | flush | { add | del | change | append |\n" \
2077 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002078#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002079 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002080 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
2081 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002082 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002083 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00002084 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
2085 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002086
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002087#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002088 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002089#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002090 "iprule [list | add | del] SELECTOR ACTION\n" \
2091 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2092 " [dev STRING] [pref NUMBER]\n" \
2093 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2094 " [prohibit | reject | unreachable]\n" \
2095 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002096 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002097
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002098#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002099 "{ add | change | del | show } [NAME]\n" \
2100 " [mode { ipip | gre | sit }]\n" \
2101 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002102#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002103 "iptunnel { add | change | del | show } [NAME]\n" \
2104 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2105 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002106 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002107
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002108#define kbd_mode_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002109 "[-a|k|s|u] [-C TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002110#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002111 "Report or set the keyboard mode\n" \
2112 "\nOptions set mode:" \
2113 "\n -a Default (ASCII)" \
2114 "\n -k Medium-raw (keyboard)" \
2115 "\n -s Raw (scancode)" \
2116 "\n -u Unicode (utf-8)" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002117 "\n -C TTY Affect TTY instead of /dev/tty" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002118
Eric Andersen7e9276b2001-02-22 01:15:47 +00002119#define kill_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002120 "[-l] [-SIG] PID..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002121#define kill_full_usage "\n\n" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002122 "Send a signal (default is TERM) to given PIDs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002123 "\nOptions:" \
2124 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002125/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002126
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002127#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002128 "$ ps | grep apache\n" \
2129 "252 root root S [apache]\n" \
2130 "263 www-data www-data S [apache]\n" \
2131 "264 www-data www-data S [apache]\n" \
2132 "265 www-data www-data S [apache]\n" \
2133 "266 www-data www-data S [apache]\n" \
2134 "267 www-data www-data S [apache]\n" \
2135 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002136
2137#define killall_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002138 "[-l] [-q] [-SIG] process-name..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002139#define killall_full_usage "\n\n" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002140 "Send a signal (default is TERM) to given processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002141 "\nOptions:" \
2142 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002143/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002144 "\n -q Do not complain if no processes were killed" \
2145
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002146#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002147 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002148
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002149#define killall5_trivial_usage \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002150 "[-l] [-SIG] [-o PID]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002151#define killall5_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002152 "Send a signal (default is TERM) to all processes outside current session\n" \
2153 "\nOptions:" \
2154 "\n -l List all signal names and numbers" \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002155 "\n -o PID Do not signal this PID" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002156/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002157
Mark Whitley6317c4b2001-03-12 22:51:50 +00002158#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002159 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002160#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002161 "Kernel logger\n" \
2162 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002163 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002164 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002165
Eric Andersen7e9276b2001-02-22 01:15:47 +00002166#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002167 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002168#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002169 "Print STRING's length"
2170
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002171#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002172 "$ length Hello\n" \
2173 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002174
Rob Landley9200e792005-09-15 19:26:59 +00002175#define less_trivial_usage \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002176 "[-EMNmh~I?] [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002177#define less_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002178 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002179 "changed, and files can be manipulated in various ways.\n" \
2180 "\nOptions:" \
2181 "\n -E Quit once the end of a file is reached" \
2182 "\n -M,-m Display a status line containing the line numbers" \
2183 "\n and percentage through the file" \
2184 "\n -N Prefix line numbers to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002185 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002186 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002187
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002188#define linux32_trivial_usage NOUSAGE_STR
2189#define linux32_full_usage ""
2190#define linux64_trivial_usage NOUSAGE_STR
2191#define linux64_full_usage ""
2192
2193#define linuxrc_trivial_usage NOUSAGE_STR
2194#define linuxrc_full_usage ""
2195
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002196#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002197 "personality program [args...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002198#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002199 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002200 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002201 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002202
Eric Andersen7e9276b2001-02-22 01:15:47 +00002203#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002204 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002205#define ln_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002206 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002207 "Use '--' to indicate that all following arguments are non-options.\n" \
2208 "\nOptions:" \
2209 "\n -s Make symlinks instead of hardlinks" \
2210 "\n -f Remove existing destination files" \
2211 "\n -n Don't dereference symlinks - treat like normal file" \
2212 "\n -b Make a backup of the target (if exists) before link operation" \
2213 "\n -S suf Use suffix instead of ~ when making backup files" \
2214
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002215#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002216 "$ ln -s BusyBox /tmp/ls\n" \
2217 "$ ls -l /tmp/ls\n" \
2218 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002219
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002220#define load_policy_trivial_usage NOUSAGE_STR
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002221#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002222
Eric Andersen7e9276b2001-02-22 01:15:47 +00002223#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002224 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002225#define loadfont_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002226 "Load a console font from standard input" \
2227/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2228
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002229#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002230 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002231
2232#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002233 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002234#define loadkmap_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002235 "Load a binary keyboard translation table from standard input\n" \
2236/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2237
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002238#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002239 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002240
2241#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002242 "[OPTION]... [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002243#define logger_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002244 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n" \
2245 "\nOptions:" \
2246 "\n -s Log to stderr as well as the system log" \
2247 "\n -t TAG Log using the specified tag (defaults to user name)" \
2248 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002249
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002250#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002251 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002252
Robert Griebl1fca5582002-06-04 20:45:46 +00002253#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002254 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002255#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002256 "Begin a new session on the system\n" \
2257 "\nOptions:" \
2258 "\n -f Do not authenticate (user already authenticated)" \
2259 "\n -h Name of the remote host" \
2260 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002261
Eric Andersen7e9276b2001-02-22 01:15:47 +00002262#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002263 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002264#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002265 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002266#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002267 "$ logname\n" \
2268 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002269
Mark Whitley6317c4b2001-03-12 22:51:50 +00002270#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002271 "[OPTION]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002272#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002273 "Show messages in syslogd's circular buffer\n" \
2274 "\nOptions:" \
2275 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002276
Matt Kraai83788da2002-03-20 17:38:37 +00002277#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002278 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2279 " losetup -d LOOPDEV - disassociate\n" \
2280 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002281#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002282 "Options:" \
2283 "\n -o OFS Start OFS bytes into FILE" \
2284 "\n -f Show first free loop device" \
2285
Rob Landley1d589b22005-11-29 23:47:10 +00002286#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002287 "No arguments will display all current associations.\n" \
2288 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002289 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002290 "and filename of the file the loop device is currently bound to.\n\n" \
2291 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002292 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2293 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002294
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002295#define lpd_trivial_usage \
Denis Vlasenkoa7942892008-03-23 23:40:18 +00002296 "SPOOLDIR [HELPER [ARGS...]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002297#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002298 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2299 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002300 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002301 "\ndirectory and HELPER program is called. Name of file to print" \
2302 "\nis passed in $DATAFILE variable." \
2303 "\nExample:" \
2304 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002305
Denis Vlasenko68444b92008-02-22 22:24:48 +00002306#define lpq_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002307 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID...] [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002308#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002309 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002310 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002311 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002312 "\n -f Force any waiting job to be printed" \
2313 "\n -s Short display" \
2314
2315#define lpr_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002316 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE...]"
2317/* -C CLASS exists too, not shown.
2318 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002319#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002320 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002321 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002322 "\n -m Send mail on completion" \
2323 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002324 "\n -V Verbose" \
2325
Eric Andersen7e9276b2001-02-22 01:15:47 +00002326#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002327 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00002328 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002329 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
2330 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
2331 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
2332 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
2333 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
2334 USE_SELINUX("K") "] [filenames...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002335#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002336 "List directory contents\n" \
2337 "\nOptions:" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002338 "\n -1 List in a single column" \
2339 "\n -A Don't list . and .." \
2340 "\n -a Don't hide entries starting with ." \
2341 "\n -C List by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002342 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002343 "\n -c With -l: sort by ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002344 USE_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002345 "\n --color[={always,never,auto}] Control coloring") \
2346 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002347 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002348 "\n -e List full date and time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002349 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002350 "\n -F Append indicator (one of */=@|) to entries") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002351 "\n -i List inode numbers" \
2352 "\n -l Long listing format" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002353 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002354 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002355 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002356 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002357 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002358 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002359 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002360 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002361 "\n -r Sort in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002362 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002363 "\n -S Sort by file size") \
Denis Vlasenko397de612008-03-17 08:55:44 +00002364 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002365 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002366 "\n -T NUM Assume tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002367 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002368 "\n -t With -l: sort by modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002369 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002370 "\n -u With -l: sort by access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002371 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002372 "\n -v Sort by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002373 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002374 "\n -w NUM Assume the terminal is NUM columns wide") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002375 "\n -x List by lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002376 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002377 "\n -X Sort by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00002378 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002379 "\n -h List sizes in human readable format (1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002380 USE_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002381 "\n -k List security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002382 USE_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002383 "\n -K List security context in long format") \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002384 USE_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002385 "\n -Z List security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002386
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002387#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002388 "[-Radlv] [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002389#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002390 "List file attributes on an ext2 fs\n" \
2391 "\nOptions:" \
2392 "\n -R Recursively list subdirectories" \
2393 "\n -a Do not hide entries starting with ." \
2394 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002395 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002396 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002397
Eric Andersen7e9276b2001-02-22 01:15:47 +00002398#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002399 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002400#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002401 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002402
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002403#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002404#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002405 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002406#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002407 "Create a range of block or character special files" \
2408 "\n" \
2409 "\nTYPE is:" \
2410 "\n b Block device" \
2411 "\n c Character device" \
2412 "\n f FIFO, MAJOR and MINOR are ignored" \
2413 "\n" \
2414 "\nFIRST..LAST specify numbers appended to NAME." \
2415 "\nIf 's' is the last argument, the base device is created as well." \
2416 "\n" \
2417 "\nExamples:" \
2418 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2419 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002420#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002421 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2422 "[creates ttyS2-ttyS63]\n" \
2423 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2424 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002425#endif
2426
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002427#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002428#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002429 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002430#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002431 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002432 "Device table entries take the form of:\n" \
2433 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002434 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002435 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002436 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002437 " c Character device\n" \
2438 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002439 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002440 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002441 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2442 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002443#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002444 "For example:\n" \
2445 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2446 "/dev d 755 0 0 - - - - -\n" \
2447 "/dev/console c 666 0 0 5 1 - - -\n" \
2448 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2449 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2450 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2451 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2452 "Will Produce:\n" \
2453 "/dev\n" \
2454 "/dev/console\n" \
2455 "/dev/null\n" \
2456 "/dev/zero\n" \
2457 "/dev/hda\n" \
2458 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002459#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002460
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002461#define makemime_trivial_usage \
2462 "[OPTION]... [FILE]..."
2463#define makemime_full_usage "\n\n" \
2464 "Create MIME-encoded message\n" \
2465 "\nOptions:" \
2466 "\n -C Charset" \
Denis Vlasenkoc028ec22008-11-10 10:47:47 +00002467 "\n -e Transfer encoding. Ignored. base64 is assumed" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002468 "\n" \
2469 "\nOther options are silently ignored." \
2470
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002471#define man_trivial_usage \
2472 "[OPTION]... [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002473#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002474 "Format and display manual page\n" \
2475 "\nOptions:" \
2476 "\n -a Display all pages" \
2477 "\n -w Show page locations" \
2478
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002479#define matchpathcon_trivial_usage \
2480 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002481#define matchpathcon_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002482 " -n Do not display path" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002483 "\n -N Do not use translations" \
2484 "\n -f Use alternate file_context file" \
2485 "\n -p Use prefix to speed translations" \
2486 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002487
Eric Andersen7e9276b2001-02-22 01:15:47 +00002488#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002489 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002490 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002491#define md5sum_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002492 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002493 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2494 "\nOptions:" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002495 "\n -c Check sums against given list" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002496 "\n -s Don't output anything, status code shows success" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002497 "\n -w Warn about improperly formatted checksum lines" \
2498 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002499
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002500#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002501 "$ md5sum < busybox\n" \
2502 "6fd11e98b98a58f64ff3398d7b324003\n" \
2503 "$ md5sum busybox\n" \
2504 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2505 "$ md5sum -c -\n" \
2506 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2507 "busybox: OK\n" \
2508 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002509
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002510#define sha1sum_trivial_usage \
2511 "[OPTION] [FILEs...]" \
2512 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
2513#define sha1sum_full_usage "\n\n" \
2514 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
2515 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2516 "\nOptions:" \
2517 "\n -c Check sums against given list" \
2518 "\n -s Don't output anything, status code shows success" \
2519 "\n -w Warn about improperly formatted checksum lines" \
2520 )
2521
2522#define sha256sum_trivial_usage \
2523 "[OPTION] [FILEs...]" \
2524 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha256sum [OPTION] -c [FILE]")
2525#define sha256sum_full_usage "\n\n" \
2526 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
2527 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2528 "\nOptions:" \
2529 "\n -c Check sums against given list" \
2530 "\n -s Don't output anything, status code shows success" \
2531 "\n -w Warn about improperly formatted checksum lines" \
2532 )
2533
2534#define sha512sum_trivial_usage \
2535 "[OPTION] [FILEs...]" \
2536 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha512sum [OPTION] -c [FILE]")
2537#define sha512sum_full_usage "\n\n" \
2538 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
2539 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2540 "\nOptions:" \
2541 "\n -c Check sums against given list" \
2542 "\n -s Don't output anything, status code shows success" \
2543 "\n -w Warn about improperly formatted checksum lines" \
2544 )
2545
Rob Landley70f7ef72005-12-13 08:21:33 +00002546#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002547 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002548#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002549 " -s Scan /sys and populate /dev during system boot\n" \
2550 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002551 "Called with no options (via hotplug) it uses environment variables\n" \
2552 "to determine which device to add/remove."
Denis Vlasenko397de612008-03-17 08:55:44 +00002553
Rob Landleyef10d522006-06-26 14:11:33 +00002554#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002555 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002556 "The mdev config file contains lines that look like:\n" \
2557 " hd[a-z][0-9]* 0:3 660\n\n" \
2558 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002559 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002560 "Optionally, that can be followed (on the same line) by a special character\n" \
2561 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002562 "device(s). The environment variable $MDEV indicates the active device node\n" \
2563 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002564 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2565 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002566 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002567 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002568 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002569 "Config file parsing stops on the first matching line. If no config\n" \
2570 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002571 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002572 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002573
Glenn L McGrath061c9002002-09-16 04:21:46 +00002574#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002575 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002576#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002577 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002578 " y Allow write access to your terminal\n" \
2579 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002580
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002581#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002582 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002583#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002584 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2585 "\nOptions:" \
2586 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2587 "\n next byte to it" \
2588 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2589 "\n -s Set serial line to SPEED" \
2590 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002591
Eric Andersen7e9276b2001-02-22 01:15:47 +00002592#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002593 "[OPTION] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002594#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002595 "Create DIRECTORY\n" \
2596 "\nOptions:" \
2597 "\n -m Set permission mode (as in chmod), not rwxrwxrwx - umask" \
2598 "\n -p No error if existing, make parent directories as needed" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002599 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002600 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002601 )
2602
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002603#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002604 "$ mkdir /tmp/foo\n" \
2605 "$ mkdir /tmp/foo\n" \
2606 "/tmp/foo: File exists\n" \
2607 "$ mkdir /tmp/foo/bar/baz\n" \
2608 "/tmp/foo/bar/baz: No such file or directory\n" \
2609 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002610
Mike Frysinger6447ac02005-06-11 05:29:40 +00002611#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002612 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2613 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2614 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2615 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2616 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2617 "device [blocks-count]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002618#define mke2fs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002619 " -b size Block size in bytes" \
2620 "\n -c Check for bad blocks before creating" \
2621 "\n -E opts Set extended options" \
2622 "\n -f size Fragment size in bytes" \
2623 "\n -F Force (ignore sanity checks)" \
2624 "\n -g num Number of blocks in a block group" \
2625 "\n -i ratio The bytes/inode ratio" \
2626 "\n -j Create a journal (ext3)" \
2627 "\n -J opts Set journal options (size/device)" \
2628 "\n -l file Read bad blocks list from file" \
2629 "\n -L lbl Set the volume label" \
2630 "\n -m percent Percent of fs blocks to reserve for admin" \
2631 "\n -M dir Set last mounted directory" \
2632 "\n -n Do not actually create anything" \
2633 "\n -N num Number of inodes to create" \
2634 "\n -o os Set the 'creator os' field" \
2635 "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" \
2636 "\n -q Quiet" \
2637 "\n -r rev Set filesystem revision" \
2638 "\n -S Write superblock and group descriptors only" \
2639 "\n -T fs-type Set usage type (news/largefile/largefile4)" \
2640 "\n -v Verbose" \
Mike Frysinger6447ac02005-06-11 05:29:40 +00002641
Eric Andersen7e9276b2001-02-22 01:15:47 +00002642#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002643 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002644#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002645 "Create named pipe (identical to 'mknod name p')\n" \
2646 "\nOptions:" \
2647 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002648 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002649 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002650 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002651
Eric Andersen7e9276b2001-02-22 01:15:47 +00002652#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002653 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002654#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002655 "Make a MINIX filesystem\n" \
2656 "\nOptions:" \
2657 "\n -c Check device for bad blocks" \
2658 "\n -n [14|30] Maximum length of filenames" \
2659 "\n -i INODES Number of inodes for the filesystem" \
2660 "\n -l FILENAME Read bad blocks list from FILENAME" \
2661 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002662
Eric Andersen7e9276b2001-02-22 01:15:47 +00002663#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002664 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002665#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002666 "Create a special file (block, character, or pipe)\n" \
2667 "\nOptions:" \
2668 "\n -m Create the special file using the specified mode (default a=rw)" \
2669 "\nTYPEs include:" \
2670 "\n b: Make a block device" \
2671 "\n c or u: Make a character device" \
2672 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002673 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002674 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002675 )
2676
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002677#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002678 "$ mknod /dev/fd0 b 2 0\n" \
2679 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002680
Eric Andersen7e9276b2001-02-22 01:15:47 +00002681#define mkswap_trivial_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002682 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002683#define mkswap_full_usage "\n\n" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002684 "Prepare block device to be used as swap partition"
2685#if 0
2686 "[-c] [-v0|-v1] DEVICE [BLOCKS]"
Denis Vlasenko397de612008-03-17 08:55:44 +00002687 "\nOptions:"
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002688 "\n -c Check for readability"
2689 "\n -v0 Make swap version 0 (max 128M)"
2690 "\n -v1 Make swap version 1 (default for kernels > 2.1.117)"
2691 "\n BLOCKS Number of blocks to use (default is entire partition)"
2692#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002693
Eric Andersen7e9276b2001-02-22 01:15:47 +00002694#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002695 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002696#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002697 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002698 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002699 "\nOptions:" \
2700 "\n -d Make a directory instead of a file" \
2701/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2702 "\n -t Generate a path rooted in temporary directory" \
2703 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2704 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002705 "\nFor -t or -p, directory is chosen as follows:" \
2706 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002707
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002708#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002709 "$ mktemp /tmp/temp.XXXXXX\n" \
2710 "/tmp/temp.mWiLjM\n" \
2711 "$ ls -la /tmp/temp.mWiLjM\n" \
2712 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002713
Eric Andersen8d79ce82001-07-22 23:00:15 +00002714#define modprobe_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002715 "[-knqrsv] MODULE [symbol=value...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002716#define modprobe_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002717 "Options:" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002718 USE_FEATURE_2_4_MODULES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002719 "\n -k Make module autoclean-able" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002720 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002721 "\n -n Dry run" \
2722 "\n -q Quiet" \
2723 "\n -r Remove module (stacks) or do autoclean" \
2724 "\n -s Report via syslog instead of stderr" \
2725 "\n -v Verbose" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002726 USE_FEATURE_MODPROBE_BLACKLIST( \
2727 "\n -b Apply blacklist to module names too" \
2728 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002729
Rob Landley9c32a152005-12-11 20:12:24 +00002730#define modprobe_notes_usage \
2731"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2732"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2733"pass each module it loads.\n" \
2734"\n" \
Bernhard Reutner-Fischer12aca792009-02-24 10:03:22 +00002735"The configuration file is searched (in this order):\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002736"\n" \
2737" /etc/modprobe.conf (2.6 only)\n" \
2738" /etc/modules.conf\n" \
2739" /etc/conf.modules (deprecated)\n" \
2740"\n" \
2741"They all have the same syntax (see below). If none is present, it is\n" \
2742"_not_ an error; each loaded module is then expected to load without\n" \
2743"options. Once a file is found, the others are tested for.\n" \
2744"\n" \
2745"/etc/modules.conf entry format:\n" \
2746"\n" \
2747" alias <alias_name> <mod_name>\n" \
2748" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002749" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002750" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2751" This makes it also possible to use a different set of options (below) for\n" \
2752" the module and the alias.\n" \
2753" A module can be aliased more than once.\n" \
2754"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002755" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002756" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2757" the \"symbol=value\" pairs as option to that module.\n" \
2758"\n" \
2759"Sample /etc/modules.conf file:\n" \
2760"\n" \
2761" options tulip irq=3\n" \
2762" alias tulip tulip2\n" \
2763" options tulip2 irq=4 io=0x308\n" \
2764"\n" \
2765"Other functionality offered by 'classic' modprobe is not available in\n" \
2766"this implementation.\n" \
2767"\n" \
2768"If module options are present both in the config file, and on the command line,\n" \
2769"then the options from the command line will be passed to the module _after_\n" \
2770"the options from the config file. That way, you can have defaults in the config\n" \
2771"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002772#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002773 "(with the above /etc/modules.conf):\n\n" \
2774 "$ modprobe tulip\n" \
2775 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2776 "$ modprobe tulip irq=5\n" \
2777 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2778 "$ modprobe tulip2\n" \
2779 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2780 " which are the default for alias 'tulip2'\n\n" \
2781 "$ modprobe tulip2 irq=8\n" \
2782 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2783 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2784 " from the command line\n\n" \
2785 "$ modprobe tulip2 irq=2 io=0x210\n" \
2786 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2787 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2788 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002789
Eric Andersen7e9276b2001-02-22 01:15:47 +00002790#define more_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002791 "[FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002792#define more_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002793 "View FILE or standard input one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002794
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002795#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002796 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002797
Eric Andersen7e9276b2001-02-22 01:15:47 +00002798#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002799 "[flags] DEVICE NODE [-o options,more-options]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002800#define mount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002801 "Mount a filesystem. Filesystem autodetection requires /proc be mounted.\n" \
2802 "\nOptions:" \
2803 "\n -a Mount all filesystems in fstab" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002804 USE_FEATURE_MOUNT_FAKE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002805 "\n -f "USE_FEATURE_MTAB_SUPPORT("Update /etc/mtab, but ")"don't mount" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002806 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002807 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002808 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002809 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002810 "\n -r Read-only mount" \
2811 "\n -t fs-type Filesystem type" \
2812 "\n -w Read-write mount (default)" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002813 "\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002814 "-o option:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002815 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002816 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002817 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002818 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002819 " [a]sync Writes are asynchronous / synchronous\n" \
2820 " [no]atime Disable / enable updates to inode access times\n" \
2821 " [no]diratime Disable / enable atime updates to directories\n" \
Bernhard Reutner-Fischerfb5902c2008-08-06 18:14:38 +00002822 " [no]relatime Disable / enable atime updates relative to modification time\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002823 " [no]dev Allow use of special device files / disallow them\n" \
2824 " [no]exec Allow use of executable files / disallow them\n" \
2825 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2826 " [r]shared Convert [recursively] to a shared subtree\n" \
2827 " [r]slave Convert [recursively] to a slave subtree\n" \
2828 " [r]private Convert [recursively] to a private subtree\n" \
2829 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2830 " bind Bind a directory to an additional location\n" \
2831 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002832 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002833 " remount Remount a mounted filesystem, changing its flags\n" \
2834 " ro/rw Mount for read-only / read-write\n" \
2835 "\n" \
2836 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002837 "You'll have to see the written documentation for those filesystems" \
2838
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002839#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002840 "$ mount\n" \
2841 "/dev/hda3 on / type minix (rw)\n" \
2842 "proc on /proc type proc (rw)\n" \
2843 "devpts on /dev/pts type devpts (rw)\n" \
2844 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2845 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2846 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002847#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002848 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002849
Rob Landleyd00b3a52005-08-20 05:07:08 +00002850#define mountpoint_trivial_usage \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002851 "[-q] <[-dn] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002852#define mountpoint_full_usage "\n\n" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002853 "Check if the directory is a mountpoint\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002854 "\nOptions:" \
2855 "\n -q Quiet" \
2856 "\n -d Print major/minor device number of the filesystem" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002857 "\n -n Print device name of the filesystem" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002858 "\n -x Print major/minor device number of the blockdevice" \
2859
Rob Landleyd00b3a52005-08-20 05:07:08 +00002860#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002861 "$ mountpoint /proc\n" \
2862 "/proc is not a mountpoint\n" \
2863 "$ mountpoint /sys\n" \
2864 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002865
Eric Andersen7e9276b2001-02-22 01:15:47 +00002866#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002867 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002868#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002869 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002870 "\n" \
2871 "Available Opcodes:\n" \
2872 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002873 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2874 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2875 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002876 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002877
Eric Andersen7e9276b2001-02-22 01:15:47 +00002878#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002879 "[OPTION]... SOURCE DEST\n" \
2880 "or: mv [OPTION]... SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002881#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002882 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
2883 "\nOptions:" \
2884 "\n -f Don't prompt before overwriting" \
2885 "\n -i Interactive, prompt before overwrite" \
2886
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002887#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002888 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002889
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002890#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002891 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002892#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002893 "Rename network interface while it in the down state\n" \
2894 "\nOptions:" \
2895 "\n -c FILE Use configuration file (default is /etc/mactab)" \
2896 "\n -s Use syslog (LOCAL0 facility)" \
2897 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
2898
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002899#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002900 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2901 " or\n" \
2902 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002903
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002904#if !ENABLE_DESKTOP
2905
Rob Landley1cca9482006-07-10 19:45:20 +00002906#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002907#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002908#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002909#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002910#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002911
Eric Andersen7e9276b2001-02-22 01:15:47 +00002912#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002913 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002914 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002915#define nc_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002916 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002917 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002918 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002919 "\n -e Exec rest of command line after connect" \
2920 "\n -i SECS Delay interval for lines sent" \
2921 "\n -w SECS Timeout for connect" \
2922 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002923 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002924 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002925 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002926 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002927 "\n (use -l twice with -e for persistent server)") \
2928 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002929 )
2930
Rob Landley1cca9482006-07-10 19:45:20 +00002931#define nc_notes_usage "" \
2932 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002933 "To use netcat as a terminal emulator on a serial port:\n\n" \
2934 "$ stty 115200 -F /dev/ttyS0\n" \
2935 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2936 )
Rob Landley1cca9482006-07-10 19:45:20 +00002937
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002938#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002939 "$ nc foobar.somedomain.com 25\n" \
2940 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2941 "help\n" \
2942 "214-Commands supported:\n" \
2943 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2944 "214 NOOP QUIT RSET HELP\n" \
2945 "quit\n" \
2946 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002947
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002948#else /* DESKTOP nc - much more compatible with nc 1.10 */
2949
2950#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002951 "[-options] hostname port - connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002952 USE_NC_SERVER("\n" \
2953 "nc [-options] -l -p port [hostname] [port] - listen")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002954#define nc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002955 "Options:" \
2956 "\n -e prog [args] Program to exec after connect (must be last)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002957 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002958 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002959 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002960 "\n -n Don't do DNS resolution" \
2961 "\n -s addr Local address" \
2962 "\n -p port Local port" \
2963 "\n -u UDP mode" \
2964 "\n -v Verbose (cumulative: -vv)" \
2965 "\n -w secs Timeout for connects and final net reads" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002966 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002967 "\n -i sec Delay interval for lines sent" /* ", ports scanned" */ \
2968 "\n -o file Hex dump of traffic" \
2969 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002970 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002971/* "\n -r Randomize local and remote ports" */
2972/* "\n -g gateway Source-routing hop point[s], up to 8" */
2973/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002974/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2975
2976#endif
2977
Eric Andersen1552ff72001-10-31 11:07:12 +00002978#define netstat_trivial_usage \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00002979 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")USE_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002980#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002981 "Display networking information\n" \
2982 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002983 "\n -l Display listening server sockets" \
2984 "\n -a Display all sockets (default: connected)" \
2985 "\n -e Display other/more information" \
2986 "\n -n Don't resolve names" \
2987 "\n -t Tcp sockets" \
2988 "\n -u Udp sockets" \
2989 "\n -w Raw sockets" \
2990 "\n -x Unix sockets" \
2991 "\n -r Display routing table" \
2992 USE_FEATURE_NETSTAT_WIDE( \
2993 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00002994 ) \
2995 USE_FEATURE_NETSTAT_PRG( \
2996 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002997 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002998
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002999#define nice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003000 "[-n ADJUST] [COMMAND [ARG]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003001#define nice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003002 "Run a program with modified scheduling priority\n" \
3003 "\nOptions:" \
3004 "\n -n ADJUST Adjust the scheduling priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003005
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003006#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003007 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003008#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003009 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003010 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003011 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003012 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003013 "%[niface] Monitor network interface 'iface'\n" \
3014 "%m Monitor allocated memory\n" \
3015 "%[mf] Monitor free memory\n" \
3016 "%[mt] Monitor total memory\n" \
3017 "%s Monitor allocated swap\n" \
3018 "%f Monitor number of used file descriptors\n" \
3019 "%Ni Monitor total/specific IRQ rate\n" \
3020 "%x Monitor context switch rate\n" \
3021 "%p Monitor forks\n" \
3022 "%[pn] Monitor # of processes\n" \
3023 "%b Monitor block io\n" \
3024 "%Nt Show time (with N decimal points)\n" \
3025 "%Nd Milliseconds between updates (default=1000)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003026 "%r Print <cr> instead of <lf> at EOL" \
3027
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003028#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003029 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003030
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003031#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003032 "COMMAND [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003033#define nohup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003034 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003035#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003036 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003037
Eric Andersen7e9276b2001-02-22 01:15:47 +00003038#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003039 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003040#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003041 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003042 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003043#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003044 "$ nslookup localhost\n" \
3045 "Server: default\n" \
3046 "Address: default\n" \
3047 "\n" \
3048 "Name: debian\n" \
3049 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003050
Glenn L McGrath60281112001-11-02 11:39:46 +00003051#define od_trivial_usage \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00003052 "[-aBbcDdeFfHhIiLlOovXx] " USE_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003053#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003054 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00003055 "to standard output. With no FILE or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00003056
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003057#define openvt_trivial_usage \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003058 "[-c NUM] [-sw] [COMMAND [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003059#define openvt_full_usage "\n\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003060 "Start COMMAND on a new virtual terminal\n" \
3061 "\nOptions:" \
3062 "\n -c Use specified VT" \
3063 "\n -s Switch to the VT" \
3064/* "\n -l Run COMMAND as login shell (by prepending '-')" */ \
3065 "\n -w Wait for COMMAND to exit" \
3066
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003067#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003068 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003069
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003070#define parse_trivial_usage \
3071 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
3072#define parse_full_usage "\n\n" \
3073 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
3074
Eric Andersen27f64e12002-06-23 04:24:25 +00003075#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003076 "[OPTION] [name]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003077#define passwd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003078 "Change user's password. If no name is specified,\n" \
3079 "changes the password for the current user.\n" \
3080 "\nOptions:" \
3081 "\n -a Algorithm to use for password (choices: des, md5)" /* ", sha1)" */ \
3082 "\n -d Delete password for the account" \
3083 "\n -l Lock (disable) account" \
3084 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003085
Denis Vlasenko21d10142007-07-20 21:28:41 +00003086#define chpasswd_trivial_usage \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003087 USE_GETOPT_LONG("[--md5|--encrypted]") SKIP_GETOPT_LONG("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003088#define chpasswd_full_usage "\n\n" \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003089 "Read user:password information from stdin " \
Denis Vlasenko397de612008-03-17 08:55:44 +00003090 "and update /etc/passwd accordingly.\n" \
3091 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003092 USE_GETOPT_LONG( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003093 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003094 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003095 ) \
3096 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003097 "\n -e Supplied passwords are in encrypted form" \
3098 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003099 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00003100
Glenn L McGrath655d8142003-06-22 15:32:41 +00003101#define patch_trivial_usage \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003102 "[-p NUM] [-i DIFF] [-R]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003103#define patch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003104 " -p NUM Strip NUM leading components from file names" \
3105 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003106 "\n -R Reverse patch" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003107
Glenn L McGrath655d8142003-06-22 15:32:41 +00003108#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003109 "$ patch -p1 < example.diff\n" \
3110 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00003111
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003112#define pgrep_trivial_usage \
3113 "[-flnovx] pattern"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003114#define pgrep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003115 "Display process(es) selected by regex pattern\n" \
3116 "\nOptions:" \
3117 "\n -l Show command name too" \
3118 "\n -f Match against entire command line" \
3119 "\n -n Show the newest process only" \
3120 "\n -o Show the oldest process only" \
3121 "\n -v Negate the matching" \
3122 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003123
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003124#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00003125#define pidof_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003126 "[OPTION] [NAME...]"
3127#define USAGE_PIDOF "\n\nOptions:"
3128#else
3129#define pidof_trivial_usage \
3130 "[NAME...]"
3131#define USAGE_PIDOF /* none */
3132#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003133#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003134 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003135 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003136 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003137 "\n -s Show only one PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003138 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003139 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003140 "\n Use %PPID to omit pid of pidof's parent") \
3141
Eric Andersen221b2ea2001-07-31 19:06:07 +00003142#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003143 "$ pidof init\n" \
3144 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003145 USE_FEATURE_PIDOF_OMIT( \
3146 "$ pidof /bin/sh\n20351 5973 5950\n") \
3147 USE_FEATURE_PIDOF_OMIT( \
3148 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00003149
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003150#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003151#define ping_trivial_usage \
3152 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003153#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003154 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003155#define ping6_trivial_usage \
3156 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003157#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003158 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003159#else
3160#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003161 "[OPTION]... host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003162#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003163 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3164 "\nOptions:" \
3165 "\n -4, -6 Force IPv4 or IPv6 hostname resolution" \
3166 "\n -c CNT Send only CNT pings" \
3167 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
3168 "\n -I iface/IP Use interface or IP address as source" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003169 "\n -W timeout Seconds to wait for the first response (default:10)" \
3170 "\n (after all -c CNT packets are sent)" \
3171 "\n -w deadline Seconds until ping exits (default:infinite)" \
3172 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003173 "\n -q Quiet, only displays output at start" \
3174 "\n and when finished" \
3175
Eric Andersen51b8bd62002-07-03 11:46:38 +00003176#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003177 "[OPTION]... host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003178#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003179 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3180 "\nOptions:" \
3181 "\n -c CNT Send only CNT pings" \
3182 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
3183 "\n -I iface/IP Use interface or IP address as source" \
3184 "\n -q Quiet, only displays output at start" \
3185 "\n and when finished" \
3186
Eric Andersen51b8bd62002-07-03 11:46:38 +00003187#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003188#define ping_example_usage \
3189 "$ ping localhost\n" \
3190 "PING slag (127.0.0.1): 56 data bytes\n" \
3191 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3192 "\n" \
3193 "--- debian ping statistics ---\n" \
3194 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3195 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003196#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003197 "$ ping6 ip6-localhost\n" \
3198 "PING ip6-localhost (::1): 56 data bytes\n" \
3199 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3200 "\n" \
3201 "--- ip6-localhost ping statistics ---\n" \
3202 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3203 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003204
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003205#define pipe_progress_trivial_usage NOUSAGE_STR
3206#define pipe_progress_full_usage ""
3207
Eric Andersen7e9276b2001-02-22 01:15:47 +00003208#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003209 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003210#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003211 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003212 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003213
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003214#define pkill_trivial_usage \
3215 "[-l] | [-fnovx] [-signal] pattern"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003216#define pkill_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003217 "Send a signal to process(es) selected by regex pattern\n" \
3218 "\nOptions:" \
3219 "\n -l List all signals" \
3220 "\n -f Match against entire command line" \
3221 "\n -n Signal the newest process only" \
3222 "\n -o Signal the oldest process only" \
3223 "\n -v Negate the matching" \
3224 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003225
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003226#define popmaildir_trivial_usage \
3227 "[OPTIONS] Maildir [connection-helper ...]"
3228#define popmaildir_full_usage "\n\n" \
3229 "Fetch content of remote mailbox to local maildir\n" \
3230 "\nOptions:" \
3231 "\n -b Binary mode. Ignored" \
3232 "\n -d Debug. Ignored" \
3233 "\n -m Show used memory. Ignored" \
3234 "\n -V Show version. Ignored" \
3235 "\n -c Use tcpclient. Ignored" \
3236 "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" \
3237 "\n -s Skip authorization" \
3238 "\n -T Get messages with TOP instead with RETR" \
3239 "\n -k Keep retrieved messages on the server" \
3240 "\n -t timeout Set network timeout" \
3241 USE_FEATURE_POPMAILDIR_DELIVERY( \
3242 "\n -F \"program arg1 arg2 ...\" Filter by program. May be multiple" \
3243 "\n -M \"program arg1 arg2 ...\" Deliver by program" \
3244 ) \
3245 "\n -R size Remove old messages on the server >= size (in bytes). Ignored" \
3246 "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" \
3247 "\n -L size Do not retrieve new messages >= size (in bytes). Ignored" \
3248 "\n -H lines Type specified number of lines of a message. Ignored"
3249#define popmaildir_example_usage \
3250 "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n" \
3251 "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
3252
Eric Andersen7e9276b2001-02-22 01:15:47 +00003253#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003254 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003255#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003256 "Halt and shut off power\n" \
3257 "\nOptions:" \
3258 "\n -d Delay interval for halting" \
3259 "\n -n No call to sync()" \
3260 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003261
Mike Frysinger95d3c452005-04-21 23:29:24 +00003262#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003263 "[VARIABLES...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003264#define printenv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003265 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003266 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003267
Eric Andersen7e9276b2001-02-22 01:15:47 +00003268#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003269 "FORMAT [ARGUMENT...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003270#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003271 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003272 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003273#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003274 "$ printf \"Val=%d\\n\" 5\n" \
3275 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003276
Denis Vlasenko94949192006-11-05 00:45:47 +00003277
3278#if ENABLE_DESKTOP
3279
3280#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003281 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003282#define ps_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003283 "Report process status\n" \
3284 "\nOptions:" \
3285 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00003286
3287#else /* !ENABLE_DESKTOP */
3288
Denis Vlasenko397de612008-03-17 08:55:44 +00003289#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003290#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003291#else
3292#define USAGE_PS "\nOptions:"
3293#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003294
Eric Andersen7e9276b2001-02-22 01:15:47 +00003295#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003296 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003297#define ps_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003298 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003299 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003300 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003301 "\n -Z Show SE Linux context" \
3302 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003303 USE_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003304 "\n w Wide output" \
3305 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003306
Denis Vlasenko94949192006-11-05 00:45:47 +00003307#endif /* ENABLE_DESKTOP */
3308
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003309#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003310 "$ ps\n" \
3311 " PID Uid Gid State Command\n" \
3312 " 1 root root S init\n" \
3313 " 2 root root S [kflushd]\n" \
3314 " 3 root root S [kupdate]\n" \
3315 " 4 root root S [kpiod]\n" \
3316 " 5 root root S [kswapd]\n" \
3317 " 742 andersen andersen S [bash]\n" \
3318 " 743 andersen andersen S -bash\n" \
3319 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003320 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003321
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003322#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003323 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003324#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003325 "Scan a host, print all open ports\n" \
3326 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003327 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003328 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003329 "\n -p Scan from this port (default 1)" \
3330 "\n -P Scan up to this port (default 1024)" \
3331 "\n -t Timeout (default 5000 ms)" \
3332 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3333
Eric Andersen7e9276b2001-02-22 01:15:47 +00003334#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003335 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003336#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003337 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003338#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003339 "$ pwd\n" \
3340 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003341
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003342#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003343 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003344#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003345 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003346#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003347 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003348
Eric Andersen7e9276b2001-02-22 01:15:47 +00003349#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003350 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003351#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003352 "Get and possibly set the system date and time from a remote HOST\n" \
3353 "\nOptions:" \
3354 "\n -s Set the system date and time (default)" \
3355 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003356
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00003357#define rdev_trivial_usage \
3358 ""
3359#define rdev_full_usage "\n\n" \
3360 "Print the device node associated with the filesystem mounted at '/'"
3361#define rdev_example_usage \
3362 "$ rdev\n" \
3363 "/dev/mtdblock9 /\n"
3364
Rob Landley0e4690d2006-08-20 22:12:18 +00003365#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003366 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003367#define readahead_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003368 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
3369 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00003370
Eric Andersen7e9276b2001-02-22 01:15:47 +00003371#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003372 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003373#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003374 "Display the value of a symlink" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003375 USE_FEATURE_READLINK_FOLLOW( "\n" \
3376 "\nOptions:" \
3377 "\n -f Canonicalize by following all symlinks") \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003378
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003379#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003380 "[OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003381#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003382 "Options:" \
3383 "\n -m mapfile (Default: /boot/System.map)" \
3384 "\n -p profile (Default: /proc/profile)" \
3385 "\n -M mult Set the profiling multiplier to mult" \
3386 "\n -i Print only info about the sampling step" \
3387 "\n -v Verbose" \
3388 "\n -a Print all symbols, even if count is 0" \
3389 "\n -b Print individual histogram-bin counts" \
3390 "\n -s Print individual counters within functions" \
3391 "\n -r Reset all the counters (root only)" \
3392 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003393
Glenn L McGrath62fae302002-12-10 00:14:33 +00003394#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003395 "pathname..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003396#define realpath_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003397 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00003398
Eric Andersen7e9276b2001-02-22 01:15:47 +00003399#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003400 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003401#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003402 "Reboot the system\n" \
3403 "\nOptions:" \
3404 "\n -d Delay interval for rebooting" \
3405 "\n -n No call to sync()" \
3406 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003407
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003408#define reformime_trivial_usage \
3409 "[OPTION]... [FILE]..."
3410#define reformime_full_usage "\n\n" \
3411 "Parse MIME-encoded message\n" \
3412 "\nOptions:" \
3413 "\n -x prefix Extract content of MIME sections to files" \
3414 "\n -X prog [args] Filter content of MIME sections through prog." \
3415 "\n Must be the last option" \
3416 "\n" \
3417 "\nOther options are silently ignored." \
3418
Eric Andersen7e9276b2001-02-22 01:15:47 +00003419#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003420 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003421#define renice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003422 "Change priority of running processes\n" \
3423 "\nOptions:" \
3424 "\n -n Adjust current nice value (smaller is faster)" \
3425 "\n -p Process id(s) (default)" \
3426 "\n -g Process group id(s)" \
3427 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003428
Eric Andersen7e9276b2001-02-22 01:15:47 +00003429#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003430 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003431#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003432 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003433
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003434#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003435 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003436#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003437 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003438
Denis Vlasenko397137b2007-07-23 14:03:30 +00003439#define restorecon_trivial_usage \
3440 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003441#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003442 "Reset security contexts of files in pathname\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003443 "\n -i Ignore files that do not exist" \
3444 "\n -f file File with list of files to process. Use - for stdin" \
3445 "\n -e directory Directory to exclude" \
3446 "\n -R,-r Recurse directories" \
3447 "\n -n Don't change any file labels" \
3448 "\n -o file Save list of files with incorrect context" \
3449 "\n -v Verbose" \
3450 "\n -vv Show changed labels" \
3451 "\n -F Force reset of context to match file_context" \
3452 "\n for customizable files, or the user section," \
3453 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003454
Eric Andersen7e9276b2001-02-22 01:15:47 +00003455#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003456 "[OPTION]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003457#define rm_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003458 "Remove (unlink) the FILE(s). Use '--' to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003459 "indicate that all following arguments are non-options.\n" \
3460 "\nOptions:" \
3461 "\n -i Always prompt before removing" \
3462 "\n -f Never prompt" \
3463 "\n -r,-R Remove directories recursively" \
3464
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003465#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003466 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003467
Eric Andersen7e9276b2001-02-22 01:15:47 +00003468#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003469 "[OPTION]... DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003470#define rmdir_full_usage "\n\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003471 "Remove the DIRECTORY, if it is empty.\n" \
3472 "\nOptions:" \
3473 USE_FEATURE_RMDIR_LONG_OPTIONS( \
3474 "\n -p|--parents Include parents" \
3475 "\n -ignore-fail-on-non-empty" \
3476 ) \
3477 SKIP_FEATURE_RMDIR_LONG_OPTIONS( \
3478 "\n -p Include parents" \
3479 )
3480
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003481#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003482 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003483
Eric Andersen7e9276b2001-02-22 01:15:47 +00003484#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003485 "[OPTION]... [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003486#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003487 "Unload the specified kernel modules from the kernel\n" \
3488 "\nOptions:" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003489 "\n -w Wait until the module is no longer used" \
3490 "\n -f Force unloading" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003491 "\n -a Remove all unused modules (recursively)" \
3492
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003493#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003494 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003495
Eric Andersen7e9276b2001-02-22 01:15:47 +00003496#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003497 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003498#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003499 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003500 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003501 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003502 "\n -e Display other/more information" \
3503 "\n -A inet" USE_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003504
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003505#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003506 "-i -q[ildc]p package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003507#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003508 "Manipulate RPM packages\n" \
3509 "\nOptions:" \
3510 "\n -i Install package" \
3511 "\n -q Query package" \
3512 "\n -p Query uninstalled package" \
3513 "\n -i Show information" \
3514 "\n -l List contents" \
3515 "\n -d List documents" \
3516 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003517
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003518#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003519 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003520#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003521 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003522
Mike Frysinger6b160e42008-02-15 02:27:19 +00003523#define rtcwake_trivial_usage \
3524 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SECS | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003525#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003526 "Enter a system sleep state until specified wakeup time\n" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003527 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003528 "\n -a,--auto Read clock mode from adjtime" \
3529 "\n -l,--local Clock is set to local time" \
3530 "\n -u,--utc Clock is set to UTC time" \
3531 "\n -d,--device=DEV Specify the RTC device" \
Mike Frysinger1e93f3c2008-06-04 10:33:33 +00003532 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003533 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
3534 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003535 ) \
3536 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003537 "\n -a Read clock mode from adjtime" \
3538 "\n -l Clock is set to local time" \
3539 "\n -u Clock is set to UTC time" \
3540 "\n -d DEV Specify the RTC device" \
3541 "\n -m MODE Set the sleep state (default: standby)" \
3542 "\n -s SEC Set the timeout in SEC seconds from now" \
3543 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003544 )
3545
Denis Vlasenko49622d72007-03-10 16:58:49 +00003546#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003547 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3548 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003549#define runcon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003550 "Run a program in a different security context\n" \
3551 "\n CONTEXT Complete security context\n" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003552 USE_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003553 "\n -c,--compute Compute process transition context before modifying" \
3554 "\n -t,--type=TYPE Type (for same role as parent)" \
3555 "\n -u,--user=USER User identity" \
3556 "\n -r,--role=ROLE Role" \
3557 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003558 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003559 SKIP_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003560 "\n -c Compute process transition context before modifying" \
3561 "\n -t TYPE Type (for same role as parent)" \
3562 "\n -u USER User identity" \
3563 "\n -r ROLE Role" \
3564 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003565 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003566
Eric Andersen6cf47a72001-10-31 10:24:36 +00003567#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003568 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003569#define run_parts_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003570 "Run a bunch of scripts in a directory\n" \
3571 "\nOptions:" \
3572 "\n -t Print what would be run, but don't actually run anything" \
3573 "\n -a ARG Pass ARG as argument for every program" \
3574 "\n -u MASK Set the umask to MASK before running every program" \
3575 USE_FEATURE_RUN_PARTS_FANCY( \
3576 "\n -l Print names of all matching files even if they are not executable" \
3577 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003578
3579#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003580 "$ run-parts -a start /etc/init.d\n" \
3581 "$ run-parts -a stop=now /etc/init.d\n\n" \
3582 "Let's assume you have a script foo/dosomething:\n" \
3583 "#!/bin/sh\n" \
3584 "for i in $*; do eval $i; done; unset i\n" \
3585 "case \"$1\" in\n" \
3586 "start*) echo starting something;;\n" \
3587 "stop*) set -x; shutdown -h $stop;;\n" \
3588 "esac\n\n" \
3589 "Running this yields:\n" \
3590 "$run-parts -a stop=+4m foo/\n" \
3591 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003592
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003593#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003594 "[utmp]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003595#define runlevel_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003596 "Find the current and previous system runlevel.\n\n" \
3597 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003598 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003599#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003600 "$ runlevel /var/run/utmp\n" \
3601 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003602
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003603#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003604 "dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003605#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003606 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003607
3608#define runsvdir_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003609 "[-P] [-s SCRIPT] dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003610#define runsvdir_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003611 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
3612 "\n -P Put each runsv in a new session" \
3613 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003614
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003615#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003616 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003617#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003618 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003619#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003620 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003621
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003622#define script_trivial_usage \
3623 "[-afq] [-c COMMAND] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003624#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003625 "Options:" \
3626 "\n -a Append output" \
3627 "\n -c Run COMMAND, not shell" \
3628 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003629 "\n -q Quiet" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003630
Eric Andersen7e9276b2001-02-22 01:15:47 +00003631#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003632 "[-efinr] pattern [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003633#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003634 "Options:" \
3635 "\n -e script Add the script to the commands to be executed" \
3636 "\n -f scriptfile Add scriptfile contents to the" \
3637 "\n commands to be executed" \
3638 "\n -i Edit files in-place" \
3639 "\n -n Suppress automatic printing of pattern space" \
3640 "\n -r Use extended regular expression syntax" \
3641 "\n" \
3642 "\nIf no -e or -f is given, the first non-option argument is taken as the sed" \
3643 "\nscript to interpret. All remaining arguments are names of input files; if no" \
3644 "\ninput files are specified, then the standard input is read. Source files" \
3645 "\nwill not be modified unless -i option is given." \
Eric Andersenf802ff72004-04-12 15:12:06 +00003646
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003647#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003648 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3649 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003650
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003651#define selinuxenabled_trivial_usage NOUSAGE_STR
3652#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003653
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003654#define sendmail_trivial_usage \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003655 "[OPTIONS] [rcpt]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003656#define sendmail_full_usage "\n\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003657 "Send an email\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003658 "\nOptions:" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003659 "\n -w timeout Network timeout" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003660 "\n -N type Request delivery notification. Type is ignored" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003661 "\n -f sender Sender" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003662 "\n -F fullname Sender full name. Overrides $NAME" \
3663 USE_FEATURE_SENDMAIL_MAILX( \
3664 "\n -s subject Subject" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003665 "\n -j charset Assume charset for body and subject (" CONFIG_FEATURE_MIME_CHARSET ")" \
Denis Vlasenko7e0c2432009-03-02 16:12:00 +00003666 "\n -a file File to attach. May be repeated" \
3667 "\n -H 'prog args' Run connection helper. E.g. openssl for encryption:" \
3668 "\n -H 'exec openssl s_client -quiet -tls1 -starttls smtp" \
3669 "\n -connect smtp.gmail.com:25' <email.txt" \
Denis Vlasenko021de3f2009-03-04 17:56:00 +00003670 "\n [4<username_and_passwd.txt]" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003671 "\n -S server[:port] Server" \
3672 ) \
3673 USE_FEATURE_SENDMAIL_MAILXX( \
Denis Vlasenko7e0c2432009-03-02 16:12:00 +00003674 "\n -c rcpt Cc: recipient. May be repeated" \
Denis Vlasenko2b2d9772008-09-28 13:50:57 +00003675 "\n -e rcpt Errors-To: recipient" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003676 ) \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003677 "\n -t Read recipients and subject from body" \
3678 "\n" \
3679 "\nOther options are silently ignored; -oi is implied" \
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003680
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003681#define seq_trivial_usage \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003682 "[-w] [-s SEP] [FIRST [INC]] LAST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003683#define seq_full_usage "\n\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003684 "Print numbers from FIRST to LAST, in steps of INC.\n" \
3685 "FIRST, INC default to 1\n" \
3686 "\nOptions:" \
3687 "\n -w Pad to last with leading zeros" \
3688 "\n -s SEP String separator" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003689
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003690#define sestatus_trivial_usage \
3691 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003692#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003693 " -v Verbose" \
3694 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003695
Paul Foxfc2256a2005-08-01 18:12:30 +00003696#define setconsole_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003697 "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003698#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003699 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3700 "\nOptions:" \
3701 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003702
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003703#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003704 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003705#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003706
Denis Vlasenko397137b2007-07-23 14:03:30 +00003707#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003708 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003709 USE_FEATURE_SETFILES_CHECK_OPTION( \
3710 " [-c policyfile] spec_file" \
3711 ) \
3712 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003713#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003714 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003715 USE_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003716 "\n -c file Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003717 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003718 "\n -d Show which specification matched each file" \
3719 "\n -l Log changes in file labels to syslog" \
3720 "\n -n Don't change any file labels" \
3721 "\n -q Suppress warnings" \
3722 "\n -r dir Use an altenate root path" \
3723 "\n -e dir Exclude directory" \
3724 "\n -F Force reset of context to match file_context for customizable files" \
3725 "\n -o file Save list of files with incorrect context" \
3726 "\n -s Take a list of files from standard input (instead of command line)" \
3727 "\n -v Show changes in file labels, if type or role are changing" \
3728 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3729 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003730
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003731#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003732 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003733#define setfont_full_usage "\n\n" \
3734 "Load a console font\n" \
3735 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003736 "\n -m MAPFILE Load console screen map" \
3737 "\n -C TTY Affect TTY instead of /dev/tty" \
3738
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003739#define setfont_example_usage \
3740 "$ setfont -m koi8-r /etc/i18n/fontname\n"
3741
Eric Andersen7e9276b2001-02-22 01:15:47 +00003742#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003743 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003744#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003745 "Set entries into the kernel's scancode-to-keycode map,\n" \
3746 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3747 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003748 "and KEYCODE is given in decimal" \
3749
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003750#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003751 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003752
Rob Landley87848d92006-03-27 23:23:43 +00003753#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003754 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003755#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003756 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003757
Denis Vlasenkobe039372007-10-14 04:48:44 +00003758#define setsebool_trivial_usage \
3759 "boolean value"
3760
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003761#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00003762 "Change boolean setting"
3763
Paul Fox42403642005-08-01 22:52:09 +00003764#define setsid_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003765 "PROG [ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003766#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003767 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3768 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3769 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003770
Matt Kraai2d91deb2001-08-01 17:21:35 +00003771#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003772 "[FILE]...\n" \
3773 "or: sh -c command [args]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003774#define lash_full_usage "\n\n" \
Denis Vlasenko96702ca2007-11-23 23:28:55 +00003775 "lash is deprecated, please use hush"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003776
Eric Andersen2e9c2572003-08-08 22:26:06 +00003777#define last_trivial_usage \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003778 ""USE_FEATURE_LAST_FANCY("[-HW] [-f file]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003779#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003780 "Show listing of the last users that logged into the system" \
3781 USE_FEATURE_LAST_FANCY( "\n" \
3782 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00003783/* "\n -H Show header line" */ \
3784 "\n -W Display with no host column truncation" \
3785 "\n -f file Read from file instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003786 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00003787
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00003788#define showkey_trivial_usage \
3789 "[-a | -k | -s]"
3790#define showkey_full_usage "\n\n" \
3791 "Show keys pressed\n" \
3792 "\nOptions:" \
3793 "\n -a Display decimal/octal/hex values of the keys" \
3794 "\n -k Display interpreted keycodes (default)" \
3795 "\n -s Display raw scan-codes" \
3796
Denis Vlasenko14923db2007-06-20 15:23:03 +00003797#define slattach_trivial_usage \
3798 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003799#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003800 "Attach network interface(s) to serial line(s)\n" \
3801 "\nOptions:" \
3802 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3803 "\n -s Set line speed" \
3804 "\n -e Exit after initializing device" \
3805 "\n -h Exit when the carrier is lost" \
3806 "\n -c Execute a command when the line is hung up" \
3807 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3808 "\n -L Enable 3-wire operation" \
3809 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003810
Eric Andersen7e9276b2001-02-22 01:15:47 +00003811#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003812 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003813#define sleep_full_usage "\n\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003814 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003815 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003816 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003817 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003818#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003819 "$ sleep 2\n" \
3820 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003821 USE_FEATURE_FANCY_SLEEP( \
3822 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003823 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003824
Eric Andersen7e9276b2001-02-22 01:15:47 +00003825#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003826 "[-nru" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003827 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003828 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003829#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003830 "Sort lines of text\n" \
3831 "\nOptions:" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003832 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003833 "\n -b Ignore leading blanks" \
3834 "\n -c Check whether input is sorted" \
3835 "\n -d Dictionary order (blank or alphanumeric only)" \
3836 "\n -f Ignore case" \
3837 "\n -g General numerical sort" \
3838 "\n -i Ignore unprintable characters" \
3839 "\n -k Sort key" \
3840 "\n -M Sort month" \
3841 ) \
3842 "\n -n Sort numbers" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003843 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003844 "\n -o Output to file" \
3845 "\n -k Sort by key" \
3846 "\n -t CHAR Key separator" \
3847 ) \
3848 "\n -r Reverse sort order" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003849 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003850 "\n -s Stable (don't sort ties alphabetically)" \
3851 ) \
3852 "\n -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003853 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003854 "\n -z Lines are terminated by NUL, not newline" \
3855 "\n -mST Ignored for GNU compatibility") \
3856
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003857#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003858 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3859 "a\n" \
3860 "b\n" \
3861 "c\n" \
3862 "d\n" \
3863 "e\n" \
3864 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003865 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003866 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3867 "d 2\n" \
3868 "b 2\n" \
3869 "c 3\n" \
3870 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003871 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003872
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003873#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003874 "[OPTION] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003875#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003876 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003877 "\n -b n[k|m] Split by bytes" \
3878 "\n -l n Split by lines" \
3879 "\n -a n Use n letters as suffix" \
3880
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003881#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003882 "$ split TODO foo\n" \
3883 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003884
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003885#define start_stop_daemon_trivial_usage \
Denis Vlasenko7987a182008-07-01 10:00:46 +00003886 "[OPTIONS] [-S|-K] ... [-- arguments...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003887#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003888 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003889 "-K: stop all matching processes.\n" \
3890 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003891 USE_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003892 "\nProcess matching:" \
3893 "\n -u,--user USERNAME|UID Match only this user's processes" \
3894 "\n -n,--name NAME Match processes with NAME" \
3895 "\n in comm field in /proc/PID/stat" \
3896 "\n -x,--exec EXECUTABLE Match processes with this command" \
3897 "\n in /proc/PID/cmdline" \
3898 "\n -p,--pidfile FILE Match a process with PID from the file" \
3899 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003900 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003901 "\n -x,--exec EXECUTABLE Program to run" \
3902 "\n -a,--startas NAME Zeroth argument" \
3903 "\n -b,--background Background" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003904 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003905 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003906 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003907 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
3908 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003909 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003910 "\n -s,--signal SIG Signal to send" \
3911 "\n -t,--test Match only, exit with 0 if a process is found" \
3912 "\nOther:" \
3913 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3914 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003915 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003916 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003917 "\n -q,--quiet Quiet" \
3918 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003919 SKIP_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003920 "\nProcess matching:" \
3921 "\n -u USERNAME|UID Match only this user's processes" \
3922 "\n -n NAME Match processes with NAME" \
3923 "\n in comm field in /proc/PID/stat" \
3924 "\n -x EXECUTABLE Match processes with this command" \
3925 "\n command in /proc/PID/cmdline" \
3926 "\n -p FILE Match a process with PID from the file" \
3927 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003928 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003929 "\n -x EXECUTABLE Program to run" \
3930 "\n -a NAME Zeroth argument" \
3931 "\n -b Background" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003932 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003933 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003934 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003935 "\n -c USER[:[GRP]] Change to user/group" \
3936 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003937 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003938 "\n -s SIG Signal to send" \
3939 "\n -t Match only, exit with 0 if a process is found" \
3940 "\nOther:" \
3941 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3942 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003943 "\n -v Verbose" \
3944 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003945 "\n -q Quiet" \
3946 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003947
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003948#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003949 "[OPTION] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003950#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003951 "Display file (default) or filesystem status\n" \
3952 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003953 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003954 "\n -c fmt Use the specified format" \
3955 ) \
3956 "\n -f Display filesystem status" \
3957 "\n -L Dereference links" \
3958 "\n -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003959 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003960 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003961 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003962 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003963 "\n\nValid format sequences for files:\n" \
3964 " %a Access rights in octal\n" \
3965 " %A Access rights in human readable form\n" \
3966 " %b Number of blocks allocated (see %B)\n" \
3967 " %B The size in bytes of each block reported by %b\n" \
3968 " %d Device number in decimal\n" \
3969 " %D Device number in hex\n" \
3970 " %f Raw mode in hex\n" \
3971 " %F File type\n" \
3972 " %g Group ID of owner\n" \
3973 " %G Group name of owner\n" \
3974 " %h Number of hard links\n" \
3975 " %i Inode number\n" \
3976 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003977 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003978 " %o I/O block size\n" \
3979 " %s Total size, in bytes\n" \
3980 " %t Major device type in hex\n" \
3981 " %T Minor device type in hex\n" \
3982 " %u User ID of owner\n" \
3983 " %U User name of owner\n" \
3984 " %x Time of last access\n" \
3985 " %X Time of last access as seconds since Epoch\n" \
3986 " %y Time of last modification\n" \
3987 " %Y Time of last modification as seconds since Epoch\n" \
3988 " %z Time of last change\n" \
3989 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003990 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003991 " %a Free blocks available to non-superuser\n" \
3992 " %b Total data blocks in file system\n" \
3993 " %c Total file nodes in file system\n" \
3994 " %d Free file nodes in file system\n" \
3995 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003996 USE_SELINUX( \
3997 " %C Security context in SELinux\n" \
3998 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003999 " %i File System ID in hex\n" \
4000 " %l Maximum length of filenames\n" \
4001 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004002 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004003 " %S Fundamental block size (for block counts)\n" \
4004 " %t Type in hex\n" \
4005 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004006 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004007
Eric Andersenef5e8f82002-11-07 02:09:37 +00004008#define strings_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004009 "[-afo] [-n length] [file...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004010#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004011 "Display printable strings in a binary file\n" \
4012 "\nOptions:" \
4013 "\n -a Scan whole file (default)" \
4014 "\n -f Precede strings with filenames" \
4015 "\n -n N At least N characters form a string (default 4)" \
4016 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00004017
Eric Andersen7e9276b2001-02-22 01:15:47 +00004018#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004019 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004020#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004021 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004022 "and deviations from stty sane\n" \
4023 "\nOptions:" \
4024 "\n -F DEVICE Open device instead of stdin" \
4025 "\n -a Print all current settings in human-readable form" \
4026 "\n -g Print in stty-readable form" \
4027 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004028
Robert Griebl1fca5582002-06-04 20:45:46 +00004029#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004030 "[OPTION]... [-] [username]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004031#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004032 "Change user id or become root\n" \
4033 "\nOptions:" \
4034 "\n -p, -m Preserve environment" \
4035 "\n -c Command to pass to 'sh -c'" \
4036 "\n -s Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00004037
Eric Andersen27f64e12002-06-23 04:24:25 +00004038#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004039 "[OPTION]... [tty-device]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004040#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004041 "Single user login\n" \
4042 "\nOptions:" \
4043 "\n -t Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004044
Mike Frysinger95d3c452005-04-21 23:29:24 +00004045#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004046 "[rs] [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004047#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004048 "Checksum and count the blocks in a file\n" \
4049 "\nOptions:" \
4050 "\n -r Use BSD sum algorithm (1K blocks)" \
4051 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00004052
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004053#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004054 "[-v] [-w sec] command service..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004055#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004056 "Control services monitored by runsv supervisor.\n" \
4057 "Commands (only first character is enough):\n" \
4058 "\n" \
4059 "status: query service status\n" \
4060 "up: if service isn't running, start it. If service stops, restart it\n" \
4061 "once: like 'up', but if service stops, don't restart it\n" \
4062 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004063 " if it exists. After it stops, do not restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004064 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004065 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004066 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004067 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004068
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004069#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004070 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004071#define svlogd_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004072 "Continuously read log data from standard input, optionally " \
4073 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko397de612008-03-17 08:55:44 +00004074 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004075
Eric Andersen7e9276b2001-02-22 01:15:47 +00004076#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004077 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004078#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004079 "Stop swapping on DEVICE\n" \
4080 "\nOptions:" \
4081 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004082
Eric Andersen7e9276b2001-02-22 01:15:47 +00004083#define swapon_trivial_usage \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004084 "[-a]" USE_FEATURE_SWAPON_PRI(" [-p pri]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004085#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004086 "Start swapping on DEVICE\n" \
4087 "\nOptions:" \
4088 "\n -a Start swapping on all swap devices" \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004089 USE_FEATURE_SWAPON_PRI( \
4090 "\n -p pri Set swap device priority" \
4091 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004092
Rob Landley0f34a822005-10-27 22:55:50 +00004093#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004094 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004095#define switch_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004096 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004097 "and exec NEW_INIT\n" \
4098 "\nOptions:" \
4099 "\n -c Redirect console to device on new root" \
Rob Landley0f34a822005-10-27 22:55:50 +00004100
Eric Andersen7e9276b2001-02-22 01:15:47 +00004101#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004102 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004103#define sync_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004104 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004105
Eric Andersenb9050282003-12-24 06:02:11 +00004106#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004107 "[OPTIONS]... [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004108#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004109 "Configure kernel parameters at runtime\n" \
4110 "\nOptions:" \
4111 "\n -n Disable printing of key names" \
4112 "\n -e Don't warn about unknown keys" \
4113 "\n -w Change sysctl setting" \
4114 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
4115 "\n -a Display all values" \
4116 "\n -A Display all values in table form" \
4117
Eric Andersen5d38f5b2005-09-12 21:42:48 +00004118#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00004119 "sysctl [-n] [-e] variable...\n" \
4120 "sysctl [-n] [-e] -w variable=value...\n" \
4121 "sysctl [-n] [-e] -a\n" \
4122 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
4123 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00004124
Eric Andersen7e9276b2001-02-22 01:15:47 +00004125#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004126 "[OPTION]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004127#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004128 "System logging utility.\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004129 "Note that this version of syslogd ignores /etc/syslog.conf.\n" \
4130 "\nOptions:" \
4131 "\n -n Run in foreground" \
4132 "\n -O FILE Log to given file (default=/var/log/messages)" \
4133 "\n -l n Set local log level" \
4134 "\n -S Smaller logging output" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004135 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004136 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
4137 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004138 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004139 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
4140 "\n -L Log locally and via network (default is network only if -R)") \
4141 USE_FEATURE_SYSLOGD_DUP( \
4142 "\n -D Drop duplicates") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004143 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004144 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00004145 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004146/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00004147
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004148#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004149 "$ syslogd -R masterlog:514\n" \
4150 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004151
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004152#define tac_trivial_usage \
4153 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004154#define tac_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004155 "Concatenate FILE(s) and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004156
Eric Andersen7e9276b2001-02-22 01:15:47 +00004157#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004158 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004159#define tail_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004160 "Print last 10 lines of each FILE to standard output.\n" \
4161 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004162 "file name. With no FILE, or when FILE is -, read standard input.\n" \
4163 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004164 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004165 "\n -c N[kbm] Output the last N bytes") \
4166 "\n -n N[kbm] Print last N lines instead of last 10" \
4167 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004168 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004169 "\n -q Never output headers giving file names" \
4170 "\n -s SEC Wait SEC seconds between reads with -f" \
4171 "\n -v Always output headers giving file names" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004172 "\n" \
4173 "\nIf the first character of N (bytes or lines) is a '+', output begins with" \
4174 "\nthe Nth item from the start of each file, otherwise, print the last N items" \
4175 "\nin the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004176
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004177#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004178 "$ tail -n 1 /etc/resolv.conf\n" \
4179 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004180
Eric Andersen7e9276b2001-02-22 01:15:47 +00004181#define tar_trivial_usage \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004182 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_SEAMLESS_GZ("z") \
4183 USE_FEATURE_SEAMLESS_BZ2("j") USE_FEATURE_SEAMLESS_LZMA("a") \
4184 USE_FEATURE_SEAMLESS_Z("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00004185 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004186 "[-f TARFILE] [-C DIR] [FILE(s)]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004187#define tar_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004188 "Create, extract, or list files from a tar file\n" \
4189 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004190 USE_FEATURE_TAR_CREATE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004191 "\n c Create") \
4192 "\n x Extract" \
4193 "\n t List" \
4194 "\nArchive format selection:" \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004195 USE_FEATURE_SEAMLESS_GZ( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004196 "\n z Filter the archive through gzip" \
4197 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004198 USE_FEATURE_SEAMLESS_BZ2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004199 "\n j Filter the archive through bzip2" \
4200 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004201 USE_FEATURE_SEAMLESS_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004202 "\n a Filter the archive through lzma" \
4203 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004204 USE_FEATURE_SEAMLESS_Z( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004205 "\n Z Filter the archive through compress" \
4206 ) \
4207 "\nFile selection:" \
4208 "\n f Name of TARFILE or \"-\" for stdin" \
4209 "\n O Extract to stdout" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004210 USE_FEATURE_TAR_FROM( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004211 "\n exclude File to exclude" \
4212 "\n X File with names to exclude" \
4213 ) \
4214 "\n C Change to directory DIR before operation" \
4215 "\n v Verbose" \
4216
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004217#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004218 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
4219 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004220
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004221#define taskset_trivial_usage \
Denis Vlasenkob44c7902008-03-17 09:29:43 +00004222 "[-p] [mask] [pid | command [arg]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004223#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004224 "Set or get CPU affinity\n" \
4225 "\nOptions:" \
4226 "\n -p Operate on an existing PID" \
4227
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004228#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004229 "$ taskset 0x7 ./dgemm_test&\n" \
4230 "$ taskset -p 0x1 $!\n" \
4231 "pid 4790's current affinity mask: 7\n" \
4232 "pid 4790's new affinity mask: 1\n" \
4233 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4234 "pid 6671's current affinity mask: 1\n" \
4235 "pid 6671's new affinity mask: 1\n" \
4236 "$ taskset -p 1\n" \
4237 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004238
Eric Andersen7e9276b2001-02-22 01:15:47 +00004239#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004240 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004241#define tee_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004242 "Copy standard input to each FILE, and also to standard output\n" \
4243 "\nOptions:" \
4244 "\n -a Append to the given FILEs, do not overwrite" \
4245 "\n -i Ignore interrupt signals (SIGINT)" \
4246
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004247#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004248 "$ echo \"Hello\" | tee /tmp/foo\n" \
4249 "$ cat /tmp/foo\n" \
4250 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004251
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004252#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004253#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004254 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004255#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004256 "Connect to telnet server\n" \
4257 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004258 "\n -a Automatic login with $USER variable" \
4259 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004260
Eric Andersen539ffc92004-02-22 12:25:47 +00004261#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004262#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004263 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004264#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004265 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004266#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004267
Eric Andersen08a72202002-09-30 20:52:10 +00004268#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004269 "[OPTION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004270#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004271 "Handle incoming telnet connections" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004272 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
4273 "\nOptions:" \
4274 "\n -l LOGIN Exec LOGIN on connect" \
4275 "\n -f issue_file Display issue_file instead of /etc/issue" \
4276 "\n -K Close connection as soon as login exits" \
4277 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004278 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004279 "\n -p PORT Port to listen on" \
4280 "\n -b ADDR Address to bind to" \
4281 "\n -F Run in foreground" \
4282 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004283 )
Eric Andersen08a72202002-09-30 20:52:10 +00004284
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004285/* "test --help" does not print help (POSIX compat), only "[ --help" does.
4286 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION") */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004287#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004288 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004289#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004290 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4291 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004292#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004293 "$ test 1 -eq 2\n" \
4294 "$ echo $?\n" \
4295 "1\n" \
4296 "$ test 1 -eq 1\n" \
4297 "$ echo $?\n" \
4298 "0\n" \
4299 "$ [ -d /etc ]\n" \
4300 "$ echo $?\n" \
4301 "0\n" \
4302 "$ [ -d /junk ]\n" \
4303 "$ echo $?\n" \
4304 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004305
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004306#define tc_trivial_usage \
4307 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
4308#define tc_full_usage "\n\n" \
4309 "OBJECT: {qdisc|class|filter}\n" \
4310 "CMD: {add|del|change|replace|show}\n" \
4311 "\n" \
4312 "qdisc [ handle QHANDLE ] [ root |"USE_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
4313 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4314 "\t[ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4315 "\tQDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
4316 "qdisc show [ dev STRING ]"USE_FEATURE_TC_INGRESS(" [ingress]")"\n" \
4317 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
4318 "\t[ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4319 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
4320 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
4321 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4322 "\t[ root | classid CLASSID ] [ handle FILTERID ]\n" \
4323 "\t[ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
4324 "filter show [ dev STRING ] [ root | parent CLASSID ]"
4325
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004326#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004327 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004328/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004329/* "[-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 +00004330#define tcpsvd_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004331 "Create TCP socket, bind it to ip:port and listen\n" \
4332 "for incoming connection. Run PROG for each connection.\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004333 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004334 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004335 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004336 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4337 "\n-u user[:group] Change to user/group after bind" \
4338 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004339 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004340 "\n-C n[:msg] Allow only up to n connections from the same IP" \
4341 "\n New connections from this IP address are closed" \
4342 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004343 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004344 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004345 "\n-v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004346
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004347#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00004348 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004349#define udpsvd_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004350 "Create UDP socket, bind it to ip:port and wait\n" \
4351 "for incoming packets. Run PROG for each packet,\n" \
4352 "redirecting all further packets with same peer ip:port to it\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004353 "\nip IP to listen on. '0' = all" \
4354 "\nport Port to listen on" \
4355 "\nprog [arg] Program to run" \
4356 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4357 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004358 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004359 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004360 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004361 "\n-v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004362
Mark Whitley450736c2001-03-02 19:08:50 +00004363#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004364 "[OPTION]... HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004365#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004366 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004367 "\nOptions:" \
4368 "\n -l FILE Local FILE" \
4369 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004370 USE_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004371 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004372 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004373 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004374 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004375 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004376 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004377 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004378 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004379
4380#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004381 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004382#define tftpd_full_usage "\n\n" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004383 "Transfer a file on tftp client's request.\n" \
Denis Vlasenko91f8f822008-10-30 23:42:37 +00004384 "\n" \
4385 "tftpd should be used as an inetd service.\n" \
4386 "tftpd's line for inetd.conf:\n" \
4387 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
4388 "It also can be ran from udpsvd:\n" \
4389 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004390 "\nOptions:" \
4391 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004392 "\n -c Allow file creation via upload" \
4393 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004394
Eric Andersenc3657422001-11-30 07:54:32 +00004395#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004396 "[OPTION]... COMMAND [ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004397#define time_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004398 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004399 "COMMAND's resource usage information is displayed.\n" \
4400 "\nOptions:" \
4401 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004402
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004403#define timeout_trivial_usage \
4404 "[-t SECS] [-s SIG] PROG [ARGS]"
4405#define timeout_full_usage "\n\n" \
4406 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
Denis Vlasenko42404082008-11-24 13:42:24 +00004407 "Defaults: SECS: 10, SIG: TERM." \
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004408
Eric Andersen420b2082002-09-17 22:14:58 +00004409#define top_trivial_usage \
Denis Vlasenko42cc6ba2008-09-25 11:17:10 +00004410 "[-b] [-nCOUNT] [-dSECONDS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004411#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004412 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004413 "Read the status of all processes from /proc each SECONDS\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004414 "and show the status for however many processes will fit on the screen." \
Eric Andersen420b2082002-09-17 22:14:58 +00004415
Eric Andersen7e9276b2001-02-22 01:15:47 +00004416#define touch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004417 "[-c] FILE [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004418#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004419 "Update the last-modified date on the given FILE[s]\n" \
4420 "\nOptions:" \
4421 "\n -c Do not create any files" \
4422
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004423#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004424 "$ ls -l /tmp/foo\n" \
4425 "/bin/ls: /tmp/foo: No such file or directory\n" \
4426 "$ touch /tmp/foo\n" \
4427 "$ ls -l /tmp/foo\n" \
4428 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004429
4430#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004431 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004432#define tr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004433 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004434 "standard input, writing to standard output\n" \
4435 "\nOptions:" \
4436 "\n -c Take complement of STRING1" \
4437 "\n -d Delete input characters coded STRING1" \
4438 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4439
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004440#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004441 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4442 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004443
Eric Andersen5c58d282001-07-10 16:29:00 +00004444#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004445 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
4446 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004447 " [-z pausemsecs] HOST [data size]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004448#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004449 "Trace the route to HOST\n" \
4450 "\nOptions:" \
4451 "\n -F Set the don't fragment bit" \
4452 "\n -I Use ICMP ECHO instead of UDP datagrams" \
4453 "\n -l Display the ttl value of the returned packet" \
4454 "\n -d Set SO_DEBUG options to socket" \
4455 "\n -n Print hop addresses numerically rather than symbolically" \
4456 "\n -r Bypass the normal routing tables and send directly to a host" \
4457 "\n -v Verbose" \
4458 "\n -m max_ttl Max time-to-live (max number of hops)" \
4459 "\n -p port# Base UDP port number used in probes" \
4460 "\n (default is 33434)" \
4461 "\n -q nqueries Number of probes per 'ttl' (default 3)" \
4462 "\n -s src_addr IP address to use as the source address" \
4463 "\n -t tos Type-of-service in probe packets (default 0)" \
4464 "\n -w wait Time in seconds to wait for a response" \
4465 "\n (default 3 sec)" \
4466 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004467
Eric Andersen7e9276b2001-02-22 01:15:47 +00004468#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004469 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004470#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004471 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004472#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004473 "$ true\n" \
4474 "$ echo $?\n" \
4475 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004476
Eric Andersen7e9276b2001-02-22 01:15:47 +00004477#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004478 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004479#define tty_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004480 "Print file name of standard input's terminal" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004481 USE_INCLUDE_SUSv2( "\n" \
4482 "\nOptions:" \
4483 "\n -s Print nothing, only return exit status" \
4484 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004485#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004486 "$ tty\n" \
4487 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004488
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004489#define ttysize_trivial_usage \
4490 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004491#define ttysize_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004492 "Print dimension(s) of standard input's terminal, on error return 80x25"
4493
Denis Vlasenko39b68132009-01-23 02:07:14 +00004494#define tunctl_trivial_usage \
4495 "[-f device] ([-t name] | -d name)" USE_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]")
4496#define tunctl_full_usage "\n\n" \
4497 "Create or delete tun interfaces" \
4498 "\nOptions:" \
4499 "\n -f name tun device (/dev/net/tun)" \
4500 "\n -t name Create iface 'name'" \
4501 "\n -d name Delete iface 'name'" \
4502USE_FEATURE_TUNCTL_UG( \
4503 "\n -u owner Set iface owner" \
4504 "\n -g group Set iface group" \
4505 "\n -b Brief output" \
4506)
4507#define tunctl_example_usage \
4508 "# tunctl\n" \
4509 "# tunctl -d tun0\n"
4510
Mike Frysinger174808c2005-06-11 01:14:09 +00004511#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004512 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
4513 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
4514 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
4515 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
4516 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
4517 "[-T last-check-time] [-U UUID] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004518#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004519 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004520
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004521#define udhcpc_trivial_usage \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004522 "[-Cfbnqtvo] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004523 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." USE_FEATURE_UDHCP_PORT(" [-P N]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004524#define udhcpc_full_usage "\n\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004525 USE_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004526 " -V,--vendorclass=CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004527 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
4528 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
4529 "\n -c,--clientid=CLIENTID Client identifier" \
4530 "\n -C,--clientid-none Suppress default client identifier" \
4531 "\n -p,--pidfile=file Create pidfile" \
4532 "\n -r,--request=IP IP address to request" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +00004533 "\n -s,--script=file Run file at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004534 "\n -t,--retries=N Send up to N request packets" \
4535 "\n -T,--timeout=N Try to get a lease for N seconds (default 3)" \
4536 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004537 "\n -O,--request-option=OPT Request DHCP option OPT (cumulative)" \
4538 "\n -o,--no-default-options Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004539 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004540 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004541 "\n -b,--background Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004542 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004543 "\n -S,--syslog Log to syslog too" \
4544 "\n -n,--now Exit with failure if lease is not immediately obtained" \
4545 "\n -q,--quit Quit after obtaining lease" \
4546 "\n -R,--release Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004547 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004548 "\n -P,--client-port N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004549 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004550 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004551 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004552 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004553 ) \
4554 SKIP_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004555 " -V CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004556 "\n -i INTERFACE Interface to use (default: eth0)" \
4557 "\n -H,-h HOSTNAME Client hostname" \
4558 "\n -c CLIENTID Client identifier" \
4559 "\n -C Suppress default client identifier" \
4560 "\n -p file Create pidfile" \
4561 "\n -r IP IP address to request" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +00004562 "\n -s file Run file at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004563 "\n -t N Send up to N request packets" \
4564 "\n -T N Try to get a lease for N seconds (default 3)" \
4565 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004566 "\n -O OPT Request DHCP option OPT (cumulative)" \
4567 "\n -o Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004568 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004569 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004570 "\n -b Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004571 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004572 "\n -S Log to syslog too" \
4573 "\n -n Exit with failure if lease is not immediately obtained" \
4574 "\n -q Quit after obtaining lease" \
4575 "\n -R Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004576 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004577 "\n -P N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004578 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004579 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004580 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004581 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004582 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004583
Russ Dill61fb4892002-10-14 21:41:28 +00004584#define udhcpd_trivial_usage \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004585 "[-fS]" USE_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004586
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004587#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004588 "DHCP server\n" \
4589 "\n -f Run in foreground" \
4590 "\n -S Log to syslog too" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004591 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004592 "\n -P N Use port N instead of default 67" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004593 )
Russ Dill61fb4892002-10-14 21:41:28 +00004594
Eric Andersen7e9276b2001-02-22 01:15:47 +00004595#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004596 "[flags] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004597#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004598 "Unmount file systems\n" \
4599 "\nOptions:" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00004600 USE_FEATURE_UMOUNT_ALL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004601 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
4602 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004603 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004604 "\n -n Don't erase /etc/mtab entries" \
4605 ) \
4606 "\n -r Try to remount devices as read-only if mount is busy" \
4607 "\n -l Lazy umount (detach filesystem)" \
4608 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004609 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004610 "\n -d Free loop device if it has been used" \
4611 )
4612
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004613#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004614 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004615
4616#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004617 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004618#define uname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004619 "Print system information.\n" \
4620 "\nOptions:" \
4621 "\n -a Print all" \
4622 "\n -m The machine (hardware) type" \
4623 "\n -n Hostname" \
4624 "\n -r OS release" \
4625 "\n -s OS name (default)" \
4626 "\n -p Processor type" \
4627 "\n -v OS version" \
4628
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004629#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004630 "$ uname -a\n" \
4631 "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 +00004632
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004633#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004634 "[-c] [-f] [name...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004635#define uncompress_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004636 "Uncompress .Z file[s]\n" \
4637 "\nOptions:" \
4638 "\n -c Extract to stdout" \
4639 "\n -f Overwrite an existing file" \
Tim Riker7b253f82003-12-28 05:02:40 +00004640
Denis Vlasenko3952f202007-08-13 14:10:24 +00004641#define unexpand_trivial_usage \
4642 "[-f][-a][-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004643#define unexpand_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004644 "Convert spaces to tabs, writing to standard output.\n" \
4645 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004646 USE_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004647 "\n -a,--all Convert all blanks" \
4648 "\n -f,--first-only Convert only leading blanks" \
4649 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004650 ) \
4651 SKIP_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004652 "\n -a Convert all blanks" \
4653 "\n -f Convert only leading blanks" \
4654 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004655 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004656
Eric Andersen7e9276b2001-02-22 01:15:47 +00004657#define uniq_trivial_usage \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004658 "[-fscduw]... [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004659#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004660 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004661 "\nOptions:" \
4662 "\n -c Prefix lines by the number of occurrences" \
4663 "\n -d Only print duplicate lines" \
4664 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004665 "\n -f N Skip first N fields" \
4666 "\n -s N Skip first N chars (after any skipped fields)" \
4667 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004668
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004669#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004670 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4671 "a\n" \
4672 "b\n" \
4673 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004674
4675#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004676 "[option] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004677#define unix2dos_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004678 "Convert FILE from unix to dos format.\n" \
4679 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00004680 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004681 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004682 "\n -d unix2dos" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004683
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004684#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004685 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004686#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004687 "Extract files from ZIP archives\n" \
4688 "\nOptions:" \
4689 "\n -l List archive contents (with -q for short form)" \
4690 "\n -n Never overwrite existing files (default)" \
4691 "\n -o Overwrite files without prompting" \
4692 "\n -p Send output to stdout" \
4693 "\n -q Quiet" \
4694 "\n -x Exclude these files" \
4695 "\n -d Extract files into this directory" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004696
Eric Andersen7e9276b2001-02-22 01:15:47 +00004697#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004698 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004699#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004700 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004701
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004702#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004703 "$ uptime\n" \
4704 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004705
4706#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004707 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004708#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004709 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004710
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004711#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004712 "$ usleep 1000000\n" \
4713 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004714
4715#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004716 "[-o outfile] [infile]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004717#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004718 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004719 "Finds outfile name in uuencoded source unless -o is given"
4720
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004721#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004722 "$ uudecode -o busybox busybox.uu\n" \
4723 "$ ls -l busybox\n" \
4724 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004725
4726#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004727 "[-m] [infile] stored_filename"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004728#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004729 "Uuencode a file to stdout\n" \
4730 "\nOptions:" \
4731 "\n -m Use base64 encoding per RFC1521" \
4732
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004733#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004734 "$ uuencode busybox busybox\n" \
4735 "begin 755 busybox\n" \
4736 "<encoded file snipped>\n" \
4737 "$ uudecode busybox busybox > busybox.uu\n" \
4738 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004739
Eric Andersen853c4942003-01-23 05:59:32 +00004740#define vconfig_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004741 "COMMAND [OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004742#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004743 "Create and remove virtual ethernet devices\n" \
4744 "\nOptions:" \
4745 "\n add [interface-name] [vlan_id]" \
4746 "\n rem [vlan-name]" \
4747 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4748 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4749 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4750 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004751
Eric Andersen3f980402001-04-04 17:31:15 +00004752#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004753 "[OPTION] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004754#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004755 "Edit FILE\n" \
4756 "\nOptions:" \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004757 USE_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004758 "\n -c Initial command to run ($EXINIT also available)") \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004759 USE_FEATURE_VI_READONLY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004760 "\n -R Read-only - do not write to the file") \
4761 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00004762
Eric Andersen27f64e12002-06-23 04:24:25 +00004763#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004764 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004765#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004766 "Lock a virtual terminal. A password is required to unlock.\n" \
4767 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00004768 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004769
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004770#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00004771 "[-n seconds] [-t] COMMAND..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004772#define watch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004773 "Execute a program periodically\n" \
4774 "\nOptions:" \
4775 "\n -n Loop period in seconds (default 2)" \
4776 "\n -t Don't print header" \
4777
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004778#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004779 "$ watch date\n" \
4780 "Mon Dec 17 10:31:40 GMT 2000\n" \
4781 "Mon Dec 17 10:31:42 GMT 2000\n" \
4782 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004783
Eric Andersen7e9276b2001-02-22 01:15:47 +00004784#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004785 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004786#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004787 "Periodically write to watchdog device DEV\n" \
4788 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004789 "\n -T N Reboot after N seconds if not reset (default 60)" \
4790 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004791 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004792 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004793 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004794
4795#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004796 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004797#define wc_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004798 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004799 "more than one FILE is specified. With no FILE, read standard input.\n" \
4800 "\nOptions:" \
4801 "\n -c Print the byte counts" \
4802 "\n -l Print the newline counts" \
4803 "\n -L Print the length of the longest line" \
4804 "\n -w Print the word counts" \
4805
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004806#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004807 "$ wc /etc/passwd\n" \
4808 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004809
4810#define wget_trivial_usage \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00004811 USE_FEATURE_WGET_LONG_OPTIONS( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004812 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004813 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4814 " [-U|--user-agent agent] url" \
4815 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00004816 SKIP_FEATURE_WGET_LONG_OPTIONS( \
Denis Vlasenko03630782007-10-18 11:11:12 +00004817 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4818 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004819#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004820 "Retrieve files via HTTP or FTP\n" \
4821 "\nOptions:" \
4822 "\n -s Spider mode - only check file existence" \
4823 "\n -c Continue retrieval of aborted transfer" \
4824 "\n -q Quiet" \
4825 "\n -P Set directory prefix to DIR" \
4826 "\n -O Save to filename ('-' for stdout)" \
4827 "\n -U Adjust 'User-Agent' field" \
4828 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004829
4830#define which_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004831 "[COMMAND...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004832#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004833 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004834#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004835 "$ which login\n" \
4836 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004837
Eric Andersen00a6a752002-04-26 23:53:10 +00004838#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004839 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004840#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004841 "Show who is logged on\n" \
4842 "\nOptions:" \
4843 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004844
4845#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004846 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004847#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004848 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004849
4850#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004851 "[OPTIONS] [COMMAND] [ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004852#define xargs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004853 "Execute COMMAND on every item given by standard input\n" \
4854 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004855 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004856 "\n -p Ask user whether to run each command") \
4857 "\n -r Do not run command if input is empty" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004858 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004859 "\n -0 Input is separated by NUL characters") \
4860 "\n -t Print the command on stderr before execution" \
Denis Vlasenkoe82da4d2008-08-21 19:59:30 +00004861 "\n -e[STR] STR stops input processing" \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004862 "\n -n N Pass no more than N args to COMMAND" \
4863 "\n -s N Pass command line of no more than N bytes" \
4864 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
4865 "\n -x Exit if size is exceeded") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004866
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004867#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004868 "$ ls | xargs gzip\n" \
4869 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004870
4871#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004872 "[OPTION]... [STRING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004873#define yes_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004874 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004875
Eric Andersen7e9276b2001-02-22 01:15:47 +00004876#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004877 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004878#define zcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004879 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004880
Rob Landleyad8071f2005-04-30 03:49:37 +00004881#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004882 "[OPTIONS] ifname script"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004883#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004884 "Manage a ZeroConf IPv4 link-local address\n" \
4885 "\nOptions:" \
4886 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004887 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004888 "\n -r 169.254.x.x Request this address first" \
4889 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004890 "\n" \
4891 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
4892 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00004893
Eric Andersen178de172004-04-06 16:36:20 +00004894#endif /* __BB_USAGE_H__ */