blob: a9c4c4294b87cba130fe4bfa923ddeaead9b8a87 [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 \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010019 "[-d] [-c CONFDIR] [-l LOGFILE] [-e PROC_EVENT_FILE] [EVDEV_EVENT_FILE]..."
Denis Vlasenkod16950d2008-11-29 09:05:50 +000020#define acpid_full_usage "\n\n" \
21 "Listen to ACPI events and spawn specific helpers on event arrival\n" \
22 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +020023 "\n -d Don't daemonize, log to stderr" \
Denis Vlasenkod16950d2008-11-29 09:05:50 +000024 "\n -c DIR Config directory [/etc/acpi]" \
25 "\n -e FILE /proc event file [/proc/acpi/event]" \
26 "\n -l FILE Log file [/var/log/acpid]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +000027 IF_FEATURE_ACPID_COMPAT( \
Denis Vlasenkod16950d2008-11-29 09:05:50 +000028 "\n\nAccept and ignore compatibility options -g -m -s -S -v" \
29 )
30
31#define acpid_example_usage \
32 "# acpid -l /var/log/my-acpi-log\n" \
33 "# acpid -d /dev/input/event*\n"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000034
Eric Andersenf349e972001-08-21 16:18:59 +000035#define addgroup_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010036 "[-g GID] " IF_FEATURE_ADDUSER_TO_GROUP("[USER] ") "GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000037#define addgroup_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +000038 "Add a group " IF_FEATURE_ADDUSER_TO_GROUP("or add a user to a group") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000039 "\nOptions:" \
Denis Vlasenko4f98e192008-04-13 22:12:19 +000040 "\n -g GID Group id" \
Denis Vlasenkoc2931aa2009-04-22 21:35:52 +000041 "\n -S Create a system group" \
Eric Andersenf349e972001-08-21 16:18:59 +000042
43#define adduser_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010044 "[OPTIONS] USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000045#define adduser_full_usage "\n\n" \
Denis Vlasenko73ac0562008-12-25 01:01:23 +000046 "Add a user\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000047 "\nOptions:" \
48 "\n -h DIR Home directory" \
49 "\n -g GECOS GECOS field" \
50 "\n -s SHELL Login shell" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +020051 "\n -G GRP Add user to existing group" \
Denis Vlasenko397de612008-03-17 08:55:44 +000052 "\n -S Create a system user" \
Denys Vlasenko07697852009-10-06 21:11:37 +020053 "\n -D Don't assign a password" \
54 "\n -H Don't create home directory" \
Denis Vlasenkoc2931aa2009-04-22 21:35:52 +000055 "\n -u UID User id" \
Eric Andersenf349e972001-08-21 16:18:59 +000056
Mark Whitley6f932772001-03-20 19:18:10 +000057#define adjtimex_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010058 "[-q] [-o OFF] [-f FREQ] [-p TCONST] [-t TICK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000059#define adjtimex_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +010060 "Read and optionally set system timebase parameters. See adjtimex(2)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000061 "\nOptions:" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010062 "\n -q Quiet" \
63 "\n -o OFF Time offset, microseconds" \
64 "\n -f FREQ Frequency adjust, integer kernel units (65536 is 1ppm)" \
65 "\n (positive values make clock run faster)" \
66 "\n -t TICK Microseconds per tick, usually 10000" \
67 "\n -p TCONST" \
Mark Whitley6f932772001-03-20 19:18:10 +000068
Eric Andersen7e9276b2001-02-22 01:15:47 +000069#define ar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000070 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000071#define ar_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000072 "Extract or list FILES from an ar archive\n" \
73 "\nOptions:" \
74 "\n -o Preserve original dates" \
75 "\n -p Extract to stdout" \
76 "\n -t List" \
77 "\n -x Extract" \
78 "\n -v Verbose" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000079
Denis Vlasenkofa85b862007-01-07 01:24:12 +000080#define arp_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010081 "\n[-vn] [-H HWTYPE] [-i IF] -a [HOSTNAME]" \
82 "\n[-v] [-i IF] -d HOSTNAME [pub]" \
83 "\n[-v] [-H HWTYPE] [-i IF] -s HOSTNAME HWADDR [temp]" \
84 "\n[-v] [-H HWTYPE] [-i IF] -s HOSTNAME HWADDR [netmask MASK] pub" \
85 "\n[-v] [-H HWTYPE] [-i IF] -Ds HOSTNAME IFACE [netmask MASK] pub"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000086#define arp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000087 "Manipulate ARP cache\n" \
88 "\nOptions:" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000089 "\n -a Display (all) hosts" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000090 "\n -s Set new ARP entry" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000091 "\n -d Delete a specified entry" \
92 "\n -v Verbose" \
93 "\n -n Don't resolve names" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000094 "\n -i IF Network interface" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000095 "\n -D Read <hwaddr> from given device" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000096 "\n -A, -p AF Protocol family" \
Denis Vlasenko397de612008-03-17 08:55:44 +000097 "\n -H HWTYPE Hardware address type" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000098
Glenn L McGrath9e598412003-01-09 10:06:01 +000099#define arping_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100100 "[-fqbDUA] [-c CNT] [-w TIMEOUT] [-I IFACE] [-s SRC_IP] DST_IP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000101#define arping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000102 "Send ARP requests/replies\n" \
103 "\nOptions:" \
104 "\n -f Quit on first ARP reply" \
105 "\n -q Quiet" \
106 "\n -b Keep broadcasting, don't go unicast" \
107 "\n -D Duplicated address detection mode" \
108 "\n -U Unsolicited ARP mode, update your neighbors" \
109 "\n -A ARP answer mode, update your neighbors" \
110 "\n -c N Stop after sending N ARP requests" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100111 "\n -w TIMEOUT Time to wait for ARP reply, seconds" \
112 "\n -I IFACE Interface to use (default eth0)" \
113 "\n -s SRC_IP Sender IP address" \
114 "\n DST_IP Target IP address" \
Glenn L McGrath9e598412003-01-09 10:06:01 +0000115
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000116#define sh_trivial_usage NOUSAGE_STR
117#define sh_full_usage ""
118#define ash_trivial_usage NOUSAGE_STR
119#define ash_full_usage ""
120#define hush_trivial_usage NOUSAGE_STR
121#define hush_full_usage ""
Denys Vlasenko1cc4b132009-08-21 00:05:51 +0200122#define lash_trivial_usage NOUSAGE_STR
123#define lash_full_usage ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000124#define msh_trivial_usage NOUSAGE_STR
125#define msh_full_usage ""
Denys Vlasenko40477e22010-05-20 02:09:45 +0200126#define bash_trivial_usage NOUSAGE_STR
127#define bash_full_usage ""
Eric Andersen08f59e32004-03-12 22:07:10 +0000128
129#define awk_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200130 "[OPTIONS] [AWK_PROGRAM] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000131#define awk_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000132 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200133 "\n -v VAR=VAL Set variable" \
134 "\n -F SEP Use SEP as field separator" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +0100135 "\n -f FILE Read program from FILE" \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +0000136
Eric Andersen7e9276b2001-02-22 01:15:47 +0000137#define basename_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000138 "FILE [SUFFIX]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000139#define basename_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200140 "Strip directory path and .SUFFIX from FILE\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000141#define basename_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000142 "$ basename /usr/local/bin/foo\n" \
143 "foo\n" \
144 "$ basename /usr/local/bin/\n" \
145 "bin\n" \
146 "$ basename /foo/bar.txt .txt\n" \
147 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000148
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200149#define beep_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100150 "-f FREQ -l LEN -d DELAY -r COUNT -n"
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200151#define beep_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +0200152 "Options:" \
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200153 "\n -f Frequency in Hz" \
154 "\n -l Length in ms" \
155 "\n -d Delay in ms" \
156 "\n -r Repetitions" \
157 "\n -n Start new tone" \
158
Grigory Batalovad7a5d42010-05-23 23:22:10 +0200159#define blkid_trivial_usage \
160 ""
161#define blkid_full_usage "\n\n" \
162 "Print UUIDs of all filesystems"
163
Denys Vlasenkoff027d62010-05-04 15:45:25 +0200164#define bootchartd_trivial_usage \
165 "start [PROG ARGS]|stop|init"
166#define bootchartd_full_usage "\n\n" \
167 "Create /var/log/bootchart.tgz with boot chart data\n" \
168 "\nOptions:" \
169 "\nstart: start background logging; with PROG, run PROG, then kill logging with USR1" \
170 "\nstop: send USR1 to all bootchartd processes" \
171 "\ninit: start background logging; stop when getty/xdm is seen (for init scripts)" \
172 "\nUnder PID 1: as init, then exec $bootchart_init, /init, /sbin/init" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000173
Bernhard Reutner-Fischerd27d9252008-01-13 15:23:27 +0000174#define brctl_trivial_usage \
175 "COMMAND [BRIDGE [INTERFACE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000176#define brctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200177 "Manage ethernet bridges\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000178 "\nCommands:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000179 IF_FEATURE_BRCTL_SHOW( \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000180 "\n show Show a list of bridges" \
181 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000182 "\n addbr BRIDGE Create BRIDGE" \
183 "\n delbr BRIDGE Delete BRIDGE" \
184 "\n addif BRIDGE IFACE Add IFACE to BRIDGE" \
185 "\n delif BRIDGE IFACE Delete IFACE from BRIDGE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000186 IF_FEATURE_BRCTL_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000187 "\n setageing BRIDGE TIME Set ageing time" \
188 "\n setfd BRIDGE TIME Set bridge forward delay" \
189 "\n sethello BRIDGE TIME Set hello time" \
190 "\n setmaxage BRIDGE TIME Set max message age" \
191 "\n setpathcost BRIDGE COST Set path cost" \
192 "\n setportprio BRIDGE PRIO Set port priority" \
193 "\n setbridgeprio BRIDGE PRIO Set bridge priority" \
Maciek Borzecki30ebd7b2010-03-23 05:18:38 +0100194 "\n stp BRIDGE [1/yes/on|0/no/off] STP on/off" \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000195 ) \
196
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000197#define bzip2_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200198 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000199#define bzip2_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100200 "Compress FILEs (or stdin) with bzip2 algorithm\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000201 "\nOptions:" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200202 "\n -1..9 Compression level" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000203 "\n -d Decompress" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200204 "\n -c Write to stdout" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000205 "\n -f Force" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000206
Rob Landley6130b9b2006-01-23 21:10:38 +0000207#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000208 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000209
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000210#define lzop_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200211 "[-cfvd123456789CF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000212#define lzop_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200213 "Options:" \
214 "\n -1..9 Compression level" \
215 "\n -d Decompress" \
216 "\n -c Write to stdout" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000217 "\n -f Force" \
218 "\n -v Verbose" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000219 "\n -F Don't store or verify checksum" \
220 "\n -C Also write checksum of compressed block" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000221
222#define lzopcat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200223 "[-vCF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000224#define lzopcat_full_usage "\n\n" \
225 " -v Verbose" \
226 "\n -F Don't store or verify checksum" \
227
228#define unlzop_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200229 "[-cfvCF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000230#define unlzop_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200231 "Options:" \
232 "\n -c Write to stdout" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000233 "\n -f Force" \
234 "\n -v Verbose" \
235 "\n -F Don't store or verify checksum" \
236
Denys Vlasenkoe04c8672010-05-30 03:33:50 +0200237#define bunzip2_trivial_usage \
238 "[OPTIONS] [FILE]..."
239#define bunzip2_full_usage "\n\n" \
240 "Decompress FILEs (or stdin)\n" \
241 "\nOptions:" \
242 "\n -c Write to stdout" \
243 "\n -f Force" \
244
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000245#define bzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000246 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000247#define bzcat_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200248 "Decompress to stdout"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000249
Rob Landleyc1d69902006-01-20 18:28:50 +0000250#define unlzma_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100251 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000252#define unlzma_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200253 "Decompress FILE (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000254 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100255 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000256 "\n -f Force" \
Rob Landleyc1d69902006-01-20 18:28:50 +0000257
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200258#define lzma_trivial_usage \
259 "-d [OPTIONS] [FILE]..."
260#define lzma_full_usage "\n\n" \
261 "Decompress FILE (or stdin)\n" \
262 "\nOptions:" \
263 "\n -d Decompress" \
264 "\n -c Write to stdout" \
265 "\n -f Force" \
266
267#define lzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000268 "FILE"
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200269#define lzcat_full_usage "\n\n" \
270 "Decompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000271
Denys Vlasenko602ce692010-05-30 03:35:18 +0200272#define unxz_trivial_usage \
273 "[OPTIONS] [FILE]..."
274#define unxz_full_usage "\n\n" \
275 "Decompress FILE (or stdin)\n" \
276 "\nOptions:" \
277 "\n -c Write to stdout" \
278 "\n -f Force" \
279
280#define xz_trivial_usage \
281 "-d [OPTIONS] [FILE]..."
282#define xz_full_usage "\n\n" \
283 "Decompress FILE (or stdin)\n" \
284 "\nOptions:" \
285 "\n -d Decompress" \
286 "\n -c Write to stdout" \
287 "\n -f Force" \
288
289#define xzcat_trivial_usage \
290 "FILE"
291#define xzcat_full_usage "\n\n" \
292 "Decompress to stdout"
293
Eric Andersenc98c0622001-12-06 15:16:43 +0000294#define cal_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100295 "[-jy] [[MONTH] YEAR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000296#define cal_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000297 "Display a calendar\n" \
298 "\nOptions:" \
299 "\n -j Use julian dates" \
300 "\n -y Display the entire year" \
Eric Andersenc98c0622001-12-06 15:16:43 +0000301
Eric Andersen7e9276b2001-02-22 01:15:47 +0000302#define cat_trivial_usage \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200303 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000304#define cat_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200305 "Concatenate FILEs and print them to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000306
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000307#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000308 "$ cat /proc/uptime\n" \
309 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000310
Rob Landley8abbee42006-05-31 19:36:04 +0000311#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000312 "[-etv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000313#define catv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000314 "Display nonprinting characters as ^x or M-x\n" \
315 "\nOptions:" \
316 "\n -e End each line with $" \
317 "\n -t Show tabs as ^I" \
318 "\n -v Don't use ^x or M-x escapes" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000319
320#define chat_trivial_usage \
321 "EXPECT [SEND [EXPECT [SEND...]]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000322#define chat_full_usage "\n\n" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000323 "Useful for interacting with a modem connected to stdin/stdout.\n" \
324 "A script consists of one or more \"expect-send\" pairs of strings,\n" \
325 "each pair is a pair of arguments. Example:\n" \
326 "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \
327
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000328#define chattr_trivial_usage \
Denys Vlasenko79ae5342010-01-06 12:27:18 +0100329 "[-R] [-+=AacDdijsStTu] [-v VERSION] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000330#define chattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000331 "Change file attributes on an ext2 fs\n" \
332 "\nModifiers:" \
333 "\n - Remove attributes" \
334 "\n + Add attributes" \
335 "\n = Set attributes" \
336 "\nAttributes:" \
337 "\n A Don't track atime" \
338 "\n a Append mode only" \
339 "\n c Enable compress" \
340 "\n D Write dir contents synchronously" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200341 "\n d Don't backup with dump" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000342 "\n i Cannot be modified (immutable)" \
343 "\n j Write all data to journal first" \
344 "\n s Zero disk storage when deleted" \
345 "\n S Write file contents synchronously" \
346 "\n t Disable tail-merging of partial blocks with other files" \
347 "\n u Allow file to be undeleted" \
348 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100349 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000350 "\n -v Set the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000351
Denis Vlasenko49622d72007-03-10 16:58:49 +0000352#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000353 "[OPTIONS] CONTEXT FILE..." \
354 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000355 IF_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000356 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
357 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000358#define chcon_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000359 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000360 IF_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000361 "\n -v,--verbose Verbose" \
362 "\n -c,--changes Report changes made" \
363 "\n -h,--no-dereference Affect symlinks instead of their targets" \
364 "\n -f,--silent,--quiet Suppress most error messages" \
365 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
366 "\n -u,--user=USER Set user/role/type/range in the target" \
367 "\n -r,--role=ROLE security context" \
368 "\n -t,--type=TYPE" \
369 "\n -l,--range=RANGE" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200370 "\n -R,--recursive Recurse" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000371 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000372 IF_NOT_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000373 "\n -v Verbose" \
374 "\n -c Report changes made" \
375 "\n -h Affect symlinks instead of their targets" \
376 "\n -f Suppress most error messages" \
377 "\n -u USER Set user/role/type/range in the target security context" \
378 "\n -r ROLE" \
379 "\n -t TYPE" \
380 "\n -l RNG" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200381 "\n -R Recurse" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000382 )
383
Eric Andersen7e9276b2001-02-22 01:15:47 +0000384#define chmod_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000385 "[-R"IF_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000386#define chmod_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000387 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000388 "symbols +-= and one or more of the letters rwxst\n" \
389 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200390 "\n -R Recurse" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000391 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000392 "\n -c List changed files" \
393 "\n -v List all files" \
394 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000395 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000396#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000397 "$ ls -l /tmp/foo\n" \
398 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
399 "$ chmod u+x /tmp/foo\n" \
400 "$ ls -l /tmp/foo\n" \
401 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
402 "$ chmod 444 /tmp/foo\n" \
403 "$ ls -l /tmp/foo\n" \
404 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000405
Denis Vlasenko081ef792007-03-17 16:38:21 +0000406#define chgrp_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000407 "[-RhLHP"IF_DESKTOP("cvf")"]... GROUP FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000408#define chgrp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000409 "Change the group membership of each FILE to GROUP\n" \
410 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200411 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000412 "\n -h Affect symlinks instead of symlink targets" \
413 "\n -L Traverse all symlinks to directories" \
414 "\n -H Traverse symlinks on command line only" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200415 "\n -P Don't traverse symlinks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000416 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000417 "\n -c List changed files" \
418 "\n -v Verbose" \
419 "\n -f Hide errors" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000420 )
421#define chgrp_example_usage \
422 "$ ls -l /tmp/foo\n" \
423 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
424 "$ chgrp root /tmp/foo\n" \
425 "$ ls -l /tmp/foo\n" \
426 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
427
Eric Andersen7e9276b2001-02-22 01:15:47 +0000428#define chown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000429 "[-RhLHP"IF_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000430#define chown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000431 "Change the owner and/or group of each FILE to OWNER and/or GROUP\n" \
432 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200433 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000434 "\n -h Affect symlinks instead of symlink targets" \
435 "\n -L Traverse all symlinks to directories" \
436 "\n -H Traverse symlinks on command line only" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200437 "\n -P Don't traverse symlinks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000438 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000439 "\n -c List changed files" \
440 "\n -v List all files" \
441 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000442 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000443#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000444 "$ ls -l /tmp/foo\n" \
445 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
446 "$ chown root /tmp/foo\n" \
447 "$ ls -l /tmp/foo\n" \
448 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
449 "$ chown root.root /tmp/foo\n" \
450 "ls -l /tmp/foo\n" \
451 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000452
Denis Vlasenkofe544582006-10-03 15:57:40 +0000453#define chpst_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000454 "[-vP012] [-u USER[:GRP]] [-U USER[:GRP]] [-e DIR]\n" \
455 " [-/ DIR] [-n NICE] [-m BYTES] [-d BYTES] [-o N]\n" \
456 " [-p N] [-f BYTES] [-c BYTES] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000457#define chpst_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000458 "Change the process state and run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000459 "\nOptions:" \
460 "\n -u USER[:GRP] Set uid and gid" \
461 "\n -U USER[:GRP] Set $UID and $GID in environment" \
462 "\n -e DIR Set environment variables as specified by files" \
463 "\n in DIR: file=1st_line_of_file" \
464 "\n -/ DIR Chroot to DIR" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000465 "\n -n NICE Add NICE to nice value" \
466 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000467 "\n -d BYTES Limit data segment" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000468 "\n -o N Limit number of open files per process" \
469 "\n -p N Limit number of processes per uid" \
470 "\n -f BYTES Limit output file sizes" \
471 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000472 "\n -v Verbose" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000473 "\n -P Create new process group" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100474 "\n -0 Close stdin" \
475 "\n -1 Close stdout" \
476 "\n -2 Close stderr" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000477
Denis Vlasenkofe544582006-10-03 15:57:40 +0000478#define setuidgid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100479 "USER PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000480#define setuidgid_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100481 "Set uid and gid to USER's uid and gid, removing all supplementary\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000482 "groups and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000483#define envuidgid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100484 "USER PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000485#define envuidgid_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100486 "Set $UID to USER's uid and $GID to USER's gid and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000487#define envdir_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100488 "DIR PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000489#define envdir_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000490 "Set various environment variables as specified by files\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000491 "in the directory dir and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000492#define softlimit_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000493 "[-a BYTES] [-m BYTES] [-d BYTES] [-s BYTES] [-l BYTES]\n" \
494 " [-f BYTES] [-c BYTES] [-r BYTES] [-o N] [-p N] [-t N]\n" \
495 " PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000496#define softlimit_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000497 "Set soft resource limits, then run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000498 "\nOptions:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000499 "\n -a BYTES Limit total size of all segments" \
500 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES -a BYTES" \
501 "\n -d BYTES Limit data segment" \
502 "\n -s BYTES Limit stack segment" \
503 "\n -l BYTES Limit locked memory size" \
504 "\n -o N Limit number of open files per process" \
505 "\n -p N Limit number of processes per uid" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000506 "\nOptions controlling file sizes:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000507 "\n -f BYTES Limit output file sizes" \
508 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000509 "\nEfficiency opts:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000510 "\n -r BYTES Limit resident set size" \
511 "\n -t N Limit CPU time, process receives" \
512 "\n a SIGXCPU after N seconds" \
Denis Vlasenkofe544582006-10-03 15:57:40 +0000513
Eric Andersen7e9276b2001-02-22 01:15:47 +0000514#define chroot_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100515 "NEWROOT [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000516#define chroot_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200517 "Run PROG with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000518#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000519 "$ ls -l /bin/ls\n" \
520 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
521 "# mount /dev/hdc1 /mnt -t minix\n" \
522 "# chroot /mnt\n" \
523 "# ls -l /bin/ls\n" \
524 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000525
Eric Andersen7e9276b2001-02-22 01:15:47 +0000526#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000527 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000528#define chvt_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000529 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000530
Rob Landley856489b2006-04-18 20:57:28 +0000531#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000532 "FILES..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000533#define cksum_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000534 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000535
Eric Andersen7e9276b2001-02-22 01:15:47 +0000536#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000537 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000538#define clear_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000539 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000540
Eric Andersen7e9276b2001-02-22 01:15:47 +0000541#define cmp_trivial_usage \
Denys Vlasenko65ebbc52010-05-09 04:38:22 +0200542 "[-l] [-s] FILE1 [FILE2" IF_DESKTOP(" [SKIP1 [SKIP2]]") "]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000543#define cmp_full_usage "\n\n" \
Denys Vlasenko65ebbc52010-05-09 04:38:22 +0200544 "Compare FILE1 with FILE2 (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000545 "\nOptions:" \
546 "\n -l Write the byte numbers (decimal) and values (octal)" \
547 "\n for all differing bytes" \
548 "\n -s Quiet" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000549
Rob Landley2acfd7b2005-05-11 23:12:49 +0000550#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000551 "[-123] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000552#define comm_full_usage "\n\n" \
Denys Vlasenko65ebbc52010-05-09 04:38:22 +0200553 "Compare FILE1 with FILE2\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000554 "\nOptions:" \
555 "\n -1 Suppress lines unique to FILE1" \
556 "\n -2 Suppress lines unique to FILE2" \
557 "\n -3 Suppress lines common to both files" \
Rob Landley2acfd7b2005-05-11 23:12:49 +0000558
Paul Fox79c142d2005-08-01 16:04:40 +0000559#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000560 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000561#define bbconfig_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000562 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000563
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000564#define chrt_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100565 "[OPTIONS] [PRIO] [PID | PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000566#define chrt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000567 "Manipulate real-time attributes of a process\n" \
568 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100569 "\n -p Operate on PID" \
570 "\n -r Set SCHED_RR scheduling" \
571 "\n -f Set SCHED_FIFO scheduling" \
572 "\n -o Set SCHED_OTHER scheduling" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000573 "\n -m Show min and max priorities" \
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000574
575#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000576 "$ chrt -r 4 sleep 900; x=$!\n" \
577 "$ chrt -f -p 3 $x\n" \
578 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000579
Eric Andersen7e9276b2001-02-22 01:15:47 +0000580#define cp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200581 "[OPTIONS] SOURCE DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000582#define cp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000583 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY\n" \
584 "\nOptions:" \
585 "\n -a Same as -dpR" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000586 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000587 "\n -c Preserve security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000588 ) \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100589 "\n -R,-r Recurse" \
590 "\n -d,-P Preserve symlinks (default if -R)" \
591 "\n -L Follow all symlinks" \
592 "\n -H Follow symlinks on command line" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000593 "\n -p Preserve file attributes if possible" \
Denys Vlasenkoa3581402010-05-27 02:30:04 +0200594 "\n -f Overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000595 "\n -i Prompt before overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000596 "\n -l,-s Create (sym)links" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000597
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000598#define cpio_trivial_usage \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100599 "[-dmvu] [-F FILE]" IF_FEATURE_CPIO_O(" [-H newc]") \
600 " [-ti"IF_FEATURE_CPIO_O("o")"]" IF_FEATURE_CPIO_P(" [-p DIR]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000601#define cpio_full_usage "\n\n" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000602 "Extract or list files from a cpio archive" \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100603 IF_FEATURE_CPIO_O(", or" \
604 "\ncreate an archive" IF_FEATURE_CPIO_P(" (-o) or copy files (-p)") \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100605 " using file list on stdin" \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100606 ) \
607 "\n" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000608 "\nMain operation mode:" \
609 "\n -t List" \
610 "\n -i Extract" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000611 IF_FEATURE_CPIO_O( \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100612 "\n -o Create (requires -H newc)" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000613 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000614 IF_FEATURE_CPIO_P( \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100615 "\n -p DIR Copy files to DIR" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000616 ) \
617 "\nOptions:" \
618 "\n -d Make leading directories" \
619 "\n -m Preserve mtime" \
620 "\n -v Verbose" \
621 "\n -u Overwrite" \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100622 "\n -F FILE Input (-t,-i,-p) or output (-o) file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000623 IF_FEATURE_CPIO_O( \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100624 "\n -H newc Archive format" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000625 ) \
Tim Riker7b253f82003-12-28 05:02:40 +0000626
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000627#define crond_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000628 "-fbS -l N " IF_FEATURE_CROND_D("-d N ") "-L LOGFILE -c DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000629#define crond_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000630 " -f Foreground" \
631 "\n -b Background (default)" \
632 "\n -S Log to syslog (default)" \
633 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000634 IF_FEATURE_CROND_D( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000635 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000636 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000637 "\n -L Log to file" \
638 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000639
640#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000641 "[-c DIR] [-u USER] [-ler]|[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000642#define crontab_full_usage "\n\n" \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000643 " -c Crontab directory" \
644 "\n -u User" \
645 "\n -l List crontab" \
646 "\n -e Edit crontab" \
647 "\n -r Delete crontab" \
648 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000649
Denis Vlasenko2211d522008-11-10 18:52:35 +0000650#define cryptpw_trivial_usage \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000651 "[OPTIONS] [PASSWORD] [SALT]"
652/* We do support -s, we just don't mention it */
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000653#define cryptpw_full_usage "\n\n" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000654 "Crypt the PASSWORD using crypt(3)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000655 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200656 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100657 "\n -P,--password-fd=N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000658/* "\n -s,--stdin Use stdin; like -P0" */ \
659 "\n -m,--method=TYPE Encryption method TYPE" \
660 "\n -S,--salt=SALT" \
661 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200662 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100663 "\n -P N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000664/* "\n -s Use stdin; like -P0" */ \
665 "\n -m TYPE Encryption method TYPE" \
666 "\n -S SALT" \
667 ) \
668
669/* mkpasswd is an alias to cryptpw */
670
671#define mkpasswd_trivial_usage \
672 "[OPTIONS] [PASSWORD] [SALT]"
673/* We do support -s, we just don't mention it */
674#define mkpasswd_full_usage "\n\n" \
675 "Crypt the PASSWORD using crypt(3)\n" \
676 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200677 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100678 "\n -P,--password-fd=N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000679/* "\n -s,--stdin Use stdin; like -P0" */ \
680 "\n -m,--method=TYPE Encryption method TYPE" \
681 "\n -S,--salt=SALT" \
682 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200683 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100684 "\n -P N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000685/* "\n -s Use stdin; like -P0" */ \
686 "\n -m TYPE Encryption method TYPE" \
687 "\n -S SALT" \
688 ) \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000689
Denys Vlasenkob367bb22010-05-15 20:43:07 +0200690#define cttyhack_trivial_usage \
691 "PROG ARGS"
692#define cttyhack_full_usage "\n\n" \
693 "Give PROG a controlling tty if possible." \
694 "\nExample for /etc/inittab (for busybox init):" \
695 "\n ::respawn:/bin/cttyhack /bin/sh" \
696 "\nGiving controlling tty to shell running with PID 1:" \
697 "\n $ exec cttyhack sh" \
Denys Vlasenkoef215552010-05-17 09:55:13 +0200698 "\nStarting interactive shell from boot shell script:" \
Denys Vlasenkob367bb22010-05-15 20:43:07 +0200699 "\n setsid cttyhack sh" \
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000700
Eric Andersen7e9276b2001-02-22 01:15:47 +0000701#define cut_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200702 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000703#define cut_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100704 "Print selected fields from each input FILE to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000705 "\nOptions:" \
706 "\n -b LIST Output only bytes from LIST" \
707 "\n -c LIST Output only characters from LIST" \
708 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
709 "\n -s Output only the lines containing delimiter" \
710 "\n -f N Print only these fields" \
711 "\n -n Ignored" \
712
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000713#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000714 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
715 "Hello\n" \
716 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
717 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000718
Eric Andersen7e9276b2001-02-22 01:15:47 +0000719#define date_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200720 "[OPTIONS] [+FMT] [TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000721#define date_full_usage "\n\n" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000722 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000723 "\nOptions:" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200724 IF_NOT_LONG_OPTS( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200725 "\n [-s] TIME Set time to TIME" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000726 "\n -u Work in UTC (don't convert to local time)" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200727 "\n -R Output RFC-2822 compliant date string" \
728 ) IF_LONG_OPTS( \
729 "\n [-s,--set] TIME Set time to TIME" \
Denys Vlasenko50be9632009-10-23 16:25:20 +0200730 "\n -u,--utc Work in UTC (don't convert to local time)" \
731 "\n -R,--rfc-2822 Output RFC-2822 compliant date string" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200732 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000733 IF_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000734 "\n -I[SPEC] Output ISO-8601 compliant date string" \
735 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000736 "\n 'hours', 'minutes', or 'seconds' for date and" \
737 "\n time to the indicated precision" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200738 ) IF_NOT_LONG_OPTS( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000739 "\n -r FILE Display last modification time of FILE" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200740 "\n -d TIME Display TIME, not 'now'" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200741 ) IF_LONG_OPTS( \
Denys Vlasenko50be9632009-10-23 16:25:20 +0200742 "\n -r,--reference FILE Display last modification time of FILE" \
743 "\n -d,--date TIME Display TIME, not 'now'" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200744 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000745 IF_FEATURE_DATE_ISOFMT( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200746 "\n -D FMT Use FMT for -d TIME conversion" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000747 ) \
748 "\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +0200749 "\nRecognized TIME formats:" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000750 "\n hh:mm[:ss]" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000751 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000752 "\n YYYY-MM-DD hh:mm[:ss]" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200753 "\n [[[[[YY]YY]MM]DD]hh]mm[.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000754
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000755#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000756 "$ date\n" \
757 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000758
Eric Andersen7e9276b2001-02-22 01:15:47 +0000759#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000760 "expression..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000761#define dc_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +0000762 "Tiny RPN calculator. Operations:\n" \
763 "+, add, -, sub, *, mul, /, div, %, mod, **, exp, and, or, not, eor,\n" \
764 "p - print top of the stack (without altering the stack),\n" \
765 "f - print entire stack, o - pop the value and set output radix\n" \
766 "(value must be 10 or 16).\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100767 "Examples: 'dc 2 2 add' -> 4, 'dc 8 8 * 2 2 + /' -> 16\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000768
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000769#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000770 "$ dc 2 2 + p\n" \
771 "4\n" \
772 "$ dc 8 8 \\* 2 2 + / p\n" \
773 "16\n" \
774 "$ dc 0 1 and p\n" \
775 "0\n" \
776 "$ dc 0 1 or p\n" \
777 "1\n" \
778 "$ echo 72 9 div 8 mul p | dc\n" \
779 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000780
Eric Andersen7e9276b2001-02-22 01:15:47 +0000781#define dd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000782 "[if=FILE] [of=FILE] " IF_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
783 " [seek=N]" IF_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000784#define dd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000785 "Copy a file with converting and formatting\n" \
786 "\nOptions:" \
787 "\n if=FILE Read from FILE instead of stdin" \
788 "\n of=FILE Write to FILE instead of stdout" \
789 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000790 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000791 "\n ibs=N Read N bytes at a time" \
792 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000793 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000794 "\n obs=N Write N bytes at a time" \
795 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000796 "\n count=N Copy only N input blocks" \
797 "\n skip=N Skip N input blocks" \
798 "\n seek=N Skip N output blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000799 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000800 "\n conv=notrunc Don't truncate output file" \
801 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000802 "\n conv=sync Pad blocks with zeros" \
803 "\n conv=fsync Physically write data out before finishing" \
804 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000805 "\n" \
806 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
807 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
808
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000809#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000810 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
811 "4+0 records in\n" \
812 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000813
Eric Andersen7e9276b2001-02-22 01:15:47 +0000814#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000815 "[N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000816#define deallocvt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000817 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000818
Eric Andersenf349e972001-08-21 16:18:59 +0000819#define delgroup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000820 IF_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000821#define delgroup_full_usage "\n\n" \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000822 "Delete group GROUP from the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000823 IF_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000824
825#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000826 "USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000827#define deluser_full_usage "\n\n" \
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000828 "Delete USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000829
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000830#define depmod_trivial_usage NOUSAGE_STR
831#define depmod_full_usage ""
Bernhard Reutner-Fischer55e547e2008-05-26 12:01:49 +0000832
Denis Vlasenkoc94fa562008-10-26 11:08:14 +0000833#define devmem_trivial_usage \
834 "ADDRESS [WIDTH [VALUE]]"
835
836#define devmem_full_usage "\n\n" \
837 "Read/write from physical address\n" \
838 "\n ADDRESS Address to act upon" \
839 "\n WIDTH Width (8/16/...)" \
840 "\n VALUE Data to be written" \
841
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000842#define devfsd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000843 "mntpnt [-v]" IF_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000844#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000845 "Manage devfs permissions and old device name symlinks\n" \
846 "\nOptions:" \
847 "\n mntpnt The mount point where devfs is mounted" \
848 "\n -v Print the protocol version numbers for devfsd" \
849 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000850 IF_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000851 "\n -fg Run in foreground" \
852 "\n -np Exit after parsing the configuration file" \
853 "\n and processing synthetic REGISTER events," \
Denys Vlasenko07697852009-10-06 21:11:37 +0200854 "\n don't poll for events" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000855 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000856
Eric Andersen7e9276b2001-02-22 01:15:47 +0000857#define df_trivial_usage \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000858 "[-Pk" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000859 IF_FEATURE_HUMAN_READABLE("mh") \
860 IF_FEATURE_DF_FANCY("ai] [-B SIZE") \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100861 "] [FILESYSTEM]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000862#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000863 "Print filesystem usage statistics\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000864 "\nOptions:" \
865 "\n -P POSIX output format" \
866 "\n -k 1024-byte blocks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000867 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000868 "\n -m 1M-byte blocks" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000869 "\n -h Human readable (e.g. 1K 243M 2G)" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000870 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000871 IF_FEATURE_DF_FANCY( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000872 "\n -a Show all filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000873 "\n -i Inodes" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000874 "\n -B SIZE Blocksize" \
875 ) \
876
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000877#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000878 "$ df\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000879 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000880 "/dev/sda3 8690864 8553540 137324 98% /\n" \
881 "/dev/sda1 64216 36364 27852 57% /boot\n" \
882 "$ df /dev/sda3\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000883 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
884 "/dev/sda3 8690864 8553540 137324 98% /\n" \
885 "$ POSIXLY_CORRECT=sure df /dev/sda3\n" \
886 "Filesystem 512B-blocks Used Available Use% Mounted on\n" \
887 "/dev/sda3 17381728 17107080 274648 98% /\n" \
888 "$ POSIXLY_CORRECT=yep df -P /dev/sda3\n" \
889 "Filesystem 512-blocks Used Available Capacity Mounted on\n" \
890 "/dev/sda3 17381728 17107080 274648 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000891
Denis Vlasenko736230e2006-11-20 19:40:36 +0000892#define dhcprelay_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100893 "CLIENT_IFACE[,CLIENT_IFACE2]... SERVER_IFACE [SERVER_IP]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000894#define dhcprelay_full_usage "\n\n" \
Denis Vlasenkoe8a79682009-04-13 03:33:46 +0000895 "Relay DHCP requests between clients and server" \
Denis Vlasenko736230e2006-11-20 19:40:36 +0000896
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000897#define diff_trivial_usage \
Matheus Izvekovfe1ce2e2010-01-18 16:07:07 -0200898 "[-abBdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000899#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000900 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000901 "This implementation supports unified diffs only.\n" \
902 "\nOptions:" \
903 "\n -a Treat all files as text" \
904 "\n -b Ignore changes in the amount of whitespace" \
Matheus Izvekovfe1ce2e2010-01-18 16:07:07 -0200905 "\n -B Ignore changes whose lines are all blank" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000906 "\n -d Try hard to find a smaller set of changes" \
907 "\n -i Ignore case differences" \
908 "\n -L Use LABEL instead of the filename in the unified header" \
909 "\n -N Treat absent files as empty" \
910 "\n -q Output only whether files differ" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100911 "\n -r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000912 "\n -S Start with FILE when comparing directories" \
913 "\n -T Make tabs line up by prefixing a tab when necessary" \
914 "\n -s Report when two files are the same" \
915 "\n -t Expand tabs to spaces in output" \
916 "\n -U Output LINES lines of context" \
917 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000918
Eric Andersen7e9276b2001-02-22 01:15:47 +0000919#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000920 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000921#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000922 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000923#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000924 "$ dirname /tmp/foo\n" \
925 "/tmp\n" \
926 "$ dirname /tmp/foo/\n" \
927 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000928
Eric Andersen7e9276b2001-02-22 01:15:47 +0000929#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000930 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000931#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000932 "Print or control the kernel ring buffer\n" \
933 "\nOptions:" \
934 "\n -c Clear ring buffer after printing" \
935 "\n -n LEVEL Set console logging level" \
936 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000937
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000938#define dnsd_trivial_usage \
Denys Vlasenko343dfd72010-02-07 02:45:03 +0100939 "[-dvs] [-c CONFFILE] [-t TTL_SEC] [-p PORT] [-i ADDR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000940#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000941 "Small static DNS server daemon\n" \
942 "\nOptions:" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +0100943 "\n -c FILE Config file" \
944 "\n -t SEC TTL" \
945 "\n -p PORT Listen on PORT" \
946 "\n -i ADDR Listen on ADDR" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000947 "\n -d Daemonize" \
Denys Vlasenko343dfd72010-02-07 02:45:03 +0100948 "\n -v Verbose" \
949 "\n -s Send successful replies only. Use this if you want" \
950 "\n to use /etc/resolv.conf with two nameserver lines:" \
951 "\n nameserver DNSD_SERVER" \
952 "\n nameserver NORNAL_DNS_SERVER" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000953
Eric Andersen7e9276b2001-02-22 01:15:47 +0000954#define dos2unix_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +0200955 "[OPTIONS] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000956#define dos2unix_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200957 "Convert FILE in-place from DOS to Unix format.\n" \
958 "When no file is given, use stdin/stdout.\n" \
959 "\nOptions:" \
960 "\n -u dos2unix" \
961 "\n -d unix2dos" \
962
963#define unix2dos_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +0200964 "[OPTIONS] [FILE]"
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200965#define unix2dos_full_usage "\n\n" \
966 "Convert FILE in-place from Unix to DOS format.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000967 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000968 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000969 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000970 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000971
Eric Andersen7e9276b2001-02-22 01:15:47 +0000972#define dpkg_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100973 "[-ilCPru] [-F OPT] PACKAGE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000974#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000975 "Install, remove and manage Debian packages\n" \
976 "\nOptions:" \
Kim B. Heino3d43aed2010-03-29 14:18:27 +0200977 IF_LONG_OPTS( \
978 "\n -i,--install Install the package" \
979 "\n -l,--list List of installed packages" \
980 "\n --configure Configure an unpackaged package" \
981 "\n -P,--purge Purge all files of a package" \
982 "\n -r,--remove Remove all but the configuration files for a package" \
983 "\n --unpack Unpack a package, but don't configure it" \
984 "\n --force-depends Ignore dependency problems" \
985 "\n --force-confnew Overwrite existing config files when installing" \
986 "\n --force-confold Keep old config files when installing" \
987 ) \
988 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000989 "\n -i Install the package" \
990 "\n -l List of installed packages" \
991 "\n -C Configure an unpackaged package" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000992 "\n -P Purge all files of a package" \
993 "\n -r Remove all but the configuration files for a package" \
994 "\n -u Unpack a package, but don't configure it" \
Kim B. Heino3d43aed2010-03-29 14:18:27 +0200995 "\n -F depends Ignore dependency problems" \
996 "\n -F confnew Overwrite existing config files when installing" \
997 "\n -F confold Keep old config files when installing" \
998 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000999
Eric Andersen7e9276b2001-02-22 01:15:47 +00001000#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001001 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001002#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001003 "Perform actions on Debian packages (.debs)\n" \
1004 "\nOptions:" \
1005 "\n -c List contents of filesystem tree" \
1006 "\n -e Extract control files to [argument] directory" \
1007 "\n -f Display control field name starting with [argument]" \
1008 "\n -x Extract packages filesystem tree to directory" \
1009 "\n -X Verbose extract" \
1010
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001011#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001012 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001013
Eric Andersen7e9276b2001-02-22 01:15:47 +00001014#define du_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001015 "[-aHLdclsx" IF_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001016#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001017 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001018 "Disk space is printed in units of " \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001019 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
1020 IF_NOT_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001021 " bytes.\n" \
1022 "\nOptions:" \
1023 "\n -a Show file sizes too" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001024 "\n -L Follow all symlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001025 "\n -H Follow symlinks on command line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001026 "\n -d N Limit output to directories (and files with -a) of depth < N" \
1027 "\n -c Show grand total" \
1028 "\n -l Count sizes many times if hard linked" \
1029 "\n -s Display only a total for each argument" \
1030 "\n -x Skip directories on different filesystems" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001031 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001032 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
1033 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001034 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001035 "\n -k Sizes in kilobytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001036 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001037
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001038#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001039 "$ du\n" \
1040 "16 ./CVS\n" \
1041 "12 ./kernel-patches/CVS\n" \
1042 "80 ./kernel-patches\n" \
1043 "12 ./tests/CVS\n" \
1044 "36 ./tests\n" \
1045 "12 ./scripts/CVS\n" \
1046 "16 ./scripts\n" \
1047 "12 ./docs/CVS\n" \
1048 "104 ./docs\n" \
1049 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001050
Eric Andersen7e9276b2001-02-22 01:15:47 +00001051#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001052 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001053#define dumpkmap_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001054 "Print a binary keyboard translation table to stdout"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001055#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001056 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001057
Russ Dill61fb4892002-10-14 21:41:28 +00001058#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001059 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001060#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001061 "Display DHCP leases granted by udhcpd\n" \
1062 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001063 IF_LONG_OPTS( \
Denys Vlasenkoc8a2ab12010-03-28 00:02:20 +01001064 "\n -f,--file=FILE Lease file" \
1065 "\n -r,--remaining Show remaining time" \
1066 "\n -a,--absolute Show expiration time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001067 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001068 IF_NOT_LONG_OPTS( \
Denys Vlasenkoc8a2ab12010-03-28 00:02:20 +01001069 "\n -f FILE Lease file" \
1070 "\n -r Show remaining time" \
1071 "\n -a Show expiration time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001072 )
Russ Dill61fb4892002-10-14 21:41:28 +00001073
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001074/*
Mike Frysinger51a43b42005-09-24 07:11:16 +00001075#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001076 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
1077 "[-I inode_buffer_blocks] [-P process_inode_size] " \
1078 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
1079 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001080#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001081 "Check ext2/ext3 file system\n" \
1082 "\nOptions:" \
1083 "\n -p Automatic repair (no questions)" \
1084 "\n -n Make no changes to the filesystem" \
1085 "\n -y Assume 'yes' to all questions" \
1086 "\n -c Check for bad blocks and add them to the badblock list" \
1087 "\n -f Force checking even if filesystem is marked clean" \
1088 "\n -v Verbose" \
1089 "\n -b superblock Use alternative superblock" \
1090 "\n -B blocksize Force blocksize when looking for superblock" \
1091 "\n -j journal Set location of the external journal" \
1092 "\n -l file Add to badblocks list" \
1093 "\n -L file Set badblocks list" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001094*/
Mike Frysinger51a43b42005-09-24 07:11:16 +00001095
Eric Andersen7e9276b2001-02-22 01:15:47 +00001096#define echo_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001097 IF_FEATURE_FANCY_ECHO("[-neE] ") "[ARG]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001098#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001099 "Print the specified ARGs to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001100 IF_FEATURE_FANCY_ECHO( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001101 "\nOptions:" \
1102 "\n -n Suppress trailing newline" \
Denys Vlasenkoc8a2ab12010-03-28 00:02:20 +01001103 "\n -e Interpret backslash escapes (i.e., \\t=tab)" \
1104 "\n -E Don't interpret backslash escapes (default)" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001105 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001106#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001107 "$ echo \"Erik is cool\"\n" \
1108 "Erik is cool\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001109 IF_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001110 "Erik\n" \
1111 "is\n" \
1112 "cool\n" \
1113 "$ echo \"Erik\\nis\\ncool\"\n" \
1114 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001115
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001116#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001117 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001118#define eject_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001119 "Eject DEVICE or default /dev/cdrom\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001120 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001121 IF_FEATURE_EJECT_SCSI( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001122 "\n -s SCSI device" \
1123 ) \
1124 "\n -t Close tray" \
1125 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001126
Rob Landley3b890392006-05-04 20:56:43 +00001127#define ed_trivial_usage ""
1128#define ed_full_usage ""
1129
Eric Andersen84e229c2001-03-29 22:48:33 +00001130#define env_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001131 "[-iu] [-] [name=value]... [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001132#define env_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001133 "Print the current environment or run PROG after setting up\n" \
1134 "the specified environment\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001135 "\nOptions:" \
1136 "\n -, -i Start with an empty environment" \
1137 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +00001138
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001139#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001140 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001141#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001142 "Send a magic packet to wake up sleeping machines.\n" \
1143 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001144 "a hostname with a known 'ethers' entry.\n" \
1145 "\nOptions:" \
1146 "\n -b Send wake-up packet to the broadcast address" \
1147 "\n -i iface Interface to use (default eth0)" \
1148 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001149
Denis Vlasenko3952f202007-08-13 14:10:24 +00001150#define expand_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01001151 "[-i] [-t N] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001152#define expand_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001153 "Convert tabs to spaces, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001154 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001155 IF_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001156 "\n -i,--initial Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001157 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001158 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001159 IF_NOT_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001160 "\n -i Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001161 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001162 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00001163
Eric Andersen7e9276b2001-02-22 01:15:47 +00001164#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001165 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001166#define expr_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001167 "Print the value of EXPRESSION to stdout\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001168 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001169 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001170 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
1171 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1172 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1173 " ARG1 <= ARG2\n" \
1174 " ARG1 = ARG2\n" \
1175 " ARG1 != ARG2\n" \
1176 " ARG1 >= ARG2\n" \
1177 " ARG1 > ARG2\n" \
1178 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1179 " ARG1 - ARG2\n" \
1180 " ARG1 * ARG2\n" \
1181 " ARG1 / ARG2\n" \
1182 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001183 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1184 " match STRING REGEXP Same as STRING : REGEXP\n" \
1185 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1186 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1187 " length STRING Length of STRING\n" \
1188 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001189 " it is a keyword like 'match' or an\n" \
1190 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001191 " (EXPRESSION) Value of EXPRESSION\n" \
1192 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001193 "Beware that many operators need to be escaped or quoted for shells.\n" \
1194 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001195 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001196 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1197 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001198
Mike Frysingerfa69f112005-04-17 07:24:19 +00001199#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001200 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001201#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001202 "Provide fake ident (auth) service\n" \
1203 "\nOptions:" \
1204 "\n -f Run in foreground" \
1205 "\n -i Inetd mode" \
1206 "\n -w Inetd 'wait' mode" \
1207 "\n -b ADDR Bind to specified address" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001208 "\n STRING Ident answer string (default: nobody)" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001209
Eric Andersen7e9276b2001-02-22 01:15:47 +00001210#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001211 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001212#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001213 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001214
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001215#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001216 "$ false\n" \
1217 "$ echo $?\n" \
1218 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001219
Denys Vlasenkoff027d62010-05-04 15:45:25 +02001220#define fbsplash_trivial_usage \
1221 "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
1222#define fbsplash_full_usage "\n\n" \
1223 "Options:" \
1224 "\n -s Image" \
1225 "\n -c Hide cursor" \
1226 "\n -d Framebuffer device (default /dev/fb0)" \
1227 "\n -i Config file (var=value):" \
1228 "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT" \
1229 "\n BAR_R,BAR_G,BAR_B" \
1230 "\n -f Control pipe (else exit after drawing image)" \
1231 "\n commands: 'NN' (% for progress bar) or 'exit'" \
1232
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001233#define fbset_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001234 "[OPTIONS] [MODE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001235#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001236 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001237
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001238#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001239 "$ fbset\n" \
1240 "mode \"1024x768-76\"\n" \
1241 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1242 " geometry 1024 768 1024 768 16\n" \
1243 " timings 12714 128 32 16 4 128 4\n" \
1244 " accel false\n" \
1245 " rgba 5/11,6/5,5/0,0/0\n" \
1246 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001247
Eric Andersen7e9276b2001-02-22 01:15:47 +00001248#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001249 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001250#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001251 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001252
Eric Andersen01c3d402003-07-05 07:51:31 +00001253#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001254 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001255#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001256 "Format floppy disk\n" \
1257 "\nOptions:" \
1258 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001259
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001260/* Looks like someone forgot to add this to config system */
1261#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1262# define ENABLE_FEATURE_FDISK_BLKSIZE 0
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001263# define IF_FEATURE_FDISK_BLKSIZE(a)
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001264#endif
1265
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001266#define fdisk_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001267 "[-ul" IF_FEATURE_FDISK_BLKSIZE("s") "] " \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001268 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001269#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001270 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001271 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001272 "\n -u Start and End are in sectors (instead of cylinders)" \
1273 "\n -l Show partition table for each DISK, then exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001274 IF_FEATURE_FDISK_BLKSIZE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001275 "\n -s Show partition sizes in kb for each DISK, then exit" \
1276 ) \
1277 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1278 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
Denys Vlasenko37bc1eb2010-04-06 00:04:08 +02001279 "\n -H HEADS" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001280 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001281
Grigory Batalovad7a5d42010-05-23 23:22:10 +02001282#define fgconsole_trivial_usage \
1283 ""
1284#define fgconsole_full_usage "\n\n" \
1285 "Get active console"
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001286
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001287#define findfs_trivial_usage \
1288 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001289#define findfs_full_usage "\n\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02001290 "Find a filesystem device based on a label or UUID"
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001291#define findfs_example_usage \
1292 "$ findfs LABEL=MyDevice"
1293
Eric Andersen7e9276b2001-02-22 01:15:47 +00001294#define find_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001295 "[PATH]... [EXPRESSION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001296#define find_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001297 "Search for files. The default PATH is the current directory,\n" \
1298 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001299 "\nEXPRESSION may consist of:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001300 "\n -follow Follow symlinks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001301 IF_FEATURE_FIND_XDEV( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001302 "\n -xdev Don't descend directories on other filesystems") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001303 IF_FEATURE_FIND_MAXDEPTH( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001304 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1305 "\n tests/actions to command line arguments only") \
Denys Vlasenko07697852009-10-06 21:11:37 +02001306 "\n -mindepth N Don't act on first N levels" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001307 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001308 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001309 IF_FEATURE_FIND_PATH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001310 "\n -path PATTERN Path matches PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001311 IF_FEATURE_FIND_REGEX( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001312 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001313 IF_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001314 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001315 IF_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001316 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001317 "\n or exactly NNN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001318 IF_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001319 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001320 "\n or exactly N days") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001321 IF_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001322 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001323 "\n or exactly N minutes") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001324 IF_FEATURE_FIND_NEWER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001325 "\n -newer FILE Modified time is more recent than FILE's") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001326 IF_FEATURE_FIND_INUM( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001327 "\n -inum N File has inode number N") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001328 IF_FEATURE_FIND_USER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001329 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001330 IF_FEATURE_FIND_GROUP( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001331 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001332 IF_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001333 "\n -depth Process directory name after traversing it") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001334 IF_FEATURE_FIND_SIZE( \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001335 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001336 "\n +/-N: file size is bigger/smaller than N") \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001337 IF_FEATURE_FIND_LINKS( \
1338 "\n -links N Number of links is greater than (+N), less than (-N)," \
1339 "\n or exactly N") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001340 "\n -print Print (default and assumed)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001341 IF_FEATURE_FIND_PRINT0( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001342 "\n -print0 Delimit output with null characters rather than" \
1343 "\n newlines") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001344 IF_FEATURE_FIND_CONTEXT ( \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001345 "\n -context File has specified security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001346 IF_FEATURE_FIND_EXEC( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001347 "\n -exec CMD ARG ; Run CMD with all instances of {} replaced by the" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001348 "\n matching files") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001349 IF_FEATURE_FIND_PRUNE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001350 "\n -prune Stop traversing current subtree") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001351 IF_FEATURE_FIND_DELETE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001352 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001353 IF_FEATURE_FIND_PAREN( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001354 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001355
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001356#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001357 "$ find / -name passwd\n" \
1358 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001359
Denys Vlasenkobf2af9a2009-05-25 04:15:37 +02001360#define flash_lock_trivial_usage \
1361 "MTD_DEVICE OFFSET SECTORS"
1362#define flash_lock_full_usage "\n\n" \
1363 "Lock part or all of an MTD device. If SECTORS is -1, then all sectors\n" \
1364 "will be locked, regardless of the value of OFFSET"
1365
1366#define flash_unlock_trivial_usage \
1367 "MTD_DEVICE"
1368#define flash_unlock_full_usage "\n\n" \
1369 "Unlock an MTD device"
1370
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001371#define flash_eraseall_trivial_usage \
1372 "[-jq] MTD_DEVICE"
1373#define flash_eraseall_full_usage "\n\n" \
1374 "Erase an MTD device\n" \
1375 "\nOptions:" \
Stefan Seyfriedd095fd42009-11-21 18:32:19 +01001376 "\n -j Format the device for jffs2" \
1377 "\n -q Don't display progress messages" \
1378
1379#define flashcp_trivial_usage \
1380 "-v FILE MTD_DEVICE"
1381#define flashcp_full_usage "\n\n" \
1382 "Copy an image to MTD device\n" \
1383 "\nOptions:" \
1384 "\n -v Verbose" \
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001385
Timo Teras892d4b62010-03-18 22:45:35 +01001386#define flock_trivial_usage \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001387 "[-sxun] FD|{FILE [-c] PROG ARGS}"
Timo Teras892d4b62010-03-18 22:45:35 +01001388#define flock_full_usage "\n\n" \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001389 "[Un]lock file descriptor, or lock FILE and run PROG\n" \
Timo Teras892d4b62010-03-18 22:45:35 +01001390 "\nOptions:" \
1391 "\n -s Shared lock" \
1392 "\n -x Exclusive lock (default)" \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001393 "\n -u Unlock FD" \
Timo Teras892d4b62010-03-18 22:45:35 +01001394 "\n -n Fail rather than wait" \
1395
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001396#define fold_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001397 "[-bs] [-w WIDTH] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001398#define fold_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001399 "Wrap input lines in each FILE (or stdin), writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001400 "\nOptions:" \
1401 "\n -b Count bytes rather than columns" \
1402 "\n -s Break at spaces" \
1403 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001404
Eric Andersen7e9276b2001-02-22 01:15:47 +00001405#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001406 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001407#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001408 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001409#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001410 "$ free\n" \
1411 " total used free shared buffers\n" \
1412 " Mem: 257628 248724 8904 59644 93124\n" \
1413 " Swap: 128516 8404 120112\n" \
1414 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001415
Eric Andersen7e9276b2001-02-22 01:15:47 +00001416#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001417 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001418#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001419 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001420#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001421 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001422
Mike Frysinger51a43b42005-09-24 07:11:16 +00001423#define fsck_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001424 "[-ANPRTV] [-C FD] [-t FSTYPE] [FS_OPTS] [BLOCKDEV]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001425#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001426 "Check and repair filesystems\n" \
1427 "\nOptions:" \
1428 "\n -A Walk /etc/fstab and check all filesystems" \
1429 "\n -N Don't execute, just show what would be done" \
1430 "\n -P With -A, check filesystems in parallel" \
1431 "\n -R With -A, skip the root filesystem" \
1432 "\n -T Don't show title on startup" \
1433 "\n -V Verbose" \
1434 "\n -C n Write status information to specified filedescriptor" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001435 "\n -t TYPE List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001436
Eric Andersen7e9276b2001-02-22 01:15:47 +00001437#define fsck_minix_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001438 "[-larvsmf] BLOCKDEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001439#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001440 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001441 "\nOptions:" \
1442 "\n -l List all filenames" \
1443 "\n -r Perform interactive repairs" \
1444 "\n -a Perform automatic repairs" \
1445 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001446 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001447 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001448 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001449
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001450#define ftpd_trivial_usage \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001451 "[-wvS] [-t N] [-T N] [DIR]"
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001452#define ftpd_full_usage "\n\n" \
Denys Vlasenkoae357bd2009-09-11 23:29:45 +02001453 "Anonymous FTP server\n" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001454 "\n" \
1455 "ftpd should be used as an inetd service.\n" \
1456 "ftpd's line for inetd.conf:\n" \
1457 " 21 stream tcp nowait root ftpd ftpd /files/to/serve\n" \
1458 "It also can be ran from tcpsvd:\n" \
1459 " tcpsvd -vE 0.0.0.0 21 ftpd /files/to/serve\n" \
1460 "\nOptions:" \
1461 "\n -w Allow upload" \
Denis Vlasenko4221e902009-03-11 15:07:44 +00001462 "\n -v Log to stderr" \
1463 "\n -S Log to syslog" \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001464 "\n -t,-T Idle and absolute timeouts" \
Denis Vlasenko92576712009-03-09 16:25:33 +00001465 "\n DIR Change root to this directory" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001466
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001467#define ftpget_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001468 "[OPTIONS] HOST [LOCAL_FILE] REMOTE_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001469#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001470 "Retrieve a remote file via FTP\n" \
1471 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001472 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001473 "\n -c,--continue Continue previous transfer" \
1474 "\n -v,--verbose Verbose" \
1475 "\n -u,--username Username" \
1476 "\n -p,--password Password" \
1477 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001478 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001479 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001480 "\n -c Continue previous transfer" \
1481 "\n -v Verbose" \
1482 "\n -u Username" \
1483 "\n -p Password" \
1484 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001485 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001486
1487#define ftpput_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001488 "[OPTIONS] HOST [REMOTE_FILE] LOCAL_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001489#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001490 "Store a local file on a remote machine via FTP\n" \
1491 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001492 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001493 "\n -v,--verbose Verbose" \
1494 "\n -u,--username Username" \
1495 "\n -p,--password Password" \
1496 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001497 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001498 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001499 "\n -v Verbose" \
1500 "\n -u Username" \
1501 "\n -p Password" \
1502 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001503 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001504
Rob Landleyaa872762005-10-28 13:05:12 +00001505#define fuser_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001506 "[OPTIONS] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001507#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001508 "Find processes which use FILEs or PORTs\n" \
1509 "\nOptions:" \
1510 "\n -m Find processes which use same fs as FILEs" \
1511 "\n -4 Search only IPv4 space" \
1512 "\n -6 Search only IPv6 space" \
Maksym Kryzhanovskyyfef9ee72010-05-22 20:41:08 +02001513 "\n -s Don't display PIDs" \
1514 "\n -k Kill found processes" \
1515 "\n -SIGNAL Signal to send (default: KILL)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001516
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001517#define getenforce_trivial_usage NOUSAGE_STR
1518#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001519
Eric Andersen7e9276b2001-02-22 01:15:47 +00001520#define getopt_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001521 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001522#define getopt_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001523 "Options:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001524 IF_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001525 "\n -a,--alternative Allow long options starting with single -" \
1526 "\n -l,--longoptions=longopts Long options to be recognized" \
1527 "\n -n,--name=progname The name under which errors are reported" \
1528 "\n -o,--options=optstring Short options to be recognized" \
1529 "\n -q,--quiet Disable error reporting by getopt(3)" \
1530 "\n -Q,--quiet-output No normal output" \
1531 "\n -s,--shell=shell Set shell quoting conventions" \
1532 "\n -T,--test Test for getopt(1) version" \
1533 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001534 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001535 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001536 "\n -a Allow long options starting with single -" \
1537 "\n -l longopts Long options to be recognized" \
1538 "\n -n progname The name under which errors are reported" \
1539 "\n -o optstring Short options to be recognized" \
1540 "\n -q Disable error reporting by getopt(3)" \
1541 "\n -Q No normal output" \
1542 "\n -s shell Set shell quoting conventions" \
1543 "\n -T Test for getopt(1) version" \
1544 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001545 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001546#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001547 "$ cat getopt.test\n" \
1548 "#!/bin/sh\n" \
1549 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1550 " -n 'example.busybox' -- \"$@\"`\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001551 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001552 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001553 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001554 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001555 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1556 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001557 " -c|--c-long)\n" \
1558 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001559 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1560 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1561 " esac;;\n" \
1562 " --) shift; break;;\n" \
1563 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001564 " esac\n" \
1565 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001566
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001567#define getsebool_trivial_usage \
1568 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001569#define getsebool_full_usage "\n\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01001570 " -a Show all selinux booleans"
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001571
Eric Andersenf349e972001-08-21 16:18:59 +00001572#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001573 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001574#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001575 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1576 "\nOptions:" \
1577 "\n -h Enable hardware (RTS/CTS) flow control" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001578 "\n -i Don't display /etc/issue before running login" \
1579 "\n -L Local line, don't do carrier detect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001580 "\n -m Get baud rate from modem's CONNECT status message" \
1581 "\n -w Wait for a CR or LF before sending /etc/issue" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001582 "\n -n Don't prompt the user for a login name" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02001583 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
1584 "\n -l LOGIN Invoke LOGIN instead of /bin/login" \
1585 "\n -t SEC Terminate after SEC if no username is read" \
1586 "\n -I INITSTR Send INITSTR before anything else" \
1587 "\n -H HOST Log HOST into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001588
Eric Andersen7e9276b2001-02-22 01:15:47 +00001589#define grep_trivial_usage \
Denys Vlasenko05273da2010-04-26 08:45:44 +02001590 "[-HhnlLoqvsriw" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001591 "F" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001592 IF_FEATURE_GREP_EGREP_ALIAS("E") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001593 IF_EXTRA_COMPAT("z") \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001594 "] [-m N] " \
1595 IF_FEATURE_GREP_CONTEXT("[-A/B/C N] ") \
1596 "PATTERN/-e PATTERN.../-f FILE [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001597#define grep_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001598 "Search for PATTERN in FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001599 "\nOptions:" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001600 "\n -H Add 'filename:' prefix" \
1601 "\n -h Do not add 'filename:' prefix" \
1602 "\n -n Add 'line_no:' prefix" \
1603 "\n -l Show only names of files that match" \
1604 "\n -L Show only names of files that don't match" \
1605 "\n -c Show only count of matching lines" \
1606 "\n -o Show only the matching part of line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001607 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1608 "\n -v Select non-matching lines" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001609 "\n -s Suppress open and read errors" \
1610 "\n -r Recurse" \
1611 "\n -i Ignore case" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001612 "\n -w Match whole words only" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001613 "\n -F PATTERN is a literal (not regexp)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001614 IF_FEATURE_GREP_EGREP_ALIAS( \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001615 "\n -E PATTERN is an extended regexp" \
1616 ) \
1617 IF_EXTRA_COMPAT( \
1618 "\n -z Input is NUL terminated" \
1619 ) \
1620 "\n -m N Match up to N times per file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001621 IF_FEATURE_GREP_CONTEXT( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001622 "\n -A N Print N lines of trailing context" \
1623 "\n -B N Print N lines of leading context" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001624 "\n -C N Same as '-A N -B N'" \
1625 ) \
1626 "\n -e PTRN Pattern to match" \
1627 "\n -f FILE Read pattern from file" \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001628
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001629#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001630 "$ grep root /etc/passwd\n" \
1631 "root:x:0:0:root:/root:/bin/bash\n" \
1632 "$ grep ^[rR]oo. /etc/passwd\n" \
1633 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001634
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001635#define egrep_trivial_usage NOUSAGE_STR
1636#define egrep_full_usage ""
1637
1638#define fgrep_trivial_usage NOUSAGE_STR
1639#define fgrep_full_usage ""
1640
Eric Andersen7e9276b2001-02-22 01:15:47 +00001641#define gunzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001642 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001643#define gunzip_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02001644 "Decompress FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001645 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001646 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001647 "\n -f Force" \
1648 "\n -t Test file integrity" \
1649
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001650#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001651 "$ ls -la /tmp/BusyBox*\n" \
1652 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1653 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1654 "$ ls -la /tmp/BusyBox*\n" \
1655 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001656
1657#define gzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001658 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001659#define gzip_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001660 "Compress FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001661 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001662 "\n -d Decompress" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02001663 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001664 "\n -f Force" \
1665
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001666#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001667 "$ ls -la /tmp/busybox*\n" \
1668 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1669 "$ gzip /tmp/busybox.tar\n" \
1670 "$ ls -la /tmp/busybox*\n" \
1671 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001672
1673#define halt_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001674 "[-d DELAY] [-n] [-f]" IF_FEATURE_WTMP(" [-w]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001675#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001676 "Halt the system\n" \
1677 "\nOptions:" \
1678 "\n -d Delay interval for halting" \
1679 "\n -n No call to sync()" \
1680 "\n -f Force halt (don't go through init)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001681 IF_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001682 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001683 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001684
Eric Andersen3443bd72003-07-22 07:30:36 +00001685#define hdparm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001686 "[OPTIONS] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001687#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001688 "Options:" \
1689 "\n -a Get/set fs readahead" \
1690 "\n -A Set drive read-lookahead flag (0/1)" \
1691 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1692 "\n -B Set Advanced Power Management setting (1-255)" \
1693 "\n -c Get/set IDE 32-bit IO setting" \
1694 "\n -C Check IDE power mode status" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001695 IF_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001696 "\n -d Get/set using_dma flag") \
1697 "\n -D Enable/disable drive defect-mgmt" \
1698 "\n -f Flush buffer cache for device on exit" \
1699 "\n -g Display drive geometry" \
1700 "\n -h Display terse usage information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001701 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001702 "\n -i Display drive identification") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001703 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001704 "\n -I Detailed/current information directly from drive") \
1705 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1706 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1707 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1708 "\n -m Get/set multiple sector count" \
1709 "\n -n Get/set ignore-write-errors flag (0/1)" \
1710 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1711 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001712/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001713 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1714 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001715 IF_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001716 "\n -R Register an IDE interface (DANGEROUS)") \
1717 "\n -S Set standby (spindown) timeout" \
1718 "\n -t Perform device read timings" \
1719 "\n -T Perform cache read timings" \
1720 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001721 IF_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001722 "\n -U Unregister an IDE interface (DANGEROUS)") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001723 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1724 "\n -V Display program version and exit immediately" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001725 IF_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001726 "\n -w Perform device reset (DANGEROUS)") \
1727 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001728 IF_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001729 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1730 "\n -X Set IDE xfer mode (DANGEROUS)" \
1731 "\n -y Put IDE drive in standby mode" \
1732 "\n -Y Put IDE drive to sleep" \
1733 "\n -Z Disable Seagate auto-powersaving mode" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001734 "\n -z Reread partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001735
Eric Andersen7e9276b2001-02-22 01:15:47 +00001736#define head_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001737 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001738#define head_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001739 "Print first 10 lines of each FILE (or stdin) to stdout.\n" \
Denys Vlasenko57493282010-03-02 16:18:14 +01001740 "With more than one FILE, precede each with a filename header.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001741 "\nOptions:" \
Denys Vlasenko57493282010-03-02 16:18:14 +01001742 "\n -n N[kbm] Print first N lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001743 IF_FEATURE_FANCY_HEAD( \
Denys Vlasenko57493282010-03-02 16:18:14 +01001744 "\n -c N[kbm] Print first N bytes" \
1745 "\n -q Never print headers" \
1746 "\n -v Always print headers" \
1747 ) \
1748 "\n" \
1749 "\nN may be suffixed by k (x1024), b (x512), or m (x1024^2)." \
Denis Vlasenko397de612008-03-17 08:55:44 +00001750
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001751#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001752 "$ head -n 2 /etc/passwd\n" \
1753 "root:x:0:0:root:/root:/bin/bash\n" \
1754 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001755
Denys Vlasenko57493282010-03-02 16:18:14 +01001756#define tail_trivial_usage \
1757 "[OPTIONS] [FILE]..."
1758#define tail_full_usage "\n\n" \
1759 "Print last 10 lines of each FILE (or stdin) to stdout.\n" \
1760 "With more than one FILE, precede each with a filename header.\n" \
1761 "\nOptions:" \
1762 "\n -f Print data as file grows" \
1763 IF_FEATURE_FANCY_TAIL( \
1764 "\n -s SECONDS Wait SECONDS between reads with -f" \
1765 ) \
1766 "\n -n N[kbm] Print last N lines" \
1767 IF_FEATURE_FANCY_TAIL( \
1768 "\n -c N[kbm] Print last N bytes" \
1769 "\n -q Never print headers" \
1770 "\n -v Always print headers" \
1771 "\n" \
1772 "\nN may be suffixed by k (x1024), b (x512), or m (x1024^2)." \
1773 "\nIf N starts with a '+', output begins with the Nth item from the start" \
1774 "\nof each file, not from the end." \
1775 ) \
1776
1777#define tail_example_usage \
1778 "$ tail -n 1 /etc/resolv.conf\n" \
1779 "nameserver 10.0.0.1\n"
1780
Glenn L McGrath60281112001-11-02 11:39:46 +00001781#define hexdump_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001782 "[-bcCdefnosvx" IF_FEATURE_HEXDUMP_REVERSE("R") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001783#define hexdump_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001784 "Display FILEs (or stdin) in a user specified format\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001785 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001786 "\n -b One-byte octal display" \
1787 "\n -c One-byte character display" \
1788 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1789 "\n -d Two-byte decimal display" \
1790 "\n -e FORMAT STRING" \
1791 "\n -f FORMAT FILE" \
1792 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1793 "\n -o Two-byte octal display" \
1794 "\n -s OFFSET Skip OFFSET bytes" \
1795 "\n -v Display all input data" \
1796 "\n -x Two-byte hexadecimal display" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001797 IF_FEATURE_HEXDUMP_REVERSE( \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001798 "\n -R Reverse of 'hexdump -Cv'") \
1799
1800#define hd_trivial_usage \
1801 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001802#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001803 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001804
Eric Andersen7e9276b2001-02-22 01:15:47 +00001805#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001806 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001807#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001808 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001809
1810#define hostname_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001811 "[OPTIONS] [HOSTNAME | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001812#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001813 "Get or set hostname or DNS domain name\n" \
1814 "\nOptions:" \
1815 "\n -s Short" \
1816 "\n -i Addresses for the hostname" \
1817 "\n -d DNS domain name" \
1818 "\n -f Fully qualified domain name" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001819 "\n -F FILE Use FILE's content as hostname" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001820
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001821#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001822 "$ hostname\n" \
1823 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001824
Denys Vlasenkod30b89c2009-06-26 01:55:45 +02001825#define dnsdomainname_trivial_usage NOUSAGE_STR
1826#define dnsdomainname_full_usage ""
1827
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001828#define httpd_trivial_usage \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001829 "[-ifv[v]]" \
1830 " [-c CONFFILE]" \
1831 " [-p [IP:]PORT]" \
1832 IF_FEATURE_HTTPD_SETUID(" [-u USER[:GRP]]") \
1833 IF_FEATURE_HTTPD_BASIC_AUTH(" [-r REALM]") \
1834 " [-h HOME]\n" \
1835 "or httpd -d/-e" IF_FEATURE_HTTPD_AUTH_MD5("/-m") " STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001836#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001837 "Listen for incoming HTTP requests\n" \
1838 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001839 "\n -i Inetd mode" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001840 "\n -f Don't daemonize" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001841 "\n -v[v] Verbose" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001842 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001843 IF_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001844 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001845 IF_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001846 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001847 "\n -h HOME Home directory (default .)" \
Denys Vlasenko8fc9e6a2010-04-02 10:40:58 +02001848 "\n -c FILE Configuration file (default {/etc,HOME}/httpd.conf)" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001849 IF_FEATURE_HTTPD_AUTH_MD5( \
1850 "\n -m STRING MD5 crypt STRING") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001851 "\n -e STRING HTML encode STRING" \
1852 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001853
Robert Griebl1cd04452002-07-21 16:50:49 +00001854#define hwclock_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001855 IF_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001856 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1857 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001858 " [-f FILE]" \
1859 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001860 IF_NOT_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001861 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1862 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001863#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001864 "Query and set hardware clock (RTC)\n" \
1865 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001866 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001867 "\n -s Set system time from hardware clock" \
1868 "\n -w Set hardware clock to system time" \
1869 "\n -u Hardware clock is in UTC" \
1870 "\n -l Hardware clock is in local time" \
1871 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001872
Eric Andersen7e9276b2001-02-22 01:15:47 +00001873#define id_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001874 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001875#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001876 "Print information about USER or the current user\n" \
1877 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001878 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001879 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001880 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001881 "\n -u Print user ID" \
Denis Vlasenko4f3209b2008-09-13 12:51:10 +00001882 "\n -g Print group ID" \
1883 "\n -G Print supplementary group IDs" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001884 "\n -n Print name instead of a number" \
1885 "\n -r Print real user ID instead of effective ID" \
1886
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001887#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001888 "$ id\n" \
1889 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001890
Eric Andersen7e9276b2001-02-22 01:15:47 +00001891#define ifconfig_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001892 IF_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001893#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001894 "Configure a network interface\n" \
1895 "\nOptions:" \
1896 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001897 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001898 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001899 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001900 " [del ADDRESS[/PREFIXLEN]]\n") \
1901 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1902 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001903 IF_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001904 " [outfill NN] [keepalive NN]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001905 " " IF_FEATURE_IFCONFIG_HW("[hw ether" IF_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001906 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001907 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001908 IF_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001909 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001910 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001911
Denis Vlasenko06aed432008-02-26 18:25:24 +00001912#define ifenslave_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001913 "[-cdf] MASTER_IFACE SLAVE_IFACE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001914#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001915 "Configure network interfaces for parallel routing\n" \
1916 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001917 "\n -c, --change-active Change active slave" \
1918 "\n -d, --detach Remove slave interface from bonding device" \
1919 "\n -f, --force Force, even if interface is not Ethernet" \
1920/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001921
Denis Vlasenko06aed432008-02-26 18:25:24 +00001922#define ifenslave_example_usage \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001923 "To create a bond device, simply follow these three steps:\n" \
1924 "- ensure that the required drivers are properly loaded:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001925 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001926 "- assign an IP address to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001927 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001928 "- attach all the interfaces you need to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001929 " # ifenslave bond0 eth0 eth1 eth2\n" \
1930 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1931 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001932 " To detach a dead interface without setting the bond device down:\n" \
1933 " # ifenslave -d bond0 eth1\n\n" \
1934 " To set the bond device down and automatically release all the slaves:\n" \
1935 " # ifconfig bond0 down\n\n" \
1936 " To change active slave:\n" \
1937 " # ifenslave -c bond0 eth0\n" \
1938
1939#define ifplugd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001940 "[OPTIONS]"
Denis Vlasenko71c16572009-04-26 01:08:51 +00001941#define ifplugd_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +02001942 "Network interface plug detection daemon\n" \
1943 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001944 "\n -n Don't daemonize" \
1945 "\n -s Don't log to syslog" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001946 "\n -i IFACE Interface" \
1947 "\n -f/-F Treat link detection error as link down/link up" \
1948 "\n (otherwise exit on error)" \
Denys Vlasenko999e4422010-01-08 13:03:48 +01001949 "\n -a Don't up interface at each link probe" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001950 "\n -M Monitor creation/destruction of interface" \
1951 "\n (otherwise it must exist)" \
1952 "\n -r PROG Script to run" \
1953 "\n -x ARG Extra argument for script" \
1954 "\n -I Don't exit on nonzero exit code from script" \
1955 "\n -p Don't run script on daemon startup" \
1956 "\n -q Don't run script on daemon quit" \
1957 "\n -l Run script on startup even if no cable is detected" \
1958 "\n -t SECS Poll time in seconds" \
1959 "\n -u SECS Delay before running script after link up" \
1960 "\n -d SECS Delay after link down" \
Denys Vlasenkob8f0e802010-01-07 14:56:50 +01001961 "\n -m MODE API mode (mii, priv, ethtool, wlan, iff, auto)" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001962 "\n -k Kill running daemon" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001963
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001964#define ifup_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001965 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] IFACE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001966#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001967 "Options:" \
1968 "\n -a De/configure all interfaces automatically" \
1969 "\n -i FILE Use FILE for interface definitions" \
1970 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001971 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001972 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001973 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001974 ) \
1975 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001976 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001977
1978#define ifdown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001979 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001980#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001981 "Options:" \
1982 "\n -a De/configure all interfaces automatically" \
1983 "\n -i FILE Use FILE for interface definitions" \
1984 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001985 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001986 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001987 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001988 ) \
1989 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001990 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001991
Glenn L McGrath06e95652003-02-09 06:51:14 +00001992#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001993 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001994#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001995 "Listen for network connections and launch programs\n" \
1996 "\nOptions:" \
1997 "\n -f Run in foreground" \
1998 "\n -e Log to stderr" \
1999 "\n -q N Socket listen queue (default: 128)" \
2000 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002001 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00002002
Eric Andersen7e9276b2001-02-22 01:15:47 +00002003#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002004 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002005#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002006 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00002007
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002008#define init_notes_usage \
2009"This version of init is designed to be run only by the kernel.\n" \
2010"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002011"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00002012"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002013"runlevels, use sysvinit.\n" \
2014"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002015"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002016"it has the following default behavior:\n" \
2017"\n" \
2018" ::sysinit:/etc/init.d/rcS\n" \
2019" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002020" ::ctrlaltdel:/sbin/reboot\n" \
2021" ::shutdown:/sbin/swapoff -a\n" \
2022" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00002023" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002024"\n" \
2025"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
2026"\n" \
2027" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002028" tty3::askfirst:/bin/sh\n" \
2029" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002030"\n" \
2031"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
2032"\n" \
2033" <id>:<runlevels>:<action>:<process>\n" \
2034"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002035" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002036"\n" \
2037" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
2038" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002039" the specified process to run on. The contents of this field are\n" \
2040" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
2041" be unique, although if it isn't you may have strange results. If this\n" \
2042" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002043" note that if BusyBox detects that a serial console is in use, then only\n" \
2044" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002045" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002046" stinkin' utmp.\n" \
2047"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002048" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002049"\n" \
2050" The runlevels field is completely ignored.\n" \
2051"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002052" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002053"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002054" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00002055" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002056"\n" \
2057" The available actions can be classified into two groups: actions\n" \
2058" that are run only once, and actions that are re-run when the specified\n" \
2059" process exits.\n" \
2060"\n" \
2061" Run only-once actions:\n" \
2062"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002063" 'sysinit' is the first item run on boot. init waits until all\n" \
2064" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002065" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002066" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002067" the specified task completes. 'once' actions are asynchronous,\n" \
2068" therefore, init does not wait for them to complete. 'restart' is\n" \
2069" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00002070" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002071" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002072" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002073" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002074" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002075" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002076" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002077" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002078"\n" \
2079" Run repeatedly actions:\n" \
2080"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002081" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002082" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002083" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
2084" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002085" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002086" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002087" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002088" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002089"\n" \
2090" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002091" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00002092" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002093"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002094" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002095"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00002096" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002097"\n" \
2098"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00002099"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002100" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002101" #\n" \
2102" ::sysinit:/etc/init.d/rcS\n" \
2103" \n" \
2104" # /bin/sh invocations on selected ttys\n" \
2105" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002106" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002107" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002108" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002109" tty2::askfirst:-/bin/sh\n" \
2110" tty3::askfirst:-/bin/sh\n" \
2111" tty4::askfirst:-/bin/sh\n" \
2112" \n" \
2113" # /sbin/getty invocations for selected ttys\n" \
2114" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00002115" tty4::respawn:/sbin/getty 38400 tty4\n" \
2116" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002117" \n" \
2118" \n" \
2119" # Example of how to put a getty on a serial line (for a terminal)\n" \
2120" #\n" \
2121" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
2122" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
2123" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002124" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002125" #::respawn:/sbin/getty 57600 ttyS2\n" \
2126" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00002127" # Stuff to do when restarting the init process\n" \
2128" ::restart:/sbin/init\n" \
2129" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002130" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002131" ::ctrlaltdel:/sbin/reboot\n" \
2132" ::shutdown:/bin/umount -a -r\n" \
2133" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002134
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002135#define inotifyd_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002136 "PROG FILE1[:MASK]..."
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002137#define inotifyd_full_usage "\n\n" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002138 "Run PROG on filesystem changes." \
2139 "\nWhen a filesystem event matching MASK occurs on FILEn," \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002140 "\nPROG ACTUAL_EVENTS FILEn [SUBFILE] is run." \
Denis Vlasenko289ff0e2008-11-14 21:52:16 +00002141 "\nEvents:" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002142 "\n a File is accessed" \
2143 "\n c File is modified" \
2144 "\n e Metadata changed" \
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02002145 "\n w Writable file is closed" \
2146 "\n 0 Unwritable file is closed" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002147 "\n r File is opened" \
Denis Vlasenkoa09a42c2008-11-17 22:19:18 +00002148 "\n D File is deleted" \
2149 "\n M File is moved" \
2150 "\n u Backing fs is unmounted" \
2151 "\n o Event queue overflowed" \
2152 "\n x File can't be watched anymore" \
2153 "\nIf watching a directory:" \
2154 "\n m Subfile is moved into dir" \
2155 "\n y Subfile is moved out of dir" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002156 "\n n Subfile is created" \
2157 "\n d Subfile is deleted" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002158 "\n" \
2159 "\ninotifyd waits for PROG to exit." \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002160 "\nWhen x event happens for all FILEs, inotifyd exits." \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002161
Denis Vlasenko36309cf2008-11-22 18:29:01 +00002162/* 2.6 style insmod has no options and required filename
2163 * (not module name - .ko can't be omitted) */
Eric Andersen7e9276b2001-02-22 01:15:47 +00002164#define insmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002165 IF_FEATURE_2_4_MODULES("[OPTIONS] MODULE ") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002166 IF_NOT_FEATURE_2_4_MODULES("FILE ") \
Denis Vlasenko36309cf2008-11-22 18:29:01 +00002167 "[symbol=value]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002168#define insmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002169 "Load the specified kernel modules into the kernel" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002170 IF_FEATURE_2_4_MODULES( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002171 "\nOptions:" \
2172 "\n -f Force module to load into the wrong kernel version" \
2173 "\n -k Make module autoclean-able" \
2174 "\n -v Verbose" \
2175 "\n -q Quiet" \
2176 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002177 IF_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002178 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00002179 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002180 "\n -o NAME Set internal module name to NAME" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002181 "\n -x Don't export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00002182 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00002183
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002184/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00002185#define install_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002186 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [SOURCE]... DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002187#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002188 "Copy files and set attributes\n" \
2189 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002190 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002191 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002192 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002193 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002194 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002195 "\n -o USER Set ownership" \
2196 "\n -g GRP Set group ownership" \
2197 "\n -m MODE Set permissions" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002198 IF_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002199 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002200 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002201
Denis Vlasenko4acdb462009-01-31 21:45:57 +00002202#define ionice_trivial_usage \
2203 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
2204#define ionice_full_usage "\n\n" \
2205 "Change I/O scheduling class and priority\n" \
2206 "\nOptions:" \
2207 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
2208 "\n -n Priority" \
2209
Denis Vlasenko397de612008-03-17 08:55:44 +00002210/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002211#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00002212 "[OPTIONS] {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002213 IF_FEATURE_IP_ADDRESS("address | ") \
2214 IF_FEATURE_IP_ROUTE("route | ") \
2215 IF_FEATURE_IP_LINK("link | ") \
2216 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2217 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002218 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002219#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002220 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002221 "where OBJECT := {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002222 IF_FEATURE_IP_ADDRESS("address | ") \
2223 IF_FEATURE_IP_ROUTE("route | ") \
2224 IF_FEATURE_IP_LINK("link | ") \
2225 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2226 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002227 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002228 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002229
2230#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002231 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002232 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002233#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002234 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002235 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
2236 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002237 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002238 " [broadcast ADDR] [anycast ADDR]\n" \
2239 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002240 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002241
Eric Andersende4f07e2003-12-11 01:18:07 +00002242#define ipcalc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002243 "[OPTIONS] ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002244#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002245 "Calculate IP network settings from a IP address\n" \
2246 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002247 IF_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002248 "\n -b,--broadcast Display calculated broadcast address" \
2249 "\n -n,--network Display calculated network address" \
2250 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002251 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002252 "\n -p,--prefix Display the prefix for IP/NETMASK" \
2253 "\n -h,--hostname Display first resolved host name" \
2254 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002255 ) \
2256 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002257 IF_NOT_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002258 "\n -b Display calculated broadcast address" \
2259 "\n -n Display calculated network address" \
2260 "\n -m Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002261 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002262 "\n -p Display the prefix for IP/NETMASK" \
2263 "\n -h Display first resolved host name" \
2264 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002265 ) \
2266 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00002267
Rob Landley6eb1e412005-06-20 04:30:36 +00002268#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002269 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002270#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002271 "Upper-case options MQS remove an object by shmkey value.\n" \
2272 "Lower-case options remove an object by shmid value.\n" \
2273 "\nOptions:" \
2274 "\n -mM Remove memory segment after last detach" \
2275 "\n -qQ Remove message queue" \
2276 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002277
2278#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002279 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002280#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002281 " -i Show specific resource" \
2282 "\nResource specification:" \
2283 "\n -m Shared memory segments" \
2284 "\n -q Message queues" \
2285 "\n -s Semaphore arrays" \
2286 "\n -a All (default)" \
2287 "\nOutput format:" \
2288 "\n -t Time" \
2289 "\n -c Creator" \
2290 "\n -p Pid" \
2291 "\n -l Limits" \
2292 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002293
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002294#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002295 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002296#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00002297 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002298 " dynamic { on | off } |\n" \
2299 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002300 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002301
2302#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002303 "{ list | flush | { add | del | change | append |\n" \
2304 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002305#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002306 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002307 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
2308 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002309 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002310 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00002311 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
2312 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002313
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002314#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002315 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002316#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002317 "iprule [list | add | del] SELECTOR ACTION\n" \
2318 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2319 " [dev STRING] [pref NUMBER]\n" \
2320 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2321 " [prohibit | reject | unreachable]\n" \
2322 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002323 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002324
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002325#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002326 "{ add | change | del | show } [NAME]\n" \
2327 " [mode { ipip | gre | sit }]\n" \
2328 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002329#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002330 "iptunnel { add | change | del | show } [NAME]\n" \
2331 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2332 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002333 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002334
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002335#define kbd_mode_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002336 "[-a|k|s|u] [-C TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002337#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002338 "Report or set the keyboard mode\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002339 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002340 "\n -a Default (ASCII)" \
2341 "\n -k Medium-raw (keyboard)" \
2342 "\n -s Raw (scancode)" \
2343 "\n -u Unicode (utf-8)" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002344 "\n -C TTY Affect TTY instead of /dev/tty" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002345
Eric Andersen7e9276b2001-02-22 01:15:47 +00002346#define kill_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002347 "[-l] [-SIG] PID..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002348#define kill_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002349 "Send a signal (default: TERM) to given PIDs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002350 "\nOptions:" \
2351 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002352/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002353
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002354#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002355 "$ ps | grep apache\n" \
2356 "252 root root S [apache]\n" \
2357 "263 www-data www-data S [apache]\n" \
2358 "264 www-data www-data S [apache]\n" \
2359 "265 www-data www-data S [apache]\n" \
2360 "266 www-data www-data S [apache]\n" \
2361 "267 www-data www-data S [apache]\n" \
2362 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002363
2364#define killall_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002365 "[-l] [-q] [-SIG] PROCESS_NAME..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002366#define killall_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002367 "Send a signal (default: TERM) to given processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002368 "\nOptions:" \
2369 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002370/* "\n -s SIG Yet another way of specifying SIG" */ \
Denys Vlasenko07697852009-10-06 21:11:37 +02002371 "\n -q Don't complain if no processes were killed" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002372
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002373#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002374 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002375
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002376#define killall5_trivial_usage \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002377 "[-l] [-SIG] [-o PID]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002378#define killall5_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002379 "Send a signal (default: TERM) to all processes outside current session\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002380 "\nOptions:" \
2381 "\n -l List all signal names and numbers" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002382 "\n -o PID Don't signal this PID" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002383/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002384
Mark Whitley6317c4b2001-03-12 22:51:50 +00002385#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002386 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002387#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002388 "Kernel logger\n" \
2389 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002390 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002391 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002392
Eric Andersen7e9276b2001-02-22 01:15:47 +00002393#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002394 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002395#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002396 "Print STRING's length"
2397
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002398#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002399 "$ length Hello\n" \
2400 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002401
Rob Landley9200e792005-09-15 19:26:59 +00002402#define less_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002403 "[-EMNmh~I?] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002404#define less_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002405 "View FILE (or stdin) one screenful at a time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002406 "\nOptions:" \
2407 "\n -E Quit once the end of a file is reached" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002408 "\n -M,-m Display status line with line numbers" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002409 "\n and percentage through the file" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002410 "\n -N Prefix line number to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002411 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002412 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002413
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002414#define linux32_trivial_usage NOUSAGE_STR
2415#define linux32_full_usage ""
2416#define linux64_trivial_usage NOUSAGE_STR
2417#define linux64_full_usage ""
2418
2419#define linuxrc_trivial_usage NOUSAGE_STR
2420#define linuxrc_full_usage ""
2421
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002422#define setarch_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002423 "personality PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002424#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002425 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002426 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002427 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002428
Eric Andersen7e9276b2001-02-22 01:15:47 +00002429#define ln_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002430 "[OPTIONS] TARGET... LINK|DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002431#define ln_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002432 "Create a link LINK or DIR/TARGET to the specified TARGET(s)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002433 "\nOptions:" \
2434 "\n -s Make symlinks instead of hardlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002435 "\n -f Remove existing destinations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002436 "\n -n Don't dereference symlinks - treat like normal file" \
2437 "\n -b Make a backup of the target (if exists) before link operation" \
2438 "\n -S suf Use suffix instead of ~ when making backup files" \
2439
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002440#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002441 "$ ln -s BusyBox /tmp/ls\n" \
2442 "$ ls -l /tmp/ls\n" \
2443 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002444
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002445#define load_policy_trivial_usage NOUSAGE_STR
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002446#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002447
Eric Andersen7e9276b2001-02-22 01:15:47 +00002448#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002449 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002450#define loadfont_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002451 "Load a console font from stdin" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002452/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2453
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002454#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002455 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002456
2457#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002458 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002459#define loadkmap_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002460 "Load a binary keyboard translation table from stdin\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002461/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2462
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002463#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002464 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002465
2466#define logger_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002467 "[OPTIONS] [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002468#define logger_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002469 "Write MESSAGE (or stdin) to syslog\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002470 "\nOptions:" \
2471 "\n -s Log to stderr as well as the system log" \
2472 "\n -t TAG Log using the specified tag (defaults to user name)" \
2473 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002474
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002475#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002476 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002477
Robert Griebl1fca5582002-06-04 20:45:46 +00002478#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002479 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002480#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002481 "Begin a new session on the system\n" \
2482 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002483 "\n -f Don't authenticate (user already authenticated)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002484 "\n -h Name of the remote host" \
2485 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002486
Eric Andersen7e9276b2001-02-22 01:15:47 +00002487#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002488 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002489#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002490 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002491#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002492 "$ logname\n" \
2493 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002494
Mark Whitley6317c4b2001-03-12 22:51:50 +00002495#define logread_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002496 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002497#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002498 "Show messages in syslogd's circular buffer\n" \
2499 "\nOptions:" \
2500 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002501
Matt Kraai83788da2002-03-20 17:38:37 +00002502#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002503 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2504 " losetup -d LOOPDEV - disassociate\n" \
2505 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002506#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002507 "Options:" \
2508 "\n -o OFS Start OFS bytes into FILE" \
2509 "\n -f Show first free loop device" \
2510
Rob Landley1d589b22005-11-29 23:47:10 +00002511#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002512 "No arguments will display all current associations.\n" \
2513 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002514 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002515 "and filename of the file the loop device is currently bound to.\n\n" \
2516 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002517 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2518 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002519
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002520#define lpd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002521 "SPOOLDIR [HELPER [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002522#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002523 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2524 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002525 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002526 "\ndirectory and HELPER program is called. Name of file to print" \
2527 "\nis passed in $DATAFILE variable." \
2528 "\nExample:" \
2529 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002530
Denis Vlasenko68444b92008-02-22 22:24:48 +00002531#define lpq_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002532 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID]... [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002533#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002534 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002535 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002536 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002537 "\n -f Force any waiting job to be printed" \
2538 "\n -s Short display" \
2539
2540#define lpr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002541 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE]..."
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002542/* -C CLASS exists too, not shown.
2543 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002544#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002545 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002546 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002547 "\n -m Send mail on completion" \
2548 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002549 "\n -V Verbose" \
2550
Eric Andersen7e9276b2001-02-22 01:15:47 +00002551#define ls_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002552 "[-1Aa" IF_FEATURE_LS_TIMESTAMPS("c") "Cd" \
2553 IF_FEATURE_LS_TIMESTAMPS("e") IF_FEATURE_LS_FILETYPES("F") "iln" \
2554 IF_FEATURE_LS_FILETYPES("p") IF_FEATURE_LS_FOLLOWLINKS("L") \
2555 IF_FEATURE_LS_RECURSIVE("R") IF_FEATURE_LS_SORTFILES("rS") "s" \
2556 IF_FEATURE_AUTOWIDTH("T") IF_FEATURE_LS_TIMESTAMPS("tu") \
2557 IF_FEATURE_LS_SORTFILES("v") IF_FEATURE_AUTOWIDTH("w") "x" \
2558 IF_FEATURE_LS_SORTFILES("X") IF_FEATURE_HUMAN_READABLE("h") "k" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002559 IF_SELINUX("K") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002560#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002561 "List directory contents\n" \
2562 "\nOptions:" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002563 "\n -1 List in a single column" \
2564 "\n -A Don't list . and .." \
2565 "\n -a Don't hide entries starting with ." \
2566 "\n -C List by columns" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002567 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002568 "\n -c With -l: sort by ctime") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002569 IF_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002570 "\n --color[={always,never,auto}] Control coloring") \
2571 "\n -d List directory entries instead of contents" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002572 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002573 "\n -e List full date and time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002574 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002575 "\n -F Append indicator (one of */=@|) to entries") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002576 "\n -i List inode numbers" \
2577 "\n -l Long listing format" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002578 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002579 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002580 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002581 IF_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002582 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002583 IF_FEATURE_LS_RECURSIVE( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002584 "\n -R Recurse") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002585 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002586 "\n -r Sort in reverse order") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002587 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002588 "\n -S Sort by file size") \
Denis Vlasenko397de612008-03-17 08:55:44 +00002589 "\n -s List the size of each file, in blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002590 IF_FEATURE_AUTOWIDTH( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002591 "\n -T N Assume tabstop every N columns") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002592 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002593 "\n -t With -l: sort by modification time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002594 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002595 "\n -u With -l: sort by access time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002596 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002597 "\n -v Sort by version") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002598 IF_FEATURE_AUTOWIDTH( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002599 "\n -w N Assume the terminal is N columns wide") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002600 "\n -x List by lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002601 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002602 "\n -X Sort by extension") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002603 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002604 "\n -h List sizes in human readable format (1K 243M 2G)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002605 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002606 "\n -k List security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002607 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002608 "\n -K List security context in long format") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002609 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002610 "\n -Z List security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002611
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002612#define lsattr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002613 "[-Radlv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002614#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002615 "List file attributes on an ext2 fs\n" \
2616 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002617 "\n -R Recurse" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002618 "\n -a Don't hide entries starting with ." \
Denis Vlasenko397de612008-03-17 08:55:44 +00002619 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002620 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002621 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002622
Eric Andersen7e9276b2001-02-22 01:15:47 +00002623#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002624 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002625#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002626 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002627
Souf Oued982bc712009-12-05 17:56:25 +01002628#define lspci_trivial_usage \
2629 "[-mk]"
2630#define lspci_full_usage "\n\n" \
2631 "List all PCI devices" \
2632 "\n" \
2633 "\n -m Parseable output" \
2634 "\n -k Show driver" \
2635
Souf Oued11a802a2009-12-07 01:37:34 +01002636#define lsusb_trivial_usage NOUSAGE_STR
2637#define lsusb_full_usage ""
2638
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002639#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002640#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002641 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002642#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002643 "Create a range of block or character special files" \
2644 "\n" \
2645 "\nTYPE is:" \
2646 "\n b Block device" \
2647 "\n c Character device" \
2648 "\n f FIFO, MAJOR and MINOR are ignored" \
2649 "\n" \
2650 "\nFIRST..LAST specify numbers appended to NAME." \
2651 "\nIf 's' is the last argument, the base device is created as well." \
2652 "\n" \
2653 "\nExamples:" \
2654 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2655 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002656#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002657 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2658 "[creates ttyS2-ttyS63]\n" \
2659 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2660 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002661#endif
2662
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002663#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002664#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002665 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002666#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002667 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002668 "Device table entries take the form of:\n" \
2669 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002670 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002671 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002672 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002673 " c Character device\n" \
2674 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002675 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002676 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002677 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2678 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002679#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002680 "For example:\n" \
2681 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2682 "/dev d 755 0 0 - - - - -\n" \
2683 "/dev/console c 666 0 0 5 1 - - -\n" \
2684 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2685 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2686 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2687 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2688 "Will Produce:\n" \
2689 "/dev\n" \
2690 "/dev/console\n" \
2691 "/dev/null\n" \
2692 "/dev/zero\n" \
2693 "/dev/hda\n" \
2694 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002695#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002696
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002697#define makemime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002698 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002699#define makemime_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002700 "Create multipart MIME-encoded message from FILEs\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002701/* "Transfer encoding is base64, disposition is inline (not attachment)\n" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002702 "\nOptions:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002703 "\n -o FILE Output. Default: stdout" \
2704 "\n -a HDR Add header. Examples:" \
2705 "\n \"From: user@host.org\", \"Date: `date -R`\"" \
2706 "\n -c CT Content type. Default: text/plain" \
2707 "\n -C CS Charset. Default: " CONFIG_FEATURE_MIME_CHARSET \
2708/* "\n -e ENC Transfer encoding. Ignored. base64 is assumed" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002709 "\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002710 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002711
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002712#define man_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002713 "[OPTIONS] [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002714#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002715 "Format and display manual page\n" \
2716 "\nOptions:" \
2717 "\n -a Display all pages" \
2718 "\n -w Show page locations" \
2719
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002720#define matchpathcon_trivial_usage \
2721 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002722#define matchpathcon_full_usage "\n\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002723 " -n Don't display path" \
2724 "\n -N Don't use translations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002725 "\n -f Use alternate file_context file" \
2726 "\n -p Use prefix to speed translations" \
2727 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002728
Eric Andersen7e9276b2001-02-22 01:15:47 +00002729#define md5sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002730 "[OPTIONS] [FILE]..." \
2731 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTIONS] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002732#define md5sum_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002733 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2734 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002735 "\nOptions:" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002736 "\n -c Check sums against given list" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002737 "\n -s Don't output anything, status code shows success" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002738 "\n -w Warn about improperly formatted checksum lines" \
2739 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002740
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002741#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002742 "$ md5sum < busybox\n" \
2743 "6fd11e98b98a58f64ff3398d7b324003\n" \
2744 "$ md5sum busybox\n" \
2745 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2746 "$ md5sum -c -\n" \
2747 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2748 "busybox: OK\n" \
2749 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002750
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002751#define sha1sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002752 "[OPTIONS] [FILE]..." \
2753 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002754#define sha1sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002755 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002756 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002757 "\nOptions:" \
2758 "\n -c Check sums against given list" \
2759 "\n -s Don't output anything, status code shows success" \
2760 "\n -w Warn about improperly formatted checksum lines" \
2761 )
2762
2763#define sha256sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002764 "[OPTIONS] [FILE]..." \
2765 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha256sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002766#define sha256sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002767 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA256 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002768 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002769 "\nOptions:" \
2770 "\n -c Check sums against given list" \
2771 "\n -s Don't output anything, status code shows success" \
2772 "\n -w Warn about improperly formatted checksum lines" \
2773 )
2774
2775#define sha512sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002776 "[OPTIONS] [FILE]..." \
2777 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha512sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002778#define sha512sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002779 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA512 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002780 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002781 "\nOptions:" \
2782 "\n -c Check sums against given list" \
2783 "\n -s Don't output anything, status code shows success" \
2784 "\n -w Warn about improperly formatted checksum lines" \
2785 )
2786
Rob Landley70f7ef72005-12-13 08:21:33 +00002787#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002788 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002789#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002790 " -s Scan /sys and populate /dev during system boot\n" \
2791 "\n" \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002792 "It can be run by kernel as a hotplug helper. To activate it:\n" \
Denys Vlasenkof92874e2009-12-05 15:59:05 +01002793 " echo /sbin/mdev > /proc/sys/kernel/hotplug\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002794 IF_FEATURE_MDEV_CONF( \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002795 "It uses /etc/mdev.conf with lines\n" \
Denis Vlasenkof2b39e02009-04-13 23:18:52 +00002796 "[-]DEVNAME UID:GID PERM" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002797 IF_FEATURE_MDEV_RENAME(" [>|=PATH]") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002798 IF_FEATURE_MDEV_EXEC(" [@|$|*PROG]") \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002799 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002800
Rob Landleyef10d522006-06-26 14:11:33 +00002801#define mdev_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002802 IF_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002803 "The mdev config file contains lines that look like:\n" \
2804 " hd[a-z][0-9]* 0:3 660\n\n" \
2805 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002806 IF_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002807 "Optionally, that can be followed (on the same line) by a special character\n" \
2808 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002809 "device(s). The environment variable $MDEV indicates the active device node\n" \
2810 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002811 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2812 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002813 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002814 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002815 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002816 "Config file parsing stops on the first matching line. If no config\n" \
2817 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002818 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002819 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002820
Glenn L McGrath061c9002002-09-16 04:21:46 +00002821#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002822 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002823#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002824 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002825 " y Allow write access to your terminal\n" \
2826 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002827
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002828#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002829 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002830#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002831 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2832 "\nOptions:" \
2833 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2834 "\n next byte to it" \
2835 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2836 "\n -s Set serial line to SPEED" \
2837 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002838
Eric Andersen7e9276b2001-02-22 01:15:47 +00002839#define mkdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002840 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002841#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002842 "Create DIRECTORY\n" \
2843 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002844 "\n -m Mode" \
2845 "\n -p No error if exists; make parent directories as needed" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002846 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002847 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002848 )
2849
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002850#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002851 "$ mkdir /tmp/foo\n" \
2852 "$ mkdir /tmp/foo\n" \
2853 "/tmp/foo: File exists\n" \
2854 "$ mkdir /tmp/foo/bar/baz\n" \
2855 "/tmp/foo/bar/baz: No such file or directory\n" \
2856 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002857
Eric Andersen7e9276b2001-02-22 01:15:47 +00002858#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002859 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002860#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002861 "Create named pipe (identical to 'mknod name p')\n" \
2862 "\nOptions:" \
2863 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002864 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002865 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002866 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002867
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002868#define mkfs_ext2_trivial_usage \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002869 "[-Fn] " \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002870 /* "[-c|-l filename] " */ \
2871 "[-b BLK_SIZE] " \
2872 /* "[-f fragment-size] [-g blocks-per-group] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002873 "[-i INODE_RATIO] [-I INODE_SIZE] " \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002874 /* "[-j] [-J journal-options] [-N number-of-inodes] " */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002875 "[-m RESERVED_PERCENT] " \
2876 /* "[-o creator-os] [-O feature[,...]] [-q] " */ \
2877 /* "[r fs-revision-level] [-E extended-options] [-v] [-F] " */ \
2878 "[-L LABEL] " \
2879 /* "[-M last-mounted-directory] [-S] [-T filesystem-type] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002880 "BLOCKDEV [KBYTES]"
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002881#define mkfs_ext2_full_usage "\n\n" \
2882 " -b BLK_SIZE Block size, bytes" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002883/* "\n -c Check device for bad blocks" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002884/* "\n -E opts Set extended options" */ \
2885/* "\n -f size Fragment size in bytes" */ \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002886 "\n -F Force" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002887/* "\n -g N Number of blocks in a block group" */ \
Denys Vlasenko838e07a2009-10-22 12:15:33 +02002888 "\n -i RATIO Max number of files is filesystem_size / RATIO" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002889 "\n -I BYTES Inode size (min 128)" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002890/* "\n -j Create a journal (ext3)" */ \
2891/* "\n -J opts Set journal options (size/device)" */ \
2892/* "\n -l file Read bad blocks list from file" */ \
Denys Vlasenko6a8cfdc2009-10-17 23:41:15 +02002893 "\n -L LBL Volume label" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002894 "\n -m PERCENT Percent of blocks to reserve for admin" \
2895/* "\n -M dir Set last mounted directory" */ \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002896 "\n -n Dry run" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002897/* "\n -N N Number of inodes to create" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002898/* "\n -o os Set the 'creator os' field" */ \
2899/* "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" */ \
2900/* "\n -q Quiet" */ \
2901/* "\n -r rev Set filesystem revision" */ \
2902/* "\n -S Write superblock and group descriptors only" */ \
2903/* "\n -T fs-type Set usage type (news/largefile/largefile4)" */ \
2904/* "\n -v Verbose" */ \
2905
Eric Andersen7e9276b2001-02-22 01:15:47 +00002906#define mkfs_minix_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002907 "[-c | -l FILE] [-nXX] [-iXX] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002908#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002909 "Make a MINIX filesystem\n" \
2910 "\nOptions:" \
2911 "\n -c Check device for bad blocks" \
2912 "\n -n [14|30] Maximum length of filenames" \
2913 "\n -i INODES Number of inodes for the filesystem" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002914 "\n -l FILE Read bad blocks list from FILE" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002915 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002916
Vladimir Dronnikov0d8ea642009-11-02 10:41:46 +01002917#define mkfs_reiser_trivial_usage \
2918 "[-f] [-l LABEL] BLOCKDEV [4K-BLOCKS]"
2919
2920#define mkfs_reiser_full_usage "\n\n" \
2921 "Make a ReiserFS V3 filesystem\n" \
2922 "\nOptions:" \
2923 "\n -f Force" \
2924 "\n -l LBL Volume label" \
2925
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002926#define mkfs_vfat_trivial_usage \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002927 "[-v] [-n LABEL] BLOCKDEV [KBYTES]"
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002928/* Accepted but ignored:
2929 "[-c] [-C] [-I] [-l bad-block-file] [-b backup-boot-sector] "
2930 "[-m boot-msg-file] [-i volume-id] "
2931 "[-s sectors-per-cluster] [-S logical-sector-size] [-f number-of-FATs] "
2932 "[-h hidden-sectors] [-F fat-size] [-r root-dir-entries] [-R reserved-sectors] "
2933*/
2934#define mkfs_vfat_full_usage "\n\n" \
2935 "Make a FAT32 filesystem\n" \
2936 "\nOptions:" \
2937/* "\n -c Check device for bad blocks" */ \
2938 "\n -v Verbose" \
2939/* "\n -I Allow to use entire disk device (e.g. /dev/hda)" */ \
2940 "\n -n LBL Volume label" \
2941
Eric Andersen7e9276b2001-02-22 01:15:47 +00002942#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002943 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002944#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002945 "Create a special file (block, character, or pipe)\n" \
2946 "\nOptions:" \
2947 "\n -m Create the special file using the specified mode (default a=rw)" \
2948 "\nTYPEs include:" \
2949 "\n b: Make a block device" \
2950 "\n c or u: Make a character device" \
2951 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002952 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002953 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002954 )
2955
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002956#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002957 "$ mknod /dev/fd0 b 2 0\n" \
2958 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002959
Eric Andersen7e9276b2001-02-22 01:15:47 +00002960#define mkswap_trivial_usage \
Denys Vlasenko40e7d252010-02-01 23:48:27 +01002961 "[OPTIONS] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002962#define mkswap_full_usage "\n\n" \
Denys Vlasenko68c67462009-11-03 05:51:20 +01002963 "Prepare BLOCKDEV to be used as swap partition\n" \
2964 "\nOptions:" \
2965 "\n -L LBL Label" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002966
Eric Andersen7e9276b2001-02-22 01:15:47 +00002967#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002968 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002969#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002970 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002971 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002972 "\nOptions:" \
2973 "\n -d Make a directory instead of a file" \
2974/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2975 "\n -t Generate a path rooted in temporary directory" \
2976 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2977 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002978 "\nFor -t or -p, directory is chosen as follows:" \
2979 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002980
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002981#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002982 "$ mktemp /tmp/temp.XXXXXX\n" \
2983 "/tmp/temp.mWiLjM\n" \
2984 "$ ls -la /tmp/temp.mWiLjM\n" \
2985 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002986
Eric Andersen8d79ce82001-07-22 23:00:15 +00002987#define modprobe_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002988 IF_MODPROBE_SMALL("[-qfwrsv] MODULE [symbol=value]...") \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002989 IF_NOT_MODPROBE_SMALL("[-" \
2990 IF_FEATURE_2_4_MODULES("k")"nqrsv" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002991 IF_FEATURE_MODPROBE_BLACKLIST("b")"] MODULE [symbol=value]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002992#define modprobe_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002993 "Options:" \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002994 IF_MODPROBE_SMALL( \
2995 "\n -q Quiet" \
2996 "\n -f Force" \
2997 "\n -w Wait for unload" \
2998 "\n -r Remove module (stacks) or do autoclean" \
2999 "\n -s Report via syslog instead of stderr" \
3000 "\n -v Verbose" \
3001 ) \
3002 IF_NOT_MODPROBE_SMALL( \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003003 IF_FEATURE_2_4_MODULES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003004 "\n -k Make module autoclean-able" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00003005 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003006 "\n -n Dry run" \
3007 "\n -q Quiet" \
3008 "\n -r Remove module (stacks) or do autoclean" \
3009 "\n -s Report via syslog instead of stderr" \
3010 "\n -v Verbose" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003011 IF_FEATURE_MODPROBE_BLACKLIST( \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00003012 "\n -b Apply blacklist to module names too" \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02003013 ) \
3014 )
Denis Vlasenko397de612008-03-17 08:55:44 +00003015
Rob Landley9c32a152005-12-11 20:12:24 +00003016#define modprobe_notes_usage \
3017"modprobe can (un)load a stack of modules, passing each module options (when\n" \
3018"loading). modprobe uses a configuration file to determine what option(s) to\n" \
3019"pass each module it loads.\n" \
3020"\n" \
Bernhard Reutner-Fischer12aca792009-02-24 10:03:22 +00003021"The configuration file is searched (in this order):\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00003022"\n" \
3023" /etc/modprobe.conf (2.6 only)\n" \
3024" /etc/modules.conf\n" \
3025" /etc/conf.modules (deprecated)\n" \
3026"\n" \
3027"They all have the same syntax (see below). If none is present, it is\n" \
3028"_not_ an error; each loaded module is then expected to load without\n" \
3029"options. Once a file is found, the others are tested for.\n" \
3030"\n" \
3031"/etc/modules.conf entry format:\n" \
3032"\n" \
3033" alias <alias_name> <mod_name>\n" \
3034" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00003035" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00003036" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
3037" This makes it also possible to use a different set of options (below) for\n" \
3038" the module and the alias.\n" \
3039" A module can be aliased more than once.\n" \
3040"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003041" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00003042" When loading module mod_name (or the module aliased by alias_name), pass\n" \
3043" the \"symbol=value\" pairs as option to that module.\n" \
3044"\n" \
3045"Sample /etc/modules.conf file:\n" \
3046"\n" \
3047" options tulip irq=3\n" \
3048" alias tulip tulip2\n" \
3049" options tulip2 irq=4 io=0x308\n" \
3050"\n" \
3051"Other functionality offered by 'classic' modprobe is not available in\n" \
3052"this implementation.\n" \
3053"\n" \
3054"If module options are present both in the config file, and on the command line,\n" \
3055"then the options from the command line will be passed to the module _after_\n" \
3056"the options from the config file. That way, you can have defaults in the config\n" \
3057"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00003058#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003059 "(with the above /etc/modules.conf):\n\n" \
3060 "$ modprobe tulip\n" \
3061 " will load the module 'tulip' with default option 'irq=3'\n\n" \
3062 "$ modprobe tulip irq=5\n" \
3063 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
3064 "$ modprobe tulip2\n" \
3065 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
3066 " which are the default for alias 'tulip2'\n\n" \
3067 "$ modprobe tulip2 irq=8\n" \
3068 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
3069 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
3070 " from the command line\n\n" \
3071 "$ modprobe tulip2 irq=2 io=0x210\n" \
3072 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
3073 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
3074 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00003075
Eric Andersen7e9276b2001-02-22 01:15:47 +00003076#define more_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003077 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003078#define more_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003079 "View FILE (or stdin) one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00003080
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003081#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003082 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003083
Eric Andersen7e9276b2001-02-22 01:15:47 +00003084#define mount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003085 "[OPTIONS] [-o OPTS] DEVICE NODE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003086#define mount_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003087 "Mount a filesystem. Filesystem autodetection requires /proc.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003088 "\nOptions:" \
3089 "\n -a Mount all filesystems in fstab" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003090 IF_FEATURE_MOUNT_FAKE( \
3091 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003092 "\n -f Update /etc/mtab, but don't mount" \
3093 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003094 IF_NOT_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003095 "\n -f Dry run" \
3096 ) \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00003097 ) \
Denys Vlasenkoe2e4cc22009-06-19 11:48:29 +02003098 IF_FEATURE_MOUNT_HELPERS( \
3099 "\n -i Don't run mount helper" \
3100 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003101 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003102 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003103 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003104 "\n -r Read-only mount" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003105 "\n -w Read-write mount (default)" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003106 "\n -t FSTYPE Filesystem type" \
3107 "\n -O OPT Mount only filesystems with option OPT (-a only)" \
3108 "\n-o OPT:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003109 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003110 "\n loop Ignored (loop devices are autodetected)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003111 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003112 IF_FEATURE_MOUNT_FLAGS( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003113 "\n [a]sync Writes are [a]synchronous" \
3114 "\n [no]atime Disable/enable updates to inode access times" \
3115 "\n [no]diratime Disable/enable atime updates to directories" \
3116 "\n [no]relatime Disable/enable atime updates relative to modification time" \
3117 "\n [no]dev (Dis)allow use of special device files" \
3118 "\n [no]exec (Dis)allow use of executable files" \
3119 "\n [no]suid (Dis)allow set-user-id-root programs" \
3120 "\n [r]shared Convert [recursively] to a shared subtree" \
3121 "\n [r]slave Convert [recursively] to a slave subtree" \
3122 "\n [r]private Convert [recursively] to a private subtree" \
3123 "\n [un]bindable Make mount point [un]able to be bind mounted" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003124 "\n bind Bind a file or directory to another location" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003125 "\n move Relocate an existing mount point" \
Rob Landleye55a73c2006-08-09 20:55:35 +00003126 ) \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003127 "\n remount Remount a mounted filesystem, changing flags" \
3128 "\n ro/rw Same as -r/-w" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003129 "\n" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003130 "\nThere are filesystem-specific -o flags." \
Denis Vlasenko397de612008-03-17 08:55:44 +00003131
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003132#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003133 "$ mount\n" \
3134 "/dev/hda3 on / type minix (rw)\n" \
3135 "proc on /proc type proc (rw)\n" \
3136 "devpts on /dev/pts type devpts (rw)\n" \
3137 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
3138 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
3139 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00003140#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003141 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003142
Rob Landleyd00b3a52005-08-20 05:07:08 +00003143#define mountpoint_trivial_usage \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003144 "[-q] <[-dn] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003145#define mountpoint_full_usage "\n\n" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003146 "Check if the directory is a mountpoint\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003147 "\nOptions:" \
3148 "\n -q Quiet" \
3149 "\n -d Print major/minor device number of the filesystem" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003150 "\n -n Print device name of the filesystem" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003151 "\n -x Print major/minor device number of the blockdevice" \
3152
Rob Landleyd00b3a52005-08-20 05:07:08 +00003153#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003154 "$ mountpoint /proc\n" \
3155 "/proc is not a mountpoint\n" \
3156 "$ mountpoint /sys\n" \
3157 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00003158
Eric Andersen7e9276b2001-02-22 01:15:47 +00003159#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003160 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003161#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003162 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003163 "\n" \
3164 "Available Opcodes:\n" \
3165 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003166 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
3167 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
3168 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003169 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003170
Eric Andersen7e9276b2001-02-22 01:15:47 +00003171#define mv_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003172 "[OPTIONS] SOURCE DEST\n" \
3173 "or: mv [OPTIONS] SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003174#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003175 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
3176 "\nOptions:" \
3177 "\n -f Don't prompt before overwriting" \
3178 "\n -i Interactive, prompt before overwrite" \
3179
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003180#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003181 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003182
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003183#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003184 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003185#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003186 "Rename network interface while it in the down state\n" \
3187 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003188 "\n -c FILE Use configuration file (default: /etc/mactab)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003189 "\n -s Use syslog (LOCAL0 facility)" \
3190 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
3191
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003192#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003193 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
3194 " or\n" \
3195 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003196
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003197#if !ENABLE_DESKTOP
3198
Rob Landley1cca9482006-07-10 19:45:20 +00003199#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003200#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003201#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003202#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003203#endif
Rob Landley1cca9482006-07-10 19:45:20 +00003204
Eric Andersen7e9276b2001-02-22 01:15:47 +00003205#define nc_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003206 IF_NC_EXTRA("[-iN] [-wN] ")IF_NC_SERVER("[-l] [-p PORT] ") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003207 "["IF_NC_EXTRA("-f FILENAME|")"IPADDR PORT]"IF_NC_EXTRA(" [-e PROG]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003208#define nc_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003209 "Open a pipe to IP:port" IF_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003210 NC_OPTIONS_STR \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003211 IF_NC_EXTRA( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003212 "\n -e PROG Run PROG after connect" \
3213 "\n -i SEC Delay interval for lines sent" \
3214 "\n -w SEC Timeout for connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003215 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003216 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003217 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003218 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003219 IF_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003220 "\n (use -l twice with -e for persistent server)") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003221 "\n -p PORT Local port" \
Rob Landley1cca9482006-07-10 19:45:20 +00003222 )
3223
Rob Landley1cca9482006-07-10 19:45:20 +00003224#define nc_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003225 IF_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003226 "To use netcat as a terminal emulator on a serial port:\n\n" \
3227 "$ stty 115200 -F /dev/ttyS0\n" \
3228 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
3229 )
Rob Landley1cca9482006-07-10 19:45:20 +00003230
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003231#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003232 "$ nc foobar.somedomain.com 25\n" \
3233 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
3234 "help\n" \
3235 "214-Commands supported:\n" \
3236 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
3237 "214 NOOP QUIT RSET HELP\n" \
3238 "quit\n" \
3239 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003240
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003241#else /* DESKTOP nc - much more compatible with nc 1.10 */
3242
3243#define nc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003244 "[OPTIONS] HOST PORT - connect" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003245 IF_NC_SERVER("\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003246 "nc [OPTIONS] -l -p PORT [HOST] [PORT] - listen")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003247#define nc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003248 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003249 "\n -e PROG Run PROG after connect (must be last)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003250 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003251 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003252 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003253 "\n -n Don't do DNS resolution" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003254 "\n -s ADDR Local address" \
3255 "\n -p PORT Local port" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003256 "\n -u UDP mode" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003257 "\n -v Verbose" \
3258 "\n -w SEC Timeout for connects and final net reads" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003259 IF_NC_EXTRA( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003260 "\n -i SEC Delay interval for lines sent" /* ", ports scanned" */ \
3261 "\n -o FILE Hex dump traffic" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003262 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003263 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003264/* "\n -r Randomize local and remote ports" */
3265/* "\n -g gateway Source-routing hop point[s], up to 8" */
3266/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003267/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
3268
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003269/* -e PROG can take ARGS too: "nc ... -e ls -l", but we don't document it
3270 * in help text: nc 1.10 does not allow that. We don't want to entice
3271 * users to use this incompatibility */
3272
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003273#endif
3274
Eric Andersen1552ff72001-10-31 11:07:12 +00003275#define netstat_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003276 "[-laentuwxr"IF_FEATURE_NETSTAT_WIDE("W")IF_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003277#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003278 "Display networking information\n" \
3279 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003280 "\n -l Display listening server sockets" \
3281 "\n -a Display all sockets (default: connected)" \
3282 "\n -e Display other/more information" \
3283 "\n -n Don't resolve names" \
3284 "\n -t Tcp sockets" \
3285 "\n -u Udp sockets" \
3286 "\n -w Raw sockets" \
3287 "\n -x Unix sockets" \
3288 "\n -r Display routing table" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003289 IF_FEATURE_NETSTAT_WIDE( \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003290 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003291 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003292 IF_FEATURE_NETSTAT_PRG( \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003293 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003294 )
Eric Andersen1552ff72001-10-31 11:07:12 +00003295
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003296#define nice_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003297 "[-n ADJUST] [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003298#define nice_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003299 "Run PROG with modified scheduling priority\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003300 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003301 "\n -n ADJUST Adjust priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003302
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003303#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003304 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003305#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003306 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003307 "Format specifiers:\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003308 " %Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003309 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003310 " %[niface] Monitor network interface 'iface'\n" \
3311 " %m Monitor allocated memory\n" \
3312 " %[mf] Monitor free memory\n" \
3313 " %[mt] Monitor total memory\n" \
3314 " %s Monitor allocated swap\n" \
3315 " %f Monitor number of used file descriptors\n" \
3316 " %Ni Monitor total/specific IRQ rate\n" \
3317 " %x Monitor context switch rate\n" \
3318 " %p Monitor forks\n" \
3319 " %[pn] Monitor # of processes\n" \
3320 " %b Monitor block io\n" \
3321 " %Nt Show time (with N decimal points)\n" \
3322 " %Nd Milliseconds between updates (default:1000)\n" \
3323 " %r Print <cr> instead of <lf> at EOL" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003324
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003325#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003326 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003327
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003328#define nohup_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003329 "PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003330#define nohup_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003331 "Run PROG immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003332#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003333 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003334
Eric Andersen7e9276b2001-02-22 01:15:47 +00003335#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003336 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003337#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003338 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003339 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003340#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003341 "$ nslookup localhost\n" \
3342 "Server: default\n" \
3343 "Address: default\n" \
3344 "\n" \
3345 "Name: debian\n" \
3346 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003347
Adam Tkacb1585062009-11-22 03:43:55 +01003348#define ntpd_trivial_usage \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01003349 "[-dnqwl] [-S PROG] [-p PEER]..."
Adam Tkacb1585062009-11-22 03:43:55 +01003350#define ntpd_full_usage "\n\n" \
3351 "NTP client/server\n" \
3352 "\nOptions:" \
3353 "\n -d Verbose" \
3354 "\n -n Do not daemonize" \
Denys Vlasenko8d580c72009-11-23 16:27:16 +01003355 "\n -q Quit after clock is set" \
Denys Vlasenko907647f2009-12-02 23:17:45 +01003356/* -N exists for mostly compat reasons, thus not essential to inform */ \
Denys Vlasenkob2e5fc32009-11-25 14:52:47 +01003357/* the user that it exists: user may use nice as well */ \
3358/* "\n -N Run at high priority" */ \
Denys Vlasenko074e8dc2010-01-04 23:58:13 +01003359 "\n -w Do not set time (only query peers), implies -n" \
Adam Tkacb1585062009-11-22 03:43:55 +01003360 "\n -l Run as server on port 123" \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01003361 "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins" \
Adam Tkacb1585062009-11-22 03:43:55 +01003362 "\n -p PEER Obtain time from PEER (may be repeated)" \
3363
Glenn L McGrath60281112001-11-02 11:39:46 +00003364#define od_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003365 "[-aBbcDdeFfHhIiLlOovXx] " IF_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003366#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003367 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003368 "(or stdin) to stdout"
Glenn L McGrath60281112001-11-02 11:39:46 +00003369
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003370#define openvt_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003371 "[-c N] [-sw] [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003372#define openvt_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003373 "Start PROG on a new virtual terminal\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003374 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003375 "\n -c N Use specified VT" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003376 "\n -s Switch to the VT" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003377/* "\n -l Run PROG as login shell (by prepending '-')" */ \
3378 "\n -w Wait for PROG to exit" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003379
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003380#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003381 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003382
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003383/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003384#define parse_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003385 "[-n MAXTOKENS] [-m MINTOKENS] [-d DELIMS] [-f FLAGS] FILE..."
3386#define parse_full_usage ""
3387*/
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003388
Eric Andersen27f64e12002-06-23 04:24:25 +00003389#define passwd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003390 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003391#define passwd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003392 "Change USER's password. If no USER is specified,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003393 "changes the password for the current user.\n" \
3394 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003395 "\n -a Algorithm to use for password (des, md5)" /* ", sha1)" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00003396 "\n -d Delete password for the account" \
3397 "\n -l Lock (disable) account" \
3398 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003399
Denis Vlasenko21d10142007-07-20 21:28:41 +00003400#define chpasswd_trivial_usage \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003401 IF_LONG_OPTS("[--md5|--encrypted]") IF_NOT_LONG_OPTS("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003402#define chpasswd_full_usage "\n\n" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003403 "Read user:password from stdin and update /etc/passwd\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003404 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003405 IF_LONG_OPTS( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003406 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003407 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003408 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003409 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003410 "\n -e Supplied passwords are in encrypted form" \
3411 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003412 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00003413
Glenn L McGrath655d8142003-06-22 15:32:41 +00003414#define patch_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003415 "[OPTIONS] [ORIGFILE [PATCHFILE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003416#define patch_full_usage "\n\n" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003417 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003418 " -p,--strip N Strip N leading components from file names" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003419 "\n -i,--input DIFF Read DIFF instead of stdin" \
3420 "\n -R,--reverse Reverse patch" \
3421 "\n -N,--forward Ignore already applied patches" \
3422 "\n --dry-run Don't actually change files" \
3423 ) \
3424 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003425 " -p N Strip N leading components from file names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003426 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003427 "\n -R Reverse patch" \
Denys Vlasenkod7874ed2009-08-20 23:33:19 +02003428 "\n -N Ignore already applied patches" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003429 )
Denis Vlasenko397de612008-03-17 08:55:44 +00003430
Glenn L McGrath655d8142003-06-22 15:32:41 +00003431#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003432 "$ patch -p1 < example.diff\n" \
3433 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00003434
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003435#define pgrep_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003436 "[-flnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003437#define pgrep_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003438 "Display process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003439 "\nOptions:" \
3440 "\n -l Show command name too" \
3441 "\n -f Match against entire command line" \
3442 "\n -n Show the newest process only" \
3443 "\n -o Show the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003444 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003445 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003446 "\n -s Match session ID (0 for current)" \
3447 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003448
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003449#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00003450#define pidof_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003451 "[OPTIONS] [NAME]..."
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003452#define USAGE_PIDOF "\n\nOptions:"
3453#else
3454#define pidof_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003455 "[NAME]..."
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003456#define USAGE_PIDOF /* none */
3457#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003458#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003459 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003460 USAGE_PIDOF \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003461 IF_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003462 "\n -s Show only one PID") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003463 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003464 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003465 "\n Use %PPID to omit pid of pidof's parent") \
3466
Eric Andersen221b2ea2001-07-31 19:06:07 +00003467#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003468 "$ pidof init\n" \
3469 "1\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003470 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003471 "$ pidof /bin/sh\n20351 5973 5950\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003472 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003473 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00003474
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003475#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003476#define ping_trivial_usage \
3477 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003478#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003479 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003480#define ping6_trivial_usage \
3481 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003482#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003483 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003484#else
3485#define ping_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003486 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003487#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003488 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3489 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003490 "\n -4, -6 Force IP or IPv6 name resolution" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003491 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003492 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3493 "\n -I IFACE/IP Use interface or IP address as source" \
3494 "\n -W SEC Seconds to wait for the first response (default:10)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003495 "\n (after all -c CNT packets are sent)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003496 "\n -w SEC Seconds until ping exits (default:infinite)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003497 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003498 "\n -q Quiet, only displays output at start" \
3499 "\n and when finished" \
3500
Eric Andersen51b8bd62002-07-03 11:46:38 +00003501#define ping6_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003502 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003503#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003504 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3505 "\nOptions:" \
3506 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003507 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3508 "\n -I IFACE/IP Use interface or IP address as source" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003509 "\n -q Quiet, only displays output at start" \
3510 "\n and when finished" \
3511
Eric Andersen51b8bd62002-07-03 11:46:38 +00003512#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003513#define ping_example_usage \
3514 "$ ping localhost\n" \
3515 "PING slag (127.0.0.1): 56 data bytes\n" \
3516 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3517 "\n" \
3518 "--- debian ping statistics ---\n" \
3519 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3520 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003521#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003522 "$ ping6 ip6-localhost\n" \
3523 "PING ip6-localhost (::1): 56 data bytes\n" \
3524 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3525 "\n" \
3526 "--- ip6-localhost ping statistics ---\n" \
3527 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3528 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003529
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003530#define pipe_progress_trivial_usage NOUSAGE_STR
3531#define pipe_progress_full_usage ""
3532
Eric Andersen7e9276b2001-02-22 01:15:47 +00003533#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003534 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003535#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003536 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003537 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003538
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003539#define pkill_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003540 "[-l|-SIGNAL] [-fnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003541#define pkill_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003542 "Send a signal to process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003543 "\nOptions:" \
3544 "\n -l List all signals" \
3545 "\n -f Match against entire command line" \
3546 "\n -n Signal the newest process only" \
3547 "\n -o Signal the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003548 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003549 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003550 "\n -s Match session ID (0 for current)" \
3551 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003552
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003553#define popmaildir_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003554 "[OPTIONS] MAILDIR [CONN_HELPER ARGS]"
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003555#define popmaildir_full_usage "\n\n" \
3556 "Fetch content of remote mailbox to local maildir\n" \
3557 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003558/* "\n -b Binary mode. Ignored" */ \
3559/* "\n -d Debug. Ignored" */ \
3560/* "\n -m Show used memory. Ignored" */ \
3561/* "\n -V Show version. Ignored" */ \
3562/* "\n -c Use tcpclient. Ignored" */ \
3563/* "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003564 "\n -s Skip authorization" \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003565 "\n -T Get messages with TOP instead of RETR" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003566 "\n -k Keep retrieved messages on the server" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003567 "\n -t SEC Network timeout" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003568 IF_FEATURE_POPMAILDIR_DELIVERY( \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003569 "\n -F \"PROG ARGS\" Filter program (may be repeated)" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003570 "\n -M \"PROG ARGS\" Delivery program" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003571 ) \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003572 "\n" \
3573 "\nFetch from plain POP3 server:" \
3574 "\npopmaildir -k DIR nc pop3.server.com 110 <user_and_pass.txt" \
3575 "\nFetch from SSLed POP3 server and delete fetched emails:" \
3576 "\npopmaildir DIR -- openssl s_client -quiet -connect pop3.server.com:995 <user_and_pass.txt"
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003577/* "\n -R BYTES Remove old messages on the server >= BYTES. Ignored" */
3578/* "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" */
3579/* "\n -L BYTES Don't retrieve new messages >= BYTES. Ignored" */
3580/* "\n -H LINES Type first LINES of a message. Ignored" */
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003581#define popmaildir_example_usage \
3582 "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n" \
3583 "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
3584
Eric Andersen7e9276b2001-02-22 01:15:47 +00003585#define poweroff_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003586 "[-d DELAY] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003587#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003588 "Halt and shut off power\n" \
3589 "\nOptions:" \
3590 "\n -d Delay interval for halting" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003591 "\n -n Do not sync" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003592 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003593
Mike Frysinger95d3c452005-04-21 23:29:24 +00003594#define printenv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003595 "[VARIABLE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003596#define printenv_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003597 "Print environment VARIABLEs.\n" \
3598 "If no VARIABLE specified, print all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003599
Eric Andersen7e9276b2001-02-22 01:15:47 +00003600#define printf_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003601 "FORMAT [ARGUMENT]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003602#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003603 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003604 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003605#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003606 "$ printf \"Val=%d\\n\" 5\n" \
3607 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003608
Denis Vlasenko94949192006-11-05 00:45:47 +00003609
3610#if ENABLE_DESKTOP
3611
3612#define ps_trivial_usage \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003613 "[-o COL1,COL2=HEADER]" IF_FEATURE_SHOW_THREADS(" [-T]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003614#define ps_full_usage "\n\n" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003615 "Show list of processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003616 "\nOptions:" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003617 "\n -o COL1,COL2=HEADER Select columns for display" \
Denys Vlasenko532609e2009-09-20 20:29:25 +02003618 IF_FEATURE_SHOW_THREADS( \
3619 "\n -T Show threads" \
3620 )
Denis Vlasenko94949192006-11-05 00:45:47 +00003621
3622#else /* !ENABLE_DESKTOP */
3623
Denis Vlasenko397de612008-03-17 08:55:44 +00003624#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003625#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003626#else
3627#define USAGE_PS "\nOptions:"
3628#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003629
Eric Andersen7e9276b2001-02-22 01:15:47 +00003630#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003631 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003632#define ps_full_usage "\n\n" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003633 "Show list of processes\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003634 USAGE_PS \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003635 IF_SELINUX( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003636 "\n -Z Show selinux context" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003637 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003638 IF_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003639 "\n w Wide output" \
3640 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003641
Denis Vlasenko94949192006-11-05 00:45:47 +00003642#endif /* ENABLE_DESKTOP */
3643
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003644#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003645 "$ ps\n" \
3646 " PID Uid Gid State Command\n" \
3647 " 1 root root S init\n" \
3648 " 2 root root S [kflushd]\n" \
3649 " 3 root root S [kupdate]\n" \
3650 " 4 root root S [kpiod]\n" \
3651 " 5 root root S [kswapd]\n" \
3652 " 742 andersen andersen S [bash]\n" \
3653 " 743 andersen andersen S -bash\n" \
3654 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003655 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003656
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003657#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003658 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003659#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003660 "Scan a host, print all open ports\n" \
3661 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003662 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003663 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003664 "\n -p Scan from this port (default 1)" \
3665 "\n -P Scan up to this port (default 1024)" \
3666 "\n -t Timeout (default 5000 ms)" \
3667 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3668
Eric Andersen7e9276b2001-02-22 01:15:47 +00003669#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003670 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003671#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003672 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003673#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003674 "$ pwd\n" \
3675 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003676
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003677#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003678 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003679#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003680 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003681#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003682 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003683
Eric Andersen7e9276b2001-02-22 01:15:47 +00003684#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003685 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003686#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003687 "Get and possibly set the system date and time from a remote HOST\n" \
3688 "\nOptions:" \
3689 "\n -s Set the system date and time (default)" \
3690 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003691
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00003692#define rdev_trivial_usage \
3693 ""
3694#define rdev_full_usage "\n\n" \
3695 "Print the device node associated with the filesystem mounted at '/'"
3696#define rdev_example_usage \
3697 "$ rdev\n" \
3698 "/dev/mtdblock9 /\n"
3699
Rob Landley0e4690d2006-08-20 22:12:18 +00003700#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003701 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003702#define readahead_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003703 "Preload FILEs to RAM"
Rob Landley0e4690d2006-08-20 22:12:18 +00003704
Eric Andersen7e9276b2001-02-22 01:15:47 +00003705#define readlink_trivial_usage \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003706 IF_FEATURE_READLINK_FOLLOW("[-fnv] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003707#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003708 "Display the value of a symlink" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003709 IF_FEATURE_READLINK_FOLLOW( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003710 "\nOptions:" \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003711 "\n -f Canonicalize by following all symlinks" \
3712 "\n -n Don't add newline" \
3713 "\n -v Verbose" \
3714 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003715
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003716#define readprofile_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003717 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003718#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003719 "Options:" \
3720 "\n -m mapfile (Default: /boot/System.map)" \
3721 "\n -p profile (Default: /proc/profile)" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003722 "\n -M NUM Set the profiling multiplier to NUM" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003723 "\n -i Print only info about the sampling step" \
3724 "\n -v Verbose" \
3725 "\n -a Print all symbols, even if count is 0" \
3726 "\n -b Print individual histogram-bin counts" \
3727 "\n -s Print individual counters within functions" \
3728 "\n -r Reset all the counters (root only)" \
3729 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003730
Glenn L McGrath62fae302002-12-10 00:14:33 +00003731#define realpath_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003732 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003733#define realpath_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003734 "Return the absolute pathnames of given FILE"
Tim Riker7b253f82003-12-28 05:02:40 +00003735
Eric Andersen7e9276b2001-02-22 01:15:47 +00003736#define reboot_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003737 "[-d DELAY] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003738#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003739 "Reboot the system\n" \
3740 "\nOptions:" \
3741 "\n -d Delay interval for rebooting" \
3742 "\n -n No call to sync()" \
3743 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003744
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003745#define reformime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003746 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003747#define reformime_full_usage "\n\n" \
3748 "Parse MIME-encoded message\n" \
3749 "\nOptions:" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003750 "\n -x PREFIX Extract content of MIME sections to files" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003751 "\n -X PROG ARGS Filter content of MIME sections through PROG" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003752 "\n Must be the last option" \
3753 "\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003754 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003755
Eric Andersen7e9276b2001-02-22 01:15:47 +00003756#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003757 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003758#define renice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003759 "Change priority of running processes\n" \
3760 "\nOptions:" \
3761 "\n -n Adjust current nice value (smaller is faster)" \
3762 "\n -p Process id(s) (default)" \
3763 "\n -g Process group id(s)" \
3764 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003765
Denys Vlasenko5e611152009-05-19 17:36:16 +02003766#define scriptreplay_trivial_usage \
3767 "timingfile [typescript [divisor]]"
3768#define scriptreplay_full_usage "\n\n" \
3769 "Play back typescripts, using timing information"
3770
Eric Andersen7e9276b2001-02-22 01:15:47 +00003771#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003772 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003773#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003774 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003775
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003776#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003777 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003778#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003779 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003780
Denis Vlasenko397137b2007-07-23 14:03:30 +00003781#define restorecon_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003782 "[-iFnRv] [-e EXCLUDEDIR]... [-o FILE] [-f FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003783#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003784 "Reset security contexts of files in pathname\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003785 "\n -i Ignore files that don't exist" \
3786 "\n -f FILE File with list of files to process" \
3787 "\n -e DIR Directory to exclude" \
3788 "\n -R,-r Recurse" \
3789 "\n -n Don't change any file labels" \
3790 "\n -o FILE Save list of files with incorrect context" \
3791 "\n -v Verbose" \
3792 "\n -vv Show changed labels" \
3793 "\n -F Force reset of context to match file_context" \
3794 "\n for customizable files, or the user section," \
3795 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003796
Souf Oued43afd752010-05-02 18:45:02 +02003797#define rfkill_trivial_usage \
3798 "COMMAND [INDEX|TYPE]"
3799#define rfkill_full_usage "\n\n" \
3800 "Enable/disable wireless devices\n" \
3801 "\nCommands:" \
3802 "\n list [INDEX|TYPE] List current state" \
3803 "\n block INDEX|TYPE Disable device" \
3804 "\n unblock INDEX|TYPE Enable device" \
3805 "\n" \
3806 "\n TYPE: all, wlan(wifi), bluetooth, uwb(ultrawideband)," \
3807 "\n wimax, wwan, gps, fm" \
3808
Eric Andersen7e9276b2001-02-22 01:15:47 +00003809#define rm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003810 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003811#define rm_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003812 "Remove (unlink) FILEs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003813 "\nOptions:" \
3814 "\n -i Always prompt before removing" \
3815 "\n -f Never prompt" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003816 "\n -R,-r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003817
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003818#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003819 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003820
Eric Andersen7e9276b2001-02-22 01:15:47 +00003821#define rmdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003822 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003823#define rmdir_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003824 "Remove DIRECTORY if it is empty\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003825 "\nOptions:" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003826 IF_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003827 "\n -p|--parents Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003828 "\n --ignore-fail-on-non-empty" \
3829 ) \
3830 IF_NOT_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003831 "\n -p Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003832 )
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003833
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003834#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003835 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003836
Eric Andersen7e9276b2001-02-22 01:15:47 +00003837#define rmmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003838 "[OPTIONS] [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003839#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003840 "Unload the specified kernel modules from the kernel\n" \
3841 "\nOptions:" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003842 "\n -w Wait until the module is no longer used" \
3843 "\n -f Force unloading" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003844 "\n -a Remove all unused modules (recursively)" \
3845
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003846#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003847 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003848
Eric Andersen7e9276b2001-02-22 01:15:47 +00003849#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003850 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003851#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003852 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003853 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003854 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003855 "\n -e Display other/more information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003856 "\n -A inet" IF_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003857
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003858#define rpm_trivial_usage \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02003859 "-i PACKAGE.rpm; rpm -qp[ildc] PACKAGE.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003860#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003861 "Manipulate RPM packages\n" \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02003862 "\nCommands:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003863 "\n -i Install package" \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02003864 "\n -qp Query package" \
3865 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003866 "\n -i Show information" \
3867 "\n -l List contents" \
3868 "\n -d List documents" \
3869 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003870
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003871#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003872 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003873#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003874 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003875
Mike Frysinger6b160e42008-02-15 02:27:19 +00003876#define rtcwake_trivial_usage \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003877 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SEC | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003878#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003879 "Enter a system sleep state until specified wakeup time\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003880 IF_LONG_OPTS( \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003881 "\n -a,--auto Read clock mode from adjtime" \
3882 "\n -l,--local Clock is set to local time" \
3883 "\n -u,--utc Clock is set to UTC time" \
3884 "\n -d,--device=DEV Specify the RTC device" \
3885 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003886 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003887 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003888 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003889 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003890 "\n -a Read clock mode from adjtime" \
3891 "\n -l Clock is set to local time" \
3892 "\n -u Clock is set to UTC time" \
3893 "\n -d DEV Specify the RTC device" \
3894 "\n -m MODE Set the sleep state (default: standby)" \
3895 "\n -s SEC Set the timeout in SEC seconds from now" \
3896 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003897 )
3898
Denis Vlasenko49622d72007-03-10 16:58:49 +00003899#define runcon_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003900 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] PROG ARGS\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003901 "runcon CONTEXT PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003902#define runcon_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003903 "Run PROG in a different security context\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003904 "\n CONTEXT Complete security context\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003905 IF_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003906 "\n -c,--compute Compute process transition context before modifying" \
3907 "\n -t,--type=TYPE Type (for same role as parent)" \
3908 "\n -u,--user=USER User identity" \
3909 "\n -r,--role=ROLE Role" \
3910 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003911 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003912 IF_NOT_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003913 "\n -c Compute process transition context before modifying" \
3914 "\n -t TYPE Type (for same role as parent)" \
3915 "\n -u USER User identity" \
3916 "\n -r ROLE Role" \
3917 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003918 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003919
Eric Andersen6cf47a72001-10-31 10:24:36 +00003920#define run_parts_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003921 "[-t] "IF_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003922#define run_parts_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003923 "Run a bunch of scripts in DIRECTORY\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003924 "\nOptions:" \
3925 "\n -t Print what would be run, but don't actually run anything" \
3926 "\n -a ARG Pass ARG as argument for every program" \
3927 "\n -u MASK Set the umask to MASK before running every program" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003928 IF_FEATURE_RUN_PARTS_FANCY( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003929 "\n -l Print names of all matching files even if they are not executable" \
3930 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003931
3932#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003933 "$ run-parts -a start /etc/init.d\n" \
3934 "$ run-parts -a stop=now /etc/init.d\n\n" \
3935 "Let's assume you have a script foo/dosomething:\n" \
3936 "#!/bin/sh\n" \
3937 "for i in $*; do eval $i; done; unset i\n" \
3938 "case \"$1\" in\n" \
3939 "start*) echo starting something;;\n" \
3940 "stop*) set -x; shutdown -h $stop;;\n" \
3941 "esac\n\n" \
3942 "Running this yields:\n" \
3943 "$run-parts -a stop=+4m foo/\n" \
3944 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003945
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003946#define runlevel_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003947 "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003948#define runlevel_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003949 "Find the current and previous system runlevel\n" \
3950 "\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003951 "If no utmp FILE exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003952 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003953#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003954 "$ runlevel /var/run/utmp\n" \
3955 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003956
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003957#define runsv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003958 "DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003959#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003960 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003961
3962#define runsvdir_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003963 "[-P] [-s SCRIPT] DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003964#define runsvdir_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003965 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
3966 "\n -P Put each runsv in a new session" \
3967 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003968
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003969#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003970 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003971#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003972 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003973#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003974 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003975
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003976#define script_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003977 "[-afq" IF_SCRIPTREPLAY("t") "] [-c PROG] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003978#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003979 "Options:" \
3980 "\n -a Append output" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003981 "\n -c PROG Run PROG, not shell" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003982 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003983 "\n -q Quiet" \
Denys Vlasenko5e611152009-05-19 17:36:16 +02003984 IF_SCRIPTREPLAY( \
3985 "\n -t Send timing to stderr" \
3986 )
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003987
Eric Andersen7e9276b2001-02-22 01:15:47 +00003988#define sed_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003989 "[-efinr] SED_CMD [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003990#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003991 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003992 "\n -e CMD Add CMD to sed commands to be executed" \
3993 "\n -f FILE Add FILE contents to sed commands to be executed" \
Denys Vlasenkodac863a2009-10-27 09:11:17 +01003994 "\n -i Edit files in-place (else sends result to stdout)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003995 "\n -n Suppress automatic printing of pattern space" \
3996 "\n -r Use extended regex syntax" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003997 "\n" \
Rob Landley7b284152009-10-26 16:04:07 -05003998 "\nIf no -e or -f, the first non-option argument is the sed command string." \
3999 "\nRemaining arguments are input files (stdin if none)."
Eric Andersenf802ff72004-04-12 15:12:06 +00004000
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004001#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004002 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
4003 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004004
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00004005#define selinuxenabled_trivial_usage NOUSAGE_STR
4006#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004007
Denis Vlasenko73032ca2008-01-28 22:47:03 +00004008#define sendmail_trivial_usage \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02004009 "[OPTIONS] [RECIPIENT_EMAIL]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004010#define sendmail_full_usage "\n\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02004011 "Read email from stdin and send it\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00004012 "\nStandard options:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02004013 "\n -t Read additional recipients from message body" \
4014 "\n -f sender Sender (required)" \
4015 "\n -o options Various options. -oi implied, others are ignored" \
Vladimir Dronnikovb618dba2009-10-04 01:34:54 +02004016 "\n -i -oi synonym. implied and ignored" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00004017 "\n" \
4018 "\nBusybox specific options:" \
4019 "\n -w seconds Network timeout" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02004020 "\n -H 'PROG ARGS' Run connection helper" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00004021 "\n Examples:" \
Denis Vlasenko7e0c2432009-03-02 16:12:00 +00004022 "\n -H 'exec openssl s_client -quiet -tls1 -starttls smtp" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00004023 "\n -connect smtp.gmail.com:25' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00004024 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00004025 "\n -H 'exec openssl s_client -quiet -tls1" \
4026 "\n -connect smtp.gmail.com:465' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00004027 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00004028 "\n -S server[:port] Server" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00004029 "\n -au<username> Username for AUTH LOGIN" \
4030 "\n -ap<password> Password for AUTH LOGIN" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02004031 "\n -am<method> Authentication method. Ignored. LOGIN is implied" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00004032 "\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00004033 "\nOther options are silently ignored; -oi -t is implied" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02004034 IF_MAKEMIME( \
4035 "\nUse makemime applet to create message with attachments" \
4036 )
Denis Vlasenko73032ca2008-01-28 22:47:03 +00004037
Glenn L McGrath82364bb2004-01-27 09:22:20 +00004038#define seq_trivial_usage \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00004039 "[-w] [-s SEP] [FIRST [INC]] LAST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004040#define seq_full_usage "\n\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00004041 "Print numbers from FIRST to LAST, in steps of INC.\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004042 "FIRST, INC default to 1.\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00004043 "\nOptions:" \
4044 "\n -w Pad to last with leading zeros" \
4045 "\n -s SEP String separator" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00004046
Denis Vlasenko705eaf82007-11-22 01:10:41 +00004047#define sestatus_trivial_usage \
4048 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004049#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004050 " -v Verbose" \
4051 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00004052
Paul Foxfc2256a2005-08-01 18:12:30 +00004053#define setconsole_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004054 "[-r" IF_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004055#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004056 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
4057 "\nOptions:" \
4058 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00004059
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004060#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004061 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00004062#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004063
Denis Vlasenko397137b2007-07-23 14:03:30 +00004064#define setfiles_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004065 "[-dnpqsvW] [-e DIR]... [-o FILE] [-r alt_root_path]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004066 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397137b2007-07-23 14:03:30 +00004067 " [-c policyfile] spec_file" \
4068 ) \
4069 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004070#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004071 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004072 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004073 "\n -c FILE Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00004074 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004075 "\n -d Show which specification matched each file" \
4076 "\n -l Log changes in file labels to syslog" \
4077 "\n -n Don't change any file labels" \
4078 "\n -q Suppress warnings" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004079 "\n -r DIR Use an alternate root path" \
4080 "\n -e DIR Exclude DIR" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004081 "\n -F Force reset of context to match file_context for customizable files" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004082 "\n -o FILE Save list of files with incorrect context" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004083 "\n -s Take a list of files from stdin (instead of command line)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004084 "\n -v Show changes in file labels, if type or role are changing" \
4085 "\n -vv Show changes in file labels, if type, role, or user are changing" \
4086 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00004087
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00004088#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00004089 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00004090#define setfont_full_usage "\n\n" \
4091 "Load a console font\n" \
4092 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00004093 "\n -m MAPFILE Load console screen map" \
4094 "\n -C TTY Affect TTY instead of /dev/tty" \
4095
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00004096#define setfont_example_usage \
4097 "$ setfont -m koi8-r /etc/i18n/fontname\n"
4098
Eric Andersen7e9276b2001-02-22 01:15:47 +00004099#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004100 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004101#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004102 "Set entries into the kernel's scancode-to-keycode map,\n" \
4103 "allowing unusual keyboards to generate usable keycodes.\n\n" \
4104 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004105 "and KEYCODE is given in decimal." \
Denis Vlasenko397de612008-03-17 08:55:44 +00004106
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004107#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004108 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004109
Rob Landley87848d92006-03-27 23:23:43 +00004110#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004111 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004112#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004113 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00004114
Denis Vlasenkobe039372007-10-14 04:48:44 +00004115#define setsebool_trivial_usage \
4116 "boolean value"
4117
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004118#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00004119 "Change boolean setting"
4120
Paul Fox42403642005-08-01 22:52:09 +00004121#define setsid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004122 "PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004123#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004124 "Run PROG in a new session. PROG will have no controlling terminal\n" \
4125 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
4126 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00004127
Eric Andersen2e9c2572003-08-08 22:26:06 +00004128#define last_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004129 ""IF_FEATURE_LAST_FANCY("[-HW] [-f FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004130#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004131 "Show listing of the last users that logged into the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004132 IF_FEATURE_LAST_FANCY( "\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004133 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00004134/* "\n -H Show header line" */ \
4135 "\n -W Display with no host column truncation" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004136 "\n -f FILE Read from FILE instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004137 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00004138
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00004139#define showkey_trivial_usage \
4140 "[-a | -k | -s]"
4141#define showkey_full_usage "\n\n" \
4142 "Show keys pressed\n" \
4143 "\nOptions:" \
4144 "\n -a Display decimal/octal/hex values of the keys" \
4145 "\n -k Display interpreted keycodes (default)" \
4146 "\n -s Display raw scan-codes" \
4147
Denis Vlasenko14923db2007-06-20 15:23:03 +00004148#define slattach_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004149 "[-cehmLF] [-s SPEED] [-p PROTOCOL] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004150#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004151 "Attach network interface(s) to serial line(s)\n" \
4152 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004153 "\n -p PROT Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
4154 "\n -s SPD Set line speed" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004155 "\n -e Exit after initializing device" \
4156 "\n -h Exit when the carrier is lost" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004157 "\n -c PROG Run PROG when the line is hung up" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004158 "\n -m Do NOT initialize the line in raw 8 bits mode" \
4159 "\n -L Enable 3-wire operation" \
4160 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00004161
Eric Andersen7e9276b2001-02-22 01:15:47 +00004162#define sleep_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004163 IF_FEATURE_FANCY_SLEEP("[") "N" IF_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004164#define sleep_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004165 IF_NOT_FEATURE_FANCY_SLEEP("Pause for N seconds") \
4166 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004167 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004168 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004169#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004170 "$ sleep 2\n" \
4171 "[2 second delay results]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004172 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004173 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004174 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00004175
Eric Andersen7e9276b2001-02-22 01:15:47 +00004176#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004177 "[-nru" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004178 IF_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004179 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004180#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004181 "Sort lines of text\n" \
4182 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004183 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004184 "\n -b Ignore leading blanks" \
4185 "\n -c Check whether input is sorted" \
4186 "\n -d Dictionary order (blank or alphanumeric only)" \
4187 "\n -f Ignore case" \
4188 "\n -g General numerical sort" \
4189 "\n -i Ignore unprintable characters" \
4190 "\n -k Sort key" \
4191 "\n -M Sort month" \
4192 ) \
4193 "\n -n Sort numbers" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004194 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004195 "\n -o Output to file" \
4196 "\n -k Sort by key" \
4197 "\n -t CHAR Key separator" \
4198 ) \
4199 "\n -r Reverse sort order" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004200 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004201 "\n -s Stable (don't sort ties alphabetically)" \
4202 ) \
4203 "\n -u Suppress duplicate lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004204 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004205 "\n -z Lines are terminated by NUL, not newline" \
4206 "\n -mST Ignored for GNU compatibility") \
4207
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004208#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004209 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
4210 "a\n" \
4211 "b\n" \
4212 "c\n" \
4213 "d\n" \
4214 "e\n" \
4215 "f\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004216 IF_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00004217 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
4218 "d 2\n" \
4219 "b 2\n" \
4220 "c 3\n" \
4221 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004222 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004223
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00004224#define split_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004225 "[OPTIONS] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004226#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00004227 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004228 "\n -b n[k|m] Split by bytes" \
4229 "\n -l n Split by lines" \
4230 "\n -a n Use n letters as suffix" \
4231
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00004232#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00004233 "$ split TODO foo\n" \
4234 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00004235
Eric Andersenc2af1ee2001-10-18 19:33:06 +00004236#define start_stop_daemon_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004237 "[OPTIONS] [-S|-K] ... [-- ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004238#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004239 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004240 "-K: stop all matching processes.\n" \
4241 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004242 IF_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004243 "\nProcess matching:" \
4244 "\n -u,--user USERNAME|UID Match only this user's processes" \
4245 "\n -n,--name NAME Match processes with NAME" \
4246 "\n in comm field in /proc/PID/stat" \
4247 "\n -x,--exec EXECUTABLE Match processes with this command" \
4248 "\n in /proc/PID/cmdline" \
4249 "\n -p,--pidfile FILE Match a process with PID from the file" \
4250 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004251 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004252 "\n -x,--exec EXECUTABLE Program to run" \
4253 "\n -a,--startas NAME Zeroth argument" \
4254 "\n -b,--background Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004255 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004256 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004257 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004258 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
4259 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004260 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004261 "\n -s,--signal SIG Signal to send" \
4262 "\n -t,--test Match only, exit with 0 if a process is found" \
4263 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004264 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004265 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004266 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00004267 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00004268 "\n -q,--quiet Quiet" \
4269 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004270 IF_NOT_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004271 "\nProcess matching:" \
4272 "\n -u USERNAME|UID Match only this user's processes" \
4273 "\n -n NAME Match processes with NAME" \
4274 "\n in comm field in /proc/PID/stat" \
4275 "\n -x EXECUTABLE Match processes with this command" \
4276 "\n command in /proc/PID/cmdline" \
4277 "\n -p FILE Match a process with PID from the file" \
4278 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004279 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004280 "\n -x EXECUTABLE Program to run" \
4281 "\n -a NAME Zeroth argument" \
4282 "\n -b Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004283 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004284 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00004285 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004286 "\n -c USER[:[GRP]] Change to user/group" \
4287 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004288 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004289 "\n -s SIG Signal to send" \
4290 "\n -t Match only, exit with 0 if a process is found" \
4291 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004292 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004293 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004294 "\n -v Verbose" \
4295 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00004296 "\n -q Quiet" \
4297 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00004298
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004299#define stat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004300 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004301#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004302 "Display file (default) or filesystem status\n" \
4303 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004304 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004305 "\n -c fmt Use the specified format" \
4306 ) \
4307 "\n -f Display filesystem status" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004308 "\n -L Follow links" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004309 "\n -t Display info in terse form" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004310 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004311 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004312 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004313 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004314 "\n\nValid format sequences for files:\n" \
4315 " %a Access rights in octal\n" \
4316 " %A Access rights in human readable form\n" \
4317 " %b Number of blocks allocated (see %B)\n" \
4318 " %B The size in bytes of each block reported by %b\n" \
4319 " %d Device number in decimal\n" \
4320 " %D Device number in hex\n" \
4321 " %f Raw mode in hex\n" \
4322 " %F File type\n" \
4323 " %g Group ID of owner\n" \
4324 " %G Group name of owner\n" \
4325 " %h Number of hard links\n" \
4326 " %i Inode number\n" \
4327 " %n File name\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004328 " %N File name, with -> TARGET if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004329 " %o I/O block size\n" \
4330 " %s Total size, in bytes\n" \
4331 " %t Major device type in hex\n" \
4332 " %T Minor device type in hex\n" \
4333 " %u User ID of owner\n" \
4334 " %U User name of owner\n" \
4335 " %x Time of last access\n" \
4336 " %X Time of last access as seconds since Epoch\n" \
4337 " %y Time of last modification\n" \
4338 " %Y Time of last modification as seconds since Epoch\n" \
4339 " %z Time of last change\n" \
4340 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004341 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004342 " %a Free blocks available to non-superuser\n" \
4343 " %b Total data blocks in file system\n" \
4344 " %c Total file nodes in file system\n" \
4345 " %d Free file nodes in file system\n" \
4346 " %f Free blocks in file system\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004347 IF_SELINUX( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004348 " %C Security context in selinux\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004349 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004350 " %i File System ID in hex\n" \
4351 " %l Maximum length of filenames\n" \
4352 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004353 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004354 " %S Fundamental block size (for block counts)\n" \
4355 " %t Type in hex\n" \
4356 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004357 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004358
Eric Andersenef5e8f82002-11-07 02:09:37 +00004359#define strings_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004360 "[-afo] [-n LEN] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004361#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004362 "Display printable strings in a binary file\n" \
4363 "\nOptions:" \
4364 "\n -a Scan whole file (default)" \
4365 "\n -f Precede strings with filenames" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004366 "\n -n LEN At least LEN characters form a string (default 4)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004367 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00004368
Eric Andersen7e9276b2001-02-22 01:15:47 +00004369#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004370 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004371#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004372 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004373 "and deviations from stty sane\n" \
4374 "\nOptions:" \
4375 "\n -F DEVICE Open device instead of stdin" \
4376 "\n -a Print all current settings in human-readable form" \
4377 "\n -g Print in stty-readable form" \
4378 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004379
Robert Griebl1fca5582002-06-04 20:45:46 +00004380#define su_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004381 "[OPTIONS] [-] [USERNAME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004382#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004383 "Change user id or become root\n" \
4384 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004385 "\n -p,-m Preserve environment" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004386 "\n -c CMD Command to pass to 'sh -c'" \
4387 "\n -s SH Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00004388
Eric Andersen27f64e12002-06-23 04:24:25 +00004389#define sulogin_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004390 "[-t N] [TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004391#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004392 "Single user login\n" \
4393 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004394 "\n -t N Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004395
Mike Frysinger95d3c452005-04-21 23:29:24 +00004396#define sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004397 "[-rs] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004398#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004399 "Checksum and count the blocks in a file\n" \
4400 "\nOptions:" \
4401 "\n -r Use BSD sum algorithm (1K blocks)" \
4402 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00004403
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004404#define sv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004405 "[-v] [-w SEC] CMD SERVICE_DIR..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004406#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004407 "Control services monitored by runsv supervisor.\n" \
4408 "Commands (only first character is enough):\n" \
4409 "\n" \
4410 "status: query service status\n" \
4411 "up: if service isn't running, start it. If service stops, restart it\n" \
4412 "once: like 'up', but if service stops, don't restart it\n" \
4413 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004414 " if it exists. After it stops, don't restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004415 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004416 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004417 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004418 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004419
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004420#define svlogd_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004421 "[-ttv] [-r C] [-R CHARS] [-l MATCHLEN] [-b BUFLEN] DIR..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004422#define svlogd_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004423 "Continuously read log data from stdin, optionally\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004424 "filter log messages, and write the data to one or more automatically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004425 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004426
Eric Andersen7e9276b2001-02-22 01:15:47 +00004427#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004428 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004429#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004430 "Stop swapping on DEVICE\n" \
4431 "\nOptions:" \
4432 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004433
Eric Andersen7e9276b2001-02-22 01:15:47 +00004434#define swapon_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004435 "[-a]" IF_FEATURE_SWAPON_PRI(" [-p PRI]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004436#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004437 "Start swapping on DEVICE\n" \
4438 "\nOptions:" \
4439 "\n -a Start swapping on all swap devices" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004440 IF_FEATURE_SWAPON_PRI( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004441 "\n -p PRI Set swap device priority" \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004442 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004443
Rob Landley0f34a822005-10-27 22:55:50 +00004444#define switch_root_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004445 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004446#define switch_root_full_usage "\n\n" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004447 "Free initramfs and switch to another root fs:\n" \
4448 "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n" \
4449 "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004450 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004451 "\n -c DEV Reopen stdio to DEV after switch" \
Rob Landley0f34a822005-10-27 22:55:50 +00004452
Eric Andersen7e9276b2001-02-22 01:15:47 +00004453#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004454 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004455#define sync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004456 "Write all buffered blocks to disk"
4457
4458#define fsync_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004459 "[OPTIONS] FILE..."
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004460#define fsync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004461 "Write files' buffered blocks to disk\n" \
4462 "\nOptions:" \
4463 "\n -d Avoid syncing metadata"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004464
Eric Andersenb9050282003-12-24 06:02:11 +00004465#define sysctl_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004466 "[OPTIONS] [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004467#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004468 "Configure kernel parameters at runtime\n" \
4469 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004470 "\n -n Don't print key names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004471 "\n -e Don't warn about unknown keys" \
4472 "\n -w Change sysctl setting" \
4473 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
4474 "\n -a Display all values" \
4475 "\n -A Display all values in table form" \
4476
Eric Andersen5d38f5b2005-09-12 21:42:48 +00004477#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00004478 "sysctl [-n] [-e] variable...\n" \
4479 "sysctl [-n] [-e] -w variable=value...\n" \
4480 "sysctl [-n] [-e] -a\n" \
4481 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
4482 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00004483
Eric Andersen7e9276b2001-02-22 01:15:47 +00004484#define syslogd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004485 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004486#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004487 "System logging utility.\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004488 "This version of syslogd ignores /etc/syslog.conf\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004489 "\nOptions:" \
4490 "\n -n Run in foreground" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004491 "\n -O FILE Log to given file (default:/var/log/messages)" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004492 "\n -l N Set local log level" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004493 "\n -S Smaller logging output" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004494 IF_FEATURE_ROTATE_LOGFILE( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004495 "\n -s SIZE Max size (KB) before rotate (default:200KB, 0=off)" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004496 "\n -b N N rotated logs to keep (default:1, max=99, 0=purge)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004497 IF_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004498 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
4499 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004500 IF_FEATURE_SYSLOGD_DUP( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004501 "\n -D Drop duplicates") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004502 IF_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004503 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00004504 /* NB: -Csize shouldn't have space (because size is optional) */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004505/* "\n -m MIN Minutes between MARK lines (default:20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00004506
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004507#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004508 "$ syslogd -R masterlog:514\n" \
4509 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004510
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004511#define tac_trivial_usage \
4512 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004513#define tac_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004514 "Concatenate FILEs and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004515
Eric Andersen7e9276b2001-02-22 01:15:47 +00004516#define tar_trivial_usage \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004517 "-[" IF_FEATURE_TAR_CREATE("c") "xt" IF_FEATURE_SEAMLESS_GZ("z") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004518 IF_FEATURE_SEAMLESS_BZ2("j") IF_FEATURE_SEAMLESS_LZMA("a") \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004519 IF_FEATURE_SEAMLESS_Z("Z") IF_FEATURE_TAR_NOPRESERVE_TIME("m") "vO] " \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004520 IF_FEATURE_TAR_FROM("[-X FILE] ") \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004521 "[-f TARFILE] [-C DIR] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004522#define tar_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004523 IF_FEATURE_TAR_CREATE("Create, extract, ") \
4524 IF_NOT_FEATURE_TAR_CREATE("Extract ") \
4525 "or list files from a tar file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004526 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004527 IF_FEATURE_TAR_CREATE( \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004528 "\n c Create" \
4529 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004530 "\n x Extract" \
4531 "\n t List" \
4532 "\nArchive format selection:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004533 IF_FEATURE_SEAMLESS_GZ( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004534 "\n z Filter the archive through gzip" \
4535 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004536 IF_FEATURE_SEAMLESS_BZ2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004537 "\n j Filter the archive through bzip2" \
4538 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004539 IF_FEATURE_SEAMLESS_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004540 "\n a Filter the archive through lzma" \
4541 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004542 IF_FEATURE_SEAMLESS_Z( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004543 "\n Z Filter the archive through compress" \
4544 ) \
Mikhail Gusarov0d478332010-01-19 20:22:30 +06004545 IF_FEATURE_TAR_NOPRESERVE_TIME( \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004546 "\n m Do not restore mtime" \
Mikhail Gusarov0d478332010-01-19 20:22:30 +06004547 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004548 "\nFile selection:" \
4549 "\n f Name of TARFILE or \"-\" for stdin" \
4550 "\n O Extract to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004551 IF_FEATURE_TAR_FROM( \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004552 IF_FEATURE_TAR_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004553 "\n exclude File to exclude" \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004554 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004555 "\n X File with names to exclude" \
4556 ) \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004557 "\n C Change to DIR before operation" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004558 "\n v Verbose" \
4559
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004560#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004561 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
4562 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004563
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004564#define taskset_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004565 "[-p] [MASK] [PID | PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004566#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004567 "Set or get CPU affinity\n" \
4568 "\nOptions:" \
4569 "\n -p Operate on an existing PID" \
4570
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004571#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004572 "$ taskset 0x7 ./dgemm_test&\n" \
4573 "$ taskset -p 0x1 $!\n" \
4574 "pid 4790's current affinity mask: 7\n" \
4575 "pid 4790's new affinity mask: 1\n" \
4576 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4577 "pid 6671's current affinity mask: 1\n" \
4578 "pid 6671's new affinity mask: 1\n" \
4579 "$ taskset -p 1\n" \
4580 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004581
Eric Andersen7e9276b2001-02-22 01:15:47 +00004582#define tee_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004583 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004584#define tee_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004585 "Copy stdin to each FILE, and also to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004586 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004587 "\n -a Append to the given FILEs, don't overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004588 "\n -i Ignore interrupt signals (SIGINT)" \
4589
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004590#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004591 "$ echo \"Hello\" | tee /tmp/foo\n" \
4592 "$ cat /tmp/foo\n" \
4593 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004594
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004595#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004596#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004597 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004598#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004599 "Connect to telnet server\n" \
4600 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004601 "\n -a Automatic login with $USER variable" \
4602 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004603
Eric Andersen539ffc92004-02-22 12:25:47 +00004604#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004605#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004606 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004607#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004608 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004609#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004610
Eric Andersen08a72202002-09-30 20:52:10 +00004611#define telnetd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004612 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004613#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004614 "Handle incoming telnet connections" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004615 IF_NOT_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004616 "\nOptions:" \
4617 "\n -l LOGIN Exec LOGIN on connect" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004618 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004619 "\n -K Close connection as soon as login exits" \
4620 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004621 IF_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004622 "\n -p PORT Port to listen on" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004623 "\n -b ADDR[:PORT] Address to bind to" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004624 "\n -F Run in foreground" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004625 "\n -i Inetd mode" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004626 IF_FEATURE_TELNETD_INETD_WAIT( \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004627 "\n -w SEC Inetd 'wait' mode, linger time SEC" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004628 "\n -S Log to syslog (implied by -i or without -F and -w)" \
4629 ) \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004630 )
Eric Andersen08a72202002-09-30 20:52:10 +00004631
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004632/* "test --help" does not print help (POSIX compat), only "[ --help" does.
Denys Vlasenko662078f2010-01-14 13:27:34 +01004633 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION")
4634 * Unfortunately, it screws up generated BusyBox.html. TODO. */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004635#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004636 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004637#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004638 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4639 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004640#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004641 "$ test 1 -eq 2\n" \
4642 "$ echo $?\n" \
4643 "1\n" \
4644 "$ test 1 -eq 1\n" \
4645 "$ echo $?\n" \
4646 "0\n" \
4647 "$ [ -d /etc ]\n" \
4648 "$ echo $?\n" \
4649 "0\n" \
4650 "$ [ -d /junk ]\n" \
4651 "$ echo $?\n" \
4652 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004653
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004654#define tc_trivial_usage \
4655 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
4656#define tc_full_usage "\n\n" \
4657 "OBJECT: {qdisc|class|filter}\n" \
4658 "CMD: {add|del|change|replace|show}\n" \
4659 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004660 "qdisc [ handle QHANDLE ] [ root |"IF_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004661 /* "[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4662 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4663 " QDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004664 "qdisc show [ dev STRING ]"IF_FEATURE_TC_INGRESS(" [ingress]")"\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004665 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004666 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004667 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
4668 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
4669 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004670 " [ root | classid CLASSID ] [ handle FILTERID ]\n" \
4671 " [ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004672 "filter show [ dev STRING ] [ root | parent CLASSID ]"
4673
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004674#define tcpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004675 "[-hEv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004676/* with not-implemented options: */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004677/* "[-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 +00004678#define tcpsvd_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004679 "Create TCP socket, bind to IP:PORT and listen\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004680 "for incoming connection. Run PROG for each connection.\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004681 "\n IP IP to listen on. '0' = all" \
4682 "\n PORT Port to listen on" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004683 "\n PROG ARGS Program to run" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004684 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4685 "\n -u USER[:GRP] Change to user/group after bind" \
4686 "\n -c N Handle up to N connections simultaneously" \
4687 "\n -b N Allow a backlog of approximately N TCP SYNs" \
4688 "\n -C N[:MSG] Allow only up to N connections from the same IP" \
4689 "\n New connections from this IP address are closed" \
4690 "\n immediately. MSG is written to the peer before close" \
4691 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004692 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004693 "\n -v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004694
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004695#define udpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004696 "[-hEv] [-c N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004697#define udpsvd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004698 "Create UDP socket, bind to IP:PORT and wait\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004699 "for incoming packets. Run PROG for each packet,\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004700 "redirecting all further packets with same peer ip:port to it.\n" \
4701 "\n IP IP to listen on. '0' = all" \
4702 "\n PORT Port to listen on" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004703 "\n PROG ARGS Program to run" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004704 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4705 "\n -u USER[:GRP] Change to user/group after bind" \
4706 "\n -c N Handle up to N connections simultaneously" \
4707 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004708 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004709 "\n -v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004710
Mark Whitley450736c2001-03-02 19:08:50 +00004711#define tftp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004712 "[OPTIONS] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004713#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004714 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004715 "\nOptions:" \
4716 "\n -l FILE Local FILE" \
4717 "\n -r FILE Remote FILE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004718 IF_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004719 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004720 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004721 IF_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004722 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004723 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004724 IF_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004725 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004726 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004727
4728#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004729 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004730#define tftpd_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004731 "Transfer a file on tftp client's request\n" \
Denis Vlasenko91f8f822008-10-30 23:42:37 +00004732 "\n" \
4733 "tftpd should be used as an inetd service.\n" \
4734 "tftpd's line for inetd.conf:\n" \
4735 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
4736 "It also can be ran from udpsvd:\n" \
4737 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004738 "\nOptions:" \
4739 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004740 "\n -c Allow file creation via upload" \
4741 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004742
Eric Andersenc3657422001-11-30 07:54:32 +00004743#define time_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004744 "[OPTIONS] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004745#define time_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004746 "Run PROG, display resource usage when it exits\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004747 "\nOptions:" \
4748 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004749
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004750#define timeout_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004751 "[-t SECS] [-s SIG] PROG ARGS"
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004752#define timeout_full_usage "\n\n" \
4753 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
Denis Vlasenko42404082008-11-24 13:42:24 +00004754 "Defaults: SECS: 10, SIG: TERM." \
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004755
Eric Andersen420b2082002-09-17 22:14:58 +00004756#define top_trivial_usage \
Denys Vlasenko00528822009-09-11 23:26:42 +02004757 "[-b] [-nCOUNT] [-dSECONDS]" IF_FEATURE_TOPMEM(" [-m]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004758#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004759 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004760 "Read the status of all processes from /proc each SECONDS\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004761 "and display a screenful of them." \
4762//TODO: add options and keyboard commands
Eric Andersen420b2082002-09-17 22:14:58 +00004763
Eric Andersen7e9276b2001-02-22 01:15:47 +00004764#define touch_trivial_usage \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004765 "[-c] [-d DATE] FILE [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004766#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004767 "Update the last-modified date on the given FILE[s]\n" \
4768 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004769 "\n -c Don't create files" \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004770 "\n -d DT Date/time to use" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004771
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004772#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004773 "$ ls -l /tmp/foo\n" \
4774 "/bin/ls: /tmp/foo: No such file or directory\n" \
4775 "$ touch /tmp/foo\n" \
4776 "$ ls -l /tmp/foo\n" \
4777 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004778
4779#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004780 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004781#define tr_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004782 "Translate, squeeze, or delete characters from stdin, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004783 "\nOptions:" \
4784 "\n -c Take complement of STRING1" \
4785 "\n -d Delete input characters coded STRING1" \
4786 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4787
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004788#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004789 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4790 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004791
Eric Andersen5c58d282001-07-10 16:29:00 +00004792#define traceroute_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004793 "[-"IF_TRACEROUTE6("46")"FIldnrv] [-f 1ST_TTL] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
4794 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-g GATEWAY] [-i IFACE]\n" \
4795 " [-z PAUSE_MSEC] HOST [BYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004796#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004797 "Trace the route to HOST\n" \
4798 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004799 IF_TRACEROUTE6( \
4800 "\n -4, -6 Force IP or IPv6 name resolution" \
4801 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004802 "\n -F Set the don't fragment bit" \
4803 "\n -I Use ICMP ECHO instead of UDP datagrams" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004804 "\n -l Display the TTL value of the returned packet" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004805 "\n -d Set SO_DEBUG options to socket" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004806 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004807 "\n -r Bypass routing tables, send directly to HOST" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004808 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004809 "\n -m Max time-to-live (max number of hops)" \
4810 "\n -p Base UDP port number used in probes" \
4811 "\n (default 33434)" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004812 "\n -q Number of probes per TTL (default 3)" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004813 "\n -s IP address to use as the source address" \
4814 "\n -t Type-of-service in probe packets (default 0)" \
4815 "\n -w Time in seconds to wait for a response (default 3)" \
4816 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004817
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004818#define traceroute6_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004819 "[-dnrv] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
4820 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-i IFACE]\n" \
4821 " HOST [BYTES]"
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004822#define traceroute6_full_usage "\n\n" \
4823 "Trace the route to HOST\n" \
4824 "\nOptions:" \
4825 "\n -d Set SO_DEBUG options to socket" \
4826 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004827 "\n -r Bypass routing tables, send directly to HOST" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004828 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004829 "\n -m Max time-to-live (max number of hops)" \
4830 "\n -p Base UDP port number used in probes" \
4831 "\n (default is 33434)" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004832 "\n -q Number of probes per TTL (default 3)" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004833 "\n -s IP address to use as the source address" \
4834 "\n -t Type-of-service in probe packets (default 0)" \
4835 "\n -w Time in seconds to wait for a response (default 3)" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004836
Eric Andersen7e9276b2001-02-22 01:15:47 +00004837#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004838 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004839#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004840 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004841#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004842 "$ true\n" \
4843 "$ echo $?\n" \
4844 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004845
Eric Andersen7e9276b2001-02-22 01:15:47 +00004846#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004847 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004848#define tty_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004849 "Print file name of stdin's terminal" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004850 IF_INCLUDE_SUSv2( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004851 "\nOptions:" \
4852 "\n -s Print nothing, only return exit status" \
4853 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004854#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004855 "$ tty\n" \
4856 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004857
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004858#define ttysize_trivial_usage \
4859 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004860#define ttysize_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004861 "Print dimension(s) of stdin's terminal, on error return 80x25"
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004862
Denis Vlasenko39b68132009-01-23 02:07:14 +00004863#define tunctl_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004864 "[-f device] ([-t name] | -d name)" IF_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]")
Denis Vlasenko39b68132009-01-23 02:07:14 +00004865#define tunctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004866 "Create or delete tun interfaces\n" \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004867 "\nOptions:" \
4868 "\n -f name tun device (/dev/net/tun)" \
4869 "\n -t name Create iface 'name'" \
4870 "\n -d name Delete iface 'name'" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004871 IF_FEATURE_TUNCTL_UG( \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004872 "\n -u owner Set iface owner" \
4873 "\n -g group Set iface group" \
4874 "\n -b Brief output" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004875 )
Denis Vlasenko39b68132009-01-23 02:07:14 +00004876#define tunctl_example_usage \
4877 "# tunctl\n" \
4878 "# tunctl -d tun0\n"
4879
Mike Frysinger174808c2005-06-11 01:14:09 +00004880#define tune2fs_trivial_usage \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004881/* "[-c max-mounts-count] [-e errors-behavior] [-g group] " */ \
4882/* "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " */ \
4883/* "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " */ \
4884/* "[-r reserved-blocks-count] [-u user] [-C mount-count] " */ \
4885 "[-L LABEL] " \
4886/* "[-M last-mounted-dir] [-O [^]feature[,...]] " */ \
4887/* "[-T last-check-time] [-U UUID] " */ \
4888 "BLOCKDEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004889#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004890 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004891
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004892#define udhcpc_trivial_usage \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004893 "[-fbnqvoCR] [-i IFACE] [-r IP] [-s PROG] [-p PIDFILE]\n" \
4894 " [-H HOSTNAME] [-c CID] [-V VENDOR] [-O DHCP_OPT]..." IF_FEATURE_UDHCP_PORT(" [-P N]")
4895#define udhcpc_full_usage "\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004896 IF_LONG_OPTS( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004897 "\n -i,--interface IFACE Interface to use (default eth0)" \
4898 "\n -p,--pidfile FILE Create pidfile" \
4899 "\n -r,--request IP IP address to request" \
4900 "\n -s,--script PROG Run PROG at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
4901 "\n -t,--retries N Send up to N discover packets" \
4902 "\n -T,--timeout N Pause between packets (default 3 seconds)" \
Denys Vlasenkoe6080a42010-04-14 14:04:26 -07004903 "\n -A,--tryagain N Wait N seconds after failure (default 20)" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004904 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004905 USE_FOR_MMU( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004906 "\n -b,--background Background if lease is not obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004907 ) \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004908 "\n -S,--syslog Log to syslog too" \
4909 "\n -n,--now Exit if lease is not obtained" \
4910 "\n -q,--quit Exit after obtaining lease" \
4911 "\n -R,--release Release IP on exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004912 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004913 "\n -P,--client-port N Use port N (default 68)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004914 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004915 IF_FEATURE_UDHCPC_ARPING( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004916 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004917 ) \
Denys Vlasenkoe6080a42010-04-14 14:04:26 -07004918 "\n -O,--request-option OPT Request DHCP option OPT (cumulative)" \
4919 "\n -o,--no-default-options Don't request any options (unless -O is given)" \
4920 "\n -x OPT:VAL Include option OPT in sent packets (cumulative)" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004921 "\n -F,--fqdn NAME Ask server to update DNS mapping for NAME" \
4922 "\n -H,-h,--hostname NAME Send NAME as client hostname (default none)" \
4923 "\n -V,--vendorclass VENDOR Vendor identifier (default 'udhcp VERSION')" \
4924 "\n -c,--clientid CLIENTID Client identifier (default own MAC)" \
4925 "\n -C,--clientid-none Don't send client identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004926 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004927 IF_NOT_LONG_OPTS( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004928 "\n -i IFACE Interface to use (default eth0)" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +01004929 "\n -p FILE Create pidfile" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004930 "\n -r IP IP address to request" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004931 "\n -s PROG Run PROG at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
4932 "\n -t N Send up to N discover packets" \
4933 "\n -T N Pause between packets (default 3 seconds)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004934 "\n -A N Wait N seconds (default 20) after failure" \
Denys Vlasenko7e6add12010-03-25 20:32:38 +01004935 "\n -x OPT:VAL Include option OPT in sent packets" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004936 "\n -O OPT Request DHCP option OPT (cumulative)" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004937 "\n -o Don't request any options (unless -O is given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004938 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004939 USE_FOR_MMU( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004940 "\n -b Background if lease is not obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004941 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004942 "\n -S Log to syslog too" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004943 "\n -n Exit if lease is not obtained" \
4944 "\n -q Exit after obtaining lease" \
4945 "\n -R Release IP on exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004946 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004947 "\n -P N Use port N (default 68)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004948 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004949 IF_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004950 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004951 ) \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004952 "\n -F NAME Ask server to update DNS mapping for NAME" \
4953 "\n -H,-h NAME Send NAME as client hostname (default none)" \
4954 "\n -V VENDOR Vendor identifier (default 'udhcp VERSION')" \
4955 "\n -c CLIENTID Client identifier (default own MAC)" \
4956 "\n -C Don't send client identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004957 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004958
Russ Dill61fb4892002-10-14 21:41:28 +00004959#define udhcpd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004960 "[-fS]" IF_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004961
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004962#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004963 "DHCP server\n" \
4964 "\n -f Run in foreground" \
4965 "\n -S Log to syslog too" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004966 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004967 "\n -P N Use port N (default 67)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004968 )
Russ Dill61fb4892002-10-14 21:41:28 +00004969
Eric Andersen7e9276b2001-02-22 01:15:47 +00004970#define umount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004971 "[OPTIONS] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004972#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004973 "Unmount file systems\n" \
4974 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004975 IF_FEATURE_UMOUNT_ALL( \
4976 "\n -a Unmount all file systems" IF_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004977 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004978 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004979 "\n -n Don't erase /etc/mtab entries" \
4980 ) \
4981 "\n -r Try to remount devices as read-only if mount is busy" \
4982 "\n -l Lazy umount (detach filesystem)" \
4983 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004984 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004985 "\n -d Free loop device if it has been used" \
4986 )
4987
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004988#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004989 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004990
4991#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004992 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004993#define uname_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004994 "Print system information\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004995 "\nOptions:" \
4996 "\n -a Print all" \
4997 "\n -m The machine (hardware) type" \
4998 "\n -n Hostname" \
4999 "\n -r OS release" \
5000 "\n -s OS name (default)" \
5001 "\n -p Processor type" \
5002 "\n -v OS version" \
5003
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005004#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005005 "$ uname -a\n" \
5006 "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 +00005007
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00005008#define uncompress_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005009 "[-cf] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005010#define uncompress_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02005011 "Decompress .Z file[s]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005012 "\nOptions:" \
Denys Vlasenkoa3581402010-05-27 02:30:04 +02005013 "\n -c Write to stdout" \
5014 "\n -f Overwrite" \
Tim Riker7b253f82003-12-28 05:02:40 +00005015
Denis Vlasenko3952f202007-08-13 14:10:24 +00005016#define unexpand_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005017 "[-fa][-t N] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005018#define unexpand_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01005019 "Convert spaces to tabs, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005020 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005021 IF_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00005022 "\n -a,--all Convert all blanks" \
5023 "\n -f,--first-only Convert only leading blanks" \
5024 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00005025 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005026 IF_NOT_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00005027 "\n -a Convert all blanks" \
5028 "\n -f Convert only leading blanks" \
5029 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00005030 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00005031
Eric Andersen7e9276b2001-02-22 01:15:47 +00005032#define uniq_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005033 "[-cdu][-f,s,w N] [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005034#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00005035 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005036 "\nOptions:" \
5037 "\n -c Prefix lines by the number of occurrences" \
5038 "\n -d Only print duplicate lines" \
5039 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00005040 "\n -f N Skip first N fields" \
5041 "\n -s N Skip first N chars (after any skipped fields)" \
5042 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005043
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005044#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005045 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
5046 "a\n" \
5047 "b\n" \
5048 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005049
Glenn L McGrath87ac7022002-01-02 13:52:26 +00005050#define unzip_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005051 "[-opts[modifiers]] FILE[.zip] [LIST] [-x XLIST] [-d DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005052#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005053 "Extract files from ZIP archives\n" \
5054 "\nOptions:" \
5055 "\n -l List archive contents (with -q for short form)" \
Denys Vlasenkoa3581402010-05-27 02:30:04 +02005056 "\n -n Never overwrite files (default)" \
5057 "\n -o Overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005058 "\n -p Send output to stdout" \
5059 "\n -q Quiet" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005060 "\n -x XLST Exclude these files" \
5061 "\n -d DIR Extract files into DIR" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00005062
Eric Andersen7e9276b2001-02-22 01:15:47 +00005063#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005064 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005065#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005066 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00005067
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005068#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005069 "$ uptime\n" \
5070 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005071
5072#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005073 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005074#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005075 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00005076
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005077#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005078 "$ usleep 1000000\n" \
5079 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005080
5081#define uudecode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01005082 "[-o OUTFILE] [INFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005083#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00005084 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005085 "Finds outfile name in uuencoded source unless -o is given"
5086
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005087#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005088 "$ uudecode -o busybox busybox.uu\n" \
5089 "$ ls -l busybox\n" \
5090 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005091
5092#define uuencode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01005093 "[-m] [INFILE] STORED_FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005094#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005095 "Uuencode a file to stdout\n" \
5096 "\nOptions:" \
5097 "\n -m Use base64 encoding per RFC1521" \
5098
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005099#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005100 "$ uuencode busybox busybox\n" \
5101 "begin 755 busybox\n" \
5102 "<encoded file snipped>\n" \
5103 "$ uudecode busybox busybox > busybox.uu\n" \
5104 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005105
Eric Andersen853c4942003-01-23 05:59:32 +00005106#define vconfig_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005107 "COMMAND [OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005108#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005109 "Create and remove virtual ethernet devices\n" \
5110 "\nOptions:" \
5111 "\n add [interface-name] [vlan_id]" \
5112 "\n rem [vlan-name]" \
5113 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
5114 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
5115 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
5116 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00005117
Eric Andersen3f980402001-04-04 17:31:15 +00005118#define vi_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005119 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005120#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005121 "Edit FILE\n" \
5122 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005123 IF_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00005124 "\n -c Initial command to run ($EXINIT also available)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005125 IF_FEATURE_VI_READONLY( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01005126 "\n -R Read-only") \
Denis Vlasenko397de612008-03-17 08:55:44 +00005127 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00005128
Eric Andersen27f64e12002-06-23 04:24:25 +00005129#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005130 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005131#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005132 "Lock a virtual terminal. A password is required to unlock.\n" \
5133 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00005134 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00005135
Matthew Stoltenberg4803db52009-08-13 00:59:32 +02005136#define volname_trivial_usage \
5137 "[DEVICE]"
5138#define volname_full_usage "\n\n" \
5139 "Show CD volume name of the DEVICE (default /dev/cdrom)"
5140
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005141#define wall_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01005142 "[FILE]"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005143#define wall_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01005144 "Write content of FILE or stdin to all logged-in users"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005145#define wall_sample_usage \
5146 "echo foo | wall\n" \
5147 "wall ./mymessage"
5148
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005149#define watch_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01005150 "[-n SEC] [-t] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005151#define watch_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005152 "Run PROG periodically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005153 "\nOptions:" \
5154 "\n -n Loop period in seconds (default 2)" \
5155 "\n -t Don't print header" \
5156
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005157#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005158 "$ watch date\n" \
5159 "Mon Dec 17 10:31:40 GMT 2000\n" \
5160 "Mon Dec 17 10:31:42 GMT 2000\n" \
5161 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005162
Eric Andersen7e9276b2001-02-22 01:15:47 +00005163#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005164 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005165#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005166 "Periodically write to watchdog device DEV\n" \
5167 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005168 "\n -T N Reboot after N seconds if not reset (default 60)" \
5169 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00005170 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00005171 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005172 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005173
5174#define wc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005175 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005176#define wc_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01005177 "Print line, word, and byte counts for each FILE (or stdin),\n" \
5178 "and a total line if more than one FILE is specified\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005179 "\nOptions:" \
5180 "\n -c Print the byte counts" \
5181 "\n -l Print the newline counts" \
5182 "\n -L Print the length of the longest line" \
5183 "\n -w Print the word counts" \
5184
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005185#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005186 "$ wc /etc/passwd\n" \
5187 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005188
5189#define wget_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005190 IF_FEATURE_WGET_LONG_OPTIONS( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005191 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document FILE]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00005192 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005193 " [--no-check-certificate] [-U|--user-agent AGENT] URL" \
Denis Vlasenko03630782007-10-18 11:11:12 +00005194 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005195 IF_NOT_FEATURE_WGET_LONG_OPTIONS( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005196 "[-csq] [-O FILE] [-Y on/off] [-P DIR] [-U AGENT] URL" \
Denis Vlasenko03630782007-10-18 11:11:12 +00005197 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005198#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005199 "Retrieve files via HTTP or FTP\n" \
5200 "\nOptions:" \
5201 "\n -s Spider mode - only check file existence" \
5202 "\n -c Continue retrieval of aborted transfer" \
5203 "\n -q Quiet" \
5204 "\n -P Set directory prefix to DIR" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005205 "\n -O FILE Save to FILE ('-' for stdout)" \
5206 "\n -U STR Use STR for User-Agent header" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005207 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005208
5209#define which_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005210 "[COMMAND]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005211#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005212 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005213#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005214 "$ which login\n" \
5215 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00005216
Eric Andersen00a6a752002-04-26 23:53:10 +00005217#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00005218 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005219#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005220 "Show who is logged on\n" \
5221 "\nOptions:" \
5222 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005223
5224#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005225 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005226#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005227 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005228
5229#define xargs_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01005230 "[OPTIONS] [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005231#define xargs_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01005232 "Run PROG on every item given by stdin\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005233 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005234 IF_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005235 "\n -p Ask user whether to run each command") \
Denys Vlasenko07697852009-10-06 21:11:37 +02005236 "\n -r Don't run command if input is empty" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005237 IF_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005238 "\n -0 Input is separated by NUL characters") \
5239 "\n -t Print the command on stderr before execution" \
Denis Vlasenkoe82da4d2008-08-21 19:59:30 +00005240 "\n -e[STR] STR stops input processing" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005241 "\n -n N Pass no more than N args to PROG" \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005242 "\n -s N Pass command line of no more than N bytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005243 IF_FEATURE_XARGS_SUPPORT_TERMOPT( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005244 "\n -x Exit if size is exceeded") \
Denis Vlasenko397de612008-03-17 08:55:44 +00005245
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005246#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005247 "$ ls | xargs gzip\n" \
5248 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005249
5250#define yes_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005251 "[OPTIONS] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005252#define yes_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005253 "Repeatedly output a line with STRING, or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00005254
Eric Andersen7e9276b2001-02-22 01:15:47 +00005255#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005256 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005257#define zcat_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02005258 "Decompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00005259
Rob Landleyad8071f2005-04-30 03:49:37 +00005260#define zcip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005261 "[OPTIONS] IFACE SCRIPT"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005262#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005263 "Manage a ZeroConf IPv4 link-local address\n" \
5264 "\nOptions:" \
5265 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00005266 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005267 "\n -r 169.254.x.x Request this address first" \
5268 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00005269 "\n" \
5270 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
5271 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00005272
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00005273
5274#endif