blob: d53b867310879e078a14a4d509e66397df487658 [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
Denys Vlasenkoff027d62010-05-04 15:45:25 +0200159#define bootchartd_trivial_usage \
160 "start [PROG ARGS]|stop|init"
161#define bootchartd_full_usage "\n\n" \
162 "Create /var/log/bootchart.tgz with boot chart data\n" \
163 "\nOptions:" \
164 "\nstart: start background logging; with PROG, run PROG, then kill logging with USR1" \
165 "\nstop: send USR1 to all bootchartd processes" \
166 "\ninit: start background logging; stop when getty/xdm is seen (for init scripts)" \
167 "\nUnder PID 1: as init, then exec $bootchart_init, /init, /sbin/init" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000168
Bernhard Reutner-Fischerd27d9252008-01-13 15:23:27 +0000169#define brctl_trivial_usage \
170 "COMMAND [BRIDGE [INTERFACE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000171#define brctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200172 "Manage ethernet bridges\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000173 "\nCommands:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000174 IF_FEATURE_BRCTL_SHOW( \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000175 "\n show Show a list of bridges" \
176 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000177 "\n addbr BRIDGE Create BRIDGE" \
178 "\n delbr BRIDGE Delete BRIDGE" \
179 "\n addif BRIDGE IFACE Add IFACE to BRIDGE" \
180 "\n delif BRIDGE IFACE Delete IFACE from BRIDGE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000181 IF_FEATURE_BRCTL_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000182 "\n setageing BRIDGE TIME Set ageing time" \
183 "\n setfd BRIDGE TIME Set bridge forward delay" \
184 "\n sethello BRIDGE TIME Set hello time" \
185 "\n setmaxage BRIDGE TIME Set max message age" \
186 "\n setpathcost BRIDGE COST Set path cost" \
187 "\n setportprio BRIDGE PRIO Set port priority" \
188 "\n setbridgeprio BRIDGE PRIO Set bridge priority" \
Maciek Borzecki30ebd7b2010-03-23 05:18:38 +0100189 "\n stp BRIDGE [1/yes/on|0/no/off] STP on/off" \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000190 ) \
191
Glenn L McGrath24e28332001-10-05 03:48:57 +0000192#define bunzip2_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100193 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000194#define bunzip2_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100195 "Uncompress FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000196 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100197 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000198 "\n -f Force" \
Glenn L McGrath24e28332001-10-05 03:48:57 +0000199
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000200#define bzip2_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200201 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000202#define bzip2_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100203 "Compress FILEs (or stdin) with bzip2 algorithm\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000204 "\nOptions:" \
Bernhard Reutner-Fischerbaab3272010-02-14 11:11:47 +0100205 "\n -c Write to stdout" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000206 "\n -d Decompress" \
207 "\n -f Force" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000208 "\n -1..-9 Compression level" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000209
Rob Landley6130b9b2006-01-23 21:10:38 +0000210#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000211 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000212
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000213#define lzop_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200214 "[-cfvd123456789CF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000215#define lzop_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100216 " -c Write to stdout" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000217 "\n -f Force" \
218 "\n -v Verbose" \
219 "\n -d Decompress" \
220 "\n -F Don't store or verify checksum" \
221 "\n -C Also write checksum of compressed block" \
222 "\n -1..9 Compression level" \
223
224#define lzopcat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200225 "[-vCF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000226#define lzopcat_full_usage "\n\n" \
227 " -v Verbose" \
228 "\n -F Don't store or verify checksum" \
229
230#define unlzop_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200231 "[-cfvCF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000232#define unlzop_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100233 " -c Write to stdout" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000234 "\n -f Force" \
235 "\n -v Verbose" \
236 "\n -F Don't store or verify checksum" \
237
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000238#define bzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000239 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000240#define bzcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000241 "Uncompress to stdout"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000242
Rob Landleyc1d69902006-01-20 18:28:50 +0000243#define unlzma_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100244 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000245#define unlzma_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100246 "Uncompress FILE (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000247 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100248 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000249 "\n -f Force" \
Rob Landleyc1d69902006-01-20 18:28:50 +0000250
251#define lzmacat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000252 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000253#define lzmacat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000254 "Uncompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000255
Eric Andersenc98c0622001-12-06 15:16:43 +0000256#define cal_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100257 "[-jy] [[MONTH] YEAR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000258#define cal_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000259 "Display a calendar\n" \
260 "\nOptions:" \
261 "\n -j Use julian dates" \
262 "\n -y Display the entire year" \
Eric Andersenc98c0622001-12-06 15:16:43 +0000263
Eric Andersen7e9276b2001-02-22 01:15:47 +0000264#define cat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000265 "[-u] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000266#define cat_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +0200267 "Concatenate FILEs and print them to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000268 "\nOptions:" \
269 "\n -u Use unbuffered i/o (ignored)" \
270
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000271#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000272 "$ cat /proc/uptime\n" \
273 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000274
Rob Landley8abbee42006-05-31 19:36:04 +0000275#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000276 "[-etv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000277#define catv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000278 "Display nonprinting characters as ^x or M-x\n" \
279 "\nOptions:" \
280 "\n -e End each line with $" \
281 "\n -t Show tabs as ^I" \
282 "\n -v Don't use ^x or M-x escapes" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000283
284#define chat_trivial_usage \
285 "EXPECT [SEND [EXPECT [SEND...]]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000286#define chat_full_usage "\n\n" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000287 "Useful for interacting with a modem connected to stdin/stdout.\n" \
288 "A script consists of one or more \"expect-send\" pairs of strings,\n" \
289 "each pair is a pair of arguments. Example:\n" \
290 "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \
291
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000292#define chattr_trivial_usage \
Denys Vlasenko79ae5342010-01-06 12:27:18 +0100293 "[-R] [-+=AacDdijsStTu] [-v VERSION] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000294#define chattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000295 "Change file attributes on an ext2 fs\n" \
296 "\nModifiers:" \
297 "\n - Remove attributes" \
298 "\n + Add attributes" \
299 "\n = Set attributes" \
300 "\nAttributes:" \
301 "\n A Don't track atime" \
302 "\n a Append mode only" \
303 "\n c Enable compress" \
304 "\n D Write dir contents synchronously" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200305 "\n d Don't backup with dump" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000306 "\n i Cannot be modified (immutable)" \
307 "\n j Write all data to journal first" \
308 "\n s Zero disk storage when deleted" \
309 "\n S Write file contents synchronously" \
310 "\n t Disable tail-merging of partial blocks with other files" \
311 "\n u Allow file to be undeleted" \
312 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100313 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000314 "\n -v Set the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000315
Denis Vlasenko49622d72007-03-10 16:58:49 +0000316#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000317 "[OPTIONS] CONTEXT FILE..." \
318 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000319 IF_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000320 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
321 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000322#define chcon_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000323 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000324 IF_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000325 "\n -v,--verbose Verbose" \
326 "\n -c,--changes Report changes made" \
327 "\n -h,--no-dereference Affect symlinks instead of their targets" \
328 "\n -f,--silent,--quiet Suppress most error messages" \
329 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
330 "\n -u,--user=USER Set user/role/type/range in the target" \
331 "\n -r,--role=ROLE security context" \
332 "\n -t,--type=TYPE" \
333 "\n -l,--range=RANGE" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200334 "\n -R,--recursive Recurse" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000335 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000336 IF_NOT_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000337 "\n -v Verbose" \
338 "\n -c Report changes made" \
339 "\n -h Affect symlinks instead of their targets" \
340 "\n -f Suppress most error messages" \
341 "\n -u USER Set user/role/type/range in the target security context" \
342 "\n -r ROLE" \
343 "\n -t TYPE" \
344 "\n -l RNG" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200345 "\n -R Recurse" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000346 )
347
Eric Andersen7e9276b2001-02-22 01:15:47 +0000348#define chmod_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000349 "[-R"IF_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000350#define chmod_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000351 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000352 "symbols +-= and one or more of the letters rwxst\n" \
353 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200354 "\n -R Recurse" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000355 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000356 "\n -c List changed files" \
357 "\n -v List all files" \
358 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000359 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000360#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000361 "$ ls -l /tmp/foo\n" \
362 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
363 "$ chmod u+x /tmp/foo\n" \
364 "$ ls -l /tmp/foo\n" \
365 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
366 "$ chmod 444 /tmp/foo\n" \
367 "$ ls -l /tmp/foo\n" \
368 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000369
Denis Vlasenko081ef792007-03-17 16:38:21 +0000370#define chgrp_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000371 "[-RhLHP"IF_DESKTOP("cvf")"]... GROUP FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000372#define chgrp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000373 "Change the group membership of each FILE to GROUP\n" \
374 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200375 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000376 "\n -h Affect symlinks instead of symlink targets" \
377 "\n -L Traverse all symlinks to directories" \
378 "\n -H Traverse symlinks on command line only" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200379 "\n -P Don't traverse symlinks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000380 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000381 "\n -c List changed files" \
382 "\n -v Verbose" \
383 "\n -f Hide errors" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000384 )
385#define chgrp_example_usage \
386 "$ ls -l /tmp/foo\n" \
387 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
388 "$ chgrp root /tmp/foo\n" \
389 "$ ls -l /tmp/foo\n" \
390 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
391
Eric Andersen7e9276b2001-02-22 01:15:47 +0000392#define chown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000393 "[-RhLHP"IF_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000394#define chown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000395 "Change the owner and/or group of each FILE to OWNER and/or GROUP\n" \
396 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200397 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000398 "\n -h Affect symlinks instead of symlink targets" \
399 "\n -L Traverse all symlinks to directories" \
400 "\n -H Traverse symlinks on command line only" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200401 "\n -P Don't traverse symlinks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000402 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000403 "\n -c List changed files" \
404 "\n -v List all files" \
405 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000406 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000407#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000408 "$ ls -l /tmp/foo\n" \
409 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
410 "$ chown root /tmp/foo\n" \
411 "$ ls -l /tmp/foo\n" \
412 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
413 "$ chown root.root /tmp/foo\n" \
414 "ls -l /tmp/foo\n" \
415 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000416
Denis Vlasenkofe544582006-10-03 15:57:40 +0000417#define chpst_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000418 "[-vP012] [-u USER[:GRP]] [-U USER[:GRP]] [-e DIR]\n" \
419 " [-/ DIR] [-n NICE] [-m BYTES] [-d BYTES] [-o N]\n" \
420 " [-p N] [-f BYTES] [-c BYTES] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000421#define chpst_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000422 "Change the process state and run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000423 "\nOptions:" \
424 "\n -u USER[:GRP] Set uid and gid" \
425 "\n -U USER[:GRP] Set $UID and $GID in environment" \
426 "\n -e DIR Set environment variables as specified by files" \
427 "\n in DIR: file=1st_line_of_file" \
428 "\n -/ DIR Chroot to DIR" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000429 "\n -n NICE Add NICE to nice value" \
430 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000431 "\n -d BYTES Limit data segment" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000432 "\n -o N Limit number of open files per process" \
433 "\n -p N Limit number of processes per uid" \
434 "\n -f BYTES Limit output file sizes" \
435 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000436 "\n -v Verbose" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000437 "\n -P Create new process group" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100438 "\n -0 Close stdin" \
439 "\n -1 Close stdout" \
440 "\n -2 Close stderr" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000441
Denis Vlasenkofe544582006-10-03 15:57:40 +0000442#define setuidgid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100443 "USER PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000444#define setuidgid_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100445 "Set uid and gid to USER's uid and gid, removing all supplementary\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000446 "groups and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000447#define envuidgid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100448 "USER PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000449#define envuidgid_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100450 "Set $UID to USER's uid and $GID to USER's gid and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000451#define envdir_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100452 "DIR PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000453#define envdir_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000454 "Set various environment variables as specified by files\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000455 "in the directory dir and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000456#define softlimit_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000457 "[-a BYTES] [-m BYTES] [-d BYTES] [-s BYTES] [-l BYTES]\n" \
458 " [-f BYTES] [-c BYTES] [-r BYTES] [-o N] [-p N] [-t N]\n" \
459 " PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000460#define softlimit_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000461 "Set soft resource limits, then run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000462 "\nOptions:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000463 "\n -a BYTES Limit total size of all segments" \
464 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES -a BYTES" \
465 "\n -d BYTES Limit data segment" \
466 "\n -s BYTES Limit stack segment" \
467 "\n -l BYTES Limit locked memory size" \
468 "\n -o N Limit number of open files per process" \
469 "\n -p N Limit number of processes per uid" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000470 "\nOptions controlling file sizes:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000471 "\n -f BYTES Limit output file sizes" \
472 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000473 "\nEfficiency opts:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000474 "\n -r BYTES Limit resident set size" \
475 "\n -t N Limit CPU time, process receives" \
476 "\n a SIGXCPU after N seconds" \
Denis Vlasenkofe544582006-10-03 15:57:40 +0000477
Eric Andersen7e9276b2001-02-22 01:15:47 +0000478#define chroot_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100479 "NEWROOT [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000480#define chroot_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200481 "Run PROG with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000482#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000483 "$ ls -l /bin/ls\n" \
484 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
485 "# mount /dev/hdc1 /mnt -t minix\n" \
486 "# chroot /mnt\n" \
487 "# ls -l /bin/ls\n" \
488 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000489
Eric Andersen7e9276b2001-02-22 01:15:47 +0000490#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000491 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000492#define chvt_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000493 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000494
Rob Landley856489b2006-04-18 20:57:28 +0000495#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000496 "FILES..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000497#define cksum_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000498 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000499
Eric Andersen7e9276b2001-02-22 01:15:47 +0000500#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000501 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000502#define clear_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000503 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000504
Eric Andersen7e9276b2001-02-22 01:15:47 +0000505#define cmp_trivial_usage \
Denys Vlasenko65ebbc52010-05-09 04:38:22 +0200506 "[-l] [-s] FILE1 [FILE2" IF_DESKTOP(" [SKIP1 [SKIP2]]") "]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000507#define cmp_full_usage "\n\n" \
Denys Vlasenko65ebbc52010-05-09 04:38:22 +0200508 "Compare FILE1 with FILE2 (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000509 "\nOptions:" \
510 "\n -l Write the byte numbers (decimal) and values (octal)" \
511 "\n for all differing bytes" \
512 "\n -s Quiet" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000513
Rob Landley2acfd7b2005-05-11 23:12:49 +0000514#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000515 "[-123] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000516#define comm_full_usage "\n\n" \
Denys Vlasenko65ebbc52010-05-09 04:38:22 +0200517 "Compare FILE1 with FILE2\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000518 "\nOptions:" \
519 "\n -1 Suppress lines unique to FILE1" \
520 "\n -2 Suppress lines unique to FILE2" \
521 "\n -3 Suppress lines common to both files" \
Rob Landley2acfd7b2005-05-11 23:12:49 +0000522
Paul Fox79c142d2005-08-01 16:04:40 +0000523#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000524 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000525#define bbconfig_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000526 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000527
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000528#define chrt_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100529 "[OPTIONS] [PRIO] [PID | PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000530#define chrt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000531 "Manipulate real-time attributes of a process\n" \
532 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100533 "\n -p Operate on PID" \
534 "\n -r Set SCHED_RR scheduling" \
535 "\n -f Set SCHED_FIFO scheduling" \
536 "\n -o Set SCHED_OTHER scheduling" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000537 "\n -m Show min and max priorities" \
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000538
539#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000540 "$ chrt -r 4 sleep 900; x=$!\n" \
541 "$ chrt -f -p 3 $x\n" \
542 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000543
Eric Andersen7e9276b2001-02-22 01:15:47 +0000544#define cp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200545 "[OPTIONS] SOURCE DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000546#define cp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000547 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY\n" \
548 "\nOptions:" \
549 "\n -a Same as -dpR" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000550 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000551 "\n -c Preserve security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000552 ) \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100553 "\n -R,-r Recurse" \
554 "\n -d,-P Preserve symlinks (default if -R)" \
555 "\n -L Follow all symlinks" \
556 "\n -H Follow symlinks on command line" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000557 "\n -p Preserve file attributes if possible" \
558 "\n -f Force overwrite" \
559 "\n -i Prompt before overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000560 "\n -l,-s Create (sym)links" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000561
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000562#define cpio_trivial_usage \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100563 "[-dmvu] [-F FILE]" IF_FEATURE_CPIO_O(" [-H newc]") \
564 " [-ti"IF_FEATURE_CPIO_O("o")"]" IF_FEATURE_CPIO_P(" [-p DIR]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000565#define cpio_full_usage "\n\n" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000566 "Extract or list files from a cpio archive" \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100567 IF_FEATURE_CPIO_O(", or" \
568 "\ncreate an archive" IF_FEATURE_CPIO_P(" (-o) or copy files (-p)") \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100569 " using file list on stdin" \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100570 ) \
571 "\n" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000572 "\nMain operation mode:" \
573 "\n -t List" \
574 "\n -i Extract" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000575 IF_FEATURE_CPIO_O( \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100576 "\n -o Create (requires -H newc)" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000577 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000578 IF_FEATURE_CPIO_P( \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100579 "\n -p DIR Copy files to DIR" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000580 ) \
581 "\nOptions:" \
582 "\n -d Make leading directories" \
583 "\n -m Preserve mtime" \
584 "\n -v Verbose" \
585 "\n -u Overwrite" \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100586 "\n -F FILE Input (-t,-i,-p) or output (-o) file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000587 IF_FEATURE_CPIO_O( \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100588 "\n -H newc Archive format" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000589 ) \
Tim Riker7b253f82003-12-28 05:02:40 +0000590
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000591#define crond_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000592 "-fbS -l N " IF_FEATURE_CROND_D("-d N ") "-L LOGFILE -c DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000593#define crond_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000594 " -f Foreground" \
595 "\n -b Background (default)" \
596 "\n -S Log to syslog (default)" \
597 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000598 IF_FEATURE_CROND_D( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000599 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000600 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000601 "\n -L Log to file" \
602 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000603
604#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000605 "[-c DIR] [-u USER] [-ler]|[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000606#define crontab_full_usage "\n\n" \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000607 " -c Crontab directory" \
608 "\n -u User" \
609 "\n -l List crontab" \
610 "\n -e Edit crontab" \
611 "\n -r Delete crontab" \
612 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000613
Denis Vlasenko2211d522008-11-10 18:52:35 +0000614#define cryptpw_trivial_usage \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000615 "[OPTIONS] [PASSWORD] [SALT]"
616/* We do support -s, we just don't mention it */
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000617#define cryptpw_full_usage "\n\n" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000618 "Crypt the PASSWORD using crypt(3)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000619 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200620 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100621 "\n -P,--password-fd=N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000622/* "\n -s,--stdin Use stdin; like -P0" */ \
623 "\n -m,--method=TYPE Encryption method TYPE" \
624 "\n -S,--salt=SALT" \
625 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200626 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100627 "\n -P N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000628/* "\n -s Use stdin; like -P0" */ \
629 "\n -m TYPE Encryption method TYPE" \
630 "\n -S SALT" \
631 ) \
632
633/* mkpasswd is an alias to cryptpw */
634
635#define mkpasswd_trivial_usage \
636 "[OPTIONS] [PASSWORD] [SALT]"
637/* We do support -s, we just don't mention it */
638#define mkpasswd_full_usage "\n\n" \
639 "Crypt the PASSWORD using crypt(3)\n" \
640 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200641 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100642 "\n -P,--password-fd=N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000643/* "\n -s,--stdin Use stdin; like -P0" */ \
644 "\n -m,--method=TYPE Encryption method TYPE" \
645 "\n -S,--salt=SALT" \
646 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200647 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100648 "\n -P N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000649/* "\n -s Use stdin; like -P0" */ \
650 "\n -m TYPE Encryption method TYPE" \
651 "\n -S SALT" \
652 ) \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000653
Denys Vlasenkob367bb22010-05-15 20:43:07 +0200654#define cttyhack_trivial_usage \
655 "PROG ARGS"
656#define cttyhack_full_usage "\n\n" \
657 "Give PROG a controlling tty if possible." \
658 "\nExample for /etc/inittab (for busybox init):" \
659 "\n ::respawn:/bin/cttyhack /bin/sh" \
660 "\nGiving controlling tty to shell running with PID 1:" \
661 "\n $ exec cttyhack sh" \
Denys Vlasenkoef215552010-05-17 09:55:13 +0200662 "\nStarting interactive shell from boot shell script:" \
Denys Vlasenkob367bb22010-05-15 20:43:07 +0200663 "\n setsid cttyhack sh" \
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000664
Eric Andersen7e9276b2001-02-22 01:15:47 +0000665#define cut_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200666 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000667#define cut_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100668 "Print selected fields from each input FILE to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000669 "\nOptions:" \
670 "\n -b LIST Output only bytes from LIST" \
671 "\n -c LIST Output only characters from LIST" \
672 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
673 "\n -s Output only the lines containing delimiter" \
674 "\n -f N Print only these fields" \
675 "\n -n Ignored" \
676
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000677#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000678 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
679 "Hello\n" \
680 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
681 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000682
Eric Andersen7e9276b2001-02-22 01:15:47 +0000683#define date_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200684 "[OPTIONS] [+FMT] [TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000685#define date_full_usage "\n\n" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000686 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000687 "\nOptions:" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200688 IF_NOT_LONG_OPTS( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200689 "\n [-s] TIME Set time to TIME" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000690 "\n -u Work in UTC (don't convert to local time)" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200691 "\n -R Output RFC-2822 compliant date string" \
692 ) IF_LONG_OPTS( \
693 "\n [-s,--set] TIME Set time to TIME" \
Denys Vlasenko50be9632009-10-23 16:25:20 +0200694 "\n -u,--utc Work in UTC (don't convert to local time)" \
695 "\n -R,--rfc-2822 Output RFC-2822 compliant date string" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200696 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000697 IF_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000698 "\n -I[SPEC] Output ISO-8601 compliant date string" \
699 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000700 "\n 'hours', 'minutes', or 'seconds' for date and" \
701 "\n time to the indicated precision" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200702 ) IF_NOT_LONG_OPTS( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000703 "\n -r FILE Display last modification time of FILE" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200704 "\n -d TIME Display TIME, not 'now'" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200705 ) IF_LONG_OPTS( \
Denys Vlasenko50be9632009-10-23 16:25:20 +0200706 "\n -r,--reference FILE Display last modification time of FILE" \
707 "\n -d,--date TIME Display TIME, not 'now'" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200708 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000709 IF_FEATURE_DATE_ISOFMT( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200710 "\n -D FMT Use FMT for -d TIME conversion" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000711 ) \
712 "\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +0200713 "\nRecognized TIME formats:" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000714 "\n hh:mm[:ss]" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000715 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000716 "\n YYYY-MM-DD hh:mm[:ss]" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200717 "\n [[[[[YY]YY]MM]DD]hh]mm[.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000718
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000719#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000720 "$ date\n" \
721 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000722
Eric Andersen7e9276b2001-02-22 01:15:47 +0000723#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000724 "expression..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000725#define dc_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +0000726 "Tiny RPN calculator. Operations:\n" \
727 "+, add, -, sub, *, mul, /, div, %, mod, **, exp, and, or, not, eor,\n" \
728 "p - print top of the stack (without altering the stack),\n" \
729 "f - print entire stack, o - pop the value and set output radix\n" \
730 "(value must be 10 or 16).\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100731 "Examples: 'dc 2 2 add' -> 4, 'dc 8 8 * 2 2 + /' -> 16\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000732
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000733#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000734 "$ dc 2 2 + p\n" \
735 "4\n" \
736 "$ dc 8 8 \\* 2 2 + / p\n" \
737 "16\n" \
738 "$ dc 0 1 and p\n" \
739 "0\n" \
740 "$ dc 0 1 or p\n" \
741 "1\n" \
742 "$ echo 72 9 div 8 mul p | dc\n" \
743 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000744
Eric Andersen7e9276b2001-02-22 01:15:47 +0000745#define dd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000746 "[if=FILE] [of=FILE] " IF_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
747 " [seek=N]" IF_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000748#define dd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000749 "Copy a file with converting and formatting\n" \
750 "\nOptions:" \
751 "\n if=FILE Read from FILE instead of stdin" \
752 "\n of=FILE Write to FILE instead of stdout" \
753 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000754 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000755 "\n ibs=N Read N bytes at a time" \
756 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000757 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000758 "\n obs=N Write N bytes at a time" \
759 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000760 "\n count=N Copy only N input blocks" \
761 "\n skip=N Skip N input blocks" \
762 "\n seek=N Skip N output blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000763 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000764 "\n conv=notrunc Don't truncate output file" \
765 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000766 "\n conv=sync Pad blocks with zeros" \
767 "\n conv=fsync Physically write data out before finishing" \
768 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000769 "\n" \
770 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
771 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
772
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000773#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000774 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
775 "4+0 records in\n" \
776 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000777
Eric Andersen7e9276b2001-02-22 01:15:47 +0000778#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000779 "[N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000780#define deallocvt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000781 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000782
Eric Andersenf349e972001-08-21 16:18:59 +0000783#define delgroup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000784 IF_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000785#define delgroup_full_usage "\n\n" \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000786 "Delete group GROUP from the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000787 IF_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000788
789#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000790 "USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000791#define deluser_full_usage "\n\n" \
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000792 "Delete USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000793
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000794#define depmod_trivial_usage NOUSAGE_STR
795#define depmod_full_usage ""
Bernhard Reutner-Fischer55e547e2008-05-26 12:01:49 +0000796
Denis Vlasenkoc94fa562008-10-26 11:08:14 +0000797#define devmem_trivial_usage \
798 "ADDRESS [WIDTH [VALUE]]"
799
800#define devmem_full_usage "\n\n" \
801 "Read/write from physical address\n" \
802 "\n ADDRESS Address to act upon" \
803 "\n WIDTH Width (8/16/...)" \
804 "\n VALUE Data to be written" \
805
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000806#define devfsd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000807 "mntpnt [-v]" IF_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000808#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000809 "Manage devfs permissions and old device name symlinks\n" \
810 "\nOptions:" \
811 "\n mntpnt The mount point where devfs is mounted" \
812 "\n -v Print the protocol version numbers for devfsd" \
813 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000814 IF_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000815 "\n -fg Run in foreground" \
816 "\n -np Exit after parsing the configuration file" \
817 "\n and processing synthetic REGISTER events," \
Denys Vlasenko07697852009-10-06 21:11:37 +0200818 "\n don't poll for events" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000819 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000820
Eric Andersen7e9276b2001-02-22 01:15:47 +0000821#define df_trivial_usage \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000822 "[-Pk" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000823 IF_FEATURE_HUMAN_READABLE("mh") \
824 IF_FEATURE_DF_FANCY("ai] [-B SIZE") \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100825 "] [FILESYSTEM]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000826#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000827 "Print filesystem usage statistics\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000828 "\nOptions:" \
829 "\n -P POSIX output format" \
830 "\n -k 1024-byte blocks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000831 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000832 "\n -m 1M-byte blocks" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000833 "\n -h Human readable (e.g. 1K 243M 2G)" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000834 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000835 IF_FEATURE_DF_FANCY( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000836 "\n -a Show all filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000837 "\n -i Inodes" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000838 "\n -B SIZE Blocksize" \
839 ) \
840
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000841#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000842 "$ df\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000843 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000844 "/dev/sda3 8690864 8553540 137324 98% /\n" \
845 "/dev/sda1 64216 36364 27852 57% /boot\n" \
846 "$ df /dev/sda3\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000847 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
848 "/dev/sda3 8690864 8553540 137324 98% /\n" \
849 "$ POSIXLY_CORRECT=sure df /dev/sda3\n" \
850 "Filesystem 512B-blocks Used Available Use% Mounted on\n" \
851 "/dev/sda3 17381728 17107080 274648 98% /\n" \
852 "$ POSIXLY_CORRECT=yep df -P /dev/sda3\n" \
853 "Filesystem 512-blocks Used Available Capacity Mounted on\n" \
854 "/dev/sda3 17381728 17107080 274648 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000855
Denis Vlasenko736230e2006-11-20 19:40:36 +0000856#define dhcprelay_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100857 "CLIENT_IFACE[,CLIENT_IFACE2]... SERVER_IFACE [SERVER_IP]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000858#define dhcprelay_full_usage "\n\n" \
Denis Vlasenkoe8a79682009-04-13 03:33:46 +0000859 "Relay DHCP requests between clients and server" \
Denis Vlasenko736230e2006-11-20 19:40:36 +0000860
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000861#define diff_trivial_usage \
Matheus Izvekovfe1ce2e2010-01-18 16:07:07 -0200862 "[-abBdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000863#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000864 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000865 "This implementation supports unified diffs only.\n" \
866 "\nOptions:" \
867 "\n -a Treat all files as text" \
868 "\n -b Ignore changes in the amount of whitespace" \
Matheus Izvekovfe1ce2e2010-01-18 16:07:07 -0200869 "\n -B Ignore changes whose lines are all blank" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000870 "\n -d Try hard to find a smaller set of changes" \
871 "\n -i Ignore case differences" \
872 "\n -L Use LABEL instead of the filename in the unified header" \
873 "\n -N Treat absent files as empty" \
874 "\n -q Output only whether files differ" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100875 "\n -r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000876 "\n -S Start with FILE when comparing directories" \
877 "\n -T Make tabs line up by prefixing a tab when necessary" \
878 "\n -s Report when two files are the same" \
879 "\n -t Expand tabs to spaces in output" \
880 "\n -U Output LINES lines of context" \
881 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000882
Eric Andersen7e9276b2001-02-22 01:15:47 +0000883#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000884 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000885#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000886 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000887#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000888 "$ dirname /tmp/foo\n" \
889 "/tmp\n" \
890 "$ dirname /tmp/foo/\n" \
891 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000892
Eric Andersen7e9276b2001-02-22 01:15:47 +0000893#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000894 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000895#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000896 "Print or control the kernel ring buffer\n" \
897 "\nOptions:" \
898 "\n -c Clear ring buffer after printing" \
899 "\n -n LEVEL Set console logging level" \
900 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000901
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000902#define dnsd_trivial_usage \
Denys Vlasenko343dfd72010-02-07 02:45:03 +0100903 "[-dvs] [-c CONFFILE] [-t TTL_SEC] [-p PORT] [-i ADDR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000904#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000905 "Small static DNS server daemon\n" \
906 "\nOptions:" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +0100907 "\n -c FILE Config file" \
908 "\n -t SEC TTL" \
909 "\n -p PORT Listen on PORT" \
910 "\n -i ADDR Listen on ADDR" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000911 "\n -d Daemonize" \
Denys Vlasenko343dfd72010-02-07 02:45:03 +0100912 "\n -v Verbose" \
913 "\n -s Send successful replies only. Use this if you want" \
914 "\n to use /etc/resolv.conf with two nameserver lines:" \
915 "\n nameserver DNSD_SERVER" \
916 "\n nameserver NORNAL_DNS_SERVER" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000917
Eric Andersen7e9276b2001-02-22 01:15:47 +0000918#define dos2unix_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +0200919 "[OPTIONS] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000920#define dos2unix_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200921 "Convert FILE in-place from DOS to Unix format.\n" \
922 "When no file is given, use stdin/stdout.\n" \
923 "\nOptions:" \
924 "\n -u dos2unix" \
925 "\n -d unix2dos" \
926
927#define unix2dos_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +0200928 "[OPTIONS] [FILE]"
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200929#define unix2dos_full_usage "\n\n" \
930 "Convert FILE in-place from Unix to DOS format.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000931 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000932 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000933 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000934 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000935
Eric Andersen7e9276b2001-02-22 01:15:47 +0000936#define dpkg_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100937 "[-ilCPru] [-F OPT] PACKAGE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000938#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000939 "Install, remove and manage Debian packages\n" \
940 "\nOptions:" \
Kim B. Heino3d43aed2010-03-29 14:18:27 +0200941 IF_LONG_OPTS( \
942 "\n -i,--install Install the package" \
943 "\n -l,--list List of installed packages" \
944 "\n --configure Configure an unpackaged package" \
945 "\n -P,--purge Purge all files of a package" \
946 "\n -r,--remove Remove all but the configuration files for a package" \
947 "\n --unpack Unpack a package, but don't configure it" \
948 "\n --force-depends Ignore dependency problems" \
949 "\n --force-confnew Overwrite existing config files when installing" \
950 "\n --force-confold Keep old config files when installing" \
951 ) \
952 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000953 "\n -i Install the package" \
954 "\n -l List of installed packages" \
955 "\n -C Configure an unpackaged package" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000956 "\n -P Purge all files of a package" \
957 "\n -r Remove all but the configuration files for a package" \
958 "\n -u Unpack a package, but don't configure it" \
Kim B. Heino3d43aed2010-03-29 14:18:27 +0200959 "\n -F depends Ignore dependency problems" \
960 "\n -F confnew Overwrite existing config files when installing" \
961 "\n -F confold Keep old config files when installing" \
962 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000963
Eric Andersen7e9276b2001-02-22 01:15:47 +0000964#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000965 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000966#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000967 "Perform actions on Debian packages (.debs)\n" \
968 "\nOptions:" \
969 "\n -c List contents of filesystem tree" \
970 "\n -e Extract control files to [argument] directory" \
971 "\n -f Display control field name starting with [argument]" \
972 "\n -x Extract packages filesystem tree to directory" \
973 "\n -X Verbose extract" \
974
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000975#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000976 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000977
Eric Andersen7e9276b2001-02-22 01:15:47 +0000978#define du_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000979 "[-aHLdclsx" IF_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000980#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000981 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000982 "Disk space is printed in units of " \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000983 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
984 IF_NOT_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000985 " bytes.\n" \
986 "\nOptions:" \
987 "\n -a Show file sizes too" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000988 "\n -L Follow all symlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100989 "\n -H Follow symlinks on command line" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000990 "\n -d N Limit output to directories (and files with -a) of depth < N" \
991 "\n -c Show grand total" \
992 "\n -l Count sizes many times if hard linked" \
993 "\n -s Display only a total for each argument" \
994 "\n -x Skip directories on different filesystems" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000995 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000996 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
997 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000998 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000999 "\n -k Sizes in kilobytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001000 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001001
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001002#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001003 "$ du\n" \
1004 "16 ./CVS\n" \
1005 "12 ./kernel-patches/CVS\n" \
1006 "80 ./kernel-patches\n" \
1007 "12 ./tests/CVS\n" \
1008 "36 ./tests\n" \
1009 "12 ./scripts/CVS\n" \
1010 "16 ./scripts\n" \
1011 "12 ./docs/CVS\n" \
1012 "104 ./docs\n" \
1013 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001014
Eric Andersen7e9276b2001-02-22 01:15:47 +00001015#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001016 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001017#define dumpkmap_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001018 "Print a binary keyboard translation table to stdout"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001019#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001020 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001021
Russ Dill61fb4892002-10-14 21:41:28 +00001022#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001023 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001024#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001025 "Display DHCP leases granted by udhcpd\n" \
1026 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001027 IF_LONG_OPTS( \
Denys Vlasenkoc8a2ab12010-03-28 00:02:20 +01001028 "\n -f,--file=FILE Lease file" \
1029 "\n -r,--remaining Show remaining time" \
1030 "\n -a,--absolute Show expiration time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001031 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001032 IF_NOT_LONG_OPTS( \
Denys Vlasenkoc8a2ab12010-03-28 00:02:20 +01001033 "\n -f FILE Lease file" \
1034 "\n -r Show remaining time" \
1035 "\n -a Show expiration time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001036 )
Russ Dill61fb4892002-10-14 21:41:28 +00001037
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001038/*
Mike Frysinger51a43b42005-09-24 07:11:16 +00001039#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001040 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
1041 "[-I inode_buffer_blocks] [-P process_inode_size] " \
1042 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
1043 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001044#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001045 "Check ext2/ext3 file system\n" \
1046 "\nOptions:" \
1047 "\n -p Automatic repair (no questions)" \
1048 "\n -n Make no changes to the filesystem" \
1049 "\n -y Assume 'yes' to all questions" \
1050 "\n -c Check for bad blocks and add them to the badblock list" \
1051 "\n -f Force checking even if filesystem is marked clean" \
1052 "\n -v Verbose" \
1053 "\n -b superblock Use alternative superblock" \
1054 "\n -B blocksize Force blocksize when looking for superblock" \
1055 "\n -j journal Set location of the external journal" \
1056 "\n -l file Add to badblocks list" \
1057 "\n -L file Set badblocks list" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001058*/
Mike Frysinger51a43b42005-09-24 07:11:16 +00001059
Eric Andersen7e9276b2001-02-22 01:15:47 +00001060#define echo_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001061 IF_FEATURE_FANCY_ECHO("[-neE] ") "[ARG]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001062#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001063 "Print the specified ARGs to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001064 IF_FEATURE_FANCY_ECHO( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001065 "\nOptions:" \
1066 "\n -n Suppress trailing newline" \
Denys Vlasenkoc8a2ab12010-03-28 00:02:20 +01001067 "\n -e Interpret backslash escapes (i.e., \\t=tab)" \
1068 "\n -E Don't interpret backslash escapes (default)" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001069 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001070#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001071 "$ echo \"Erik is cool\"\n" \
1072 "Erik is cool\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001073 IF_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001074 "Erik\n" \
1075 "is\n" \
1076 "cool\n" \
1077 "$ echo \"Erik\\nis\\ncool\"\n" \
1078 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001079
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001080#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001081 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001082#define eject_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001083 "Eject DEVICE or default /dev/cdrom\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001084 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001085 IF_FEATURE_EJECT_SCSI( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001086 "\n -s SCSI device" \
1087 ) \
1088 "\n -t Close tray" \
1089 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001090
Rob Landley3b890392006-05-04 20:56:43 +00001091#define ed_trivial_usage ""
1092#define ed_full_usage ""
1093
Eric Andersen84e229c2001-03-29 22:48:33 +00001094#define env_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001095 "[-iu] [-] [name=value]... [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001096#define env_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001097 "Print the current environment or run PROG after setting up\n" \
1098 "the specified environment\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001099 "\nOptions:" \
1100 "\n -, -i Start with an empty environment" \
1101 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +00001102
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001103#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001104 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001105#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001106 "Send a magic packet to wake up sleeping machines.\n" \
1107 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001108 "a hostname with a known 'ethers' entry.\n" \
1109 "\nOptions:" \
1110 "\n -b Send wake-up packet to the broadcast address" \
1111 "\n -i iface Interface to use (default eth0)" \
1112 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001113
Denis Vlasenko3952f202007-08-13 14:10:24 +00001114#define expand_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01001115 "[-i] [-t N] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001116#define expand_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001117 "Convert tabs to spaces, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001118 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001119 IF_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001120 "\n -i,--initial Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001121 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001122 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001123 IF_NOT_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001124 "\n -i Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001125 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001126 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00001127
Eric Andersen7e9276b2001-02-22 01:15:47 +00001128#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001129 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001130#define expr_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001131 "Print the value of EXPRESSION to stdout\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001132 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001133 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001134 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
1135 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1136 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1137 " ARG1 <= ARG2\n" \
1138 " ARG1 = ARG2\n" \
1139 " ARG1 != ARG2\n" \
1140 " ARG1 >= ARG2\n" \
1141 " ARG1 > ARG2\n" \
1142 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1143 " ARG1 - ARG2\n" \
1144 " ARG1 * ARG2\n" \
1145 " ARG1 / ARG2\n" \
1146 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001147 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1148 " match STRING REGEXP Same as STRING : REGEXP\n" \
1149 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1150 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1151 " length STRING Length of STRING\n" \
1152 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001153 " it is a keyword like 'match' or an\n" \
1154 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001155 " (EXPRESSION) Value of EXPRESSION\n" \
1156 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001157 "Beware that many operators need to be escaped or quoted for shells.\n" \
1158 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001159 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001160 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1161 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001162
Mike Frysingerfa69f112005-04-17 07:24:19 +00001163#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001164 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001165#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001166 "Provide fake ident (auth) service\n" \
1167 "\nOptions:" \
1168 "\n -f Run in foreground" \
1169 "\n -i Inetd mode" \
1170 "\n -w Inetd 'wait' mode" \
1171 "\n -b ADDR Bind to specified address" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001172 "\n STRING Ident answer string (default: nobody)" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001173
Eric Andersen7e9276b2001-02-22 01:15:47 +00001174#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001175 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001176#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001177 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001178
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001179#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001180 "$ false\n" \
1181 "$ echo $?\n" \
1182 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001183
Denys Vlasenkoff027d62010-05-04 15:45:25 +02001184#define fbsplash_trivial_usage \
1185 "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
1186#define fbsplash_full_usage "\n\n" \
1187 "Options:" \
1188 "\n -s Image" \
1189 "\n -c Hide cursor" \
1190 "\n -d Framebuffer device (default /dev/fb0)" \
1191 "\n -i Config file (var=value):" \
1192 "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT" \
1193 "\n BAR_R,BAR_G,BAR_B" \
1194 "\n -f Control pipe (else exit after drawing image)" \
1195 "\n commands: 'NN' (% for progress bar) or 'exit'" \
1196
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001197#define fbset_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001198 "[OPTIONS] [MODE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001199#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001200 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001201
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001202#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001203 "$ fbset\n" \
1204 "mode \"1024x768-76\"\n" \
1205 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1206 " geometry 1024 768 1024 768 16\n" \
1207 " timings 12714 128 32 16 4 128 4\n" \
1208 " accel false\n" \
1209 " rgba 5/11,6/5,5/0,0/0\n" \
1210 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001211
Eric Andersen7e9276b2001-02-22 01:15:47 +00001212#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001213 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001214#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001215 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001216
Eric Andersen01c3d402003-07-05 07:51:31 +00001217#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001218 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001219#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001220 "Format floppy disk\n" \
1221 "\nOptions:" \
1222 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001223
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001224/* Looks like someone forgot to add this to config system */
1225#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1226# define ENABLE_FEATURE_FDISK_BLKSIZE 0
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001227# define IF_FEATURE_FDISK_BLKSIZE(a)
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001228#endif
1229
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001230#define fdisk_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001231 "[-ul" IF_FEATURE_FDISK_BLKSIZE("s") "] " \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001232 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001233#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001234 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001235 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001236 "\n -u Start and End are in sectors (instead of cylinders)" \
1237 "\n -l Show partition table for each DISK, then exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001238 IF_FEATURE_FDISK_BLKSIZE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001239 "\n -s Show partition sizes in kb for each DISK, then exit" \
1240 ) \
1241 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1242 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
Denys Vlasenko37bc1eb2010-04-06 00:04:08 +02001243 "\n -H HEADS" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001244 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001245
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001246#define blkid_trivial_usage \
1247 ""
1248#define blkid_full_usage "\n\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02001249 "Print UUIDs of all filesystems"
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001250
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001251#define findfs_trivial_usage \
1252 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001253#define findfs_full_usage "\n\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02001254 "Find a filesystem device based on a label or UUID"
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001255#define findfs_example_usage \
1256 "$ findfs LABEL=MyDevice"
1257
Eric Andersen7e9276b2001-02-22 01:15:47 +00001258#define find_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001259 "[PATH]... [EXPRESSION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001260#define find_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001261 "Search for files. The default PATH is the current directory,\n" \
1262 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001263 "\nEXPRESSION may consist of:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001264 "\n -follow Follow symlinks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001265 IF_FEATURE_FIND_XDEV( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001266 "\n -xdev Don't descend directories on other filesystems") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001267 IF_FEATURE_FIND_MAXDEPTH( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001268 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1269 "\n tests/actions to command line arguments only") \
Denys Vlasenko07697852009-10-06 21:11:37 +02001270 "\n -mindepth N Don't act on first N levels" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001271 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001272 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001273 IF_FEATURE_FIND_PATH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001274 "\n -path PATTERN Path matches PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001275 IF_FEATURE_FIND_REGEX( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001276 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001277 IF_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001278 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001279 IF_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001280 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001281 "\n or exactly NNN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001282 IF_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001283 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001284 "\n or exactly N days") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001285 IF_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001286 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001287 "\n or exactly N minutes") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001288 IF_FEATURE_FIND_NEWER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001289 "\n -newer FILE Modified time is more recent than FILE's") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001290 IF_FEATURE_FIND_INUM( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001291 "\n -inum N File has inode number N") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001292 IF_FEATURE_FIND_USER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001293 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001294 IF_FEATURE_FIND_GROUP( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001295 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001296 IF_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001297 "\n -depth Process directory name after traversing it") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001298 IF_FEATURE_FIND_SIZE( \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001299 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001300 "\n +/-N: file size is bigger/smaller than N") \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001301 IF_FEATURE_FIND_LINKS( \
1302 "\n -links N Number of links is greater than (+N), less than (-N)," \
1303 "\n or exactly N") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001304 "\n -print Print (default and assumed)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001305 IF_FEATURE_FIND_PRINT0( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001306 "\n -print0 Delimit output with null characters rather than" \
1307 "\n newlines") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001308 IF_FEATURE_FIND_CONTEXT ( \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001309 "\n -context File has specified security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001310 IF_FEATURE_FIND_EXEC( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001311 "\n -exec CMD ARG ; Run CMD with all instances of {} replaced by the" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001312 "\n matching files") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001313 IF_FEATURE_FIND_PRUNE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001314 "\n -prune Stop traversing current subtree") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001315 IF_FEATURE_FIND_DELETE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001316 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001317 IF_FEATURE_FIND_PAREN( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001318 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001319
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001320#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001321 "$ find / -name passwd\n" \
1322 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001323
Denys Vlasenkobf2af9a2009-05-25 04:15:37 +02001324#define flash_lock_trivial_usage \
1325 "MTD_DEVICE OFFSET SECTORS"
1326#define flash_lock_full_usage "\n\n" \
1327 "Lock part or all of an MTD device. If SECTORS is -1, then all sectors\n" \
1328 "will be locked, regardless of the value of OFFSET"
1329
1330#define flash_unlock_trivial_usage \
1331 "MTD_DEVICE"
1332#define flash_unlock_full_usage "\n\n" \
1333 "Unlock an MTD device"
1334
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001335#define flash_eraseall_trivial_usage \
1336 "[-jq] MTD_DEVICE"
1337#define flash_eraseall_full_usage "\n\n" \
1338 "Erase an MTD device\n" \
1339 "\nOptions:" \
Stefan Seyfriedd095fd42009-11-21 18:32:19 +01001340 "\n -j Format the device for jffs2" \
1341 "\n -q Don't display progress messages" \
1342
1343#define flashcp_trivial_usage \
1344 "-v FILE MTD_DEVICE"
1345#define flashcp_full_usage "\n\n" \
1346 "Copy an image to MTD device\n" \
1347 "\nOptions:" \
1348 "\n -v Verbose" \
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001349
Timo Teras892d4b62010-03-18 22:45:35 +01001350#define flock_trivial_usage \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001351 "[-sxun] FD|{FILE [-c] PROG ARGS}"
Timo Teras892d4b62010-03-18 22:45:35 +01001352#define flock_full_usage "\n\n" \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001353 "[Un]lock file descriptor, or lock FILE and run PROG\n" \
Timo Teras892d4b62010-03-18 22:45:35 +01001354 "\nOptions:" \
1355 "\n -s Shared lock" \
1356 "\n -x Exclusive lock (default)" \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001357 "\n -u Unlock FD" \
Timo Teras892d4b62010-03-18 22:45:35 +01001358 "\n -n Fail rather than wait" \
1359
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001360#define fold_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001361 "[-bs] [-w WIDTH] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001362#define fold_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001363 "Wrap input lines in each FILE (or stdin), writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001364 "\nOptions:" \
1365 "\n -b Count bytes rather than columns" \
1366 "\n -s Break at spaces" \
1367 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001368
Eric Andersen7e9276b2001-02-22 01:15:47 +00001369#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001370 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001371#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001372 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001373#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001374 "$ free\n" \
1375 " total used free shared buffers\n" \
1376 " Mem: 257628 248724 8904 59644 93124\n" \
1377 " Swap: 128516 8404 120112\n" \
1378 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001379
Eric Andersen7e9276b2001-02-22 01:15:47 +00001380#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001381 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001382#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001383 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001384#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001385 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001386
Mike Frysinger51a43b42005-09-24 07:11:16 +00001387#define fsck_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001388 "[-ANPRTV] [-C FD] [-t FSTYPE] [FS_OPTS] [BLOCKDEV]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001389#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001390 "Check and repair filesystems\n" \
1391 "\nOptions:" \
1392 "\n -A Walk /etc/fstab and check all filesystems" \
1393 "\n -N Don't execute, just show what would be done" \
1394 "\n -P With -A, check filesystems in parallel" \
1395 "\n -R With -A, skip the root filesystem" \
1396 "\n -T Don't show title on startup" \
1397 "\n -V Verbose" \
1398 "\n -C n Write status information to specified filedescriptor" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001399 "\n -t TYPE List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001400
Eric Andersen7e9276b2001-02-22 01:15:47 +00001401#define fsck_minix_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001402 "[-larvsmf] BLOCKDEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001403#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001404 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001405 "\nOptions:" \
1406 "\n -l List all filenames" \
1407 "\n -r Perform interactive repairs" \
1408 "\n -a Perform automatic repairs" \
1409 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001410 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001411 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001412 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001413
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001414#define ftpd_trivial_usage \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001415 "[-wvS] [-t N] [-T N] [DIR]"
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001416#define ftpd_full_usage "\n\n" \
Denys Vlasenkoae357bd2009-09-11 23:29:45 +02001417 "Anonymous FTP server\n" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001418 "\n" \
1419 "ftpd should be used as an inetd service.\n" \
1420 "ftpd's line for inetd.conf:\n" \
1421 " 21 stream tcp nowait root ftpd ftpd /files/to/serve\n" \
1422 "It also can be ran from tcpsvd:\n" \
1423 " tcpsvd -vE 0.0.0.0 21 ftpd /files/to/serve\n" \
1424 "\nOptions:" \
1425 "\n -w Allow upload" \
Denis Vlasenko4221e902009-03-11 15:07:44 +00001426 "\n -v Log to stderr" \
1427 "\n -S Log to syslog" \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001428 "\n -t,-T Idle and absolute timeouts" \
Denis Vlasenko92576712009-03-09 16:25:33 +00001429 "\n DIR Change root to this directory" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001430
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001431#define ftpget_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001432 "[OPTIONS] HOST [LOCAL_FILE] REMOTE_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001433#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001434 "Retrieve a remote file via FTP\n" \
1435 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001436 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001437 "\n -c,--continue Continue previous transfer" \
1438 "\n -v,--verbose Verbose" \
1439 "\n -u,--username Username" \
1440 "\n -p,--password Password" \
1441 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001442 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001443 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001444 "\n -c Continue previous transfer" \
1445 "\n -v Verbose" \
1446 "\n -u Username" \
1447 "\n -p Password" \
1448 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001449 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001450
1451#define ftpput_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001452 "[OPTIONS] HOST [REMOTE_FILE] LOCAL_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001453#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001454 "Store a local file on a remote machine via FTP\n" \
1455 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001456 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001457 "\n -v,--verbose Verbose" \
1458 "\n -u,--username Username" \
1459 "\n -p,--password Password" \
1460 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001461 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001462 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001463 "\n -v Verbose" \
1464 "\n -u Username" \
1465 "\n -p Password" \
1466 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001467 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001468
Rob Landleyaa872762005-10-28 13:05:12 +00001469#define fuser_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001470 "[OPTIONS] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001471#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001472 "Find processes which use FILEs or PORTs\n" \
1473 "\nOptions:" \
1474 "\n -m Find processes which use same fs as FILEs" \
1475 "\n -4 Search only IPv4 space" \
1476 "\n -6 Search only IPv6 space" \
Maksym Kryzhanovskyyfef9ee72010-05-22 20:41:08 +02001477 "\n -s Don't display PIDs" \
1478 "\n -k Kill found processes" \
1479 "\n -SIGNAL Signal to send (default: KILL)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001480
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001481#define getenforce_trivial_usage NOUSAGE_STR
1482#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001483
Eric Andersen7e9276b2001-02-22 01:15:47 +00001484#define getopt_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001485 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001486#define getopt_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001487 "Options:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001488 IF_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001489 "\n -a,--alternative Allow long options starting with single -" \
1490 "\n -l,--longoptions=longopts Long options to be recognized" \
1491 "\n -n,--name=progname The name under which errors are reported" \
1492 "\n -o,--options=optstring Short options to be recognized" \
1493 "\n -q,--quiet Disable error reporting by getopt(3)" \
1494 "\n -Q,--quiet-output No normal output" \
1495 "\n -s,--shell=shell Set shell quoting conventions" \
1496 "\n -T,--test Test for getopt(1) version" \
1497 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001498 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001499 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001500 "\n -a Allow long options starting with single -" \
1501 "\n -l longopts Long options to be recognized" \
1502 "\n -n progname The name under which errors are reported" \
1503 "\n -o optstring Short options to be recognized" \
1504 "\n -q Disable error reporting by getopt(3)" \
1505 "\n -Q No normal output" \
1506 "\n -s shell Set shell quoting conventions" \
1507 "\n -T Test for getopt(1) version" \
1508 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001509 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001510#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001511 "$ cat getopt.test\n" \
1512 "#!/bin/sh\n" \
1513 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1514 " -n 'example.busybox' -- \"$@\"`\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001515 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001516 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001517 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001518 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001519 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1520 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001521 " -c|--c-long)\n" \
1522 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001523 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1524 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1525 " esac;;\n" \
1526 " --) shift; break;;\n" \
1527 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001528 " esac\n" \
1529 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001530
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001531#define getsebool_trivial_usage \
1532 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001533#define getsebool_full_usage "\n\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01001534 " -a Show all selinux booleans"
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001535
Eric Andersenf349e972001-08-21 16:18:59 +00001536#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001537 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001538#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001539 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1540 "\nOptions:" \
1541 "\n -h Enable hardware (RTS/CTS) flow control" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001542 "\n -i Don't display /etc/issue before running login" \
1543 "\n -L Local line, don't do carrier detect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001544 "\n -m Get baud rate from modem's CONNECT status message" \
1545 "\n -w Wait for a CR or LF before sending /etc/issue" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001546 "\n -n Don't prompt the user for a login name" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02001547 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
1548 "\n -l LOGIN Invoke LOGIN instead of /bin/login" \
1549 "\n -t SEC Terminate after SEC if no username is read" \
1550 "\n -I INITSTR Send INITSTR before anything else" \
1551 "\n -H HOST Log HOST into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001552
Eric Andersen7e9276b2001-02-22 01:15:47 +00001553#define grep_trivial_usage \
Denys Vlasenko05273da2010-04-26 08:45:44 +02001554 "[-HhnlLoqvsriw" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001555 "F" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001556 IF_FEATURE_GREP_EGREP_ALIAS("E") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001557 IF_EXTRA_COMPAT("z") \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001558 "] [-m N] " \
1559 IF_FEATURE_GREP_CONTEXT("[-A/B/C N] ") \
1560 "PATTERN/-e PATTERN.../-f FILE [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001561#define grep_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001562 "Search for PATTERN in FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001563 "\nOptions:" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001564 "\n -H Add 'filename:' prefix" \
1565 "\n -h Do not add 'filename:' prefix" \
1566 "\n -n Add 'line_no:' prefix" \
1567 "\n -l Show only names of files that match" \
1568 "\n -L Show only names of files that don't match" \
1569 "\n -c Show only count of matching lines" \
1570 "\n -o Show only the matching part of line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001571 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1572 "\n -v Select non-matching lines" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001573 "\n -s Suppress open and read errors" \
1574 "\n -r Recurse" \
1575 "\n -i Ignore case" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001576 "\n -w Match whole words only" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001577 "\n -F PATTERN is a literal (not regexp)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001578 IF_FEATURE_GREP_EGREP_ALIAS( \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001579 "\n -E PATTERN is an extended regexp" \
1580 ) \
1581 IF_EXTRA_COMPAT( \
1582 "\n -z Input is NUL terminated" \
1583 ) \
1584 "\n -m N Match up to N times per file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001585 IF_FEATURE_GREP_CONTEXT( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001586 "\n -A N Print N lines of trailing context" \
1587 "\n -B N Print N lines of leading context" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001588 "\n -C N Same as '-A N -B N'" \
1589 ) \
1590 "\n -e PTRN Pattern to match" \
1591 "\n -f FILE Read pattern from file" \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001592
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001593#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001594 "$ grep root /etc/passwd\n" \
1595 "root:x:0:0:root:/root:/bin/bash\n" \
1596 "$ grep ^[rR]oo. /etc/passwd\n" \
1597 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001598
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001599#define egrep_trivial_usage NOUSAGE_STR
1600#define egrep_full_usage ""
1601
1602#define fgrep_trivial_usage NOUSAGE_STR
1603#define fgrep_full_usage ""
1604
Eric Andersen7e9276b2001-02-22 01:15:47 +00001605#define gunzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001606 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001607#define gunzip_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001608 "Uncompress FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001609 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001610 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001611 "\n -f Force" \
1612 "\n -t Test file integrity" \
1613
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001614#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001615 "$ ls -la /tmp/BusyBox*\n" \
1616 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1617 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1618 "$ ls -la /tmp/BusyBox*\n" \
1619 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001620
1621#define gzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001622 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001623#define gzip_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001624 "Compress FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001625 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001626 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001627 "\n -d Decompress" \
1628 "\n -f Force" \
1629
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001630#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001631 "$ ls -la /tmp/busybox*\n" \
1632 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1633 "$ gzip /tmp/busybox.tar\n" \
1634 "$ ls -la /tmp/busybox*\n" \
1635 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001636
1637#define halt_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001638 "[-d DELAY] [-n] [-f]" IF_FEATURE_WTMP(" [-w]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001639#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001640 "Halt the system\n" \
1641 "\nOptions:" \
1642 "\n -d Delay interval for halting" \
1643 "\n -n No call to sync()" \
1644 "\n -f Force halt (don't go through init)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001645 IF_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001646 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001647 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001648
Eric Andersen3443bd72003-07-22 07:30:36 +00001649#define hdparm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001650 "[OPTIONS] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001651#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001652 "Options:" \
1653 "\n -a Get/set fs readahead" \
1654 "\n -A Set drive read-lookahead flag (0/1)" \
1655 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1656 "\n -B Set Advanced Power Management setting (1-255)" \
1657 "\n -c Get/set IDE 32-bit IO setting" \
1658 "\n -C Check IDE power mode status" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001659 IF_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001660 "\n -d Get/set using_dma flag") \
1661 "\n -D Enable/disable drive defect-mgmt" \
1662 "\n -f Flush buffer cache for device on exit" \
1663 "\n -g Display drive geometry" \
1664 "\n -h Display terse usage information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001665 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001666 "\n -i Display drive identification") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001667 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001668 "\n -I Detailed/current information directly from drive") \
1669 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1670 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1671 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1672 "\n -m Get/set multiple sector count" \
1673 "\n -n Get/set ignore-write-errors flag (0/1)" \
1674 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1675 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001676/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001677 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1678 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001679 IF_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001680 "\n -R Register an IDE interface (DANGEROUS)") \
1681 "\n -S Set standby (spindown) timeout" \
1682 "\n -t Perform device read timings" \
1683 "\n -T Perform cache read timings" \
1684 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001685 IF_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001686 "\n -U Unregister an IDE interface (DANGEROUS)") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001687 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1688 "\n -V Display program version and exit immediately" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001689 IF_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001690 "\n -w Perform device reset (DANGEROUS)") \
1691 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001692 IF_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001693 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1694 "\n -X Set IDE xfer mode (DANGEROUS)" \
1695 "\n -y Put IDE drive in standby mode" \
1696 "\n -Y Put IDE drive to sleep" \
1697 "\n -Z Disable Seagate auto-powersaving mode" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001698 "\n -z Reread partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001699
Eric Andersen7e9276b2001-02-22 01:15:47 +00001700#define head_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001701 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001702#define head_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001703 "Print first 10 lines of each FILE (or stdin) to stdout.\n" \
Denys Vlasenko57493282010-03-02 16:18:14 +01001704 "With more than one FILE, precede each with a filename header.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001705 "\nOptions:" \
Denys Vlasenko57493282010-03-02 16:18:14 +01001706 "\n -n N[kbm] Print first N lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001707 IF_FEATURE_FANCY_HEAD( \
Denys Vlasenko57493282010-03-02 16:18:14 +01001708 "\n -c N[kbm] Print first N bytes" \
1709 "\n -q Never print headers" \
1710 "\n -v Always print headers" \
1711 ) \
1712 "\n" \
1713 "\nN may be suffixed by k (x1024), b (x512), or m (x1024^2)." \
Denis Vlasenko397de612008-03-17 08:55:44 +00001714
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001715#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001716 "$ head -n 2 /etc/passwd\n" \
1717 "root:x:0:0:root:/root:/bin/bash\n" \
1718 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001719
Denys Vlasenko57493282010-03-02 16:18:14 +01001720#define tail_trivial_usage \
1721 "[OPTIONS] [FILE]..."
1722#define tail_full_usage "\n\n" \
1723 "Print last 10 lines of each FILE (or stdin) to stdout.\n" \
1724 "With more than one FILE, precede each with a filename header.\n" \
1725 "\nOptions:" \
1726 "\n -f Print data as file grows" \
1727 IF_FEATURE_FANCY_TAIL( \
1728 "\n -s SECONDS Wait SECONDS between reads with -f" \
1729 ) \
1730 "\n -n N[kbm] Print last N lines" \
1731 IF_FEATURE_FANCY_TAIL( \
1732 "\n -c N[kbm] Print last N bytes" \
1733 "\n -q Never print headers" \
1734 "\n -v Always print headers" \
1735 "\n" \
1736 "\nN may be suffixed by k (x1024), b (x512), or m (x1024^2)." \
1737 "\nIf N starts with a '+', output begins with the Nth item from the start" \
1738 "\nof each file, not from the end." \
1739 ) \
1740
1741#define tail_example_usage \
1742 "$ tail -n 1 /etc/resolv.conf\n" \
1743 "nameserver 10.0.0.1\n"
1744
Glenn L McGrath60281112001-11-02 11:39:46 +00001745#define hexdump_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001746 "[-bcCdefnosvx" IF_FEATURE_HEXDUMP_REVERSE("R") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001747#define hexdump_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001748 "Display FILEs (or stdin) in a user specified format\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001749 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001750 "\n -b One-byte octal display" \
1751 "\n -c One-byte character display" \
1752 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1753 "\n -d Two-byte decimal display" \
1754 "\n -e FORMAT STRING" \
1755 "\n -f FORMAT FILE" \
1756 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1757 "\n -o Two-byte octal display" \
1758 "\n -s OFFSET Skip OFFSET bytes" \
1759 "\n -v Display all input data" \
1760 "\n -x Two-byte hexadecimal display" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001761 IF_FEATURE_HEXDUMP_REVERSE( \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001762 "\n -R Reverse of 'hexdump -Cv'") \
1763
1764#define hd_trivial_usage \
1765 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001766#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001767 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001768
Eric Andersen7e9276b2001-02-22 01:15:47 +00001769#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001770 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001771#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001772 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001773
1774#define hostname_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001775 "[OPTIONS] [HOSTNAME | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001776#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001777 "Get or set hostname or DNS domain name\n" \
1778 "\nOptions:" \
1779 "\n -s Short" \
1780 "\n -i Addresses for the hostname" \
1781 "\n -d DNS domain name" \
1782 "\n -f Fully qualified domain name" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001783 "\n -F FILE Use FILE's content as hostname" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001784
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001785#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001786 "$ hostname\n" \
1787 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001788
Denys Vlasenkod30b89c2009-06-26 01:55:45 +02001789#define dnsdomainname_trivial_usage NOUSAGE_STR
1790#define dnsdomainname_full_usage ""
1791
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001792#define httpd_trivial_usage \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001793 "[-ifv[v]]" \
1794 " [-c CONFFILE]" \
1795 " [-p [IP:]PORT]" \
1796 IF_FEATURE_HTTPD_SETUID(" [-u USER[:GRP]]") \
1797 IF_FEATURE_HTTPD_BASIC_AUTH(" [-r REALM]") \
1798 " [-h HOME]\n" \
1799 "or httpd -d/-e" IF_FEATURE_HTTPD_AUTH_MD5("/-m") " STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001800#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001801 "Listen for incoming HTTP requests\n" \
1802 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001803 "\n -i Inetd mode" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001804 "\n -f Don't daemonize" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001805 "\n -v[v] Verbose" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001806 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001807 IF_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001808 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001809 IF_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001810 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001811 "\n -h HOME Home directory (default .)" \
Denys Vlasenko8fc9e6a2010-04-02 10:40:58 +02001812 "\n -c FILE Configuration file (default {/etc,HOME}/httpd.conf)" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001813 IF_FEATURE_HTTPD_AUTH_MD5( \
1814 "\n -m STRING MD5 crypt STRING") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001815 "\n -e STRING HTML encode STRING" \
1816 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001817
Robert Griebl1cd04452002-07-21 16:50:49 +00001818#define hwclock_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001819 IF_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001820 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1821 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001822 " [-f FILE]" \
1823 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001824 IF_NOT_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001825 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1826 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001827#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001828 "Query and set hardware clock (RTC)\n" \
1829 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001830 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001831 "\n -s Set system time from hardware clock" \
1832 "\n -w Set hardware clock to system time" \
1833 "\n -u Hardware clock is in UTC" \
1834 "\n -l Hardware clock is in local time" \
1835 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001836
Eric Andersen7e9276b2001-02-22 01:15:47 +00001837#define id_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001838 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001839#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001840 "Print information about USER or the current user\n" \
1841 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001842 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001843 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001844 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001845 "\n -u Print user ID" \
Denis Vlasenko4f3209b2008-09-13 12:51:10 +00001846 "\n -g Print group ID" \
1847 "\n -G Print supplementary group IDs" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001848 "\n -n Print name instead of a number" \
1849 "\n -r Print real user ID instead of effective ID" \
1850
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001851#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001852 "$ id\n" \
1853 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001854
Eric Andersen7e9276b2001-02-22 01:15:47 +00001855#define ifconfig_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001856 IF_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001857#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001858 "Configure a network interface\n" \
1859 "\nOptions:" \
1860 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001861 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001862 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001863 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001864 " [del ADDRESS[/PREFIXLEN]]\n") \
1865 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1866 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001867 IF_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001868 " [outfill NN] [keepalive NN]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001869 " " IF_FEATURE_IFCONFIG_HW("[hw ether" IF_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001870 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001871 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001872 IF_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001873 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001874 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001875
Denis Vlasenko06aed432008-02-26 18:25:24 +00001876#define ifenslave_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001877 "[-cdf] MASTER_IFACE SLAVE_IFACE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001878#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001879 "Configure network interfaces for parallel routing\n" \
1880 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001881 "\n -c, --change-active Change active slave" \
1882 "\n -d, --detach Remove slave interface from bonding device" \
1883 "\n -f, --force Force, even if interface is not Ethernet" \
1884/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001885
Denis Vlasenko06aed432008-02-26 18:25:24 +00001886#define ifenslave_example_usage \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001887 "To create a bond device, simply follow these three steps:\n" \
1888 "- ensure that the required drivers are properly loaded:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001889 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001890 "- assign an IP address to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001891 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001892 "- attach all the interfaces you need to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001893 " # ifenslave bond0 eth0 eth1 eth2\n" \
1894 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1895 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001896 " To detach a dead interface without setting the bond device down:\n" \
1897 " # ifenslave -d bond0 eth1\n\n" \
1898 " To set the bond device down and automatically release all the slaves:\n" \
1899 " # ifconfig bond0 down\n\n" \
1900 " To change active slave:\n" \
1901 " # ifenslave -c bond0 eth0\n" \
1902
1903#define ifplugd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001904 "[OPTIONS]"
Denis Vlasenko71c16572009-04-26 01:08:51 +00001905#define ifplugd_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +02001906 "Network interface plug detection daemon\n" \
1907 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001908 "\n -n Don't daemonize" \
1909 "\n -s Don't log to syslog" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001910 "\n -i IFACE Interface" \
1911 "\n -f/-F Treat link detection error as link down/link up" \
1912 "\n (otherwise exit on error)" \
Denys Vlasenko999e4422010-01-08 13:03:48 +01001913 "\n -a Don't up interface at each link probe" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001914 "\n -M Monitor creation/destruction of interface" \
1915 "\n (otherwise it must exist)" \
1916 "\n -r PROG Script to run" \
1917 "\n -x ARG Extra argument for script" \
1918 "\n -I Don't exit on nonzero exit code from script" \
1919 "\n -p Don't run script on daemon startup" \
1920 "\n -q Don't run script on daemon quit" \
1921 "\n -l Run script on startup even if no cable is detected" \
1922 "\n -t SECS Poll time in seconds" \
1923 "\n -u SECS Delay before running script after link up" \
1924 "\n -d SECS Delay after link down" \
Denys Vlasenkob8f0e802010-01-07 14:56:50 +01001925 "\n -m MODE API mode (mii, priv, ethtool, wlan, iff, auto)" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001926 "\n -k Kill running daemon" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001927
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001928#define ifup_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001929 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] IFACE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001930#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001931 "Options:" \
1932 "\n -a De/configure all interfaces automatically" \
1933 "\n -i FILE Use FILE for interface definitions" \
1934 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001935 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001936 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001937 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001938 ) \
1939 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001940 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001941
1942#define ifdown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001943 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001944#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001945 "Options:" \
1946 "\n -a De/configure all interfaces automatically" \
1947 "\n -i FILE Use FILE for interface definitions" \
1948 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001949 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001950 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001951 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001952 ) \
1953 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001954 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001955
Glenn L McGrath06e95652003-02-09 06:51:14 +00001956#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001957 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001958#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001959 "Listen for network connections and launch programs\n" \
1960 "\nOptions:" \
1961 "\n -f Run in foreground" \
1962 "\n -e Log to stderr" \
1963 "\n -q N Socket listen queue (default: 128)" \
1964 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001965 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001966
Eric Andersen7e9276b2001-02-22 01:15:47 +00001967#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001968 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001969#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001970 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001971
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001972#define init_notes_usage \
1973"This version of init is designed to be run only by the kernel.\n" \
1974"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001975"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001976"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001977"runlevels, use sysvinit.\n" \
1978"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001979"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001980"it has the following default behavior:\n" \
1981"\n" \
1982" ::sysinit:/etc/init.d/rcS\n" \
1983" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001984" ::ctrlaltdel:/sbin/reboot\n" \
1985" ::shutdown:/sbin/swapoff -a\n" \
1986" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001987" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001988"\n" \
1989"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1990"\n" \
1991" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001992" tty3::askfirst:/bin/sh\n" \
1993" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001994"\n" \
1995"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1996"\n" \
1997" <id>:<runlevels>:<action>:<process>\n" \
1998"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001999" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002000"\n" \
2001" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
2002" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002003" the specified process to run on. The contents of this field are\n" \
2004" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
2005" be unique, although if it isn't you may have strange results. If this\n" \
2006" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002007" note that if BusyBox detects that a serial console is in use, then only\n" \
2008" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002009" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002010" stinkin' utmp.\n" \
2011"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002012" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002013"\n" \
2014" The runlevels field is completely ignored.\n" \
2015"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002016" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002017"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002018" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00002019" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002020"\n" \
2021" The available actions can be classified into two groups: actions\n" \
2022" that are run only once, and actions that are re-run when the specified\n" \
2023" process exits.\n" \
2024"\n" \
2025" Run only-once actions:\n" \
2026"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002027" 'sysinit' is the first item run on boot. init waits until all\n" \
2028" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002029" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002030" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002031" the specified task completes. 'once' actions are asynchronous,\n" \
2032" therefore, init does not wait for them to complete. 'restart' is\n" \
2033" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00002034" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002035" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002036" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002037" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002038" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002039" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002040" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002041" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002042"\n" \
2043" Run repeatedly actions:\n" \
2044"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002045" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002046" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002047" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
2048" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002049" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002050" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002051" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002052" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002053"\n" \
2054" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002055" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00002056" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002057"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002058" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002059"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00002060" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002061"\n" \
2062"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00002063"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002064" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002065" #\n" \
2066" ::sysinit:/etc/init.d/rcS\n" \
2067" \n" \
2068" # /bin/sh invocations on selected ttys\n" \
2069" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002070" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002071" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002072" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002073" tty2::askfirst:-/bin/sh\n" \
2074" tty3::askfirst:-/bin/sh\n" \
2075" tty4::askfirst:-/bin/sh\n" \
2076" \n" \
2077" # /sbin/getty invocations for selected ttys\n" \
2078" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00002079" tty4::respawn:/sbin/getty 38400 tty4\n" \
2080" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002081" \n" \
2082" \n" \
2083" # Example of how to put a getty on a serial line (for a terminal)\n" \
2084" #\n" \
2085" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
2086" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
2087" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002088" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002089" #::respawn:/sbin/getty 57600 ttyS2\n" \
2090" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00002091" # Stuff to do when restarting the init process\n" \
2092" ::restart:/sbin/init\n" \
2093" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002094" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002095" ::ctrlaltdel:/sbin/reboot\n" \
2096" ::shutdown:/bin/umount -a -r\n" \
2097" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002098
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002099#define inotifyd_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002100 "PROG FILE1[:MASK]..."
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002101#define inotifyd_full_usage "\n\n" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002102 "Run PROG on filesystem changes." \
2103 "\nWhen a filesystem event matching MASK occurs on FILEn," \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002104 "\nPROG ACTUAL_EVENTS FILEn [SUBFILE] is run." \
Denis Vlasenko289ff0e2008-11-14 21:52:16 +00002105 "\nEvents:" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002106 "\n a File is accessed" \
2107 "\n c File is modified" \
2108 "\n e Metadata changed" \
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02002109 "\n w Writable file is closed" \
2110 "\n 0 Unwritable file is closed" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002111 "\n r File is opened" \
Denis Vlasenkoa09a42c2008-11-17 22:19:18 +00002112 "\n D File is deleted" \
2113 "\n M File is moved" \
2114 "\n u Backing fs is unmounted" \
2115 "\n o Event queue overflowed" \
2116 "\n x File can't be watched anymore" \
2117 "\nIf watching a directory:" \
2118 "\n m Subfile is moved into dir" \
2119 "\n y Subfile is moved out of dir" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002120 "\n n Subfile is created" \
2121 "\n d Subfile is deleted" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002122 "\n" \
2123 "\ninotifyd waits for PROG to exit." \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002124 "\nWhen x event happens for all FILEs, inotifyd exits." \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002125
Denis Vlasenko36309cf2008-11-22 18:29:01 +00002126/* 2.6 style insmod has no options and required filename
2127 * (not module name - .ko can't be omitted) */
Eric Andersen7e9276b2001-02-22 01:15:47 +00002128#define insmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002129 IF_FEATURE_2_4_MODULES("[OPTIONS] MODULE ") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002130 IF_NOT_FEATURE_2_4_MODULES("FILE ") \
Denis Vlasenko36309cf2008-11-22 18:29:01 +00002131 "[symbol=value]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002132#define insmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002133 "Load the specified kernel modules into the kernel" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002134 IF_FEATURE_2_4_MODULES( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002135 "\nOptions:" \
2136 "\n -f Force module to load into the wrong kernel version" \
2137 "\n -k Make module autoclean-able" \
2138 "\n -v Verbose" \
2139 "\n -q Quiet" \
2140 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002141 IF_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002142 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00002143 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002144 "\n -o NAME Set internal module name to NAME" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002145 "\n -x Don't export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00002146 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00002147
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002148/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00002149#define install_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002150 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [SOURCE]... DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002151#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002152 "Copy files and set attributes\n" \
2153 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002154 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002155 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002156 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002157 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002158 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002159 "\n -o USER Set ownership" \
2160 "\n -g GRP Set group ownership" \
2161 "\n -m MODE Set permissions" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002162 IF_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002163 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002164 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002165
Denis Vlasenko4acdb462009-01-31 21:45:57 +00002166#define ionice_trivial_usage \
2167 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
2168#define ionice_full_usage "\n\n" \
2169 "Change I/O scheduling class and priority\n" \
2170 "\nOptions:" \
2171 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
2172 "\n -n Priority" \
2173
Denis Vlasenko397de612008-03-17 08:55:44 +00002174/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002175#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00002176 "[OPTIONS] {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002177 IF_FEATURE_IP_ADDRESS("address | ") \
2178 IF_FEATURE_IP_ROUTE("route | ") \
2179 IF_FEATURE_IP_LINK("link | ") \
2180 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2181 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002182 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002183#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002184 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002185 "where OBJECT := {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002186 IF_FEATURE_IP_ADDRESS("address | ") \
2187 IF_FEATURE_IP_ROUTE("route | ") \
2188 IF_FEATURE_IP_LINK("link | ") \
2189 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2190 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002191 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002192 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002193
2194#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002195 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002196 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002197#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002198 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002199 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
2200 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002201 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002202 " [broadcast ADDR] [anycast ADDR]\n" \
2203 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002204 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002205
Eric Andersende4f07e2003-12-11 01:18:07 +00002206#define ipcalc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002207 "[OPTIONS] ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002208#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002209 "Calculate IP network settings from a IP address\n" \
2210 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002211 IF_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002212 "\n -b,--broadcast Display calculated broadcast address" \
2213 "\n -n,--network Display calculated network address" \
2214 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002215 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002216 "\n -p,--prefix Display the prefix for IP/NETMASK" \
2217 "\n -h,--hostname Display first resolved host name" \
2218 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002219 ) \
2220 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002221 IF_NOT_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002222 "\n -b Display calculated broadcast address" \
2223 "\n -n Display calculated network address" \
2224 "\n -m Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002225 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002226 "\n -p Display the prefix for IP/NETMASK" \
2227 "\n -h Display first resolved host name" \
2228 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002229 ) \
2230 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00002231
Rob Landley6eb1e412005-06-20 04:30:36 +00002232#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002233 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002234#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002235 "Upper-case options MQS remove an object by shmkey value.\n" \
2236 "Lower-case options remove an object by shmid value.\n" \
2237 "\nOptions:" \
2238 "\n -mM Remove memory segment after last detach" \
2239 "\n -qQ Remove message queue" \
2240 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002241
2242#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002243 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002244#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002245 " -i Show specific resource" \
2246 "\nResource specification:" \
2247 "\n -m Shared memory segments" \
2248 "\n -q Message queues" \
2249 "\n -s Semaphore arrays" \
2250 "\n -a All (default)" \
2251 "\nOutput format:" \
2252 "\n -t Time" \
2253 "\n -c Creator" \
2254 "\n -p Pid" \
2255 "\n -l Limits" \
2256 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002257
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002258#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002259 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002260#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00002261 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002262 " dynamic { on | off } |\n" \
2263 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002264 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002265
2266#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002267 "{ list | flush | { add | del | change | append |\n" \
2268 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002269#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002270 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002271 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
2272 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002273 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002274 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00002275 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
2276 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002277
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002278#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002279 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002280#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002281 "iprule [list | add | del] SELECTOR ACTION\n" \
2282 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2283 " [dev STRING] [pref NUMBER]\n" \
2284 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2285 " [prohibit | reject | unreachable]\n" \
2286 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002287 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002288
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002289#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002290 "{ add | change | del | show } [NAME]\n" \
2291 " [mode { ipip | gre | sit }]\n" \
2292 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002293#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002294 "iptunnel { add | change | del | show } [NAME]\n" \
2295 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2296 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002297 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002298
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002299#define kbd_mode_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002300 "[-a|k|s|u] [-C TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002301#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002302 "Report or set the keyboard mode\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002303 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002304 "\n -a Default (ASCII)" \
2305 "\n -k Medium-raw (keyboard)" \
2306 "\n -s Raw (scancode)" \
2307 "\n -u Unicode (utf-8)" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002308 "\n -C TTY Affect TTY instead of /dev/tty" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002309
Eric Andersen7e9276b2001-02-22 01:15:47 +00002310#define kill_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002311 "[-l] [-SIG] PID..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002312#define kill_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002313 "Send a signal (default: TERM) to given PIDs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002314 "\nOptions:" \
2315 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002316/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002317
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002318#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002319 "$ ps | grep apache\n" \
2320 "252 root root S [apache]\n" \
2321 "263 www-data www-data S [apache]\n" \
2322 "264 www-data www-data S [apache]\n" \
2323 "265 www-data www-data S [apache]\n" \
2324 "266 www-data www-data S [apache]\n" \
2325 "267 www-data www-data S [apache]\n" \
2326 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002327
2328#define killall_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002329 "[-l] [-q] [-SIG] PROCESS_NAME..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002330#define killall_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002331 "Send a signal (default: TERM) to given processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002332 "\nOptions:" \
2333 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002334/* "\n -s SIG Yet another way of specifying SIG" */ \
Denys Vlasenko07697852009-10-06 21:11:37 +02002335 "\n -q Don't complain if no processes were killed" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002336
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002337#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002338 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002339
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002340#define killall5_trivial_usage \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002341 "[-l] [-SIG] [-o PID]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002342#define killall5_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002343 "Send a signal (default: TERM) to all processes outside current session\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002344 "\nOptions:" \
2345 "\n -l List all signal names and numbers" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002346 "\n -o PID Don't signal this PID" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002347/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002348
Mark Whitley6317c4b2001-03-12 22:51:50 +00002349#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002350 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002351#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002352 "Kernel logger\n" \
2353 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002354 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002355 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002356
Eric Andersen7e9276b2001-02-22 01:15:47 +00002357#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002358 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002359#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002360 "Print STRING's length"
2361
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002362#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002363 "$ length Hello\n" \
2364 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002365
Rob Landley9200e792005-09-15 19:26:59 +00002366#define less_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002367 "[-EMNmh~I?] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002368#define less_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002369 "View FILE (or stdin) one screenful at a time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002370 "\nOptions:" \
2371 "\n -E Quit once the end of a file is reached" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002372 "\n -M,-m Display status line with line numbers" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002373 "\n and percentage through the file" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002374 "\n -N Prefix line number to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002375 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002376 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002377
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002378#define linux32_trivial_usage NOUSAGE_STR
2379#define linux32_full_usage ""
2380#define linux64_trivial_usage NOUSAGE_STR
2381#define linux64_full_usage ""
2382
2383#define linuxrc_trivial_usage NOUSAGE_STR
2384#define linuxrc_full_usage ""
2385
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002386#define setarch_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002387 "personality PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002388#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002389 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002390 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002391 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002392
Eric Andersen7e9276b2001-02-22 01:15:47 +00002393#define ln_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002394 "[OPTIONS] TARGET... LINK|DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002395#define ln_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002396 "Create a link LINK or DIR/TARGET to the specified TARGET(s)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002397 "\nOptions:" \
2398 "\n -s Make symlinks instead of hardlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002399 "\n -f Remove existing destinations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002400 "\n -n Don't dereference symlinks - treat like normal file" \
2401 "\n -b Make a backup of the target (if exists) before link operation" \
2402 "\n -S suf Use suffix instead of ~ when making backup files" \
2403
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002404#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002405 "$ ln -s BusyBox /tmp/ls\n" \
2406 "$ ls -l /tmp/ls\n" \
2407 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002408
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002409#define load_policy_trivial_usage NOUSAGE_STR
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002410#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002411
Eric Andersen7e9276b2001-02-22 01:15:47 +00002412#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002413 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002414#define loadfont_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002415 "Load a console font from stdin" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002416/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2417
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002418#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002419 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002420
2421#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002422 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002423#define loadkmap_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002424 "Load a binary keyboard translation table from stdin\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002425/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2426
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002427#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002428 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002429
2430#define logger_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002431 "[OPTIONS] [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002432#define logger_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002433 "Write MESSAGE (or stdin) to syslog\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002434 "\nOptions:" \
2435 "\n -s Log to stderr as well as the system log" \
2436 "\n -t TAG Log using the specified tag (defaults to user name)" \
2437 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002438
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002439#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002440 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002441
Robert Griebl1fca5582002-06-04 20:45:46 +00002442#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002443 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002444#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002445 "Begin a new session on the system\n" \
2446 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002447 "\n -f Don't authenticate (user already authenticated)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002448 "\n -h Name of the remote host" \
2449 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002450
Eric Andersen7e9276b2001-02-22 01:15:47 +00002451#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002452 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002453#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002454 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002455#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002456 "$ logname\n" \
2457 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002458
Mark Whitley6317c4b2001-03-12 22:51:50 +00002459#define logread_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002460 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002461#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002462 "Show messages in syslogd's circular buffer\n" \
2463 "\nOptions:" \
2464 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002465
Matt Kraai83788da2002-03-20 17:38:37 +00002466#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002467 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2468 " losetup -d LOOPDEV - disassociate\n" \
2469 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002470#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002471 "Options:" \
2472 "\n -o OFS Start OFS bytes into FILE" \
2473 "\n -f Show first free loop device" \
2474
Rob Landley1d589b22005-11-29 23:47:10 +00002475#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002476 "No arguments will display all current associations.\n" \
2477 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002478 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002479 "and filename of the file the loop device is currently bound to.\n\n" \
2480 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002481 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2482 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002483
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002484#define lpd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002485 "SPOOLDIR [HELPER [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002486#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002487 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2488 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002489 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002490 "\ndirectory and HELPER program is called. Name of file to print" \
2491 "\nis passed in $DATAFILE variable." \
2492 "\nExample:" \
2493 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002494
Denis Vlasenko68444b92008-02-22 22:24:48 +00002495#define lpq_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002496 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID]... [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002497#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002498 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002499 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002500 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002501 "\n -f Force any waiting job to be printed" \
2502 "\n -s Short display" \
2503
2504#define lpr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002505 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE]..."
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002506/* -C CLASS exists too, not shown.
2507 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002508#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002509 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002510 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002511 "\n -m Send mail on completion" \
2512 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002513 "\n -V Verbose" \
2514
Eric Andersen7e9276b2001-02-22 01:15:47 +00002515#define ls_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002516 "[-1Aa" IF_FEATURE_LS_TIMESTAMPS("c") "Cd" \
2517 IF_FEATURE_LS_TIMESTAMPS("e") IF_FEATURE_LS_FILETYPES("F") "iln" \
2518 IF_FEATURE_LS_FILETYPES("p") IF_FEATURE_LS_FOLLOWLINKS("L") \
2519 IF_FEATURE_LS_RECURSIVE("R") IF_FEATURE_LS_SORTFILES("rS") "s" \
2520 IF_FEATURE_AUTOWIDTH("T") IF_FEATURE_LS_TIMESTAMPS("tu") \
2521 IF_FEATURE_LS_SORTFILES("v") IF_FEATURE_AUTOWIDTH("w") "x" \
2522 IF_FEATURE_LS_SORTFILES("X") IF_FEATURE_HUMAN_READABLE("h") "k" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002523 IF_SELINUX("K") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002524#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002525 "List directory contents\n" \
2526 "\nOptions:" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002527 "\n -1 List in a single column" \
2528 "\n -A Don't list . and .." \
2529 "\n -a Don't hide entries starting with ." \
2530 "\n -C List by columns" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002531 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002532 "\n -c With -l: sort by ctime") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002533 IF_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002534 "\n --color[={always,never,auto}] Control coloring") \
2535 "\n -d List directory entries instead of contents" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002536 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002537 "\n -e List full date and time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002538 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002539 "\n -F Append indicator (one of */=@|) to entries") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002540 "\n -i List inode numbers" \
2541 "\n -l Long listing format" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002542 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002543 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002544 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002545 IF_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002546 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002547 IF_FEATURE_LS_RECURSIVE( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002548 "\n -R Recurse") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002549 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002550 "\n -r Sort in reverse order") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002551 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002552 "\n -S Sort by file size") \
Denis Vlasenko397de612008-03-17 08:55:44 +00002553 "\n -s List the size of each file, in blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002554 IF_FEATURE_AUTOWIDTH( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002555 "\n -T N Assume tabstop every N columns") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002556 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002557 "\n -t With -l: sort by modification time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002558 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002559 "\n -u With -l: sort by access time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002560 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002561 "\n -v Sort by version") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002562 IF_FEATURE_AUTOWIDTH( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002563 "\n -w N Assume the terminal is N columns wide") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002564 "\n -x List by lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002565 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002566 "\n -X Sort by extension") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002567 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002568 "\n -h List sizes in human readable format (1K 243M 2G)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002569 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002570 "\n -k List security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002571 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002572 "\n -K List security context in long format") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002573 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002574 "\n -Z List security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002575
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002576#define lsattr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002577 "[-Radlv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002578#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002579 "List file attributes on an ext2 fs\n" \
2580 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002581 "\n -R Recurse" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002582 "\n -a Don't hide entries starting with ." \
Denis Vlasenko397de612008-03-17 08:55:44 +00002583 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002584 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002585 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002586
Eric Andersen7e9276b2001-02-22 01:15:47 +00002587#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002588 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002589#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002590 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002591
Souf Oued982bc712009-12-05 17:56:25 +01002592#define lspci_trivial_usage \
2593 "[-mk]"
2594#define lspci_full_usage "\n\n" \
2595 "List all PCI devices" \
2596 "\n" \
2597 "\n -m Parseable output" \
2598 "\n -k Show driver" \
2599
Souf Oued11a802a2009-12-07 01:37:34 +01002600#define lsusb_trivial_usage NOUSAGE_STR
2601#define lsusb_full_usage ""
2602
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002603#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002604#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002605 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002606#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002607 "Create a range of block or character special files" \
2608 "\n" \
2609 "\nTYPE is:" \
2610 "\n b Block device" \
2611 "\n c Character device" \
2612 "\n f FIFO, MAJOR and MINOR are ignored" \
2613 "\n" \
2614 "\nFIRST..LAST specify numbers appended to NAME." \
2615 "\nIf 's' is the last argument, the base device is created as well." \
2616 "\n" \
2617 "\nExamples:" \
2618 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2619 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002620#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002621 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2622 "[creates ttyS2-ttyS63]\n" \
2623 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2624 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002625#endif
2626
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002627#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002628#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002629 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002630#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002631 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002632 "Device table entries take the form of:\n" \
2633 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002634 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002635 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002636 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002637 " c Character device\n" \
2638 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002639 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002640 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002641 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2642 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002643#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002644 "For example:\n" \
2645 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2646 "/dev d 755 0 0 - - - - -\n" \
2647 "/dev/console c 666 0 0 5 1 - - -\n" \
2648 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2649 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2650 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2651 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2652 "Will Produce:\n" \
2653 "/dev\n" \
2654 "/dev/console\n" \
2655 "/dev/null\n" \
2656 "/dev/zero\n" \
2657 "/dev/hda\n" \
2658 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002659#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002660
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002661#define makemime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002662 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002663#define makemime_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002664 "Create multipart MIME-encoded message from FILEs\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002665/* "Transfer encoding is base64, disposition is inline (not attachment)\n" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002666 "\nOptions:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002667 "\n -o FILE Output. Default: stdout" \
2668 "\n -a HDR Add header. Examples:" \
2669 "\n \"From: user@host.org\", \"Date: `date -R`\"" \
2670 "\n -c CT Content type. Default: text/plain" \
2671 "\n -C CS Charset. Default: " CONFIG_FEATURE_MIME_CHARSET \
2672/* "\n -e ENC Transfer encoding. Ignored. base64 is assumed" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002673 "\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002674 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002675
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002676#define man_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002677 "[OPTIONS] [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002678#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002679 "Format and display manual page\n" \
2680 "\nOptions:" \
2681 "\n -a Display all pages" \
2682 "\n -w Show page locations" \
2683
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002684#define matchpathcon_trivial_usage \
2685 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002686#define matchpathcon_full_usage "\n\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002687 " -n Don't display path" \
2688 "\n -N Don't use translations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002689 "\n -f Use alternate file_context file" \
2690 "\n -p Use prefix to speed translations" \
2691 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002692
Eric Andersen7e9276b2001-02-22 01:15:47 +00002693#define md5sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002694 "[OPTIONS] [FILE]..." \
2695 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTIONS] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002696#define md5sum_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002697 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2698 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002699 "\nOptions:" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002700 "\n -c Check sums against given list" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002701 "\n -s Don't output anything, status code shows success" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002702 "\n -w Warn about improperly formatted checksum lines" \
2703 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002704
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002705#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002706 "$ md5sum < busybox\n" \
2707 "6fd11e98b98a58f64ff3398d7b324003\n" \
2708 "$ md5sum busybox\n" \
2709 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2710 "$ md5sum -c -\n" \
2711 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2712 "busybox: OK\n" \
2713 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002714
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002715#define sha1sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002716 "[OPTIONS] [FILE]..." \
2717 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002718#define sha1sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002719 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002720 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002721 "\nOptions:" \
2722 "\n -c Check sums against given list" \
2723 "\n -s Don't output anything, status code shows success" \
2724 "\n -w Warn about improperly formatted checksum lines" \
2725 )
2726
2727#define sha256sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002728 "[OPTIONS] [FILE]..." \
2729 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha256sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002730#define sha256sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002731 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA256 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002732 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002733 "\nOptions:" \
2734 "\n -c Check sums against given list" \
2735 "\n -s Don't output anything, status code shows success" \
2736 "\n -w Warn about improperly formatted checksum lines" \
2737 )
2738
2739#define sha512sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002740 "[OPTIONS] [FILE]..." \
2741 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha512sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002742#define sha512sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002743 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA512 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002744 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002745 "\nOptions:" \
2746 "\n -c Check sums against given list" \
2747 "\n -s Don't output anything, status code shows success" \
2748 "\n -w Warn about improperly formatted checksum lines" \
2749 )
2750
Rob Landley70f7ef72005-12-13 08:21:33 +00002751#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002752 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002753#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002754 " -s Scan /sys and populate /dev during system boot\n" \
2755 "\n" \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002756 "It can be run by kernel as a hotplug helper. To activate it:\n" \
Denys Vlasenkof92874e2009-12-05 15:59:05 +01002757 " echo /sbin/mdev > /proc/sys/kernel/hotplug\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002758 IF_FEATURE_MDEV_CONF( \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002759 "It uses /etc/mdev.conf with lines\n" \
Denis Vlasenkof2b39e02009-04-13 23:18:52 +00002760 "[-]DEVNAME UID:GID PERM" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002761 IF_FEATURE_MDEV_RENAME(" [>|=PATH]") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002762 IF_FEATURE_MDEV_EXEC(" [@|$|*PROG]") \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002763 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002764
Rob Landleyef10d522006-06-26 14:11:33 +00002765#define mdev_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002766 IF_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002767 "The mdev config file contains lines that look like:\n" \
2768 " hd[a-z][0-9]* 0:3 660\n\n" \
2769 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002770 IF_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002771 "Optionally, that can be followed (on the same line) by a special character\n" \
2772 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002773 "device(s). The environment variable $MDEV indicates the active device node\n" \
2774 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002775 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2776 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002777 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002778 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002779 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002780 "Config file parsing stops on the first matching line. If no config\n" \
2781 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002782 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002783 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002784
Glenn L McGrath061c9002002-09-16 04:21:46 +00002785#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002786 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002787#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002788 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002789 " y Allow write access to your terminal\n" \
2790 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002791
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002792#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002793 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002794#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002795 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2796 "\nOptions:" \
2797 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2798 "\n next byte to it" \
2799 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2800 "\n -s Set serial line to SPEED" \
2801 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002802
Eric Andersen7e9276b2001-02-22 01:15:47 +00002803#define mkdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002804 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002805#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002806 "Create DIRECTORY\n" \
2807 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002808 "\n -m Mode" \
2809 "\n -p No error if exists; make parent directories as needed" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002810 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002811 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002812 )
2813
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002814#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002815 "$ mkdir /tmp/foo\n" \
2816 "$ mkdir /tmp/foo\n" \
2817 "/tmp/foo: File exists\n" \
2818 "$ mkdir /tmp/foo/bar/baz\n" \
2819 "/tmp/foo/bar/baz: No such file or directory\n" \
2820 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002821
Eric Andersen7e9276b2001-02-22 01:15:47 +00002822#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002823 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002824#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002825 "Create named pipe (identical to 'mknod name p')\n" \
2826 "\nOptions:" \
2827 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002828 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002829 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002830 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002831
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002832#define mkfs_ext2_trivial_usage \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002833 "[-Fn] " \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002834 /* "[-c|-l filename] " */ \
2835 "[-b BLK_SIZE] " \
2836 /* "[-f fragment-size] [-g blocks-per-group] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002837 "[-i INODE_RATIO] [-I INODE_SIZE] " \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002838 /* "[-j] [-J journal-options] [-N number-of-inodes] " */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002839 "[-m RESERVED_PERCENT] " \
2840 /* "[-o creator-os] [-O feature[,...]] [-q] " */ \
2841 /* "[r fs-revision-level] [-E extended-options] [-v] [-F] " */ \
2842 "[-L LABEL] " \
2843 /* "[-M last-mounted-directory] [-S] [-T filesystem-type] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002844 "BLOCKDEV [KBYTES]"
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002845#define mkfs_ext2_full_usage "\n\n" \
2846 " -b BLK_SIZE Block size, bytes" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002847/* "\n -c Check device for bad blocks" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002848/* "\n -E opts Set extended options" */ \
2849/* "\n -f size Fragment size in bytes" */ \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002850 "\n -F Force" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002851/* "\n -g N Number of blocks in a block group" */ \
Denys Vlasenko838e07a2009-10-22 12:15:33 +02002852 "\n -i RATIO Max number of files is filesystem_size / RATIO" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002853 "\n -I BYTES Inode size (min 128)" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002854/* "\n -j Create a journal (ext3)" */ \
2855/* "\n -J opts Set journal options (size/device)" */ \
2856/* "\n -l file Read bad blocks list from file" */ \
Denys Vlasenko6a8cfdc2009-10-17 23:41:15 +02002857 "\n -L LBL Volume label" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002858 "\n -m PERCENT Percent of blocks to reserve for admin" \
2859/* "\n -M dir Set last mounted directory" */ \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002860 "\n -n Dry run" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002861/* "\n -N N Number of inodes to create" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002862/* "\n -o os Set the 'creator os' field" */ \
2863/* "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" */ \
2864/* "\n -q Quiet" */ \
2865/* "\n -r rev Set filesystem revision" */ \
2866/* "\n -S Write superblock and group descriptors only" */ \
2867/* "\n -T fs-type Set usage type (news/largefile/largefile4)" */ \
2868/* "\n -v Verbose" */ \
2869
Eric Andersen7e9276b2001-02-22 01:15:47 +00002870#define mkfs_minix_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002871 "[-c | -l FILE] [-nXX] [-iXX] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002872#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002873 "Make a MINIX filesystem\n" \
2874 "\nOptions:" \
2875 "\n -c Check device for bad blocks" \
2876 "\n -n [14|30] Maximum length of filenames" \
2877 "\n -i INODES Number of inodes for the filesystem" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002878 "\n -l FILE Read bad blocks list from FILE" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002879 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002880
Vladimir Dronnikov0d8ea642009-11-02 10:41:46 +01002881#define mkfs_reiser_trivial_usage \
2882 "[-f] [-l LABEL] BLOCKDEV [4K-BLOCKS]"
2883
2884#define mkfs_reiser_full_usage "\n\n" \
2885 "Make a ReiserFS V3 filesystem\n" \
2886 "\nOptions:" \
2887 "\n -f Force" \
2888 "\n -l LBL Volume label" \
2889
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002890#define mkfs_vfat_trivial_usage \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002891 "[-v] [-n LABEL] BLOCKDEV [KBYTES]"
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002892/* Accepted but ignored:
2893 "[-c] [-C] [-I] [-l bad-block-file] [-b backup-boot-sector] "
2894 "[-m boot-msg-file] [-i volume-id] "
2895 "[-s sectors-per-cluster] [-S logical-sector-size] [-f number-of-FATs] "
2896 "[-h hidden-sectors] [-F fat-size] [-r root-dir-entries] [-R reserved-sectors] "
2897*/
2898#define mkfs_vfat_full_usage "\n\n" \
2899 "Make a FAT32 filesystem\n" \
2900 "\nOptions:" \
2901/* "\n -c Check device for bad blocks" */ \
2902 "\n -v Verbose" \
2903/* "\n -I Allow to use entire disk device (e.g. /dev/hda)" */ \
2904 "\n -n LBL Volume label" \
2905
Eric Andersen7e9276b2001-02-22 01:15:47 +00002906#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002907 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002908#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002909 "Create a special file (block, character, or pipe)\n" \
2910 "\nOptions:" \
2911 "\n -m Create the special file using the specified mode (default a=rw)" \
2912 "\nTYPEs include:" \
2913 "\n b: Make a block device" \
2914 "\n c or u: Make a character device" \
2915 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002916 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002917 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002918 )
2919
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002920#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002921 "$ mknod /dev/fd0 b 2 0\n" \
2922 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002923
Eric Andersen7e9276b2001-02-22 01:15:47 +00002924#define mkswap_trivial_usage \
Denys Vlasenko40e7d252010-02-01 23:48:27 +01002925 "[OPTIONS] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002926#define mkswap_full_usage "\n\n" \
Denys Vlasenko68c67462009-11-03 05:51:20 +01002927 "Prepare BLOCKDEV to be used as swap partition\n" \
2928 "\nOptions:" \
2929 "\n -L LBL Label" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002930
Eric Andersen7e9276b2001-02-22 01:15:47 +00002931#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002932 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002933#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002934 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002935 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002936 "\nOptions:" \
2937 "\n -d Make a directory instead of a file" \
2938/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2939 "\n -t Generate a path rooted in temporary directory" \
2940 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2941 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002942 "\nFor -t or -p, directory is chosen as follows:" \
2943 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002944
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002945#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002946 "$ mktemp /tmp/temp.XXXXXX\n" \
2947 "/tmp/temp.mWiLjM\n" \
2948 "$ ls -la /tmp/temp.mWiLjM\n" \
2949 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002950
Eric Andersen8d79ce82001-07-22 23:00:15 +00002951#define modprobe_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002952 IF_MODPROBE_SMALL("[-qfwrsv] MODULE [symbol=value]...") \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002953 IF_NOT_MODPROBE_SMALL("[-" \
2954 IF_FEATURE_2_4_MODULES("k")"nqrsv" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002955 IF_FEATURE_MODPROBE_BLACKLIST("b")"] MODULE [symbol=value]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002956#define modprobe_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002957 "Options:" \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002958 IF_MODPROBE_SMALL( \
2959 "\n -q Quiet" \
2960 "\n -f Force" \
2961 "\n -w Wait for unload" \
2962 "\n -r Remove module (stacks) or do autoclean" \
2963 "\n -s Report via syslog instead of stderr" \
2964 "\n -v Verbose" \
2965 ) \
2966 IF_NOT_MODPROBE_SMALL( \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002967 IF_FEATURE_2_4_MODULES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002968 "\n -k Make module autoclean-able" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002969 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002970 "\n -n Dry run" \
2971 "\n -q Quiet" \
2972 "\n -r Remove module (stacks) or do autoclean" \
2973 "\n -s Report via syslog instead of stderr" \
2974 "\n -v Verbose" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002975 IF_FEATURE_MODPROBE_BLACKLIST( \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002976 "\n -b Apply blacklist to module names too" \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002977 ) \
2978 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002979
Rob Landley9c32a152005-12-11 20:12:24 +00002980#define modprobe_notes_usage \
2981"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2982"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2983"pass each module it loads.\n" \
2984"\n" \
Bernhard Reutner-Fischer12aca792009-02-24 10:03:22 +00002985"The configuration file is searched (in this order):\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002986"\n" \
2987" /etc/modprobe.conf (2.6 only)\n" \
2988" /etc/modules.conf\n" \
2989" /etc/conf.modules (deprecated)\n" \
2990"\n" \
2991"They all have the same syntax (see below). If none is present, it is\n" \
2992"_not_ an error; each loaded module is then expected to load without\n" \
2993"options. Once a file is found, the others are tested for.\n" \
2994"\n" \
2995"/etc/modules.conf entry format:\n" \
2996"\n" \
2997" alias <alias_name> <mod_name>\n" \
2998" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002999" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00003000" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
3001" This makes it also possible to use a different set of options (below) for\n" \
3002" the module and the alias.\n" \
3003" A module can be aliased more than once.\n" \
3004"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003005" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00003006" When loading module mod_name (or the module aliased by alias_name), pass\n" \
3007" the \"symbol=value\" pairs as option to that module.\n" \
3008"\n" \
3009"Sample /etc/modules.conf file:\n" \
3010"\n" \
3011" options tulip irq=3\n" \
3012" alias tulip tulip2\n" \
3013" options tulip2 irq=4 io=0x308\n" \
3014"\n" \
3015"Other functionality offered by 'classic' modprobe is not available in\n" \
3016"this implementation.\n" \
3017"\n" \
3018"If module options are present both in the config file, and on the command line,\n" \
3019"then the options from the command line will be passed to the module _after_\n" \
3020"the options from the config file. That way, you can have defaults in the config\n" \
3021"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00003022#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003023 "(with the above /etc/modules.conf):\n\n" \
3024 "$ modprobe tulip\n" \
3025 " will load the module 'tulip' with default option 'irq=3'\n\n" \
3026 "$ modprobe tulip irq=5\n" \
3027 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
3028 "$ modprobe tulip2\n" \
3029 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
3030 " which are the default for alias 'tulip2'\n\n" \
3031 "$ modprobe tulip2 irq=8\n" \
3032 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
3033 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
3034 " from the command line\n\n" \
3035 "$ modprobe tulip2 irq=2 io=0x210\n" \
3036 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
3037 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
3038 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00003039
Eric Andersen7e9276b2001-02-22 01:15:47 +00003040#define more_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003041 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003042#define more_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003043 "View FILE (or stdin) one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00003044
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003045#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003046 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003047
Eric Andersen7e9276b2001-02-22 01:15:47 +00003048#define mount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003049 "[OPTIONS] [-o OPTS] DEVICE NODE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003050#define mount_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003051 "Mount a filesystem. Filesystem autodetection requires /proc.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003052 "\nOptions:" \
3053 "\n -a Mount all filesystems in fstab" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003054 IF_FEATURE_MOUNT_FAKE( \
3055 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003056 "\n -f Update /etc/mtab, but don't mount" \
3057 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003058 IF_NOT_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003059 "\n -f Dry run" \
3060 ) \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00003061 ) \
Denys Vlasenkoe2e4cc22009-06-19 11:48:29 +02003062 IF_FEATURE_MOUNT_HELPERS( \
3063 "\n -i Don't run mount helper" \
3064 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003065 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003066 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003067 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003068 "\n -r Read-only mount" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003069 "\n -w Read-write mount (default)" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003070 "\n -t FSTYPE Filesystem type" \
3071 "\n -O OPT Mount only filesystems with option OPT (-a only)" \
3072 "\n-o OPT:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003073 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003074 "\n loop Ignored (loop devices are autodetected)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003075 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003076 IF_FEATURE_MOUNT_FLAGS( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003077 "\n [a]sync Writes are [a]synchronous" \
3078 "\n [no]atime Disable/enable updates to inode access times" \
3079 "\n [no]diratime Disable/enable atime updates to directories" \
3080 "\n [no]relatime Disable/enable atime updates relative to modification time" \
3081 "\n [no]dev (Dis)allow use of special device files" \
3082 "\n [no]exec (Dis)allow use of executable files" \
3083 "\n [no]suid (Dis)allow set-user-id-root programs" \
3084 "\n [r]shared Convert [recursively] to a shared subtree" \
3085 "\n [r]slave Convert [recursively] to a slave subtree" \
3086 "\n [r]private Convert [recursively] to a private subtree" \
3087 "\n [un]bindable Make mount point [un]able to be bind mounted" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003088 "\n bind Bind a file or directory to another location" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003089 "\n move Relocate an existing mount point" \
Rob Landleye55a73c2006-08-09 20:55:35 +00003090 ) \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003091 "\n remount Remount a mounted filesystem, changing flags" \
3092 "\n ro/rw Same as -r/-w" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003093 "\n" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003094 "\nThere are filesystem-specific -o flags." \
Denis Vlasenko397de612008-03-17 08:55:44 +00003095
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003096#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003097 "$ mount\n" \
3098 "/dev/hda3 on / type minix (rw)\n" \
3099 "proc on /proc type proc (rw)\n" \
3100 "devpts on /dev/pts type devpts (rw)\n" \
3101 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
3102 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
3103 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00003104#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003105 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003106
Rob Landleyd00b3a52005-08-20 05:07:08 +00003107#define mountpoint_trivial_usage \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003108 "[-q] <[-dn] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003109#define mountpoint_full_usage "\n\n" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003110 "Check if the directory is a mountpoint\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003111 "\nOptions:" \
3112 "\n -q Quiet" \
3113 "\n -d Print major/minor device number of the filesystem" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003114 "\n -n Print device name of the filesystem" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003115 "\n -x Print major/minor device number of the blockdevice" \
3116
Rob Landleyd00b3a52005-08-20 05:07:08 +00003117#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003118 "$ mountpoint /proc\n" \
3119 "/proc is not a mountpoint\n" \
3120 "$ mountpoint /sys\n" \
3121 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00003122
Eric Andersen7e9276b2001-02-22 01:15:47 +00003123#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003124 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003125#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003126 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003127 "\n" \
3128 "Available Opcodes:\n" \
3129 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003130 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
3131 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
3132 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003133 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003134
Eric Andersen7e9276b2001-02-22 01:15:47 +00003135#define mv_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003136 "[OPTIONS] SOURCE DEST\n" \
3137 "or: mv [OPTIONS] SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003138#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003139 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
3140 "\nOptions:" \
3141 "\n -f Don't prompt before overwriting" \
3142 "\n -i Interactive, prompt before overwrite" \
3143
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003144#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003145 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003146
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003147#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003148 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003149#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003150 "Rename network interface while it in the down state\n" \
3151 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003152 "\n -c FILE Use configuration file (default: /etc/mactab)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003153 "\n -s Use syslog (LOCAL0 facility)" \
3154 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
3155
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003156#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003157 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
3158 " or\n" \
3159 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003160
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003161#if !ENABLE_DESKTOP
3162
Rob Landley1cca9482006-07-10 19:45:20 +00003163#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003164#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003165#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003166#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003167#endif
Rob Landley1cca9482006-07-10 19:45:20 +00003168
Eric Andersen7e9276b2001-02-22 01:15:47 +00003169#define nc_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003170 IF_NC_EXTRA("[-iN] [-wN] ")IF_NC_SERVER("[-l] [-p PORT] ") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003171 "["IF_NC_EXTRA("-f FILENAME|")"IPADDR PORT]"IF_NC_EXTRA(" [-e PROG]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003172#define nc_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003173 "Open a pipe to IP:port" IF_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003174 NC_OPTIONS_STR \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003175 IF_NC_EXTRA( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003176 "\n -e PROG Run PROG after connect" \
3177 "\n -i SEC Delay interval for lines sent" \
3178 "\n -w SEC Timeout for connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003179 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003180 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003181 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003182 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003183 IF_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003184 "\n (use -l twice with -e for persistent server)") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003185 "\n -p PORT Local port" \
Rob Landley1cca9482006-07-10 19:45:20 +00003186 )
3187
Rob Landley1cca9482006-07-10 19:45:20 +00003188#define nc_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003189 IF_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003190 "To use netcat as a terminal emulator on a serial port:\n\n" \
3191 "$ stty 115200 -F /dev/ttyS0\n" \
3192 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
3193 )
Rob Landley1cca9482006-07-10 19:45:20 +00003194
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003195#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003196 "$ nc foobar.somedomain.com 25\n" \
3197 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
3198 "help\n" \
3199 "214-Commands supported:\n" \
3200 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
3201 "214 NOOP QUIT RSET HELP\n" \
3202 "quit\n" \
3203 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003204
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003205#else /* DESKTOP nc - much more compatible with nc 1.10 */
3206
3207#define nc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003208 "[OPTIONS] HOST PORT - connect" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003209 IF_NC_SERVER("\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003210 "nc [OPTIONS] -l -p PORT [HOST] [PORT] - listen")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003211#define nc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003212 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003213 "\n -e PROG Run PROG after connect (must be last)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003214 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003215 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003216 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003217 "\n -n Don't do DNS resolution" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003218 "\n -s ADDR Local address" \
3219 "\n -p PORT Local port" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003220 "\n -u UDP mode" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003221 "\n -v Verbose" \
3222 "\n -w SEC Timeout for connects and final net reads" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003223 IF_NC_EXTRA( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003224 "\n -i SEC Delay interval for lines sent" /* ", ports scanned" */ \
3225 "\n -o FILE Hex dump traffic" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003226 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003227 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003228/* "\n -r Randomize local and remote ports" */
3229/* "\n -g gateway Source-routing hop point[s], up to 8" */
3230/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003231/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
3232
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003233/* -e PROG can take ARGS too: "nc ... -e ls -l", but we don't document it
3234 * in help text: nc 1.10 does not allow that. We don't want to entice
3235 * users to use this incompatibility */
3236
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003237#endif
3238
Eric Andersen1552ff72001-10-31 11:07:12 +00003239#define netstat_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003240 "[-laentuwxr"IF_FEATURE_NETSTAT_WIDE("W")IF_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003241#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003242 "Display networking information\n" \
3243 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003244 "\n -l Display listening server sockets" \
3245 "\n -a Display all sockets (default: connected)" \
3246 "\n -e Display other/more information" \
3247 "\n -n Don't resolve names" \
3248 "\n -t Tcp sockets" \
3249 "\n -u Udp sockets" \
3250 "\n -w Raw sockets" \
3251 "\n -x Unix sockets" \
3252 "\n -r Display routing table" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003253 IF_FEATURE_NETSTAT_WIDE( \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003254 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003255 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003256 IF_FEATURE_NETSTAT_PRG( \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003257 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003258 )
Eric Andersen1552ff72001-10-31 11:07:12 +00003259
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003260#define nice_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003261 "[-n ADJUST] [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003262#define nice_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003263 "Run PROG with modified scheduling priority\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003264 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003265 "\n -n ADJUST Adjust priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003266
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003267#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003268 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003269#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003270 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003271 "Format specifiers:\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003272 " %Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003273 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003274 " %[niface] Monitor network interface 'iface'\n" \
3275 " %m Monitor allocated memory\n" \
3276 " %[mf] Monitor free memory\n" \
3277 " %[mt] Monitor total memory\n" \
3278 " %s Monitor allocated swap\n" \
3279 " %f Monitor number of used file descriptors\n" \
3280 " %Ni Monitor total/specific IRQ rate\n" \
3281 " %x Monitor context switch rate\n" \
3282 " %p Monitor forks\n" \
3283 " %[pn] Monitor # of processes\n" \
3284 " %b Monitor block io\n" \
3285 " %Nt Show time (with N decimal points)\n" \
3286 " %Nd Milliseconds between updates (default:1000)\n" \
3287 " %r Print <cr> instead of <lf> at EOL" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003288
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003289#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003290 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003291
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003292#define nohup_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003293 "PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003294#define nohup_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003295 "Run PROG immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003296#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003297 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003298
Eric Andersen7e9276b2001-02-22 01:15:47 +00003299#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003300 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003301#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003302 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003303 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003304#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003305 "$ nslookup localhost\n" \
3306 "Server: default\n" \
3307 "Address: default\n" \
3308 "\n" \
3309 "Name: debian\n" \
3310 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003311
Adam Tkacb1585062009-11-22 03:43:55 +01003312#define ntpd_trivial_usage \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01003313 "[-dnqwl] [-S PROG] [-p PEER]..."
Adam Tkacb1585062009-11-22 03:43:55 +01003314#define ntpd_full_usage "\n\n" \
3315 "NTP client/server\n" \
3316 "\nOptions:" \
3317 "\n -d Verbose" \
3318 "\n -n Do not daemonize" \
Denys Vlasenko8d580c72009-11-23 16:27:16 +01003319 "\n -q Quit after clock is set" \
Denys Vlasenko907647f2009-12-02 23:17:45 +01003320/* -N exists for mostly compat reasons, thus not essential to inform */ \
Denys Vlasenkob2e5fc32009-11-25 14:52:47 +01003321/* the user that it exists: user may use nice as well */ \
3322/* "\n -N Run at high priority" */ \
Denys Vlasenko074e8dc2010-01-04 23:58:13 +01003323 "\n -w Do not set time (only query peers), implies -n" \
Adam Tkacb1585062009-11-22 03:43:55 +01003324 "\n -l Run as server on port 123" \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01003325 "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins" \
Adam Tkacb1585062009-11-22 03:43:55 +01003326 "\n -p PEER Obtain time from PEER (may be repeated)" \
3327
Glenn L McGrath60281112001-11-02 11:39:46 +00003328#define od_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003329 "[-aBbcDdeFfHhIiLlOovXx] " IF_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003330#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003331 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003332 "(or stdin) to stdout"
Glenn L McGrath60281112001-11-02 11:39:46 +00003333
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003334#define openvt_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003335 "[-c N] [-sw] [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003336#define openvt_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003337 "Start PROG on a new virtual terminal\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003338 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003339 "\n -c N Use specified VT" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003340 "\n -s Switch to the VT" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003341/* "\n -l Run PROG as login shell (by prepending '-')" */ \
3342 "\n -w Wait for PROG to exit" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003343
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003344#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003345 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003346
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003347/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003348#define parse_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003349 "[-n MAXTOKENS] [-m MINTOKENS] [-d DELIMS] [-f FLAGS] FILE..."
3350#define parse_full_usage ""
3351*/
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003352
Eric Andersen27f64e12002-06-23 04:24:25 +00003353#define passwd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003354 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003355#define passwd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003356 "Change USER's password. If no USER is specified,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003357 "changes the password for the current user.\n" \
3358 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003359 "\n -a Algorithm to use for password (des, md5)" /* ", sha1)" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00003360 "\n -d Delete password for the account" \
3361 "\n -l Lock (disable) account" \
3362 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003363
Denis Vlasenko21d10142007-07-20 21:28:41 +00003364#define chpasswd_trivial_usage \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003365 IF_LONG_OPTS("[--md5|--encrypted]") IF_NOT_LONG_OPTS("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003366#define chpasswd_full_usage "\n\n" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003367 "Read user:password from stdin and update /etc/passwd\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003368 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003369 IF_LONG_OPTS( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003370 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003371 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003372 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003373 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003374 "\n -e Supplied passwords are in encrypted form" \
3375 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003376 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00003377
Glenn L McGrath655d8142003-06-22 15:32:41 +00003378#define patch_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003379 "[OPTIONS] [ORIGFILE [PATCHFILE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003380#define patch_full_usage "\n\n" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003381 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003382 " -p,--strip N Strip N leading components from file names" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003383 "\n -i,--input DIFF Read DIFF instead of stdin" \
3384 "\n -R,--reverse Reverse patch" \
3385 "\n -N,--forward Ignore already applied patches" \
3386 "\n --dry-run Don't actually change files" \
3387 ) \
3388 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003389 " -p N Strip N leading components from file names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003390 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003391 "\n -R Reverse patch" \
Denys Vlasenkod7874ed2009-08-20 23:33:19 +02003392 "\n -N Ignore already applied patches" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003393 )
Denis Vlasenko397de612008-03-17 08:55:44 +00003394
Glenn L McGrath655d8142003-06-22 15:32:41 +00003395#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003396 "$ patch -p1 < example.diff\n" \
3397 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00003398
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003399#define pgrep_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003400 "[-flnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003401#define pgrep_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003402 "Display process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003403 "\nOptions:" \
3404 "\n -l Show command name too" \
3405 "\n -f Match against entire command line" \
3406 "\n -n Show the newest process only" \
3407 "\n -o Show the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003408 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003409 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003410 "\n -s Match session ID (0 for current)" \
3411 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003412
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003413#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00003414#define pidof_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003415 "[OPTIONS] [NAME]..."
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003416#define USAGE_PIDOF "\n\nOptions:"
3417#else
3418#define pidof_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003419 "[NAME]..."
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003420#define USAGE_PIDOF /* none */
3421#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003422#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003423 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003424 USAGE_PIDOF \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003425 IF_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003426 "\n -s Show only one PID") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003427 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003428 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003429 "\n Use %PPID to omit pid of pidof's parent") \
3430
Eric Andersen221b2ea2001-07-31 19:06:07 +00003431#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003432 "$ pidof init\n" \
3433 "1\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003434 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003435 "$ pidof /bin/sh\n20351 5973 5950\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003436 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003437 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00003438
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003439#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003440#define ping_trivial_usage \
3441 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003442#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003443 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003444#define ping6_trivial_usage \
3445 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003446#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003447 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003448#else
3449#define ping_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003450 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003451#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003452 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3453 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003454 "\n -4, -6 Force IP or IPv6 name resolution" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003455 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003456 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3457 "\n -I IFACE/IP Use interface or IP address as source" \
3458 "\n -W SEC Seconds to wait for the first response (default:10)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003459 "\n (after all -c CNT packets are sent)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003460 "\n -w SEC Seconds until ping exits (default:infinite)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003461 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003462 "\n -q Quiet, only displays output at start" \
3463 "\n and when finished" \
3464
Eric Andersen51b8bd62002-07-03 11:46:38 +00003465#define ping6_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003466 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003467#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003468 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3469 "\nOptions:" \
3470 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003471 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3472 "\n -I IFACE/IP Use interface or IP address as source" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003473 "\n -q Quiet, only displays output at start" \
3474 "\n and when finished" \
3475
Eric Andersen51b8bd62002-07-03 11:46:38 +00003476#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003477#define ping_example_usage \
3478 "$ ping localhost\n" \
3479 "PING slag (127.0.0.1): 56 data bytes\n" \
3480 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3481 "\n" \
3482 "--- debian ping statistics ---\n" \
3483 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3484 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003485#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003486 "$ ping6 ip6-localhost\n" \
3487 "PING ip6-localhost (::1): 56 data bytes\n" \
3488 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3489 "\n" \
3490 "--- ip6-localhost ping statistics ---\n" \
3491 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3492 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003493
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003494#define pipe_progress_trivial_usage NOUSAGE_STR
3495#define pipe_progress_full_usage ""
3496
Eric Andersen7e9276b2001-02-22 01:15:47 +00003497#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003498 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003499#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003500 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003501 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003502
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003503#define pkill_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003504 "[-l|-SIGNAL] [-fnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003505#define pkill_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003506 "Send a signal to process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003507 "\nOptions:" \
3508 "\n -l List all signals" \
3509 "\n -f Match against entire command line" \
3510 "\n -n Signal the newest process only" \
3511 "\n -o Signal the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003512 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003513 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003514 "\n -s Match session ID (0 for current)" \
3515 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003516
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003517#define popmaildir_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003518 "[OPTIONS] MAILDIR [CONN_HELPER ARGS]"
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003519#define popmaildir_full_usage "\n\n" \
3520 "Fetch content of remote mailbox to local maildir\n" \
3521 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003522/* "\n -b Binary mode. Ignored" */ \
3523/* "\n -d Debug. Ignored" */ \
3524/* "\n -m Show used memory. Ignored" */ \
3525/* "\n -V Show version. Ignored" */ \
3526/* "\n -c Use tcpclient. Ignored" */ \
3527/* "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003528 "\n -s Skip authorization" \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003529 "\n -T Get messages with TOP instead of RETR" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003530 "\n -k Keep retrieved messages on the server" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003531 "\n -t SEC Network timeout" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003532 IF_FEATURE_POPMAILDIR_DELIVERY( \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003533 "\n -F \"PROG ARGS\" Filter program (may be repeated)" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003534 "\n -M \"PROG ARGS\" Delivery program" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003535 ) \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003536 "\n" \
3537 "\nFetch from plain POP3 server:" \
3538 "\npopmaildir -k DIR nc pop3.server.com 110 <user_and_pass.txt" \
3539 "\nFetch from SSLed POP3 server and delete fetched emails:" \
3540 "\npopmaildir DIR -- openssl s_client -quiet -connect pop3.server.com:995 <user_and_pass.txt"
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003541/* "\n -R BYTES Remove old messages on the server >= BYTES. Ignored" */
3542/* "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" */
3543/* "\n -L BYTES Don't retrieve new messages >= BYTES. Ignored" */
3544/* "\n -H LINES Type first LINES of a message. Ignored" */
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003545#define popmaildir_example_usage \
3546 "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n" \
3547 "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
3548
Eric Andersen7e9276b2001-02-22 01:15:47 +00003549#define poweroff_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003550 "[-d DELAY] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003551#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003552 "Halt and shut off power\n" \
3553 "\nOptions:" \
3554 "\n -d Delay interval for halting" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003555 "\n -n Do not sync" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003556 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003557
Mike Frysinger95d3c452005-04-21 23:29:24 +00003558#define printenv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003559 "[VARIABLE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003560#define printenv_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003561 "Print environment VARIABLEs.\n" \
3562 "If no VARIABLE specified, print all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003563
Eric Andersen7e9276b2001-02-22 01:15:47 +00003564#define printf_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003565 "FORMAT [ARGUMENT]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003566#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003567 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003568 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003569#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003570 "$ printf \"Val=%d\\n\" 5\n" \
3571 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003572
Denis Vlasenko94949192006-11-05 00:45:47 +00003573
3574#if ENABLE_DESKTOP
3575
3576#define ps_trivial_usage \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003577 "[-o COL1,COL2=HEADER]" IF_FEATURE_SHOW_THREADS(" [-T]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003578#define ps_full_usage "\n\n" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003579 "Show list of processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003580 "\nOptions:" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003581 "\n -o COL1,COL2=HEADER Select columns for display" \
Denys Vlasenko532609e2009-09-20 20:29:25 +02003582 IF_FEATURE_SHOW_THREADS( \
3583 "\n -T Show threads" \
3584 )
Denis Vlasenko94949192006-11-05 00:45:47 +00003585
3586#else /* !ENABLE_DESKTOP */
3587
Denis Vlasenko397de612008-03-17 08:55:44 +00003588#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003589#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003590#else
3591#define USAGE_PS "\nOptions:"
3592#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003593
Eric Andersen7e9276b2001-02-22 01:15:47 +00003594#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003595 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003596#define ps_full_usage "\n\n" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003597 "Show list of processes\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003598 USAGE_PS \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003599 IF_SELINUX( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003600 "\n -Z Show selinux context" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003601 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003602 IF_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003603 "\n w Wide output" \
3604 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003605
Denis Vlasenko94949192006-11-05 00:45:47 +00003606#endif /* ENABLE_DESKTOP */
3607
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003608#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003609 "$ ps\n" \
3610 " PID Uid Gid State Command\n" \
3611 " 1 root root S init\n" \
3612 " 2 root root S [kflushd]\n" \
3613 " 3 root root S [kupdate]\n" \
3614 " 4 root root S [kpiod]\n" \
3615 " 5 root root S [kswapd]\n" \
3616 " 742 andersen andersen S [bash]\n" \
3617 " 743 andersen andersen S -bash\n" \
3618 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003619 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003620
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003621#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003622 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003623#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003624 "Scan a host, print all open ports\n" \
3625 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003626 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003627 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003628 "\n -p Scan from this port (default 1)" \
3629 "\n -P Scan up to this port (default 1024)" \
3630 "\n -t Timeout (default 5000 ms)" \
3631 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3632
Eric Andersen7e9276b2001-02-22 01:15:47 +00003633#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003634 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003635#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003636 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003637#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003638 "$ pwd\n" \
3639 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003640
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003641#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003642 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003643#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003644 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003645#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003646 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003647
Eric Andersen7e9276b2001-02-22 01:15:47 +00003648#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003649 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003650#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003651 "Get and possibly set the system date and time from a remote HOST\n" \
3652 "\nOptions:" \
3653 "\n -s Set the system date and time (default)" \
3654 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003655
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00003656#define rdev_trivial_usage \
3657 ""
3658#define rdev_full_usage "\n\n" \
3659 "Print the device node associated with the filesystem mounted at '/'"
3660#define rdev_example_usage \
3661 "$ rdev\n" \
3662 "/dev/mtdblock9 /\n"
3663
Rob Landley0e4690d2006-08-20 22:12:18 +00003664#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003665 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003666#define readahead_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003667 "Preload FILEs to RAM"
Rob Landley0e4690d2006-08-20 22:12:18 +00003668
Eric Andersen7e9276b2001-02-22 01:15:47 +00003669#define readlink_trivial_usage \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003670 IF_FEATURE_READLINK_FOLLOW("[-fnv] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003671#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003672 "Display the value of a symlink" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003673 IF_FEATURE_READLINK_FOLLOW( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003674 "\nOptions:" \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003675 "\n -f Canonicalize by following all symlinks" \
3676 "\n -n Don't add newline" \
3677 "\n -v Verbose" \
3678 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003679
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003680#define readprofile_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003681 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003682#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003683 "Options:" \
3684 "\n -m mapfile (Default: /boot/System.map)" \
3685 "\n -p profile (Default: /proc/profile)" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003686 "\n -M NUM Set the profiling multiplier to NUM" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003687 "\n -i Print only info about the sampling step" \
3688 "\n -v Verbose" \
3689 "\n -a Print all symbols, even if count is 0" \
3690 "\n -b Print individual histogram-bin counts" \
3691 "\n -s Print individual counters within functions" \
3692 "\n -r Reset all the counters (root only)" \
3693 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003694
Glenn L McGrath62fae302002-12-10 00:14:33 +00003695#define realpath_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003696 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003697#define realpath_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003698 "Return the absolute pathnames of given FILE"
Tim Riker7b253f82003-12-28 05:02:40 +00003699
Eric Andersen7e9276b2001-02-22 01:15:47 +00003700#define reboot_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003701 "[-d DELAY] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003702#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003703 "Reboot the system\n" \
3704 "\nOptions:" \
3705 "\n -d Delay interval for rebooting" \
3706 "\n -n No call to sync()" \
3707 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003708
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003709#define reformime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003710 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003711#define reformime_full_usage "\n\n" \
3712 "Parse MIME-encoded message\n" \
3713 "\nOptions:" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003714 "\n -x PREFIX Extract content of MIME sections to files" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003715 "\n -X PROG ARGS Filter content of MIME sections through PROG" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003716 "\n Must be the last option" \
3717 "\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003718 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003719
Eric Andersen7e9276b2001-02-22 01:15:47 +00003720#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003721 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003722#define renice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003723 "Change priority of running processes\n" \
3724 "\nOptions:" \
3725 "\n -n Adjust current nice value (smaller is faster)" \
3726 "\n -p Process id(s) (default)" \
3727 "\n -g Process group id(s)" \
3728 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003729
Denys Vlasenko5e611152009-05-19 17:36:16 +02003730#define scriptreplay_trivial_usage \
3731 "timingfile [typescript [divisor]]"
3732#define scriptreplay_full_usage "\n\n" \
3733 "Play back typescripts, using timing information"
3734
Eric Andersen7e9276b2001-02-22 01:15:47 +00003735#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003736 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003737#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003738 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003739
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003740#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003741 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003742#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003743 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003744
Denis Vlasenko397137b2007-07-23 14:03:30 +00003745#define restorecon_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003746 "[-iFnRv] [-e EXCLUDEDIR]... [-o FILE] [-f FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003747#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003748 "Reset security contexts of files in pathname\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003749 "\n -i Ignore files that don't exist" \
3750 "\n -f FILE File with list of files to process" \
3751 "\n -e DIR Directory to exclude" \
3752 "\n -R,-r Recurse" \
3753 "\n -n Don't change any file labels" \
3754 "\n -o FILE Save list of files with incorrect context" \
3755 "\n -v Verbose" \
3756 "\n -vv Show changed labels" \
3757 "\n -F Force reset of context to match file_context" \
3758 "\n for customizable files, or the user section," \
3759 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003760
Souf Oued43afd752010-05-02 18:45:02 +02003761#define rfkill_trivial_usage \
3762 "COMMAND [INDEX|TYPE]"
3763#define rfkill_full_usage "\n\n" \
3764 "Enable/disable wireless devices\n" \
3765 "\nCommands:" \
3766 "\n list [INDEX|TYPE] List current state" \
3767 "\n block INDEX|TYPE Disable device" \
3768 "\n unblock INDEX|TYPE Enable device" \
3769 "\n" \
3770 "\n TYPE: all, wlan(wifi), bluetooth, uwb(ultrawideband)," \
3771 "\n wimax, wwan, gps, fm" \
3772
Eric Andersen7e9276b2001-02-22 01:15:47 +00003773#define rm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003774 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003775#define rm_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003776 "Remove (unlink) FILEs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003777 "\nOptions:" \
3778 "\n -i Always prompt before removing" \
3779 "\n -f Never prompt" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003780 "\n -R,-r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003781
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003782#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003783 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003784
Eric Andersen7e9276b2001-02-22 01:15:47 +00003785#define rmdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003786 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003787#define rmdir_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003788 "Remove DIRECTORY if it is empty\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003789 "\nOptions:" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003790 IF_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003791 "\n -p|--parents Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003792 "\n --ignore-fail-on-non-empty" \
3793 ) \
3794 IF_NOT_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003795 "\n -p Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003796 )
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003797
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003798#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003799 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003800
Eric Andersen7e9276b2001-02-22 01:15:47 +00003801#define rmmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003802 "[OPTIONS] [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003803#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003804 "Unload the specified kernel modules from the kernel\n" \
3805 "\nOptions:" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003806 "\n -w Wait until the module is no longer used" \
3807 "\n -f Force unloading" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003808 "\n -a Remove all unused modules (recursively)" \
3809
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003810#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003811 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003812
Eric Andersen7e9276b2001-02-22 01:15:47 +00003813#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003814 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003815#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003816 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003817 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003818 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003819 "\n -e Display other/more information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003820 "\n -A inet" IF_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003821
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003822#define rpm_trivial_usage \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02003823 "-i PACKAGE.rpm; rpm -qp[ildc] PACKAGE.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003824#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003825 "Manipulate RPM packages\n" \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02003826 "\nCommands:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003827 "\n -i Install package" \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02003828 "\n -qp Query package" \
3829 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003830 "\n -i Show information" \
3831 "\n -l List contents" \
3832 "\n -d List documents" \
3833 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003834
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003835#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003836 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003837#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003838 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003839
Mike Frysinger6b160e42008-02-15 02:27:19 +00003840#define rtcwake_trivial_usage \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003841 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SEC | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003842#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003843 "Enter a system sleep state until specified wakeup time\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003844 IF_LONG_OPTS( \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003845 "\n -a,--auto Read clock mode from adjtime" \
3846 "\n -l,--local Clock is set to local time" \
3847 "\n -u,--utc Clock is set to UTC time" \
3848 "\n -d,--device=DEV Specify the RTC device" \
3849 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003850 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003851 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003852 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003853 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003854 "\n -a Read clock mode from adjtime" \
3855 "\n -l Clock is set to local time" \
3856 "\n -u Clock is set to UTC time" \
3857 "\n -d DEV Specify the RTC device" \
3858 "\n -m MODE Set the sleep state (default: standby)" \
3859 "\n -s SEC Set the timeout in SEC seconds from now" \
3860 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003861 )
3862
Denis Vlasenko49622d72007-03-10 16:58:49 +00003863#define runcon_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003864 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] PROG ARGS\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003865 "runcon CONTEXT PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003866#define runcon_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003867 "Run PROG in a different security context\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003868 "\n CONTEXT Complete security context\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003869 IF_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003870 "\n -c,--compute Compute process transition context before modifying" \
3871 "\n -t,--type=TYPE Type (for same role as parent)" \
3872 "\n -u,--user=USER User identity" \
3873 "\n -r,--role=ROLE Role" \
3874 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003875 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003876 IF_NOT_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003877 "\n -c Compute process transition context before modifying" \
3878 "\n -t TYPE Type (for same role as parent)" \
3879 "\n -u USER User identity" \
3880 "\n -r ROLE Role" \
3881 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003882 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003883
Eric Andersen6cf47a72001-10-31 10:24:36 +00003884#define run_parts_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003885 "[-t] "IF_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003886#define run_parts_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003887 "Run a bunch of scripts in DIRECTORY\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003888 "\nOptions:" \
3889 "\n -t Print what would be run, but don't actually run anything" \
3890 "\n -a ARG Pass ARG as argument for every program" \
3891 "\n -u MASK Set the umask to MASK before running every program" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003892 IF_FEATURE_RUN_PARTS_FANCY( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003893 "\n -l Print names of all matching files even if they are not executable" \
3894 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003895
3896#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003897 "$ run-parts -a start /etc/init.d\n" \
3898 "$ run-parts -a stop=now /etc/init.d\n\n" \
3899 "Let's assume you have a script foo/dosomething:\n" \
3900 "#!/bin/sh\n" \
3901 "for i in $*; do eval $i; done; unset i\n" \
3902 "case \"$1\" in\n" \
3903 "start*) echo starting something;;\n" \
3904 "stop*) set -x; shutdown -h $stop;;\n" \
3905 "esac\n\n" \
3906 "Running this yields:\n" \
3907 "$run-parts -a stop=+4m foo/\n" \
3908 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003909
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003910#define runlevel_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003911 "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003912#define runlevel_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003913 "Find the current and previous system runlevel\n" \
3914 "\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003915 "If no utmp FILE exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003916 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003917#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003918 "$ runlevel /var/run/utmp\n" \
3919 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003920
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003921#define runsv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003922 "DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003923#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003924 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003925
3926#define runsvdir_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003927 "[-P] [-s SCRIPT] DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003928#define runsvdir_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003929 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
3930 "\n -P Put each runsv in a new session" \
3931 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003932
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003933#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003934 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003935#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003936 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003937#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003938 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003939
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003940#define script_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003941 "[-afq" IF_SCRIPTREPLAY("t") "] [-c PROG] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003942#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003943 "Options:" \
3944 "\n -a Append output" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003945 "\n -c PROG Run PROG, not shell" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003946 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003947 "\n -q Quiet" \
Denys Vlasenko5e611152009-05-19 17:36:16 +02003948 IF_SCRIPTREPLAY( \
3949 "\n -t Send timing to stderr" \
3950 )
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003951
Eric Andersen7e9276b2001-02-22 01:15:47 +00003952#define sed_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003953 "[-efinr] SED_CMD [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003954#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003955 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003956 "\n -e CMD Add CMD to sed commands to be executed" \
3957 "\n -f FILE Add FILE contents to sed commands to be executed" \
Denys Vlasenkodac863a2009-10-27 09:11:17 +01003958 "\n -i Edit files in-place (else sends result to stdout)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003959 "\n -n Suppress automatic printing of pattern space" \
3960 "\n -r Use extended regex syntax" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003961 "\n" \
Rob Landley7b284152009-10-26 16:04:07 -05003962 "\nIf no -e or -f, the first non-option argument is the sed command string." \
3963 "\nRemaining arguments are input files (stdin if none)."
Eric Andersenf802ff72004-04-12 15:12:06 +00003964
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003965#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003966 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3967 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003968
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003969#define selinuxenabled_trivial_usage NOUSAGE_STR
3970#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003971
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003972#define sendmail_trivial_usage \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003973 "[OPTIONS] [RECIPIENT_EMAIL]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003974#define sendmail_full_usage "\n\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003975 "Read email from stdin and send it\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003976 "\nStandard options:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003977 "\n -t Read additional recipients from message body" \
3978 "\n -f sender Sender (required)" \
3979 "\n -o options Various options. -oi implied, others are ignored" \
Vladimir Dronnikovb618dba2009-10-04 01:34:54 +02003980 "\n -i -oi synonym. implied and ignored" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003981 "\n" \
3982 "\nBusybox specific options:" \
3983 "\n -w seconds Network timeout" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003984 "\n -H 'PROG ARGS' Run connection helper" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003985 "\n Examples:" \
Denis Vlasenko7e0c2432009-03-02 16:12:00 +00003986 "\n -H 'exec openssl s_client -quiet -tls1 -starttls smtp" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003987 "\n -connect smtp.gmail.com:25' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003988 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003989 "\n -H 'exec openssl s_client -quiet -tls1" \
3990 "\n -connect smtp.gmail.com:465' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003991 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003992 "\n -S server[:port] Server" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003993 "\n -au<username> Username for AUTH LOGIN" \
3994 "\n -ap<password> Password for AUTH LOGIN" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003995 "\n -am<method> Authentication method. Ignored. LOGIN is implied" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003996 "\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003997 "\nOther options are silently ignored; -oi -t is implied" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003998 IF_MAKEMIME( \
3999 "\nUse makemime applet to create message with attachments" \
4000 )
Denis Vlasenko73032ca2008-01-28 22:47:03 +00004001
Glenn L McGrath82364bb2004-01-27 09:22:20 +00004002#define seq_trivial_usage \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00004003 "[-w] [-s SEP] [FIRST [INC]] LAST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004004#define seq_full_usage "\n\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00004005 "Print numbers from FIRST to LAST, in steps of INC.\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004006 "FIRST, INC default to 1.\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00004007 "\nOptions:" \
4008 "\n -w Pad to last with leading zeros" \
4009 "\n -s SEP String separator" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00004010
Denis Vlasenko705eaf82007-11-22 01:10:41 +00004011#define sestatus_trivial_usage \
4012 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004013#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004014 " -v Verbose" \
4015 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00004016
Paul Foxfc2256a2005-08-01 18:12:30 +00004017#define setconsole_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004018 "[-r" IF_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004019#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004020 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
4021 "\nOptions:" \
4022 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00004023
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004024#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004025 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00004026#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004027
Denis Vlasenko397137b2007-07-23 14:03:30 +00004028#define setfiles_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004029 "[-dnpqsvW] [-e DIR]... [-o FILE] [-r alt_root_path]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004030 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397137b2007-07-23 14:03:30 +00004031 " [-c policyfile] spec_file" \
4032 ) \
4033 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004034#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004035 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004036 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004037 "\n -c FILE Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00004038 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004039 "\n -d Show which specification matched each file" \
4040 "\n -l Log changes in file labels to syslog" \
4041 "\n -n Don't change any file labels" \
4042 "\n -q Suppress warnings" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004043 "\n -r DIR Use an alternate root path" \
4044 "\n -e DIR Exclude DIR" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004045 "\n -F Force reset of context to match file_context for customizable files" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004046 "\n -o FILE Save list of files with incorrect context" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004047 "\n -s Take a list of files from stdin (instead of command line)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004048 "\n -v Show changes in file labels, if type or role are changing" \
4049 "\n -vv Show changes in file labels, if type, role, or user are changing" \
4050 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00004051
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00004052#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00004053 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00004054#define setfont_full_usage "\n\n" \
4055 "Load a console font\n" \
4056 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00004057 "\n -m MAPFILE Load console screen map" \
4058 "\n -C TTY Affect TTY instead of /dev/tty" \
4059
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00004060#define setfont_example_usage \
4061 "$ setfont -m koi8-r /etc/i18n/fontname\n"
4062
Eric Andersen7e9276b2001-02-22 01:15:47 +00004063#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004064 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004065#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004066 "Set entries into the kernel's scancode-to-keycode map,\n" \
4067 "allowing unusual keyboards to generate usable keycodes.\n\n" \
4068 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004069 "and KEYCODE is given in decimal." \
Denis Vlasenko397de612008-03-17 08:55:44 +00004070
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004071#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004072 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004073
Rob Landley87848d92006-03-27 23:23:43 +00004074#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004075 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004076#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004077 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00004078
Denis Vlasenkobe039372007-10-14 04:48:44 +00004079#define setsebool_trivial_usage \
4080 "boolean value"
4081
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004082#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00004083 "Change boolean setting"
4084
Paul Fox42403642005-08-01 22:52:09 +00004085#define setsid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004086 "PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004087#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004088 "Run PROG in a new session. PROG will have no controlling terminal\n" \
4089 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
4090 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00004091
Eric Andersen2e9c2572003-08-08 22:26:06 +00004092#define last_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004093 ""IF_FEATURE_LAST_FANCY("[-HW] [-f FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004094#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004095 "Show listing of the last users that logged into the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004096 IF_FEATURE_LAST_FANCY( "\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004097 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00004098/* "\n -H Show header line" */ \
4099 "\n -W Display with no host column truncation" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004100 "\n -f FILE Read from FILE instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004101 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00004102
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00004103#define showkey_trivial_usage \
4104 "[-a | -k | -s]"
4105#define showkey_full_usage "\n\n" \
4106 "Show keys pressed\n" \
4107 "\nOptions:" \
4108 "\n -a Display decimal/octal/hex values of the keys" \
4109 "\n -k Display interpreted keycodes (default)" \
4110 "\n -s Display raw scan-codes" \
4111
Denis Vlasenko14923db2007-06-20 15:23:03 +00004112#define slattach_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004113 "[-cehmLF] [-s SPEED] [-p PROTOCOL] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004114#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004115 "Attach network interface(s) to serial line(s)\n" \
4116 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004117 "\n -p PROT Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
4118 "\n -s SPD Set line speed" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004119 "\n -e Exit after initializing device" \
4120 "\n -h Exit when the carrier is lost" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004121 "\n -c PROG Run PROG when the line is hung up" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004122 "\n -m Do NOT initialize the line in raw 8 bits mode" \
4123 "\n -L Enable 3-wire operation" \
4124 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00004125
Eric Andersen7e9276b2001-02-22 01:15:47 +00004126#define sleep_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004127 IF_FEATURE_FANCY_SLEEP("[") "N" IF_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004128#define sleep_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004129 IF_NOT_FEATURE_FANCY_SLEEP("Pause for N seconds") \
4130 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004131 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004132 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004133#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004134 "$ sleep 2\n" \
4135 "[2 second delay results]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004136 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004137 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004138 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00004139
Eric Andersen7e9276b2001-02-22 01:15:47 +00004140#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004141 "[-nru" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004142 IF_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004143 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004144#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004145 "Sort lines of text\n" \
4146 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004147 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004148 "\n -b Ignore leading blanks" \
4149 "\n -c Check whether input is sorted" \
4150 "\n -d Dictionary order (blank or alphanumeric only)" \
4151 "\n -f Ignore case" \
4152 "\n -g General numerical sort" \
4153 "\n -i Ignore unprintable characters" \
4154 "\n -k Sort key" \
4155 "\n -M Sort month" \
4156 ) \
4157 "\n -n Sort numbers" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004158 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004159 "\n -o Output to file" \
4160 "\n -k Sort by key" \
4161 "\n -t CHAR Key separator" \
4162 ) \
4163 "\n -r Reverse sort order" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004164 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004165 "\n -s Stable (don't sort ties alphabetically)" \
4166 ) \
4167 "\n -u Suppress duplicate lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004168 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004169 "\n -z Lines are terminated by NUL, not newline" \
4170 "\n -mST Ignored for GNU compatibility") \
4171
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004172#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004173 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
4174 "a\n" \
4175 "b\n" \
4176 "c\n" \
4177 "d\n" \
4178 "e\n" \
4179 "f\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004180 IF_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00004181 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
4182 "d 2\n" \
4183 "b 2\n" \
4184 "c 3\n" \
4185 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004186 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004187
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00004188#define split_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004189 "[OPTIONS] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004190#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00004191 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004192 "\n -b n[k|m] Split by bytes" \
4193 "\n -l n Split by lines" \
4194 "\n -a n Use n letters as suffix" \
4195
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00004196#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00004197 "$ split TODO foo\n" \
4198 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00004199
Eric Andersenc2af1ee2001-10-18 19:33:06 +00004200#define start_stop_daemon_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004201 "[OPTIONS] [-S|-K] ... [-- ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004202#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004203 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004204 "-K: stop all matching processes.\n" \
4205 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004206 IF_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004207 "\nProcess matching:" \
4208 "\n -u,--user USERNAME|UID Match only this user's processes" \
4209 "\n -n,--name NAME Match processes with NAME" \
4210 "\n in comm field in /proc/PID/stat" \
4211 "\n -x,--exec EXECUTABLE Match processes with this command" \
4212 "\n in /proc/PID/cmdline" \
4213 "\n -p,--pidfile FILE Match a process with PID from the file" \
4214 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004215 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004216 "\n -x,--exec EXECUTABLE Program to run" \
4217 "\n -a,--startas NAME Zeroth argument" \
4218 "\n -b,--background Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004219 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004220 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004221 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004222 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
4223 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004224 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004225 "\n -s,--signal SIG Signal to send" \
4226 "\n -t,--test Match only, exit with 0 if a process is found" \
4227 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004228 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004229 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004230 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00004231 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00004232 "\n -q,--quiet Quiet" \
4233 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004234 IF_NOT_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004235 "\nProcess matching:" \
4236 "\n -u USERNAME|UID Match only this user's processes" \
4237 "\n -n NAME Match processes with NAME" \
4238 "\n in comm field in /proc/PID/stat" \
4239 "\n -x EXECUTABLE Match processes with this command" \
4240 "\n command in /proc/PID/cmdline" \
4241 "\n -p FILE Match a process with PID from the file" \
4242 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004243 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004244 "\n -x EXECUTABLE Program to run" \
4245 "\n -a NAME Zeroth argument" \
4246 "\n -b Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004247 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004248 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00004249 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004250 "\n -c USER[:[GRP]] Change to user/group" \
4251 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004252 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004253 "\n -s SIG Signal to send" \
4254 "\n -t Match only, exit with 0 if a process is found" \
4255 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004256 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004257 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004258 "\n -v Verbose" \
4259 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00004260 "\n -q Quiet" \
4261 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00004262
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004263#define stat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004264 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004265#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004266 "Display file (default) or filesystem status\n" \
4267 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004268 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004269 "\n -c fmt Use the specified format" \
4270 ) \
4271 "\n -f Display filesystem status" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004272 "\n -L Follow links" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004273 "\n -t Display info in terse form" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004274 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004275 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004276 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004277 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004278 "\n\nValid format sequences for files:\n" \
4279 " %a Access rights in octal\n" \
4280 " %A Access rights in human readable form\n" \
4281 " %b Number of blocks allocated (see %B)\n" \
4282 " %B The size in bytes of each block reported by %b\n" \
4283 " %d Device number in decimal\n" \
4284 " %D Device number in hex\n" \
4285 " %f Raw mode in hex\n" \
4286 " %F File type\n" \
4287 " %g Group ID of owner\n" \
4288 " %G Group name of owner\n" \
4289 " %h Number of hard links\n" \
4290 " %i Inode number\n" \
4291 " %n File name\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004292 " %N File name, with -> TARGET if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004293 " %o I/O block size\n" \
4294 " %s Total size, in bytes\n" \
4295 " %t Major device type in hex\n" \
4296 " %T Minor device type in hex\n" \
4297 " %u User ID of owner\n" \
4298 " %U User name of owner\n" \
4299 " %x Time of last access\n" \
4300 " %X Time of last access as seconds since Epoch\n" \
4301 " %y Time of last modification\n" \
4302 " %Y Time of last modification as seconds since Epoch\n" \
4303 " %z Time of last change\n" \
4304 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004305 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004306 " %a Free blocks available to non-superuser\n" \
4307 " %b Total data blocks in file system\n" \
4308 " %c Total file nodes in file system\n" \
4309 " %d Free file nodes in file system\n" \
4310 " %f Free blocks in file system\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004311 IF_SELINUX( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004312 " %C Security context in selinux\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004313 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004314 " %i File System ID in hex\n" \
4315 " %l Maximum length of filenames\n" \
4316 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004317 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004318 " %S Fundamental block size (for block counts)\n" \
4319 " %t Type in hex\n" \
4320 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004321 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004322
Eric Andersenef5e8f82002-11-07 02:09:37 +00004323#define strings_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004324 "[-afo] [-n LEN] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004325#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004326 "Display printable strings in a binary file\n" \
4327 "\nOptions:" \
4328 "\n -a Scan whole file (default)" \
4329 "\n -f Precede strings with filenames" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004330 "\n -n LEN At least LEN characters form a string (default 4)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004331 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00004332
Eric Andersen7e9276b2001-02-22 01:15:47 +00004333#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004334 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004335#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004336 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004337 "and deviations from stty sane\n" \
4338 "\nOptions:" \
4339 "\n -F DEVICE Open device instead of stdin" \
4340 "\n -a Print all current settings in human-readable form" \
4341 "\n -g Print in stty-readable form" \
4342 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004343
Robert Griebl1fca5582002-06-04 20:45:46 +00004344#define su_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004345 "[OPTIONS] [-] [USERNAME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004346#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004347 "Change user id or become root\n" \
4348 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004349 "\n -p,-m Preserve environment" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004350 "\n -c CMD Command to pass to 'sh -c'" \
4351 "\n -s SH Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00004352
Eric Andersen27f64e12002-06-23 04:24:25 +00004353#define sulogin_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004354 "[-t N] [TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004355#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004356 "Single user login\n" \
4357 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004358 "\n -t N Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004359
Mike Frysinger95d3c452005-04-21 23:29:24 +00004360#define sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004361 "[-rs] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004362#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004363 "Checksum and count the blocks in a file\n" \
4364 "\nOptions:" \
4365 "\n -r Use BSD sum algorithm (1K blocks)" \
4366 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00004367
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004368#define sv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004369 "[-v] [-w SEC] CMD SERVICE_DIR..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004370#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004371 "Control services monitored by runsv supervisor.\n" \
4372 "Commands (only first character is enough):\n" \
4373 "\n" \
4374 "status: query service status\n" \
4375 "up: if service isn't running, start it. If service stops, restart it\n" \
4376 "once: like 'up', but if service stops, don't restart it\n" \
4377 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004378 " if it exists. After it stops, don't restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004379 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004380 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004381 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004382 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004383
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004384#define svlogd_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004385 "[-ttv] [-r C] [-R CHARS] [-l MATCHLEN] [-b BUFLEN] DIR..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004386#define svlogd_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004387 "Continuously read log data from stdin, optionally\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004388 "filter log messages, and write the data to one or more automatically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004389 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004390
Eric Andersen7e9276b2001-02-22 01:15:47 +00004391#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004392 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004393#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004394 "Stop swapping on DEVICE\n" \
4395 "\nOptions:" \
4396 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004397
Eric Andersen7e9276b2001-02-22 01:15:47 +00004398#define swapon_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004399 "[-a]" IF_FEATURE_SWAPON_PRI(" [-p PRI]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004400#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004401 "Start swapping on DEVICE\n" \
4402 "\nOptions:" \
4403 "\n -a Start swapping on all swap devices" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004404 IF_FEATURE_SWAPON_PRI( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004405 "\n -p PRI Set swap device priority" \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004406 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004407
Rob Landley0f34a822005-10-27 22:55:50 +00004408#define switch_root_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004409 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004410#define switch_root_full_usage "\n\n" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004411 "Free initramfs and switch to another root fs:\n" \
4412 "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n" \
4413 "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004414 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004415 "\n -c DEV Reopen stdio to DEV after switch" \
Rob Landley0f34a822005-10-27 22:55:50 +00004416
Eric Andersen7e9276b2001-02-22 01:15:47 +00004417#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004418 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004419#define sync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004420 "Write all buffered blocks to disk"
4421
4422#define fsync_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004423 "[OPTIONS] FILE..."
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004424#define fsync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004425 "Write files' buffered blocks to disk\n" \
4426 "\nOptions:" \
4427 "\n -d Avoid syncing metadata"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004428
Eric Andersenb9050282003-12-24 06:02:11 +00004429#define sysctl_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004430 "[OPTIONS] [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004431#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004432 "Configure kernel parameters at runtime\n" \
4433 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004434 "\n -n Don't print key names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004435 "\n -e Don't warn about unknown keys" \
4436 "\n -w Change sysctl setting" \
4437 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
4438 "\n -a Display all values" \
4439 "\n -A Display all values in table form" \
4440
Eric Andersen5d38f5b2005-09-12 21:42:48 +00004441#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00004442 "sysctl [-n] [-e] variable...\n" \
4443 "sysctl [-n] [-e] -w variable=value...\n" \
4444 "sysctl [-n] [-e] -a\n" \
4445 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
4446 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00004447
Eric Andersen7e9276b2001-02-22 01:15:47 +00004448#define syslogd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004449 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004450#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004451 "System logging utility.\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004452 "This version of syslogd ignores /etc/syslog.conf\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004453 "\nOptions:" \
4454 "\n -n Run in foreground" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004455 "\n -O FILE Log to given file (default:/var/log/messages)" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004456 "\n -l N Set local log level" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004457 "\n -S Smaller logging output" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004458 IF_FEATURE_ROTATE_LOGFILE( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004459 "\n -s SIZE Max size (KB) before rotate (default:200KB, 0=off)" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004460 "\n -b N N rotated logs to keep (default:1, max=99, 0=purge)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004461 IF_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004462 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
4463 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004464 IF_FEATURE_SYSLOGD_DUP( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004465 "\n -D Drop duplicates") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004466 IF_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004467 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00004468 /* NB: -Csize shouldn't have space (because size is optional) */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004469/* "\n -m MIN Minutes between MARK lines (default:20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00004470
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004471#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004472 "$ syslogd -R masterlog:514\n" \
4473 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004474
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004475#define tac_trivial_usage \
4476 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004477#define tac_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004478 "Concatenate FILEs and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004479
Eric Andersen7e9276b2001-02-22 01:15:47 +00004480#define tar_trivial_usage \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004481 "-[" IF_FEATURE_TAR_CREATE("c") "xt" IF_FEATURE_SEAMLESS_GZ("z") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004482 IF_FEATURE_SEAMLESS_BZ2("j") IF_FEATURE_SEAMLESS_LZMA("a") \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004483 IF_FEATURE_SEAMLESS_Z("Z") IF_FEATURE_TAR_NOPRESERVE_TIME("m") "vO] " \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004484 IF_FEATURE_TAR_FROM("[-X FILE] ") \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004485 "[-f TARFILE] [-C DIR] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004486#define tar_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004487 IF_FEATURE_TAR_CREATE("Create, extract, ") \
4488 IF_NOT_FEATURE_TAR_CREATE("Extract ") \
4489 "or list files from a tar file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004490 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004491 IF_FEATURE_TAR_CREATE( \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004492 "\n c Create" \
4493 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004494 "\n x Extract" \
4495 "\n t List" \
4496 "\nArchive format selection:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004497 IF_FEATURE_SEAMLESS_GZ( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004498 "\n z Filter the archive through gzip" \
4499 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004500 IF_FEATURE_SEAMLESS_BZ2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004501 "\n j Filter the archive through bzip2" \
4502 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004503 IF_FEATURE_SEAMLESS_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004504 "\n a Filter the archive through lzma" \
4505 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004506 IF_FEATURE_SEAMLESS_Z( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004507 "\n Z Filter the archive through compress" \
4508 ) \
Mikhail Gusarov0d478332010-01-19 20:22:30 +06004509 IF_FEATURE_TAR_NOPRESERVE_TIME( \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004510 "\n m Do not restore mtime" \
Mikhail Gusarov0d478332010-01-19 20:22:30 +06004511 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004512 "\nFile selection:" \
4513 "\n f Name of TARFILE or \"-\" for stdin" \
4514 "\n O Extract to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004515 IF_FEATURE_TAR_FROM( \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004516 IF_FEATURE_TAR_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004517 "\n exclude File to exclude" \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004518 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004519 "\n X File with names to exclude" \
4520 ) \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004521 "\n C Change to DIR before operation" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004522 "\n v Verbose" \
4523
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004524#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004525 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
4526 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004527
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004528#define taskset_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004529 "[-p] [MASK] [PID | PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004530#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004531 "Set or get CPU affinity\n" \
4532 "\nOptions:" \
4533 "\n -p Operate on an existing PID" \
4534
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004535#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004536 "$ taskset 0x7 ./dgemm_test&\n" \
4537 "$ taskset -p 0x1 $!\n" \
4538 "pid 4790's current affinity mask: 7\n" \
4539 "pid 4790's new affinity mask: 1\n" \
4540 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4541 "pid 6671's current affinity mask: 1\n" \
4542 "pid 6671's new affinity mask: 1\n" \
4543 "$ taskset -p 1\n" \
4544 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004545
Eric Andersen7e9276b2001-02-22 01:15:47 +00004546#define tee_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004547 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004548#define tee_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004549 "Copy stdin to each FILE, and also to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004550 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004551 "\n -a Append to the given FILEs, don't overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004552 "\n -i Ignore interrupt signals (SIGINT)" \
4553
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004554#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004555 "$ echo \"Hello\" | tee /tmp/foo\n" \
4556 "$ cat /tmp/foo\n" \
4557 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004558
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004559#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004560#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004561 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004562#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004563 "Connect to telnet server\n" \
4564 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004565 "\n -a Automatic login with $USER variable" \
4566 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004567
Eric Andersen539ffc92004-02-22 12:25:47 +00004568#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004569#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004570 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004571#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004572 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004573#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004574
Eric Andersen08a72202002-09-30 20:52:10 +00004575#define telnetd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004576 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004577#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004578 "Handle incoming telnet connections" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004579 IF_NOT_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004580 "\nOptions:" \
4581 "\n -l LOGIN Exec LOGIN on connect" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004582 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004583 "\n -K Close connection as soon as login exits" \
4584 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004585 IF_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004586 "\n -p PORT Port to listen on" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004587 "\n -b ADDR[:PORT] Address to bind to" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004588 "\n -F Run in foreground" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004589 "\n -i Inetd mode" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004590 IF_FEATURE_TELNETD_INETD_WAIT( \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004591 "\n -w SEC Inetd 'wait' mode, linger time SEC" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004592 "\n -S Log to syslog (implied by -i or without -F and -w)" \
4593 ) \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004594 )
Eric Andersen08a72202002-09-30 20:52:10 +00004595
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004596/* "test --help" does not print help (POSIX compat), only "[ --help" does.
Denys Vlasenko662078f2010-01-14 13:27:34 +01004597 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION")
4598 * Unfortunately, it screws up generated BusyBox.html. TODO. */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004599#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004600 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004601#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004602 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4603 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004604#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004605 "$ test 1 -eq 2\n" \
4606 "$ echo $?\n" \
4607 "1\n" \
4608 "$ test 1 -eq 1\n" \
4609 "$ echo $?\n" \
4610 "0\n" \
4611 "$ [ -d /etc ]\n" \
4612 "$ echo $?\n" \
4613 "0\n" \
4614 "$ [ -d /junk ]\n" \
4615 "$ echo $?\n" \
4616 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004617
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004618#define tc_trivial_usage \
4619 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
4620#define tc_full_usage "\n\n" \
4621 "OBJECT: {qdisc|class|filter}\n" \
4622 "CMD: {add|del|change|replace|show}\n" \
4623 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004624 "qdisc [ handle QHANDLE ] [ root |"IF_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004625 /* "[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4626 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4627 " QDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004628 "qdisc show [ dev STRING ]"IF_FEATURE_TC_INGRESS(" [ingress]")"\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004629 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004630 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004631 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
4632 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
4633 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004634 " [ root | classid CLASSID ] [ handle FILTERID ]\n" \
4635 " [ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004636 "filter show [ dev STRING ] [ root | parent CLASSID ]"
4637
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004638#define tcpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004639 "[-hEv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004640/* with not-implemented options: */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004641/* "[-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 +00004642#define tcpsvd_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004643 "Create TCP socket, bind to IP:PORT and listen\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004644 "for incoming connection. Run PROG for each connection.\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004645 "\n IP IP to listen on. '0' = all" \
4646 "\n PORT Port to listen on" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004647 "\n PROG ARGS Program to run" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004648 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4649 "\n -u USER[:GRP] Change to user/group after bind" \
4650 "\n -c N Handle up to N connections simultaneously" \
4651 "\n -b N Allow a backlog of approximately N TCP SYNs" \
4652 "\n -C N[:MSG] Allow only up to N connections from the same IP" \
4653 "\n New connections from this IP address are closed" \
4654 "\n immediately. MSG is written to the peer before close" \
4655 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004656 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004657 "\n -v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004658
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004659#define udpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004660 "[-hEv] [-c N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004661#define udpsvd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004662 "Create UDP socket, bind to IP:PORT and wait\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004663 "for incoming packets. Run PROG for each packet,\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004664 "redirecting all further packets with same peer ip:port to it.\n" \
4665 "\n IP IP to listen on. '0' = all" \
4666 "\n PORT Port to listen on" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004667 "\n PROG ARGS Program to run" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004668 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4669 "\n -u USER[:GRP] Change to user/group after bind" \
4670 "\n -c N Handle up to N connections simultaneously" \
4671 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004672 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004673 "\n -v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004674
Mark Whitley450736c2001-03-02 19:08:50 +00004675#define tftp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004676 "[OPTIONS] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004677#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004678 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004679 "\nOptions:" \
4680 "\n -l FILE Local FILE" \
4681 "\n -r FILE Remote FILE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004682 IF_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004683 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004684 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004685 IF_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004686 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004687 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004688 IF_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004689 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004690 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004691
4692#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004693 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004694#define tftpd_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004695 "Transfer a file on tftp client's request\n" \
Denis Vlasenko91f8f822008-10-30 23:42:37 +00004696 "\n" \
4697 "tftpd should be used as an inetd service.\n" \
4698 "tftpd's line for inetd.conf:\n" \
4699 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
4700 "It also can be ran from udpsvd:\n" \
4701 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004702 "\nOptions:" \
4703 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004704 "\n -c Allow file creation via upload" \
4705 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004706
Eric Andersenc3657422001-11-30 07:54:32 +00004707#define time_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004708 "[OPTIONS] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004709#define time_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004710 "Run PROG, display resource usage when it exits\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004711 "\nOptions:" \
4712 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004713
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004714#define timeout_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004715 "[-t SECS] [-s SIG] PROG ARGS"
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004716#define timeout_full_usage "\n\n" \
4717 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
Denis Vlasenko42404082008-11-24 13:42:24 +00004718 "Defaults: SECS: 10, SIG: TERM." \
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004719
Eric Andersen420b2082002-09-17 22:14:58 +00004720#define top_trivial_usage \
Denys Vlasenko00528822009-09-11 23:26:42 +02004721 "[-b] [-nCOUNT] [-dSECONDS]" IF_FEATURE_TOPMEM(" [-m]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004722#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004723 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004724 "Read the status of all processes from /proc each SECONDS\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004725 "and display a screenful of them." \
4726//TODO: add options and keyboard commands
Eric Andersen420b2082002-09-17 22:14:58 +00004727
Eric Andersen7e9276b2001-02-22 01:15:47 +00004728#define touch_trivial_usage \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004729 "[-c] [-d DATE] FILE [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004730#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004731 "Update the last-modified date on the given FILE[s]\n" \
4732 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004733 "\n -c Don't create files" \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004734 "\n -d DT Date/time to use" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004735
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004736#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004737 "$ ls -l /tmp/foo\n" \
4738 "/bin/ls: /tmp/foo: No such file or directory\n" \
4739 "$ touch /tmp/foo\n" \
4740 "$ ls -l /tmp/foo\n" \
4741 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004742
4743#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004744 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004745#define tr_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004746 "Translate, squeeze, or delete characters from stdin, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004747 "\nOptions:" \
4748 "\n -c Take complement of STRING1" \
4749 "\n -d Delete input characters coded STRING1" \
4750 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4751
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004752#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004753 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4754 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004755
Eric Andersen5c58d282001-07-10 16:29:00 +00004756#define traceroute_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004757 "[-"IF_TRACEROUTE6("46")"FIldnrv] [-f 1ST_TTL] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
4758 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-g GATEWAY] [-i IFACE]\n" \
4759 " [-z PAUSE_MSEC] HOST [BYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004760#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004761 "Trace the route to HOST\n" \
4762 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004763 IF_TRACEROUTE6( \
4764 "\n -4, -6 Force IP or IPv6 name resolution" \
4765 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004766 "\n -F Set the don't fragment bit" \
4767 "\n -I Use ICMP ECHO instead of UDP datagrams" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004768 "\n -l Display the TTL value of the returned packet" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004769 "\n -d Set SO_DEBUG options to socket" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004770 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004771 "\n -r Bypass routing tables, send directly to HOST" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004772 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004773 "\n -m Max time-to-live (max number of hops)" \
4774 "\n -p Base UDP port number used in probes" \
4775 "\n (default 33434)" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004776 "\n -q Number of probes per TTL (default 3)" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004777 "\n -s IP address to use as the source address" \
4778 "\n -t Type-of-service in probe packets (default 0)" \
4779 "\n -w Time in seconds to wait for a response (default 3)" \
4780 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004781
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004782#define traceroute6_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004783 "[-dnrv] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
4784 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-i IFACE]\n" \
4785 " HOST [BYTES]"
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004786#define traceroute6_full_usage "\n\n" \
4787 "Trace the route to HOST\n" \
4788 "\nOptions:" \
4789 "\n -d Set SO_DEBUG options to socket" \
4790 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004791 "\n -r Bypass routing tables, send directly to HOST" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004792 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004793 "\n -m Max time-to-live (max number of hops)" \
4794 "\n -p Base UDP port number used in probes" \
4795 "\n (default is 33434)" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004796 "\n -q Number of probes per TTL (default 3)" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004797 "\n -s IP address to use as the source address" \
4798 "\n -t Type-of-service in probe packets (default 0)" \
4799 "\n -w Time in seconds to wait for a response (default 3)" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004800
Eric Andersen7e9276b2001-02-22 01:15:47 +00004801#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004802 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004803#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004804 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004805#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004806 "$ true\n" \
4807 "$ echo $?\n" \
4808 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004809
Eric Andersen7e9276b2001-02-22 01:15:47 +00004810#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004811 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004812#define tty_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004813 "Print file name of stdin's terminal" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004814 IF_INCLUDE_SUSv2( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004815 "\nOptions:" \
4816 "\n -s Print nothing, only return exit status" \
4817 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004818#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004819 "$ tty\n" \
4820 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004821
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004822#define ttysize_trivial_usage \
4823 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004824#define ttysize_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004825 "Print dimension(s) of stdin's terminal, on error return 80x25"
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004826
Denis Vlasenko39b68132009-01-23 02:07:14 +00004827#define tunctl_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004828 "[-f device] ([-t name] | -d name)" IF_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]")
Denis Vlasenko39b68132009-01-23 02:07:14 +00004829#define tunctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004830 "Create or delete tun interfaces\n" \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004831 "\nOptions:" \
4832 "\n -f name tun device (/dev/net/tun)" \
4833 "\n -t name Create iface 'name'" \
4834 "\n -d name Delete iface 'name'" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004835 IF_FEATURE_TUNCTL_UG( \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004836 "\n -u owner Set iface owner" \
4837 "\n -g group Set iface group" \
4838 "\n -b Brief output" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004839 )
Denis Vlasenko39b68132009-01-23 02:07:14 +00004840#define tunctl_example_usage \
4841 "# tunctl\n" \
4842 "# tunctl -d tun0\n"
4843
Mike Frysinger174808c2005-06-11 01:14:09 +00004844#define tune2fs_trivial_usage \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004845/* "[-c max-mounts-count] [-e errors-behavior] [-g group] " */ \
4846/* "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " */ \
4847/* "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " */ \
4848/* "[-r reserved-blocks-count] [-u user] [-C mount-count] " */ \
4849 "[-L LABEL] " \
4850/* "[-M last-mounted-dir] [-O [^]feature[,...]] " */ \
4851/* "[-T last-check-time] [-U UUID] " */ \
4852 "BLOCKDEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004853#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004854 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004855
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004856#define udhcpc_trivial_usage \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004857 "[-fbnqvoCR] [-i IFACE] [-r IP] [-s PROG] [-p PIDFILE]\n" \
4858 " [-H HOSTNAME] [-c CID] [-V VENDOR] [-O DHCP_OPT]..." IF_FEATURE_UDHCP_PORT(" [-P N]")
4859#define udhcpc_full_usage "\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004860 IF_LONG_OPTS( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004861 "\n -i,--interface IFACE Interface to use (default eth0)" \
4862 "\n -p,--pidfile FILE Create pidfile" \
4863 "\n -r,--request IP IP address to request" \
4864 "\n -s,--script PROG Run PROG at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
4865 "\n -t,--retries N Send up to N discover packets" \
4866 "\n -T,--timeout N Pause between packets (default 3 seconds)" \
Denys Vlasenkoe6080a42010-04-14 14:04:26 -07004867 "\n -A,--tryagain N Wait N seconds after failure (default 20)" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004868 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004869 USE_FOR_MMU( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004870 "\n -b,--background Background if lease is not obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004871 ) \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004872 "\n -S,--syslog Log to syslog too" \
4873 "\n -n,--now Exit if lease is not obtained" \
4874 "\n -q,--quit Exit after obtaining lease" \
4875 "\n -R,--release Release IP on exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004876 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004877 "\n -P,--client-port N Use port N (default 68)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004878 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004879 IF_FEATURE_UDHCPC_ARPING( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004880 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004881 ) \
Denys Vlasenkoe6080a42010-04-14 14:04:26 -07004882 "\n -O,--request-option OPT Request DHCP option OPT (cumulative)" \
4883 "\n -o,--no-default-options Don't request any options (unless -O is given)" \
4884 "\n -x OPT:VAL Include option OPT in sent packets (cumulative)" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004885 "\n -F,--fqdn NAME Ask server to update DNS mapping for NAME" \
4886 "\n -H,-h,--hostname NAME Send NAME as client hostname (default none)" \
4887 "\n -V,--vendorclass VENDOR Vendor identifier (default 'udhcp VERSION')" \
4888 "\n -c,--clientid CLIENTID Client identifier (default own MAC)" \
4889 "\n -C,--clientid-none Don't send client identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004890 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004891 IF_NOT_LONG_OPTS( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004892 "\n -i IFACE Interface to use (default eth0)" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +01004893 "\n -p FILE Create pidfile" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004894 "\n -r IP IP address to request" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004895 "\n -s PROG Run PROG at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
4896 "\n -t N Send up to N discover packets" \
4897 "\n -T N Pause between packets (default 3 seconds)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004898 "\n -A N Wait N seconds (default 20) after failure" \
Denys Vlasenko7e6add12010-03-25 20:32:38 +01004899 "\n -x OPT:VAL Include option OPT in sent packets" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004900 "\n -O OPT Request DHCP option OPT (cumulative)" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004901 "\n -o Don't request any options (unless -O is given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004902 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004903 USE_FOR_MMU( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004904 "\n -b Background if lease is not obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004905 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004906 "\n -S Log to syslog too" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004907 "\n -n Exit if lease is not obtained" \
4908 "\n -q Exit after obtaining lease" \
4909 "\n -R Release IP on exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004910 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004911 "\n -P N Use port N (default 68)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004912 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004913 IF_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004914 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004915 ) \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004916 "\n -F NAME Ask server to update DNS mapping for NAME" \
4917 "\n -H,-h NAME Send NAME as client hostname (default none)" \
4918 "\n -V VENDOR Vendor identifier (default 'udhcp VERSION')" \
4919 "\n -c CLIENTID Client identifier (default own MAC)" \
4920 "\n -C Don't send client identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004921 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004922
Russ Dill61fb4892002-10-14 21:41:28 +00004923#define udhcpd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004924 "[-fS]" IF_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004925
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004926#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004927 "DHCP server\n" \
4928 "\n -f Run in foreground" \
4929 "\n -S Log to syslog too" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004930 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004931 "\n -P N Use port N (default 67)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004932 )
Russ Dill61fb4892002-10-14 21:41:28 +00004933
Eric Andersen7e9276b2001-02-22 01:15:47 +00004934#define umount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004935 "[OPTIONS] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004936#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004937 "Unmount file systems\n" \
4938 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004939 IF_FEATURE_UMOUNT_ALL( \
4940 "\n -a Unmount all file systems" IF_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004941 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004942 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004943 "\n -n Don't erase /etc/mtab entries" \
4944 ) \
4945 "\n -r Try to remount devices as read-only if mount is busy" \
4946 "\n -l Lazy umount (detach filesystem)" \
4947 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004948 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004949 "\n -d Free loop device if it has been used" \
4950 )
4951
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004952#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004953 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004954
4955#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004956 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004957#define uname_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004958 "Print system information\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004959 "\nOptions:" \
4960 "\n -a Print all" \
4961 "\n -m The machine (hardware) type" \
4962 "\n -n Hostname" \
4963 "\n -r OS release" \
4964 "\n -s OS name (default)" \
4965 "\n -p Processor type" \
4966 "\n -v OS version" \
4967
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004968#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004969 "$ uname -a\n" \
4970 "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 +00004971
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004972#define uncompress_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004973 "[-cf] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004974#define uncompress_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004975 "Uncompress .Z file[s]\n" \
4976 "\nOptions:" \
4977 "\n -c Extract to stdout" \
4978 "\n -f Overwrite an existing file" \
Tim Riker7b253f82003-12-28 05:02:40 +00004979
Denis Vlasenko3952f202007-08-13 14:10:24 +00004980#define unexpand_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004981 "[-fa][-t N] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004982#define unexpand_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004983 "Convert spaces to tabs, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004984 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004985 IF_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004986 "\n -a,--all Convert all blanks" \
4987 "\n -f,--first-only Convert only leading blanks" \
4988 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004989 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004990 IF_NOT_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004991 "\n -a Convert all blanks" \
4992 "\n -f Convert only leading blanks" \
4993 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004994 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004995
Eric Andersen7e9276b2001-02-22 01:15:47 +00004996#define uniq_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004997 "[-cdu][-f,s,w N] [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004998#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004999 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005000 "\nOptions:" \
5001 "\n -c Prefix lines by the number of occurrences" \
5002 "\n -d Only print duplicate lines" \
5003 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00005004 "\n -f N Skip first N fields" \
5005 "\n -s N Skip first N chars (after any skipped fields)" \
5006 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005007
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005008#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005009 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
5010 "a\n" \
5011 "b\n" \
5012 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005013
Glenn L McGrath87ac7022002-01-02 13:52:26 +00005014#define unzip_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005015 "[-opts[modifiers]] FILE[.zip] [LIST] [-x XLIST] [-d DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005016#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005017 "Extract files from ZIP archives\n" \
5018 "\nOptions:" \
5019 "\n -l List archive contents (with -q for short form)" \
5020 "\n -n Never overwrite existing files (default)" \
5021 "\n -o Overwrite files without prompting" \
5022 "\n -p Send output to stdout" \
5023 "\n -q Quiet" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005024 "\n -x XLST Exclude these files" \
5025 "\n -d DIR Extract files into DIR" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00005026
Eric Andersen7e9276b2001-02-22 01:15:47 +00005027#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005028 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005029#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005030 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00005031
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005032#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005033 "$ uptime\n" \
5034 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005035
5036#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005037 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005038#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005039 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00005040
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005041#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005042 "$ usleep 1000000\n" \
5043 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005044
5045#define uudecode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01005046 "[-o OUTFILE] [INFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005047#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00005048 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005049 "Finds outfile name in uuencoded source unless -o is given"
5050
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005051#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005052 "$ uudecode -o busybox busybox.uu\n" \
5053 "$ ls -l busybox\n" \
5054 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005055
5056#define uuencode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01005057 "[-m] [INFILE] STORED_FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005058#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005059 "Uuencode a file to stdout\n" \
5060 "\nOptions:" \
5061 "\n -m Use base64 encoding per RFC1521" \
5062
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005063#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005064 "$ uuencode busybox busybox\n" \
5065 "begin 755 busybox\n" \
5066 "<encoded file snipped>\n" \
5067 "$ uudecode busybox busybox > busybox.uu\n" \
5068 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005069
Eric Andersen853c4942003-01-23 05:59:32 +00005070#define vconfig_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005071 "COMMAND [OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005072#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005073 "Create and remove virtual ethernet devices\n" \
5074 "\nOptions:" \
5075 "\n add [interface-name] [vlan_id]" \
5076 "\n rem [vlan-name]" \
5077 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
5078 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
5079 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
5080 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00005081
Eric Andersen3f980402001-04-04 17:31:15 +00005082#define vi_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005083 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005084#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005085 "Edit FILE\n" \
5086 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005087 IF_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00005088 "\n -c Initial command to run ($EXINIT also available)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005089 IF_FEATURE_VI_READONLY( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01005090 "\n -R Read-only") \
Denis Vlasenko397de612008-03-17 08:55:44 +00005091 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00005092
Eric Andersen27f64e12002-06-23 04:24:25 +00005093#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005094 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005095#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005096 "Lock a virtual terminal. A password is required to unlock.\n" \
5097 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00005098 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00005099
Matthew Stoltenberg4803db52009-08-13 00:59:32 +02005100#define volname_trivial_usage \
5101 "[DEVICE]"
5102#define volname_full_usage "\n\n" \
5103 "Show CD volume name of the DEVICE (default /dev/cdrom)"
5104
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005105#define wall_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01005106 "[FILE]"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005107#define wall_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01005108 "Write content of FILE or stdin to all logged-in users"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005109#define wall_sample_usage \
5110 "echo foo | wall\n" \
5111 "wall ./mymessage"
5112
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005113#define watch_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01005114 "[-n SEC] [-t] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005115#define watch_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005116 "Run PROG periodically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005117 "\nOptions:" \
5118 "\n -n Loop period in seconds (default 2)" \
5119 "\n -t Don't print header" \
5120
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005121#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005122 "$ watch date\n" \
5123 "Mon Dec 17 10:31:40 GMT 2000\n" \
5124 "Mon Dec 17 10:31:42 GMT 2000\n" \
5125 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005126
Eric Andersen7e9276b2001-02-22 01:15:47 +00005127#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005128 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005129#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005130 "Periodically write to watchdog device DEV\n" \
5131 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005132 "\n -T N Reboot after N seconds if not reset (default 60)" \
5133 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00005134 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00005135 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005136 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005137
5138#define wc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005139 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005140#define wc_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01005141 "Print line, word, and byte counts for each FILE (or stdin),\n" \
5142 "and a total line if more than one FILE is specified\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005143 "\nOptions:" \
5144 "\n -c Print the byte counts" \
5145 "\n -l Print the newline counts" \
5146 "\n -L Print the length of the longest line" \
5147 "\n -w Print the word counts" \
5148
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005149#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005150 "$ wc /etc/passwd\n" \
5151 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005152
5153#define wget_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005154 IF_FEATURE_WGET_LONG_OPTIONS( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005155 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document FILE]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00005156 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005157 " [--no-check-certificate] [-U|--user-agent AGENT] URL" \
Denis Vlasenko03630782007-10-18 11:11:12 +00005158 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005159 IF_NOT_FEATURE_WGET_LONG_OPTIONS( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005160 "[-csq] [-O FILE] [-Y on/off] [-P DIR] [-U AGENT] URL" \
Denis Vlasenko03630782007-10-18 11:11:12 +00005161 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005162#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005163 "Retrieve files via HTTP or FTP\n" \
5164 "\nOptions:" \
5165 "\n -s Spider mode - only check file existence" \
5166 "\n -c Continue retrieval of aborted transfer" \
5167 "\n -q Quiet" \
5168 "\n -P Set directory prefix to DIR" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005169 "\n -O FILE Save to FILE ('-' for stdout)" \
5170 "\n -U STR Use STR for User-Agent header" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005171 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005172
5173#define which_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005174 "[COMMAND]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005175#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005176 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005177#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005178 "$ which login\n" \
5179 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00005180
Eric Andersen00a6a752002-04-26 23:53:10 +00005181#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00005182 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005183#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005184 "Show who is logged on\n" \
5185 "\nOptions:" \
5186 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005187
5188#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005189 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005190#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005191 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005192
5193#define xargs_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01005194 "[OPTIONS] [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005195#define xargs_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01005196 "Run PROG on every item given by stdin\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005197 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005198 IF_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005199 "\n -p Ask user whether to run each command") \
Denys Vlasenko07697852009-10-06 21:11:37 +02005200 "\n -r Don't run command if input is empty" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005201 IF_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005202 "\n -0 Input is separated by NUL characters") \
5203 "\n -t Print the command on stderr before execution" \
Denis Vlasenkoe82da4d2008-08-21 19:59:30 +00005204 "\n -e[STR] STR stops input processing" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005205 "\n -n N Pass no more than N args to PROG" \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005206 "\n -s N Pass command line of no more than N bytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005207 IF_FEATURE_XARGS_SUPPORT_TERMOPT( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005208 "\n -x Exit if size is exceeded") \
Denis Vlasenko397de612008-03-17 08:55:44 +00005209
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005210#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005211 "$ ls | xargs gzip\n" \
5212 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005213
5214#define yes_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005215 "[OPTIONS] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005216#define yes_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005217 "Repeatedly output a line with STRING, or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00005218
Eric Andersen7e9276b2001-02-22 01:15:47 +00005219#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005220 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005221#define zcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005222 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00005223
Rob Landleyad8071f2005-04-30 03:49:37 +00005224#define zcip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005225 "[OPTIONS] IFACE SCRIPT"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005226#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005227 "Manage a ZeroConf IPv4 link-local address\n" \
5228 "\nOptions:" \
5229 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00005230 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005231 "\n -r 169.254.x.x Request this address first" \
5232 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00005233 "\n" \
5234 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
5235 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00005236
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00005237
5238#endif