blob: 000b864d60c10a7f793b219df72a9919978c1b9d [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 Vlasenko397de612008-03-17 08:55:44 +000040 "Add a group " USE_FEATURE_ADDUSER_TO_GROUP("or add an user to a group") "\n" \
41 "\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 Vlasenko397de612008-03-17 08:55:44 +000047 "Add an user\n" \
48 "\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#if !ENABLE_USE_BB_CRYPT || ENABLE_USE_BB_CRYPT_SHA
577#define cryptpw_trivial_usage \
578 "[-a des|md5|sha256/512] [string]"
579#else
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000580#define cryptpw_trivial_usage \
581 "[-a des|md5] [string]"
Denis Vlasenko2211d522008-11-10 18:52:35 +0000582#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000583#define cryptpw_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000584 "Output crypted string.\n" \
585 "If string isn't supplied on cmdline, read it from stdin.\n" \
586 "\nOptions:" \
587 "\n -a Algorithm to use (default: md5)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000588
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000589#define cttyhack_trivial_usage NOUSAGE_STR
590#define cttyhack_full_usage ""
591
Eric Andersen7e9276b2001-02-22 01:15:47 +0000592#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000593 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000594#define cut_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000595 "Print selected fields from each input FILE to standard output\n" \
596 "\nOptions:" \
597 "\n -b LIST Output only bytes from LIST" \
598 "\n -c LIST Output only characters from LIST" \
599 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
600 "\n -s Output only the lines containing delimiter" \
601 "\n -f N Print only these fields" \
602 "\n -n Ignored" \
603
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000604#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000605 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
606 "Hello\n" \
607 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
608 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000609
Eric Andersen7e9276b2001-02-22 01:15:47 +0000610#define date_trivial_usage \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000611 "[OPTION]... [+FMT] [TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000612#define date_full_usage "\n\n" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000613 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000614 "\nOptions:" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000615 "\n -u Work in UTC (don't convert to local time)" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000616 "\n -R Output RFC-822 compliant date string" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000617 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000618 "\n -I[SPEC] Output ISO-8601 compliant date string" \
619 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000620 "\n 'hours', 'minutes', or 'seconds' for date and" \
621 "\n time to the indicated precision" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000622 ) \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000623 "\n -d TIME Display TIME, not 'now'" \
624 "\n -r FILE Display last modification time of FILE" \
625 "\n [-s] TIME Set time to TIME" \
626 USE_FEATURE_DATE_ISOFMT( \
627 "\n -D FMT Use FMT for str->date conversion" \
628 ) \
629 "\n" \
630 "\nRecognized formats for TIME:" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000631 "\n hh:mm[:ss]" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000632 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000633 "\n YYYY-MM-DD hh:mm[:ss]" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000634 "\n MMDDhhmm[[YY]YY][.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000635
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000636#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000637 "$ date\n" \
638 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000639
Eric Andersen7e9276b2001-02-22 01:15:47 +0000640#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000641 "expression..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000642#define dc_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +0000643 "Tiny RPN calculator. Operations:\n" \
644 "+, add, -, sub, *, mul, /, div, %, mod, **, exp, and, or, not, eor,\n" \
645 "p - print top of the stack (without altering the stack),\n" \
646 "f - print entire stack, o - pop the value and set output radix\n" \
647 "(value must be 10 or 16).\n" \
648 "Examples: 'dc 2 2 add' -> 4, 'dc 8 8 * 2 2 + /' -> 16.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000649
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000650#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000651 "$ dc 2 2 + p\n" \
652 "4\n" \
653 "$ dc 8 8 \\* 2 2 + / p\n" \
654 "16\n" \
655 "$ dc 0 1 and p\n" \
656 "0\n" \
657 "$ dc 0 1 or p\n" \
658 "1\n" \
659 "$ echo 72 9 div 8 mul p | dc\n" \
660 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000661
Eric Andersen7e9276b2001-02-22 01:15:47 +0000662#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000663 "[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 +0000664 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000665#define dd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000666 "Copy a file with converting and formatting\n" \
667 "\nOptions:" \
668 "\n if=FILE Read from FILE instead of stdin" \
669 "\n of=FILE Write to FILE instead of stdout" \
670 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000671 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000672 "\n ibs=N Read N bytes at a time" \
673 ) \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000674 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000675 "\n obs=N Write N bytes at a time" \
676 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000677 "\n count=N Copy only N input blocks" \
678 "\n skip=N Skip N input blocks" \
679 "\n seek=N Skip N output blocks" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000680 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000681 "\n conv=notrunc Don't truncate output file" \
682 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000683 "\n conv=sync Pad blocks with zeros" \
684 "\n conv=fsync Physically write data out before finishing" \
685 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000686 "\n" \
687 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
688 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
689
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000690#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000691 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
692 "4+0 records in\n" \
693 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000694
Eric Andersen7e9276b2001-02-22 01:15:47 +0000695#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000696 "[N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000697#define deallocvt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000698 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000699
Eric Andersenf349e972001-08-21 16:18:59 +0000700#define delgroup_trivial_usage \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000701 USE_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000702#define delgroup_full_usage "\n\n" \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000703 "Delete group GROUP from the system" \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000704 USE_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000705
706#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000707 "USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000708#define deluser_full_usage "\n\n" \
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000709 "Delete USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000710
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000711#define depmod_trivial_usage NOUSAGE_STR
712#define depmod_full_usage ""
Bernhard Reutner-Fischer55e547e2008-05-26 12:01:49 +0000713
Denis Vlasenkoc94fa562008-10-26 11:08:14 +0000714#define devmem_trivial_usage \
715 "ADDRESS [WIDTH [VALUE]]"
716
717#define devmem_full_usage "\n\n" \
718 "Read/write from physical address\n" \
719 "\n ADDRESS Address to act upon" \
720 "\n WIDTH Width (8/16/...)" \
721 "\n VALUE Data to be written" \
722
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000723#define devfsd_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000724 "mntpnt [-v]" USE_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000725#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000726 "Manage devfs permissions and old device name symlinks\n" \
727 "\nOptions:" \
728 "\n mntpnt The mount point where devfs is mounted" \
729 "\n -v Print the protocol version numbers for devfsd" \
730 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000731 USE_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000732 "\n -fg Run in foreground" \
733 "\n -np Exit after parsing the configuration file" \
734 "\n and processing synthetic REGISTER events," \
735 "\n do not poll for events" \
736 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000737
Eric Andersen7e9276b2001-02-22 01:15:47 +0000738#define df_trivial_usage \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000739 "[-Pk" \
740 USE_FEATURE_HUMAN_READABLE("mh") \
741 USE_FEATURE_DF_FANCY("ai] [-B SIZE") \
742 "] [FILESYSTEM...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000743#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000744 "Print filesystem usage statistics\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000745 "\nOptions:" \
746 "\n -P POSIX output format" \
747 "\n -k 1024-byte blocks (default)" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000748 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000749 "\n -m 1M-byte blocks" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000750 "\n -h Human readable (e.g. 1K 243M 2G)" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000751 ) \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000752 USE_FEATURE_DF_FANCY( \
753 "\n -a Show all filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000754 "\n -i Inodes" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000755 "\n -B SIZE Blocksize" \
756 ) \
757
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000758#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000759 "$ df\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000760 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000761 "/dev/sda3 8690864 8553540 137324 98% /\n" \
762 "/dev/sda1 64216 36364 27852 57% /boot\n" \
763 "$ df /dev/sda3\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000764 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
765 "/dev/sda3 8690864 8553540 137324 98% /\n" \
766 "$ POSIXLY_CORRECT=sure df /dev/sda3\n" \
767 "Filesystem 512B-blocks Used Available Use% Mounted on\n" \
768 "/dev/sda3 17381728 17107080 274648 98% /\n" \
769 "$ POSIXLY_CORRECT=yep df -P /dev/sda3\n" \
770 "Filesystem 512-blocks Used Available Capacity Mounted on\n" \
771 "/dev/sda3 17381728 17107080 274648 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000772
Denis Vlasenko736230e2006-11-20 19:40:36 +0000773#define dhcprelay_trivial_usage \
Bernhard Reutner-Fischer55fb9da2008-05-27 12:42:39 +0000774 "[client1,client2,...] [server_device]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000775#define dhcprelay_full_usage "\n\n" \
Bernhard Reutner-Fischer55fb9da2008-05-27 12:42:39 +0000776 "Relay dhcp requests from client devices to server device.\n" \
777 "Pass clients as CSV"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000778
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000779#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000780 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000781#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000782 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000783 "This implementation supports unified diffs only.\n" \
784 "\nOptions:" \
785 "\n -a Treat all files as text" \
786 "\n -b Ignore changes in the amount of whitespace" \
787 "\n -d Try hard to find a smaller set of changes" \
788 "\n -i Ignore case differences" \
789 "\n -L Use LABEL instead of the filename in the unified header" \
790 "\n -N Treat absent files as empty" \
791 "\n -q Output only whether files differ" \
792 "\n -r Recursively compare subdirectories" \
793 "\n -S Start with FILE when comparing directories" \
794 "\n -T Make tabs line up by prefixing a tab when necessary" \
795 "\n -s Report when two files are the same" \
796 "\n -t Expand tabs to spaces in output" \
797 "\n -U Output LINES lines of context" \
798 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000799
Eric Andersen7e9276b2001-02-22 01:15:47 +0000800#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000801 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000802#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000803 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000804#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000805 "$ dirname /tmp/foo\n" \
806 "/tmp\n" \
807 "$ dirname /tmp/foo/\n" \
808 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000809
Eric Andersen7e9276b2001-02-22 01:15:47 +0000810#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000811 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000812#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000813 "Print or control the kernel ring buffer\n" \
814 "\nOptions:" \
815 "\n -c Clear ring buffer after printing" \
816 "\n -n LEVEL Set console logging level" \
817 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000818
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000819#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000820 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000821#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000822 "Small static DNS server daemon\n" \
823 "\nOptions:" \
824 "\n -c Config filename" \
825 "\n -t TTL in seconds" \
826 "\n -p Listening port" \
827 "\n -i Listening ip (default all)" \
828 "\n -d Daemonize" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000829
Eric Andersen7e9276b2001-02-22 01:15:47 +0000830#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000831 "[option] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000832#define dos2unix_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000833 "Convert FILE from dos to unix format.\n" \
834 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000835 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000836 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000837 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000838
Eric Andersen7e9276b2001-02-22 01:15:47 +0000839#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000840 "[-ilCPru] [-F option] package_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000841#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000842 "Install, remove and manage Debian packages\n" \
843 "\nOptions:" \
844 "\n -i Install the package" \
845 "\n -l List of installed packages" \
846 "\n -C Configure an unpackaged package" \
847 "\n -F depends Ignore dependency problems" \
848 "\n -P Purge all files of a package" \
849 "\n -r Remove all but the configuration files for a package" \
850 "\n -u Unpack a package, but don't configure it" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000851
Eric Andersen7e9276b2001-02-22 01:15:47 +0000852#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000853 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000854#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000855 "Perform actions on Debian packages (.debs)\n" \
856 "\nOptions:" \
857 "\n -c List contents of filesystem tree" \
858 "\n -e Extract control files to [argument] directory" \
859 "\n -f Display control field name starting with [argument]" \
860 "\n -x Extract packages filesystem tree to directory" \
861 "\n -X Verbose extract" \
862
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000863#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000864 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000865
Eric Andersen7e9276b2001-02-22 01:15:47 +0000866#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000867 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000868#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000869 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000870 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000871 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
872 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000873 " bytes.\n" \
874 "\nOptions:" \
875 "\n -a Show file sizes too" \
876 "\n -H Follow symlinks on command line" \
877 "\n -L Follow all symlinks" \
878 "\n -d N Limit output to directories (and files with -a) of depth < N" \
879 "\n -c Show grand total" \
880 "\n -l Count sizes many times if hard linked" \
881 "\n -s Display only a total for each argument" \
882 "\n -x Skip directories on different filesystems" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000883 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000884 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
885 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000886 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000887 "\n -k Sizes in kilobytes" \
888 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
889
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000890#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000891 "$ du\n" \
892 "16 ./CVS\n" \
893 "12 ./kernel-patches/CVS\n" \
894 "80 ./kernel-patches\n" \
895 "12 ./tests/CVS\n" \
896 "36 ./tests\n" \
897 "12 ./scripts/CVS\n" \
898 "16 ./scripts\n" \
899 "12 ./docs/CVS\n" \
900 "104 ./docs\n" \
901 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000902
Eric Andersen7e9276b2001-02-22 01:15:47 +0000903#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000904 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000905#define dumpkmap_full_usage "\n\n" \
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000906 "Print a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000907#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000908 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000909
Russ Dill61fb4892002-10-14 21:41:28 +0000910#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000911 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000912#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000913 "Display DHCP leases granted by udhcpd\n" \
914 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000915 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000916 "\n -f,--file=FILE Leases file to load" \
917 "\n -r,--remaining Interpret lease times as time remaining" \
918 "\n -a,--absolute Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000919 ) \
920 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000921 "\n -f FILE Leases file to load" \
922 "\n -r Interpret lease times as time remaining" \
923 "\n -a Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000924 )
Russ Dill61fb4892002-10-14 21:41:28 +0000925
Mike Frysinger51a43b42005-09-24 07:11:16 +0000926#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000927 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
928 "[-I inode_buffer_blocks] [-P process_inode_size] " \
929 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
930 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000931#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000932 "Check ext2/ext3 file system\n" \
933 "\nOptions:" \
934 "\n -p Automatic repair (no questions)" \
935 "\n -n Make no changes to the filesystem" \
936 "\n -y Assume 'yes' to all questions" \
937 "\n -c Check for bad blocks and add them to the badblock list" \
938 "\n -f Force checking even if filesystem is marked clean" \
939 "\n -v Verbose" \
940 "\n -b superblock Use alternative superblock" \
941 "\n -B blocksize Force blocksize when looking for superblock" \
942 "\n -j journal Set location of the external journal" \
943 "\n -l file Add to badblocks list" \
944 "\n -L file Set badblocks list" \
Mike Frysinger51a43b42005-09-24 07:11:16 +0000945
Eric Andersen7e9276b2001-02-22 01:15:47 +0000946#define echo_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000947 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000948#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000949 "Print the specified ARGs to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000950 USE_FEATURE_FANCY_ECHO( "\n" \
951 "\nOptions:" \
952 "\n -n Suppress trailing newline" \
953 "\n -e Interpret backslash-escaped characters (i.e., \\t=tab)" \
954 "\n -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000955 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000956#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000957 "$ echo \"Erik is cool\"\n" \
958 "Erik is cool\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000959 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000960 "Erik\n" \
961 "is\n" \
962 "cool\n" \
963 "$ echo \"Erik\\nis\\ncool\"\n" \
964 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000965
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000966#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000967 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000968#define eject_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000969 "Eject specified DEVICE (or default /dev/cdrom)\n" \
970 "\nOptions:" \
971 USE_FEATURE_EJECT_SCSI( \
972 "\n -s SCSI device" \
973 ) \
974 "\n -t Close tray" \
975 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000976
Rob Landley3b890392006-05-04 20:56:43 +0000977#define ed_trivial_usage ""
978#define ed_full_usage ""
979
Eric Andersen84e229c2001-03-29 22:48:33 +0000980#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000981 "[-iu] [-] [name=value]... [command]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000982#define env_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000983 "Print the current environment or run a program after setting\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000984 "up the specified environment\n" \
985 "\nOptions:" \
986 "\n -, -i Start with an empty environment" \
987 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +0000988
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000989#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000990 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000991#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000992 "Send a magic packet to wake up sleeping machines.\n" \
993 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000994 "a hostname with a known 'ethers' entry.\n" \
995 "\nOptions:" \
996 "\n -b Send wake-up packet to the broadcast address" \
997 "\n -i iface Interface to use (default eth0)" \
998 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000999
Denis Vlasenko3952f202007-08-13 14:10:24 +00001000#define expand_trivial_usage \
1001 "[-i] [-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001002#define expand_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001003 "Convert tabs to spaces, writing to standard output.\n" \
1004 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001005 USE_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001006 "\n -i,--initial Do not convert tabs after non blanks" \
1007 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001008 ) \
1009 SKIP_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001010 "\n -i Do not convert tabs after non blanks" \
1011 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001012 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00001013
Eric Andersen7e9276b2001-02-22 01:15:47 +00001014#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001015 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001016#define expr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001017 "Print the value of EXPRESSION to standard output.\n" \
1018 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001019 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001020 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
1021 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1022 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1023 " ARG1 <= ARG2\n" \
1024 " ARG1 = ARG2\n" \
1025 " ARG1 != ARG2\n" \
1026 " ARG1 >= ARG2\n" \
1027 " ARG1 > ARG2\n" \
1028 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1029 " ARG1 - ARG2\n" \
1030 " ARG1 * ARG2\n" \
1031 " ARG1 / ARG2\n" \
1032 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001033 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1034 " match STRING REGEXP Same as STRING : REGEXP\n" \
1035 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1036 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1037 " length STRING Length of STRING\n" \
1038 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001039 " it is a keyword like 'match' or an\n" \
1040 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001041 " (EXPRESSION) Value of EXPRESSION\n" \
1042 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001043 "Beware that many operators need to be escaped or quoted for shells.\n" \
1044 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001045 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001046 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1047 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001048
Mike Frysingerfa69f112005-04-17 07:24:19 +00001049#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001050 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001051#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001052 "Provide fake ident (auth) service\n" \
1053 "\nOptions:" \
1054 "\n -f Run in foreground" \
1055 "\n -i Inetd mode" \
1056 "\n -w Inetd 'wait' mode" \
1057 "\n -b ADDR Bind to specified address" \
1058 "\n STRING Ident answer string (default is 'nobody')" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001059
Eric Andersen7e9276b2001-02-22 01:15:47 +00001060#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001061 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001062#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001063 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001064
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001065#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001066 "$ false\n" \
1067 "$ echo $?\n" \
1068 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001069
1070#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001071 "[options] [mode]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001072#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001073 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001074
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001075#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001076 "$ fbset\n" \
1077 "mode \"1024x768-76\"\n" \
1078 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1079 " geometry 1024 768 1024 768 16\n" \
1080 " timings 12714 128 32 16 4 128 4\n" \
1081 " accel false\n" \
1082 " rgba 5/11,6/5,5/0,0/0\n" \
1083 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001084
Eric Andersen7e9276b2001-02-22 01:15:47 +00001085#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001086 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001087#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001088 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001089
Eric Andersen01c3d402003-07-05 07:51:31 +00001090#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001091 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001092#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001093 "Format floppy disk\n" \
1094 "\nOptions:" \
1095 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001096
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001097/* Looks like someone forgot to add this to config system */
1098#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1099# define ENABLE_FEATURE_FDISK_BLKSIZE 0
1100# define USE_FEATURE_FDISK_BLKSIZE(a)
1101#endif
1102
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001103#define fdisk_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001104 "[-ul" USE_FEATURE_FDISK_BLKSIZE("s") "] " \
1105 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001106#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001107 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001108 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001109 "\n -u Start and End are in sectors (instead of cylinders)" \
1110 "\n -l Show partition table for each DISK, then exit" \
1111 USE_FEATURE_FDISK_BLKSIZE( \
1112 "\n -s Show partition sizes in kb for each DISK, then exit" \
1113 ) \
1114 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1115 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
1116 "\n -H HEADS\n" \
1117 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001118
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001119#define blkid_trivial_usage \
1120 ""
1121#define blkid_full_usage "\n\n" \
1122 "Print UUIDs of all filesystems."
1123
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001124#define findfs_trivial_usage \
1125 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001126#define findfs_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001127 "Find a filesystem device based on a label or UUID."
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001128#define findfs_example_usage \
1129 "$ findfs LABEL=MyDevice"
1130
Eric Andersen7e9276b2001-02-22 01:15:47 +00001131#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001132 "[PATH...] [EXPRESSION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001133#define find_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001134 "Search for files. The default PATH is the current directory,\n" \
1135 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001136 "\nEXPRESSION may consist of:" \
1137 "\n -follow Dereference symlinks" \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001138 USE_FEATURE_FIND_XDEV( \
1139 "\n -xdev Don't descend directories on other filesystems") \
1140 USE_FEATURE_FIND_MAXDEPTH( \
1141 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1142 "\n tests/actions to command line arguments only") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001143 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001144 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001145 USE_FEATURE_FIND_PATH( \
1146 "\n -path PATTERN Path matches PATTERN") \
1147 USE_FEATURE_FIND_REGEX( \
1148 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001149 USE_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001150 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001151 USE_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001152 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001153 "\n or exactly (NNN)") \
1154 USE_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001155 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001156 "\n or exactly (N) days") \
1157 USE_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001158 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001159 "\n or exactly (N) minutes") \
1160 USE_FEATURE_FIND_NEWER( \
1161 "\n -newer FILE Modified time is more recent than FILE's") \
1162 USE_FEATURE_FIND_INUM( \
1163 "\n -inum N File has inode number N") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001164 USE_FEATURE_FIND_USER( \
1165 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
1166 USE_FEATURE_FIND_GROUP( \
1167 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
1168 USE_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001169 "\n -depth Process directory name after traversing it") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001170 USE_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001171 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1172 "\n +/-N: file size is bigger/smaller than N") \
1173 "\n -print Print (default and assumed)" \
1174 USE_FEATURE_FIND_PRINT0( \
1175 "\n -print0 Delimit output with null characters rather than" \
1176 "\n newlines") \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001177 USE_FEATURE_FIND_CONTEXT ( \
1178 "\n -context File has specified security context") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001179 USE_FEATURE_FIND_EXEC( \
1180 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1181 "\n matching files") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001182 USE_FEATURE_FIND_PRUNE( \
1183 "\n -prune Stop traversing current subtree") \
1184 USE_FEATURE_FIND_DELETE( \
1185 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001186 USE_FEATURE_FIND_PAREN( \
1187 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001188
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001189#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001190 "$ find / -name passwd\n" \
1191 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001192
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001193#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001194 "[-bs] [-w WIDTH] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001195#define fold_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001196 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001197 "standard output\n" \
1198 "\nOptions:" \
1199 "\n -b Count bytes rather than columns" \
1200 "\n -s Break at spaces" \
1201 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001202
Eric Andersen7e9276b2001-02-22 01:15:47 +00001203#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001204 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001205#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001206 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001207#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001208 "$ free\n" \
1209 " total used free shared buffers\n" \
1210 " Mem: 257628 248724 8904 59644 93124\n" \
1211 " Swap: 128516 8404 120112\n" \
1212 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001213
Eric Andersen7e9276b2001-02-22 01:15:47 +00001214#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001215 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001216#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001217 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001218#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001219 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001220
Mike Frysinger51a43b42005-09-24 07:11:16 +00001221#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001222 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001223#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001224 "Check and repair filesystems\n" \
1225 "\nOptions:" \
1226 "\n -A Walk /etc/fstab and check all filesystems" \
1227 "\n -N Don't execute, just show what would be done" \
1228 "\n -P With -A, check filesystems in parallel" \
1229 "\n -R With -A, skip the root filesystem" \
1230 "\n -T Don't show title on startup" \
1231 "\n -V Verbose" \
1232 "\n -C n Write status information to specified filedescriptor" \
1233 "\n -t type List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001234
Eric Andersen7e9276b2001-02-22 01:15:47 +00001235#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001236 "[-larvsmf] /dev/name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001237#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001238 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001239 "\nOptions:" \
1240 "\n -l List all filenames" \
1241 "\n -r Perform interactive repairs" \
1242 "\n -a Perform automatic repairs" \
1243 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001244 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001245 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001246 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001247
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001248#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001249 "[options] remote-host local-file remote-file"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001250#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001251 "Retrieve a remote file via FTP\n" \
1252 "\nOptions:" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001253 USE_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001254 "\n -c,--continue Continue previous transfer" \
1255 "\n -v,--verbose Verbose" \
1256 "\n -u,--username Username" \
1257 "\n -p,--password Password" \
1258 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001259 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001260 SKIP_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001261 "\n -c Continue previous transfer" \
1262 "\n -v Verbose" \
1263 "\n -u Username" \
1264 "\n -p Password" \
1265 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001266 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001267
1268#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001269 "[options] remote-host remote-file local-file"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001270#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001271 "Store a local file on a remote machine via FTP\n" \
1272 "\nOptions:" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001273 USE_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001274 "\n -v,--verbose Verbose" \
1275 "\n -u,--username Username" \
1276 "\n -p,--password Password" \
1277 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001278 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001279 SKIP_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001280 "\n -v Verbose" \
1281 "\n -u Username" \
1282 "\n -p Password" \
1283 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001284 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001285
Rob Landleyaa872762005-10-28 13:05:12 +00001286#define fuser_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001287 "[options] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001288#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001289 "Find processes which use FILEs or PORTs\n" \
1290 "\nOptions:" \
1291 "\n -m Find processes which use same fs as FILEs" \
1292 "\n -4 Search only IPv4 space" \
1293 "\n -6 Search only IPv6 space" \
1294 "\n -s Silent: just exit with 0 if any processes are found" \
1295 "\n -k Kill found processes (otherwise display PIDs)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001296 "\n -SIGNAL Signal to send (default: TERM)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001297
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001298#define getenforce_trivial_usage NOUSAGE_STR
1299#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001300
Eric Andersen7e9276b2001-02-22 01:15:47 +00001301#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001302 "[OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001303#define getopt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001304 "Parse command options\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001305 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001306 "\n -a,--alternative Allow long options starting with single -" \
1307 "\n -l,--longoptions=longopts Long options to be recognized" \
1308 "\n -n,--name=progname The name under which errors are reported" \
1309 "\n -o,--options=optstring Short options to be recognized" \
1310 "\n -q,--quiet Disable error reporting by getopt(3)" \
1311 "\n -Q,--quiet-output No normal output" \
1312 "\n -s,--shell=shell Set shell quoting conventions" \
1313 "\n -T,--test Test for getopt(1) version" \
1314 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001315 ) \
1316 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001317 "\n -a Allow long options starting with single -" \
1318 "\n -l longopts Long options to be recognized" \
1319 "\n -n progname The name under which errors are reported" \
1320 "\n -o optstring Short options to be recognized" \
1321 "\n -q Disable error reporting by getopt(3)" \
1322 "\n -Q No normal output" \
1323 "\n -s shell Set shell quoting conventions" \
1324 "\n -T Test for getopt(1) version" \
1325 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001326 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001327#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001328 "$ cat getopt.test\n" \
1329 "#!/bin/sh\n" \
1330 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1331 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001332 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001333 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001334 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001335 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001336 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1337 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001338 " -c|--c-long)\n" \
1339 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001340 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1341 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1342 " esac;;\n" \
1343 " --) shift; break;;\n" \
1344 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001345 " esac\n" \
1346 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001347
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001348#define getsebool_trivial_usage \
1349 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001350#define getsebool_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001351 " -a Show all SELinux booleans"
1352
Eric Andersenf349e972001-08-21 16:18:59 +00001353#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001354 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001355#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001356 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1357 "\nOptions:" \
1358 "\n -h Enable hardware (RTS/CTS) flow control" \
1359 "\n -i Do not display /etc/issue before running login" \
1360 "\n -L Local line, do not do carrier detect" \
1361 "\n -m Get baud rate from modem's CONNECT status message" \
1362 "\n -w Wait for a CR or LF before sending /etc/issue" \
1363 "\n -n Do not prompt the user for a login name" \
1364 "\n -f issue_file Display issue_file instead of /etc/issue" \
1365 "\n -l login_app Invoke login_app instead of /bin/login" \
1366 "\n -t timeout Terminate after timeout if no username is read" \
1367 "\n -I initstring Init string to send before anything else" \
1368 "\n -H login_host Log login_host into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001369
Eric Andersen7e9276b2001-02-22 01:15:47 +00001370#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001371 "[-HhrilLnqvso" \
1372 USE_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001373 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001374 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1375 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001376 "] PATTERN [FILEs...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001377#define grep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001378 "Search for PATTERN in each FILE or standard input\n" \
1379 "\nOptions:" \
1380 "\n -H Prefix output lines with filename where match was found" \
1381 "\n -h Suppress the prefixing filename on output" \
1382 "\n -r Recurse subdirectories" \
1383 "\n -i Ignore case distinctions" \
1384 "\n -l List names of files that match" \
1385 "\n -L List names of files that do not match" \
1386 "\n -n Print line number with output lines" \
1387 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1388 "\n -v Select non-matching lines" \
1389 "\n -s Suppress file open/read error messages" \
1390 "\n -c Only print count of matching lines" \
1391 "\n -o Show only the part of a line that matches PATTERN" \
1392 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001393 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001394 "\n -w Match whole words only") \
1395 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001396 USE_FEATURE_GREP_EGREP_ALIAS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001397 "\n -E PATTERN is an extended regular expression") \
1398 "\n -e PTRN Pattern to match" \
1399 "\n -f FILE Read pattern from file" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001400 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001401 "\n -A Print NUM lines of trailing context" \
1402 "\n -B Print NUM lines of leading context" \
1403 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001404
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001405#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001406 "$ grep root /etc/passwd\n" \
1407 "root:x:0:0:root:/root:/bin/bash\n" \
1408 "$ grep ^[rR]oo. /etc/passwd\n" \
1409 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001410
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001411#define egrep_trivial_usage NOUSAGE_STR
1412#define egrep_full_usage ""
1413
1414#define fgrep_trivial_usage NOUSAGE_STR
1415#define fgrep_full_usage ""
1416
Eric Andersen7e9276b2001-02-22 01:15:47 +00001417#define gunzip_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001418 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001419#define gunzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001420 "Uncompress FILEs (or standard input)\n" \
1421 "\nOptions:" \
1422 "\n -c Write to standard output" \
1423 "\n -f Force" \
1424 "\n -t Test file integrity" \
1425
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001426#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001427 "$ ls -la /tmp/BusyBox*\n" \
1428 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1429 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1430 "$ ls -la /tmp/BusyBox*\n" \
1431 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001432
1433#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001434 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001435#define gzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001436 "Compress FILEs (or standard input)\n" \
1437 "\nOptions:" \
1438 "\n -c Write to standard output" \
1439 "\n -d Decompress" \
1440 "\n -f Force" \
1441
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001442#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001443 "$ ls -la /tmp/busybox*\n" \
1444 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1445 "$ gzip /tmp/busybox.tar\n" \
1446 "$ ls -la /tmp/busybox*\n" \
1447 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001448
1449#define halt_trivial_usage \
Bernhard Reutner-Fischerd93179f2008-09-01 15:24:52 +00001450 "[-d delay] [-n] [-f]" USE_FEATURE_WTMP(" [-w]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001451#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001452 "Halt the system\n" \
1453 "\nOptions:" \
1454 "\n -d Delay interval for halting" \
1455 "\n -n No call to sync()" \
1456 "\n -f Force halt (don't go through init)" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001457 USE_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001458 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001459 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001460
Eric Andersen3443bd72003-07-22 07:30:36 +00001461#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001462 "[options] [device] .."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001463#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001464 "Options:" \
1465 "\n -a Get/set fs readahead" \
1466 "\n -A Set drive read-lookahead flag (0/1)" \
1467 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1468 "\n -B Set Advanced Power Management setting (1-255)" \
1469 "\n -c Get/set IDE 32-bit IO setting" \
1470 "\n -C Check IDE power mode status" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001471 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001472 "\n -d Get/set using_dma flag") \
1473 "\n -D Enable/disable drive defect-mgmt" \
1474 "\n -f Flush buffer cache for device on exit" \
1475 "\n -g Display drive geometry" \
1476 "\n -h Display terse usage information" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001477 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001478 "\n -i Display drive identification") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001479 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001480 "\n -I Detailed/current information directly from drive") \
1481 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1482 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1483 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1484 "\n -m Get/set multiple sector count" \
1485 "\n -n Get/set ignore-write-errors flag (0/1)" \
1486 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1487 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001488/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001489 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1490 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001491 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001492 "\n -R Register an IDE interface (DANGEROUS)") \
1493 "\n -S Set standby (spindown) timeout" \
1494 "\n -t Perform device read timings" \
1495 "\n -T Perform cache read timings" \
1496 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001497 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001498 "\n -U Un-register an IDE interface (DANGEROUS)") \
1499 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1500 "\n -V Display program version and exit immediately" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001501 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001502 "\n -w Perform device reset (DANGEROUS)") \
1503 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001504 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001505 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1506 "\n -X Set IDE xfer mode (DANGEROUS)" \
1507 "\n -y Put IDE drive in standby mode" \
1508 "\n -Y Put IDE drive to sleep" \
1509 "\n -Z Disable Seagate auto-powersaving mode" \
1510 "\n -z Re-read partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001511
Eric Andersen7e9276b2001-02-22 01:15:47 +00001512#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001513 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001514#define head_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001515 "Print first 10 lines of each FILE to standard output.\n" \
1516 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001517 "file name. With no FILE, or when FILE is -, read standard input.\n" \
1518 "\nOptions:" \
1519 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001520 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001521 "\n -c NUM Output the first NUM bytes" \
1522 "\n -q Never output headers giving file names" \
1523 "\n -v Always output headers giving file names") \
1524
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001525#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001526 "$ head -n 2 /etc/passwd\n" \
1527 "root:x:0:0:root:/root:/bin/bash\n" \
1528 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001529
Glenn L McGrath60281112001-11-02 11:39:46 +00001530#define hexdump_trivial_usage \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001531 "[-bcCdefnosvx" USE_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001532#define hexdump_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001533 "Display file(s) or standard input in a user specified format\n" \
1534 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001535 "\n -b One-byte octal display" \
1536 "\n -c One-byte character display" \
1537 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1538 "\n -d Two-byte decimal display" \
1539 "\n -e FORMAT STRING" \
1540 "\n -f FORMAT FILE" \
1541 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1542 "\n -o Two-byte octal display" \
1543 "\n -s OFFSET Skip OFFSET bytes" \
1544 "\n -v Display all input data" \
1545 "\n -x Two-byte hexadecimal display" \
1546 USE_FEATURE_HEXDUMP_REVERSE( \
1547 "\n -R Reverse of 'hexdump -Cv'") \
1548
1549#define hd_trivial_usage \
1550 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001551#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001552 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001553
Eric Andersen7e9276b2001-02-22 01:15:47 +00001554#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001555 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001556#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001557 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001558
1559#define hostname_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001560 "[OPTION] [hostname | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001561#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001562 "Get or set hostname or DNS domain name\n" \
1563 "\nOptions:" \
1564 "\n -s Short" \
1565 "\n -i Addresses for the hostname" \
1566 "\n -d DNS domain name" \
1567 "\n -f Fully qualified domain name" \
1568 "\n -F FILE Use the contents of FILE to specify the hostname" \
1569
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001570#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001571 "$ hostname\n" \
1572 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001573
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001574#define httpd_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001575 "[-c conffile]" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001576 " [-p [ip:]port]" \
1577 " [-i] [-f] [-v[v]]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001578 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001579 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001580 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001581 " [-h home]" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001582 " [-d/-e string]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001583#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001584 "Listen for incoming HTTP requests\n" \
1585 "\nOptions:" \
1586 "\n -c FILE Configuration file (default httpd.conf)" \
1587 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
1588 "\n -i Inetd mode" \
1589 "\n -f Do not daemonize" \
1590 "\n -v[v] Verbose" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001591 USE_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001592 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001593 USE_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001594 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001595 USE_FEATURE_HTTPD_AUTH_MD5( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001596 "\n -m PASS Crypt PASS with md5 algorithm") \
1597 "\n -h HOME Home directory (default .)" \
1598 "\n -e STRING HTML encode STRING" \
1599 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001600
Robert Griebl1cd04452002-07-21 16:50:49 +00001601#define hwclock_trivial_usage \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001602 USE_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001603 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1604 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001605 " [-f FILE]" \
1606 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001607 SKIP_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001608 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1609 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001610#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001611 "Query and set hardware clock (RTC)\n" \
1612 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001613 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001614 "\n -s Set system time from hardware clock" \
1615 "\n -w Set hardware clock to system time" \
1616 "\n -u Hardware clock is in UTC" \
1617 "\n -l Hardware clock is in local time" \
1618 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001619
Eric Andersen7e9276b2001-02-22 01:15:47 +00001620#define id_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001621 "[OPTIONS]... [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001622#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001623 "Print information about USER or the current user\n" \
1624 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001625 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001626 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001627 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001628 "\n -u Print user ID" \
Denis Vlasenko4f3209b2008-09-13 12:51:10 +00001629 "\n -g Print group ID" \
1630 "\n -G Print supplementary group IDs" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001631 "\n -n Print name instead of a number" \
1632 "\n -r Print real user ID instead of effective ID" \
1633
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001634#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001635 "$ id\n" \
1636 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001637
Eric Andersen7e9276b2001-02-22 01:15:47 +00001638#define ifconfig_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001639 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001640#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001641 "Configure a network interface\n" \
1642 "\nOptions:" \
1643 "\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001644 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001645 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001646 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001647 " [del ADDRESS[/PREFIXLEN]]\n") \
1648 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1649 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001650 USE_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001651 " [outfill NN] [keepalive NN]\n") \
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001652 " " USE_FEATURE_IFCONFIG_HW("[hw ether" USE_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001653 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001654 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001655 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001656 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001657 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001658
Denis Vlasenko06aed432008-02-26 18:25:24 +00001659#define ifenslave_trivial_usage \
1660 "[-cdf] master-iface <slave-iface...>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001661#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001662 "Configure network interfaces for parallel routing\n" \
1663 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001664 "\n -c, --change-active Change active slave" \
1665 "\n -d, --detach Remove slave interface from bonding device" \
1666 "\n -f, --force Force, even if interface is not Ethernet" \
1667/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001668
Denis Vlasenko06aed432008-02-26 18:25:24 +00001669#define ifenslave_example_usage \
1670 "To create a bond device, simply follow these three steps :\n" \
1671 "- ensure that the required drivers are properly loaded :\n" \
1672 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
1673 "- assign an IP address to the bond device :\n" \
1674 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
1675 "- attach all the interfaces you need to the bond device :\n" \
1676 " # ifenslave bond0 eth0 eth1 eth2\n" \
1677 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1678 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
1679 " To detach a dead interface without setting the bond device down :\n" \
1680 " # ifenslave -d bond0 eth1\n\n" \
1681 " To set the bond device down and automatically release all the slaves :\n" \
1682 " # ifconfig bond0 down\n\n" \
1683 " To change active slave :\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001684 " # ifenslave -c bond0 eth0\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001685
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001686#define ifup_trivial_usage \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001687 "[-ain"USE_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001688#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001689 "Options:" \
1690 "\n -a De/configure all interfaces automatically" \
1691 "\n -i FILE Use FILE for interface definitions" \
1692 "\n -n Print out what would happen, but don't do it" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001693 USE_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001694 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001695 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001696 ) \
1697 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001698 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001699
1700#define ifdown_trivial_usage \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001701 "[-ain"USE_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001702#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001703 "Options:" \
1704 "\n -a De/configure all interfaces automatically" \
1705 "\n -i FILE Use FILE for interface definitions" \
1706 "\n -n Print out what would happen, but don't do it" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001707 USE_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001708 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001709 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001710 ) \
1711 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001712 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001713
Glenn L McGrath06e95652003-02-09 06:51:14 +00001714#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001715 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001716#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001717 "Listen for network connections and launch programs\n" \
1718 "\nOptions:" \
1719 "\n -f Run in foreground" \
1720 "\n -e Log to stderr" \
1721 "\n -q N Socket listen queue (default: 128)" \
1722 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001723 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001724
Eric Andersen7e9276b2001-02-22 01:15:47 +00001725#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001726 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001727#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001728 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001729
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001730#define init_notes_usage \
1731"This version of init is designed to be run only by the kernel.\n" \
1732"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001733"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001734"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001735"runlevels, use sysvinit.\n" \
1736"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001737"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001738"it has the following default behavior:\n" \
1739"\n" \
1740" ::sysinit:/etc/init.d/rcS\n" \
1741" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001742" ::ctrlaltdel:/sbin/reboot\n" \
1743" ::shutdown:/sbin/swapoff -a\n" \
1744" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001745" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001746"\n" \
1747"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1748"\n" \
1749" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001750" tty3::askfirst:/bin/sh\n" \
1751" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001752"\n" \
1753"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1754"\n" \
1755" <id>:<runlevels>:<action>:<process>\n" \
1756"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001757" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001758"\n" \
1759" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1760" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001761" the specified process to run on. The contents of this field are\n" \
1762" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1763" be unique, although if it isn't you may have strange results. If this\n" \
1764" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001765" note that if BusyBox detects that a serial console is in use, then only\n" \
1766" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001767" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001768" stinkin' utmp.\n" \
1769"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001770" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001771"\n" \
1772" The runlevels field is completely ignored.\n" \
1773"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001774" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001775"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001776" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001777" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001778"\n" \
1779" The available actions can be classified into two groups: actions\n" \
1780" that are run only once, and actions that are re-run when the specified\n" \
1781" process exits.\n" \
1782"\n" \
1783" Run only-once actions:\n" \
1784"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001785" 'sysinit' is the first item run on boot. init waits until all\n" \
1786" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001787" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001788" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001789" the specified task completes. 'once' actions are asynchronous,\n" \
1790" therefore, init does not wait for them to complete. 'restart' is\n" \
1791" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001792" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001793" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001794" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001795" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001796" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001797" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001798" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001799" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001800"\n" \
1801" Run repeatedly actions:\n" \
1802"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001803" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001804" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001805" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1806" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001807" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001808" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001809" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001810" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001811"\n" \
1812" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001813" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001814" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001815"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001816" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001817"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001818" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001819"\n" \
1820"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001821"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001822" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001823" #\n" \
1824" ::sysinit:/etc/init.d/rcS\n" \
1825" \n" \
1826" # /bin/sh invocations on selected ttys\n" \
1827" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001828" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001829" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001830" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001831" tty2::askfirst:-/bin/sh\n" \
1832" tty3::askfirst:-/bin/sh\n" \
1833" tty4::askfirst:-/bin/sh\n" \
1834" \n" \
1835" # /sbin/getty invocations for selected ttys\n" \
1836" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001837" tty4::respawn:/sbin/getty 38400 tty4\n" \
1838" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001839" \n" \
1840" \n" \
1841" # Example of how to put a getty on a serial line (for a terminal)\n" \
1842" #\n" \
1843" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1844" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1845" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001846" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001847" #::respawn:/sbin/getty 57600 ttyS2\n" \
1848" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001849" # Stuff to do when restarting the init process\n" \
1850" ::restart:/sbin/init\n" \
1851" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001852" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001853" ::ctrlaltdel:/sbin/reboot\n" \
1854" ::shutdown:/bin/umount -a -r\n" \
1855" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001856
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001857#define inotifyd_trivial_usage \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001858 "PROG FILE1[:MASK] ..."
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001859#define inotifyd_full_usage "\n\n" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001860 "Run PROG on filesystem changes." \
1861 "\nWhen a filesystem event matching MASK occurs on FILEn," \
1862 "\nPROG <actual_event(s)> <FILEn> [<subfile_name>] is run." \
Denis Vlasenko289ff0e2008-11-14 21:52:16 +00001863 "\nEvents:" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001864 "\n a File is accessed" \
1865 "\n c File is modified" \
1866 "\n e Metadata changed" \
1867 "\n w Writtable file is closed" \
1868 "\n 0 Unwrittable file is closed" \
1869 "\n r File is opened" \
Denis Vlasenkoa09a42c2008-11-17 22:19:18 +00001870 "\n D File is deleted" \
1871 "\n M File is moved" \
1872 "\n u Backing fs is unmounted" \
1873 "\n o Event queue overflowed" \
1874 "\n x File can't be watched anymore" \
1875 "\nIf watching a directory:" \
1876 "\n m Subfile is moved into dir" \
1877 "\n y Subfile is moved out of dir" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001878 "\n n Subfile is created" \
1879 "\n d Subfile is deleted" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001880 "\n" \
1881 "\ninotifyd waits for PROG to exit." \
1882 "\nWhen x event happens for all FILEs, inotifyd exits" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001883
Denis Vlasenko36309cf2008-11-22 18:29:01 +00001884/* 2.6 style insmod has no options and required filename
1885 * (not module name - .ko can't be omitted) */
Eric Andersen7e9276b2001-02-22 01:15:47 +00001886#define insmod_trivial_usage \
Denis Vlasenko36309cf2008-11-22 18:29:01 +00001887 USE_FEATURE_2_4_MODULES("[OPTION]... MODULE ") \
1888 SKIP_FEATURE_2_4_MODULES("FILE ") \
1889 "[symbol=value]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001890#define insmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001891 "Load the specified kernel modules into the kernel" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001892 USE_FEATURE_2_4_MODULES( "\n" \
1893 "\nOptions:" \
1894 "\n -f Force module to load into the wrong kernel version" \
1895 "\n -k Make module autoclean-able" \
1896 "\n -v Verbose" \
1897 "\n -q Quiet" \
1898 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001899 USE_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001900 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001901 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001902 "\n -o NAME Set internal module name to NAME" \
1903 "\n -x Do not export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001904 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001905
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00001906/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001907#define install_trivial_usage \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001908 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [source] dest|directory"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001909#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001910 "Copy files and set attributes\n" \
1911 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001912 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001913 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00001914 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001915 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001916 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001917 "\n -o USER Set ownership" \
1918 "\n -g GRP Set group ownership" \
1919 "\n -m MODE Set permissions" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001920 USE_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001921 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001922 )
Denis Vlasenko397de612008-03-17 08:55:44 +00001923
1924/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001925#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001926 "[OPTIONS] {" \
1927 USE_FEATURE_IP_ADDRESS("address | ") \
1928 USE_FEATURE_IP_ROUTE("route | ") \
1929 USE_FEATURE_IP_LINK("link | ") \
1930 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1931 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001932 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001933#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001934 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001935 "where OBJECT := {" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001936 USE_FEATURE_IP_ADDRESS("address | ") \
1937 USE_FEATURE_IP_ROUTE("route | ") \
1938 USE_FEATURE_IP_LINK("link | ") \
1939 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1940 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001941 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001942 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001943
1944#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001945 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001946 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001947#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001948 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001949 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
1950 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001951 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001952 " [broadcast ADDR] [anycast ADDR]\n" \
1953 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001954 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001955
Eric Andersende4f07e2003-12-11 01:18:07 +00001956#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001957 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001958#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001959 "Calculate IP network settings from a IP address\n" \
1960 "\nOptions:" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001961 USE_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001962 "\n -b,--broadcast Display calculated broadcast address" \
1963 "\n -n,--network Display calculated network address" \
1964 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001965 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001966 "\n -p,--prefix Display the prefix for IP/NETMASK" \
1967 "\n -h,--hostname Display first resolved host name" \
1968 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001969 ) \
1970 ) \
1971 SKIP_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001972 "\n -b Display calculated broadcast address" \
1973 "\n -n Display calculated network address" \
1974 "\n -m Display default netmask for IP" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001975 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001976 "\n -p Display the prefix for IP/NETMASK" \
1977 "\n -h Display first resolved host name" \
1978 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001979 ) \
1980 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001981
Rob Landley6eb1e412005-06-20 04:30:36 +00001982#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001983 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001984#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001985 "Upper-case options MQS remove an object by shmkey value.\n" \
1986 "Lower-case options remove an object by shmid value.\n" \
1987 "\nOptions:" \
1988 "\n -mM Remove memory segment after last detach" \
1989 "\n -qQ Remove message queue" \
1990 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001991
1992#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001993 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001994#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001995 " -i Show specific resource" \
1996 "\nResource specification:" \
1997 "\n -m Shared memory segments" \
1998 "\n -q Message queues" \
1999 "\n -s Semaphore arrays" \
2000 "\n -a All (default)" \
2001 "\nOutput format:" \
2002 "\n -t Time" \
2003 "\n -c Creator" \
2004 "\n -p Pid" \
2005 "\n -l Limits" \
2006 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002007
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002008#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002009 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002010#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00002011 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002012 " dynamic { on | off } |\n" \
2013 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002014 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002015
2016#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002017 "{ list | flush | { add | del | change | append |\n" \
2018 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002019#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002020 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002021 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
2022 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002023 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002024 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00002025 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
2026 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002027
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002028#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002029 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002030#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002031 "iprule [list | add | del] SELECTOR ACTION\n" \
2032 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2033 " [dev STRING] [pref NUMBER]\n" \
2034 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2035 " [prohibit | reject | unreachable]\n" \
2036 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002037 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002038
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002039#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002040 "{ add | change | del | show } [NAME]\n" \
2041 " [mode { ipip | gre | sit }]\n" \
2042 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002043#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002044 "iptunnel { add | change | del | show } [NAME]\n" \
2045 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2046 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002047 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002048
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002049#define kbd_mode_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002050 "[-a|k|s|u] [-C TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002051#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002052 "Report or set the keyboard mode\n" \
2053 "\nOptions set mode:" \
2054 "\n -a Default (ASCII)" \
2055 "\n -k Medium-raw (keyboard)" \
2056 "\n -s Raw (scancode)" \
2057 "\n -u Unicode (utf-8)" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002058 "\n -C TTY Affect TTY instead of /dev/tty" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002059
Eric Andersen7e9276b2001-02-22 01:15:47 +00002060#define kill_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002061 "[-l] [-SIG] PID..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002062#define kill_full_usage "\n\n" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002063 "Send a signal (default is TERM) to given PIDs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002064 "\nOptions:" \
2065 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002066/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002067
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002068#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002069 "$ ps | grep apache\n" \
2070 "252 root root S [apache]\n" \
2071 "263 www-data www-data S [apache]\n" \
2072 "264 www-data www-data S [apache]\n" \
2073 "265 www-data www-data S [apache]\n" \
2074 "266 www-data www-data S [apache]\n" \
2075 "267 www-data www-data S [apache]\n" \
2076 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002077
2078#define killall_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002079 "[-l] [-q] [-SIG] process-name..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002080#define killall_full_usage "\n\n" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002081 "Send a signal (default is TERM) to given processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002082 "\nOptions:" \
2083 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002084/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002085 "\n -q Do not complain if no processes were killed" \
2086
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002087#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002088 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002089
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002090#define killall5_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002091 "[-l] [-SIG]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002092#define killall5_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002093 "Send a signal (default is TERM) to all processes outside current session\n" \
2094 "\nOptions:" \
2095 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002096/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002097
Mark Whitley6317c4b2001-03-12 22:51:50 +00002098#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002099 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002100#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002101 "Kernel logger\n" \
2102 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002103 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002104 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002105
Eric Andersen7e9276b2001-02-22 01:15:47 +00002106#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002107 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002108#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002109 "Print STRING's length"
2110
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002111#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002112 "$ length Hello\n" \
2113 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002114
Rob Landley9200e792005-09-15 19:26:59 +00002115#define less_trivial_usage \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002116 "[-EMNmh~I?] [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002117#define less_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002118 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002119 "changed, and files can be manipulated in various ways.\n" \
2120 "\nOptions:" \
2121 "\n -E Quit once the end of a file is reached" \
2122 "\n -M,-m Display a status line containing the line numbers" \
2123 "\n and percentage through the file" \
2124 "\n -N Prefix line numbers to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002125 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002126 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002127
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002128#define linux32_trivial_usage NOUSAGE_STR
2129#define linux32_full_usage ""
2130#define linux64_trivial_usage NOUSAGE_STR
2131#define linux64_full_usage ""
2132
2133#define linuxrc_trivial_usage NOUSAGE_STR
2134#define linuxrc_full_usage ""
2135
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002136#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002137 "personality program [args...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002138#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002139 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002140 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002141 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002142
Eric Andersen7e9276b2001-02-22 01:15:47 +00002143#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002144 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002145#define ln_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002146 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002147 "Use '--' to indicate that all following arguments are non-options.\n" \
2148 "\nOptions:" \
2149 "\n -s Make symlinks instead of hardlinks" \
2150 "\n -f Remove existing destination files" \
2151 "\n -n Don't dereference symlinks - treat like normal file" \
2152 "\n -b Make a backup of the target (if exists) before link operation" \
2153 "\n -S suf Use suffix instead of ~ when making backup files" \
2154
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002155#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002156 "$ ln -s BusyBox /tmp/ls\n" \
2157 "$ ls -l /tmp/ls\n" \
2158 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002159
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002160#define load_policy_trivial_usage NOUSAGE_STR
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002161#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002162
Eric Andersen7e9276b2001-02-22 01:15:47 +00002163#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002164 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002165#define loadfont_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002166 "Load a console font from standard input" \
2167/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2168
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002169#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002170 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002171
2172#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002173 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002174#define loadkmap_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002175 "Load a binary keyboard translation table from standard input\n" \
2176/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2177
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002178#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002179 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002180
2181#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002182 "[OPTION]... [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002183#define logger_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002184 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n" \
2185 "\nOptions:" \
2186 "\n -s Log to stderr as well as the system log" \
2187 "\n -t TAG Log using the specified tag (defaults to user name)" \
2188 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002189
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002190#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002191 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002192
Robert Griebl1fca5582002-06-04 20:45:46 +00002193#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002194 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002195#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002196 "Begin a new session on the system\n" \
2197 "\nOptions:" \
2198 "\n -f Do not authenticate (user already authenticated)" \
2199 "\n -h Name of the remote host" \
2200 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002201
Eric Andersen7e9276b2001-02-22 01:15:47 +00002202#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002203 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002204#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002205 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002206#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002207 "$ logname\n" \
2208 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002209
Mark Whitley6317c4b2001-03-12 22:51:50 +00002210#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002211 "[OPTION]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002212#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002213 "Show messages in syslogd's circular buffer\n" \
2214 "\nOptions:" \
2215 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002216
Matt Kraai83788da2002-03-20 17:38:37 +00002217#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002218 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2219 " losetup -d LOOPDEV - disassociate\n" \
2220 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002221#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002222 "Options:" \
2223 "\n -o OFS Start OFS bytes into FILE" \
2224 "\n -f Show first free loop device" \
2225
Rob Landley1d589b22005-11-29 23:47:10 +00002226#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002227 "No arguments will display all current associations.\n" \
2228 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002229 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002230 "and filename of the file the loop device is currently bound to.\n\n" \
2231 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002232 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2233 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002234
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002235#define lpd_trivial_usage \
Denis Vlasenkoa7942892008-03-23 23:40:18 +00002236 "SPOOLDIR [HELPER [ARGS...]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002237#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002238 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2239 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002240 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002241 "\ndirectory and HELPER program is called. Name of file to print" \
2242 "\nis passed in $DATAFILE variable." \
2243 "\nExample:" \
2244 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002245
Denis Vlasenko68444b92008-02-22 22:24:48 +00002246#define lpq_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002247 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID...] [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002248#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002249 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002250 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002251 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002252 "\n -f Force any waiting job to be printed" \
2253 "\n -s Short display" \
2254
2255#define lpr_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002256 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE...]"
2257/* -C CLASS exists too, not shown.
2258 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002259#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002260 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002261 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002262 "\n -m Send mail on completion" \
2263 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002264 "\n -V Verbose" \
2265
Eric Andersen7e9276b2001-02-22 01:15:47 +00002266#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002267 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00002268 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002269 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
2270 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
2271 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
2272 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
2273 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
2274 USE_SELINUX("K") "] [filenames...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002275#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002276 "List directory contents\n" \
2277 "\nOptions:" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002278 "\n -1 List in a single column" \
2279 "\n -A Don't list . and .." \
2280 "\n -a Don't hide entries starting with ." \
2281 "\n -C List by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002282 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002283 "\n -c With -l: sort by ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002284 USE_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002285 "\n --color[={always,never,auto}] Control coloring") \
2286 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002287 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002288 "\n -e List full date and time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002289 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002290 "\n -F Append indicator (one of */=@|) to entries") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002291 "\n -i List inode numbers" \
2292 "\n -l Long listing format" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002293 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002294 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002295 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002296 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002297 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002298 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002299 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002300 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002301 "\n -r Sort in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002302 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002303 "\n -S Sort by file size") \
Denis Vlasenko397de612008-03-17 08:55:44 +00002304 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002305 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002306 "\n -T NUM Assume tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002307 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002308 "\n -t With -l: sort by modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002309 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002310 "\n -u With -l: sort by access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002311 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002312 "\n -v Sort by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002313 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002314 "\n -w NUM Assume the terminal is NUM columns wide") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002315 "\n -x List by lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002316 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002317 "\n -X Sort by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00002318 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002319 "\n -h List sizes in human readable format (1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002320 USE_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002321 "\n -k List security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002322 USE_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002323 "\n -K List security context in long format") \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002324 USE_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002325 "\n -Z List security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002326
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002327#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002328 "[-Radlv] [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002329#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002330 "List file attributes on an ext2 fs\n" \
2331 "\nOptions:" \
2332 "\n -R Recursively list subdirectories" \
2333 "\n -a Do not hide entries starting with ." \
2334 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002335 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002336 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002337
Eric Andersen7e9276b2001-02-22 01:15:47 +00002338#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002339 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002340#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002341 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002342
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002343#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002344#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002345 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002346#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002347 "Create a range of block or character special files" \
2348 "\n" \
2349 "\nTYPE is:" \
2350 "\n b Block device" \
2351 "\n c Character device" \
2352 "\n f FIFO, MAJOR and MINOR are ignored" \
2353 "\n" \
2354 "\nFIRST..LAST specify numbers appended to NAME." \
2355 "\nIf 's' is the last argument, the base device is created as well." \
2356 "\n" \
2357 "\nExamples:" \
2358 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2359 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002360#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002361 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2362 "[creates ttyS2-ttyS63]\n" \
2363 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2364 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002365#endif
2366
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002367#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002368#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002369 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002370#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002371 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002372 "Device table entries take the form of:\n" \
2373 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002374 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002375 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002376 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002377 " c Character device\n" \
2378 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002379 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002380 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002381 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2382 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002383#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002384 "For example:\n" \
2385 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2386 "/dev d 755 0 0 - - - - -\n" \
2387 "/dev/console c 666 0 0 5 1 - - -\n" \
2388 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2389 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2390 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2391 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2392 "Will Produce:\n" \
2393 "/dev\n" \
2394 "/dev/console\n" \
2395 "/dev/null\n" \
2396 "/dev/zero\n" \
2397 "/dev/hda\n" \
2398 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002399#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002400
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002401#define makemime_trivial_usage \
2402 "[OPTION]... [FILE]..."
2403#define makemime_full_usage "\n\n" \
2404 "Create MIME-encoded message\n" \
2405 "\nOptions:" \
2406 "\n -C Charset" \
Denis Vlasenkoc028ec22008-11-10 10:47:47 +00002407 "\n -e Transfer encoding. Ignored. base64 is assumed" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002408 "\n" \
2409 "\nOther options are silently ignored." \
2410
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002411#define man_trivial_usage \
2412 "[OPTION]... [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002413#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002414 "Format and display manual page\n" \
2415 "\nOptions:" \
2416 "\n -a Display all pages" \
2417 "\n -w Show page locations" \
2418
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002419#define matchpathcon_trivial_usage \
2420 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002421#define matchpathcon_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002422 " -n Do not display path" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002423 "\n -N Do not use translations" \
2424 "\n -f Use alternate file_context file" \
2425 "\n -p Use prefix to speed translations" \
2426 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002427
Eric Andersen7e9276b2001-02-22 01:15:47 +00002428#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002429 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002430 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002431#define md5sum_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002432 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002433 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2434 "\nOptions:" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002435 "\n -c Check sums against given list" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002436 "\n -s Don't output anything, status code shows success" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002437 "\n -w Warn about improperly formatted checksum lines" \
2438 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002439
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002440#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002441 "$ md5sum < busybox\n" \
2442 "6fd11e98b98a58f64ff3398d7b324003\n" \
2443 "$ md5sum busybox\n" \
2444 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2445 "$ md5sum -c -\n" \
2446 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2447 "busybox: OK\n" \
2448 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002449
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002450#define sha1sum_trivial_usage \
2451 "[OPTION] [FILEs...]" \
2452 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
2453#define sha1sum_full_usage "\n\n" \
2454 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
2455 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2456 "\nOptions:" \
2457 "\n -c Check sums against given list" \
2458 "\n -s Don't output anything, status code shows success" \
2459 "\n -w Warn about improperly formatted checksum lines" \
2460 )
2461
2462#define sha256sum_trivial_usage \
2463 "[OPTION] [FILEs...]" \
2464 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha256sum [OPTION] -c [FILE]")
2465#define sha256sum_full_usage "\n\n" \
2466 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
2467 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2468 "\nOptions:" \
2469 "\n -c Check sums against given list" \
2470 "\n -s Don't output anything, status code shows success" \
2471 "\n -w Warn about improperly formatted checksum lines" \
2472 )
2473
2474#define sha512sum_trivial_usage \
2475 "[OPTION] [FILEs...]" \
2476 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha512sum [OPTION] -c [FILE]")
2477#define sha512sum_full_usage "\n\n" \
2478 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
2479 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2480 "\nOptions:" \
2481 "\n -c Check sums against given list" \
2482 "\n -s Don't output anything, status code shows success" \
2483 "\n -w Warn about improperly formatted checksum lines" \
2484 )
2485
Rob Landley70f7ef72005-12-13 08:21:33 +00002486#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002487 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002488#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002489 " -s Scan /sys and populate /dev during system boot\n" \
2490 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002491 "Called with no options (via hotplug) it uses environment variables\n" \
2492 "to determine which device to add/remove."
Denis Vlasenko397de612008-03-17 08:55:44 +00002493
Rob Landleyef10d522006-06-26 14:11:33 +00002494#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002495 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002496 "The mdev config file contains lines that look like:\n" \
2497 " hd[a-z][0-9]* 0:3 660\n\n" \
2498 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002499 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002500 "Optionally, that can be followed (on the same line) by a special character\n" \
2501 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002502 "device(s). The environment variable $MDEV indicates the active device node\n" \
2503 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002504 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2505 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002506 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002507 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002508 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002509 "Config file parsing stops on the first matching line. If no config\n" \
2510 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002511 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002512 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002513
Glenn L McGrath061c9002002-09-16 04:21:46 +00002514#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002515 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002516#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002517 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002518 " y Allow write access to your terminal\n" \
2519 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002520
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002521#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002522 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002523#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002524 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2525 "\nOptions:" \
2526 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2527 "\n next byte to it" \
2528 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2529 "\n -s Set serial line to SPEED" \
2530 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002531
Eric Andersen7e9276b2001-02-22 01:15:47 +00002532#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002533 "[OPTION] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002534#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002535 "Create DIRECTORY\n" \
2536 "\nOptions:" \
2537 "\n -m Set permission mode (as in chmod), not rwxrwxrwx - umask" \
2538 "\n -p No error if existing, make parent directories as needed" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002539 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002540 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002541 )
2542
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002543#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002544 "$ mkdir /tmp/foo\n" \
2545 "$ mkdir /tmp/foo\n" \
2546 "/tmp/foo: File exists\n" \
2547 "$ mkdir /tmp/foo/bar/baz\n" \
2548 "/tmp/foo/bar/baz: No such file or directory\n" \
2549 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002550
Mike Frysinger6447ac02005-06-11 05:29:40 +00002551#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002552 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2553 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2554 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2555 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2556 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2557 "device [blocks-count]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002558#define mke2fs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002559 " -b size Block size in bytes" \
2560 "\n -c Check for bad blocks before creating" \
2561 "\n -E opts Set extended options" \
2562 "\n -f size Fragment size in bytes" \
2563 "\n -F Force (ignore sanity checks)" \
2564 "\n -g num Number of blocks in a block group" \
2565 "\n -i ratio The bytes/inode ratio" \
2566 "\n -j Create a journal (ext3)" \
2567 "\n -J opts Set journal options (size/device)" \
2568 "\n -l file Read bad blocks list from file" \
2569 "\n -L lbl Set the volume label" \
2570 "\n -m percent Percent of fs blocks to reserve for admin" \
2571 "\n -M dir Set last mounted directory" \
2572 "\n -n Do not actually create anything" \
2573 "\n -N num Number of inodes to create" \
2574 "\n -o os Set the 'creator os' field" \
2575 "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" \
2576 "\n -q Quiet" \
2577 "\n -r rev Set filesystem revision" \
2578 "\n -S Write superblock and group descriptors only" \
2579 "\n -T fs-type Set usage type (news/largefile/largefile4)" \
2580 "\n -v Verbose" \
Mike Frysinger6447ac02005-06-11 05:29:40 +00002581
Eric Andersen7e9276b2001-02-22 01:15:47 +00002582#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002583 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002584#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002585 "Create named pipe (identical to 'mknod name p')\n" \
2586 "\nOptions:" \
2587 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002588 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002589 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002590 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002591
Eric Andersen7e9276b2001-02-22 01:15:47 +00002592#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002593 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002594#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002595 "Make a MINIX filesystem\n" \
2596 "\nOptions:" \
2597 "\n -c Check device for bad blocks" \
2598 "\n -n [14|30] Maximum length of filenames" \
2599 "\n -i INODES Number of inodes for the filesystem" \
2600 "\n -l FILENAME Read bad blocks list from FILENAME" \
2601 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002602
Eric Andersen7e9276b2001-02-22 01:15:47 +00002603#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002604 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002605#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002606 "Create a special file (block, character, or pipe)\n" \
2607 "\nOptions:" \
2608 "\n -m Create the special file using the specified mode (default a=rw)" \
2609 "\nTYPEs include:" \
2610 "\n b: Make a block device" \
2611 "\n c or u: Make a character device" \
2612 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002613 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002614 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002615 )
2616
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002617#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002618 "$ mknod /dev/fd0 b 2 0\n" \
2619 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002620
Eric Andersen7e9276b2001-02-22 01:15:47 +00002621#define mkswap_trivial_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002622 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002623#define mkswap_full_usage "\n\n" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002624 "Prepare block device to be used as swap partition"
2625#if 0
2626 "[-c] [-v0|-v1] DEVICE [BLOCKS]"
Denis Vlasenko397de612008-03-17 08:55:44 +00002627 "\nOptions:"
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002628 "\n -c Check for readability"
2629 "\n -v0 Make swap version 0 (max 128M)"
2630 "\n -v1 Make swap version 1 (default for kernels > 2.1.117)"
2631 "\n BLOCKS Number of blocks to use (default is entire partition)"
2632#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002633
Eric Andersen7e9276b2001-02-22 01:15:47 +00002634#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002635 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002636#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002637 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002638 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002639 "\nOptions:" \
2640 "\n -d Make a directory instead of a file" \
2641/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2642 "\n -t Generate a path rooted in temporary directory" \
2643 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2644 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002645 "\nFor -t or -p, directory is chosen as follows:" \
2646 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002647
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002648#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002649 "$ mktemp /tmp/temp.XXXXXX\n" \
2650 "/tmp/temp.mWiLjM\n" \
2651 "$ ls -la /tmp/temp.mWiLjM\n" \
2652 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002653
Eric Andersen8d79ce82001-07-22 23:00:15 +00002654#define modprobe_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002655 "[-knqrsv] MODULE [symbol=value...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002656#define modprobe_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002657 "Options:" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002658 USE_FEATURE_2_4_MODULES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002659 "\n -k Make module autoclean-able" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002660 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002661 "\n -n Dry run" \
2662 "\n -q Quiet" \
2663 "\n -r Remove module (stacks) or do autoclean" \
2664 "\n -s Report via syslog instead of stderr" \
2665 "\n -v Verbose" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002666 USE_FEATURE_MODPROBE_BLACKLIST( \
2667 "\n -b Apply blacklist to module names too" \
2668 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002669
Rob Landley9c32a152005-12-11 20:12:24 +00002670#define modprobe_notes_usage \
2671"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2672"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2673"pass each module it loads.\n" \
2674"\n" \
2675"The configuration file is searched (in order) amongst:\n" \
2676"\n" \
2677" /etc/modprobe.conf (2.6 only)\n" \
2678" /etc/modules.conf\n" \
2679" /etc/conf.modules (deprecated)\n" \
2680"\n" \
2681"They all have the same syntax (see below). If none is present, it is\n" \
2682"_not_ an error; each loaded module is then expected to load without\n" \
2683"options. Once a file is found, the others are tested for.\n" \
2684"\n" \
2685"/etc/modules.conf entry format:\n" \
2686"\n" \
2687" alias <alias_name> <mod_name>\n" \
2688" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002689" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002690" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2691" This makes it also possible to use a different set of options (below) for\n" \
2692" the module and the alias.\n" \
2693" A module can be aliased more than once.\n" \
2694"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002695" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002696" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2697" the \"symbol=value\" pairs as option to that module.\n" \
2698"\n" \
2699"Sample /etc/modules.conf file:\n" \
2700"\n" \
2701" options tulip irq=3\n" \
2702" alias tulip tulip2\n" \
2703" options tulip2 irq=4 io=0x308\n" \
2704"\n" \
2705"Other functionality offered by 'classic' modprobe is not available in\n" \
2706"this implementation.\n" \
2707"\n" \
2708"If module options are present both in the config file, and on the command line,\n" \
2709"then the options from the command line will be passed to the module _after_\n" \
2710"the options from the config file. That way, you can have defaults in the config\n" \
2711"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002712#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002713 "(with the above /etc/modules.conf):\n\n" \
2714 "$ modprobe tulip\n" \
2715 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2716 "$ modprobe tulip irq=5\n" \
2717 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2718 "$ modprobe tulip2\n" \
2719 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2720 " which are the default for alias 'tulip2'\n\n" \
2721 "$ modprobe tulip2 irq=8\n" \
2722 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2723 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2724 " from the command line\n\n" \
2725 "$ modprobe tulip2 irq=2 io=0x210\n" \
2726 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2727 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2728 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002729
Eric Andersen7e9276b2001-02-22 01:15:47 +00002730#define more_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002731 "[FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002732#define more_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002733 "View FILE or standard input one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002734
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002735#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002736 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002737
Eric Andersen7e9276b2001-02-22 01:15:47 +00002738#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002739 "[flags] DEVICE NODE [-o options,more-options]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002740#define mount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002741 "Mount a filesystem. Filesystem autodetection requires /proc be mounted.\n" \
2742 "\nOptions:" \
2743 "\n -a Mount all filesystems in fstab" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002744 USE_FEATURE_MOUNT_FAKE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002745 "\n -f "USE_FEATURE_MTAB_SUPPORT("Update /etc/mtab, but ")"don't mount" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002746 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002747 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002748 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002749 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002750 "\n -r Read-only mount" \
2751 "\n -t fs-type Filesystem type" \
2752 "\n -w Read-write mount (default)" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002753 "\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002754 "-o option:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002755 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002756 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002757 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002758 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002759 " [a]sync Writes are asynchronous / synchronous\n" \
2760 " [no]atime Disable / enable updates to inode access times\n" \
2761 " [no]diratime Disable / enable atime updates to directories\n" \
Bernhard Reutner-Fischerfb5902c2008-08-06 18:14:38 +00002762 " [no]relatime Disable / enable atime updates relative to modification time\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002763 " [no]dev Allow use of special device files / disallow them\n" \
2764 " [no]exec Allow use of executable files / disallow them\n" \
2765 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2766 " [r]shared Convert [recursively] to a shared subtree\n" \
2767 " [r]slave Convert [recursively] to a slave subtree\n" \
2768 " [r]private Convert [recursively] to a private subtree\n" \
2769 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2770 " bind Bind a directory to an additional location\n" \
2771 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002772 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002773 " remount Remount a mounted filesystem, changing its flags\n" \
2774 " ro/rw Mount for read-only / read-write\n" \
2775 "\n" \
2776 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002777 "You'll have to see the written documentation for those filesystems" \
2778
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002779#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002780 "$ mount\n" \
2781 "/dev/hda3 on / type minix (rw)\n" \
2782 "proc on /proc type proc (rw)\n" \
2783 "devpts on /dev/pts type devpts (rw)\n" \
2784 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2785 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2786 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002787#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002788 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002789
Rob Landleyd00b3a52005-08-20 05:07:08 +00002790#define mountpoint_trivial_usage \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002791 "[-q] <[-dn] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002792#define mountpoint_full_usage "\n\n" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002793 "Check if the directory is a mountpoint\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002794 "\nOptions:" \
2795 "\n -q Quiet" \
2796 "\n -d Print major/minor device number of the filesystem" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002797 "\n -n Print device name of the filesystem" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002798 "\n -x Print major/minor device number of the blockdevice" \
2799
Rob Landleyd00b3a52005-08-20 05:07:08 +00002800#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002801 "$ mountpoint /proc\n" \
2802 "/proc is not a mountpoint\n" \
2803 "$ mountpoint /sys\n" \
2804 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002805
Eric Andersen7e9276b2001-02-22 01:15:47 +00002806#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002807 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002808#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002809 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002810 "\n" \
2811 "Available Opcodes:\n" \
2812 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002813 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2814 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2815 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002816 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002817
Eric Andersen7e9276b2001-02-22 01:15:47 +00002818#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002819 "[OPTION]... SOURCE DEST\n" \
2820 "or: mv [OPTION]... SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002821#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002822 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
2823 "\nOptions:" \
2824 "\n -f Don't prompt before overwriting" \
2825 "\n -i Interactive, prompt before overwrite" \
2826
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002827#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002828 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002829
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002830#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002831 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002832#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002833 "Rename network interface while it in the down state\n" \
2834 "\nOptions:" \
2835 "\n -c FILE Use configuration file (default is /etc/mactab)" \
2836 "\n -s Use syslog (LOCAL0 facility)" \
2837 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
2838
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002839#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002840 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2841 " or\n" \
2842 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002843
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002844#if !ENABLE_DESKTOP
2845
Rob Landley1cca9482006-07-10 19:45:20 +00002846#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002847#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002848#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002849#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002850#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002851
Eric Andersen7e9276b2001-02-22 01:15:47 +00002852#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002853 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002854 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002855#define nc_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002856 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002857 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002858 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002859 "\n -e Exec rest of command line after connect" \
2860 "\n -i SECS Delay interval for lines sent" \
2861 "\n -w SECS Timeout for connect" \
2862 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002863 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002864 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002865 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002866 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002867 "\n (use -l twice with -e for persistent server)") \
2868 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002869 )
2870
Rob Landley1cca9482006-07-10 19:45:20 +00002871#define nc_notes_usage "" \
2872 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002873 "To use netcat as a terminal emulator on a serial port:\n\n" \
2874 "$ stty 115200 -F /dev/ttyS0\n" \
2875 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2876 )
Rob Landley1cca9482006-07-10 19:45:20 +00002877
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002878#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002879 "$ nc foobar.somedomain.com 25\n" \
2880 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2881 "help\n" \
2882 "214-Commands supported:\n" \
2883 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2884 "214 NOOP QUIT RSET HELP\n" \
2885 "quit\n" \
2886 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002887
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002888#else /* DESKTOP nc - much more compatible with nc 1.10 */
2889
2890#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002891 "[-options] hostname port - connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002892 USE_NC_SERVER("\n" \
2893 "nc [-options] -l -p port [hostname] [port] - listen")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002894#define nc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002895 "Options:" \
2896 "\n -e prog [args] Program to exec after connect (must be last)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002897 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002898 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002899 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002900 "\n -n Don't do DNS resolution" \
2901 "\n -s addr Local address" \
2902 "\n -p port Local port" \
2903 "\n -u UDP mode" \
2904 "\n -v Verbose (cumulative: -vv)" \
2905 "\n -w secs Timeout for connects and final net reads" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002906 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002907 "\n -i sec Delay interval for lines sent" /* ", ports scanned" */ \
2908 "\n -o file Hex dump of traffic" \
2909 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002910 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002911/* "\n -r Randomize local and remote ports" */
2912/* "\n -g gateway Source-routing hop point[s], up to 8" */
2913/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002914/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2915
2916#endif
2917
Eric Andersen1552ff72001-10-31 11:07:12 +00002918#define netstat_trivial_usage \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00002919 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")USE_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002920#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002921 "Display networking information\n" \
2922 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002923 "\n -l Display listening server sockets" \
2924 "\n -a Display all sockets (default: connected)" \
2925 "\n -e Display other/more information" \
2926 "\n -n Don't resolve names" \
2927 "\n -t Tcp sockets" \
2928 "\n -u Udp sockets" \
2929 "\n -w Raw sockets" \
2930 "\n -x Unix sockets" \
2931 "\n -r Display routing table" \
2932 USE_FEATURE_NETSTAT_WIDE( \
2933 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00002934 ) \
2935 USE_FEATURE_NETSTAT_PRG( \
2936 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002937 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002938
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002939#define nice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002940 "[-n ADJUST] [COMMAND [ARG]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002941#define nice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002942 "Run a program with modified scheduling priority\n" \
2943 "\nOptions:" \
2944 "\n -n ADJUST Adjust the scheduling priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002945
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002946#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002947 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002948#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002949 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002950 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002951 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002952 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002953 "%[niface] Monitor network interface 'iface'\n" \
2954 "%m Monitor allocated memory\n" \
2955 "%[mf] Monitor free memory\n" \
2956 "%[mt] Monitor total memory\n" \
2957 "%s Monitor allocated swap\n" \
2958 "%f Monitor number of used file descriptors\n" \
2959 "%Ni Monitor total/specific IRQ rate\n" \
2960 "%x Monitor context switch rate\n" \
2961 "%p Monitor forks\n" \
2962 "%[pn] Monitor # of processes\n" \
2963 "%b Monitor block io\n" \
2964 "%Nt Show time (with N decimal points)\n" \
2965 "%Nd Milliseconds between updates (default=1000)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002966 "%r Print <cr> instead of <lf> at EOL" \
2967
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002968#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002969 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002970
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002971#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002972 "COMMAND [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002973#define nohup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002974 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002975#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002976 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002977
Eric Andersen7e9276b2001-02-22 01:15:47 +00002978#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002979 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002980#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002981 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002982 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002983#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002984 "$ nslookup localhost\n" \
2985 "Server: default\n" \
2986 "Address: default\n" \
2987 "\n" \
2988 "Name: debian\n" \
2989 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002990
Glenn L McGrath60281112001-11-02 11:39:46 +00002991#define od_trivial_usage \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002992 "[-aBbcDdeFfHhIiLlOovXx] " USE_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002993#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002994 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002995 "to standard output. With no FILE or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002996
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002997#define openvt_trivial_usage \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00002998 "[-c NUM] [-sw] [COMMAND [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002999#define openvt_full_usage "\n\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003000 "Start COMMAND on a new virtual terminal\n" \
3001 "\nOptions:" \
3002 "\n -c Use specified VT" \
3003 "\n -s Switch to the VT" \
3004/* "\n -l Run COMMAND as login shell (by prepending '-')" */ \
3005 "\n -w Wait for COMMAND to exit" \
3006
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003007#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003008 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003009
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003010#define parse_trivial_usage \
3011 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
3012#define parse_full_usage "\n\n" \
3013 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
3014
Eric Andersen27f64e12002-06-23 04:24:25 +00003015#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003016 "[OPTION] [name]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003017#define passwd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003018 "Change user's password. If no name is specified,\n" \
3019 "changes the password for the current user.\n" \
3020 "\nOptions:" \
3021 "\n -a Algorithm to use for password (choices: des, md5)" /* ", sha1)" */ \
3022 "\n -d Delete password for the account" \
3023 "\n -l Lock (disable) account" \
3024 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003025
Denis Vlasenko21d10142007-07-20 21:28:41 +00003026#define chpasswd_trivial_usage \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003027 USE_GETOPT_LONG("[--md5|--encrypted]") SKIP_GETOPT_LONG("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003028#define chpasswd_full_usage "\n\n" \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003029 "Read user:password information from stdin " \
Denis Vlasenko397de612008-03-17 08:55:44 +00003030 "and update /etc/passwd accordingly.\n" \
3031 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003032 USE_GETOPT_LONG( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003033 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003034 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003035 ) \
3036 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003037 "\n -e Supplied passwords are in encrypted form" \
3038 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003039 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00003040
Glenn L McGrath655d8142003-06-22 15:32:41 +00003041#define patch_trivial_usage \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003042 "[-p NUM] [-i DIFF] [-R]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003043#define patch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003044 " -p NUM Strip NUM leading components from file names" \
3045 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003046 "\n -R Reverse patch" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003047
Glenn L McGrath655d8142003-06-22 15:32:41 +00003048#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003049 "$ patch -p1 < example.diff\n" \
3050 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00003051
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003052#define pgrep_trivial_usage \
3053 "[-flnovx] pattern"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003054#define pgrep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003055 "Display process(es) selected by regex pattern\n" \
3056 "\nOptions:" \
3057 "\n -l Show command name too" \
3058 "\n -f Match against entire command line" \
3059 "\n -n Show the newest process only" \
3060 "\n -o Show the oldest process only" \
3061 "\n -v Negate the matching" \
3062 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003063
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003064#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00003065#define pidof_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003066 "[OPTION] [NAME...]"
3067#define USAGE_PIDOF "\n\nOptions:"
3068#else
3069#define pidof_trivial_usage \
3070 "[NAME...]"
3071#define USAGE_PIDOF /* none */
3072#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003073#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003074 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003075 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003076 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003077 "\n -s Show only one PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003078 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003079 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003080 "\n Use %PPID to omit pid of pidof's parent") \
3081
Eric Andersen221b2ea2001-07-31 19:06:07 +00003082#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003083 "$ pidof init\n" \
3084 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003085 USE_FEATURE_PIDOF_OMIT( \
3086 "$ pidof /bin/sh\n20351 5973 5950\n") \
3087 USE_FEATURE_PIDOF_OMIT( \
3088 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00003089
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003090#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003091#define ping_trivial_usage \
3092 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003093#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003094 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003095#define ping6_trivial_usage \
3096 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003097#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003098 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003099#else
3100#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003101 "[OPTION]... host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003102#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003103 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3104 "\nOptions:" \
3105 "\n -4, -6 Force IPv4 or IPv6 hostname resolution" \
3106 "\n -c CNT Send only CNT pings" \
3107 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
3108 "\n -I iface/IP Use interface or IP address as source" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003109 "\n -W timeout Seconds to wait for the first response (default:10)" \
3110 "\n (after all -c CNT packets are sent)" \
3111 "\n -w deadline Seconds until ping exits (default:infinite)" \
3112 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003113 "\n -q Quiet, only displays output at start" \
3114 "\n and when finished" \
3115
Eric Andersen51b8bd62002-07-03 11:46:38 +00003116#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003117 "[OPTION]... host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003118#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003119 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3120 "\nOptions:" \
3121 "\n -c CNT Send only CNT pings" \
3122 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
3123 "\n -I iface/IP Use interface or IP address as source" \
3124 "\n -q Quiet, only displays output at start" \
3125 "\n and when finished" \
3126
Eric Andersen51b8bd62002-07-03 11:46:38 +00003127#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003128#define ping_example_usage \
3129 "$ ping localhost\n" \
3130 "PING slag (127.0.0.1): 56 data bytes\n" \
3131 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3132 "\n" \
3133 "--- debian ping statistics ---\n" \
3134 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3135 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003136#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003137 "$ ping6 ip6-localhost\n" \
3138 "PING ip6-localhost (::1): 56 data bytes\n" \
3139 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3140 "\n" \
3141 "--- ip6-localhost ping statistics ---\n" \
3142 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3143 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003144
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003145#define pipe_progress_trivial_usage NOUSAGE_STR
3146#define pipe_progress_full_usage ""
3147
Eric Andersen7e9276b2001-02-22 01:15:47 +00003148#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003149 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003150#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003151 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003152 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003153
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003154#define pkill_trivial_usage \
3155 "[-l] | [-fnovx] [-signal] pattern"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003156#define pkill_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003157 "Send a signal to process(es) selected by regex pattern\n" \
3158 "\nOptions:" \
3159 "\n -l List all signals" \
3160 "\n -f Match against entire command line" \
3161 "\n -n Signal the newest process only" \
3162 "\n -o Signal the oldest process only" \
3163 "\n -v Negate the matching" \
3164 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003165
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003166#define popmaildir_trivial_usage \
3167 "[OPTIONS] Maildir [connection-helper ...]"
3168#define popmaildir_full_usage "\n\n" \
3169 "Fetch content of remote mailbox to local maildir\n" \
3170 "\nOptions:" \
3171 "\n -b Binary mode. Ignored" \
3172 "\n -d Debug. Ignored" \
3173 "\n -m Show used memory. Ignored" \
3174 "\n -V Show version. Ignored" \
3175 "\n -c Use tcpclient. Ignored" \
3176 "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" \
3177 "\n -s Skip authorization" \
3178 "\n -T Get messages with TOP instead with RETR" \
3179 "\n -k Keep retrieved messages on the server" \
3180 "\n -t timeout Set network timeout" \
3181 USE_FEATURE_POPMAILDIR_DELIVERY( \
3182 "\n -F \"program arg1 arg2 ...\" Filter by program. May be multiple" \
3183 "\n -M \"program arg1 arg2 ...\" Deliver by program" \
3184 ) \
3185 "\n -R size Remove old messages on the server >= size (in bytes). Ignored" \
3186 "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" \
3187 "\n -L size Do not retrieve new messages >= size (in bytes). Ignored" \
3188 "\n -H lines Type specified number of lines of a message. Ignored"
3189#define popmaildir_example_usage \
3190 "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n" \
3191 "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
3192
Eric Andersen7e9276b2001-02-22 01:15:47 +00003193#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003194 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003195#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003196 "Halt and shut off power\n" \
3197 "\nOptions:" \
3198 "\n -d Delay interval for halting" \
3199 "\n -n No call to sync()" \
3200 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003201
Mike Frysinger95d3c452005-04-21 23:29:24 +00003202#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003203 "[VARIABLES...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003204#define printenv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003205 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003206 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003207
Eric Andersen7e9276b2001-02-22 01:15:47 +00003208#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003209 "FORMAT [ARGUMENT...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003210#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003211 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003212 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003213#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003214 "$ printf \"Val=%d\\n\" 5\n" \
3215 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003216
Denis Vlasenko94949192006-11-05 00:45:47 +00003217
3218#if ENABLE_DESKTOP
3219
3220#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003221 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003222#define ps_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003223 "Report process status\n" \
3224 "\nOptions:" \
3225 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00003226
3227#else /* !ENABLE_DESKTOP */
3228
Denis Vlasenko397de612008-03-17 08:55:44 +00003229#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003230#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003231#else
3232#define USAGE_PS "\nOptions:"
3233#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003234
Eric Andersen7e9276b2001-02-22 01:15:47 +00003235#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003236 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003237#define ps_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003238 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003239 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003240 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003241 "\n -Z Show SE Linux context" \
3242 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003243 USE_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003244 "\n w Wide output" \
3245 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003246
Denis Vlasenko94949192006-11-05 00:45:47 +00003247#endif /* ENABLE_DESKTOP */
3248
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003249#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003250 "$ ps\n" \
3251 " PID Uid Gid State Command\n" \
3252 " 1 root root S init\n" \
3253 " 2 root root S [kflushd]\n" \
3254 " 3 root root S [kupdate]\n" \
3255 " 4 root root S [kpiod]\n" \
3256 " 5 root root S [kswapd]\n" \
3257 " 742 andersen andersen S [bash]\n" \
3258 " 743 andersen andersen S -bash\n" \
3259 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003260 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003261
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003262#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003263 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003264#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003265 "Scan a host, print all open ports\n" \
3266 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003267 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003268 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003269 "\n -p Scan from this port (default 1)" \
3270 "\n -P Scan up to this port (default 1024)" \
3271 "\n -t Timeout (default 5000 ms)" \
3272 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3273
Eric Andersen7e9276b2001-02-22 01:15:47 +00003274#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003275 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003276#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003277 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003278#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003279 "$ pwd\n" \
3280 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003281
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003282#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003283 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003284#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003285 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003286#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003287 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003288
Eric Andersen7e9276b2001-02-22 01:15:47 +00003289#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003290 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003291#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003292 "Get and possibly set the system date and time from a remote HOST\n" \
3293 "\nOptions:" \
3294 "\n -s Set the system date and time (default)" \
3295 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003296
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00003297#define rdev_trivial_usage \
3298 ""
3299#define rdev_full_usage "\n\n" \
3300 "Print the device node associated with the filesystem mounted at '/'"
3301#define rdev_example_usage \
3302 "$ rdev\n" \
3303 "/dev/mtdblock9 /\n"
3304
Rob Landley0e4690d2006-08-20 22:12:18 +00003305#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003306 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003307#define readahead_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003308 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
3309 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00003310
Eric Andersen7e9276b2001-02-22 01:15:47 +00003311#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003312 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003313#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003314 "Display the value of a symlink" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003315 USE_FEATURE_READLINK_FOLLOW( "\n" \
3316 "\nOptions:" \
3317 "\n -f Canonicalize by following all symlinks") \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003318
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003319#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003320 "[OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003321#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003322 "Options:" \
3323 "\n -m mapfile (Default: /boot/System.map)" \
3324 "\n -p profile (Default: /proc/profile)" \
3325 "\n -M mult Set the profiling multiplier to mult" \
3326 "\n -i Print only info about the sampling step" \
3327 "\n -v Verbose" \
3328 "\n -a Print all symbols, even if count is 0" \
3329 "\n -b Print individual histogram-bin counts" \
3330 "\n -s Print individual counters within functions" \
3331 "\n -r Reset all the counters (root only)" \
3332 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003333
Glenn L McGrath62fae302002-12-10 00:14:33 +00003334#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003335 "pathname..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003336#define realpath_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003337 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00003338
Eric Andersen7e9276b2001-02-22 01:15:47 +00003339#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003340 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003341#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003342 "Reboot the system\n" \
3343 "\nOptions:" \
3344 "\n -d Delay interval for rebooting" \
3345 "\n -n No call to sync()" \
3346 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003347
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003348#define reformime_trivial_usage \
3349 "[OPTION]... [FILE]..."
3350#define reformime_full_usage "\n\n" \
3351 "Parse MIME-encoded message\n" \
3352 "\nOptions:" \
3353 "\n -x prefix Extract content of MIME sections to files" \
3354 "\n -X prog [args] Filter content of MIME sections through prog." \
3355 "\n Must be the last option" \
3356 "\n" \
3357 "\nOther options are silently ignored." \
3358
Eric Andersen7e9276b2001-02-22 01:15:47 +00003359#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003360 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003361#define renice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003362 "Change priority of running processes\n" \
3363 "\nOptions:" \
3364 "\n -n Adjust current nice value (smaller is faster)" \
3365 "\n -p Process id(s) (default)" \
3366 "\n -g Process group id(s)" \
3367 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003368
Eric Andersen7e9276b2001-02-22 01:15:47 +00003369#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003370 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003371#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003372 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003373
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003374#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003375 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003376#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003377 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003378
Denis Vlasenko397137b2007-07-23 14:03:30 +00003379#define restorecon_trivial_usage \
3380 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003381#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003382 "Reset security contexts of files in pathname\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003383 "\n -i Ignore files that do not exist" \
3384 "\n -f file File with list of files to process. Use - for stdin" \
3385 "\n -e directory Directory to exclude" \
3386 "\n -R,-r Recurse directories" \
3387 "\n -n Don't change any file labels" \
3388 "\n -o file Save list of files with incorrect context" \
3389 "\n -v Verbose" \
3390 "\n -vv Show changed labels" \
3391 "\n -F Force reset of context to match file_context" \
3392 "\n for customizable files, or the user section," \
3393 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003394
Eric Andersen7e9276b2001-02-22 01:15:47 +00003395#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003396 "[OPTION]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003397#define rm_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003398 "Remove (unlink) the FILE(s). Use '--' to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003399 "indicate that all following arguments are non-options.\n" \
3400 "\nOptions:" \
3401 "\n -i Always prompt before removing" \
3402 "\n -f Never prompt" \
3403 "\n -r,-R Remove directories recursively" \
3404
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003405#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003406 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003407
Eric Andersen7e9276b2001-02-22 01:15:47 +00003408#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003409 "[OPTION]... DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003410#define rmdir_full_usage "\n\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003411 "Remove the DIRECTORY, if it is empty.\n" \
3412 "\nOptions:" \
3413 USE_FEATURE_RMDIR_LONG_OPTIONS( \
3414 "\n -p|--parents Include parents" \
3415 "\n -ignore-fail-on-non-empty" \
3416 ) \
3417 SKIP_FEATURE_RMDIR_LONG_OPTIONS( \
3418 "\n -p Include parents" \
3419 )
3420
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003421#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003422 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003423
Eric Andersen7e9276b2001-02-22 01:15:47 +00003424#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003425 "[OPTION]... [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003426#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003427 "Unload the specified kernel modules from the kernel\n" \
3428 "\nOptions:" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003429 "\n -w Wait until the module is no longer used" \
3430 "\n -f Force unloading" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003431 "\n -a Remove all unused modules (recursively)" \
3432
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003433#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003434 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003435
Eric Andersen7e9276b2001-02-22 01:15:47 +00003436#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003437 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003438#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003439 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003440 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003441 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003442 "\n -e Display other/more information" \
3443 "\n -A inet" USE_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003444
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003445#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003446 "-i -q[ildc]p package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003447#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003448 "Manipulate RPM packages\n" \
3449 "\nOptions:" \
3450 "\n -i Install package" \
3451 "\n -q Query package" \
3452 "\n -p Query uninstalled package" \
3453 "\n -i Show information" \
3454 "\n -l List contents" \
3455 "\n -d List documents" \
3456 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003457
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003458#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003459 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003460#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003461 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003462
Mike Frysinger6b160e42008-02-15 02:27:19 +00003463#define rtcwake_trivial_usage \
3464 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SECS | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003465#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003466 "Enter a system sleep state until specified wakeup time\n" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003467 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003468 "\n -a,--auto Read clock mode from adjtime" \
3469 "\n -l,--local Clock is set to local time" \
3470 "\n -u,--utc Clock is set to UTC time" \
3471 "\n -d,--device=DEV Specify the RTC device" \
Mike Frysinger1e93f3c2008-06-04 10:33:33 +00003472 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003473 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
3474 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003475 ) \
3476 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003477 "\n -a Read clock mode from adjtime" \
3478 "\n -l Clock is set to local time" \
3479 "\n -u Clock is set to UTC time" \
3480 "\n -d DEV Specify the RTC device" \
3481 "\n -m MODE Set the sleep state (default: standby)" \
3482 "\n -s SEC Set the timeout in SEC seconds from now" \
3483 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003484 )
3485
Denis Vlasenko49622d72007-03-10 16:58:49 +00003486#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003487 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3488 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003489#define runcon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003490 "Run a program in a different security context\n" \
3491 "\n CONTEXT Complete security context\n" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003492 USE_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003493 "\n -c,--compute Compute process transition context before modifying" \
3494 "\n -t,--type=TYPE Type (for same role as parent)" \
3495 "\n -u,--user=USER User identity" \
3496 "\n -r,--role=ROLE Role" \
3497 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003498 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003499 SKIP_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003500 "\n -c Compute process transition context before modifying" \
3501 "\n -t TYPE Type (for same role as parent)" \
3502 "\n -u USER User identity" \
3503 "\n -r ROLE Role" \
3504 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003505 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003506
Eric Andersen6cf47a72001-10-31 10:24:36 +00003507#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003508 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003509#define run_parts_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003510 "Run a bunch of scripts in a directory\n" \
3511 "\nOptions:" \
3512 "\n -t Print what would be run, but don't actually run anything" \
3513 "\n -a ARG Pass ARG as argument for every program" \
3514 "\n -u MASK Set the umask to MASK before running every program" \
3515 USE_FEATURE_RUN_PARTS_FANCY( \
3516 "\n -l Print names of all matching files even if they are not executable" \
3517 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003518
3519#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003520 "$ run-parts -a start /etc/init.d\n" \
3521 "$ run-parts -a stop=now /etc/init.d\n\n" \
3522 "Let's assume you have a script foo/dosomething:\n" \
3523 "#!/bin/sh\n" \
3524 "for i in $*; do eval $i; done; unset i\n" \
3525 "case \"$1\" in\n" \
3526 "start*) echo starting something;;\n" \
3527 "stop*) set -x; shutdown -h $stop;;\n" \
3528 "esac\n\n" \
3529 "Running this yields:\n" \
3530 "$run-parts -a stop=+4m foo/\n" \
3531 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003532
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003533#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003534 "[utmp]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003535#define runlevel_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003536 "Find the current and previous system runlevel.\n\n" \
3537 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003538 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003539#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003540 "$ runlevel /var/run/utmp\n" \
3541 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003542
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003543#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003544 "dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003545#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003546 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003547
3548#define runsvdir_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003549 "[-P] [-s SCRIPT] dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003550#define runsvdir_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003551 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
3552 "\n -P Put each runsv in a new session" \
3553 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003554
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003555#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003556 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003557#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003558 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003559#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003560 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003561
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003562#define script_trivial_usage \
3563 "[-afq] [-c COMMAND] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003564#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003565 "Options:" \
3566 "\n -a Append output" \
3567 "\n -c Run COMMAND, not shell" \
3568 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003569 "\n -q Quiet" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003570
Eric Andersen7e9276b2001-02-22 01:15:47 +00003571#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003572 "[-efinr] pattern [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003573#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003574 "Options:" \
3575 "\n -e script Add the script to the commands to be executed" \
3576 "\n -f scriptfile Add scriptfile contents to the" \
3577 "\n commands to be executed" \
3578 "\n -i Edit files in-place" \
3579 "\n -n Suppress automatic printing of pattern space" \
3580 "\n -r Use extended regular expression syntax" \
3581 "\n" \
3582 "\nIf no -e or -f is given, the first non-option argument is taken as the sed" \
3583 "\nscript to interpret. All remaining arguments are names of input files; if no" \
3584 "\ninput files are specified, then the standard input is read. Source files" \
3585 "\nwill not be modified unless -i option is given." \
Eric Andersenf802ff72004-04-12 15:12:06 +00003586
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003587#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003588 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3589 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003590
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003591#define selinuxenabled_trivial_usage NOUSAGE_STR
3592#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003593
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003594#define sendmail_trivial_usage \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003595 "[OPTIONS] [rcpt]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003596#define sendmail_full_usage "\n\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003597 "Send an email\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003598 "\nOptions:" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003599 "\n -w timeout Network timeout" \
3600 "\n -H [user:pass@]server[:port] Server" \
3601 "\n -S Use openssl connection helper for secure servers" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003602 "\n -N type Request delivery notification. Type is ignored" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003603 "\n -f sender Sender" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003604 "\n -F fullname Sender full name. Overrides $NAME" \
3605 USE_FEATURE_SENDMAIL_MAILX( \
3606 "\n -s subject Subject" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003607 "\n -j charset Assume charset for body and subject (" CONFIG_FEATURE_MIME_CHARSET ")" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003608 "\n -a file File to attach. May be multiple" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003609 "\n -H \"prog args...\" Use external connection helper. E.g. openssl for secure servers" \
3610 "\n -S server[:port] Server" \
3611 ) \
3612 USE_FEATURE_SENDMAIL_MAILXX( \
3613 "\n -c rcpt Cc: recipient. May be multiple" \
Denis Vlasenko2b2d9772008-09-28 13:50:57 +00003614 "\n -e rcpt Errors-To: recipient" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003615 ) \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003616 "\n -t Read recipients and subject from body" \
3617 "\n" \
3618 "\nOther options are silently ignored; -oi is implied" \
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003619
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003620#define seq_trivial_usage \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003621 "[-w] [-s SEP] [FIRST [INC]] LAST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003622#define seq_full_usage "\n\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003623 "Print numbers from FIRST to LAST, in steps of INC.\n" \
3624 "FIRST, INC default to 1\n" \
3625 "\nOptions:" \
3626 "\n -w Pad to last with leading zeros" \
3627 "\n -s SEP String separator" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003628
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003629#define sestatus_trivial_usage \
3630 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003631#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003632 " -v Verbose" \
3633 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003634
Paul Foxfc2256a2005-08-01 18:12:30 +00003635#define setconsole_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003636 "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003637#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003638 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3639 "\nOptions:" \
3640 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003641
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003642#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003643 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003644#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003645
Denis Vlasenko397137b2007-07-23 14:03:30 +00003646#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003647 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003648 USE_FEATURE_SETFILES_CHECK_OPTION( \
3649 " [-c policyfile] spec_file" \
3650 ) \
3651 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003652#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003653 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003654 USE_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003655 "\n -c file Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003656 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003657 "\n -d Show which specification matched each file" \
3658 "\n -l Log changes in file labels to syslog" \
3659 "\n -n Don't change any file labels" \
3660 "\n -q Suppress warnings" \
3661 "\n -r dir Use an altenate root path" \
3662 "\n -e dir Exclude directory" \
3663 "\n -F Force reset of context to match file_context for customizable files" \
3664 "\n -o file Save list of files with incorrect context" \
3665 "\n -s Take a list of files from standard input (instead of command line)" \
3666 "\n -v Show changes in file labels, if type or role are changing" \
3667 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3668 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003669
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003670#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003671 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003672#define setfont_full_usage "\n\n" \
3673 "Load a console font\n" \
3674 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003675 "\n -m MAPFILE Load console screen map" \
3676 "\n -C TTY Affect TTY instead of /dev/tty" \
3677
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003678#define setfont_example_usage \
3679 "$ setfont -m koi8-r /etc/i18n/fontname\n"
3680
Eric Andersen7e9276b2001-02-22 01:15:47 +00003681#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003682 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003683#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003684 "Set entries into the kernel's scancode-to-keycode map,\n" \
3685 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3686 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003687 "and KEYCODE is given in decimal" \
3688
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003689#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003690 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003691
Rob Landley87848d92006-03-27 23:23:43 +00003692#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003693 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003694#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003695 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003696
Denis Vlasenkobe039372007-10-14 04:48:44 +00003697#define setsebool_trivial_usage \
3698 "boolean value"
3699
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003700#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00003701 "Change boolean setting"
3702
Paul Fox42403642005-08-01 22:52:09 +00003703#define setsid_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003704 "PROG [ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003705#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003706 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3707 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3708 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003709
Matt Kraai2d91deb2001-08-01 17:21:35 +00003710#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003711 "[FILE]...\n" \
3712 "or: sh -c command [args]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003713#define lash_full_usage "\n\n" \
Denis Vlasenko96702ca2007-11-23 23:28:55 +00003714 "lash is deprecated, please use hush"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003715
Eric Andersen2e9c2572003-08-08 22:26:06 +00003716#define last_trivial_usage \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003717 ""USE_FEATURE_LAST_FANCY("[-HW] [-f file]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003718#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003719 "Show listing of the last users that logged into the system" \
3720 USE_FEATURE_LAST_FANCY( "\n" \
3721 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00003722/* "\n -H Show header line" */ \
3723 "\n -W Display with no host column truncation" \
3724 "\n -f file Read from file instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003725 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00003726
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00003727#define showkey_trivial_usage \
3728 "[-a | -k | -s]"
3729#define showkey_full_usage "\n\n" \
3730 "Show keys pressed\n" \
3731 "\nOptions:" \
3732 "\n -a Display decimal/octal/hex values of the keys" \
3733 "\n -k Display interpreted keycodes (default)" \
3734 "\n -s Display raw scan-codes" \
3735
Denis Vlasenko14923db2007-06-20 15:23:03 +00003736#define slattach_trivial_usage \
3737 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003738#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003739 "Attach network interface(s) to serial line(s)\n" \
3740 "\nOptions:" \
3741 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3742 "\n -s Set line speed" \
3743 "\n -e Exit after initializing device" \
3744 "\n -h Exit when the carrier is lost" \
3745 "\n -c Execute a command when the line is hung up" \
3746 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3747 "\n -L Enable 3-wire operation" \
3748 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003749
Eric Andersen7e9276b2001-02-22 01:15:47 +00003750#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003751 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003752#define sleep_full_usage "\n\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003753 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003754 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003755 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003756 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003757#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003758 "$ sleep 2\n" \
3759 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003760 USE_FEATURE_FANCY_SLEEP( \
3761 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003762 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003763
Eric Andersen7e9276b2001-02-22 01:15:47 +00003764#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003765 "[-nru" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003766 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003767 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003768#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003769 "Sort lines of text\n" \
3770 "\nOptions:" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003771 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003772 "\n -b Ignore leading blanks" \
3773 "\n -c Check whether input is sorted" \
3774 "\n -d Dictionary order (blank or alphanumeric only)" \
3775 "\n -f Ignore case" \
3776 "\n -g General numerical sort" \
3777 "\n -i Ignore unprintable characters" \
3778 "\n -k Sort key" \
3779 "\n -M Sort month" \
3780 ) \
3781 "\n -n Sort numbers" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003782 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003783 "\n -o Output to file" \
3784 "\n -k Sort by key" \
3785 "\n -t CHAR Key separator" \
3786 ) \
3787 "\n -r Reverse sort order" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003788 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003789 "\n -s Stable (don't sort ties alphabetically)" \
3790 ) \
3791 "\n -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003792 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003793 "\n -z Lines are terminated by NUL, not newline" \
3794 "\n -mST Ignored for GNU compatibility") \
3795
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003796#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003797 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3798 "a\n" \
3799 "b\n" \
3800 "c\n" \
3801 "d\n" \
3802 "e\n" \
3803 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003804 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003805 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3806 "d 2\n" \
3807 "b 2\n" \
3808 "c 3\n" \
3809 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003810 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003811
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003812#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003813 "[OPTION] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003814#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003815 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003816 "\n -b n[k|m] Split by bytes" \
3817 "\n -l n Split by lines" \
3818 "\n -a n Use n letters as suffix" \
3819
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003820#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003821 "$ split TODO foo\n" \
3822 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003823
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003824#define start_stop_daemon_trivial_usage \
Denis Vlasenko7987a182008-07-01 10:00:46 +00003825 "[OPTIONS] [-S|-K] ... [-- arguments...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003826#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003827 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003828 "-K: stop all matching processes.\n" \
3829 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003830 USE_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003831 "\nProcess matching:" \
3832 "\n -u,--user USERNAME|UID Match only this user's processes" \
3833 "\n -n,--name NAME Match processes with NAME" \
3834 "\n in comm field in /proc/PID/stat" \
3835 "\n -x,--exec EXECUTABLE Match processes with this command" \
3836 "\n in /proc/PID/cmdline" \
3837 "\n -p,--pidfile FILE Match a process with PID from the file" \
3838 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003839 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003840 "\n -x,--exec EXECUTABLE Program to run" \
3841 "\n -a,--startas NAME Zeroth argument" \
3842 "\n -b,--background Background" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003843 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003844 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003845 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003846 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
3847 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003848 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003849 "\n -s,--signal SIG Signal to send" \
3850 "\n -t,--test Match only, exit with 0 if a process is found" \
3851 "\nOther:" \
3852 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3853 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003854 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003855 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003856 "\n -q,--quiet Quiet" \
3857 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003858 SKIP_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003859 "\nProcess matching:" \
3860 "\n -u USERNAME|UID Match only this user's processes" \
3861 "\n -n NAME Match processes with NAME" \
3862 "\n in comm field in /proc/PID/stat" \
3863 "\n -x EXECUTABLE Match processes with this command" \
3864 "\n command in /proc/PID/cmdline" \
3865 "\n -p FILE Match a process with PID from the file" \
3866 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003867 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003868 "\n -x EXECUTABLE Program to run" \
3869 "\n -a NAME Zeroth argument" \
3870 "\n -b Background" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003871 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003872 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003873 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003874 "\n -c USER[:[GRP]] Change to user/group" \
3875 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003876 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003877 "\n -s SIG Signal to send" \
3878 "\n -t Match only, exit with 0 if a process is found" \
3879 "\nOther:" \
3880 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3881 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003882 "\n -v Verbose" \
3883 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003884 "\n -q Quiet" \
3885 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003886
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003887#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003888 "[OPTION] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003889#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003890 "Display file (default) or filesystem status\n" \
3891 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003892 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003893 "\n -c fmt Use the specified format" \
3894 ) \
3895 "\n -f Display filesystem status" \
3896 "\n -L Dereference links" \
3897 "\n -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003898 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003899 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003900 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003901 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003902 "\n\nValid format sequences for files:\n" \
3903 " %a Access rights in octal\n" \
3904 " %A Access rights in human readable form\n" \
3905 " %b Number of blocks allocated (see %B)\n" \
3906 " %B The size in bytes of each block reported by %b\n" \
3907 " %d Device number in decimal\n" \
3908 " %D Device number in hex\n" \
3909 " %f Raw mode in hex\n" \
3910 " %F File type\n" \
3911 " %g Group ID of owner\n" \
3912 " %G Group name of owner\n" \
3913 " %h Number of hard links\n" \
3914 " %i Inode number\n" \
3915 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003916 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003917 " %o I/O block size\n" \
3918 " %s Total size, in bytes\n" \
3919 " %t Major device type in hex\n" \
3920 " %T Minor device type in hex\n" \
3921 " %u User ID of owner\n" \
3922 " %U User name of owner\n" \
3923 " %x Time of last access\n" \
3924 " %X Time of last access as seconds since Epoch\n" \
3925 " %y Time of last modification\n" \
3926 " %Y Time of last modification as seconds since Epoch\n" \
3927 " %z Time of last change\n" \
3928 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003929 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003930 " %a Free blocks available to non-superuser\n" \
3931 " %b Total data blocks in file system\n" \
3932 " %c Total file nodes in file system\n" \
3933 " %d Free file nodes in file system\n" \
3934 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003935 USE_SELINUX( \
3936 " %C Security context in SELinux\n" \
3937 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003938 " %i File System ID in hex\n" \
3939 " %l Maximum length of filenames\n" \
3940 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003941 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003942 " %S Fundamental block size (for block counts)\n" \
3943 " %t Type in hex\n" \
3944 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003945 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003946
Eric Andersenef5e8f82002-11-07 02:09:37 +00003947#define strings_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003948 "[-afo] [-n length] [file...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003949#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003950 "Display printable strings in a binary file\n" \
3951 "\nOptions:" \
3952 "\n -a Scan whole file (default)" \
3953 "\n -f Precede strings with filenames" \
3954 "\n -n N At least N characters form a string (default 4)" \
3955 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00003956
Eric Andersen7e9276b2001-02-22 01:15:47 +00003957#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003958 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003959#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003960 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003961 "and deviations from stty sane\n" \
3962 "\nOptions:" \
3963 "\n -F DEVICE Open device instead of stdin" \
3964 "\n -a Print all current settings in human-readable form" \
3965 "\n -g Print in stty-readable form" \
3966 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003967
Robert Griebl1fca5582002-06-04 20:45:46 +00003968#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003969 "[OPTION]... [-] [username]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003970#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003971 "Change user id or become root\n" \
3972 "\nOptions:" \
3973 "\n -p, -m Preserve environment" \
3974 "\n -c Command to pass to 'sh -c'" \
3975 "\n -s Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00003976
Eric Andersen27f64e12002-06-23 04:24:25 +00003977#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003978 "[OPTION]... [tty-device]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003979#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003980 "Single user login\n" \
3981 "\nOptions:" \
3982 "\n -t Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003983
Mike Frysinger95d3c452005-04-21 23:29:24 +00003984#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003985 "[rs] [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003986#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003987 "Checksum and count the blocks in a file\n" \
3988 "\nOptions:" \
3989 "\n -r Use BSD sum algorithm (1K blocks)" \
3990 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00003991
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003992#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003993 "[-v] [-w sec] command service..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003994#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003995 "Control services monitored by runsv supervisor.\n" \
3996 "Commands (only first character is enough):\n" \
3997 "\n" \
3998 "status: query service status\n" \
3999 "up: if service isn't running, start it. If service stops, restart it\n" \
4000 "once: like 'up', but if service stops, don't restart it\n" \
4001 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004002 " if it exists. After it stops, do not restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004003 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004004 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004005 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004006 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004007
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004008#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004009 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004010#define svlogd_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004011 "Continuously read log data from standard input, optionally " \
4012 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko397de612008-03-17 08:55:44 +00004013 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004014
Eric Andersen7e9276b2001-02-22 01:15:47 +00004015#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004016 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004017#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004018 "Stop swapping on DEVICE\n" \
4019 "\nOptions:" \
4020 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004021
Eric Andersen7e9276b2001-02-22 01:15:47 +00004022#define swapon_trivial_usage \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004023 "[-a]" USE_FEATURE_SWAPON_PRI(" [-p pri]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004024#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004025 "Start swapping on DEVICE\n" \
4026 "\nOptions:" \
4027 "\n -a Start swapping on all swap devices" \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004028 USE_FEATURE_SWAPON_PRI( \
4029 "\n -p pri Set swap device priority" \
4030 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004031
Rob Landley0f34a822005-10-27 22:55:50 +00004032#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004033 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004034#define switch_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004035 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004036 "and exec NEW_INIT\n" \
4037 "\nOptions:" \
4038 "\n -c Redirect console to device on new root" \
Rob Landley0f34a822005-10-27 22:55:50 +00004039
Eric Andersen7e9276b2001-02-22 01:15:47 +00004040#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004041 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004042#define sync_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004043 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004044
Eric Andersenb9050282003-12-24 06:02:11 +00004045#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004046 "[OPTIONS]... [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004047#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004048 "Configure kernel parameters at runtime\n" \
4049 "\nOptions:" \
4050 "\n -n Disable printing of key names" \
4051 "\n -e Don't warn about unknown keys" \
4052 "\n -w Change sysctl setting" \
4053 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
4054 "\n -a Display all values" \
4055 "\n -A Display all values in table form" \
4056
Eric Andersen5d38f5b2005-09-12 21:42:48 +00004057#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00004058 "sysctl [-n] [-e] variable...\n" \
4059 "sysctl [-n] [-e] -w variable=value...\n" \
4060 "sysctl [-n] [-e] -a\n" \
4061 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
4062 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00004063
Eric Andersen7e9276b2001-02-22 01:15:47 +00004064#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004065 "[OPTION]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004066#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004067 "System logging utility.\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004068 "Note that this version of syslogd ignores /etc/syslog.conf.\n" \
4069 "\nOptions:" \
4070 "\n -n Run in foreground" \
4071 "\n -O FILE Log to given file (default=/var/log/messages)" \
4072 "\n -l n Set local log level" \
4073 "\n -S Smaller logging output" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004074 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004075 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
4076 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004077 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004078 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
4079 "\n -L Log locally and via network (default is network only if -R)") \
4080 USE_FEATURE_SYSLOGD_DUP( \
4081 "\n -D Drop duplicates") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004082 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004083 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00004084 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004085/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00004086
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004087#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004088 "$ syslogd -R masterlog:514\n" \
4089 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004090
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004091#define tac_trivial_usage \
4092 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004093#define tac_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004094 "Concatenate FILE(s) and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004095
Eric Andersen7e9276b2001-02-22 01:15:47 +00004096#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004097 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004098#define tail_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004099 "Print last 10 lines of each FILE to standard output.\n" \
4100 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004101 "file name. With no FILE, or when FILE is -, read standard input.\n" \
4102 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004103 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004104 "\n -c N[kbm] Output the last N bytes") \
4105 "\n -n N[kbm] Print last N lines instead of last 10" \
4106 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004107 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004108 "\n -q Never output headers giving file names" \
4109 "\n -s SEC Wait SEC seconds between reads with -f" \
4110 "\n -v Always output headers giving file names" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004111 "\n" \
4112 "\nIf the first character of N (bytes or lines) is a '+', output begins with" \
4113 "\nthe Nth item from the start of each file, otherwise, print the last N items" \
4114 "\nin the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004115
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004116#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004117 "$ tail -n 1 /etc/resolv.conf\n" \
4118 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004119
Eric Andersen7e9276b2001-02-22 01:15:47 +00004120#define tar_trivial_usage \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004121 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_SEAMLESS_GZ("z") \
4122 USE_FEATURE_SEAMLESS_BZ2("j") USE_FEATURE_SEAMLESS_LZMA("a") \
4123 USE_FEATURE_SEAMLESS_Z("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00004124 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004125 "[-f TARFILE] [-C DIR] [FILE(s)]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004126#define tar_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004127 "Create, extract, or list files from a tar file\n" \
4128 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004129 USE_FEATURE_TAR_CREATE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004130 "\n c Create") \
4131 "\n x Extract" \
4132 "\n t List" \
4133 "\nArchive format selection:" \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004134 USE_FEATURE_SEAMLESS_GZ( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004135 "\n z Filter the archive through gzip" \
4136 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004137 USE_FEATURE_SEAMLESS_BZ2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004138 "\n j Filter the archive through bzip2" \
4139 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004140 USE_FEATURE_SEAMLESS_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004141 "\n a Filter the archive through lzma" \
4142 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004143 USE_FEATURE_SEAMLESS_Z( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004144 "\n Z Filter the archive through compress" \
4145 ) \
4146 "\nFile selection:" \
4147 "\n f Name of TARFILE or \"-\" for stdin" \
4148 "\n O Extract to stdout" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004149 USE_FEATURE_TAR_FROM( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004150 "\n exclude File to exclude" \
4151 "\n X File with names to exclude" \
4152 ) \
4153 "\n C Change to directory DIR before operation" \
4154 "\n v Verbose" \
4155
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004156#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004157 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
4158 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004159
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004160#define taskset_trivial_usage \
Denis Vlasenkob44c7902008-03-17 09:29:43 +00004161 "[-p] [mask] [pid | command [arg]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004162#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004163 "Set or get CPU affinity\n" \
4164 "\nOptions:" \
4165 "\n -p Operate on an existing PID" \
4166
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004167#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004168 "$ taskset 0x7 ./dgemm_test&\n" \
4169 "$ taskset -p 0x1 $!\n" \
4170 "pid 4790's current affinity mask: 7\n" \
4171 "pid 4790's new affinity mask: 1\n" \
4172 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4173 "pid 6671's current affinity mask: 1\n" \
4174 "pid 6671's new affinity mask: 1\n" \
4175 "$ taskset -p 1\n" \
4176 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004177
Eric Andersen7e9276b2001-02-22 01:15:47 +00004178#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004179 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004180#define tee_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004181 "Copy standard input to each FILE, and also to standard output\n" \
4182 "\nOptions:" \
4183 "\n -a Append to the given FILEs, do not overwrite" \
4184 "\n -i Ignore interrupt signals (SIGINT)" \
4185
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004186#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004187 "$ echo \"Hello\" | tee /tmp/foo\n" \
4188 "$ cat /tmp/foo\n" \
4189 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004190
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004191#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004192#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004193 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004194#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004195 "Connect to telnet server\n" \
4196 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004197 "\n -a Automatic login with $USER variable" \
4198 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004199
Eric Andersen539ffc92004-02-22 12:25:47 +00004200#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004201#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004202 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004203#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004204 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004205#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004206
Eric Andersen08a72202002-09-30 20:52:10 +00004207#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004208 "[OPTION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004209#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004210 "Handle incoming telnet connections" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004211 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
4212 "\nOptions:" \
4213 "\n -l LOGIN Exec LOGIN on connect" \
4214 "\n -f issue_file Display issue_file instead of /etc/issue" \
4215 "\n -K Close connection as soon as login exits" \
4216 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004217 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004218 "\n -p PORT Port to listen on" \
4219 "\n -b ADDR Address to bind to" \
4220 "\n -F Run in foreground" \
4221 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004222 )
Eric Andersen08a72202002-09-30 20:52:10 +00004223
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004224/* "test --help" does not print help (POSIX compat), only "[ --help" does.
4225 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION") */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004226#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004227 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004228#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004229 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4230 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004231#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004232 "$ test 1 -eq 2\n" \
4233 "$ echo $?\n" \
4234 "1\n" \
4235 "$ test 1 -eq 1\n" \
4236 "$ echo $?\n" \
4237 "0\n" \
4238 "$ [ -d /etc ]\n" \
4239 "$ echo $?\n" \
4240 "0\n" \
4241 "$ [ -d /junk ]\n" \
4242 "$ echo $?\n" \
4243 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004244
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004245#define tc_trivial_usage \
4246 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
4247#define tc_full_usage "\n\n" \
4248 "OBJECT: {qdisc|class|filter}\n" \
4249 "CMD: {add|del|change|replace|show}\n" \
4250 "\n" \
4251 "qdisc [ handle QHANDLE ] [ root |"USE_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
4252 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4253 "\t[ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4254 "\tQDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
4255 "qdisc show [ dev STRING ]"USE_FEATURE_TC_INGRESS(" [ingress]")"\n" \
4256 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
4257 "\t[ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4258 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
4259 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
4260 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4261 "\t[ root | classid CLASSID ] [ handle FILTERID ]\n" \
4262 "\t[ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
4263 "filter show [ dev STRING ] [ root | parent CLASSID ]"
4264
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004265#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004266 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004267/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004268/* "[-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 +00004269#define tcpsvd_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004270 "Create TCP socket, bind it to ip:port and listen\n" \
4271 "for incoming connection. Run PROG for each connection.\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004272 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004273 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004274 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004275 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4276 "\n-u user[:group] Change to user/group after bind" \
4277 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004278 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004279 "\n-C n[:msg] Allow only up to n connections from the same IP" \
4280 "\n New connections from this IP address are closed" \
4281 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004282 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004283 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004284 "\n-v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004285
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004286#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00004287 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004288#define udpsvd_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004289 "Create UDP socket, bind it to ip:port and wait\n" \
4290 "for incoming packets. Run PROG for each packet,\n" \
4291 "redirecting all further packets with same peer ip:port to it\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004292 "\nip IP to listen on. '0' = all" \
4293 "\nport Port to listen on" \
4294 "\nprog [arg] Program to run" \
4295 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4296 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004297 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004298 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004299 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004300 "\n-v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004301
Mark Whitley450736c2001-03-02 19:08:50 +00004302#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004303 "[OPTION]... HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004304#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004305 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004306 "\nOptions:" \
4307 "\n -l FILE Local FILE" \
4308 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004309 USE_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004310 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004311 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004312 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004313 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004314 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004315 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004316 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004317 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004318
4319#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004320 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004321#define tftpd_full_usage "\n\n" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004322 "Transfer a file on tftp client's request.\n" \
Denis Vlasenko91f8f822008-10-30 23:42:37 +00004323 "\n" \
4324 "tftpd should be used as an inetd service.\n" \
4325 "tftpd's line for inetd.conf:\n" \
4326 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
4327 "It also can be ran from udpsvd:\n" \
4328 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004329 "\nOptions:" \
4330 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004331 "\n -c Allow file creation via upload" \
4332 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004333
Eric Andersenc3657422001-11-30 07:54:32 +00004334#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004335 "[OPTION]... COMMAND [ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004336#define time_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004337 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004338 "COMMAND's resource usage information is displayed.\n" \
4339 "\nOptions:" \
4340 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004341
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004342#define timeout_trivial_usage \
4343 "[-t SECS] [-s SIG] PROG [ARGS]"
4344#define timeout_full_usage "\n\n" \
4345 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
Denis Vlasenko42404082008-11-24 13:42:24 +00004346 "Defaults: SECS: 10, SIG: TERM." \
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004347
Eric Andersen420b2082002-09-17 22:14:58 +00004348#define top_trivial_usage \
Denis Vlasenko42cc6ba2008-09-25 11:17:10 +00004349 "[-b] [-nCOUNT] [-dSECONDS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004350#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004351 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004352 "Read the status of all processes from /proc each SECONDS\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004353 "and show the status for however many processes will fit on the screen." \
Eric Andersen420b2082002-09-17 22:14:58 +00004354
Eric Andersen7e9276b2001-02-22 01:15:47 +00004355#define touch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004356 "[-c] FILE [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004357#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004358 "Update the last-modified date on the given FILE[s]\n" \
4359 "\nOptions:" \
4360 "\n -c Do not create any files" \
4361
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004362#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004363 "$ ls -l /tmp/foo\n" \
4364 "/bin/ls: /tmp/foo: No such file or directory\n" \
4365 "$ touch /tmp/foo\n" \
4366 "$ ls -l /tmp/foo\n" \
4367 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004368
4369#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004370 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004371#define tr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004372 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004373 "standard input, writing to standard output\n" \
4374 "\nOptions:" \
4375 "\n -c Take complement of STRING1" \
4376 "\n -d Delete input characters coded STRING1" \
4377 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4378
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004379#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004380 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4381 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004382
Eric Andersen5c58d282001-07-10 16:29:00 +00004383#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004384 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
4385 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004386 " [-z pausemsecs] HOST [data size]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004387#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004388 "Trace the route to HOST\n" \
4389 "\nOptions:" \
4390 "\n -F Set the don't fragment bit" \
4391 "\n -I Use ICMP ECHO instead of UDP datagrams" \
4392 "\n -l Display the ttl value of the returned packet" \
4393 "\n -d Set SO_DEBUG options to socket" \
4394 "\n -n Print hop addresses numerically rather than symbolically" \
4395 "\n -r Bypass the normal routing tables and send directly to a host" \
4396 "\n -v Verbose" \
4397 "\n -m max_ttl Max time-to-live (max number of hops)" \
4398 "\n -p port# Base UDP port number used in probes" \
4399 "\n (default is 33434)" \
4400 "\n -q nqueries Number of probes per 'ttl' (default 3)" \
4401 "\n -s src_addr IP address to use as the source address" \
4402 "\n -t tos Type-of-service in probe packets (default 0)" \
4403 "\n -w wait Time in seconds to wait for a response" \
4404 "\n (default 3 sec)" \
4405 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004406
Eric Andersen7e9276b2001-02-22 01:15:47 +00004407#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004408 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004409#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004410 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004411#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004412 "$ true\n" \
4413 "$ echo $?\n" \
4414 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004415
Eric Andersen7e9276b2001-02-22 01:15:47 +00004416#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004417 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004418#define tty_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004419 "Print file name of standard input's terminal" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004420 USE_INCLUDE_SUSv2( "\n" \
4421 "\nOptions:" \
4422 "\n -s Print nothing, only return exit status" \
4423 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004424#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004425 "$ tty\n" \
4426 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004427
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004428#define ttysize_trivial_usage \
4429 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004430#define ttysize_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004431 "Print dimension(s) of standard input's terminal, on error return 80x25"
4432
Mike Frysinger174808c2005-06-11 01:14:09 +00004433#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004434 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
4435 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
4436 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
4437 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
4438 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
4439 "[-T last-check-time] [-U UUID] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004440#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004441 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004442
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004443#define udhcpc_trivial_usage \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004444 "[-Cfbnqtvo] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004445 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." USE_FEATURE_UDHCP_PORT(" [-P N]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004446#define udhcpc_full_usage "\n\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004447 USE_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004448 " -V,--vendorclass=CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004449 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
4450 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
4451 "\n -c,--clientid=CLIENTID Client identifier" \
4452 "\n -C,--clientid-none Suppress default client identifier" \
4453 "\n -p,--pidfile=file Create pidfile" \
4454 "\n -r,--request=IP IP address to request" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +00004455 "\n -s,--script=file Run file at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004456 "\n -t,--retries=N Send up to N request packets" \
4457 "\n -T,--timeout=N Try to get a lease for N seconds (default 3)" \
4458 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004459 "\n -O,--request-option=OPT Request DHCP option OPT (cumulative)" \
4460 "\n -o,--no-default-options Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004461 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004462 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004463 "\n -b,--background Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004464 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004465 "\n -S,--syslog Log to syslog too" \
4466 "\n -n,--now Exit with failure if lease is not immediately obtained" \
4467 "\n -q,--quit Quit after obtaining lease" \
4468 "\n -R,--release Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004469 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004470 "\n -P,--client-port N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004471 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004472 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004473 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004474 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004475 ) \
4476 SKIP_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004477 " -V CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004478 "\n -i INTERFACE Interface to use (default: eth0)" \
4479 "\n -H,-h HOSTNAME Client hostname" \
4480 "\n -c CLIENTID Client identifier" \
4481 "\n -C Suppress default client identifier" \
4482 "\n -p file Create pidfile" \
4483 "\n -r IP IP address to request" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +00004484 "\n -s file Run file at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004485 "\n -t N Send up to N request packets" \
4486 "\n -T N Try to get a lease for N seconds (default 3)" \
4487 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004488 "\n -O OPT Request DHCP option OPT (cumulative)" \
4489 "\n -o Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004490 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004491 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004492 "\n -b Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004493 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004494 "\n -S Log to syslog too" \
4495 "\n -n Exit with failure if lease is not immediately obtained" \
4496 "\n -q Quit after obtaining lease" \
4497 "\n -R Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004498 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004499 "\n -P N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004500 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004501 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004502 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004503 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004504 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004505
Russ Dill61fb4892002-10-14 21:41:28 +00004506#define udhcpd_trivial_usage \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004507 "[-fS]" USE_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004508
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004509#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004510 "DHCP server\n" \
4511 "\n -f Run in foreground" \
4512 "\n -S Log to syslog too" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004513 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004514 "\n -P N Use port N instead of default 67" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004515 )
Russ Dill61fb4892002-10-14 21:41:28 +00004516
Eric Andersen7e9276b2001-02-22 01:15:47 +00004517#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004518 "[flags] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004519#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004520 "Unmount file systems\n" \
4521 "\nOptions:" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00004522 USE_FEATURE_UMOUNT_ALL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004523 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
4524 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004525 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004526 "\n -n Don't erase /etc/mtab entries" \
4527 ) \
4528 "\n -r Try to remount devices as read-only if mount is busy" \
4529 "\n -l Lazy umount (detach filesystem)" \
4530 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004531 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004532 "\n -d Free loop device if it has been used" \
4533 )
4534
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004535#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004536 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004537
4538#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004539 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004540#define uname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004541 "Print system information.\n" \
4542 "\nOptions:" \
4543 "\n -a Print all" \
4544 "\n -m The machine (hardware) type" \
4545 "\n -n Hostname" \
4546 "\n -r OS release" \
4547 "\n -s OS name (default)" \
4548 "\n -p Processor type" \
4549 "\n -v OS version" \
4550
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004551#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004552 "$ uname -a\n" \
4553 "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 +00004554
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004555#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004556 "[-c] [-f] [name...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004557#define uncompress_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004558 "Uncompress .Z file[s]\n" \
4559 "\nOptions:" \
4560 "\n -c Extract to stdout" \
4561 "\n -f Overwrite an existing file" \
Tim Riker7b253f82003-12-28 05:02:40 +00004562
Denis Vlasenko3952f202007-08-13 14:10:24 +00004563#define unexpand_trivial_usage \
4564 "[-f][-a][-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004565#define unexpand_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004566 "Convert spaces to tabs, writing to standard output.\n" \
4567 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004568 USE_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004569 "\n -a,--all Convert all blanks" \
4570 "\n -f,--first-only Convert only leading blanks" \
4571 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004572 ) \
4573 SKIP_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004574 "\n -a Convert all blanks" \
4575 "\n -f Convert only leading blanks" \
4576 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004577 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004578
Eric Andersen7e9276b2001-02-22 01:15:47 +00004579#define uniq_trivial_usage \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004580 "[-fscduw]... [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004581#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004582 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004583 "\nOptions:" \
4584 "\n -c Prefix lines by the number of occurrences" \
4585 "\n -d Only print duplicate lines" \
4586 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004587 "\n -f N Skip first N fields" \
4588 "\n -s N Skip first N chars (after any skipped fields)" \
4589 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004590
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004591#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004592 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4593 "a\n" \
4594 "b\n" \
4595 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004596
4597#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004598 "[option] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004599#define unix2dos_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004600 "Convert FILE from unix to dos format.\n" \
4601 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00004602 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004603 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004604 "\n -d unix2dos" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004605
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004606#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004607 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004608#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004609 "Extract files from ZIP archives\n" \
4610 "\nOptions:" \
4611 "\n -l List archive contents (with -q for short form)" \
4612 "\n -n Never overwrite existing files (default)" \
4613 "\n -o Overwrite files without prompting" \
4614 "\n -p Send output to stdout" \
4615 "\n -q Quiet" \
4616 "\n -x Exclude these files" \
4617 "\n -d Extract files into this directory" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004618
Eric Andersen7e9276b2001-02-22 01:15:47 +00004619#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004620 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004621#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004622 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004623
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004624#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004625 "$ uptime\n" \
4626 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004627
4628#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004629 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004630#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004631 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004632
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004633#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004634 "$ usleep 1000000\n" \
4635 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004636
4637#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004638 "[-o outfile] [infile]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004639#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004640 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004641 "Finds outfile name in uuencoded source unless -o is given"
4642
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004643#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004644 "$ uudecode -o busybox busybox.uu\n" \
4645 "$ ls -l busybox\n" \
4646 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004647
4648#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004649 "[-m] [infile] stored_filename"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004650#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004651 "Uuencode a file to stdout\n" \
4652 "\nOptions:" \
4653 "\n -m Use base64 encoding per RFC1521" \
4654
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004655#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004656 "$ uuencode busybox busybox\n" \
4657 "begin 755 busybox\n" \
4658 "<encoded file snipped>\n" \
4659 "$ uudecode busybox busybox > busybox.uu\n" \
4660 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004661
Eric Andersen853c4942003-01-23 05:59:32 +00004662#define vconfig_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004663 "COMMAND [OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004664#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004665 "Create and remove virtual ethernet devices\n" \
4666 "\nOptions:" \
4667 "\n add [interface-name] [vlan_id]" \
4668 "\n rem [vlan-name]" \
4669 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4670 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4671 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4672 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004673
Eric Andersen3f980402001-04-04 17:31:15 +00004674#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004675 "[OPTION] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004676#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004677 "Edit FILE\n" \
4678 "\nOptions:" \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004679 USE_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004680 "\n -c Initial command to run ($EXINIT also available)") \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004681 USE_FEATURE_VI_READONLY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004682 "\n -R Read-only - do not write to the file") \
4683 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00004684
Eric Andersen27f64e12002-06-23 04:24:25 +00004685#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004686 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004687#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004688 "Lock a virtual terminal. A password is required to unlock.\n" \
4689 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00004690 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004691
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004692#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00004693 "[-n seconds] [-t] COMMAND..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004694#define watch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004695 "Execute a program periodically\n" \
4696 "\nOptions:" \
4697 "\n -n Loop period in seconds (default 2)" \
4698 "\n -t Don't print header" \
4699
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004700#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004701 "$ watch date\n" \
4702 "Mon Dec 17 10:31:40 GMT 2000\n" \
4703 "Mon Dec 17 10:31:42 GMT 2000\n" \
4704 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004705
Eric Andersen7e9276b2001-02-22 01:15:47 +00004706#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004707 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004708#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004709 "Periodically write to watchdog device DEV\n" \
4710 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004711 "\n -T N Reboot after N seconds if not reset (default 60)" \
4712 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004713 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004714 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004715 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004716
4717#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004718 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004719#define wc_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004720 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004721 "more than one FILE is specified. With no FILE, read standard input.\n" \
4722 "\nOptions:" \
4723 "\n -c Print the byte counts" \
4724 "\n -l Print the newline counts" \
4725 "\n -L Print the length of the longest line" \
4726 "\n -w Print the word counts" \
4727
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004728#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004729 "$ wc /etc/passwd\n" \
4730 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004731
4732#define wget_trivial_usage \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00004733 USE_FEATURE_WGET_LONG_OPTIONS( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004734 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004735 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4736 " [-U|--user-agent agent] url" \
4737 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00004738 SKIP_FEATURE_WGET_LONG_OPTIONS( \
Denis Vlasenko03630782007-10-18 11:11:12 +00004739 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4740 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004741#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004742 "Retrieve files via HTTP or FTP\n" \
4743 "\nOptions:" \
4744 "\n -s Spider mode - only check file existence" \
4745 "\n -c Continue retrieval of aborted transfer" \
4746 "\n -q Quiet" \
4747 "\n -P Set directory prefix to DIR" \
4748 "\n -O Save to filename ('-' for stdout)" \
4749 "\n -U Adjust 'User-Agent' field" \
4750 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004751
4752#define which_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004753 "[COMMAND...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004754#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004755 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004756#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004757 "$ which login\n" \
4758 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004759
Eric Andersen00a6a752002-04-26 23:53:10 +00004760#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004761 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004762#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004763 "Show who is logged on\n" \
4764 "\nOptions:" \
4765 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004766
4767#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004768 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004769#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004770 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004771
4772#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004773 "[OPTIONS] [COMMAND] [ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004774#define xargs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004775 "Execute COMMAND on every item given by standard input\n" \
4776 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004777 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004778 "\n -p Ask user whether to run each command") \
4779 "\n -r Do not run command if input is empty" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004780 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004781 "\n -0 Input is separated by NUL characters") \
4782 "\n -t Print the command on stderr before execution" \
Denis Vlasenkoe82da4d2008-08-21 19:59:30 +00004783 "\n -e[STR] STR stops input processing" \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004784 "\n -n N Pass no more than N args to COMMAND" \
4785 "\n -s N Pass command line of no more than N bytes" \
4786 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
4787 "\n -x Exit if size is exceeded") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004788
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004789#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004790 "$ ls | xargs gzip\n" \
4791 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004792
4793#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004794 "[OPTION]... [STRING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004795#define yes_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004796 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004797
Eric Andersen7e9276b2001-02-22 01:15:47 +00004798#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004799 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004800#define zcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004801 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004802
Rob Landleyad8071f2005-04-30 03:49:37 +00004803#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004804 "[OPTIONS] ifname script"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004805#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004806 "Manage a ZeroConf IPv4 link-local address\n" \
4807 "\nOptions:" \
4808 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004809 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004810 "\n -r 169.254.x.x Request this address first" \
4811 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004812 "\n" \
4813 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
4814 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00004815
Eric Andersen178de172004-04-06 16:36:20 +00004816#endif /* __BB_USAGE_H__ */