blob: 7b88a2accd2c7bae5acdac4bd6273df74b91d2d9 [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 */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +000012#ifndef BB_USAGE_H
13#define BB_USAGE_H 1
Eric Andersen178de172004-04-06 16:36:20 +000014
Denis Vlasenko4f98e192008-04-13 22:12:19 +000015
16#define NOUSAGE_STR "\b"
17
Denis Vlasenkod16950d2008-11-29 09:05:50 +000018#define acpid_trivial_usage \
19 "[-d] [-c CONFDIR] [-l LOGFILE] [-e PROC_EVENT_FILE] [EVDEV_EVENT_FILE...]"
20
21#define acpid_full_usage "\n\n" \
22 "Listen to ACPI events and spawn specific helpers on event arrival\n" \
23 "\nOptions:" \
24 "\n -d Do not daemonize and log to stderr" \
25 "\n -c DIR Config directory [/etc/acpi]" \
26 "\n -e FILE /proc event file [/proc/acpi/event]" \
27 "\n -l FILE Log file [/var/log/acpid]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +000028 IF_FEATURE_ACPID_COMPAT( \
Denis Vlasenkod16950d2008-11-29 09:05:50 +000029 "\n\nAccept and ignore compatibility options -g -m -s -S -v" \
30 )
31
32#define acpid_example_usage \
33 "# acpid -l /var/log/my-acpi-log\n" \
34 "# acpid -d /dev/input/event*\n"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000035
Eric Andersenf349e972001-08-21 16:18:59 +000036#define addgroup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +000037 "[-g GID] " IF_FEATURE_ADDUSER_TO_GROUP("[user_name] ") "group_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000038#define addgroup_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +000039 "Add a group " IF_FEATURE_ADDUSER_TO_GROUP("or add a user to a group") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000040 "\nOptions:" \
Denis Vlasenko4f98e192008-04-13 22:12:19 +000041 "\n -g GID Group id" \
Denis Vlasenkoc2931aa2009-04-22 21:35:52 +000042 "\n -S Create a system group" \
Eric Andersenf349e972001-08-21 16:18:59 +000043
44#define adduser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000045 "[OPTIONS] user_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000046#define adduser_full_usage "\n\n" \
Denis Vlasenko73ac0562008-12-25 01:01:23 +000047 "Add a user\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000048 "\nOptions:" \
49 "\n -h DIR Home directory" \
50 "\n -g GECOS GECOS field" \
51 "\n -s SHELL Login shell" \
52 "\n -G GROUP Add user to existing group" \
53 "\n -S Create a system user" \
54 "\n -D Do not assign a password" \
55 "\n -H Do not create home directory" \
Denis Vlasenkoc2931aa2009-04-22 21:35:52 +000056 "\n -u UID User id" \
Eric Andersenf349e972001-08-21 16:18:59 +000057
Mark Whitley6f932772001-03-20 19:18:10 +000058#define adjtimex_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000059 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000060#define adjtimex_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000061 "Read and optionally set system timebase parameters. See adjtimex(2).\n" \
62 "\nOptions:" \
63 "\n -q Quiet" \
64 "\n -o offset Time offset, microseconds" \
65 "\n -f frequency Frequency adjust, integer kernel units (65536 is 1ppm)" \
66 "\n (positive values make clock run faster)" \
67 "\n -t tick Microseconds per tick, usually 10000" \
68 "\n -p timeconstant" \
Mark Whitley6f932772001-03-20 19:18:10 +000069
Eric Andersen7e9276b2001-02-22 01:15:47 +000070#define ar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000071 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000072#define ar_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000073 "Extract or list FILES from an ar archive\n" \
74 "\nOptions:" \
75 "\n -o Preserve original dates" \
76 "\n -p Extract to stdout" \
77 "\n -t List" \
78 "\n -x Extract" \
79 "\n -v Verbose" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000080
Denis Vlasenkofa85b862007-01-07 01:24:12 +000081#define arp_trivial_usage \
Denis Vlasenko4d476922008-11-13 00:05:17 +000082 "\n[-vn] [-H type] [-i if] -a [hostname]" \
83 "\n[-v] [-i if] -d hostname [pub]" \
84 "\n[-v] [-H type] [-i if] -s hostname hw_addr [temp]" \
85 "\n[-v] [-H type] [-i if] -s hostname hw_addr [netmask nm] pub" \
86 "\n[-v] [-H type] [-i if] -Ds hostname ifa [netmask nm] pub"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000087#define arp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000088 "Manipulate ARP cache\n" \
89 "\nOptions:" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000090 "\n -a Display (all) hosts" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000091 "\n -s Set new ARP entry" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000092 "\n -d Delete a specified entry" \
93 "\n -v Verbose" \
94 "\n -n Don't resolve names" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000095 "\n -i IF Network interface" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000096 "\n -D Read <hwaddr> from given device" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000097 "\n -A, -p AF Protocol family" \
Denis Vlasenko397de612008-03-17 08:55:44 +000098 "\n -H HWTYPE Hardware address type" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000099
Glenn L McGrath9e598412003-01-09 10:06:01 +0000100#define arping_trivial_usage \
Denis Vlasenkof23c3f92007-11-23 09:27:05 +0000101 "[-fqbDUA] [-c count] [-w timeout] [-I dev] [-s sender] target"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000102#define arping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000103 "Send ARP requests/replies\n" \
104 "\nOptions:" \
105 "\n -f Quit on first ARP reply" \
106 "\n -q Quiet" \
107 "\n -b Keep broadcasting, don't go unicast" \
108 "\n -D Duplicated address detection mode" \
109 "\n -U Unsolicited ARP mode, update your neighbors" \
110 "\n -A ARP answer mode, update your neighbors" \
111 "\n -c N Stop after sending N ARP requests" \
112 "\n -w timeout Time to wait for ARP reply, in seconds" \
113 "\n -I dev Interface to use (default eth0)" \
114 "\n -s sender Sender IP address" \
115 "\n target Target IP address" \
Glenn L McGrath9e598412003-01-09 10:06:01 +0000116
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000117#define sh_trivial_usage NOUSAGE_STR
118#define sh_full_usage ""
119#define ash_trivial_usage NOUSAGE_STR
120#define ash_full_usage ""
121#define hush_trivial_usage NOUSAGE_STR
122#define hush_full_usage ""
123#define msh_trivial_usage NOUSAGE_STR
124#define msh_full_usage ""
Eric Andersen08f59e32004-03-12 22:07:10 +0000125
126#define awk_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000127 "[OPTION]... [program-text] [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000128#define awk_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000129 "Options:" \
130 "\n -v var=val Set variable" \
131 "\n -F sep Use sep as field separator" \
132 "\n -f file Read program from file" \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +0000133
Eric Andersen7e9276b2001-02-22 01:15:47 +0000134#define basename_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000135 "FILE [SUFFIX]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000136#define basename_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000137 "Strip directory path and suffixes from FILE.\n" \
138 "If specified, also remove any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000139#define basename_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000140 "$ basename /usr/local/bin/foo\n" \
141 "foo\n" \
142 "$ basename /usr/local/bin/\n" \
143 "bin\n" \
144 "$ basename /foo/bar.txt .txt\n" \
145 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000146
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000147#define fbsplash_trivial_usage \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000148 "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000149#define fbsplash_full_usage "\n\n" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000150 "Options:\n" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000151 "\n -s Image" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000152 "\n -c Hide cursor" \
153 "\n -d Framebuffer device (default /dev/fb0)" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000154 "\n -i Config file (var=value):" \
155 "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT" \
156 "\n BAR_R,BAR_G,BAR_B" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000157 "\n -f Control pipe (else exit after drawing image)" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000158 "\n commands: 'NN' (% for progress bar) or 'exit'" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000159
Bernhard Reutner-Fischerd27d9252008-01-13 15:23:27 +0000160#define brctl_trivial_usage \
161 "COMMAND [BRIDGE [INTERFACE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000162#define brctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000163 "Manage ethernet bridges.\n" \
164 "\nCommands:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000165 IF_FEATURE_BRCTL_SHOW( \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000166 "\n show Show a list of bridges" \
167 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000168 "\n addbr BRIDGE Create BRIDGE" \
169 "\n delbr BRIDGE Delete BRIDGE" \
170 "\n addif BRIDGE IFACE Add IFACE to BRIDGE" \
171 "\n delif BRIDGE IFACE Delete IFACE from BRIDGE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000172 IF_FEATURE_BRCTL_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000173 "\n setageing BRIDGE TIME Set ageing time" \
174 "\n setfd BRIDGE TIME Set bridge forward delay" \
175 "\n sethello BRIDGE TIME Set hello time" \
176 "\n setmaxage BRIDGE TIME Set max message age" \
177 "\n setpathcost BRIDGE COST Set path cost" \
178 "\n setportprio BRIDGE PRIO Set port priority" \
179 "\n setbridgeprio BRIDGE PRIO Set bridge priority" \
180 "\n stp BRIDGE [1|0] STP on/off" \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000181 ) \
182
Glenn L McGrath24e28332001-10-05 03:48:57 +0000183#define bunzip2_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000184 "[OPTION]... [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000185#define bunzip2_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000186 "Uncompress FILE (or standard input if FILE is '-' or omitted)\n" \
187 "\nOptions:" \
188 "\n -c Write to standard output" \
189 "\n -f Force" \
Glenn L McGrath24e28332001-10-05 03:48:57 +0000190
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000191#define bzip2_trivial_usage \
192 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000193#define bzip2_full_usage "\n\n" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000194 "Compress FILE(s) with bzip2 algorithm.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000195 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n" \
196 "\nOptions:" \
197 "\n -c Write to standard output" \
198 "\n -d Decompress" \
199 "\n -f Force" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000200 "\n -1..-9 Compression level" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000201
Rob Landley6130b9b2006-01-23 21:10:38 +0000202#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000203 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000204
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000205#define bzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000206 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000207#define bzcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000208 "Uncompress to stdout"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000209
Rob Landleyc1d69902006-01-20 18:28:50 +0000210#define unlzma_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000211 "[OPTION]... [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000212#define unlzma_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000213 "Uncompress FILE (or standard input if FILE is '-' or omitted)\n" \
214 "\nOptions:" \
215 "\n -c Write to standard output" \
216 "\n -f Force" \
Rob Landleyc1d69902006-01-20 18:28:50 +0000217
218#define lzmacat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000219 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000220#define lzmacat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000221 "Uncompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000222
Eric Andersenc98c0622001-12-06 15:16:43 +0000223#define cal_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000224 "[-jy] [[month] year]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000225#define cal_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000226 "Display a calendar\n" \
227 "\nOptions:" \
228 "\n -j Use julian dates" \
229 "\n -y Display the entire year" \
Eric Andersenc98c0622001-12-06 15:16:43 +0000230
Eric Andersen7e9276b2001-02-22 01:15:47 +0000231#define cat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000232 "[-u] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000233#define cat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000234 "Concatenate FILE(s) and print them to stdout\n" \
235 "\nOptions:" \
236 "\n -u Use unbuffered i/o (ignored)" \
237
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000238#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000239 "$ cat /proc/uptime\n" \
240 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000241
Rob Landley8abbee42006-05-31 19:36:04 +0000242#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000243 "[-etv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000244#define catv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000245 "Display nonprinting characters as ^x or M-x\n" \
246 "\nOptions:" \
247 "\n -e End each line with $" \
248 "\n -t Show tabs as ^I" \
249 "\n -v Don't use ^x or M-x escapes" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000250
251#define chat_trivial_usage \
252 "EXPECT [SEND [EXPECT [SEND...]]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000253#define chat_full_usage "\n\n" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000254 "Useful for interacting with a modem connected to stdin/stdout.\n" \
255 "A script consists of one or more \"expect-send\" pairs of strings,\n" \
256 "each pair is a pair of arguments. Example:\n" \
257 "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \
258
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000259#define chattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000260 "[-R] [-+=AacDdijsStTu] [-v version] files..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000261#define chattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000262 "Change file attributes on an ext2 fs\n" \
263 "\nModifiers:" \
264 "\n - Remove attributes" \
265 "\n + Add attributes" \
266 "\n = Set attributes" \
267 "\nAttributes:" \
268 "\n A Don't track atime" \
269 "\n a Append mode only" \
270 "\n c Enable compress" \
271 "\n D Write dir contents synchronously" \
272 "\n d Do not backup with dump" \
273 "\n i Cannot be modified (immutable)" \
274 "\n j Write all data to journal first" \
275 "\n s Zero disk storage when deleted" \
276 "\n S Write file contents synchronously" \
277 "\n t Disable tail-merging of partial blocks with other files" \
278 "\n u Allow file to be undeleted" \
279 "\nOptions:" \
280 "\n -R Recursively list subdirectories" \
281 "\n -v Set the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000282
Denis Vlasenko49622d72007-03-10 16:58:49 +0000283#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000284 "[OPTIONS] CONTEXT FILE..." \
285 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000286 IF_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000287 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
288 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000289#define chcon_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000290 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000291 IF_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000292 "\n -v,--verbose Verbose" \
293 "\n -c,--changes Report changes made" \
294 "\n -h,--no-dereference Affect symlinks instead of their targets" \
295 "\n -f,--silent,--quiet Suppress most error messages" \
296 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
297 "\n -u,--user=USER Set user/role/type/range in the target" \
298 "\n -r,--role=ROLE security context" \
299 "\n -t,--type=TYPE" \
300 "\n -l,--range=RANGE" \
301 "\n -R,--recursive Recurse subdirectories" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000302 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000303 IF_NOT_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000304 "\n -v Verbose" \
305 "\n -c Report changes made" \
306 "\n -h Affect symlinks instead of their targets" \
307 "\n -f Suppress most error messages" \
308 "\n -u USER Set user/role/type/range in the target security context" \
309 "\n -r ROLE" \
310 "\n -t TYPE" \
311 "\n -l RNG" \
312 "\n -R Recurse subdirectories" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000313 )
314
Eric Andersen7e9276b2001-02-22 01:15:47 +0000315#define chmod_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000316 "[-R"IF_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000317#define chmod_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000318 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000319 "symbols +-= and one or more of the letters rwxst\n" \
320 "\nOptions:" \
321 "\n -R Recurse directories" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000322 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000323 "\n -c List changed files" \
324 "\n -v List all files" \
325 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000326 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000327#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000328 "$ ls -l /tmp/foo\n" \
329 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
330 "$ chmod u+x /tmp/foo\n" \
331 "$ ls -l /tmp/foo\n" \
332 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
333 "$ chmod 444 /tmp/foo\n" \
334 "$ ls -l /tmp/foo\n" \
335 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000336
Denis Vlasenko081ef792007-03-17 16:38:21 +0000337#define chgrp_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000338 "[-RhLHP"IF_DESKTOP("cvf")"]... GROUP FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000339#define chgrp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000340 "Change the group membership of each FILE to GROUP\n" \
341 "\nOptions:" \
342 "\n -R Recurse directories" \
343 "\n -h Affect symlinks instead of symlink targets" \
344 "\n -L Traverse all symlinks to directories" \
345 "\n -H Traverse symlinks on command line only" \
346 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000347 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000348 "\n -c List changed files" \
349 "\n -v Verbose" \
350 "\n -f Hide errors" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000351 )
352#define chgrp_example_usage \
353 "$ ls -l /tmp/foo\n" \
354 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
355 "$ chgrp root /tmp/foo\n" \
356 "$ ls -l /tmp/foo\n" \
357 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
358
Eric Andersen7e9276b2001-02-22 01:15:47 +0000359#define chown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000360 "[-RhLHP"IF_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000361#define chown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000362 "Change the owner and/or group of each FILE to OWNER and/or GROUP\n" \
363 "\nOptions:" \
364 "\n -R Recurse directories" \
365 "\n -h Affect symlinks instead of symlink targets" \
366 "\n -L Traverse all symlinks to directories" \
367 "\n -H Traverse symlinks on command line only" \
368 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000369 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000370 "\n -c List changed files" \
371 "\n -v List all files" \
372 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000373 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000374#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000375 "$ ls -l /tmp/foo\n" \
376 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
377 "$ chown root /tmp/foo\n" \
378 "$ ls -l /tmp/foo\n" \
379 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
380 "$ chown root.root /tmp/foo\n" \
381 "ls -l /tmp/foo\n" \
382 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000383
Denis Vlasenkofe544582006-10-03 15:57:40 +0000384#define chpst_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000385 "[-vP012] [-u USER[:GRP]] [-U USER[:GRP]] [-e DIR]\n" \
386 " [-/ DIR] [-n NICE] [-m BYTES] [-d BYTES] [-o N]\n" \
387 " [-p N] [-f BYTES] [-c BYTES] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000388#define chpst_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000389 "Change the process state and run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000390 "\nOptions:" \
391 "\n -u USER[:GRP] Set uid and gid" \
392 "\n -U USER[:GRP] Set $UID and $GID in environment" \
393 "\n -e DIR Set environment variables as specified by files" \
394 "\n in DIR: file=1st_line_of_file" \
395 "\n -/ DIR Chroot to DIR" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000396 "\n -n NICE Add NICE to nice value" \
397 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000398 "\n -d BYTES Limit data segment" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000399 "\n -o N Limit number of open files per process" \
400 "\n -p N Limit number of processes per uid" \
401 "\n -f BYTES Limit output file sizes" \
402 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000403 "\n -v Verbose" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000404 "\n -P Create new process group" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000405 "\n -0 Close standard input" \
406 "\n -1 Close standard output" \
407 "\n -2 Close standard error" \
408
Denis Vlasenkofe544582006-10-03 15:57:40 +0000409#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000410 "account prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000411#define setuidgid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000412 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000413 "groups and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000414#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000415 "account prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000416#define envuidgid_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000417 "Set $UID to account's uid and $GID to account's gid and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000418#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000419 "dir prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000420#define envdir_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000421 "Set various environment variables as specified by files\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000422 "in the directory dir and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000423#define softlimit_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000424 "[-a BYTES] [-m BYTES] [-d BYTES] [-s BYTES] [-l BYTES]\n" \
425 " [-f BYTES] [-c BYTES] [-r BYTES] [-o N] [-p N] [-t N]\n" \
426 " PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000427#define softlimit_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000428 "Set soft resource limits, then run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000429 "\nOptions:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000430 "\n -a BYTES Limit total size of all segments" \
431 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES -a BYTES" \
432 "\n -d BYTES Limit data segment" \
433 "\n -s BYTES Limit stack segment" \
434 "\n -l BYTES Limit locked memory size" \
435 "\n -o N Limit number of open files per process" \
436 "\n -p N Limit number of processes per uid" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000437 "\nOptions controlling file sizes:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000438 "\n -f BYTES Limit output file sizes" \
439 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000440 "\nEfficiency opts:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000441 "\n -r BYTES Limit resident set size" \
442 "\n -t N Limit CPU time, process receives" \
443 "\n a SIGXCPU after N seconds" \
Denis Vlasenkofe544582006-10-03 15:57:40 +0000444
Eric Andersen7e9276b2001-02-22 01:15:47 +0000445#define chroot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000446 "NEWROOT [COMMAND...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000447#define chroot_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000448 "Run COMMAND with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000449#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000450 "$ ls -l /bin/ls\n" \
451 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
452 "# mount /dev/hdc1 /mnt -t minix\n" \
453 "# chroot /mnt\n" \
454 "# ls -l /bin/ls\n" \
455 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000456
Eric Andersen7e9276b2001-02-22 01:15:47 +0000457#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000458 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000459#define chvt_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000460 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000461
Rob Landley856489b2006-04-18 20:57:28 +0000462#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000463 "FILES..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000464#define cksum_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000465 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000466
Eric Andersen7e9276b2001-02-22 01:15:47 +0000467#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000468 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000469#define clear_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000470 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000471
Eric Andersen7e9276b2001-02-22 01:15:47 +0000472#define cmp_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000473 "[-l] [-s] FILE1 [FILE2" IF_DESKTOP(" [SKIP1 [SKIP2]") "]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000474#define cmp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000475 "Compares FILE1 vs stdin if FILE2 is not specified\n" \
476 "\nOptions:" \
477 "\n -l Write the byte numbers (decimal) and values (octal)" \
478 "\n for all differing bytes" \
479 "\n -s Quiet" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000480
Rob Landley2acfd7b2005-05-11 23:12:49 +0000481#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000482 "[-123] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000483#define comm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000484 "Compare FILE1 to FILE2, or to stdin if - is specified\n" \
485 "\nOptions:" \
486 "\n -1 Suppress lines unique to FILE1" \
487 "\n -2 Suppress lines unique to FILE2" \
488 "\n -3 Suppress lines common to both files" \
Rob Landley2acfd7b2005-05-11 23:12:49 +0000489
Paul Fox79c142d2005-08-01 16:04:40 +0000490#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000491 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000492#define bbconfig_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000493 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000494
Rob Landley69674942006-09-11 00:34:01 +0000495#define bbsh_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000496 "[FILE]...\n" \
497 "or: bbsh -c command [args]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000498#define bbsh_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000499 "The bbsh shell (command interpreter)"
Rob Landley69674942006-09-11 00:34:01 +0000500
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000501#define chrt_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000502 "[OPTION]... [prio] [pid | command [arg]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000503#define chrt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000504 "Manipulate real-time attributes of a process\n" \
505 "\nOptions:" \
506 "\n -p Operate on pid" \
507 "\n -r Set scheduling policy to SCHED_RR" \
508 "\n -f Set scheduling policy to SCHED_FIFO" \
509 "\n -o Set scheduling policy to SCHED_OTHER" \
510 "\n -m Show min and max priorities" \
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000511
512#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000513 "$ chrt -r 4 sleep 900; x=$!\n" \
514 "$ chrt -f -p 3 $x\n" \
515 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000516
Eric Andersen7e9276b2001-02-22 01:15:47 +0000517#define cp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000518 "[OPTION]... SOURCE DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000519#define cp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000520 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY\n" \
521 "\nOptions:" \
522 "\n -a Same as -dpR" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000523 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000524 "\n -c Preserve security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000525 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000526 "\n -d,-P Preserve links" \
527 "\n -H,-L Dereference all symlinks (default)" \
528 "\n -p Preserve file attributes if possible" \
529 "\n -f Force overwrite" \
530 "\n -i Prompt before overwrite" \
531 "\n -R,-r Recurse directories" \
532 "\n -l,-s Create (sym)links" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000533
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000534#define cpio_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000535 "-[ti" IF_FEATURE_CPIO_O("o") IF_FEATURE_CPIO_P("p") "dmvu] [-F FILE]" \
536 IF_FEATURE_CPIO_O( " [-H newc]" )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000537#define cpio_full_usage "\n\n" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000538 "Extract or list files from a cpio archive" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000539 IF_FEATURE_CPIO_O( ", or create a cpio archive" ) \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000540 "\nMain operation mode:" \
541 "\n -t List" \
542 "\n -i Extract" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000543 IF_FEATURE_CPIO_O( \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000544 "\n -o Create" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000545 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000546 IF_FEATURE_CPIO_P( \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000547 "\n -p Passthrough" \
548 ) \
549 "\nOptions:" \
550 "\n -d Make leading directories" \
551 "\n -m Preserve mtime" \
552 "\n -v Verbose" \
553 "\n -u Overwrite" \
554 "\n -F Input file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000555 IF_FEATURE_CPIO_O( \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000556 "\n -H Define format" \
557 ) \
Tim Riker7b253f82003-12-28 05:02:40 +0000558
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000559#define crond_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000560 "-fbS -l N " IF_FEATURE_CROND_D("-d N ") "-L LOGFILE -c DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000561#define crond_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000562 " -f Foreground" \
563 "\n -b Background (default)" \
564 "\n -S Log to syslog (default)" \
565 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000566 IF_FEATURE_CROND_D( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000567 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000568 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000569 "\n -L Log to file" \
570 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000571
572#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000573 "[-c DIR] [-u USER] [-ler]|[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000574#define crontab_full_usage "\n\n" \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000575 " -c Crontab directory" \
576 "\n -u User" \
577 "\n -l List crontab" \
578 "\n -e Edit crontab" \
579 "\n -r Delete crontab" \
580 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000581
Denis Vlasenko2211d522008-11-10 18:52:35 +0000582#define cryptpw_trivial_usage \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000583 "[OPTIONS] [PASSWORD] [SALT]"
584/* We do support -s, we just don't mention it */
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000585#define cryptpw_full_usage "\n\n" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000586 "Crypt the PASSWORD using crypt(3)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000587 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000588 IF_GETOPT_LONG( \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000589 "\n -P,--password-fd=NUM Read password from fd NUM" \
590/* "\n -s,--stdin Use stdin; like -P0" */ \
591 "\n -m,--method=TYPE Encryption method TYPE" \
592 "\n -S,--salt=SALT" \
593 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000594 IF_NOT_GETOPT_LONG( \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000595 "\n -P NUM Read password from fd NUM" \
596/* "\n -s Use stdin; like -P0" */ \
597 "\n -m TYPE Encryption method TYPE" \
598 "\n -S SALT" \
599 ) \
600
601/* mkpasswd is an alias to cryptpw */
602
603#define mkpasswd_trivial_usage \
604 "[OPTIONS] [PASSWORD] [SALT]"
605/* We do support -s, we just don't mention it */
606#define mkpasswd_full_usage "\n\n" \
607 "Crypt the PASSWORD using crypt(3)\n" \
608 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000609 IF_GETOPT_LONG( \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000610 "\n -P,--password-fd=NUM Read password from fd NUM" \
611/* "\n -s,--stdin Use stdin; like -P0" */ \
612 "\n -m,--method=TYPE Encryption method TYPE" \
613 "\n -S,--salt=SALT" \
614 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000615 IF_NOT_GETOPT_LONG( \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000616 "\n -P NUM Read password from fd NUM" \
617/* "\n -s Use stdin; like -P0" */ \
618 "\n -m TYPE Encryption method TYPE" \
619 "\n -S SALT" \
620 ) \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000621
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000622#define cttyhack_trivial_usage NOUSAGE_STR
623#define cttyhack_full_usage ""
624
Eric Andersen7e9276b2001-02-22 01:15:47 +0000625#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000626 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000627#define cut_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000628 "Print selected fields from each input FILE to standard output\n" \
629 "\nOptions:" \
630 "\n -b LIST Output only bytes from LIST" \
631 "\n -c LIST Output only characters from LIST" \
632 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
633 "\n -s Output only the lines containing delimiter" \
634 "\n -f N Print only these fields" \
635 "\n -n Ignored" \
636
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000637#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000638 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
639 "Hello\n" \
640 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
641 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000642
Eric Andersen7e9276b2001-02-22 01:15:47 +0000643#define date_trivial_usage \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000644 "[OPTION]... [+FMT] [TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000645#define date_full_usage "\n\n" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000646 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000647 "\nOptions:" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000648 "\n -u Work in UTC (don't convert to local time)" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000649 "\n -R Output RFC-822 compliant date string" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000650 IF_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000651 "\n -I[SPEC] Output ISO-8601 compliant date string" \
652 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000653 "\n 'hours', 'minutes', or 'seconds' for date and" \
654 "\n time to the indicated precision" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000655 ) \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000656 "\n -d TIME Display TIME, not 'now'" \
657 "\n -r FILE Display last modification time of FILE" \
658 "\n [-s] TIME Set time to TIME" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000659 IF_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000660 "\n -D FMT Use FMT for str->date conversion" \
661 ) \
662 "\n" \
663 "\nRecognized formats for TIME:" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000664 "\n hh:mm[:ss]" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000665 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000666 "\n YYYY-MM-DD hh:mm[:ss]" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000667 "\n MMDDhhmm[[YY]YY][.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000668
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000669#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000670 "$ date\n" \
671 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000672
Eric Andersen7e9276b2001-02-22 01:15:47 +0000673#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000674 "expression..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000675#define dc_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +0000676 "Tiny RPN calculator. Operations:\n" \
677 "+, add, -, sub, *, mul, /, div, %, mod, **, exp, and, or, not, eor,\n" \
678 "p - print top of the stack (without altering the stack),\n" \
679 "f - print entire stack, o - pop the value and set output radix\n" \
680 "(value must be 10 or 16).\n" \
681 "Examples: 'dc 2 2 add' -> 4, 'dc 8 8 * 2 2 + /' -> 16.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000682
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000683#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000684 "$ dc 2 2 + p\n" \
685 "4\n" \
686 "$ dc 8 8 \\* 2 2 + / p\n" \
687 "16\n" \
688 "$ dc 0 1 and p\n" \
689 "0\n" \
690 "$ dc 0 1 or p\n" \
691 "1\n" \
692 "$ echo 72 9 div 8 mul p | dc\n" \
693 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000694
Eric Andersen7e9276b2001-02-22 01:15:47 +0000695#define dd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000696 "[if=FILE] [of=FILE] " IF_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
697 " [seek=N]" IF_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000698#define dd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000699 "Copy a file with converting and formatting\n" \
700 "\nOptions:" \
701 "\n if=FILE Read from FILE instead of stdin" \
702 "\n of=FILE Write to FILE instead of stdout" \
703 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000704 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000705 "\n ibs=N Read N bytes at a time" \
706 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000707 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000708 "\n obs=N Write N bytes at a time" \
709 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000710 "\n count=N Copy only N input blocks" \
711 "\n skip=N Skip N input blocks" \
712 "\n seek=N Skip N output blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000713 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000714 "\n conv=notrunc Don't truncate output file" \
715 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000716 "\n conv=sync Pad blocks with zeros" \
717 "\n conv=fsync Physically write data out before finishing" \
718 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000719 "\n" \
720 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
721 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
722
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000723#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000724 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
725 "4+0 records in\n" \
726 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000727
Eric Andersen7e9276b2001-02-22 01:15:47 +0000728#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000729 "[N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000730#define deallocvt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000731 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000732
Eric Andersenf349e972001-08-21 16:18:59 +0000733#define delgroup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000734 IF_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000735#define delgroup_full_usage "\n\n" \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000736 "Delete group GROUP from the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000737 IF_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000738
739#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000740 "USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000741#define deluser_full_usage "\n\n" \
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000742 "Delete USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000743
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000744#define depmod_trivial_usage NOUSAGE_STR
745#define depmod_full_usage ""
Bernhard Reutner-Fischer55e547e2008-05-26 12:01:49 +0000746
Denis Vlasenkoc94fa562008-10-26 11:08:14 +0000747#define devmem_trivial_usage \
748 "ADDRESS [WIDTH [VALUE]]"
749
750#define devmem_full_usage "\n\n" \
751 "Read/write from physical address\n" \
752 "\n ADDRESS Address to act upon" \
753 "\n WIDTH Width (8/16/...)" \
754 "\n VALUE Data to be written" \
755
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000756#define devfsd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000757 "mntpnt [-v]" IF_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000758#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000759 "Manage devfs permissions and old device name symlinks\n" \
760 "\nOptions:" \
761 "\n mntpnt The mount point where devfs is mounted" \
762 "\n -v Print the protocol version numbers for devfsd" \
763 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000764 IF_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000765 "\n -fg Run in foreground" \
766 "\n -np Exit after parsing the configuration file" \
767 "\n and processing synthetic REGISTER events," \
768 "\n do not poll for events" \
769 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000770
Eric Andersen7e9276b2001-02-22 01:15:47 +0000771#define df_trivial_usage \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000772 "[-Pk" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000773 IF_FEATURE_HUMAN_READABLE("mh") \
774 IF_FEATURE_DF_FANCY("ai] [-B SIZE") \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000775 "] [FILESYSTEM...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000776#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000777 "Print filesystem usage statistics\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000778 "\nOptions:" \
779 "\n -P POSIX output format" \
780 "\n -k 1024-byte blocks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000781 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000782 "\n -m 1M-byte blocks" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000783 "\n -h Human readable (e.g. 1K 243M 2G)" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000784 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000785 IF_FEATURE_DF_FANCY( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000786 "\n -a Show all filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000787 "\n -i Inodes" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000788 "\n -B SIZE Blocksize" \
789 ) \
790
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000791#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000792 "$ df\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000793 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000794 "/dev/sda3 8690864 8553540 137324 98% /\n" \
795 "/dev/sda1 64216 36364 27852 57% /boot\n" \
796 "$ df /dev/sda3\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000797 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
798 "/dev/sda3 8690864 8553540 137324 98% /\n" \
799 "$ POSIXLY_CORRECT=sure df /dev/sda3\n" \
800 "Filesystem 512B-blocks Used Available Use% Mounted on\n" \
801 "/dev/sda3 17381728 17107080 274648 98% /\n" \
802 "$ POSIXLY_CORRECT=yep df -P /dev/sda3\n" \
803 "Filesystem 512-blocks Used Available Capacity Mounted on\n" \
804 "/dev/sda3 17381728 17107080 274648 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000805
Denis Vlasenko736230e2006-11-20 19:40:36 +0000806#define dhcprelay_trivial_usage \
Denis Vlasenkoe8a79682009-04-13 03:33:46 +0000807 "CLIENT_IFACE[,CLIENT_IFACE2...] SERVER_IFACE [SERVER_IP]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000808#define dhcprelay_full_usage "\n\n" \
Denis Vlasenkoe8a79682009-04-13 03:33:46 +0000809 "Relay DHCP requests between clients and server" \
Denis Vlasenko736230e2006-11-20 19:40:36 +0000810
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000811#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000812 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000813#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000814 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000815 "This implementation supports unified diffs only.\n" \
816 "\nOptions:" \
817 "\n -a Treat all files as text" \
818 "\n -b Ignore changes in the amount of whitespace" \
819 "\n -d Try hard to find a smaller set of changes" \
820 "\n -i Ignore case differences" \
821 "\n -L Use LABEL instead of the filename in the unified header" \
822 "\n -N Treat absent files as empty" \
823 "\n -q Output only whether files differ" \
824 "\n -r Recursively compare subdirectories" \
825 "\n -S Start with FILE when comparing directories" \
826 "\n -T Make tabs line up by prefixing a tab when necessary" \
827 "\n -s Report when two files are the same" \
828 "\n -t Expand tabs to spaces in output" \
829 "\n -U Output LINES lines of context" \
830 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000831
Eric Andersen7e9276b2001-02-22 01:15:47 +0000832#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000833 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000834#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000835 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000836#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000837 "$ dirname /tmp/foo\n" \
838 "/tmp\n" \
839 "$ dirname /tmp/foo/\n" \
840 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000841
Eric Andersen7e9276b2001-02-22 01:15:47 +0000842#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000843 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000844#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000845 "Print or control the kernel ring buffer\n" \
846 "\nOptions:" \
847 "\n -c Clear ring buffer after printing" \
848 "\n -n LEVEL Set console logging level" \
849 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000850
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000851#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000852 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000853#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000854 "Small static DNS server daemon\n" \
855 "\nOptions:" \
856 "\n -c Config filename" \
857 "\n -t TTL in seconds" \
858 "\n -p Listening port" \
859 "\n -i Listening ip (default all)" \
860 "\n -d Daemonize" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000861
Eric Andersen7e9276b2001-02-22 01:15:47 +0000862#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000863 "[option] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000864#define dos2unix_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000865 "Convert FILE from dos to unix format.\n" \
866 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000867 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000868 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000869 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000870
Eric Andersen7e9276b2001-02-22 01:15:47 +0000871#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000872 "[-ilCPru] [-F option] package_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000873#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000874 "Install, remove and manage Debian packages\n" \
875 "\nOptions:" \
876 "\n -i Install the package" \
877 "\n -l List of installed packages" \
878 "\n -C Configure an unpackaged package" \
879 "\n -F depends Ignore dependency problems" \
880 "\n -P Purge all files of a package" \
881 "\n -r Remove all but the configuration files for a package" \
882 "\n -u Unpack a package, but don't configure it" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000883
Eric Andersen7e9276b2001-02-22 01:15:47 +0000884#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000885 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000886#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000887 "Perform actions on Debian packages (.debs)\n" \
888 "\nOptions:" \
889 "\n -c List contents of filesystem tree" \
890 "\n -e Extract control files to [argument] directory" \
891 "\n -f Display control field name starting with [argument]" \
892 "\n -x Extract packages filesystem tree to directory" \
893 "\n -X Verbose extract" \
894
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000895#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000896 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000897
Eric Andersen7e9276b2001-02-22 01:15:47 +0000898#define du_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000899 "[-aHLdclsx" IF_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000900#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000901 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000902 "Disk space is printed in units of " \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000903 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
904 IF_NOT_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000905 " bytes.\n" \
906 "\nOptions:" \
907 "\n -a Show file sizes too" \
908 "\n -H Follow symlinks on command line" \
909 "\n -L Follow all symlinks" \
910 "\n -d N Limit output to directories (and files with -a) of depth < N" \
911 "\n -c Show grand total" \
912 "\n -l Count sizes many times if hard linked" \
913 "\n -s Display only a total for each argument" \
914 "\n -x Skip directories on different filesystems" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000915 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000916 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
917 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000918 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000919 "\n -k Sizes in kilobytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000920 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000921
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000922#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000923 "$ du\n" \
924 "16 ./CVS\n" \
925 "12 ./kernel-patches/CVS\n" \
926 "80 ./kernel-patches\n" \
927 "12 ./tests/CVS\n" \
928 "36 ./tests\n" \
929 "12 ./scripts/CVS\n" \
930 "16 ./scripts\n" \
931 "12 ./docs/CVS\n" \
932 "104 ./docs\n" \
933 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000934
Eric Andersen7e9276b2001-02-22 01:15:47 +0000935#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000936 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000937#define dumpkmap_full_usage "\n\n" \
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000938 "Print a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000939#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000940 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000941
Russ Dill61fb4892002-10-14 21:41:28 +0000942#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000943 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000944#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000945 "Display DHCP leases granted by udhcpd\n" \
946 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000947 IF_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000948 "\n -f,--file=FILE Leases file to load" \
949 "\n -r,--remaining Interpret lease times as time remaining" \
950 "\n -a,--absolute Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000951 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000952 IF_NOT_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000953 "\n -f FILE Leases file to load" \
954 "\n -r Interpret lease times as time remaining" \
955 "\n -a Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000956 )
Russ Dill61fb4892002-10-14 21:41:28 +0000957
Mike Frysinger51a43b42005-09-24 07:11:16 +0000958#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000959 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
960 "[-I inode_buffer_blocks] [-P process_inode_size] " \
961 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
962 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000963#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000964 "Check ext2/ext3 file system\n" \
965 "\nOptions:" \
966 "\n -p Automatic repair (no questions)" \
967 "\n -n Make no changes to the filesystem" \
968 "\n -y Assume 'yes' to all questions" \
969 "\n -c Check for bad blocks and add them to the badblock list" \
970 "\n -f Force checking even if filesystem is marked clean" \
971 "\n -v Verbose" \
972 "\n -b superblock Use alternative superblock" \
973 "\n -B blocksize Force blocksize when looking for superblock" \
974 "\n -j journal Set location of the external journal" \
975 "\n -l file Add to badblocks list" \
976 "\n -L file Set badblocks list" \
Mike Frysinger51a43b42005-09-24 07:11:16 +0000977
Eric Andersen7e9276b2001-02-22 01:15:47 +0000978#define echo_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000979 IF_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000980#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000981 "Print the specified ARGs to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000982 IF_FEATURE_FANCY_ECHO( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000983 "\nOptions:" \
984 "\n -n Suppress trailing newline" \
985 "\n -e Interpret backslash-escaped characters (i.e., \\t=tab)" \
986 "\n -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000987 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000988#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000989 "$ echo \"Erik is cool\"\n" \
990 "Erik is cool\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000991 IF_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000992 "Erik\n" \
993 "is\n" \
994 "cool\n" \
995 "$ echo \"Erik\\nis\\ncool\"\n" \
996 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000997
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000998#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000999 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001000#define eject_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001001 "Eject specified DEVICE (or default /dev/cdrom)\n" \
1002 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001003 IF_FEATURE_EJECT_SCSI( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001004 "\n -s SCSI device" \
1005 ) \
1006 "\n -t Close tray" \
1007 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001008
Rob Landley3b890392006-05-04 20:56:43 +00001009#define ed_trivial_usage ""
1010#define ed_full_usage ""
1011
Eric Andersen84e229c2001-03-29 22:48:33 +00001012#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001013 "[-iu] [-] [name=value]... [command]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001014#define env_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001015 "Print the current environment or run a program after setting\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001016 "up the specified environment\n" \
1017 "\nOptions:" \
1018 "\n -, -i Start with an empty environment" \
1019 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +00001020
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001021#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001022 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001023#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001024 "Send a magic packet to wake up sleeping machines.\n" \
1025 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001026 "a hostname with a known 'ethers' entry.\n" \
1027 "\nOptions:" \
1028 "\n -b Send wake-up packet to the broadcast address" \
1029 "\n -i iface Interface to use (default eth0)" \
1030 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001031
Denis Vlasenko3952f202007-08-13 14:10:24 +00001032#define expand_trivial_usage \
1033 "[-i] [-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001034#define expand_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001035 "Convert tabs to spaces, writing to standard output.\n" \
1036 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001037 IF_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001038 "\n -i,--initial Do not convert tabs after non blanks" \
1039 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001040 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001041 IF_NOT_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001042 "\n -i Do not convert tabs after non blanks" \
1043 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001044 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00001045
Eric Andersen7e9276b2001-02-22 01:15:47 +00001046#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001047 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001048#define expr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001049 "Print the value of EXPRESSION to standard output.\n" \
1050 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001051 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001052 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
1053 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1054 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1055 " ARG1 <= ARG2\n" \
1056 " ARG1 = ARG2\n" \
1057 " ARG1 != ARG2\n" \
1058 " ARG1 >= ARG2\n" \
1059 " ARG1 > ARG2\n" \
1060 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1061 " ARG1 - ARG2\n" \
1062 " ARG1 * ARG2\n" \
1063 " ARG1 / ARG2\n" \
1064 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001065 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1066 " match STRING REGEXP Same as STRING : REGEXP\n" \
1067 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1068 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1069 " length STRING Length of STRING\n" \
1070 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001071 " it is a keyword like 'match' or an\n" \
1072 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001073 " (EXPRESSION) Value of EXPRESSION\n" \
1074 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001075 "Beware that many operators need to be escaped or quoted for shells.\n" \
1076 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001077 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001078 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1079 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001080
Mike Frysingerfa69f112005-04-17 07:24:19 +00001081#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001082 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001083#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001084 "Provide fake ident (auth) service\n" \
1085 "\nOptions:" \
1086 "\n -f Run in foreground" \
1087 "\n -i Inetd mode" \
1088 "\n -w Inetd 'wait' mode" \
1089 "\n -b ADDR Bind to specified address" \
1090 "\n STRING Ident answer string (default is 'nobody')" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001091
Eric Andersen7e9276b2001-02-22 01:15:47 +00001092#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001093 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001094#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001095 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001096
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001097#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001098 "$ false\n" \
1099 "$ echo $?\n" \
1100 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001101
1102#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001103 "[options] [mode]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001104#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001105 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001106
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001107#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001108 "$ fbset\n" \
1109 "mode \"1024x768-76\"\n" \
1110 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1111 " geometry 1024 768 1024 768 16\n" \
1112 " timings 12714 128 32 16 4 128 4\n" \
1113 " accel false\n" \
1114 " rgba 5/11,6/5,5/0,0/0\n" \
1115 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001116
Eric Andersen7e9276b2001-02-22 01:15:47 +00001117#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001118 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001119#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001120 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001121
Eric Andersen01c3d402003-07-05 07:51:31 +00001122#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001123 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001124#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001125 "Format floppy disk\n" \
1126 "\nOptions:" \
1127 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001128
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001129/* Looks like someone forgot to add this to config system */
1130#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1131# define ENABLE_FEATURE_FDISK_BLKSIZE 0
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001132# define IF_FEATURE_FDISK_BLKSIZE(a)
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001133#endif
1134
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001135#define fdisk_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001136 "[-ul" IF_FEATURE_FDISK_BLKSIZE("s") "] " \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001137 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001138#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001139 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001140 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001141 "\n -u Start and End are in sectors (instead of cylinders)" \
1142 "\n -l Show partition table for each DISK, then exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001143 IF_FEATURE_FDISK_BLKSIZE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001144 "\n -s Show partition sizes in kb for each DISK, then exit" \
1145 ) \
1146 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1147 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
1148 "\n -H HEADS\n" \
1149 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001150
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001151#define blkid_trivial_usage \
1152 ""
1153#define blkid_full_usage "\n\n" \
1154 "Print UUIDs of all filesystems."
1155
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001156#define findfs_trivial_usage \
1157 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001158#define findfs_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001159 "Find a filesystem device based on a label or UUID."
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001160#define findfs_example_usage \
1161 "$ findfs LABEL=MyDevice"
1162
Eric Andersen7e9276b2001-02-22 01:15:47 +00001163#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001164 "[PATH...] [EXPRESSION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001165#define find_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001166 "Search for files. The default PATH is the current directory,\n" \
1167 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001168 "\nEXPRESSION may consist of:" \
1169 "\n -follow Dereference symlinks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001170 IF_FEATURE_FIND_XDEV( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001171 "\n -xdev Don't descend directories on other filesystems") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001172 IF_FEATURE_FIND_MAXDEPTH( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001173 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1174 "\n tests/actions to command line arguments only") \
Denis Vlasenko83518d12009-03-20 22:17:13 +00001175 "\n -mindepth N Do not act on first N levels" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001176 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001177 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001178 IF_FEATURE_FIND_PATH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001179 "\n -path PATTERN Path matches PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001180 IF_FEATURE_FIND_REGEX( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001181 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001182 IF_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001183 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001184 IF_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001185 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001186 "\n or exactly (NNN)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001187 IF_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001188 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001189 "\n or exactly (N) days") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001190 IF_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001191 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001192 "\n or exactly (N) minutes") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001193 IF_FEATURE_FIND_NEWER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001194 "\n -newer FILE Modified time is more recent than FILE's") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001195 IF_FEATURE_FIND_INUM( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001196 "\n -inum N File has inode number N") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001197 IF_FEATURE_FIND_USER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001198 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001199 IF_FEATURE_FIND_GROUP( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001200 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001201 IF_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001202 "\n -depth Process directory name after traversing it") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001203 IF_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001204 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1205 "\n +/-N: file size is bigger/smaller than N") \
1206 "\n -print Print (default and assumed)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001207 IF_FEATURE_FIND_PRINT0( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001208 "\n -print0 Delimit output with null characters rather than" \
1209 "\n newlines") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001210 IF_FEATURE_FIND_CONTEXT ( \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001211 "\n -context File has specified security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001212 IF_FEATURE_FIND_EXEC( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001213 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1214 "\n matching files") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001215 IF_FEATURE_FIND_PRUNE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001216 "\n -prune Stop traversing current subtree") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001217 IF_FEATURE_FIND_DELETE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001218 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001219 IF_FEATURE_FIND_PAREN( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001220 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001221
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001222#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001223 "$ find / -name passwd\n" \
1224 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001225
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001226#define flash_eraseall_trivial_usage \
1227 "[-jq] MTD_DEVICE"
1228#define flash_eraseall_full_usage "\n\n" \
1229 "Erase an MTD device\n" \
1230 "\nOptions:" \
1231 "\n -j format the device for jffs2" \
1232 "\n -q don't display progress messages"
1233
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001234#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001235 "[-bs] [-w WIDTH] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001236#define fold_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001237 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001238 "standard output\n" \
1239 "\nOptions:" \
1240 "\n -b Count bytes rather than columns" \
1241 "\n -s Break at spaces" \
1242 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001243
Eric Andersen7e9276b2001-02-22 01:15:47 +00001244#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001245 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001246#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001247 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001248#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001249 "$ free\n" \
1250 " total used free shared buffers\n" \
1251 " Mem: 257628 248724 8904 59644 93124\n" \
1252 " Swap: 128516 8404 120112\n" \
1253 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001254
Eric Andersen7e9276b2001-02-22 01:15:47 +00001255#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001256 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001257#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001258 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001259#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001260 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001261
Mike Frysinger51a43b42005-09-24 07:11:16 +00001262#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001263 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001264#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001265 "Check and repair filesystems\n" \
1266 "\nOptions:" \
1267 "\n -A Walk /etc/fstab and check all filesystems" \
1268 "\n -N Don't execute, just show what would be done" \
1269 "\n -P With -A, check filesystems in parallel" \
1270 "\n -R With -A, skip the root filesystem" \
1271 "\n -T Don't show title on startup" \
1272 "\n -V Verbose" \
1273 "\n -C n Write status information to specified filedescriptor" \
1274 "\n -t type List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001275
Eric Andersen7e9276b2001-02-22 01:15:47 +00001276#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001277 "[-larvsmf] /dev/name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001278#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001279 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001280 "\nOptions:" \
1281 "\n -l List all filenames" \
1282 "\n -r Perform interactive repairs" \
1283 "\n -a Perform automatic repairs" \
1284 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001285 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001286 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001287 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001288
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001289#define ftpd_trivial_usage \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001290 "[-wvS] [-t N] [-T N] [DIR]"
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001291#define ftpd_full_usage "\n\n" \
1292 "FTP server\n" \
1293 "\n" \
1294 "ftpd should be used as an inetd service.\n" \
1295 "ftpd's line for inetd.conf:\n" \
1296 " 21 stream tcp nowait root ftpd ftpd /files/to/serve\n" \
1297 "It also can be ran from tcpsvd:\n" \
1298 " tcpsvd -vE 0.0.0.0 21 ftpd /files/to/serve\n" \
1299 "\nOptions:" \
1300 "\n -w Allow upload" \
Denis Vlasenko4221e902009-03-11 15:07:44 +00001301 "\n -v Log to stderr" \
1302 "\n -S Log to syslog" \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001303 "\n -t,-T Idle and absolute timeouts" \
Denis Vlasenko92576712009-03-09 16:25:33 +00001304 "\n DIR Change root to this directory" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001305
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001306#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001307 "[options] remote-host local-file remote-file"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001308#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001309 "Retrieve a remote file via FTP\n" \
1310 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001311 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001312 "\n -c,--continue Continue previous transfer" \
1313 "\n -v,--verbose Verbose" \
1314 "\n -u,--username Username" \
1315 "\n -p,--password Password" \
1316 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001317 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001318 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001319 "\n -c Continue previous transfer" \
1320 "\n -v Verbose" \
1321 "\n -u Username" \
1322 "\n -p Password" \
1323 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001324 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001325
1326#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001327 "[options] remote-host remote-file local-file"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001328#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001329 "Store a local file on a remote machine via FTP\n" \
1330 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001331 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001332 "\n -v,--verbose Verbose" \
1333 "\n -u,--username Username" \
1334 "\n -p,--password Password" \
1335 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001336 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001337 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001338 "\n -v Verbose" \
1339 "\n -u Username" \
1340 "\n -p Password" \
1341 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001342 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001343
Rob Landleyaa872762005-10-28 13:05:12 +00001344#define fuser_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001345 "[options] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001346#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001347 "Find processes which use FILEs or PORTs\n" \
1348 "\nOptions:" \
1349 "\n -m Find processes which use same fs as FILEs" \
1350 "\n -4 Search only IPv4 space" \
1351 "\n -6 Search only IPv6 space" \
1352 "\n -s Silent: just exit with 0 if any processes are found" \
1353 "\n -k Kill found processes (otherwise display PIDs)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001354 "\n -SIGNAL Signal to send (default: TERM)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001355
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001356#define getenforce_trivial_usage NOUSAGE_STR
1357#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001358
Eric Andersen7e9276b2001-02-22 01:15:47 +00001359#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001360 "[OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001361#define getopt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001362 "Parse command options\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001363 IF_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001364 "\n -a,--alternative Allow long options starting with single -" \
1365 "\n -l,--longoptions=longopts Long options to be recognized" \
1366 "\n -n,--name=progname The name under which errors are reported" \
1367 "\n -o,--options=optstring Short options to be recognized" \
1368 "\n -q,--quiet Disable error reporting by getopt(3)" \
1369 "\n -Q,--quiet-output No normal output" \
1370 "\n -s,--shell=shell Set shell quoting conventions" \
1371 "\n -T,--test Test for getopt(1) version" \
1372 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001373 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001374 IF_NOT_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001375 "\n -a Allow long options starting with single -" \
1376 "\n -l longopts Long options to be recognized" \
1377 "\n -n progname The name under which errors are reported" \
1378 "\n -o optstring Short options to be recognized" \
1379 "\n -q Disable error reporting by getopt(3)" \
1380 "\n -Q No normal output" \
1381 "\n -s shell Set shell quoting conventions" \
1382 "\n -T Test for getopt(1) version" \
1383 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001384 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001385#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001386 "$ cat getopt.test\n" \
1387 "#!/bin/sh\n" \
1388 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1389 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001390 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001391 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001392 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001393 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001394 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1395 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001396 " -c|--c-long)\n" \
1397 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001398 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1399 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1400 " esac;;\n" \
1401 " --) shift; break;;\n" \
1402 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001403 " esac\n" \
1404 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001405
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001406#define getsebool_trivial_usage \
1407 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001408#define getsebool_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001409 " -a Show all SELinux booleans"
1410
Eric Andersenf349e972001-08-21 16:18:59 +00001411#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001412 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001413#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001414 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1415 "\nOptions:" \
1416 "\n -h Enable hardware (RTS/CTS) flow control" \
1417 "\n -i Do not display /etc/issue before running login" \
1418 "\n -L Local line, do not do carrier detect" \
1419 "\n -m Get baud rate from modem's CONNECT status message" \
1420 "\n -w Wait for a CR or LF before sending /etc/issue" \
1421 "\n -n Do not prompt the user for a login name" \
1422 "\n -f issue_file Display issue_file instead of /etc/issue" \
1423 "\n -l login_app Invoke login_app instead of /bin/login" \
1424 "\n -t timeout Terminate after timeout if no username is read" \
1425 "\n -I initstring Init string to send before anything else" \
1426 "\n -H login_host Log login_host into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001427
Eric Andersen7e9276b2001-02-22 01:15:47 +00001428#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001429 "[-HhrilLnqvso" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001430 IF_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001431 "eF" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001432 IF_FEATURE_GREP_EGREP_ALIAS("E") \
1433 IF_FEATURE_GREP_CONTEXT("ABC") \
1434 IF_EXTRA_COMPAT("z") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001435 "] PATTERN [FILEs...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001436#define grep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001437 "Search for PATTERN in each FILE or standard input\n" \
1438 "\nOptions:" \
1439 "\n -H Prefix output lines with filename where match was found" \
1440 "\n -h Suppress the prefixing filename on output" \
1441 "\n -r Recurse subdirectories" \
1442 "\n -i Ignore case distinctions" \
1443 "\n -l List names of files that match" \
1444 "\n -L List names of files that do not match" \
1445 "\n -n Print line number with output lines" \
1446 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1447 "\n -v Select non-matching lines" \
1448 "\n -s Suppress file open/read error messages" \
1449 "\n -c Only print count of matching lines" \
1450 "\n -o Show only the part of a line that matches PATTERN" \
1451 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001452 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001453 "\n -w Match whole words only") \
1454 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001455 IF_FEATURE_GREP_EGREP_ALIAS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001456 "\n -E PATTERN is an extended regular expression") \
1457 "\n -e PTRN Pattern to match" \
1458 "\n -f FILE Read pattern from file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001459 IF_FEATURE_GREP_CONTEXT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001460 "\n -A Print NUM lines of trailing context" \
1461 "\n -B Print NUM lines of leading context" \
1462 "\n -C Print NUM lines of output context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001463 IF_EXTRA_COMPAT( \
Denis Vlasenko83518d12009-03-20 22:17:13 +00001464 "\n -z Input is NUL terminated") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001465
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001466#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001467 "$ grep root /etc/passwd\n" \
1468 "root:x:0:0:root:/root:/bin/bash\n" \
1469 "$ grep ^[rR]oo. /etc/passwd\n" \
1470 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001471
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001472#define egrep_trivial_usage NOUSAGE_STR
1473#define egrep_full_usage ""
1474
1475#define fgrep_trivial_usage NOUSAGE_STR
1476#define fgrep_full_usage ""
1477
Eric Andersen7e9276b2001-02-22 01:15:47 +00001478#define gunzip_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001479 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001480#define gunzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001481 "Uncompress FILEs (or standard input)\n" \
1482 "\nOptions:" \
1483 "\n -c Write to standard output" \
1484 "\n -f Force" \
1485 "\n -t Test file integrity" \
1486
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001487#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001488 "$ ls -la /tmp/BusyBox*\n" \
1489 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1490 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1491 "$ ls -la /tmp/BusyBox*\n" \
1492 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001493
1494#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001495 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001496#define gzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001497 "Compress FILEs (or standard input)\n" \
1498 "\nOptions:" \
1499 "\n -c Write to standard output" \
1500 "\n -d Decompress" \
1501 "\n -f Force" \
1502
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001503#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001504 "$ ls -la /tmp/busybox*\n" \
1505 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1506 "$ gzip /tmp/busybox.tar\n" \
1507 "$ ls -la /tmp/busybox*\n" \
1508 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001509
1510#define halt_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001511 "[-d delay] [-n] [-f]" IF_FEATURE_WTMP(" [-w]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001512#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001513 "Halt the system\n" \
1514 "\nOptions:" \
1515 "\n -d Delay interval for halting" \
1516 "\n -n No call to sync()" \
1517 "\n -f Force halt (don't go through init)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001518 IF_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001519 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001520 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001521
Eric Andersen3443bd72003-07-22 07:30:36 +00001522#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001523 "[options] [device] .."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001524#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001525 "Options:" \
1526 "\n -a Get/set fs readahead" \
1527 "\n -A Set drive read-lookahead flag (0/1)" \
1528 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1529 "\n -B Set Advanced Power Management setting (1-255)" \
1530 "\n -c Get/set IDE 32-bit IO setting" \
1531 "\n -C Check IDE power mode status" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001532 IF_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001533 "\n -d Get/set using_dma flag") \
1534 "\n -D Enable/disable drive defect-mgmt" \
1535 "\n -f Flush buffer cache for device on exit" \
1536 "\n -g Display drive geometry" \
1537 "\n -h Display terse usage information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001538 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001539 "\n -i Display drive identification") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001540 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001541 "\n -I Detailed/current information directly from drive") \
1542 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1543 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1544 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1545 "\n -m Get/set multiple sector count" \
1546 "\n -n Get/set ignore-write-errors flag (0/1)" \
1547 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1548 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001549/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001550 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1551 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001552 IF_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001553 "\n -R Register an IDE interface (DANGEROUS)") \
1554 "\n -S Set standby (spindown) timeout" \
1555 "\n -t Perform device read timings" \
1556 "\n -T Perform cache read timings" \
1557 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001558 IF_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001559 "\n -U Un-register an IDE interface (DANGEROUS)") \
1560 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1561 "\n -V Display program version and exit immediately" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001562 IF_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001563 "\n -w Perform device reset (DANGEROUS)") \
1564 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001565 IF_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001566 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1567 "\n -X Set IDE xfer mode (DANGEROUS)" \
1568 "\n -y Put IDE drive in standby mode" \
1569 "\n -Y Put IDE drive to sleep" \
1570 "\n -Z Disable Seagate auto-powersaving mode" \
1571 "\n -z Re-read partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001572
Eric Andersen7e9276b2001-02-22 01:15:47 +00001573#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001574 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001575#define head_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001576 "Print first 10 lines of each FILE to standard output.\n" \
1577 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001578 "file name. With no FILE, or when FILE is -, read standard input.\n" \
1579 "\nOptions:" \
1580 "\n -n NUM Print first NUM lines instead of first 10" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001581 IF_FEATURE_FANCY_HEAD( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001582 "\n -c NUM Output the first NUM bytes" \
1583 "\n -q Never output headers giving file names" \
1584 "\n -v Always output headers giving file names") \
1585
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001586#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001587 "$ head -n 2 /etc/passwd\n" \
1588 "root:x:0:0:root:/root:/bin/bash\n" \
1589 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001590
Glenn L McGrath60281112001-11-02 11:39:46 +00001591#define hexdump_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001592 "[-bcCdefnosvx" IF_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001593#define hexdump_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001594 "Display file(s) or standard input in a user specified format\n" \
1595 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001596 "\n -b One-byte octal display" \
1597 "\n -c One-byte character display" \
1598 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1599 "\n -d Two-byte decimal display" \
1600 "\n -e FORMAT STRING" \
1601 "\n -f FORMAT FILE" \
1602 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1603 "\n -o Two-byte octal display" \
1604 "\n -s OFFSET Skip OFFSET bytes" \
1605 "\n -v Display all input data" \
1606 "\n -x Two-byte hexadecimal display" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001607 IF_FEATURE_HEXDUMP_REVERSE( \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001608 "\n -R Reverse of 'hexdump -Cv'") \
1609
1610#define hd_trivial_usage \
1611 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001612#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001613 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001614
Eric Andersen7e9276b2001-02-22 01:15:47 +00001615#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001616 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001617#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001618 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001619
1620#define hostname_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001621 "[OPTION] [hostname | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001622#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001623 "Get or set hostname or DNS domain name\n" \
1624 "\nOptions:" \
1625 "\n -s Short" \
1626 "\n -i Addresses for the hostname" \
1627 "\n -d DNS domain name" \
1628 "\n -f Fully qualified domain name" \
1629 "\n -F FILE Use the contents of FILE to specify the hostname" \
1630
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001631#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001632 "$ hostname\n" \
1633 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001634
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001635#define httpd_trivial_usage \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001636 "[-ifv[v]]" \
1637 " [-c CONFFILE]" \
1638 " [-p [IP:]PORT]" \
1639 IF_FEATURE_HTTPD_SETUID(" [-u USER[:GRP]]") \
1640 IF_FEATURE_HTTPD_BASIC_AUTH(" [-r REALM]") \
1641 " [-h HOME]\n" \
1642 "or httpd -d/-e" IF_FEATURE_HTTPD_AUTH_MD5("/-m") " STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001643#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001644 "Listen for incoming HTTP requests\n" \
1645 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001646 "\n -i Inetd mode" \
1647 "\n -f Do not daemonize" \
1648 "\n -v[v] Verbose" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001649 "\n -c FILE Configuration file (default httpd.conf)" \
1650 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001651 IF_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001652 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001653 IF_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001654 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001655 "\n -h HOME Home directory (default .)" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001656 IF_FEATURE_HTTPD_AUTH_MD5( \
1657 "\n -m STRING MD5 crypt STRING") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001658 "\n -e STRING HTML encode STRING" \
1659 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001660
Robert Griebl1cd04452002-07-21 16:50:49 +00001661#define hwclock_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001662 IF_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001663 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1664 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001665 " [-f FILE]" \
1666 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001667 IF_NOT_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001668 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1669 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001670#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001671 "Query and set hardware clock (RTC)\n" \
1672 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001673 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001674 "\n -s Set system time from hardware clock" \
1675 "\n -w Set hardware clock to system time" \
1676 "\n -u Hardware clock is in UTC" \
1677 "\n -l Hardware clock is in local time" \
1678 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001679
Eric Andersen7e9276b2001-02-22 01:15:47 +00001680#define id_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001681 "[OPTIONS]... [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001682#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001683 "Print information about USER or the current user\n" \
1684 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001685 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001686 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001687 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001688 "\n -u Print user ID" \
Denis Vlasenko4f3209b2008-09-13 12:51:10 +00001689 "\n -g Print group ID" \
1690 "\n -G Print supplementary group IDs" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001691 "\n -n Print name instead of a number" \
1692 "\n -r Print real user ID instead of effective ID" \
1693
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001694#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001695 "$ id\n" \
1696 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001697
Eric Andersen7e9276b2001-02-22 01:15:47 +00001698#define ifconfig_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001699 IF_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001700#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001701 "Configure a network interface\n" \
1702 "\nOptions:" \
1703 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001704 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001705 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001706 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001707 " [del ADDRESS[/PREFIXLEN]]\n") \
1708 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1709 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001710 IF_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001711 " [outfill NN] [keepalive NN]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001712 " " IF_FEATURE_IFCONFIG_HW("[hw ether" IF_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001713 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001714 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001715 IF_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001716 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001717 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001718
Denis Vlasenko06aed432008-02-26 18:25:24 +00001719#define ifenslave_trivial_usage \
1720 "[-cdf] master-iface <slave-iface...>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001721#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001722 "Configure network interfaces for parallel routing\n" \
1723 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001724 "\n -c, --change-active Change active slave" \
1725 "\n -d, --detach Remove slave interface from bonding device" \
1726 "\n -f, --force Force, even if interface is not Ethernet" \
1727/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001728
Denis Vlasenko06aed432008-02-26 18:25:24 +00001729#define ifenslave_example_usage \
1730 "To create a bond device, simply follow these three steps :\n" \
1731 "- ensure that the required drivers are properly loaded :\n" \
1732 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
1733 "- assign an IP address to the bond device :\n" \
1734 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
1735 "- attach all the interfaces you need to the bond device :\n" \
1736 " # ifenslave bond0 eth0 eth1 eth2\n" \
1737 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1738 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
1739 " To detach a dead interface without setting the bond device down :\n" \
1740 " # ifenslave -d bond0 eth1\n\n" \
1741 " To set the bond device down and automatically release all the slaves :\n" \
1742 " # ifconfig bond0 down\n\n" \
1743 " To change active slave :\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001744 " # ifenslave -c bond0 eth0\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001745
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001746#define ifup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001747 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001748#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001749 "Options:" \
1750 "\n -a De/configure all interfaces automatically" \
1751 "\n -i FILE Use FILE for interface definitions" \
1752 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001753 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001754 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001755 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001756 ) \
1757 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001758 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001759
1760#define ifdown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001761 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001762#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001763 "Options:" \
1764 "\n -a De/configure all interfaces automatically" \
1765 "\n -i FILE Use FILE for interface definitions" \
1766 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001767 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001768 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001769 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001770 ) \
1771 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001772 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001773
Glenn L McGrath06e95652003-02-09 06:51:14 +00001774#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001775 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001776#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001777 "Listen for network connections and launch programs\n" \
1778 "\nOptions:" \
1779 "\n -f Run in foreground" \
1780 "\n -e Log to stderr" \
1781 "\n -q N Socket listen queue (default: 128)" \
1782 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001783 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001784
Eric Andersen7e9276b2001-02-22 01:15:47 +00001785#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001786 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001787#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001788 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001789
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001790#define init_notes_usage \
1791"This version of init is designed to be run only by the kernel.\n" \
1792"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001793"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001794"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001795"runlevels, use sysvinit.\n" \
1796"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001797"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001798"it has the following default behavior:\n" \
1799"\n" \
1800" ::sysinit:/etc/init.d/rcS\n" \
1801" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001802" ::ctrlaltdel:/sbin/reboot\n" \
1803" ::shutdown:/sbin/swapoff -a\n" \
1804" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001805" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001806"\n" \
1807"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1808"\n" \
1809" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001810" tty3::askfirst:/bin/sh\n" \
1811" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001812"\n" \
1813"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1814"\n" \
1815" <id>:<runlevels>:<action>:<process>\n" \
1816"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001817" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001818"\n" \
1819" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1820" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001821" the specified process to run on. The contents of this field are\n" \
1822" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1823" be unique, although if it isn't you may have strange results. If this\n" \
1824" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001825" note that if BusyBox detects that a serial console is in use, then only\n" \
1826" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001827" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001828" stinkin' utmp.\n" \
1829"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001830" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001831"\n" \
1832" The runlevels field is completely ignored.\n" \
1833"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001834" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001835"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001836" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001837" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001838"\n" \
1839" The available actions can be classified into two groups: actions\n" \
1840" that are run only once, and actions that are re-run when the specified\n" \
1841" process exits.\n" \
1842"\n" \
1843" Run only-once actions:\n" \
1844"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001845" 'sysinit' is the first item run on boot. init waits until all\n" \
1846" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001847" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001848" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001849" the specified task completes. 'once' actions are asynchronous,\n" \
1850" therefore, init does not wait for them to complete. 'restart' is\n" \
1851" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001852" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001853" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001854" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001855" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001856" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001857" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001858" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001859" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001860"\n" \
1861" Run repeatedly actions:\n" \
1862"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001863" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001864" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001865" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1866" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001867" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001868" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001869" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001870" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001871"\n" \
1872" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001873" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001874" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001875"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001876" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001877"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001878" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001879"\n" \
1880"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001881"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001882" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001883" #\n" \
1884" ::sysinit:/etc/init.d/rcS\n" \
1885" \n" \
1886" # /bin/sh invocations on selected ttys\n" \
1887" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001888" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001889" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001890" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001891" tty2::askfirst:-/bin/sh\n" \
1892" tty3::askfirst:-/bin/sh\n" \
1893" tty4::askfirst:-/bin/sh\n" \
1894" \n" \
1895" # /sbin/getty invocations for selected ttys\n" \
1896" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001897" tty4::respawn:/sbin/getty 38400 tty4\n" \
1898" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001899" \n" \
1900" \n" \
1901" # Example of how to put a getty on a serial line (for a terminal)\n" \
1902" #\n" \
1903" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1904" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1905" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001906" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001907" #::respawn:/sbin/getty 57600 ttyS2\n" \
1908" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001909" # Stuff to do when restarting the init process\n" \
1910" ::restart:/sbin/init\n" \
1911" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001912" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001913" ::ctrlaltdel:/sbin/reboot\n" \
1914" ::shutdown:/bin/umount -a -r\n" \
1915" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001916
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001917#define inotifyd_trivial_usage \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001918 "PROG FILE1[:MASK] ..."
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001919#define inotifyd_full_usage "\n\n" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001920 "Run PROG on filesystem changes." \
1921 "\nWhen a filesystem event matching MASK occurs on FILEn," \
1922 "\nPROG <actual_event(s)> <FILEn> [<subfile_name>] is run." \
Denis Vlasenko289ff0e2008-11-14 21:52:16 +00001923 "\nEvents:" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001924 "\n a File is accessed" \
1925 "\n c File is modified" \
1926 "\n e Metadata changed" \
1927 "\n w Writtable file is closed" \
1928 "\n 0 Unwrittable file is closed" \
1929 "\n r File is opened" \
Denis Vlasenkoa09a42c2008-11-17 22:19:18 +00001930 "\n D File is deleted" \
1931 "\n M File is moved" \
1932 "\n u Backing fs is unmounted" \
1933 "\n o Event queue overflowed" \
1934 "\n x File can't be watched anymore" \
1935 "\nIf watching a directory:" \
1936 "\n m Subfile is moved into dir" \
1937 "\n y Subfile is moved out of dir" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001938 "\n n Subfile is created" \
1939 "\n d Subfile is deleted" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001940 "\n" \
1941 "\ninotifyd waits for PROG to exit." \
1942 "\nWhen x event happens for all FILEs, inotifyd exits" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001943
Denis Vlasenko36309cf2008-11-22 18:29:01 +00001944/* 2.6 style insmod has no options and required filename
1945 * (not module name - .ko can't be omitted) */
Eric Andersen7e9276b2001-02-22 01:15:47 +00001946#define insmod_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001947 IF_FEATURE_2_4_MODULES("[OPTION]... MODULE ") \
1948 IF_NOT_FEATURE_2_4_MODULES("FILE ") \
Denis Vlasenko36309cf2008-11-22 18:29:01 +00001949 "[symbol=value]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001950#define insmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001951 "Load the specified kernel modules into the kernel" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001952 IF_FEATURE_2_4_MODULES( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001953 "\nOptions:" \
1954 "\n -f Force module to load into the wrong kernel version" \
1955 "\n -k Make module autoclean-able" \
1956 "\n -v Verbose" \
1957 "\n -q Quiet" \
1958 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001959 IF_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001960 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001961 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001962 "\n -o NAME Set internal module name to NAME" \
1963 "\n -x Do not export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001964 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001965
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00001966/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001967#define install_trivial_usage \
Denis Vlasenko4acdb462009-01-31 21:45:57 +00001968 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [source] dest|directory"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001969#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001970 "Copy files and set attributes\n" \
1971 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001972 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001973 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00001974 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001975 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001976 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001977 "\n -o USER Set ownership" \
1978 "\n -g GRP Set group ownership" \
1979 "\n -m MODE Set permissions" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001980 IF_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001981 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001982 )
Denis Vlasenko397de612008-03-17 08:55:44 +00001983
Denis Vlasenko4acdb462009-01-31 21:45:57 +00001984#define ionice_trivial_usage \
1985 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
1986#define ionice_full_usage "\n\n" \
1987 "Change I/O scheduling class and priority\n" \
1988 "\nOptions:" \
1989 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
1990 "\n -n Priority" \
1991
Denis Vlasenko397de612008-03-17 08:55:44 +00001992/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001993#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001994 "[OPTIONS] {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001995 IF_FEATURE_IP_ADDRESS("address | ") \
1996 IF_FEATURE_IP_ROUTE("route | ") \
1997 IF_FEATURE_IP_LINK("link | ") \
1998 IF_FEATURE_IP_TUNNEL("tunnel | ") \
1999 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002000 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002001#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002002 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002003 "where OBJECT := {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002004 IF_FEATURE_IP_ADDRESS("address | ") \
2005 IF_FEATURE_IP_ROUTE("route | ") \
2006 IF_FEATURE_IP_LINK("link | ") \
2007 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2008 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002009 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002010 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002011
2012#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002013 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002014 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002015#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002016 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002017 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
2018 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002019 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002020 " [broadcast ADDR] [anycast ADDR]\n" \
2021 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002022 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002023
Eric Andersende4f07e2003-12-11 01:18:07 +00002024#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002025 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002026#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002027 "Calculate IP network settings from a IP address\n" \
2028 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002029 IF_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002030 "\n -b,--broadcast Display calculated broadcast address" \
2031 "\n -n,--network Display calculated network address" \
2032 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002033 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002034 "\n -p,--prefix Display the prefix for IP/NETMASK" \
2035 "\n -h,--hostname Display first resolved host name" \
2036 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002037 ) \
2038 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002039 IF_NOT_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002040 "\n -b Display calculated broadcast address" \
2041 "\n -n Display calculated network address" \
2042 "\n -m Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002043 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002044 "\n -p Display the prefix for IP/NETMASK" \
2045 "\n -h Display first resolved host name" \
2046 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002047 ) \
2048 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00002049
Rob Landley6eb1e412005-06-20 04:30:36 +00002050#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002051 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002052#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002053 "Upper-case options MQS remove an object by shmkey value.\n" \
2054 "Lower-case options remove an object by shmid value.\n" \
2055 "\nOptions:" \
2056 "\n -mM Remove memory segment after last detach" \
2057 "\n -qQ Remove message queue" \
2058 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002059
2060#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002061 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002062#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002063 " -i Show specific resource" \
2064 "\nResource specification:" \
2065 "\n -m Shared memory segments" \
2066 "\n -q Message queues" \
2067 "\n -s Semaphore arrays" \
2068 "\n -a All (default)" \
2069 "\nOutput format:" \
2070 "\n -t Time" \
2071 "\n -c Creator" \
2072 "\n -p Pid" \
2073 "\n -l Limits" \
2074 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002075
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002076#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002077 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002078#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00002079 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002080 " dynamic { on | off } |\n" \
2081 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002082 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002083
2084#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002085 "{ list | flush | { add | del | change | append |\n" \
2086 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002087#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002088 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002089 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
2090 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002091 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002092 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00002093 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
2094 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002095
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002096#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002097 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002098#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002099 "iprule [list | add | del] SELECTOR ACTION\n" \
2100 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2101 " [dev STRING] [pref NUMBER]\n" \
2102 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2103 " [prohibit | reject | unreachable]\n" \
2104 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002105 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002106
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002107#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002108 "{ add | change | del | show } [NAME]\n" \
2109 " [mode { ipip | gre | sit }]\n" \
2110 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002111#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002112 "iptunnel { add | change | del | show } [NAME]\n" \
2113 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2114 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002115 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002116
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002117#define kbd_mode_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002118 "[-a|k|s|u] [-C TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002119#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002120 "Report or set the keyboard mode\n" \
2121 "\nOptions set mode:" \
2122 "\n -a Default (ASCII)" \
2123 "\n -k Medium-raw (keyboard)" \
2124 "\n -s Raw (scancode)" \
2125 "\n -u Unicode (utf-8)" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002126 "\n -C TTY Affect TTY instead of /dev/tty" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002127
Eric Andersen7e9276b2001-02-22 01:15:47 +00002128#define kill_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002129 "[-l] [-SIG] PID..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002130#define kill_full_usage "\n\n" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002131 "Send a signal (default is TERM) to given PIDs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002132 "\nOptions:" \
2133 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002134/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002135
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002136#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002137 "$ ps | grep apache\n" \
2138 "252 root root S [apache]\n" \
2139 "263 www-data www-data S [apache]\n" \
2140 "264 www-data www-data S [apache]\n" \
2141 "265 www-data www-data S [apache]\n" \
2142 "266 www-data www-data S [apache]\n" \
2143 "267 www-data www-data S [apache]\n" \
2144 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002145
2146#define killall_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002147 "[-l] [-q] [-SIG] process-name..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002148#define killall_full_usage "\n\n" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002149 "Send a signal (default is TERM) to given processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002150 "\nOptions:" \
2151 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002152/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002153 "\n -q Do not complain if no processes were killed" \
2154
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002155#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002156 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002157
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002158#define killall5_trivial_usage \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002159 "[-l] [-SIG] [-o PID]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002160#define killall5_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002161 "Send a signal (default is TERM) to all processes outside current session\n" \
2162 "\nOptions:" \
2163 "\n -l List all signal names and numbers" \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002164 "\n -o PID Do not signal this PID" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002165/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002166
Mark Whitley6317c4b2001-03-12 22:51:50 +00002167#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002168 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002169#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002170 "Kernel logger\n" \
2171 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002172 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002173 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002174
Eric Andersen7e9276b2001-02-22 01:15:47 +00002175#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002176 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002177#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002178 "Print STRING's length"
2179
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002180#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002181 "$ length Hello\n" \
2182 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002183
Rob Landley9200e792005-09-15 19:26:59 +00002184#define less_trivial_usage \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002185 "[-EMNmh~I?] [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002186#define less_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002187 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002188 "changed, and files can be manipulated in various ways.\n" \
2189 "\nOptions:" \
2190 "\n -E Quit once the end of a file is reached" \
2191 "\n -M,-m Display a status line containing the line numbers" \
2192 "\n and percentage through the file" \
2193 "\n -N Prefix line numbers to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002194 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002195 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002196
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002197#define linux32_trivial_usage NOUSAGE_STR
2198#define linux32_full_usage ""
2199#define linux64_trivial_usage NOUSAGE_STR
2200#define linux64_full_usage ""
2201
2202#define linuxrc_trivial_usage NOUSAGE_STR
2203#define linuxrc_full_usage ""
2204
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002205#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002206 "personality program [args...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002207#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002208 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002209 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002210 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002211
Eric Andersen7e9276b2001-02-22 01:15:47 +00002212#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002213 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002214#define ln_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002215 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002216 "Use '--' to indicate that all following arguments are non-options.\n" \
2217 "\nOptions:" \
2218 "\n -s Make symlinks instead of hardlinks" \
2219 "\n -f Remove existing destination files" \
2220 "\n -n Don't dereference symlinks - treat like normal file" \
2221 "\n -b Make a backup of the target (if exists) before link operation" \
2222 "\n -S suf Use suffix instead of ~ when making backup files" \
2223
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002224#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002225 "$ ln -s BusyBox /tmp/ls\n" \
2226 "$ ls -l /tmp/ls\n" \
2227 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002228
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002229#define load_policy_trivial_usage NOUSAGE_STR
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002230#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002231
Eric Andersen7e9276b2001-02-22 01:15:47 +00002232#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002233 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002234#define loadfont_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002235 "Load a console font from standard input" \
2236/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2237
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002238#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002239 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002240
2241#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002242 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002243#define loadkmap_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002244 "Load a binary keyboard translation table from standard input\n" \
2245/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2246
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002247#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002248 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002249
2250#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002251 "[OPTION]... [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002252#define logger_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002253 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n" \
2254 "\nOptions:" \
2255 "\n -s Log to stderr as well as the system log" \
2256 "\n -t TAG Log using the specified tag (defaults to user name)" \
2257 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002258
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002259#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002260 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002261
Robert Griebl1fca5582002-06-04 20:45:46 +00002262#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002263 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002264#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002265 "Begin a new session on the system\n" \
2266 "\nOptions:" \
2267 "\n -f Do not authenticate (user already authenticated)" \
2268 "\n -h Name of the remote host" \
2269 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002270
Eric Andersen7e9276b2001-02-22 01:15:47 +00002271#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002272 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002273#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002274 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002275#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002276 "$ logname\n" \
2277 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002278
Mark Whitley6317c4b2001-03-12 22:51:50 +00002279#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002280 "[OPTION]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002281#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002282 "Show messages in syslogd's circular buffer\n" \
2283 "\nOptions:" \
2284 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002285
Matt Kraai83788da2002-03-20 17:38:37 +00002286#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002287 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2288 " losetup -d LOOPDEV - disassociate\n" \
2289 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002290#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002291 "Options:" \
2292 "\n -o OFS Start OFS bytes into FILE" \
2293 "\n -f Show first free loop device" \
2294
Rob Landley1d589b22005-11-29 23:47:10 +00002295#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002296 "No arguments will display all current associations.\n" \
2297 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002298 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002299 "and filename of the file the loop device is currently bound to.\n\n" \
2300 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002301 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2302 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002303
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002304#define lpd_trivial_usage \
Denis Vlasenkoa7942892008-03-23 23:40:18 +00002305 "SPOOLDIR [HELPER [ARGS...]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002306#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002307 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2308 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002309 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002310 "\ndirectory and HELPER program is called. Name of file to print" \
2311 "\nis passed in $DATAFILE variable." \
2312 "\nExample:" \
2313 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002314
Denis Vlasenko68444b92008-02-22 22:24:48 +00002315#define lpq_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002316 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID...] [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002317#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002318 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002319 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002320 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002321 "\n -f Force any waiting job to be printed" \
2322 "\n -s Short display" \
2323
2324#define lpr_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002325 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE...]"
2326/* -C CLASS exists too, not shown.
2327 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002328#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002329 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002330 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002331 "\n -m Send mail on completion" \
2332 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002333 "\n -V Verbose" \
2334
Eric Andersen7e9276b2001-02-22 01:15:47 +00002335#define ls_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002336 "[-1Aa" IF_FEATURE_LS_TIMESTAMPS("c") "Cd" \
2337 IF_FEATURE_LS_TIMESTAMPS("e") IF_FEATURE_LS_FILETYPES("F") "iln" \
2338 IF_FEATURE_LS_FILETYPES("p") IF_FEATURE_LS_FOLLOWLINKS("L") \
2339 IF_FEATURE_LS_RECURSIVE("R") IF_FEATURE_LS_SORTFILES("rS") "s" \
2340 IF_FEATURE_AUTOWIDTH("T") IF_FEATURE_LS_TIMESTAMPS("tu") \
2341 IF_FEATURE_LS_SORTFILES("v") IF_FEATURE_AUTOWIDTH("w") "x" \
2342 IF_FEATURE_LS_SORTFILES("X") IF_FEATURE_HUMAN_READABLE("h") "k" \
2343 IF_SELINUX("K") "] [filenames...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002344#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002345 "List directory contents\n" \
2346 "\nOptions:" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002347 "\n -1 List in a single column" \
2348 "\n -A Don't list . and .." \
2349 "\n -a Don't hide entries starting with ." \
2350 "\n -C List by columns" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002351 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002352 "\n -c With -l: sort by ctime") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002353 IF_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002354 "\n --color[={always,never,auto}] Control coloring") \
2355 "\n -d List directory entries instead of contents" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002356 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002357 "\n -e List full date and time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002358 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002359 "\n -F Append indicator (one of */=@|) to entries") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002360 "\n -i List inode numbers" \
2361 "\n -l Long listing format" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002362 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002363 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002364 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002365 IF_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002366 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002367 IF_FEATURE_LS_RECURSIVE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002368 "\n -R List subdirectories recursively") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002369 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002370 "\n -r Sort in reverse order") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002371 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002372 "\n -S Sort by file size") \
Denis Vlasenko397de612008-03-17 08:55:44 +00002373 "\n -s List the size of each file, in blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002374 IF_FEATURE_AUTOWIDTH( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002375 "\n -T NUM Assume tabstop every NUM columns") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002376 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002377 "\n -t With -l: sort by modification time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002378 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002379 "\n -u With -l: sort by access time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002380 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002381 "\n -v Sort by version") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002382 IF_FEATURE_AUTOWIDTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002383 "\n -w NUM Assume the terminal is NUM columns wide") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002384 "\n -x List by lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002385 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002386 "\n -X Sort by extension") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002387 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002388 "\n -h List sizes in human readable format (1K 243M 2G)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002389 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002390 "\n -k List security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002391 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002392 "\n -K List security context in long format") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002393 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002394 "\n -Z List security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002395
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002396#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002397 "[-Radlv] [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002398#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002399 "List file attributes on an ext2 fs\n" \
2400 "\nOptions:" \
2401 "\n -R Recursively list subdirectories" \
2402 "\n -a Do not hide entries starting with ." \
2403 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002404 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002405 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002406
Eric Andersen7e9276b2001-02-22 01:15:47 +00002407#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002408 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002409#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002410 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002411
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002412#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002413#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002414 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002415#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002416 "Create a range of block or character special files" \
2417 "\n" \
2418 "\nTYPE is:" \
2419 "\n b Block device" \
2420 "\n c Character device" \
2421 "\n f FIFO, MAJOR and MINOR are ignored" \
2422 "\n" \
2423 "\nFIRST..LAST specify numbers appended to NAME." \
2424 "\nIf 's' is the last argument, the base device is created as well." \
2425 "\n" \
2426 "\nExamples:" \
2427 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2428 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002429#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002430 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2431 "[creates ttyS2-ttyS63]\n" \
2432 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2433 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002434#endif
2435
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002436#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002437#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002438 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002439#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002440 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002441 "Device table entries take the form of:\n" \
2442 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002443 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002444 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002445 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002446 " c Character device\n" \
2447 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002448 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002449 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002450 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2451 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002452#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002453 "For example:\n" \
2454 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2455 "/dev d 755 0 0 - - - - -\n" \
2456 "/dev/console c 666 0 0 5 1 - - -\n" \
2457 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2458 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2459 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2460 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2461 "Will Produce:\n" \
2462 "/dev\n" \
2463 "/dev/console\n" \
2464 "/dev/null\n" \
2465 "/dev/zero\n" \
2466 "/dev/hda\n" \
2467 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002468#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002469
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002470#define makemime_trivial_usage \
2471 "[OPTION]... [FILE]..."
2472#define makemime_full_usage "\n\n" \
2473 "Create MIME-encoded message\n" \
2474 "\nOptions:" \
2475 "\n -C Charset" \
Denis Vlasenkoc028ec22008-11-10 10:47:47 +00002476 "\n -e Transfer encoding. Ignored. base64 is assumed" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002477 "\n" \
2478 "\nOther options are silently ignored." \
2479
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002480#define man_trivial_usage \
2481 "[OPTION]... [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002482#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002483 "Format and display manual page\n" \
2484 "\nOptions:" \
2485 "\n -a Display all pages" \
2486 "\n -w Show page locations" \
2487
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002488#define matchpathcon_trivial_usage \
2489 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002490#define matchpathcon_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002491 " -n Do not display path" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002492 "\n -N Do not use translations" \
2493 "\n -f Use alternate file_context file" \
2494 "\n -p Use prefix to speed translations" \
2495 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002496
Eric Andersen7e9276b2001-02-22 01:15:47 +00002497#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002498 "[OPTION] [FILEs...]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002499 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002500#define md5sum_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002501 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2502 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002503 "\nOptions:" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002504 "\n -c Check sums against given list" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002505 "\n -s Don't output anything, status code shows success" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002506 "\n -w Warn about improperly formatted checksum lines" \
2507 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002508
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002509#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002510 "$ md5sum < busybox\n" \
2511 "6fd11e98b98a58f64ff3398d7b324003\n" \
2512 "$ md5sum busybox\n" \
2513 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2514 "$ md5sum -c -\n" \
2515 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2516 "busybox: OK\n" \
2517 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002518
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002519#define sha1sum_trivial_usage \
2520 "[OPTION] [FILEs...]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002521 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002522#define sha1sum_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002523 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
2524 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002525 "\nOptions:" \
2526 "\n -c Check sums against given list" \
2527 "\n -s Don't output anything, status code shows success" \
2528 "\n -w Warn about improperly formatted checksum lines" \
2529 )
2530
2531#define sha256sum_trivial_usage \
2532 "[OPTION] [FILEs...]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002533 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha256sum [OPTION] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002534#define sha256sum_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002535 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
2536 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002537 "\nOptions:" \
2538 "\n -c Check sums against given list" \
2539 "\n -s Don't output anything, status code shows success" \
2540 "\n -w Warn about improperly formatted checksum lines" \
2541 )
2542
2543#define sha512sum_trivial_usage \
2544 "[OPTION] [FILEs...]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002545 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha512sum [OPTION] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002546#define sha512sum_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002547 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
2548 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002549 "\nOptions:" \
2550 "\n -c Check sums against given list" \
2551 "\n -s Don't output anything, status code shows success" \
2552 "\n -w Warn about improperly formatted checksum lines" \
2553 )
2554
Rob Landley70f7ef72005-12-13 08:21:33 +00002555#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002556 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002557#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002558 " -s Scan /sys and populate /dev during system boot\n" \
2559 "\n" \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002560 "It can be run by kernel as a hotplug helper. To activate it:\n" \
2561 " echo /bin/mdev >/proc/sys/kernel/hotplug\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002562 IF_FEATURE_MDEV_CONF( \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002563 "It uses /etc/mdev.conf with lines\n" \
Denis Vlasenkof2b39e02009-04-13 23:18:52 +00002564 "[-]DEVNAME UID:GID PERM" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002565 IF_FEATURE_MDEV_RENAME(" [>|=PATH]") \
2566 IF_FEATURE_MDEV_EXEC(" [@|$|*COMMAND]") \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002567 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002568
Rob Landleyef10d522006-06-26 14:11:33 +00002569#define mdev_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002570 IF_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002571 "The mdev config file contains lines that look like:\n" \
2572 " hd[a-z][0-9]* 0:3 660\n\n" \
2573 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002574 IF_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002575 "Optionally, that can be followed (on the same line) by a special character\n" \
2576 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002577 "device(s). The environment variable $MDEV indicates the active device node\n" \
2578 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002579 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2580 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002581 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002582 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002583 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002584 "Config file parsing stops on the first matching line. If no config\n" \
2585 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002586 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002587 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002588
Glenn L McGrath061c9002002-09-16 04:21:46 +00002589#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002590 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002591#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002592 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002593 " y Allow write access to your terminal\n" \
2594 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002595
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002596#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002597 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002598#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002599 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2600 "\nOptions:" \
2601 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2602 "\n next byte to it" \
2603 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2604 "\n -s Set serial line to SPEED" \
2605 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002606
Eric Andersen7e9276b2001-02-22 01:15:47 +00002607#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002608 "[OPTION] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002609#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002610 "Create DIRECTORY\n" \
2611 "\nOptions:" \
2612 "\n -m Set permission mode (as in chmod), not rwxrwxrwx - umask" \
2613 "\n -p No error if existing, make parent directories as needed" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002614 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002615 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002616 )
2617
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002618#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002619 "$ mkdir /tmp/foo\n" \
2620 "$ mkdir /tmp/foo\n" \
2621 "/tmp/foo: File exists\n" \
2622 "$ mkdir /tmp/foo/bar/baz\n" \
2623 "/tmp/foo/bar/baz: No such file or directory\n" \
2624 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002625
Mike Frysinger6447ac02005-06-11 05:29:40 +00002626#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002627 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2628 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2629 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2630 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2631 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2632 "device [blocks-count]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002633#define mke2fs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002634 " -b size Block size in bytes" \
2635 "\n -c Check for bad blocks before creating" \
2636 "\n -E opts Set extended options" \
2637 "\n -f size Fragment size in bytes" \
2638 "\n -F Force (ignore sanity checks)" \
2639 "\n -g num Number of blocks in a block group" \
2640 "\n -i ratio The bytes/inode ratio" \
2641 "\n -j Create a journal (ext3)" \
2642 "\n -J opts Set journal options (size/device)" \
2643 "\n -l file Read bad blocks list from file" \
2644 "\n -L lbl Set the volume label" \
2645 "\n -m percent Percent of fs blocks to reserve for admin" \
2646 "\n -M dir Set last mounted directory" \
2647 "\n -n Do not actually create anything" \
2648 "\n -N num Number of inodes to create" \
2649 "\n -o os Set the 'creator os' field" \
2650 "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" \
2651 "\n -q Quiet" \
2652 "\n -r rev Set filesystem revision" \
2653 "\n -S Write superblock and group descriptors only" \
2654 "\n -T fs-type Set usage type (news/largefile/largefile4)" \
2655 "\n -v Verbose" \
Mike Frysinger6447ac02005-06-11 05:29:40 +00002656
Eric Andersen7e9276b2001-02-22 01:15:47 +00002657#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002658 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002659#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002660 "Create named pipe (identical to 'mknod name p')\n" \
2661 "\nOptions:" \
2662 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002663 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002664 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002665 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002666
Eric Andersen7e9276b2001-02-22 01:15:47 +00002667#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002668 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002669#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002670 "Make a MINIX filesystem\n" \
2671 "\nOptions:" \
2672 "\n -c Check device for bad blocks" \
2673 "\n -n [14|30] Maximum length of filenames" \
2674 "\n -i INODES Number of inodes for the filesystem" \
2675 "\n -l FILENAME Read bad blocks list from FILENAME" \
2676 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002677
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002678#define mkfs_vfat_trivial_usage \
2679 "[-v] [-n LABEL] FILE_OR_DEVICE [SIZE_IN_KB]"
2680/* Accepted but ignored:
2681 "[-c] [-C] [-I] [-l bad-block-file] [-b backup-boot-sector] "
2682 "[-m boot-msg-file] [-i volume-id] "
2683 "[-s sectors-per-cluster] [-S logical-sector-size] [-f number-of-FATs] "
2684 "[-h hidden-sectors] [-F fat-size] [-r root-dir-entries] [-R reserved-sectors] "
2685*/
2686#define mkfs_vfat_full_usage "\n\n" \
2687 "Make a FAT32 filesystem\n" \
2688 "\nOptions:" \
2689/* "\n -c Check device for bad blocks" */ \
2690 "\n -v Verbose" \
2691/* "\n -I Allow to use entire disk device (e.g. /dev/hda)" */ \
2692 "\n -n LBL Volume label" \
2693
Eric Andersen7e9276b2001-02-22 01:15:47 +00002694#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002695 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002696#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002697 "Create a special file (block, character, or pipe)\n" \
2698 "\nOptions:" \
2699 "\n -m Create the special file using the specified mode (default a=rw)" \
2700 "\nTYPEs include:" \
2701 "\n b: Make a block device" \
2702 "\n c or u: Make a character device" \
2703 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002704 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002705 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002706 )
2707
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002708#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002709 "$ mknod /dev/fd0 b 2 0\n" \
2710 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002711
Eric Andersen7e9276b2001-02-22 01:15:47 +00002712#define mkswap_trivial_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002713 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002714#define mkswap_full_usage "\n\n" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002715 "Prepare block device to be used as swap partition"
2716#if 0
2717 "[-c] [-v0|-v1] DEVICE [BLOCKS]"
Denis Vlasenko397de612008-03-17 08:55:44 +00002718 "\nOptions:"
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002719 "\n -c Check for readability"
2720 "\n -v0 Make swap version 0 (max 128M)"
2721 "\n -v1 Make swap version 1 (default for kernels > 2.1.117)"
2722 "\n BLOCKS Number of blocks to use (default is entire partition)"
2723#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002724
Eric Andersen7e9276b2001-02-22 01:15:47 +00002725#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002726 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002727#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002728 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002729 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002730 "\nOptions:" \
2731 "\n -d Make a directory instead of a file" \
2732/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2733 "\n -t Generate a path rooted in temporary directory" \
2734 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2735 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002736 "\nFor -t or -p, directory is chosen as follows:" \
2737 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002738
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002739#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002740 "$ mktemp /tmp/temp.XXXXXX\n" \
2741 "/tmp/temp.mWiLjM\n" \
2742 "$ ls -la /tmp/temp.mWiLjM\n" \
2743 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002744
Eric Andersen8d79ce82001-07-22 23:00:15 +00002745#define modprobe_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002746 "[-knqrsv] MODULE [symbol=value...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002747#define modprobe_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002748 "Options:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002749 IF_FEATURE_2_4_MODULES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002750 "\n -k Make module autoclean-able" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002751 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002752 "\n -n Dry run" \
2753 "\n -q Quiet" \
2754 "\n -r Remove module (stacks) or do autoclean" \
2755 "\n -s Report via syslog instead of stderr" \
2756 "\n -v Verbose" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002757 IF_FEATURE_MODPROBE_BLACKLIST( \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002758 "\n -b Apply blacklist to module names too" \
2759 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002760
Rob Landley9c32a152005-12-11 20:12:24 +00002761#define modprobe_notes_usage \
2762"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2763"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2764"pass each module it loads.\n" \
2765"\n" \
Bernhard Reutner-Fischer12aca792009-02-24 10:03:22 +00002766"The configuration file is searched (in this order):\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002767"\n" \
2768" /etc/modprobe.conf (2.6 only)\n" \
2769" /etc/modules.conf\n" \
2770" /etc/conf.modules (deprecated)\n" \
2771"\n" \
2772"They all have the same syntax (see below). If none is present, it is\n" \
2773"_not_ an error; each loaded module is then expected to load without\n" \
2774"options. Once a file is found, the others are tested for.\n" \
2775"\n" \
2776"/etc/modules.conf entry format:\n" \
2777"\n" \
2778" alias <alias_name> <mod_name>\n" \
2779" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002780" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002781" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2782" This makes it also possible to use a different set of options (below) for\n" \
2783" the module and the alias.\n" \
2784" A module can be aliased more than once.\n" \
2785"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002786" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002787" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2788" the \"symbol=value\" pairs as option to that module.\n" \
2789"\n" \
2790"Sample /etc/modules.conf file:\n" \
2791"\n" \
2792" options tulip irq=3\n" \
2793" alias tulip tulip2\n" \
2794" options tulip2 irq=4 io=0x308\n" \
2795"\n" \
2796"Other functionality offered by 'classic' modprobe is not available in\n" \
2797"this implementation.\n" \
2798"\n" \
2799"If module options are present both in the config file, and on the command line,\n" \
2800"then the options from the command line will be passed to the module _after_\n" \
2801"the options from the config file. That way, you can have defaults in the config\n" \
2802"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002803#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002804 "(with the above /etc/modules.conf):\n\n" \
2805 "$ modprobe tulip\n" \
2806 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2807 "$ modprobe tulip irq=5\n" \
2808 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2809 "$ modprobe tulip2\n" \
2810 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2811 " which are the default for alias 'tulip2'\n\n" \
2812 "$ modprobe tulip2 irq=8\n" \
2813 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2814 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2815 " from the command line\n\n" \
2816 "$ modprobe tulip2 irq=2 io=0x210\n" \
2817 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2818 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2819 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002820
Eric Andersen7e9276b2001-02-22 01:15:47 +00002821#define more_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002822 "[FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002823#define more_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002824 "View FILE or standard input one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002825
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002826#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002827 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002828
Eric Andersen7e9276b2001-02-22 01:15:47 +00002829#define mount_trivial_usage \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002830 "[flags] DEVICE NODE [-o OPT,OPT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002831#define mount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002832 "Mount a filesystem. Filesystem autodetection requires /proc be mounted.\n" \
2833 "\nOptions:" \
2834 "\n -a Mount all filesystems in fstab" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002835 IF_FEATURE_MOUNT_FAKE( \
2836 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002837 "\n -f Update /etc/mtab, but don't mount" \
2838 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002839 IF_NOT_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002840 "\n -f Dry run" \
2841 ) \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002842 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002843 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002844 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002845 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002846 "\n -r Read-only mount" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002847 "\n -w Read-write mount (default)" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002848 "\n -t FSTYPE Filesystem type" \
2849 "\n -O OPT Mount only filesystems with option OPT (-a only)" \
2850 "\n-o OPT:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002851 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002852 "\n loop Ignored (loop devices are autodetected)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002853 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002854 IF_FEATURE_MOUNT_FLAGS( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002855 "\n [a]sync Writes are [a]synchronous" \
2856 "\n [no]atime Disable/enable updates to inode access times" \
2857 "\n [no]diratime Disable/enable atime updates to directories" \
2858 "\n [no]relatime Disable/enable atime updates relative to modification time" \
2859 "\n [no]dev (Dis)allow use of special device files" \
2860 "\n [no]exec (Dis)allow use of executable files" \
2861 "\n [no]suid (Dis)allow set-user-id-root programs" \
2862 "\n [r]shared Convert [recursively] to a shared subtree" \
2863 "\n [r]slave Convert [recursively] to a slave subtree" \
2864 "\n [r]private Convert [recursively] to a private subtree" \
2865 "\n [un]bindable Make mount point [un]able to be bind mounted" \
2866 "\n bind Bind a directory to an additional location" \
2867 "\n move Relocate an existing mount point" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002868 ) \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002869 "\n remount Remount a mounted filesystem, changing its flags" \
2870 "\n ro/rw Read-only/read-write mount" \
2871 "\n" \
2872 "\nThere are EVEN MORE flags that are specific to each filesystem" \
2873 "\nYou'll have to see the written documentation for those filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002874
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002875#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002876 "$ mount\n" \
2877 "/dev/hda3 on / type minix (rw)\n" \
2878 "proc on /proc type proc (rw)\n" \
2879 "devpts on /dev/pts type devpts (rw)\n" \
2880 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2881 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2882 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002883#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002884 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002885
Rob Landleyd00b3a52005-08-20 05:07:08 +00002886#define mountpoint_trivial_usage \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002887 "[-q] <[-dn] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002888#define mountpoint_full_usage "\n\n" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002889 "Check if the directory is a mountpoint\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002890 "\nOptions:" \
2891 "\n -q Quiet" \
2892 "\n -d Print major/minor device number of the filesystem" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002893 "\n -n Print device name of the filesystem" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002894 "\n -x Print major/minor device number of the blockdevice" \
2895
Rob Landleyd00b3a52005-08-20 05:07:08 +00002896#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002897 "$ mountpoint /proc\n" \
2898 "/proc is not a mountpoint\n" \
2899 "$ mountpoint /sys\n" \
2900 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002901
Eric Andersen7e9276b2001-02-22 01:15:47 +00002902#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002903 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002904#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002905 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002906 "\n" \
2907 "Available Opcodes:\n" \
2908 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002909 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2910 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2911 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002912 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002913
Eric Andersen7e9276b2001-02-22 01:15:47 +00002914#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002915 "[OPTION]... SOURCE DEST\n" \
2916 "or: mv [OPTION]... SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002917#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002918 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
2919 "\nOptions:" \
2920 "\n -f Don't prompt before overwriting" \
2921 "\n -i Interactive, prompt before overwrite" \
2922
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002923#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002924 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002925
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002926#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002927 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002928#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002929 "Rename network interface while it in the down state\n" \
2930 "\nOptions:" \
2931 "\n -c FILE Use configuration file (default is /etc/mactab)" \
2932 "\n -s Use syslog (LOCAL0 facility)" \
2933 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
2934
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002935#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002936 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2937 " or\n" \
2938 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002939
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002940#if !ENABLE_DESKTOP
2941
Rob Landley1cca9482006-07-10 19:45:20 +00002942#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002943#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002944#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002945#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002946#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002947
Eric Andersen7e9276b2001-02-22 01:15:47 +00002948#define nc_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002949 IF_NC_EXTRA("[-iN] [-wN] ")IF_NC_SERVER("[-l] [-p PORT] ") \
2950 "["IF_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"IF_NC_EXTRA(" [-e COMMAND]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002951#define nc_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002952 "Open a pipe to IP:port" IF_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002953 NC_OPTIONS_STR \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002954 IF_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002955 "\n -e Exec rest of command line after connect" \
2956 "\n -i SECS Delay interval for lines sent" \
2957 "\n -w SECS Timeout for connect" \
2958 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002959 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002960 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002961 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002962 IF_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002963 "\n (use -l twice with -e for persistent server)") \
2964 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002965 )
2966
Rob Landley1cca9482006-07-10 19:45:20 +00002967#define nc_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002968 IF_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002969 "To use netcat as a terminal emulator on a serial port:\n\n" \
2970 "$ stty 115200 -F /dev/ttyS0\n" \
2971 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2972 )
Rob Landley1cca9482006-07-10 19:45:20 +00002973
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002974#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002975 "$ nc foobar.somedomain.com 25\n" \
2976 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2977 "help\n" \
2978 "214-Commands supported:\n" \
2979 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2980 "214 NOOP QUIT RSET HELP\n" \
2981 "quit\n" \
2982 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002983
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002984#else /* DESKTOP nc - much more compatible with nc 1.10 */
2985
2986#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002987 "[-options] hostname port - connect" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002988 IF_NC_SERVER("\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002989 "nc [-options] -l -p port [hostname] [port] - listen")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002990#define nc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002991 "Options:" \
2992 "\n -e prog [args] Program to exec after connect (must be last)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002993 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002994 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002995 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002996 "\n -n Don't do DNS resolution" \
2997 "\n -s addr Local address" \
2998 "\n -p port Local port" \
2999 "\n -u UDP mode" \
3000 "\n -v Verbose (cumulative: -vv)" \
3001 "\n -w secs Timeout for connects and final net reads" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003002 IF_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003003 "\n -i sec Delay interval for lines sent" /* ", ports scanned" */ \
3004 "\n -o file Hex dump of traffic" \
3005 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003006 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003007/* "\n -r Randomize local and remote ports" */
3008/* "\n -g gateway Source-routing hop point[s], up to 8" */
3009/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003010/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
3011
3012#endif
3013
Eric Andersen1552ff72001-10-31 11:07:12 +00003014#define netstat_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003015 "[-laentuwxr"IF_FEATURE_NETSTAT_WIDE("W")IF_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003016#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003017 "Display networking information\n" \
3018 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003019 "\n -l Display listening server sockets" \
3020 "\n -a Display all sockets (default: connected)" \
3021 "\n -e Display other/more information" \
3022 "\n -n Don't resolve names" \
3023 "\n -t Tcp sockets" \
3024 "\n -u Udp sockets" \
3025 "\n -w Raw sockets" \
3026 "\n -x Unix sockets" \
3027 "\n -r Display routing table" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003028 IF_FEATURE_NETSTAT_WIDE( \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003029 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003030 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003031 IF_FEATURE_NETSTAT_PRG( \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003032 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003033 )
Eric Andersen1552ff72001-10-31 11:07:12 +00003034
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003035#define nice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003036 "[-n ADJUST] [COMMAND [ARG]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003037#define nice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003038 "Run a program with modified scheduling priority\n" \
3039 "\nOptions:" \
3040 "\n -n ADJUST Adjust the scheduling priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003041
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003042#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003043 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003044#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003045 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003046 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003047 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003048 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003049 "%[niface] Monitor network interface 'iface'\n" \
3050 "%m Monitor allocated memory\n" \
3051 "%[mf] Monitor free memory\n" \
3052 "%[mt] Monitor total memory\n" \
3053 "%s Monitor allocated swap\n" \
3054 "%f Monitor number of used file descriptors\n" \
3055 "%Ni Monitor total/specific IRQ rate\n" \
3056 "%x Monitor context switch rate\n" \
3057 "%p Monitor forks\n" \
3058 "%[pn] Monitor # of processes\n" \
3059 "%b Monitor block io\n" \
3060 "%Nt Show time (with N decimal points)\n" \
3061 "%Nd Milliseconds between updates (default=1000)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003062 "%r Print <cr> instead of <lf> at EOL" \
3063
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003064#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003065 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003066
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003067#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003068 "COMMAND [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003069#define nohup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003070 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003071#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003072 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003073
Eric Andersen7e9276b2001-02-22 01:15:47 +00003074#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003075 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003076#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003077 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003078 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003079#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003080 "$ nslookup localhost\n" \
3081 "Server: default\n" \
3082 "Address: default\n" \
3083 "\n" \
3084 "Name: debian\n" \
3085 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003086
Glenn L McGrath60281112001-11-02 11:39:46 +00003087#define od_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003088 "[-aBbcDdeFfHhIiLlOovXx] " IF_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003089#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003090 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00003091 "to standard output. With no FILE or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00003092
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003093#define openvt_trivial_usage \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003094 "[-c NUM] [-sw] [COMMAND [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003095#define openvt_full_usage "\n\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003096 "Start COMMAND on a new virtual terminal\n" \
3097 "\nOptions:" \
3098 "\n -c Use specified VT" \
3099 "\n -s Switch to the VT" \
3100/* "\n -l Run COMMAND as login shell (by prepending '-')" */ \
3101 "\n -w Wait for COMMAND to exit" \
3102
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003103#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003104 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003105
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003106#define parse_trivial_usage \
3107 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
3108#define parse_full_usage "\n\n" \
3109 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
3110
Eric Andersen27f64e12002-06-23 04:24:25 +00003111#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003112 "[OPTION] [name]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003113#define passwd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003114 "Change user's password. If no name is specified,\n" \
3115 "changes the password for the current user.\n" \
3116 "\nOptions:" \
3117 "\n -a Algorithm to use for password (choices: des, md5)" /* ", sha1)" */ \
3118 "\n -d Delete password for the account" \
3119 "\n -l Lock (disable) account" \
3120 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003121
Denis Vlasenko21d10142007-07-20 21:28:41 +00003122#define chpasswd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003123 IF_GETOPT_LONG("[--md5|--encrypted]") IF_NOT_GETOPT_LONG("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003124#define chpasswd_full_usage "\n\n" \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003125 "Read user:password information from stdin " \
Denis Vlasenko397de612008-03-17 08:55:44 +00003126 "and update /etc/passwd accordingly.\n" \
3127 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003128 IF_GETOPT_LONG( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003129 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003130 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003131 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003132 IF_NOT_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003133 "\n -e Supplied passwords are in encrypted form" \
3134 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003135 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00003136
Glenn L McGrath655d8142003-06-22 15:32:41 +00003137#define patch_trivial_usage \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003138 "[-p NUM] [-i DIFF] [-R]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003139#define patch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003140 " -p NUM Strip NUM leading components from file names" \
3141 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003142 "\n -R Reverse patch" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003143
Glenn L McGrath655d8142003-06-22 15:32:41 +00003144#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003145 "$ patch -p1 < example.diff\n" \
3146 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00003147
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003148#define pgrep_trivial_usage \
3149 "[-flnovx] pattern"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003150#define pgrep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003151 "Display process(es) selected by regex pattern\n" \
3152 "\nOptions:" \
3153 "\n -l Show command name too" \
3154 "\n -f Match against entire command line" \
3155 "\n -n Show the newest process only" \
3156 "\n -o Show the oldest process only" \
3157 "\n -v Negate the matching" \
3158 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003159
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003160#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00003161#define pidof_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003162 "[OPTION] [NAME...]"
3163#define USAGE_PIDOF "\n\nOptions:"
3164#else
3165#define pidof_trivial_usage \
3166 "[NAME...]"
3167#define USAGE_PIDOF /* none */
3168#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003169#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003170 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003171 USAGE_PIDOF \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003172 IF_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003173 "\n -s Show only one PID") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003174 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003175 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003176 "\n Use %PPID to omit pid of pidof's parent") \
3177
Eric Andersen221b2ea2001-07-31 19:06:07 +00003178#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003179 "$ pidof init\n" \
3180 "1\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003181 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003182 "$ pidof /bin/sh\n20351 5973 5950\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003183 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003184 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00003185
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003186#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003187#define ping_trivial_usage \
3188 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003189#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003190 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003191#define ping6_trivial_usage \
3192 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003193#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003194 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003195#else
3196#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003197 "[OPTION]... host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003198#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003199 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3200 "\nOptions:" \
3201 "\n -4, -6 Force IPv4 or IPv6 hostname resolution" \
3202 "\n -c CNT Send only CNT pings" \
3203 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
3204 "\n -I iface/IP Use interface or IP address as source" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003205 "\n -W timeout Seconds to wait for the first response (default:10)" \
3206 "\n (after all -c CNT packets are sent)" \
3207 "\n -w deadline Seconds until ping exits (default:infinite)" \
3208 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003209 "\n -q Quiet, only displays output at start" \
3210 "\n and when finished" \
3211
Eric Andersen51b8bd62002-07-03 11:46:38 +00003212#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003213 "[OPTION]... host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003214#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003215 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3216 "\nOptions:" \
3217 "\n -c CNT Send only CNT pings" \
3218 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
3219 "\n -I iface/IP Use interface or IP address as source" \
3220 "\n -q Quiet, only displays output at start" \
3221 "\n and when finished" \
3222
Eric Andersen51b8bd62002-07-03 11:46:38 +00003223#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003224#define ping_example_usage \
3225 "$ ping localhost\n" \
3226 "PING slag (127.0.0.1): 56 data bytes\n" \
3227 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3228 "\n" \
3229 "--- debian ping statistics ---\n" \
3230 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3231 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003232#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003233 "$ ping6 ip6-localhost\n" \
3234 "PING ip6-localhost (::1): 56 data bytes\n" \
3235 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3236 "\n" \
3237 "--- ip6-localhost ping statistics ---\n" \
3238 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3239 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003240
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003241#define pipe_progress_trivial_usage NOUSAGE_STR
3242#define pipe_progress_full_usage ""
3243
Eric Andersen7e9276b2001-02-22 01:15:47 +00003244#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003245 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003246#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003247 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003248 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003249
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003250#define pkill_trivial_usage \
3251 "[-l] | [-fnovx] [-signal] pattern"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003252#define pkill_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003253 "Send a signal to process(es) selected by regex pattern\n" \
3254 "\nOptions:" \
3255 "\n -l List all signals" \
3256 "\n -f Match against entire command line" \
3257 "\n -n Signal the newest process only" \
3258 "\n -o Signal the oldest process only" \
3259 "\n -v Negate the matching" \
3260 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003261
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003262#define popmaildir_trivial_usage \
3263 "[OPTIONS] Maildir [connection-helper ...]"
3264#define popmaildir_full_usage "\n\n" \
3265 "Fetch content of remote mailbox to local maildir\n" \
3266 "\nOptions:" \
3267 "\n -b Binary mode. Ignored" \
3268 "\n -d Debug. Ignored" \
3269 "\n -m Show used memory. Ignored" \
3270 "\n -V Show version. Ignored" \
3271 "\n -c Use tcpclient. Ignored" \
3272 "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" \
3273 "\n -s Skip authorization" \
3274 "\n -T Get messages with TOP instead with RETR" \
3275 "\n -k Keep retrieved messages on the server" \
3276 "\n -t timeout Set network timeout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003277 IF_FEATURE_POPMAILDIR_DELIVERY( \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003278 "\n -F \"program arg1 arg2 ...\" Filter by program. May be multiple" \
3279 "\n -M \"program arg1 arg2 ...\" Deliver by program" \
3280 ) \
3281 "\n -R size Remove old messages on the server >= size (in bytes). Ignored" \
3282 "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" \
3283 "\n -L size Do not retrieve new messages >= size (in bytes). Ignored" \
3284 "\n -H lines Type specified number of lines of a message. Ignored"
3285#define popmaildir_example_usage \
3286 "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n" \
3287 "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
3288
Eric Andersen7e9276b2001-02-22 01:15:47 +00003289#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003290 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003291#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003292 "Halt and shut off power\n" \
3293 "\nOptions:" \
3294 "\n -d Delay interval for halting" \
3295 "\n -n No call to sync()" \
3296 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003297
Mike Frysinger95d3c452005-04-21 23:29:24 +00003298#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003299 "[VARIABLES...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003300#define printenv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003301 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003302 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003303
Eric Andersen7e9276b2001-02-22 01:15:47 +00003304#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003305 "FORMAT [ARGUMENT...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003306#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003307 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003308 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003309#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003310 "$ printf \"Val=%d\\n\" 5\n" \
3311 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003312
Denis Vlasenko94949192006-11-05 00:45:47 +00003313
3314#if ENABLE_DESKTOP
3315
3316#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003317 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003318#define ps_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003319 "Report process status\n" \
3320 "\nOptions:" \
3321 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00003322
3323#else /* !ENABLE_DESKTOP */
3324
Denis Vlasenko397de612008-03-17 08:55:44 +00003325#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003326#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003327#else
3328#define USAGE_PS "\nOptions:"
3329#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003330
Eric Andersen7e9276b2001-02-22 01:15:47 +00003331#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003332 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003333#define ps_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003334 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003335 USAGE_PS \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003336 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003337 "\n -Z Show SE Linux context" \
3338 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003339 IF_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003340 "\n w Wide output" \
3341 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003342
Denis Vlasenko94949192006-11-05 00:45:47 +00003343#endif /* ENABLE_DESKTOP */
3344
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003345#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003346 "$ ps\n" \
3347 " PID Uid Gid State Command\n" \
3348 " 1 root root S init\n" \
3349 " 2 root root S [kflushd]\n" \
3350 " 3 root root S [kupdate]\n" \
3351 " 4 root root S [kpiod]\n" \
3352 " 5 root root S [kswapd]\n" \
3353 " 742 andersen andersen S [bash]\n" \
3354 " 743 andersen andersen S -bash\n" \
3355 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003356 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003357
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003358#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003359 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003360#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003361 "Scan a host, print all open ports\n" \
3362 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003363 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003364 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003365 "\n -p Scan from this port (default 1)" \
3366 "\n -P Scan up to this port (default 1024)" \
3367 "\n -t Timeout (default 5000 ms)" \
3368 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3369
Eric Andersen7e9276b2001-02-22 01:15:47 +00003370#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003371 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003372#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003373 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003374#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003375 "$ pwd\n" \
3376 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003377
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003378#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003379 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003380#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003381 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003382#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003383 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003384
Eric Andersen7e9276b2001-02-22 01:15:47 +00003385#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003386 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003387#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003388 "Get and possibly set the system date and time from a remote HOST\n" \
3389 "\nOptions:" \
3390 "\n -s Set the system date and time (default)" \
3391 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003392
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00003393#define rdev_trivial_usage \
3394 ""
3395#define rdev_full_usage "\n\n" \
3396 "Print the device node associated with the filesystem mounted at '/'"
3397#define rdev_example_usage \
3398 "$ rdev\n" \
3399 "/dev/mtdblock9 /\n"
3400
Rob Landley0e4690d2006-08-20 22:12:18 +00003401#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003402 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003403#define readahead_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003404 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
3405 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00003406
Eric Andersen7e9276b2001-02-22 01:15:47 +00003407#define readlink_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003408 IF_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003409#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003410 "Display the value of a symlink" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003411 IF_FEATURE_READLINK_FOLLOW( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003412 "\nOptions:" \
3413 "\n -f Canonicalize by following all symlinks") \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003414
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003415#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003416 "[OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003417#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003418 "Options:" \
3419 "\n -m mapfile (Default: /boot/System.map)" \
3420 "\n -p profile (Default: /proc/profile)" \
3421 "\n -M mult Set the profiling multiplier to mult" \
3422 "\n -i Print only info about the sampling step" \
3423 "\n -v Verbose" \
3424 "\n -a Print all symbols, even if count is 0" \
3425 "\n -b Print individual histogram-bin counts" \
3426 "\n -s Print individual counters within functions" \
3427 "\n -r Reset all the counters (root only)" \
3428 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003429
Glenn L McGrath62fae302002-12-10 00:14:33 +00003430#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003431 "pathname..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003432#define realpath_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003433 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00003434
Eric Andersen7e9276b2001-02-22 01:15:47 +00003435#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003436 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003437#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003438 "Reboot the system\n" \
3439 "\nOptions:" \
3440 "\n -d Delay interval for rebooting" \
3441 "\n -n No call to sync()" \
3442 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003443
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003444#define reformime_trivial_usage \
3445 "[OPTION]... [FILE]..."
3446#define reformime_full_usage "\n\n" \
3447 "Parse MIME-encoded message\n" \
3448 "\nOptions:" \
3449 "\n -x prefix Extract content of MIME sections to files" \
3450 "\n -X prog [args] Filter content of MIME sections through prog." \
3451 "\n Must be the last option" \
3452 "\n" \
3453 "\nOther options are silently ignored." \
3454
Eric Andersen7e9276b2001-02-22 01:15:47 +00003455#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003456 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003457#define renice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003458 "Change priority of running processes\n" \
3459 "\nOptions:" \
3460 "\n -n Adjust current nice value (smaller is faster)" \
3461 "\n -p Process id(s) (default)" \
3462 "\n -g Process group id(s)" \
3463 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003464
Eric Andersen7e9276b2001-02-22 01:15:47 +00003465#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003466 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003467#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003468 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003469
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003470#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003471 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003472#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003473 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003474
Denis Vlasenko397137b2007-07-23 14:03:30 +00003475#define restorecon_trivial_usage \
3476 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003477#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003478 "Reset security contexts of files in pathname\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003479 "\n -i Ignore files that do not exist" \
3480 "\n -f file File with list of files to process. Use - for stdin" \
3481 "\n -e directory Directory to exclude" \
3482 "\n -R,-r Recurse directories" \
3483 "\n -n Don't change any file labels" \
3484 "\n -o file Save list of files with incorrect context" \
3485 "\n -v Verbose" \
3486 "\n -vv Show changed labels" \
3487 "\n -F Force reset of context to match file_context" \
3488 "\n for customizable files, or the user section," \
3489 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003490
Eric Andersen7e9276b2001-02-22 01:15:47 +00003491#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003492 "[OPTION]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003493#define rm_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003494 "Remove (unlink) the FILE(s). Use '--' to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003495 "indicate that all following arguments are non-options.\n" \
3496 "\nOptions:" \
3497 "\n -i Always prompt before removing" \
3498 "\n -f Never prompt" \
3499 "\n -r,-R Remove directories recursively" \
3500
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003501#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003502 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003503
Eric Andersen7e9276b2001-02-22 01:15:47 +00003504#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003505 "[OPTION]... DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003506#define rmdir_full_usage "\n\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003507 "Remove the DIRECTORY, if it is empty.\n" \
3508 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003509 IF_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003510 "\n -p|--parents Include parents" \
3511 "\n -ignore-fail-on-non-empty" \
3512 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003513 IF_NOT_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003514 "\n -p Include parents" \
3515 )
3516
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003517#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003518 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003519
Eric Andersen7e9276b2001-02-22 01:15:47 +00003520#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003521 "[OPTION]... [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003522#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003523 "Unload the specified kernel modules from the kernel\n" \
3524 "\nOptions:" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003525 "\n -w Wait until the module is no longer used" \
3526 "\n -f Force unloading" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003527 "\n -a Remove all unused modules (recursively)" \
3528
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003529#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003530 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003531
Eric Andersen7e9276b2001-02-22 01:15:47 +00003532#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003533 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003534#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003535 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003536 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003537 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003538 "\n -e Display other/more information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003539 "\n -A inet" IF_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003540
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003541#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003542 "-i -q[ildc]p package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003543#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003544 "Manipulate RPM packages\n" \
3545 "\nOptions:" \
3546 "\n -i Install package" \
3547 "\n -q Query package" \
3548 "\n -p Query uninstalled package" \
3549 "\n -i Show information" \
3550 "\n -l List contents" \
3551 "\n -d List documents" \
3552 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003553
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003554#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003555 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003556#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003557 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003558
Mike Frysinger6b160e42008-02-15 02:27:19 +00003559#define rtcwake_trivial_usage \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003560 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SEC | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003561#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003562 "Enter a system sleep state until specified wakeup time\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003563 IF_GETOPT_LONG( \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003564 "\n -a,--auto Read clock mode from adjtime" \
3565 "\n -l,--local Clock is set to local time" \
3566 "\n -u,--utc Clock is set to UTC time" \
3567 "\n -d,--device=DEV Specify the RTC device" \
3568 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003569 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003570 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003571 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003572 IF_NOT_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003573 "\n -a Read clock mode from adjtime" \
3574 "\n -l Clock is set to local time" \
3575 "\n -u Clock is set to UTC time" \
3576 "\n -d DEV Specify the RTC device" \
3577 "\n -m MODE Set the sleep state (default: standby)" \
3578 "\n -s SEC Set the timeout in SEC seconds from now" \
3579 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003580 )
3581
Denis Vlasenko49622d72007-03-10 16:58:49 +00003582#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003583 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3584 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003585#define runcon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003586 "Run a program in a different security context\n" \
3587 "\n CONTEXT Complete security context\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003588 IF_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003589 "\n -c,--compute Compute process transition context before modifying" \
3590 "\n -t,--type=TYPE Type (for same role as parent)" \
3591 "\n -u,--user=USER User identity" \
3592 "\n -r,--role=ROLE Role" \
3593 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003594 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003595 IF_NOT_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003596 "\n -c Compute process transition context before modifying" \
3597 "\n -t TYPE Type (for same role as parent)" \
3598 "\n -u USER User identity" \
3599 "\n -r ROLE Role" \
3600 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003601 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003602
Eric Andersen6cf47a72001-10-31 10:24:36 +00003603#define run_parts_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003604 "[-t] "IF_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003605#define run_parts_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003606 "Run a bunch of scripts in a directory\n" \
3607 "\nOptions:" \
3608 "\n -t Print what would be run, but don't actually run anything" \
3609 "\n -a ARG Pass ARG as argument for every program" \
3610 "\n -u MASK Set the umask to MASK before running every program" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003611 IF_FEATURE_RUN_PARTS_FANCY( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003612 "\n -l Print names of all matching files even if they are not executable" \
3613 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003614
3615#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003616 "$ run-parts -a start /etc/init.d\n" \
3617 "$ run-parts -a stop=now /etc/init.d\n\n" \
3618 "Let's assume you have a script foo/dosomething:\n" \
3619 "#!/bin/sh\n" \
3620 "for i in $*; do eval $i; done; unset i\n" \
3621 "case \"$1\" in\n" \
3622 "start*) echo starting something;;\n" \
3623 "stop*) set -x; shutdown -h $stop;;\n" \
3624 "esac\n\n" \
3625 "Running this yields:\n" \
3626 "$run-parts -a stop=+4m foo/\n" \
3627 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003628
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003629#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003630 "[utmp]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003631#define runlevel_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003632 "Find the current and previous system runlevel.\n\n" \
3633 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003634 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003635#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003636 "$ runlevel /var/run/utmp\n" \
3637 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003638
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003639#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003640 "dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003641#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003642 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003643
3644#define runsvdir_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003645 "[-P] [-s SCRIPT] dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003646#define runsvdir_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003647 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
3648 "\n -P Put each runsv in a new session" \
3649 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003650
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003651#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003652 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003653#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003654 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003655#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003656 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003657
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003658#define script_trivial_usage \
3659 "[-afq] [-c COMMAND] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003660#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003661 "Options:" \
3662 "\n -a Append output" \
3663 "\n -c Run COMMAND, not shell" \
3664 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003665 "\n -q Quiet" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003666
Eric Andersen7e9276b2001-02-22 01:15:47 +00003667#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003668 "[-efinr] pattern [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003669#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003670 "Options:" \
3671 "\n -e script Add the script to the commands to be executed" \
3672 "\n -f scriptfile Add scriptfile contents to the" \
3673 "\n commands to be executed" \
3674 "\n -i Edit files in-place" \
3675 "\n -n Suppress automatic printing of pattern space" \
3676 "\n -r Use extended regular expression syntax" \
3677 "\n" \
3678 "\nIf no -e or -f is given, the first non-option argument is taken as the sed" \
3679 "\nscript to interpret. All remaining arguments are names of input files; if no" \
3680 "\ninput files are specified, then the standard input is read. Source files" \
3681 "\nwill not be modified unless -i option is given." \
Eric Andersenf802ff72004-04-12 15:12:06 +00003682
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003683#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003684 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3685 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003686
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003687#define selinuxenabled_trivial_usage NOUSAGE_STR
3688#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003689
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003690#define sendmail_trivial_usage \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003691 "[OPTIONS] [rcpt]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003692#define sendmail_full_usage "\n\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003693 "Send an email\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003694 "\nStandard options:" \
3695 "\n -t Read recipients from message body, add them to those on cmdline" \
3696 "\n -f sender Sender. REQUIRED!" \
3697 "\n -o options various options. -oi IMPLIED! others are IGNORED!" \
3698 "\n" \
3699 "\nBusybox specific options:" \
3700 "\n -w seconds Network timeout" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003701 "\n -H 'prog args' Run connection helper" \
3702 "\n Examples:" \
Denis Vlasenko7e0c2432009-03-02 16:12:00 +00003703 "\n -H 'exec openssl s_client -quiet -tls1 -starttls smtp" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003704 "\n -connect smtp.gmail.com:25' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003705 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003706 "\n -H 'exec openssl s_client -quiet -tls1" \
3707 "\n -connect smtp.gmail.com:465' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003708 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003709 "\n -S server[:port] Server" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003710 "\n -au<username> Username for AUTH LOGIN" \
3711 "\n -ap<password> Password for AUTH LOGIN" \
3712 "\n -am<method> Authentication method. Ignored. login is implied." \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003713 "\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003714 "\nOther options are silently ignored; -oi -t is implied" \
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003715
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003716#define seq_trivial_usage \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003717 "[-w] [-s SEP] [FIRST [INC]] LAST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003718#define seq_full_usage "\n\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003719 "Print numbers from FIRST to LAST, in steps of INC.\n" \
3720 "FIRST, INC default to 1\n" \
3721 "\nOptions:" \
3722 "\n -w Pad to last with leading zeros" \
3723 "\n -s SEP String separator" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003724
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003725#define sestatus_trivial_usage \
3726 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003727#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003728 " -v Verbose" \
3729 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003730
Paul Foxfc2256a2005-08-01 18:12:30 +00003731#define setconsole_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003732 "[-r" IF_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003733#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003734 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3735 "\nOptions:" \
3736 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003737
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003738#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003739 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003740#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003741
Denis Vlasenko397137b2007-07-23 14:03:30 +00003742#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003743 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003744 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003745 " [-c policyfile] spec_file" \
3746 ) \
3747 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003748#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003749 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003750 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003751 "\n -c file Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003752 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003753 "\n -d Show which specification matched each file" \
3754 "\n -l Log changes in file labels to syslog" \
3755 "\n -n Don't change any file labels" \
3756 "\n -q Suppress warnings" \
3757 "\n -r dir Use an altenate root path" \
3758 "\n -e dir Exclude directory" \
3759 "\n -F Force reset of context to match file_context for customizable files" \
3760 "\n -o file Save list of files with incorrect context" \
3761 "\n -s Take a list of files from standard input (instead of command line)" \
3762 "\n -v Show changes in file labels, if type or role are changing" \
3763 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3764 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003765
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003766#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003767 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003768#define setfont_full_usage "\n\n" \
3769 "Load a console font\n" \
3770 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003771 "\n -m MAPFILE Load console screen map" \
3772 "\n -C TTY Affect TTY instead of /dev/tty" \
3773
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003774#define setfont_example_usage \
3775 "$ setfont -m koi8-r /etc/i18n/fontname\n"
3776
Eric Andersen7e9276b2001-02-22 01:15:47 +00003777#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003778 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003779#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003780 "Set entries into the kernel's scancode-to-keycode map,\n" \
3781 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3782 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003783 "and KEYCODE is given in decimal" \
3784
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003785#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003786 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003787
Rob Landley87848d92006-03-27 23:23:43 +00003788#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003789 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003790#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003791 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003792
Denis Vlasenkobe039372007-10-14 04:48:44 +00003793#define setsebool_trivial_usage \
3794 "boolean value"
3795
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003796#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00003797 "Change boolean setting"
3798
Paul Fox42403642005-08-01 22:52:09 +00003799#define setsid_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003800 "PROG [ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003801#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003802 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3803 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3804 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003805
Matt Kraai2d91deb2001-08-01 17:21:35 +00003806#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003807 "[FILE]...\n" \
3808 "or: sh -c command [args]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003809#define lash_full_usage "\n\n" \
Denis Vlasenko96702ca2007-11-23 23:28:55 +00003810 "lash is deprecated, please use hush"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003811
Eric Andersen2e9c2572003-08-08 22:26:06 +00003812#define last_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003813 ""IF_FEATURE_LAST_FANCY("[-HW] [-f file]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003814#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003815 "Show listing of the last users that logged into the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003816 IF_FEATURE_LAST_FANCY( "\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003817 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00003818/* "\n -H Show header line" */ \
3819 "\n -W Display with no host column truncation" \
3820 "\n -f file Read from file instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003821 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00003822
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00003823#define showkey_trivial_usage \
3824 "[-a | -k | -s]"
3825#define showkey_full_usage "\n\n" \
3826 "Show keys pressed\n" \
3827 "\nOptions:" \
3828 "\n -a Display decimal/octal/hex values of the keys" \
3829 "\n -k Display interpreted keycodes (default)" \
3830 "\n -s Display raw scan-codes" \
3831
Denis Vlasenko14923db2007-06-20 15:23:03 +00003832#define slattach_trivial_usage \
3833 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003834#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003835 "Attach network interface(s) to serial line(s)\n" \
3836 "\nOptions:" \
3837 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3838 "\n -s Set line speed" \
3839 "\n -e Exit after initializing device" \
3840 "\n -h Exit when the carrier is lost" \
3841 "\n -c Execute a command when the line is hung up" \
3842 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3843 "\n -L Enable 3-wire operation" \
3844 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003845
Eric Andersen7e9276b2001-02-22 01:15:47 +00003846#define sleep_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003847 IF_FEATURE_FANCY_SLEEP("[") "N" IF_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003848#define sleep_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003849 IF_NOT_FEATURE_FANCY_SLEEP("Pause for N seconds") \
3850 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003851 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003852 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003853#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003854 "$ sleep 2\n" \
3855 "[2 second delay results]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003856 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003857 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003858 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003859
Eric Andersen7e9276b2001-02-22 01:15:47 +00003860#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003861 "[-nru" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003862 IF_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003863 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003864#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003865 "Sort lines of text\n" \
3866 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003867 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003868 "\n -b Ignore leading blanks" \
3869 "\n -c Check whether input is sorted" \
3870 "\n -d Dictionary order (blank or alphanumeric only)" \
3871 "\n -f Ignore case" \
3872 "\n -g General numerical sort" \
3873 "\n -i Ignore unprintable characters" \
3874 "\n -k Sort key" \
3875 "\n -M Sort month" \
3876 ) \
3877 "\n -n Sort numbers" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003878 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003879 "\n -o Output to file" \
3880 "\n -k Sort by key" \
3881 "\n -t CHAR Key separator" \
3882 ) \
3883 "\n -r Reverse sort order" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003884 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003885 "\n -s Stable (don't sort ties alphabetically)" \
3886 ) \
3887 "\n -u Suppress duplicate lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003888 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003889 "\n -z Lines are terminated by NUL, not newline" \
3890 "\n -mST Ignored for GNU compatibility") \
3891
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003892#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003893 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3894 "a\n" \
3895 "b\n" \
3896 "c\n" \
3897 "d\n" \
3898 "e\n" \
3899 "f\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003900 IF_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003901 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3902 "d 2\n" \
3903 "b 2\n" \
3904 "c 3\n" \
3905 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003906 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003907
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003908#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003909 "[OPTION] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003910#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003911 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003912 "\n -b n[k|m] Split by bytes" \
3913 "\n -l n Split by lines" \
3914 "\n -a n Use n letters as suffix" \
3915
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003916#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003917 "$ split TODO foo\n" \
3918 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003919
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003920#define start_stop_daemon_trivial_usage \
Denis Vlasenko7987a182008-07-01 10:00:46 +00003921 "[OPTIONS] [-S|-K] ... [-- arguments...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003922#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003923 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003924 "-K: stop all matching processes.\n" \
3925 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003926 IF_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003927 "\nProcess matching:" \
3928 "\n -u,--user USERNAME|UID Match only this user's processes" \
3929 "\n -n,--name NAME Match processes with NAME" \
3930 "\n in comm field in /proc/PID/stat" \
3931 "\n -x,--exec EXECUTABLE Match processes with this command" \
3932 "\n in /proc/PID/cmdline" \
3933 "\n -p,--pidfile FILE Match a process with PID from the file" \
3934 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003935 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003936 "\n -x,--exec EXECUTABLE Program to run" \
3937 "\n -a,--startas NAME Zeroth argument" \
3938 "\n -b,--background Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003939 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003940 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003941 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003942 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
3943 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003944 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003945 "\n -s,--signal SIG Signal to send" \
3946 "\n -t,--test Match only, exit with 0 if a process is found" \
3947 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003948 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003949 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003950 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003951 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003952 "\n -q,--quiet Quiet" \
3953 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003954 IF_NOT_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003955 "\nProcess matching:" \
3956 "\n -u USERNAME|UID Match only this user's processes" \
3957 "\n -n NAME Match processes with NAME" \
3958 "\n in comm field in /proc/PID/stat" \
3959 "\n -x EXECUTABLE Match processes with this command" \
3960 "\n command in /proc/PID/cmdline" \
3961 "\n -p FILE Match a process with PID from the file" \
3962 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003963 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003964 "\n -x EXECUTABLE Program to run" \
3965 "\n -a NAME Zeroth argument" \
3966 "\n -b Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003967 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003968 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003969 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003970 "\n -c USER[:[GRP]] Change to user/group" \
3971 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003972 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003973 "\n -s SIG Signal to send" \
3974 "\n -t Match only, exit with 0 if a process is found" \
3975 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003976 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003977 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003978 "\n -v Verbose" \
3979 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003980 "\n -q Quiet" \
3981 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003982
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003983#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003984 "[OPTION] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003985#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003986 "Display file (default) or filesystem status\n" \
3987 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003988 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003989 "\n -c fmt Use the specified format" \
3990 ) \
3991 "\n -f Display filesystem status" \
3992 "\n -L Dereference links" \
3993 "\n -t Display info in terse form" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003994 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003995 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003996 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003997 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003998 "\n\nValid format sequences for files:\n" \
3999 " %a Access rights in octal\n" \
4000 " %A Access rights in human readable form\n" \
4001 " %b Number of blocks allocated (see %B)\n" \
4002 " %B The size in bytes of each block reported by %b\n" \
4003 " %d Device number in decimal\n" \
4004 " %D Device number in hex\n" \
4005 " %f Raw mode in hex\n" \
4006 " %F File type\n" \
4007 " %g Group ID of owner\n" \
4008 " %G Group name of owner\n" \
4009 " %h Number of hard links\n" \
4010 " %i Inode number\n" \
4011 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00004012 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004013 " %o I/O block size\n" \
4014 " %s Total size, in bytes\n" \
4015 " %t Major device type in hex\n" \
4016 " %T Minor device type in hex\n" \
4017 " %u User ID of owner\n" \
4018 " %U User name of owner\n" \
4019 " %x Time of last access\n" \
4020 " %X Time of last access as seconds since Epoch\n" \
4021 " %y Time of last modification\n" \
4022 " %Y Time of last modification as seconds since Epoch\n" \
4023 " %z Time of last change\n" \
4024 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004025 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004026 " %a Free blocks available to non-superuser\n" \
4027 " %b Total data blocks in file system\n" \
4028 " %c Total file nodes in file system\n" \
4029 " %d Free file nodes in file system\n" \
4030 " %f Free blocks in file system\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004031 IF_SELINUX( \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004032 " %C Security context in SELinux\n" \
4033 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004034 " %i File System ID in hex\n" \
4035 " %l Maximum length of filenames\n" \
4036 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004037 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004038 " %S Fundamental block size (for block counts)\n" \
4039 " %t Type in hex\n" \
4040 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004041 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004042
Eric Andersenef5e8f82002-11-07 02:09:37 +00004043#define strings_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004044 "[-afo] [-n length] [file...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004045#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004046 "Display printable strings in a binary file\n" \
4047 "\nOptions:" \
4048 "\n -a Scan whole file (default)" \
4049 "\n -f Precede strings with filenames" \
4050 "\n -n N At least N characters form a string (default 4)" \
4051 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00004052
Eric Andersen7e9276b2001-02-22 01:15:47 +00004053#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004054 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004055#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004056 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004057 "and deviations from stty sane\n" \
4058 "\nOptions:" \
4059 "\n -F DEVICE Open device instead of stdin" \
4060 "\n -a Print all current settings in human-readable form" \
4061 "\n -g Print in stty-readable form" \
4062 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004063
Robert Griebl1fca5582002-06-04 20:45:46 +00004064#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004065 "[OPTION]... [-] [username]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004066#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004067 "Change user id or become root\n" \
4068 "\nOptions:" \
4069 "\n -p, -m Preserve environment" \
4070 "\n -c Command to pass to 'sh -c'" \
4071 "\n -s Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00004072
Eric Andersen27f64e12002-06-23 04:24:25 +00004073#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004074 "[OPTION]... [tty-device]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004075#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004076 "Single user login\n" \
4077 "\nOptions:" \
4078 "\n -t Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004079
Mike Frysinger95d3c452005-04-21 23:29:24 +00004080#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004081 "[rs] [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004082#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004083 "Checksum and count the blocks in a file\n" \
4084 "\nOptions:" \
4085 "\n -r Use BSD sum algorithm (1K blocks)" \
4086 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00004087
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004088#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004089 "[-v] [-w sec] command service..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004090#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004091 "Control services monitored by runsv supervisor.\n" \
4092 "Commands (only first character is enough):\n" \
4093 "\n" \
4094 "status: query service status\n" \
4095 "up: if service isn't running, start it. If service stops, restart it\n" \
4096 "once: like 'up', but if service stops, don't restart it\n" \
4097 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004098 " if it exists. After it stops, do not restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004099 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004100 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004101 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004102 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004103
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004104#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004105 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004106#define svlogd_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004107 "Continuously read log data from standard input, optionally " \
4108 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko397de612008-03-17 08:55:44 +00004109 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004110
Eric Andersen7e9276b2001-02-22 01:15:47 +00004111#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004112 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004113#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004114 "Stop swapping on DEVICE\n" \
4115 "\nOptions:" \
4116 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004117
Eric Andersen7e9276b2001-02-22 01:15:47 +00004118#define swapon_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004119 "[-a]" IF_FEATURE_SWAPON_PRI(" [-p pri]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004120#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004121 "Start swapping on DEVICE\n" \
4122 "\nOptions:" \
4123 "\n -a Start swapping on all swap devices" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004124 IF_FEATURE_SWAPON_PRI( \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004125 "\n -p pri Set swap device priority" \
4126 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004127
Rob Landley0f34a822005-10-27 22:55:50 +00004128#define switch_root_trivial_usage \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004129 "[-c /dev/console] NEW_ROOT NEW_INIT [ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004130#define switch_root_full_usage "\n\n" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004131 "Free initramfs and switch to another root fs:\n" \
4132 "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n" \
4133 "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004134 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004135 "\n -c DEV Reopen stdio to DEV after switch" \
Rob Landley0f34a822005-10-27 22:55:50 +00004136
Eric Andersen7e9276b2001-02-22 01:15:47 +00004137#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004138 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004139#define sync_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004140 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004141
Eric Andersenb9050282003-12-24 06:02:11 +00004142#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004143 "[OPTIONS]... [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004144#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004145 "Configure kernel parameters at runtime\n" \
4146 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004147 "\n -n Don't print key names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004148 "\n -e Don't warn about unknown keys" \
4149 "\n -w Change sysctl setting" \
4150 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
4151 "\n -a Display all values" \
4152 "\n -A Display all values in table form" \
4153
Eric Andersen5d38f5b2005-09-12 21:42:48 +00004154#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00004155 "sysctl [-n] [-e] variable...\n" \
4156 "sysctl [-n] [-e] -w variable=value...\n" \
4157 "sysctl [-n] [-e] -a\n" \
4158 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
4159 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00004160
Eric Andersen7e9276b2001-02-22 01:15:47 +00004161#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004162 "[OPTION]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004163#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004164 "System logging utility.\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004165 "Note that this version of syslogd ignores /etc/syslog.conf.\n" \
4166 "\nOptions:" \
4167 "\n -n Run in foreground" \
4168 "\n -O FILE Log to given file (default=/var/log/messages)" \
4169 "\n -l n Set local log level" \
4170 "\n -S Smaller logging output" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004171 IF_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004172 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
4173 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004174 IF_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004175 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
4176 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004177 IF_FEATURE_SYSLOGD_DUP( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004178 "\n -D Drop duplicates") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004179 IF_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004180 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00004181 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004182/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00004183
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004184#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004185 "$ syslogd -R masterlog:514\n" \
4186 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004187
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004188#define tac_trivial_usage \
4189 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004190#define tac_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004191 "Concatenate FILE(s) and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004192
Eric Andersen7e9276b2001-02-22 01:15:47 +00004193#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004194 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004195#define tail_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004196 "Print last 10 lines of each FILE to standard output.\n" \
4197 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004198 "file name. With no FILE, or when FILE is -, read standard input.\n" \
4199 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004200 IF_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004201 "\n -c N[kbm] Output the last N bytes") \
4202 "\n -n N[kbm] Print last N lines instead of last 10" \
4203 "\n -f Output data as the file grows" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004204 IF_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004205 "\n -q Never output headers giving file names" \
4206 "\n -s SEC Wait SEC seconds between reads with -f" \
4207 "\n -v Always output headers giving file names" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004208 "\n" \
4209 "\nIf the first character of N (bytes or lines) is a '+', output begins with" \
4210 "\nthe Nth item from the start of each file, otherwise, print the last N items" \
4211 "\nin the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004212
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004213#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004214 "$ tail -n 1 /etc/resolv.conf\n" \
4215 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004216
Eric Andersen7e9276b2001-02-22 01:15:47 +00004217#define tar_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004218 "-[" IF_FEATURE_TAR_CREATE("c") IF_FEATURE_SEAMLESS_GZ("z") \
4219 IF_FEATURE_SEAMLESS_BZ2("j") IF_FEATURE_SEAMLESS_LZMA("a") \
4220 IF_FEATURE_SEAMLESS_Z("Z") "xtvO] " \
4221 IF_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004222 "[-f TARFILE] [-C DIR] [FILE(s)]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004223#define tar_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004224 "Create, extract, or list files from a tar file\n" \
4225 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004226 IF_FEATURE_TAR_CREATE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004227 "\n c Create") \
4228 "\n x Extract" \
4229 "\n t List" \
4230 "\nArchive format selection:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004231 IF_FEATURE_SEAMLESS_GZ( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004232 "\n z Filter the archive through gzip" \
4233 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004234 IF_FEATURE_SEAMLESS_BZ2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004235 "\n j Filter the archive through bzip2" \
4236 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004237 IF_FEATURE_SEAMLESS_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004238 "\n a Filter the archive through lzma" \
4239 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004240 IF_FEATURE_SEAMLESS_Z( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004241 "\n Z Filter the archive through compress" \
4242 ) \
4243 "\nFile selection:" \
4244 "\n f Name of TARFILE or \"-\" for stdin" \
4245 "\n O Extract to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004246 IF_FEATURE_TAR_FROM( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004247 "\n exclude File to exclude" \
4248 "\n X File with names to exclude" \
4249 ) \
4250 "\n C Change to directory DIR before operation" \
4251 "\n v Verbose" \
4252
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004253#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004254 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
4255 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004256
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004257#define taskset_trivial_usage \
Denis Vlasenkob44c7902008-03-17 09:29:43 +00004258 "[-p] [mask] [pid | command [arg]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004259#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004260 "Set or get CPU affinity\n" \
4261 "\nOptions:" \
4262 "\n -p Operate on an existing PID" \
4263
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004264#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004265 "$ taskset 0x7 ./dgemm_test&\n" \
4266 "$ taskset -p 0x1 $!\n" \
4267 "pid 4790's current affinity mask: 7\n" \
4268 "pid 4790's new affinity mask: 1\n" \
4269 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4270 "pid 6671's current affinity mask: 1\n" \
4271 "pid 6671's new affinity mask: 1\n" \
4272 "$ taskset -p 1\n" \
4273 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004274
Eric Andersen7e9276b2001-02-22 01:15:47 +00004275#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004276 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004277#define tee_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004278 "Copy standard input to each FILE, and also to standard output\n" \
4279 "\nOptions:" \
4280 "\n -a Append to the given FILEs, do not overwrite" \
4281 "\n -i Ignore interrupt signals (SIGINT)" \
4282
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004283#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004284 "$ echo \"Hello\" | tee /tmp/foo\n" \
4285 "$ cat /tmp/foo\n" \
4286 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004287
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004288#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004289#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004290 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004291#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004292 "Connect to telnet server\n" \
4293 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004294 "\n -a Automatic login with $USER variable" \
4295 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004296
Eric Andersen539ffc92004-02-22 12:25:47 +00004297#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004298#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004299 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004300#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004301 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004302#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004303
Eric Andersen08a72202002-09-30 20:52:10 +00004304#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004305 "[OPTION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004306#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004307 "Handle incoming telnet connections" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004308 IF_NOT_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004309 "\nOptions:" \
4310 "\n -l LOGIN Exec LOGIN on connect" \
4311 "\n -f issue_file Display issue_file instead of /etc/issue" \
4312 "\n -K Close connection as soon as login exits" \
4313 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004314 IF_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004315 "\n -p PORT Port to listen on" \
4316 "\n -b ADDR Address to bind to" \
4317 "\n -F Run in foreground" \
4318 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004319 )
Eric Andersen08a72202002-09-30 20:52:10 +00004320
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004321/* "test --help" does not print help (POSIX compat), only "[ --help" does.
4322 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION") */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004323#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004324 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004325#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004326 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4327 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004328#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004329 "$ test 1 -eq 2\n" \
4330 "$ echo $?\n" \
4331 "1\n" \
4332 "$ test 1 -eq 1\n" \
4333 "$ echo $?\n" \
4334 "0\n" \
4335 "$ [ -d /etc ]\n" \
4336 "$ echo $?\n" \
4337 "0\n" \
4338 "$ [ -d /junk ]\n" \
4339 "$ echo $?\n" \
4340 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004341
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004342#define tc_trivial_usage \
4343 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
4344#define tc_full_usage "\n\n" \
4345 "OBJECT: {qdisc|class|filter}\n" \
4346 "CMD: {add|del|change|replace|show}\n" \
4347 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004348 "qdisc [ handle QHANDLE ] [ root |"IF_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004349 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4350 "\t[ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4351 "\tQDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004352 "qdisc show [ dev STRING ]"IF_FEATURE_TC_INGRESS(" [ingress]")"\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004353 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
4354 "\t[ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4355 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
4356 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
4357 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4358 "\t[ root | classid CLASSID ] [ handle FILTERID ]\n" \
4359 "\t[ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
4360 "filter show [ dev STRING ] [ root | parent CLASSID ]"
4361
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004362#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004363 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004364/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004365/* "[-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 +00004366#define tcpsvd_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004367 "Create TCP socket, bind it to ip:port and listen\n" \
4368 "for incoming connection. Run PROG for each connection.\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004369 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004370 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004371 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004372 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4373 "\n-u user[:group] Change to user/group after bind" \
4374 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004375 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004376 "\n-C n[:msg] Allow only up to n connections from the same IP" \
4377 "\n New connections from this IP address are closed" \
4378 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004379 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004380 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004381 "\n-v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004382
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004383#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00004384 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004385#define udpsvd_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004386 "Create UDP socket, bind it to ip:port and wait\n" \
4387 "for incoming packets. Run PROG for each packet,\n" \
4388 "redirecting all further packets with same peer ip:port to it\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004389 "\nip IP to listen on. '0' = all" \
4390 "\nport Port to listen on" \
4391 "\nprog [arg] Program to run" \
4392 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4393 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004394 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004395 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004396 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004397 "\n-v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004398
Mark Whitley450736c2001-03-02 19:08:50 +00004399#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004400 "[OPTION]... HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004401#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004402 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004403 "\nOptions:" \
4404 "\n -l FILE Local FILE" \
4405 "\n -r FILE Remote FILE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004406 IF_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004407 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004408 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004409 IF_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004410 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004411 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004412 IF_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004413 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004414 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004415
4416#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004417 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004418#define tftpd_full_usage "\n\n" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004419 "Transfer a file on tftp client's request.\n" \
Denis Vlasenko91f8f822008-10-30 23:42:37 +00004420 "\n" \
4421 "tftpd should be used as an inetd service.\n" \
4422 "tftpd's line for inetd.conf:\n" \
4423 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
4424 "It also can be ran from udpsvd:\n" \
4425 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004426 "\nOptions:" \
4427 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004428 "\n -c Allow file creation via upload" \
4429 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004430
Eric Andersenc3657422001-11-30 07:54:32 +00004431#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004432 "[OPTION]... COMMAND [ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004433#define time_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004434 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004435 "COMMAND's resource usage information is displayed.\n" \
4436 "\nOptions:" \
4437 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004438
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004439#define timeout_trivial_usage \
4440 "[-t SECS] [-s SIG] PROG [ARGS]"
4441#define timeout_full_usage "\n\n" \
4442 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
Denis Vlasenko42404082008-11-24 13:42:24 +00004443 "Defaults: SECS: 10, SIG: TERM." \
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004444
Eric Andersen420b2082002-09-17 22:14:58 +00004445#define top_trivial_usage \
Denis Vlasenko42cc6ba2008-09-25 11:17:10 +00004446 "[-b] [-nCOUNT] [-dSECONDS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004447#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004448 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004449 "Read the status of all processes from /proc each SECONDS\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004450 "and show the status for however many processes will fit on the screen." \
Eric Andersen420b2082002-09-17 22:14:58 +00004451
Eric Andersen7e9276b2001-02-22 01:15:47 +00004452#define touch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004453 "[-c] FILE [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004454#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004455 "Update the last-modified date on the given FILE[s]\n" \
4456 "\nOptions:" \
4457 "\n -c Do not create any files" \
4458
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004459#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004460 "$ ls -l /tmp/foo\n" \
4461 "/bin/ls: /tmp/foo: No such file or directory\n" \
4462 "$ touch /tmp/foo\n" \
4463 "$ ls -l /tmp/foo\n" \
4464 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004465
4466#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004467 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004468#define tr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004469 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004470 "standard input, writing to standard output\n" \
4471 "\nOptions:" \
4472 "\n -c Take complement of STRING1" \
4473 "\n -d Delete input characters coded STRING1" \
4474 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4475
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004476#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004477 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4478 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004479
Eric Andersen5c58d282001-07-10 16:29:00 +00004480#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004481 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
4482 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004483 " [-z pausemsecs] HOST [data size]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004484#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004485 "Trace the route to HOST\n" \
4486 "\nOptions:" \
4487 "\n -F Set the don't fragment bit" \
4488 "\n -I Use ICMP ECHO instead of UDP datagrams" \
4489 "\n -l Display the ttl value of the returned packet" \
4490 "\n -d Set SO_DEBUG options to socket" \
4491 "\n -n Print hop addresses numerically rather than symbolically" \
4492 "\n -r Bypass the normal routing tables and send directly to a host" \
4493 "\n -v Verbose" \
4494 "\n -m max_ttl Max time-to-live (max number of hops)" \
4495 "\n -p port# Base UDP port number used in probes" \
4496 "\n (default is 33434)" \
4497 "\n -q nqueries Number of probes per 'ttl' (default 3)" \
4498 "\n -s src_addr IP address to use as the source address" \
4499 "\n -t tos Type-of-service in probe packets (default 0)" \
4500 "\n -w wait Time in seconds to wait for a response" \
4501 "\n (default 3 sec)" \
4502 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004503
Eric Andersen7e9276b2001-02-22 01:15:47 +00004504#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004505 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004506#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004507 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004508#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004509 "$ true\n" \
4510 "$ echo $?\n" \
4511 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004512
Eric Andersen7e9276b2001-02-22 01:15:47 +00004513#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004514 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004515#define tty_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004516 "Print file name of standard input's terminal" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004517 IF_INCLUDE_SUSv2( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004518 "\nOptions:" \
4519 "\n -s Print nothing, only return exit status" \
4520 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004521#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004522 "$ tty\n" \
4523 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004524
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004525#define ttysize_trivial_usage \
4526 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004527#define ttysize_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004528 "Print dimension(s) of standard input's terminal, on error return 80x25"
4529
Denis Vlasenko39b68132009-01-23 02:07:14 +00004530#define tunctl_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004531 "[-f device] ([-t name] | -d name)" IF_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]")
Denis Vlasenko39b68132009-01-23 02:07:14 +00004532#define tunctl_full_usage "\n\n" \
4533 "Create or delete tun interfaces" \
4534 "\nOptions:" \
4535 "\n -f name tun device (/dev/net/tun)" \
4536 "\n -t name Create iface 'name'" \
4537 "\n -d name Delete iface 'name'" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004538IF_FEATURE_TUNCTL_UG( \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004539 "\n -u owner Set iface owner" \
4540 "\n -g group Set iface group" \
4541 "\n -b Brief output" \
4542)
4543#define tunctl_example_usage \
4544 "# tunctl\n" \
4545 "# tunctl -d tun0\n"
4546
Mike Frysinger174808c2005-06-11 01:14:09 +00004547#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004548 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
4549 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
4550 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
4551 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
4552 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
4553 "[-T last-check-time] [-U UUID] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004554#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004555 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004556
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004557#define udhcpc_trivial_usage \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004558 "[-Cfbnqtvo] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004559 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." IF_FEATURE_UDHCP_PORT(" [-P N]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004560#define udhcpc_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004561 IF_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004562 " -V,--vendorclass=CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004563 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
4564 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
4565 "\n -c,--clientid=CLIENTID Client identifier" \
4566 "\n -C,--clientid-none Suppress default client identifier" \
4567 "\n -p,--pidfile=file Create pidfile" \
4568 "\n -r,--request=IP IP address to request" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +00004569 "\n -s,--script=file Run file at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004570 "\n -t,--retries=N Send up to N request packets" \
4571 "\n -T,--timeout=N Try to get a lease for N seconds (default 3)" \
4572 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004573 "\n -O,--request-option=OPT Request DHCP option OPT (cumulative)" \
4574 "\n -o,--no-default-options Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004575 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004576 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004577 "\n -b,--background Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004578 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004579 "\n -S,--syslog Log to syslog too" \
4580 "\n -n,--now Exit with failure if lease is not immediately obtained" \
4581 "\n -q,--quit Quit after obtaining lease" \
4582 "\n -R,--release Release IP on quit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004583 IF_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004584 "\n -P,--client-port N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004585 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004586 IF_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004587 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004588 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004589 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004590 IF_NOT_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004591 " -V CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004592 "\n -i INTERFACE Interface to use (default: eth0)" \
4593 "\n -H,-h HOSTNAME Client hostname" \
4594 "\n -c CLIENTID Client identifier" \
4595 "\n -C Suppress default client identifier" \
4596 "\n -p file Create pidfile" \
4597 "\n -r IP IP address to request" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +00004598 "\n -s file Run file at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004599 "\n -t N Send up to N request packets" \
4600 "\n -T N Try to get a lease for N seconds (default 3)" \
4601 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004602 "\n -O OPT Request DHCP option OPT (cumulative)" \
4603 "\n -o Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004604 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004605 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004606 "\n -b Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004607 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004608 "\n -S Log to syslog too" \
4609 "\n -n Exit with failure if lease is not immediately obtained" \
4610 "\n -q Quit after obtaining lease" \
4611 "\n -R Release IP on quit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004612 IF_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004613 "\n -P N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004614 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004615 IF_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004616 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004617 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004618 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004619
Russ Dill61fb4892002-10-14 21:41:28 +00004620#define udhcpd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004621 "[-fS]" IF_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004622
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004623#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004624 "DHCP server\n" \
4625 "\n -f Run in foreground" \
4626 "\n -S Log to syslog too" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004627 IF_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004628 "\n -P N Use port N instead of default 67" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004629 )
Russ Dill61fb4892002-10-14 21:41:28 +00004630
Eric Andersen7e9276b2001-02-22 01:15:47 +00004631#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004632 "[flags] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004633#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004634 "Unmount file systems\n" \
4635 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004636 IF_FEATURE_UMOUNT_ALL( \
4637 "\n -a Unmount all file systems" IF_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004638 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004639 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004640 "\n -n Don't erase /etc/mtab entries" \
4641 ) \
4642 "\n -r Try to remount devices as read-only if mount is busy" \
4643 "\n -l Lazy umount (detach filesystem)" \
4644 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004645 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004646 "\n -d Free loop device if it has been used" \
4647 )
4648
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004649#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004650 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004651
4652#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004653 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004654#define uname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004655 "Print system information.\n" \
4656 "\nOptions:" \
4657 "\n -a Print all" \
4658 "\n -m The machine (hardware) type" \
4659 "\n -n Hostname" \
4660 "\n -r OS release" \
4661 "\n -s OS name (default)" \
4662 "\n -p Processor type" \
4663 "\n -v OS version" \
4664
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004665#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004666 "$ uname -a\n" \
4667 "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 +00004668
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004669#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004670 "[-c] [-f] [name...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004671#define uncompress_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004672 "Uncompress .Z file[s]\n" \
4673 "\nOptions:" \
4674 "\n -c Extract to stdout" \
4675 "\n -f Overwrite an existing file" \
Tim Riker7b253f82003-12-28 05:02:40 +00004676
Denis Vlasenko3952f202007-08-13 14:10:24 +00004677#define unexpand_trivial_usage \
4678 "[-f][-a][-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004679#define unexpand_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004680 "Convert spaces to tabs, writing to standard output.\n" \
4681 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004682 IF_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004683 "\n -a,--all Convert all blanks" \
4684 "\n -f,--first-only Convert only leading blanks" \
4685 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004686 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004687 IF_NOT_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004688 "\n -a Convert all blanks" \
4689 "\n -f Convert only leading blanks" \
4690 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004691 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004692
Eric Andersen7e9276b2001-02-22 01:15:47 +00004693#define uniq_trivial_usage \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004694 "[-fscduw]... [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004695#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004696 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004697 "\nOptions:" \
4698 "\n -c Prefix lines by the number of occurrences" \
4699 "\n -d Only print duplicate lines" \
4700 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004701 "\n -f N Skip first N fields" \
4702 "\n -s N Skip first N chars (after any skipped fields)" \
4703 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004704
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004705#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004706 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4707 "a\n" \
4708 "b\n" \
4709 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004710
4711#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004712 "[option] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004713#define unix2dos_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004714 "Convert FILE from unix to dos format.\n" \
4715 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00004716 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004717 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004718 "\n -d unix2dos" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004719
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004720#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004721 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004722#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004723 "Extract files from ZIP archives\n" \
4724 "\nOptions:" \
4725 "\n -l List archive contents (with -q for short form)" \
4726 "\n -n Never overwrite existing files (default)" \
4727 "\n -o Overwrite files without prompting" \
4728 "\n -p Send output to stdout" \
4729 "\n -q Quiet" \
4730 "\n -x Exclude these files" \
4731 "\n -d Extract files into this directory" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004732
Eric Andersen7e9276b2001-02-22 01:15:47 +00004733#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004734 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004735#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004736 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004737
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004738#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004739 "$ uptime\n" \
4740 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004741
4742#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004743 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004744#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004745 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004746
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004747#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004748 "$ usleep 1000000\n" \
4749 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004750
4751#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004752 "[-o outfile] [infile]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004753#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004754 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004755 "Finds outfile name in uuencoded source unless -o is given"
4756
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004757#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004758 "$ uudecode -o busybox busybox.uu\n" \
4759 "$ ls -l busybox\n" \
4760 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004761
4762#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004763 "[-m] [infile] stored_filename"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004764#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004765 "Uuencode a file to stdout\n" \
4766 "\nOptions:" \
4767 "\n -m Use base64 encoding per RFC1521" \
4768
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004769#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004770 "$ uuencode busybox busybox\n" \
4771 "begin 755 busybox\n" \
4772 "<encoded file snipped>\n" \
4773 "$ uudecode busybox busybox > busybox.uu\n" \
4774 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004775
Eric Andersen853c4942003-01-23 05:59:32 +00004776#define vconfig_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004777 "COMMAND [OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004778#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004779 "Create and remove virtual ethernet devices\n" \
4780 "\nOptions:" \
4781 "\n add [interface-name] [vlan_id]" \
4782 "\n rem [vlan-name]" \
4783 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4784 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4785 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4786 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004787
Eric Andersen3f980402001-04-04 17:31:15 +00004788#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004789 "[OPTION] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004790#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004791 "Edit FILE\n" \
4792 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004793 IF_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004794 "\n -c Initial command to run ($EXINIT also available)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004795 IF_FEATURE_VI_READONLY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004796 "\n -R Read-only - do not write to the file") \
4797 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00004798
Eric Andersen27f64e12002-06-23 04:24:25 +00004799#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004800 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004801#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004802 "Lock a virtual terminal. A password is required to unlock.\n" \
4803 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00004804 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004805
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004806#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00004807 "[-n seconds] [-t] COMMAND..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004808#define watch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004809 "Execute a program periodically\n" \
4810 "\nOptions:" \
4811 "\n -n Loop period in seconds (default 2)" \
4812 "\n -t Don't print header" \
4813
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004814#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004815 "$ watch date\n" \
4816 "Mon Dec 17 10:31:40 GMT 2000\n" \
4817 "Mon Dec 17 10:31:42 GMT 2000\n" \
4818 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004819
Eric Andersen7e9276b2001-02-22 01:15:47 +00004820#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004821 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004822#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004823 "Periodically write to watchdog device DEV\n" \
4824 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004825 "\n -T N Reboot after N seconds if not reset (default 60)" \
4826 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004827 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004828 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004829 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004830
4831#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004832 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004833#define wc_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004834 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004835 "more than one FILE is specified. With no FILE, read standard input.\n" \
4836 "\nOptions:" \
4837 "\n -c Print the byte counts" \
4838 "\n -l Print the newline counts" \
4839 "\n -L Print the length of the longest line" \
4840 "\n -w Print the word counts" \
4841
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004842#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004843 "$ wc /etc/passwd\n" \
4844 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004845
4846#define wget_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004847 IF_FEATURE_WGET_LONG_OPTIONS( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004848 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004849 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4850 " [-U|--user-agent agent] url" \
4851 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004852 IF_NOT_FEATURE_WGET_LONG_OPTIONS( \
Denis Vlasenko03630782007-10-18 11:11:12 +00004853 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4854 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004855#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004856 "Retrieve files via HTTP or FTP\n" \
4857 "\nOptions:" \
4858 "\n -s Spider mode - only check file existence" \
4859 "\n -c Continue retrieval of aborted transfer" \
4860 "\n -q Quiet" \
4861 "\n -P Set directory prefix to DIR" \
4862 "\n -O Save to filename ('-' for stdout)" \
4863 "\n -U Adjust 'User-Agent' field" \
4864 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004865
4866#define which_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004867 "[COMMAND...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004868#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004869 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004870#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004871 "$ which login\n" \
4872 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004873
Eric Andersen00a6a752002-04-26 23:53:10 +00004874#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004875 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004876#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004877 "Show who is logged on\n" \
4878 "\nOptions:" \
4879 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004880
4881#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004882 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004883#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004884 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004885
4886#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004887 "[OPTIONS] [COMMAND] [ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004888#define xargs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004889 "Execute COMMAND on every item given by standard input\n" \
4890 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004891 IF_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004892 "\n -p Ask user whether to run each command") \
4893 "\n -r Do not run command if input is empty" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004894 IF_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004895 "\n -0 Input is separated by NUL characters") \
4896 "\n -t Print the command on stderr before execution" \
Denis Vlasenkoe82da4d2008-08-21 19:59:30 +00004897 "\n -e[STR] STR stops input processing" \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004898 "\n -n N Pass no more than N args to COMMAND" \
4899 "\n -s N Pass command line of no more than N bytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004900 IF_FEATURE_XARGS_SUPPORT_TERMOPT( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004901 "\n -x Exit if size is exceeded") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004902
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004903#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004904 "$ ls | xargs gzip\n" \
4905 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004906
4907#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004908 "[OPTION]... [STRING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004909#define yes_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004910 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004911
Eric Andersen7e9276b2001-02-22 01:15:47 +00004912#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004913 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004914#define zcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004915 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004916
Rob Landleyad8071f2005-04-30 03:49:37 +00004917#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004918 "[OPTIONS] ifname script"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004919#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004920 "Manage a ZeroConf IPv4 link-local address\n" \
4921 "\nOptions:" \
4922 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004923 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004924 "\n -r 169.254.x.x Request this address first" \
4925 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004926 "\n" \
4927 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
4928 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00004929
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00004930
4931#endif