blob: 92a106e3b93d066f875435a00f6a7a8c8ba5e240 [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
Denys Vlasenkof0f94702010-06-06 01:53:38 +020018INSERT
19
Denis Vlasenkod16950d2008-11-29 09:05:50 +000020#define acpid_trivial_usage \
Souf Ouedccb7a432010-09-26 12:40:05 +020021 "[-d] [-c CONFDIR] [-l LOGFILE] [-a ACTIONFILE] [-M MAPFILE] [-e PROC_EVENT_FILE] [-p PIDFILE]"
Denis Vlasenkod16950d2008-11-29 09:05:50 +000022#define acpid_full_usage "\n\n" \
23 "Listen to ACPI events and spawn specific helpers on event arrival\n" \
24 "\nOptions:" \
Denis Vlasenkod16950d2008-11-29 09:05:50 +000025 "\n -c DIR Config directory [/etc/acpi]" \
Souf Ouedccb7a432010-09-26 12:40:05 +020026 "\n -d Don't daemonize, (implies -f)" \
Denis Vlasenkod16950d2008-11-29 09:05:50 +000027 "\n -e FILE /proc event file [/proc/acpi/event]" \
Souf Ouedccb7a432010-09-26 12:40:05 +020028 "\n -f Run in foreground" \
29 "\n -l FILE Log file [/var/log/acpid.log]" \
30 "\n -p FILE Pid file [/var/run/acpid.pid]" \
31 "\n -a FILE Action file [/etc/acpid.conf]" \
32 "\n -M FILE Map file [/etc/acpi.map]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +000033 IF_FEATURE_ACPID_COMPAT( \
Denis Vlasenkod16950d2008-11-29 09:05:50 +000034 "\n\nAccept and ignore compatibility options -g -m -s -S -v" \
35 )
36
37#define acpid_example_usage \
Souf Ouedccb7a432010-09-26 12:40:05 +020038 "Without -e option, acpid uses all /dev/input/event* files\n" \
39 "# acpid\n" \
Denis Vlasenkod16950d2008-11-29 09:05:50 +000040 "# acpid -l /var/log/my-acpi-log\n" \
Souf Ouedccb7a432010-09-26 12:40:05 +020041 "# acpid -e /proc/acpi/event\n"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000042
Eric Andersenf349e972001-08-21 16:18:59 +000043#define addgroup_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010044 "[-g GID] " IF_FEATURE_ADDUSER_TO_GROUP("[USER] ") "GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000045#define addgroup_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +000046 "Add a group " IF_FEATURE_ADDUSER_TO_GROUP("or add a user to a group") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000047 "\nOptions:" \
Denis Vlasenko4f98e192008-04-13 22:12:19 +000048 "\n -g GID Group id" \
Denis Vlasenkoc2931aa2009-04-22 21:35:52 +000049 "\n -S Create a system group" \
Eric Andersenf349e972001-08-21 16:18:59 +000050
51#define adduser_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010052 "[OPTIONS] USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000053#define adduser_full_usage "\n\n" \
Denis Vlasenko73ac0562008-12-25 01:01:23 +000054 "Add a user\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000055 "\nOptions:" \
56 "\n -h DIR Home directory" \
57 "\n -g GECOS GECOS field" \
58 "\n -s SHELL Login shell" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +020059 "\n -G GRP Add user to existing group" \
Denis Vlasenko397de612008-03-17 08:55:44 +000060 "\n -S Create a system user" \
Denys Vlasenko07697852009-10-06 21:11:37 +020061 "\n -D Don't assign a password" \
62 "\n -H Don't create home directory" \
Denis Vlasenkoc2931aa2009-04-22 21:35:52 +000063 "\n -u UID User id" \
Eric Andersenf349e972001-08-21 16:18:59 +000064
Mark Whitley6f932772001-03-20 19:18:10 +000065#define adjtimex_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010066 "[-q] [-o OFF] [-f FREQ] [-p TCONST] [-t TICK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000067#define adjtimex_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +010068 "Read and optionally set system timebase parameters. See adjtimex(2)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000069 "\nOptions:" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010070 "\n -q Quiet" \
71 "\n -o OFF Time offset, microseconds" \
72 "\n -f FREQ Frequency adjust, integer kernel units (65536 is 1ppm)" \
73 "\n (positive values make clock run faster)" \
74 "\n -t TICK Microseconds per tick, usually 10000" \
75 "\n -p TCONST" \
Mark Whitley6f932772001-03-20 19:18:10 +000076
Eric Andersen7e9276b2001-02-22 01:15:47 +000077#define ar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000078 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000079#define ar_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000080 "Extract or list FILES from an ar archive\n" \
81 "\nOptions:" \
82 "\n -o Preserve original dates" \
83 "\n -p Extract to stdout" \
84 "\n -t List" \
85 "\n -x Extract" \
86 "\n -v Verbose" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000087
Denis Vlasenkofa85b862007-01-07 01:24:12 +000088#define arp_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010089 "\n[-vn] [-H HWTYPE] [-i IF] -a [HOSTNAME]" \
90 "\n[-v] [-i IF] -d HOSTNAME [pub]" \
91 "\n[-v] [-H HWTYPE] [-i IF] -s HOSTNAME HWADDR [temp]" \
92 "\n[-v] [-H HWTYPE] [-i IF] -s HOSTNAME HWADDR [netmask MASK] pub" \
93 "\n[-v] [-H HWTYPE] [-i IF] -Ds HOSTNAME IFACE [netmask MASK] pub"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000094#define arp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000095 "Manipulate ARP cache\n" \
96 "\nOptions:" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000097 "\n -a Display (all) hosts" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000098 "\n -s Set new ARP entry" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000099 "\n -d Delete a specified entry" \
100 "\n -v Verbose" \
101 "\n -n Don't resolve names" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000102 "\n -i IF Network interface" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +0000103 "\n -D Read <hwaddr> from given device" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000104 "\n -A, -p AF Protocol family" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000105 "\n -H HWTYPE Hardware address type" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +0000106
Glenn L McGrath9e598412003-01-09 10:06:01 +0000107#define arping_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100108 "[-fqbDUA] [-c CNT] [-w TIMEOUT] [-I IFACE] [-s SRC_IP] DST_IP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000109#define arping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000110 "Send ARP requests/replies\n" \
111 "\nOptions:" \
112 "\n -f Quit on first ARP reply" \
113 "\n -q Quiet" \
114 "\n -b Keep broadcasting, don't go unicast" \
115 "\n -D Duplicated address detection mode" \
116 "\n -U Unsolicited ARP mode, update your neighbors" \
117 "\n -A ARP answer mode, update your neighbors" \
118 "\n -c N Stop after sending N ARP requests" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100119 "\n -w TIMEOUT Time to wait for ARP reply, seconds" \
120 "\n -I IFACE Interface to use (default eth0)" \
121 "\n -s SRC_IP Sender IP address" \
122 "\n DST_IP Target IP address" \
Glenn L McGrath9e598412003-01-09 10:06:01 +0000123
Eric Andersen08f59e32004-03-12 22:07:10 +0000124#define awk_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200125 "[OPTIONS] [AWK_PROGRAM] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000126#define awk_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000127 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200128 "\n -v VAR=VAL Set variable" \
129 "\n -F SEP Use SEP as field separator" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +0100130 "\n -f FILE Read program from FILE" \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +0000131
Eric Andersen7e9276b2001-02-22 01:15:47 +0000132#define basename_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000133 "FILE [SUFFIX]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000134#define basename_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200135 "Strip directory path and .SUFFIX from FILE\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000136#define basename_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000137 "$ basename /usr/local/bin/foo\n" \
138 "foo\n" \
139 "$ basename /usr/local/bin/\n" \
140 "bin\n" \
141 "$ basename /foo/bar.txt .txt\n" \
142 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000143
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200144#define beep_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100145 "-f FREQ -l LEN -d DELAY -r COUNT -n"
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200146#define beep_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +0200147 "Options:" \
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200148 "\n -f Frequency in Hz" \
149 "\n -l Length in ms" \
150 "\n -d Delay in ms" \
151 "\n -r Repetitions" \
152 "\n -n Start new tone" \
153
Grigory Batalovad7a5d42010-05-23 23:22:10 +0200154#define blkid_trivial_usage \
155 ""
156#define blkid_full_usage "\n\n" \
157 "Print UUIDs of all filesystems"
158
Bernhard Reutner-Fischerd27d9252008-01-13 15:23:27 +0000159#define brctl_trivial_usage \
160 "COMMAND [BRIDGE [INTERFACE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000161#define brctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200162 "Manage ethernet bridges\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000163 "\nCommands:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000164 IF_FEATURE_BRCTL_SHOW( \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000165 "\n show Show a list of bridges" \
166 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000167 "\n addbr BRIDGE Create BRIDGE" \
168 "\n delbr BRIDGE Delete BRIDGE" \
169 "\n addif BRIDGE IFACE Add IFACE to BRIDGE" \
170 "\n delif BRIDGE IFACE Delete IFACE from BRIDGE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000171 IF_FEATURE_BRCTL_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000172 "\n setageing BRIDGE TIME Set ageing time" \
173 "\n setfd BRIDGE TIME Set bridge forward delay" \
174 "\n sethello BRIDGE TIME Set hello time" \
175 "\n setmaxage BRIDGE TIME Set max message age" \
176 "\n setpathcost BRIDGE COST Set path cost" \
177 "\n setportprio BRIDGE PRIO Set port priority" \
178 "\n setbridgeprio BRIDGE PRIO Set bridge priority" \
Maciek Borzecki30ebd7b2010-03-23 05:18:38 +0100179 "\n stp BRIDGE [1/yes/on|0/no/off] STP on/off" \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000180 ) \
181
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000182#define bzip2_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200183 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000184#define bzip2_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100185 "Compress FILEs (or stdin) with bzip2 algorithm\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000186 "\nOptions:" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200187 "\n -1..9 Compression level" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000188 "\n -d Decompress" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200189 "\n -c Write to stdout" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000190 "\n -f Force" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000191
Rob Landley6130b9b2006-01-23 21:10:38 +0000192#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000193 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000194
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000195#define lzop_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200196 "[-cfvd123456789CF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000197#define lzop_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200198 "Options:" \
199 "\n -1..9 Compression level" \
200 "\n -d Decompress" \
201 "\n -c Write to stdout" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000202 "\n -f Force" \
203 "\n -v Verbose" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000204 "\n -F Don't store or verify checksum" \
205 "\n -C Also write checksum of compressed block" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000206
207#define lzopcat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200208 "[-vCF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000209#define lzopcat_full_usage "\n\n" \
210 " -v Verbose" \
211 "\n -F Don't store or verify checksum" \
212
213#define unlzop_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200214 "[-cfvCF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000215#define unlzop_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200216 "Options:" \
217 "\n -c Write to stdout" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000218 "\n -f Force" \
219 "\n -v Verbose" \
220 "\n -F Don't store or verify checksum" \
221
Rob Landleyc1d69902006-01-20 18:28:50 +0000222#define unlzma_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100223 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000224#define unlzma_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200225 "Decompress FILE (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000226 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100227 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000228 "\n -f Force" \
Rob Landleyc1d69902006-01-20 18:28:50 +0000229
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200230#define lzma_trivial_usage \
231 "-d [OPTIONS] [FILE]..."
232#define lzma_full_usage "\n\n" \
233 "Decompress FILE (or stdin)\n" \
234 "\nOptions:" \
235 "\n -d Decompress" \
236 "\n -c Write to stdout" \
237 "\n -f Force" \
238
239#define lzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000240 "FILE"
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200241#define lzcat_full_usage "\n\n" \
242 "Decompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000243
Denys Vlasenko602ce692010-05-30 03:35:18 +0200244#define unxz_trivial_usage \
245 "[OPTIONS] [FILE]..."
246#define unxz_full_usage "\n\n" \
247 "Decompress FILE (or stdin)\n" \
248 "\nOptions:" \
249 "\n -c Write to stdout" \
250 "\n -f Force" \
251
252#define xz_trivial_usage \
253 "-d [OPTIONS] [FILE]..."
254#define xz_full_usage "\n\n" \
255 "Decompress FILE (or stdin)\n" \
256 "\nOptions:" \
257 "\n -d Decompress" \
258 "\n -c Write to stdout" \
259 "\n -f Force" \
260
261#define xzcat_trivial_usage \
262 "FILE"
263#define xzcat_full_usage "\n\n" \
264 "Decompress to stdout"
265
Eric Andersenc98c0622001-12-06 15:16:43 +0000266#define cal_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100267 "[-jy] [[MONTH] YEAR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000268#define cal_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000269 "Display a calendar\n" \
270 "\nOptions:" \
271 "\n -j Use julian dates" \
272 "\n -y Display the entire year" \
Eric Andersenc98c0622001-12-06 15:16:43 +0000273
Eric Andersen7e9276b2001-02-22 01:15:47 +0000274#define cat_trivial_usage \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200275 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000276#define cat_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200277 "Concatenate FILEs and print them to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000278
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000279#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000280 "$ cat /proc/uptime\n" \
281 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000282
Rob Landley8abbee42006-05-31 19:36:04 +0000283#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000284 "[-etv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000285#define catv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000286 "Display nonprinting characters as ^x or M-x\n" \
287 "\nOptions:" \
288 "\n -e End each line with $" \
289 "\n -t Show tabs as ^I" \
290 "\n -v Don't use ^x or M-x escapes" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000291
292#define chat_trivial_usage \
293 "EXPECT [SEND [EXPECT [SEND...]]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000294#define chat_full_usage "\n\n" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000295 "Useful for interacting with a modem connected to stdin/stdout.\n" \
296 "A script consists of one or more \"expect-send\" pairs of strings,\n" \
297 "each pair is a pair of arguments. Example:\n" \
298 "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \
299
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000300#define chattr_trivial_usage \
Denys Vlasenko79ae5342010-01-06 12:27:18 +0100301 "[-R] [-+=AacDdijsStTu] [-v VERSION] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000302#define chattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000303 "Change file attributes on an ext2 fs\n" \
304 "\nModifiers:" \
305 "\n - Remove attributes" \
306 "\n + Add attributes" \
307 "\n = Set attributes" \
308 "\nAttributes:" \
309 "\n A Don't track atime" \
310 "\n a Append mode only" \
311 "\n c Enable compress" \
312 "\n D Write dir contents synchronously" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200313 "\n d Don't backup with dump" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000314 "\n i Cannot be modified (immutable)" \
315 "\n j Write all data to journal first" \
316 "\n s Zero disk storage when deleted" \
317 "\n S Write file contents synchronously" \
318 "\n t Disable tail-merging of partial blocks with other files" \
319 "\n u Allow file to be undeleted" \
320 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100321 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000322 "\n -v Set the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000323
Denis Vlasenko49622d72007-03-10 16:58:49 +0000324#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000325 "[OPTIONS] CONTEXT FILE..." \
326 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000327 IF_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000328 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
329 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000330#define chcon_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000331 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000332 IF_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000333 "\n -v,--verbose Verbose" \
334 "\n -c,--changes Report changes made" \
335 "\n -h,--no-dereference Affect symlinks instead of their targets" \
336 "\n -f,--silent,--quiet Suppress most error messages" \
337 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
338 "\n -u,--user=USER Set user/role/type/range in the target" \
339 "\n -r,--role=ROLE security context" \
340 "\n -t,--type=TYPE" \
341 "\n -l,--range=RANGE" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200342 "\n -R,--recursive Recurse" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000343 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000344 IF_NOT_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000345 "\n -v Verbose" \
346 "\n -c Report changes made" \
347 "\n -h Affect symlinks instead of their targets" \
348 "\n -f Suppress most error messages" \
349 "\n -u USER Set user/role/type/range in the target security context" \
350 "\n -r ROLE" \
351 "\n -t TYPE" \
352 "\n -l RNG" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200353 "\n -R Recurse" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000354 )
355
Eric Andersen7e9276b2001-02-22 01:15:47 +0000356#define chmod_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000357 "[-R"IF_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000358#define chmod_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000359 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000360 "symbols +-= and one or more of the letters rwxst\n" \
361 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200362 "\n -R Recurse" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000363 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000364 "\n -c List changed files" \
365 "\n -v List all files" \
366 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000367 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000368#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000369 "$ ls -l /tmp/foo\n" \
370 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
371 "$ chmod u+x /tmp/foo\n" \
372 "$ ls -l /tmp/foo\n" \
373 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
374 "$ chmod 444 /tmp/foo\n" \
375 "$ ls -l /tmp/foo\n" \
376 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000377
Denis Vlasenko081ef792007-03-17 16:38:21 +0000378#define chgrp_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000379 "[-RhLHP"IF_DESKTOP("cvf")"]... GROUP FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000380#define chgrp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000381 "Change the group membership of each FILE to GROUP\n" \
382 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200383 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000384 "\n -h Affect symlinks instead of symlink targets" \
385 "\n -L Traverse all symlinks to directories" \
386 "\n -H Traverse symlinks on command line only" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200387 "\n -P Don't traverse symlinks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000388 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000389 "\n -c List changed files" \
390 "\n -v Verbose" \
391 "\n -f Hide errors" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000392 )
393#define chgrp_example_usage \
394 "$ ls -l /tmp/foo\n" \
395 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
396 "$ chgrp root /tmp/foo\n" \
397 "$ ls -l /tmp/foo\n" \
398 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
399
Eric Andersen7e9276b2001-02-22 01:15:47 +0000400#define chown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000401 "[-RhLHP"IF_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000402#define chown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000403 "Change the owner and/or group of each FILE to OWNER and/or GROUP\n" \
404 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200405 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000406 "\n -h Affect symlinks instead of symlink targets" \
407 "\n -L Traverse all symlinks to directories" \
408 "\n -H Traverse symlinks on command line only" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200409 "\n -P Don't traverse symlinks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000410 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000411 "\n -c List changed files" \
412 "\n -v List all files" \
413 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000414 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000415#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000416 "$ ls -l /tmp/foo\n" \
417 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
418 "$ chown root /tmp/foo\n" \
419 "$ ls -l /tmp/foo\n" \
420 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
421 "$ chown root.root /tmp/foo\n" \
422 "ls -l /tmp/foo\n" \
423 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000424
Denis Vlasenkofe544582006-10-03 15:57:40 +0000425#define chpst_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000426 "[-vP012] [-u USER[:GRP]] [-U USER[:GRP]] [-e DIR]\n" \
427 " [-/ DIR] [-n NICE] [-m BYTES] [-d BYTES] [-o N]\n" \
428 " [-p N] [-f BYTES] [-c BYTES] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000429#define chpst_full_usage "\n\n" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +0200430 "Change the process state, run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000431 "\nOptions:" \
432 "\n -u USER[:GRP] Set uid and gid" \
433 "\n -U USER[:GRP] Set $UID and $GID in environment" \
434 "\n -e DIR Set environment variables as specified by files" \
435 "\n in DIR: file=1st_line_of_file" \
436 "\n -/ DIR Chroot to DIR" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000437 "\n -n NICE Add NICE to nice value" \
438 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000439 "\n -d BYTES Limit data segment" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000440 "\n -o N Limit number of open files per process" \
441 "\n -p N Limit number of processes per uid" \
442 "\n -f BYTES Limit output file sizes" \
443 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000444 "\n -v Verbose" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000445 "\n -P Create new process group" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100446 "\n -0 Close stdin" \
447 "\n -1 Close stdout" \
448 "\n -2 Close stderr" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000449
Denis Vlasenkofe544582006-10-03 15:57:40 +0000450#define setuidgid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100451 "USER PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000452#define setuidgid_full_usage "\n\n" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +0200453 "Set uid and gid to USER's uid and gid, drop supplementary group ids,\n" \
454 "run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000455#define envuidgid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100456 "USER PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000457#define envuidgid_full_usage "\n\n" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +0200458 "Set $UID to USER's uid and $GID to USER's gid, run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000459#define envdir_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100460 "DIR PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000461#define envdir_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000462 "Set various environment variables as specified by files\n" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +0200463 "in the directory DIR, run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000464#define softlimit_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000465 "[-a BYTES] [-m BYTES] [-d BYTES] [-s BYTES] [-l BYTES]\n" \
466 " [-f BYTES] [-c BYTES] [-r BYTES] [-o N] [-p N] [-t N]\n" \
467 " PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000468#define softlimit_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000469 "Set soft resource limits, then run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000470 "\nOptions:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000471 "\n -a BYTES Limit total size of all segments" \
472 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES -a BYTES" \
473 "\n -d BYTES Limit data segment" \
474 "\n -s BYTES Limit stack segment" \
475 "\n -l BYTES Limit locked memory size" \
476 "\n -o N Limit number of open files per process" \
477 "\n -p N Limit number of processes per uid" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000478 "\nOptions controlling file sizes:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000479 "\n -f BYTES Limit output file sizes" \
480 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000481 "\nEfficiency opts:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000482 "\n -r BYTES Limit resident set size" \
483 "\n -t N Limit CPU time, process receives" \
484 "\n a SIGXCPU after N seconds" \
Denis Vlasenkofe544582006-10-03 15:57:40 +0000485
Eric Andersen7e9276b2001-02-22 01:15:47 +0000486#define chroot_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100487 "NEWROOT [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000488#define chroot_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200489 "Run PROG with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000490#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000491 "$ ls -l /bin/ls\n" \
492 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
493 "# mount /dev/hdc1 /mnt -t minix\n" \
494 "# chroot /mnt\n" \
495 "# ls -l /bin/ls\n" \
496 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000497
Eric Andersen7e9276b2001-02-22 01:15:47 +0000498#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000499 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000500#define chvt_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000501 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000502
Rob Landley856489b2006-04-18 20:57:28 +0000503#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000504 "FILES..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000505#define cksum_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000506 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000507
Eric Andersen7e9276b2001-02-22 01:15:47 +0000508#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000509 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000510#define clear_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000511 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000512
Eric Andersen7e9276b2001-02-22 01:15:47 +0000513#define cmp_trivial_usage \
Denys Vlasenko65ebbc52010-05-09 04:38:22 +0200514 "[-l] [-s] FILE1 [FILE2" IF_DESKTOP(" [SKIP1 [SKIP2]]") "]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000515#define cmp_full_usage "\n\n" \
Denys Vlasenko65ebbc52010-05-09 04:38:22 +0200516 "Compare FILE1 with FILE2 (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000517 "\nOptions:" \
518 "\n -l Write the byte numbers (decimal) and values (octal)" \
519 "\n for all differing bytes" \
520 "\n -s Quiet" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000521
Rob Landley2acfd7b2005-05-11 23:12:49 +0000522#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000523 "[-123] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000524#define comm_full_usage "\n\n" \
Denys Vlasenko65ebbc52010-05-09 04:38:22 +0200525 "Compare FILE1 with FILE2\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000526 "\nOptions:" \
527 "\n -1 Suppress lines unique to FILE1" \
528 "\n -2 Suppress lines unique to FILE2" \
529 "\n -3 Suppress lines common to both files" \
Rob Landley2acfd7b2005-05-11 23:12:49 +0000530
Paul Fox79c142d2005-08-01 16:04:40 +0000531#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000532 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000533#define bbconfig_full_usage "\n\n" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +0200534 "Print the config file used by busybox build"
Mike Frysinger036f2992005-09-24 23:50:14 +0000535
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000536#define chrt_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100537 "[OPTIONS] [PRIO] [PID | PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000538#define chrt_full_usage "\n\n" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +0200539 "Change scheduling priority and class for a process\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000540 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100541 "\n -p Operate on PID" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +0200542 "\n -r Set SCHED_RR class" \
543 "\n -f Set SCHED_FIFO class" \
544 "\n -o Set SCHED_OTHER class" \
545 "\n -m Show min/max priorities" \
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000546
547#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000548 "$ chrt -r 4 sleep 900; x=$!\n" \
549 "$ chrt -f -p 3 $x\n" \
550 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000551
Denys Vlasenko922f6f52010-07-01 16:42:27 +0200552#define nice_trivial_usage \
553 "[-n ADJUST] [PROG ARGS]"
554#define nice_full_usage "\n\n" \
555 "Change scheduling priority, run PROG\n" \
556 "\nOptions:" \
557 "\n -n ADJUST Adjust priority by ADJUST" \
558
559#define renice_trivial_usage \
560 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
561#define renice_full_usage "\n\n" \
562 "Change scheduling priority for a running process\n" \
563 "\nOptions:" \
564 "\n -n Adjust current nice value (smaller is faster)" \
565 "\n -p Process id(s) (default)" \
566 "\n -g Process group id(s)" \
567 "\n -u Process user name(s) and/or id(s)" \
568
569#define ionice_trivial_usage \
570 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
571#define ionice_full_usage "\n\n" \
572 "Change I/O priority and class\n" \
573 "\nOptions:" \
574 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
575 "\n -n Priority" \
576
Eric Andersen7e9276b2001-02-22 01:15:47 +0000577#define cp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200578 "[OPTIONS] SOURCE DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000579#define cp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000580 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY\n" \
581 "\nOptions:" \
582 "\n -a Same as -dpR" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000583 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000584 "\n -c Preserve security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000585 ) \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100586 "\n -R,-r Recurse" \
587 "\n -d,-P Preserve symlinks (default if -R)" \
588 "\n -L Follow all symlinks" \
589 "\n -H Follow symlinks on command line" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000590 "\n -p Preserve file attributes if possible" \
Denys Vlasenkoa3581402010-05-27 02:30:04 +0200591 "\n -f Overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000592 "\n -i Prompt before overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000593 "\n -l,-s Create (sym)links" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000594
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000595#define cpio_trivial_usage \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100596 "[-dmvu] [-F FILE]" IF_FEATURE_CPIO_O(" [-H newc]") \
597 " [-ti"IF_FEATURE_CPIO_O("o")"]" IF_FEATURE_CPIO_P(" [-p DIR]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000598#define cpio_full_usage "\n\n" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000599 "Extract or list files from a cpio archive" \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100600 IF_FEATURE_CPIO_O(", or" \
601 "\ncreate an archive" IF_FEATURE_CPIO_P(" (-o) or copy files (-p)") \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100602 " using file list on stdin" \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100603 ) \
604 "\n" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000605 "\nMain operation mode:" \
606 "\n -t List" \
607 "\n -i Extract" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000608 IF_FEATURE_CPIO_O( \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100609 "\n -o Create (requires -H newc)" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000610 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000611 IF_FEATURE_CPIO_P( \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100612 "\n -p DIR Copy files to DIR" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000613 ) \
614 "\nOptions:" \
615 "\n -d Make leading directories" \
616 "\n -m Preserve mtime" \
617 "\n -v Verbose" \
618 "\n -u Overwrite" \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100619 "\n -F FILE Input (-t,-i,-p) or output (-o) file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000620 IF_FEATURE_CPIO_O( \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100621 "\n -H newc Archive format" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000622 ) \
Tim Riker7b253f82003-12-28 05:02:40 +0000623
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000624#define crond_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000625 "-fbS -l N " IF_FEATURE_CROND_D("-d N ") "-L LOGFILE -c DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000626#define crond_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000627 " -f Foreground" \
628 "\n -b Background (default)" \
629 "\n -S Log to syslog (default)" \
630 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000631 IF_FEATURE_CROND_D( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000632 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000633 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000634 "\n -L Log to file" \
635 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000636
637#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000638 "[-c DIR] [-u USER] [-ler]|[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000639#define crontab_full_usage "\n\n" \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000640 " -c Crontab directory" \
641 "\n -u User" \
642 "\n -l List crontab" \
643 "\n -e Edit crontab" \
644 "\n -r Delete crontab" \
645 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000646
Denis Vlasenko2211d522008-11-10 18:52:35 +0000647#define cryptpw_trivial_usage \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000648 "[OPTIONS] [PASSWORD] [SALT]"
649/* We do support -s, we just don't mention it */
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000650#define cryptpw_full_usage "\n\n" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000651 "Crypt the PASSWORD using crypt(3)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000652 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200653 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100654 "\n -P,--password-fd=N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000655/* "\n -s,--stdin Use stdin; like -P0" */ \
656 "\n -m,--method=TYPE Encryption method TYPE" \
657 "\n -S,--salt=SALT" \
658 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200659 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100660 "\n -P N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000661/* "\n -s Use stdin; like -P0" */ \
662 "\n -m TYPE Encryption method TYPE" \
663 "\n -S SALT" \
664 ) \
665
666/* mkpasswd is an alias to cryptpw */
667
668#define mkpasswd_trivial_usage \
669 "[OPTIONS] [PASSWORD] [SALT]"
670/* We do support -s, we just don't mention it */
671#define mkpasswd_full_usage "\n\n" \
672 "Crypt the PASSWORD using crypt(3)\n" \
673 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200674 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100675 "\n -P,--password-fd=N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000676/* "\n -s,--stdin Use stdin; like -P0" */ \
677 "\n -m,--method=TYPE Encryption method TYPE" \
678 "\n -S,--salt=SALT" \
679 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200680 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100681 "\n -P N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000682/* "\n -s Use stdin; like -P0" */ \
683 "\n -m TYPE Encryption method TYPE" \
684 "\n -S SALT" \
685 ) \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000686
Eric Andersen7e9276b2001-02-22 01:15:47 +0000687#define cut_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200688 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000689#define cut_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100690 "Print selected fields from each input FILE to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000691 "\nOptions:" \
692 "\n -b LIST Output only bytes from LIST" \
693 "\n -c LIST Output only characters from LIST" \
694 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
695 "\n -s Output only the lines containing delimiter" \
696 "\n -f N Print only these fields" \
697 "\n -n Ignored" \
698
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000699#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000700 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
701 "Hello\n" \
702 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
703 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000704
Eric Andersen7e9276b2001-02-22 01:15:47 +0000705#define date_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200706 "[OPTIONS] [+FMT] [TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000707#define date_full_usage "\n\n" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000708 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000709 "\nOptions:" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200710 IF_NOT_LONG_OPTS( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200711 "\n [-s] TIME Set time to TIME" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000712 "\n -u Work in UTC (don't convert to local time)" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200713 "\n -R Output RFC-2822 compliant date string" \
714 ) IF_LONG_OPTS( \
715 "\n [-s,--set] TIME Set time to TIME" \
Denys Vlasenko50be9632009-10-23 16:25:20 +0200716 "\n -u,--utc Work in UTC (don't convert to local time)" \
717 "\n -R,--rfc-2822 Output RFC-2822 compliant date string" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200718 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000719 IF_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000720 "\n -I[SPEC] Output ISO-8601 compliant date string" \
721 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000722 "\n 'hours', 'minutes', or 'seconds' for date and" \
723 "\n time to the indicated precision" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200724 ) IF_NOT_LONG_OPTS( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000725 "\n -r FILE Display last modification time of FILE" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200726 "\n -d TIME Display TIME, not 'now'" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200727 ) IF_LONG_OPTS( \
Denys Vlasenko50be9632009-10-23 16:25:20 +0200728 "\n -r,--reference FILE Display last modification time of FILE" \
729 "\n -d,--date TIME Display TIME, not 'now'" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200730 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000731 IF_FEATURE_DATE_ISOFMT( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200732 "\n -D FMT Use FMT for -d TIME conversion" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000733 ) \
734 "\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +0200735 "\nRecognized TIME formats:" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000736 "\n hh:mm[:ss]" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000737 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000738 "\n YYYY-MM-DD hh:mm[:ss]" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200739 "\n [[[[[YY]YY]MM]DD]hh]mm[.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000740
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000741#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000742 "$ date\n" \
743 "Wed Apr 12 18:52:41 MDT 2000\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
Grigory Batalovad7a5d42010-05-23 23:22:10 +02001246#define fgconsole_trivial_usage \
1247 ""
1248#define fgconsole_full_usage "\n\n" \
1249 "Get active console"
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
Denys Vlasenkobf2af9a2009-05-25 04:15:37 +02001258#define flash_lock_trivial_usage \
1259 "MTD_DEVICE OFFSET SECTORS"
1260#define flash_lock_full_usage "\n\n" \
1261 "Lock part or all of an MTD device. If SECTORS is -1, then all sectors\n" \
1262 "will be locked, regardless of the value of OFFSET"
1263
1264#define flash_unlock_trivial_usage \
1265 "MTD_DEVICE"
1266#define flash_unlock_full_usage "\n\n" \
1267 "Unlock an MTD device"
1268
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001269#define flash_eraseall_trivial_usage \
1270 "[-jq] MTD_DEVICE"
1271#define flash_eraseall_full_usage "\n\n" \
1272 "Erase an MTD device\n" \
1273 "\nOptions:" \
Stefan Seyfriedd095fd42009-11-21 18:32:19 +01001274 "\n -j Format the device for jffs2" \
1275 "\n -q Don't display progress messages" \
1276
1277#define flashcp_trivial_usage \
1278 "-v FILE MTD_DEVICE"
1279#define flashcp_full_usage "\n\n" \
1280 "Copy an image to MTD device\n" \
1281 "\nOptions:" \
1282 "\n -v Verbose" \
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001283
Timo Teras892d4b62010-03-18 22:45:35 +01001284#define flock_trivial_usage \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001285 "[-sxun] FD|{FILE [-c] PROG ARGS}"
Timo Teras892d4b62010-03-18 22:45:35 +01001286#define flock_full_usage "\n\n" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +02001287 "[Un]lock file descriptor, or lock FILE, run PROG\n" \
Timo Teras892d4b62010-03-18 22:45:35 +01001288 "\nOptions:" \
1289 "\n -s Shared lock" \
1290 "\n -x Exclusive lock (default)" \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001291 "\n -u Unlock FD" \
Timo Teras892d4b62010-03-18 22:45:35 +01001292 "\n -n Fail rather than wait" \
1293
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001294#define fold_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001295 "[-bs] [-w WIDTH] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001296#define fold_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001297 "Wrap input lines in each FILE (or stdin), writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001298 "\nOptions:" \
1299 "\n -b Count bytes rather than columns" \
1300 "\n -s Break at spaces" \
1301 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001302
Eric Andersen7e9276b2001-02-22 01:15:47 +00001303#define free_trivial_usage \
Denys Vlasenko5657d372010-10-01 22:42:44 +02001304 "" IF_DESKTOP("[-b/k/m/g]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001305#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001306 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001307#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001308 "$ free\n" \
1309 " total used free shared buffers\n" \
1310 " Mem: 257628 248724 8904 59644 93124\n" \
1311 " Swap: 128516 8404 120112\n" \
1312 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001313
Eric Andersen7e9276b2001-02-22 01:15:47 +00001314#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001315 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001316#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001317 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001318#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001319 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001320
Mike Frysinger51a43b42005-09-24 07:11:16 +00001321#define fsck_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001322 "[-ANPRTV] [-C FD] [-t FSTYPE] [FS_OPTS] [BLOCKDEV]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001323#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001324 "Check and repair filesystems\n" \
1325 "\nOptions:" \
1326 "\n -A Walk /etc/fstab and check all filesystems" \
1327 "\n -N Don't execute, just show what would be done" \
1328 "\n -P With -A, check filesystems in parallel" \
1329 "\n -R With -A, skip the root filesystem" \
1330 "\n -T Don't show title on startup" \
1331 "\n -V Verbose" \
1332 "\n -C n Write status information to specified filedescriptor" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001333 "\n -t TYPE List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001334
Eric Andersen7e9276b2001-02-22 01:15:47 +00001335#define fsck_minix_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001336 "[-larvsmf] BLOCKDEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001337#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001338 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001339 "\nOptions:" \
1340 "\n -l List all filenames" \
1341 "\n -r Perform interactive repairs" \
1342 "\n -a Perform automatic repairs" \
1343 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001344 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001345 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001346 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001347
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001348#define ftpd_trivial_usage \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001349 "[-wvS] [-t N] [-T N] [DIR]"
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001350#define ftpd_full_usage "\n\n" \
Denys Vlasenkoae357bd2009-09-11 23:29:45 +02001351 "Anonymous FTP server\n" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001352 "\n" \
1353 "ftpd should be used as an inetd service.\n" \
1354 "ftpd's line for inetd.conf:\n" \
1355 " 21 stream tcp nowait root ftpd ftpd /files/to/serve\n" \
1356 "It also can be ran from tcpsvd:\n" \
1357 " tcpsvd -vE 0.0.0.0 21 ftpd /files/to/serve\n" \
1358 "\nOptions:" \
1359 "\n -w Allow upload" \
Denis Vlasenko4221e902009-03-11 15:07:44 +00001360 "\n -v Log to stderr" \
1361 "\n -S Log to syslog" \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001362 "\n -t,-T Idle and absolute timeouts" \
Denis Vlasenko92576712009-03-09 16:25:33 +00001363 "\n DIR Change root to this directory" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001364
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001365#define ftpget_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001366 "[OPTIONS] HOST [LOCAL_FILE] REMOTE_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001367#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001368 "Retrieve a remote file via FTP\n" \
1369 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001370 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001371 "\n -c,--continue Continue previous transfer" \
1372 "\n -v,--verbose Verbose" \
1373 "\n -u,--username Username" \
1374 "\n -p,--password Password" \
1375 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001376 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001377 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001378 "\n -c Continue previous transfer" \
1379 "\n -v Verbose" \
1380 "\n -u Username" \
1381 "\n -p Password" \
1382 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001383 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001384
1385#define ftpput_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001386 "[OPTIONS] HOST [REMOTE_FILE] LOCAL_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001387#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001388 "Store a local file on a remote machine via FTP\n" \
1389 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001390 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001391 "\n -v,--verbose Verbose" \
1392 "\n -u,--username Username" \
1393 "\n -p,--password Password" \
1394 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001395 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001396 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001397 "\n -v Verbose" \
1398 "\n -u Username" \
1399 "\n -p Password" \
1400 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001401 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001402
Rob Landleyaa872762005-10-28 13:05:12 +00001403#define fuser_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001404 "[OPTIONS] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001405#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001406 "Find processes which use FILEs or PORTs\n" \
1407 "\nOptions:" \
1408 "\n -m Find processes which use same fs as FILEs" \
1409 "\n -4 Search only IPv4 space" \
1410 "\n -6 Search only IPv6 space" \
Maksym Kryzhanovskyyfef9ee72010-05-22 20:41:08 +02001411 "\n -s Don't display PIDs" \
1412 "\n -k Kill found processes" \
1413 "\n -SIGNAL Signal to send (default: KILL)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001414
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001415#define getenforce_trivial_usage NOUSAGE_STR
1416#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001417
Eric Andersen7e9276b2001-02-22 01:15:47 +00001418#define getopt_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001419 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001420#define getopt_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001421 "Options:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001422 IF_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001423 "\n -a,--alternative Allow long options starting with single -" \
1424 "\n -l,--longoptions=longopts Long options to be recognized" \
1425 "\n -n,--name=progname The name under which errors are reported" \
1426 "\n -o,--options=optstring Short options to be recognized" \
1427 "\n -q,--quiet Disable error reporting by getopt(3)" \
1428 "\n -Q,--quiet-output No normal output" \
1429 "\n -s,--shell=shell Set shell quoting conventions" \
1430 "\n -T,--test Test for getopt(1) version" \
1431 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001432 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001433 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001434 "\n -a Allow long options starting with single -" \
1435 "\n -l longopts Long options to be recognized" \
1436 "\n -n progname The name under which errors are reported" \
1437 "\n -o optstring Short options to be recognized" \
1438 "\n -q Disable error reporting by getopt(3)" \
1439 "\n -Q No normal output" \
1440 "\n -s shell Set shell quoting conventions" \
1441 "\n -T Test for getopt(1) version" \
1442 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001443 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001444#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001445 "$ cat getopt.test\n" \
1446 "#!/bin/sh\n" \
1447 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1448 " -n 'example.busybox' -- \"$@\"`\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001449 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001450 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001451 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001452 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001453 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1454 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001455 " -c|--c-long)\n" \
1456 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001457 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1458 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1459 " esac;;\n" \
1460 " --) shift; break;;\n" \
1461 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001462 " esac\n" \
1463 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001464
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001465#define getsebool_trivial_usage \
1466 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001467#define getsebool_full_usage "\n\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01001468 " -a Show all selinux booleans"
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001469
Eric Andersenf349e972001-08-21 16:18:59 +00001470#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001471 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001472#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001473 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1474 "\nOptions:" \
1475 "\n -h Enable hardware (RTS/CTS) flow control" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001476 "\n -i Don't display /etc/issue before running login" \
1477 "\n -L Local line, don't do carrier detect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001478 "\n -m Get baud rate from modem's CONNECT status message" \
1479 "\n -w Wait for a CR or LF before sending /etc/issue" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001480 "\n -n Don't prompt the user for a login name" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02001481 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
1482 "\n -l LOGIN Invoke LOGIN instead of /bin/login" \
1483 "\n -t SEC Terminate after SEC if no username is read" \
1484 "\n -I INITSTR Send INITSTR before anything else" \
1485 "\n -H HOST Log HOST into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001486
Eric Andersen7e9276b2001-02-22 01:15:47 +00001487#define gunzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001488 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001489#define gunzip_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02001490 "Decompress FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001491 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001492 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001493 "\n -f Force" \
1494 "\n -t Test file integrity" \
1495
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001496#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001497 "$ ls -la /tmp/BusyBox*\n" \
1498 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1499 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1500 "$ ls -la /tmp/BusyBox*\n" \
1501 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001502
1503#define gzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001504 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001505#define gzip_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001506 "Compress FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001507 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001508 "\n -d Decompress" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02001509 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001510 "\n -f Force" \
1511
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001512#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001513 "$ ls -la /tmp/busybox*\n" \
1514 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1515 "$ gzip /tmp/busybox.tar\n" \
1516 "$ ls -la /tmp/busybox*\n" \
1517 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001518
1519#define halt_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001520 "[-d DELAY] [-n] [-f]" IF_FEATURE_WTMP(" [-w]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001521#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001522 "Halt the system\n" \
1523 "\nOptions:" \
Denys Vlasenkoee5ab8f2010-09-30 23:44:08 +02001524 "\n -d SEC Delay interval" \
1525 "\n -n Do not sync" \
1526 "\n -f Force (don't go through init)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001527 IF_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001528 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001529 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001530
Denys Vlasenkoee5ab8f2010-09-30 23:44:08 +02001531#define poweroff_trivial_usage \
1532 "[-d DELAY] [-n] [-f]"
1533#define poweroff_full_usage "\n\n" \
1534 "Halt and shut off power\n" \
1535 "\nOptions:" \
1536 "\n -d SEC Delay interval" \
1537 "\n -n Do not sync" \
1538 "\n -f Force (don't go through init)" \
1539
1540#define reboot_trivial_usage \
1541 "[-d DELAY] [-n] [-f]"
1542#define reboot_full_usage "\n\n" \
1543 "Reboot the system\n" \
1544 "\nOptions:" \
1545 "\n -d SEC Delay interval" \
1546 "\n -n Do not sync" \
1547 "\n -f Force (don't go through init)" \
1548
Eric Andersen3443bd72003-07-22 07:30:36 +00001549#define hdparm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001550 "[OPTIONS] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001551#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001552 "Options:" \
1553 "\n -a Get/set fs readahead" \
1554 "\n -A Set drive read-lookahead flag (0/1)" \
1555 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1556 "\n -B Set Advanced Power Management setting (1-255)" \
1557 "\n -c Get/set IDE 32-bit IO setting" \
1558 "\n -C Check IDE power mode status" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001559 IF_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001560 "\n -d Get/set using_dma flag") \
1561 "\n -D Enable/disable drive defect-mgmt" \
1562 "\n -f Flush buffer cache for device on exit" \
1563 "\n -g Display drive geometry" \
1564 "\n -h Display terse usage information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001565 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001566 "\n -i Display drive identification") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001567 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001568 "\n -I Detailed/current information directly from drive") \
1569 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1570 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1571 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1572 "\n -m Get/set multiple sector count" \
1573 "\n -n Get/set ignore-write-errors flag (0/1)" \
1574 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1575 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001576/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001577 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1578 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001579 IF_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001580 "\n -R Register an IDE interface (DANGEROUS)") \
1581 "\n -S Set standby (spindown) timeout" \
1582 "\n -t Perform device read timings" \
1583 "\n -T Perform cache read timings" \
1584 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001585 IF_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001586 "\n -U Unregister an IDE interface (DANGEROUS)") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001587 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1588 "\n -V Display program version and exit immediately" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001589 IF_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001590 "\n -w Perform device reset (DANGEROUS)") \
1591 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001592 IF_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001593 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1594 "\n -X Set IDE xfer mode (DANGEROUS)" \
1595 "\n -y Put IDE drive in standby mode" \
1596 "\n -Y Put IDE drive to sleep" \
1597 "\n -Z Disable Seagate auto-powersaving mode" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001598 "\n -z Reread partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001599
Eric Andersen7e9276b2001-02-22 01:15:47 +00001600#define head_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001601 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001602#define head_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001603 "Print first 10 lines of each FILE (or stdin) to stdout.\n" \
Denys Vlasenko57493282010-03-02 16:18:14 +01001604 "With more than one FILE, precede each with a filename header.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001605 "\nOptions:" \
Denys Vlasenko57493282010-03-02 16:18:14 +01001606 "\n -n N[kbm] Print first N lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001607 IF_FEATURE_FANCY_HEAD( \
Denys Vlasenko57493282010-03-02 16:18:14 +01001608 "\n -c N[kbm] Print first N bytes" \
1609 "\n -q Never print headers" \
1610 "\n -v Always print headers" \
1611 ) \
1612 "\n" \
1613 "\nN may be suffixed by k (x1024), b (x512), or m (x1024^2)." \
Denis Vlasenko397de612008-03-17 08:55:44 +00001614
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001615#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001616 "$ head -n 2 /etc/passwd\n" \
1617 "root:x:0:0:root:/root:/bin/bash\n" \
1618 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001619
Denys Vlasenko57493282010-03-02 16:18:14 +01001620#define tail_trivial_usage \
1621 "[OPTIONS] [FILE]..."
1622#define tail_full_usage "\n\n" \
1623 "Print last 10 lines of each FILE (or stdin) to stdout.\n" \
1624 "With more than one FILE, precede each with a filename header.\n" \
1625 "\nOptions:" \
1626 "\n -f Print data as file grows" \
1627 IF_FEATURE_FANCY_TAIL( \
1628 "\n -s SECONDS Wait SECONDS between reads with -f" \
1629 ) \
1630 "\n -n N[kbm] Print last N lines" \
1631 IF_FEATURE_FANCY_TAIL( \
1632 "\n -c N[kbm] Print last N bytes" \
1633 "\n -q Never print headers" \
1634 "\n -v Always print headers" \
1635 "\n" \
1636 "\nN may be suffixed by k (x1024), b (x512), or m (x1024^2)." \
1637 "\nIf N starts with a '+', output begins with the Nth item from the start" \
1638 "\nof each file, not from the end." \
1639 ) \
1640
1641#define tail_example_usage \
1642 "$ tail -n 1 /etc/resolv.conf\n" \
1643 "nameserver 10.0.0.1\n"
1644
Glenn L McGrath60281112001-11-02 11:39:46 +00001645#define hexdump_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001646 "[-bcCdefnosvx" IF_FEATURE_HEXDUMP_REVERSE("R") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001647#define hexdump_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001648 "Display FILEs (or stdin) in a user specified format\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001649 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001650 "\n -b One-byte octal display" \
1651 "\n -c One-byte character display" \
1652 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1653 "\n -d Two-byte decimal display" \
1654 "\n -e FORMAT STRING" \
1655 "\n -f FORMAT FILE" \
1656 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1657 "\n -o Two-byte octal display" \
1658 "\n -s OFFSET Skip OFFSET bytes" \
1659 "\n -v Display all input data" \
1660 "\n -x Two-byte hexadecimal display" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001661 IF_FEATURE_HEXDUMP_REVERSE( \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001662 "\n -R Reverse of 'hexdump -Cv'") \
1663
1664#define hd_trivial_usage \
1665 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001666#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001667 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001668
Eric Andersen7e9276b2001-02-22 01:15:47 +00001669#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001670 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001671#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001672 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001673
1674#define hostname_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001675 "[OPTIONS] [HOSTNAME | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001676#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001677 "Get or set hostname or DNS domain name\n" \
1678 "\nOptions:" \
1679 "\n -s Short" \
1680 "\n -i Addresses for the hostname" \
1681 "\n -d DNS domain name" \
1682 "\n -f Fully qualified domain name" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001683 "\n -F FILE Use FILE's content as hostname" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001684
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001685#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001686 "$ hostname\n" \
1687 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001688
Denys Vlasenkod30b89c2009-06-26 01:55:45 +02001689#define dnsdomainname_trivial_usage NOUSAGE_STR
1690#define dnsdomainname_full_usage ""
1691
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001692#define httpd_trivial_usage \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001693 "[-ifv[v]]" \
1694 " [-c CONFFILE]" \
1695 " [-p [IP:]PORT]" \
1696 IF_FEATURE_HTTPD_SETUID(" [-u USER[:GRP]]") \
1697 IF_FEATURE_HTTPD_BASIC_AUTH(" [-r REALM]") \
1698 " [-h HOME]\n" \
1699 "or httpd -d/-e" IF_FEATURE_HTTPD_AUTH_MD5("/-m") " STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001700#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001701 "Listen for incoming HTTP requests\n" \
1702 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001703 "\n -i Inetd mode" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001704 "\n -f Don't daemonize" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001705 "\n -v[v] Verbose" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001706 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001707 IF_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001708 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001709 IF_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001710 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001711 "\n -h HOME Home directory (default .)" \
Denys Vlasenko8fc9e6a2010-04-02 10:40:58 +02001712 "\n -c FILE Configuration file (default {/etc,HOME}/httpd.conf)" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001713 IF_FEATURE_HTTPD_AUTH_MD5( \
1714 "\n -m STRING MD5 crypt STRING") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001715 "\n -e STRING HTML encode STRING" \
1716 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001717
Robert Griebl1cd04452002-07-21 16:50:49 +00001718#define hwclock_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001719 IF_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001720 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1721 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001722 " [-f FILE]" \
1723 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001724 IF_NOT_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001725 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1726 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001727#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001728 "Query and set hardware clock (RTC)\n" \
1729 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001730 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001731 "\n -s Set system time from hardware clock" \
1732 "\n -w Set hardware clock to system time" \
1733 "\n -u Hardware clock is in UTC" \
1734 "\n -l Hardware clock is in local time" \
1735 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001736
Eric Andersen7e9276b2001-02-22 01:15:47 +00001737#define id_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001738 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001739#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001740 "Print information about USER or the current user\n" \
1741 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001742 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001743 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001744 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001745 "\n -u Print user ID" \
Denis Vlasenko4f3209b2008-09-13 12:51:10 +00001746 "\n -g Print group ID" \
1747 "\n -G Print supplementary group IDs" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001748 "\n -n Print name instead of a number" \
1749 "\n -r Print real user ID instead of effective ID" \
1750
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001751#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001752 "$ id\n" \
1753 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001754
Eric Andersen7e9276b2001-02-22 01:15:47 +00001755#define ifconfig_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001756 IF_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001757#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001758 "Configure a network interface\n" \
1759 "\nOptions:" \
1760 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001761 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001762 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001763 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001764 " [del ADDRESS[/PREFIXLEN]]\n") \
1765 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1766 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001767 IF_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001768 " [outfill NN] [keepalive NN]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001769 " " IF_FEATURE_IFCONFIG_HW("[hw ether" IF_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001770 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001771 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001772 IF_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001773 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001774 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001775
Denis Vlasenko06aed432008-02-26 18:25:24 +00001776#define ifenslave_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001777 "[-cdf] MASTER_IFACE SLAVE_IFACE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001778#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001779 "Configure network interfaces for parallel routing\n" \
1780 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001781 "\n -c, --change-active Change active slave" \
1782 "\n -d, --detach Remove slave interface from bonding device" \
1783 "\n -f, --force Force, even if interface is not Ethernet" \
1784/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001785
Denis Vlasenko06aed432008-02-26 18:25:24 +00001786#define ifenslave_example_usage \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001787 "To create a bond device, simply follow these three steps:\n" \
1788 "- ensure that the required drivers are properly loaded:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001789 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001790 "- assign an IP address to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001791 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001792 "- attach all the interfaces you need to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001793 " # ifenslave bond0 eth0 eth1 eth2\n" \
1794 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1795 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001796 " To detach a dead interface without setting the bond device down:\n" \
1797 " # ifenslave -d bond0 eth1\n\n" \
1798 " To set the bond device down and automatically release all the slaves:\n" \
1799 " # ifconfig bond0 down\n\n" \
1800 " To change active slave:\n" \
1801 " # ifenslave -c bond0 eth0\n" \
1802
1803#define ifplugd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001804 "[OPTIONS]"
Denis Vlasenko71c16572009-04-26 01:08:51 +00001805#define ifplugd_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +02001806 "Network interface plug detection daemon\n" \
1807 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001808 "\n -n Don't daemonize" \
1809 "\n -s Don't log to syslog" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001810 "\n -i IFACE Interface" \
1811 "\n -f/-F Treat link detection error as link down/link up" \
1812 "\n (otherwise exit on error)" \
Denys Vlasenko999e4422010-01-08 13:03:48 +01001813 "\n -a Don't up interface at each link probe" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001814 "\n -M Monitor creation/destruction of interface" \
1815 "\n (otherwise it must exist)" \
1816 "\n -r PROG Script to run" \
1817 "\n -x ARG Extra argument for script" \
1818 "\n -I Don't exit on nonzero exit code from script" \
1819 "\n -p Don't run script on daemon startup" \
1820 "\n -q Don't run script on daemon quit" \
1821 "\n -l Run script on startup even if no cable is detected" \
1822 "\n -t SECS Poll time in seconds" \
1823 "\n -u SECS Delay before running script after link up" \
1824 "\n -d SECS Delay after link down" \
Denys Vlasenkob8f0e802010-01-07 14:56:50 +01001825 "\n -m MODE API mode (mii, priv, ethtool, wlan, iff, auto)" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001826 "\n -k Kill running daemon" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001827
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001828#define ifup_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001829 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] IFACE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001830#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001831 "Options:" \
1832 "\n -a De/configure all interfaces automatically" \
1833 "\n -i FILE Use FILE for interface definitions" \
1834 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001835 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001836 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001837 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001838 ) \
1839 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001840 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001841
1842#define ifdown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001843 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001844#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001845 "Options:" \
1846 "\n -a De/configure all interfaces automatically" \
1847 "\n -i FILE Use FILE for interface definitions" \
1848 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001849 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001850 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001851 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001852 ) \
1853 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001854 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001855
Glenn L McGrath06e95652003-02-09 06:51:14 +00001856#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001857 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001858#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001859 "Listen for network connections and launch programs\n" \
1860 "\nOptions:" \
1861 "\n -f Run in foreground" \
1862 "\n -e Log to stderr" \
1863 "\n -q N Socket listen queue (default: 128)" \
1864 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001865 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001866
Eric Andersen7e9276b2001-02-22 01:15:47 +00001867#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001868 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001869#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001870 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001871
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001872#define init_notes_usage \
1873"This version of init is designed to be run only by the kernel.\n" \
1874"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001875"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001876"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001877"runlevels, use sysvinit.\n" \
1878"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001879"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001880"it has the following default behavior:\n" \
1881"\n" \
1882" ::sysinit:/etc/init.d/rcS\n" \
1883" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001884" ::ctrlaltdel:/sbin/reboot\n" \
1885" ::shutdown:/sbin/swapoff -a\n" \
1886" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001887" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001888"\n" \
1889"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1890"\n" \
1891" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001892" tty3::askfirst:/bin/sh\n" \
1893" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001894"\n" \
1895"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1896"\n" \
1897" <id>:<runlevels>:<action>:<process>\n" \
1898"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001899" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001900"\n" \
1901" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1902" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001903" the specified process to run on. The contents of this field are\n" \
1904" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1905" be unique, although if it isn't you may have strange results. If this\n" \
1906" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001907" note that if BusyBox detects that a serial console is in use, then only\n" \
1908" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001909" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001910" stinkin' utmp.\n" \
1911"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001912" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001913"\n" \
1914" The runlevels field is completely ignored.\n" \
1915"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001916" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001917"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001918" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001919" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001920"\n" \
1921" The available actions can be classified into two groups: actions\n" \
1922" that are run only once, and actions that are re-run when the specified\n" \
1923" process exits.\n" \
1924"\n" \
1925" Run only-once actions:\n" \
1926"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001927" 'sysinit' is the first item run on boot. init waits until all\n" \
1928" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001929" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001930" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001931" the specified task completes. 'once' actions are asynchronous,\n" \
1932" therefore, init does not wait for them to complete. 'restart' is\n" \
1933" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001934" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001935" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001936" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001937" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001938" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001939" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001940" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001941" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001942"\n" \
1943" Run repeatedly actions:\n" \
1944"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001945" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001946" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001947" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1948" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001949" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001950" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001951" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001952" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001953"\n" \
1954" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001955" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001956" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001957"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001958" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001959"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001960" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001961"\n" \
1962"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001963"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001964" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001965" #\n" \
1966" ::sysinit:/etc/init.d/rcS\n" \
1967" \n" \
1968" # /bin/sh invocations on selected ttys\n" \
1969" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001970" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001971" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001972" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001973" tty2::askfirst:-/bin/sh\n" \
1974" tty3::askfirst:-/bin/sh\n" \
1975" tty4::askfirst:-/bin/sh\n" \
1976" \n" \
1977" # /sbin/getty invocations for selected ttys\n" \
1978" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001979" tty4::respawn:/sbin/getty 38400 tty4\n" \
1980" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001981" \n" \
1982" \n" \
1983" # Example of how to put a getty on a serial line (for a terminal)\n" \
1984" #\n" \
1985" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1986" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1987" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001988" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001989" #::respawn:/sbin/getty 57600 ttyS2\n" \
1990" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001991" # Stuff to do when restarting the init process\n" \
1992" ::restart:/sbin/init\n" \
1993" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001994" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001995" ::ctrlaltdel:/sbin/reboot\n" \
1996" ::shutdown:/bin/umount -a -r\n" \
1997" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001998
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001999#define inotifyd_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002000 "PROG FILE1[:MASK]..."
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002001#define inotifyd_full_usage "\n\n" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002002 "Run PROG on filesystem changes." \
2003 "\nWhen a filesystem event matching MASK occurs on FILEn," \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002004 "\nPROG ACTUAL_EVENTS FILEn [SUBFILE] is run." \
Denis Vlasenko289ff0e2008-11-14 21:52:16 +00002005 "\nEvents:" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002006 "\n a File is accessed" \
2007 "\n c File is modified" \
2008 "\n e Metadata changed" \
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02002009 "\n w Writable file is closed" \
2010 "\n 0 Unwritable file is closed" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002011 "\n r File is opened" \
Denis Vlasenkoa09a42c2008-11-17 22:19:18 +00002012 "\n D File is deleted" \
2013 "\n M File is moved" \
2014 "\n u Backing fs is unmounted" \
2015 "\n o Event queue overflowed" \
2016 "\n x File can't be watched anymore" \
2017 "\nIf watching a directory:" \
2018 "\n m Subfile is moved into dir" \
2019 "\n y Subfile is moved out of dir" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002020 "\n n Subfile is created" \
2021 "\n d Subfile is deleted" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002022 "\n" \
2023 "\ninotifyd waits for PROG to exit." \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002024 "\nWhen x event happens for all FILEs, inotifyd exits." \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002025
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002026/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00002027#define install_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002028 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [SOURCE]... DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002029#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002030 "Copy files and set attributes\n" \
2031 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002032 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002033 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002034 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002035 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002036 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002037 "\n -o USER Set ownership" \
2038 "\n -g GRP Set group ownership" \
2039 "\n -m MODE Set permissions" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002040 IF_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002041 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002042 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002043
2044/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002045#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00002046 "[OPTIONS] {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002047 IF_FEATURE_IP_ADDRESS("address | ") \
2048 IF_FEATURE_IP_ROUTE("route | ") \
2049 IF_FEATURE_IP_LINK("link | ") \
2050 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2051 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002052 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002053#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002054 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002055 "where OBJECT := {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002056 IF_FEATURE_IP_ADDRESS("address | ") \
2057 IF_FEATURE_IP_ROUTE("route | ") \
2058 IF_FEATURE_IP_LINK("link | ") \
2059 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2060 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002061 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002062 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002063
2064#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002065 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002066 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002067#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002068 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002069 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
2070 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002071 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002072 " [broadcast ADDR] [anycast ADDR]\n" \
2073 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002074 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002075
Eric Andersende4f07e2003-12-11 01:18:07 +00002076#define ipcalc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002077 "[OPTIONS] ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002078#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002079 "Calculate IP network settings from a IP address\n" \
2080 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002081 IF_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002082 "\n -b,--broadcast Display calculated broadcast address" \
2083 "\n -n,--network Display calculated network address" \
2084 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002085 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002086 "\n -p,--prefix Display the prefix for IP/NETMASK" \
2087 "\n -h,--hostname Display first resolved host name" \
2088 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002089 ) \
2090 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002091 IF_NOT_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002092 "\n -b Display calculated broadcast address" \
2093 "\n -n Display calculated network address" \
2094 "\n -m Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002095 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002096 "\n -p Display the prefix for IP/NETMASK" \
2097 "\n -h Display first resolved host name" \
2098 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002099 ) \
2100 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00002101
Rob Landley6eb1e412005-06-20 04:30:36 +00002102#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002103 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002104#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002105 "Upper-case options MQS remove an object by shmkey value.\n" \
2106 "Lower-case options remove an object by shmid value.\n" \
2107 "\nOptions:" \
2108 "\n -mM Remove memory segment after last detach" \
2109 "\n -qQ Remove message queue" \
2110 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002111
2112#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002113 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002114#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002115 " -i Show specific resource" \
2116 "\nResource specification:" \
2117 "\n -m Shared memory segments" \
2118 "\n -q Message queues" \
2119 "\n -s Semaphore arrays" \
2120 "\n -a All (default)" \
2121 "\nOutput format:" \
2122 "\n -t Time" \
2123 "\n -c Creator" \
2124 "\n -p Pid" \
2125 "\n -l Limits" \
2126 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002127
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002128#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002129 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002130#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00002131 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002132 " dynamic { on | off } |\n" \
2133 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002134 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002135
2136#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002137 "{ list | flush | { add | del | change | append |\n" \
2138 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002139#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002140 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002141 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
2142 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002143 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002144 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00002145 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
2146 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002147
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002148#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002149 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002150#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002151 "iprule [list | add | del] SELECTOR ACTION\n" \
2152 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2153 " [dev STRING] [pref NUMBER]\n" \
2154 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2155 " [prohibit | reject | unreachable]\n" \
2156 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002157 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002158
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002159#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002160 "{ add | change | del | show } [NAME]\n" \
2161 " [mode { ipip | gre | sit }]\n" \
2162 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002163#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002164 "iptunnel { add | change | del | show } [NAME]\n" \
2165 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2166 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002167 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002168
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002169#define kbd_mode_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002170 "[-a|k|s|u] [-C TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002171#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002172 "Report or set the keyboard mode\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002173 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002174 "\n -a Default (ASCII)" \
2175 "\n -k Medium-raw (keyboard)" \
2176 "\n -s Raw (scancode)" \
2177 "\n -u Unicode (utf-8)" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002178 "\n -C TTY Affect TTY instead of /dev/tty" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002179
Eric Andersen7e9276b2001-02-22 01:15:47 +00002180#define kill_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002181 "[-l] [-SIG] PID..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002182#define kill_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002183 "Send a signal (default: TERM) to given PIDs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002184 "\nOptions:" \
2185 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002186/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002187
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002188#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002189 "$ ps | grep apache\n" \
2190 "252 root root S [apache]\n" \
2191 "263 www-data www-data S [apache]\n" \
2192 "264 www-data www-data S [apache]\n" \
2193 "265 www-data www-data S [apache]\n" \
2194 "266 www-data www-data S [apache]\n" \
2195 "267 www-data www-data S [apache]\n" \
2196 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002197
2198#define killall_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002199 "[-l] [-q] [-SIG] PROCESS_NAME..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002200#define killall_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002201 "Send a signal (default: TERM) to given processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002202 "\nOptions:" \
2203 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002204/* "\n -s SIG Yet another way of specifying SIG" */ \
Denys Vlasenko07697852009-10-06 21:11:37 +02002205 "\n -q Don't complain if no processes were killed" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002206
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002207#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002208 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002209
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002210#define killall5_trivial_usage \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002211 "[-l] [-SIG] [-o PID]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002212#define killall5_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002213 "Send a signal (default: TERM) to all processes outside current session\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002214 "\nOptions:" \
2215 "\n -l List all signal names and numbers" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002216 "\n -o PID Don't signal this PID" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002217/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002218
Mark Whitley6317c4b2001-03-12 22:51:50 +00002219#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002220 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002221#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002222 "Kernel logger\n" \
2223 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002224 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002225 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002226
Eric Andersen7e9276b2001-02-22 01:15:47 +00002227#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002228 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002229#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002230 "Print STRING's length"
2231
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002232#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002233 "$ length Hello\n" \
2234 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002235
Rob Landley9200e792005-09-15 19:26:59 +00002236#define less_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002237 "[-EMNmh~I?] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002238#define less_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002239 "View FILE (or stdin) one screenful at a time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002240 "\nOptions:" \
2241 "\n -E Quit once the end of a file is reached" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002242 "\n -M,-m Display status line with line numbers" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002243 "\n and percentage through the file" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002244 "\n -N Prefix line number to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002245 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002246 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002247
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002248#define linux32_trivial_usage NOUSAGE_STR
2249#define linux32_full_usage ""
2250#define linux64_trivial_usage NOUSAGE_STR
2251#define linux64_full_usage ""
2252
2253#define linuxrc_trivial_usage NOUSAGE_STR
2254#define linuxrc_full_usage ""
2255
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002256#define setarch_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002257 "personality PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002258#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002259 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002260 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002261 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002262
Eric Andersen7e9276b2001-02-22 01:15:47 +00002263#define ln_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002264 "[OPTIONS] TARGET... LINK|DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002265#define ln_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002266 "Create a link LINK or DIR/TARGET to the specified TARGET(s)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002267 "\nOptions:" \
2268 "\n -s Make symlinks instead of hardlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002269 "\n -f Remove existing destinations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002270 "\n -n Don't dereference symlinks - treat like normal file" \
2271 "\n -b Make a backup of the target (if exists) before link operation" \
2272 "\n -S suf Use suffix instead of ~ when making backup files" \
2273
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002274#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002275 "$ ln -s BusyBox /tmp/ls\n" \
2276 "$ ls -l /tmp/ls\n" \
2277 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002278
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002279#define load_policy_trivial_usage NOUSAGE_STR
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002280#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002281
Eric Andersen7e9276b2001-02-22 01:15:47 +00002282#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002283 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002284#define loadfont_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002285 "Load a console font from stdin" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002286/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2287
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002288#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002289 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002290
2291#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002292 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002293#define loadkmap_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002294 "Load a binary keyboard translation table from stdin\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002295/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2296
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002297#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002298 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002299
2300#define logger_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002301 "[OPTIONS] [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002302#define logger_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002303 "Write MESSAGE (or stdin) to syslog\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002304 "\nOptions:" \
2305 "\n -s Log to stderr as well as the system log" \
2306 "\n -t TAG Log using the specified tag (defaults to user name)" \
2307 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002308
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002309#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002310 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002311
Robert Griebl1fca5582002-06-04 20:45:46 +00002312#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002313 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002314#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002315 "Begin a new session on the system\n" \
2316 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002317 "\n -f Don't authenticate (user already authenticated)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002318 "\n -h Name of the remote host" \
2319 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002320
Eric Andersen7e9276b2001-02-22 01:15:47 +00002321#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002322 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002323#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002324 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002325#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002326 "$ logname\n" \
2327 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002328
Mark Whitley6317c4b2001-03-12 22:51:50 +00002329#define logread_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002330 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002331#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002332 "Show messages in syslogd's circular buffer\n" \
2333 "\nOptions:" \
2334 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002335
Matt Kraai83788da2002-03-20 17:38:37 +00002336#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002337 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2338 " losetup -d LOOPDEV - disassociate\n" \
2339 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002340#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002341 "Options:" \
2342 "\n -o OFS Start OFS bytes into FILE" \
2343 "\n -f Show first free loop device" \
2344
Rob Landley1d589b22005-11-29 23:47:10 +00002345#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002346 "No arguments will display all current associations.\n" \
2347 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002348 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002349 "and filename of the file the loop device is currently bound to.\n\n" \
2350 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002351 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2352 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002353
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002354#define lpd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002355 "SPOOLDIR [HELPER [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002356#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002357 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2358 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002359 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002360 "\ndirectory and HELPER program is called. Name of file to print" \
2361 "\nis passed in $DATAFILE variable." \
2362 "\nExample:" \
2363 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002364
Denis Vlasenko68444b92008-02-22 22:24:48 +00002365#define lpq_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002366 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID]... [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002367#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002368 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002369 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002370 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002371 "\n -f Force any waiting job to be printed" \
2372 "\n -s Short display" \
2373
2374#define lpr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002375 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE]..."
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002376/* -C CLASS exists too, not shown.
2377 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002378#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002379 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002380 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002381 "\n -m Send mail on completion" \
2382 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002383 "\n -V Verbose" \
2384
Eric Andersen7e9276b2001-02-22 01:15:47 +00002385#define ls_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002386 "[-1Aa" IF_FEATURE_LS_TIMESTAMPS("c") "Cd" \
2387 IF_FEATURE_LS_TIMESTAMPS("e") IF_FEATURE_LS_FILETYPES("F") "iln" \
2388 IF_FEATURE_LS_FILETYPES("p") IF_FEATURE_LS_FOLLOWLINKS("L") \
2389 IF_FEATURE_LS_RECURSIVE("R") IF_FEATURE_LS_SORTFILES("rS") "s" \
2390 IF_FEATURE_AUTOWIDTH("T") IF_FEATURE_LS_TIMESTAMPS("tu") \
2391 IF_FEATURE_LS_SORTFILES("v") IF_FEATURE_AUTOWIDTH("w") "x" \
2392 IF_FEATURE_LS_SORTFILES("X") IF_FEATURE_HUMAN_READABLE("h") "k" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002393 IF_SELINUX("K") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002394#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002395 "List directory contents\n" \
2396 "\nOptions:" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002397 "\n -1 List in a single column" \
2398 "\n -A Don't list . and .." \
2399 "\n -a Don't hide entries starting with ." \
2400 "\n -C List by columns" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002401 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002402 "\n -c With -l: sort by ctime") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002403 IF_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002404 "\n --color[={always,never,auto}] Control coloring") \
2405 "\n -d List directory entries instead of contents" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002406 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002407 "\n -e List full date and time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002408 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002409 "\n -F Append indicator (one of */=@|) to entries") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002410 "\n -i List inode numbers" \
2411 "\n -l Long listing format" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002412 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002413 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002414 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002415 IF_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002416 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002417 IF_FEATURE_LS_RECURSIVE( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002418 "\n -R Recurse") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002419 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002420 "\n -r Sort in reverse order") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002421 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002422 "\n -S Sort by file size") \
Denis Vlasenko397de612008-03-17 08:55:44 +00002423 "\n -s List the size of each file, in blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002424 IF_FEATURE_AUTOWIDTH( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002425 "\n -T N Assume tabstop every N columns") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002426 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002427 "\n -t With -l: sort by modification time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002428 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002429 "\n -u With -l: sort by access time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002430 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002431 "\n -v Sort by version") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002432 IF_FEATURE_AUTOWIDTH( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002433 "\n -w N Assume the terminal is N columns wide") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002434 "\n -x List by lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002435 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002436 "\n -X Sort by extension") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002437 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002438 "\n -h List sizes in human readable format (1K 243M 2G)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002439 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002440 "\n -k List security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002441 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002442 "\n -K List security context in long format") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002443 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002444 "\n -Z List security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002445
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002446#define lsattr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002447 "[-Radlv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002448#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002449 "List file attributes on an ext2 fs\n" \
2450 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002451 "\n -R Recurse" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002452 "\n -a Don't hide entries starting with ." \
Denis Vlasenko397de612008-03-17 08:55:44 +00002453 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002454 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002455 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002456
Eric Andersen7e9276b2001-02-22 01:15:47 +00002457#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002458 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002459#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002460 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002461
Souf Oued982bc712009-12-05 17:56:25 +01002462#define lspci_trivial_usage \
2463 "[-mk]"
2464#define lspci_full_usage "\n\n" \
2465 "List all PCI devices" \
2466 "\n" \
2467 "\n -m Parseable output" \
2468 "\n -k Show driver" \
2469
Souf Oued11a802a2009-12-07 01:37:34 +01002470#define lsusb_trivial_usage NOUSAGE_STR
2471#define lsusb_full_usage ""
2472
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002473#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002474#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002475 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002476#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002477 "Create a range of block or character special files" \
2478 "\n" \
2479 "\nTYPE is:" \
2480 "\n b Block device" \
2481 "\n c Character device" \
2482 "\n f FIFO, MAJOR and MINOR are ignored" \
2483 "\n" \
2484 "\nFIRST..LAST specify numbers appended to NAME." \
2485 "\nIf 's' is the last argument, the base device is created as well." \
2486 "\n" \
2487 "\nExamples:" \
2488 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2489 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002490#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002491 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2492 "[creates ttyS2-ttyS63]\n" \
2493 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2494 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002495#endif
2496
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002497#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002498#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002499 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002500#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002501 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002502 "Device table entries take the form of:\n" \
2503 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002504 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002505 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002506 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002507 " c Character device\n" \
2508 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002509 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002510 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002511 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2512 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002513#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002514 "For example:\n" \
2515 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2516 "/dev d 755 0 0 - - - - -\n" \
2517 "/dev/console c 666 0 0 5 1 - - -\n" \
2518 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2519 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2520 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2521 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2522 "Will Produce:\n" \
2523 "/dev\n" \
2524 "/dev/console\n" \
2525 "/dev/null\n" \
2526 "/dev/zero\n" \
2527 "/dev/hda\n" \
2528 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002529#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002530
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002531#define makemime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002532 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002533#define makemime_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002534 "Create multipart MIME-encoded message from FILEs\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002535/* "Transfer encoding is base64, disposition is inline (not attachment)\n" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002536 "\nOptions:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002537 "\n -o FILE Output. Default: stdout" \
2538 "\n -a HDR Add header. Examples:" \
2539 "\n \"From: user@host.org\", \"Date: `date -R`\"" \
2540 "\n -c CT Content type. Default: text/plain" \
2541 "\n -C CS Charset. Default: " CONFIG_FEATURE_MIME_CHARSET \
2542/* "\n -e ENC Transfer encoding. Ignored. base64 is assumed" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002543 "\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002544 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002545
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002546#define man_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002547 "[OPTIONS] [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002548#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002549 "Format and display manual page\n" \
2550 "\nOptions:" \
2551 "\n -a Display all pages" \
2552 "\n -w Show page locations" \
2553
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002554#define matchpathcon_trivial_usage \
2555 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002556#define matchpathcon_full_usage "\n\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002557 " -n Don't display path" \
2558 "\n -N Don't use translations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002559 "\n -f Use alternate file_context file" \
2560 "\n -p Use prefix to speed translations" \
2561 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002562
Eric Andersen7e9276b2001-02-22 01:15:47 +00002563#define md5sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002564 "[OPTIONS] [FILE]..." \
2565 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTIONS] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002566#define md5sum_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002567 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2568 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002569 "\nOptions:" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002570 "\n -c Check sums against given list" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002571 "\n -s Don't output anything, status code shows success" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002572 "\n -w Warn about improperly formatted checksum lines" \
2573 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002574
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002575#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002576 "$ md5sum < busybox\n" \
2577 "6fd11e98b98a58f64ff3398d7b324003\n" \
2578 "$ md5sum busybox\n" \
2579 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2580 "$ md5sum -c -\n" \
2581 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2582 "busybox: OK\n" \
2583 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002584
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002585#define sha1sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002586 "[OPTIONS] [FILE]..." \
2587 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002588#define sha1sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002589 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002590 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002591 "\nOptions:" \
2592 "\n -c Check sums against given list" \
2593 "\n -s Don't output anything, status code shows success" \
2594 "\n -w Warn about improperly formatted checksum lines" \
2595 )
2596
2597#define sha256sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002598 "[OPTIONS] [FILE]..." \
2599 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha256sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002600#define sha256sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002601 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA256 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002602 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002603 "\nOptions:" \
2604 "\n -c Check sums against given list" \
2605 "\n -s Don't output anything, status code shows success" \
2606 "\n -w Warn about improperly formatted checksum lines" \
2607 )
2608
2609#define sha512sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002610 "[OPTIONS] [FILE]..." \
2611 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha512sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002612#define sha512sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002613 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA512 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002614 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002615 "\nOptions:" \
2616 "\n -c Check sums against given list" \
2617 "\n -s Don't output anything, status code shows success" \
2618 "\n -w Warn about improperly formatted checksum lines" \
2619 )
2620
Rob Landley70f7ef72005-12-13 08:21:33 +00002621#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002622 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002623#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002624 " -s Scan /sys and populate /dev during system boot\n" \
2625 "\n" \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002626 "It can be run by kernel as a hotplug helper. To activate it:\n" \
Denys Vlasenkof92874e2009-12-05 15:59:05 +01002627 " echo /sbin/mdev > /proc/sys/kernel/hotplug\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002628 IF_FEATURE_MDEV_CONF( \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002629 "It uses /etc/mdev.conf with lines\n" \
Denis Vlasenkof2b39e02009-04-13 23:18:52 +00002630 "[-]DEVNAME UID:GID PERM" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002631 IF_FEATURE_MDEV_RENAME(" [>|=PATH]") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002632 IF_FEATURE_MDEV_EXEC(" [@|$|*PROG]") \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002633 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002634
Rob Landleyef10d522006-06-26 14:11:33 +00002635#define mdev_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002636 IF_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002637 "The mdev config file contains lines that look like:\n" \
2638 " hd[a-z][0-9]* 0:3 660\n\n" \
2639 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002640 IF_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002641 "Optionally, that can be followed (on the same line) by a special character\n" \
2642 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002643 "device(s). The environment variable $MDEV indicates the active device node\n" \
2644 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002645 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2646 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002647 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002648 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002649 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002650 "Config file parsing stops on the first matching line. If no config\n" \
2651 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002652 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002653 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002654
Glenn L McGrath061c9002002-09-16 04:21:46 +00002655#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002656 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002657#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002658 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002659 " y Allow write access to your terminal\n" \
2660 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002661
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002662#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002663 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002664#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002665 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2666 "\nOptions:" \
2667 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2668 "\n next byte to it" \
2669 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2670 "\n -s Set serial line to SPEED" \
2671 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002672
Eric Andersen7e9276b2001-02-22 01:15:47 +00002673#define mkdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002674 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002675#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002676 "Create DIRECTORY\n" \
2677 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002678 "\n -m Mode" \
2679 "\n -p No error if exists; make parent directories as needed" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002680 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002681 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002682 )
2683
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002684#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002685 "$ mkdir /tmp/foo\n" \
2686 "$ mkdir /tmp/foo\n" \
2687 "/tmp/foo: File exists\n" \
2688 "$ mkdir /tmp/foo/bar/baz\n" \
2689 "/tmp/foo/bar/baz: No such file or directory\n" \
2690 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002691
Eric Andersen7e9276b2001-02-22 01:15:47 +00002692#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002693 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002694#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002695 "Create named pipe (identical to 'mknod name p')\n" \
2696 "\nOptions:" \
2697 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002698 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002699 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002700 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002701
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002702#define mkfs_ext2_trivial_usage \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002703 "[-Fn] " \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002704 /* "[-c|-l filename] " */ \
2705 "[-b BLK_SIZE] " \
2706 /* "[-f fragment-size] [-g blocks-per-group] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002707 "[-i INODE_RATIO] [-I INODE_SIZE] " \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002708 /* "[-j] [-J journal-options] [-N number-of-inodes] " */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002709 "[-m RESERVED_PERCENT] " \
2710 /* "[-o creator-os] [-O feature[,...]] [-q] " */ \
2711 /* "[r fs-revision-level] [-E extended-options] [-v] [-F] " */ \
2712 "[-L LABEL] " \
2713 /* "[-M last-mounted-directory] [-S] [-T filesystem-type] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002714 "BLOCKDEV [KBYTES]"
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002715#define mkfs_ext2_full_usage "\n\n" \
2716 " -b BLK_SIZE Block size, bytes" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002717/* "\n -c Check device for bad blocks" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002718/* "\n -E opts Set extended options" */ \
2719/* "\n -f size Fragment size in bytes" */ \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002720 "\n -F Force" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002721/* "\n -g N Number of blocks in a block group" */ \
Denys Vlasenko838e07a2009-10-22 12:15:33 +02002722 "\n -i RATIO Max number of files is filesystem_size / RATIO" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002723 "\n -I BYTES Inode size (min 128)" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002724/* "\n -j Create a journal (ext3)" */ \
2725/* "\n -J opts Set journal options (size/device)" */ \
2726/* "\n -l file Read bad blocks list from file" */ \
Denys Vlasenko6a8cfdc2009-10-17 23:41:15 +02002727 "\n -L LBL Volume label" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002728 "\n -m PERCENT Percent of blocks to reserve for admin" \
2729/* "\n -M dir Set last mounted directory" */ \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002730 "\n -n Dry run" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002731/* "\n -N N Number of inodes to create" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002732/* "\n -o os Set the 'creator os' field" */ \
2733/* "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" */ \
2734/* "\n -q Quiet" */ \
2735/* "\n -r rev Set filesystem revision" */ \
2736/* "\n -S Write superblock and group descriptors only" */ \
2737/* "\n -T fs-type Set usage type (news/largefile/largefile4)" */ \
2738/* "\n -v Verbose" */ \
2739
Eric Andersen7e9276b2001-02-22 01:15:47 +00002740#define mkfs_minix_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002741 "[-c | -l FILE] [-nXX] [-iXX] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002742#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002743 "Make a MINIX filesystem\n" \
2744 "\nOptions:" \
2745 "\n -c Check device for bad blocks" \
2746 "\n -n [14|30] Maximum length of filenames" \
2747 "\n -i INODES Number of inodes for the filesystem" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002748 "\n -l FILE Read bad blocks list from FILE" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002749 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002750
Vladimir Dronnikov0d8ea642009-11-02 10:41:46 +01002751#define mkfs_reiser_trivial_usage \
2752 "[-f] [-l LABEL] BLOCKDEV [4K-BLOCKS]"
2753
2754#define mkfs_reiser_full_usage "\n\n" \
2755 "Make a ReiserFS V3 filesystem\n" \
2756 "\nOptions:" \
2757 "\n -f Force" \
2758 "\n -l LBL Volume label" \
2759
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002760#define mkfs_vfat_trivial_usage \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002761 "[-v] [-n LABEL] BLOCKDEV [KBYTES]"
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002762/* Accepted but ignored:
2763 "[-c] [-C] [-I] [-l bad-block-file] [-b backup-boot-sector] "
2764 "[-m boot-msg-file] [-i volume-id] "
2765 "[-s sectors-per-cluster] [-S logical-sector-size] [-f number-of-FATs] "
2766 "[-h hidden-sectors] [-F fat-size] [-r root-dir-entries] [-R reserved-sectors] "
2767*/
2768#define mkfs_vfat_full_usage "\n\n" \
2769 "Make a FAT32 filesystem\n" \
2770 "\nOptions:" \
2771/* "\n -c Check device for bad blocks" */ \
2772 "\n -v Verbose" \
2773/* "\n -I Allow to use entire disk device (e.g. /dev/hda)" */ \
2774 "\n -n LBL Volume label" \
2775
Eric Andersen7e9276b2001-02-22 01:15:47 +00002776#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002777 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002778#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002779 "Create a special file (block, character, or pipe)\n" \
2780 "\nOptions:" \
2781 "\n -m Create the special file using the specified mode (default a=rw)" \
2782 "\nTYPEs include:" \
2783 "\n b: Make a block device" \
2784 "\n c or u: Make a character device" \
2785 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002786 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002787 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002788 )
2789
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002790#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002791 "$ mknod /dev/fd0 b 2 0\n" \
2792 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002793
Eric Andersen7e9276b2001-02-22 01:15:47 +00002794#define mkswap_trivial_usage \
Denys Vlasenko40e7d252010-02-01 23:48:27 +01002795 "[OPTIONS] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002796#define mkswap_full_usage "\n\n" \
Denys Vlasenko68c67462009-11-03 05:51:20 +01002797 "Prepare BLOCKDEV to be used as swap partition\n" \
2798 "\nOptions:" \
2799 "\n -L LBL Label" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002800
Eric Andersen7e9276b2001-02-22 01:15:47 +00002801#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002802 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002803#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002804 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002805 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002806 "\nOptions:" \
2807 "\n -d Make a directory instead of a file" \
2808/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2809 "\n -t Generate a path rooted in temporary directory" \
2810 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2811 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002812 "\nFor -t or -p, directory is chosen as follows:" \
2813 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002814
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002815#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002816 "$ mktemp /tmp/temp.XXXXXX\n" \
2817 "/tmp/temp.mWiLjM\n" \
2818 "$ ls -la /tmp/temp.mWiLjM\n" \
2819 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002820
Eric Andersen7e9276b2001-02-22 01:15:47 +00002821#define more_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002822 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002823#define more_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002824 "View FILE (or stdin) one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002825
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002826#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002827 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002828
Eric Andersen7e9276b2001-02-22 01:15:47 +00002829#define mount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002830 "[OPTIONS] [-o OPTS] DEVICE NODE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002831#define mount_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002832 "Mount a filesystem. Filesystem autodetection requires /proc.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002833 "\nOptions:" \
2834 "\n -a Mount all filesystems in fstab" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002835 IF_FEATURE_MOUNT_FAKE( \
2836 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002837 "\n -f Update /etc/mtab, but don't mount" \
2838 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002839 IF_NOT_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002840 "\n -f Dry run" \
2841 ) \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002842 ) \
Denys Vlasenkoe2e4cc22009-06-19 11:48:29 +02002843 IF_FEATURE_MOUNT_HELPERS( \
2844 "\n -i Don't run mount helper" \
2845 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002846 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002847 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002848 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002849 "\n -r Read-only mount" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002850 "\n -w Read-write mount (default)" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002851 "\n -t FSTYPE Filesystem type" \
2852 "\n -O OPT Mount only filesystems with option OPT (-a only)" \
2853 "\n-o OPT:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002854 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002855 "\n loop Ignored (loop devices are autodetected)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002856 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002857 IF_FEATURE_MOUNT_FLAGS( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002858 "\n [a]sync Writes are [a]synchronous" \
2859 "\n [no]atime Disable/enable updates to inode access times" \
2860 "\n [no]diratime Disable/enable atime updates to directories" \
2861 "\n [no]relatime Disable/enable atime updates relative to modification time" \
2862 "\n [no]dev (Dis)allow use of special device files" \
2863 "\n [no]exec (Dis)allow use of executable files" \
2864 "\n [no]suid (Dis)allow set-user-id-root programs" \
2865 "\n [r]shared Convert [recursively] to a shared subtree" \
2866 "\n [r]slave Convert [recursively] to a slave subtree" \
2867 "\n [r]private Convert [recursively] to a private subtree" \
2868 "\n [un]bindable Make mount point [un]able to be bind mounted" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002869 "\n bind Bind a file or directory to another location" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002870 "\n move Relocate an existing mount point" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002871 ) \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002872 "\n remount Remount a mounted filesystem, changing flags" \
2873 "\n ro/rw Same as -r/-w" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002874 "\n" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002875 "\nThere are filesystem-specific -o flags." \
Denis Vlasenko397de612008-03-17 08:55:44 +00002876
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002877#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002878 "$ mount\n" \
2879 "/dev/hda3 on / type minix (rw)\n" \
2880 "proc on /proc type proc (rw)\n" \
2881 "devpts on /dev/pts type devpts (rw)\n" \
2882 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2883 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2884 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002885#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002886 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002887
Rob Landleyd00b3a52005-08-20 05:07:08 +00002888#define mountpoint_trivial_usage \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002889 "[-q] <[-dn] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002890#define mountpoint_full_usage "\n\n" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002891 "Check if the directory is a mountpoint\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002892 "\nOptions:" \
2893 "\n -q Quiet" \
2894 "\n -d Print major/minor device number of the filesystem" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002895 "\n -n Print device name of the filesystem" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002896 "\n -x Print major/minor device number of the blockdevice" \
2897
Rob Landleyd00b3a52005-08-20 05:07:08 +00002898#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002899 "$ mountpoint /proc\n" \
2900 "/proc is not a mountpoint\n" \
2901 "$ mountpoint /sys\n" \
2902 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002903
Eric Andersen7e9276b2001-02-22 01:15:47 +00002904#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002905 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002906#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002907 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002908 "\n" \
2909 "Available Opcodes:\n" \
2910 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002911 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2912 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2913 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002914 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002915
Eric Andersen7e9276b2001-02-22 01:15:47 +00002916#define mv_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002917 "[OPTIONS] SOURCE DEST\n" \
2918 "or: mv [OPTIONS] SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002919#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002920 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
2921 "\nOptions:" \
2922 "\n -f Don't prompt before overwriting" \
2923 "\n -i Interactive, prompt before overwrite" \
2924
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002925#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002926 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002927
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002928#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002929 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002930#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002931 "Rename network interface while it in the down state\n" \
2932 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002933 "\n -c FILE Use configuration file (default: /etc/mactab)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002934 "\n -s Use syslog (LOCAL0 facility)" \
2935 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
2936
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002937#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002938 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2939 " or\n" \
2940 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002941
Eric Andersen1552ff72001-10-31 11:07:12 +00002942#define netstat_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002943 "[-laentuwxr"IF_FEATURE_NETSTAT_WIDE("W")IF_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002944#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002945 "Display networking information\n" \
2946 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002947 "\n -l Display listening server sockets" \
2948 "\n -a Display all sockets (default: connected)" \
2949 "\n -e Display other/more information" \
2950 "\n -n Don't resolve names" \
2951 "\n -t Tcp sockets" \
2952 "\n -u Udp sockets" \
2953 "\n -w Raw sockets" \
2954 "\n -x Unix sockets" \
2955 "\n -r Display routing table" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002956 IF_FEATURE_NETSTAT_WIDE( \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002957 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00002958 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002959 IF_FEATURE_NETSTAT_PRG( \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00002960 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002961 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002962
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002963#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002964 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002965#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002966 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002967 "Format specifiers:\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02002968 " %Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002969 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02002970 " %[niface] Monitor network interface 'iface'\n" \
2971 " %m Monitor allocated memory\n" \
2972 " %[mf] Monitor free memory\n" \
2973 " %[mt] Monitor total memory\n" \
2974 " %s Monitor allocated swap\n" \
2975 " %f Monitor number of used file descriptors\n" \
2976 " %Ni Monitor total/specific IRQ rate\n" \
2977 " %x Monitor context switch rate\n" \
2978 " %p Monitor forks\n" \
2979 " %[pn] Monitor # of processes\n" \
2980 " %b Monitor block io\n" \
2981 " %Nt Show time (with N decimal points)\n" \
2982 " %Nd Milliseconds between updates (default:1000)\n" \
2983 " %r Print <cr> instead of <lf> at EOL" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002984
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002985#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002986 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002987
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002988#define nohup_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002989 "PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002990#define nohup_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002991 "Run PROG immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002992#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002993 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002994
Eric Andersen7e9276b2001-02-22 01:15:47 +00002995#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002996 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002997#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002998 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002999 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003000#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003001 "$ nslookup localhost\n" \
3002 "Server: default\n" \
3003 "Address: default\n" \
3004 "\n" \
3005 "Name: debian\n" \
3006 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003007
Adam Tkacb1585062009-11-22 03:43:55 +01003008#define ntpd_trivial_usage \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01003009 "[-dnqwl] [-S PROG] [-p PEER]..."
Adam Tkacb1585062009-11-22 03:43:55 +01003010#define ntpd_full_usage "\n\n" \
3011 "NTP client/server\n" \
3012 "\nOptions:" \
3013 "\n -d Verbose" \
3014 "\n -n Do not daemonize" \
Denys Vlasenko8d580c72009-11-23 16:27:16 +01003015 "\n -q Quit after clock is set" \
Denys Vlasenkof03fc7d2010-08-11 05:15:52 +02003016 "\n -N Run at high priority" \
Denys Vlasenko074e8dc2010-01-04 23:58:13 +01003017 "\n -w Do not set time (only query peers), implies -n" \
Adam Tkacb1585062009-11-22 03:43:55 +01003018 "\n -l Run as server on port 123" \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01003019 "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins" \
Adam Tkacb1585062009-11-22 03:43:55 +01003020 "\n -p PEER Obtain time from PEER (may be repeated)" \
3021
Glenn L McGrath60281112001-11-02 11:39:46 +00003022#define od_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003023 "[-aBbcDdeFfHhIiLlOovXx] " IF_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003024#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003025 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003026 "(or stdin) to stdout"
Glenn L McGrath60281112001-11-02 11:39:46 +00003027
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003028#define openvt_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003029 "[-c N] [-sw] [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003030#define openvt_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003031 "Start PROG on a new virtual terminal\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003032 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003033 "\n -c N Use specified VT" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003034 "\n -s Switch to the VT" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003035/* "\n -l Run PROG as login shell (by prepending '-')" */ \
3036 "\n -w Wait for PROG to exit" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003037
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003038#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003039 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003040
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003041/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003042#define parse_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003043 "[-n MAXTOKENS] [-m MINTOKENS] [-d DELIMS] [-f FLAGS] FILE..."
3044#define parse_full_usage ""
3045*/
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003046
Eric Andersen27f64e12002-06-23 04:24:25 +00003047#define passwd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003048 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003049#define passwd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003050 "Change USER's password. If no USER is specified,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003051 "changes the password for the current user.\n" \
3052 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003053 "\n -a Algorithm to use for password (des, md5)" /* ", sha1)" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00003054 "\n -d Delete password for the account" \
3055 "\n -l Lock (disable) account" \
3056 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003057
Denis Vlasenko21d10142007-07-20 21:28:41 +00003058#define chpasswd_trivial_usage \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003059 IF_LONG_OPTS("[--md5|--encrypted]") IF_NOT_LONG_OPTS("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003060#define chpasswd_full_usage "\n\n" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003061 "Read user:password from stdin and update /etc/passwd\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003062 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003063 IF_LONG_OPTS( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003064 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003065 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003066 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003067 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003068 "\n -e Supplied passwords are in encrypted form" \
3069 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003070 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00003071
Glenn L McGrath655d8142003-06-22 15:32:41 +00003072#define patch_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003073 "[OPTIONS] [ORIGFILE [PATCHFILE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003074#define patch_full_usage "\n\n" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003075 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003076 " -p,--strip N Strip N leading components from file names" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003077 "\n -i,--input DIFF Read DIFF instead of stdin" \
3078 "\n -R,--reverse Reverse patch" \
3079 "\n -N,--forward Ignore already applied patches" \
3080 "\n --dry-run Don't actually change files" \
3081 ) \
3082 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003083 " -p N Strip N leading components from file names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003084 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003085 "\n -R Reverse patch" \
Denys Vlasenkod7874ed2009-08-20 23:33:19 +02003086 "\n -N Ignore already applied patches" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003087 )
Denis Vlasenko397de612008-03-17 08:55:44 +00003088
Glenn L McGrath655d8142003-06-22 15:32:41 +00003089#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003090 "$ patch -p1 < example.diff\n" \
3091 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00003092
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003093#define pgrep_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003094 "[-flnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003095#define pgrep_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003096 "Display process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003097 "\nOptions:" \
3098 "\n -l Show command name too" \
3099 "\n -f Match against entire command line" \
3100 "\n -n Show the newest process only" \
3101 "\n -o Show the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003102 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003103 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003104 "\n -s Match session ID (0 for current)" \
3105 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003106
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003107#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00003108#define pidof_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003109 "[OPTIONS] [NAME]..."
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003110#define USAGE_PIDOF "\n\nOptions:"
3111#else
3112#define pidof_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003113 "[NAME]..."
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003114#define USAGE_PIDOF /* none */
3115#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003116#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003117 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003118 USAGE_PIDOF \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003119 IF_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003120 "\n -s Show only one PID") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003121 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003122 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003123 "\n Use %PPID to omit pid of pidof's parent") \
3124
Eric Andersen221b2ea2001-07-31 19:06:07 +00003125#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003126 "$ pidof init\n" \
3127 "1\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003128 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003129 "$ pidof /bin/sh\n20351 5973 5950\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003130 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003131 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00003132
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003133#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003134#define ping_trivial_usage \
3135 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003136#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003137 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003138#define ping6_trivial_usage \
3139 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003140#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003141 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003142#else
3143#define ping_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003144 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003145#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003146 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3147 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003148 "\n -4, -6 Force IP or IPv6 name resolution" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003149 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003150 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3151 "\n -I IFACE/IP Use interface or IP address as source" \
3152 "\n -W SEC Seconds to wait for the first response (default:10)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003153 "\n (after all -c CNT packets are sent)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003154 "\n -w SEC Seconds until ping exits (default:infinite)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003155 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003156 "\n -q Quiet, only displays output at start" \
3157 "\n and when finished" \
3158
Eric Andersen51b8bd62002-07-03 11:46:38 +00003159#define ping6_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003160 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003161#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003162 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3163 "\nOptions:" \
3164 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003165 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3166 "\n -I IFACE/IP Use interface or IP address as source" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003167 "\n -q Quiet, only displays output at start" \
3168 "\n and when finished" \
3169
Eric Andersen51b8bd62002-07-03 11:46:38 +00003170#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003171#define ping_example_usage \
3172 "$ ping localhost\n" \
3173 "PING slag (127.0.0.1): 56 data bytes\n" \
3174 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3175 "\n" \
3176 "--- debian ping statistics ---\n" \
3177 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3178 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003179#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003180 "$ ping6 ip6-localhost\n" \
3181 "PING ip6-localhost (::1): 56 data bytes\n" \
3182 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3183 "\n" \
3184 "--- ip6-localhost ping statistics ---\n" \
3185 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3186 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003187
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003188#define pipe_progress_trivial_usage NOUSAGE_STR
3189#define pipe_progress_full_usage ""
3190
Eric Andersen7e9276b2001-02-22 01:15:47 +00003191#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003192 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003193#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003194 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003195 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003196
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003197#define pkill_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003198 "[-l|-SIGNAL] [-fnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003199#define pkill_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003200 "Send a signal to process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003201 "\nOptions:" \
3202 "\n -l List all signals" \
3203 "\n -f Match against entire command line" \
3204 "\n -n Signal the newest process only" \
3205 "\n -o Signal the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003206 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003207 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003208 "\n -s Match session ID (0 for current)" \
3209 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003210
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003211#define popmaildir_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003212 "[OPTIONS] MAILDIR [CONN_HELPER ARGS]"
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003213#define popmaildir_full_usage "\n\n" \
3214 "Fetch content of remote mailbox to local maildir\n" \
3215 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003216/* "\n -b Binary mode. Ignored" */ \
3217/* "\n -d Debug. Ignored" */ \
3218/* "\n -m Show used memory. Ignored" */ \
3219/* "\n -V Show version. Ignored" */ \
3220/* "\n -c Use tcpclient. Ignored" */ \
3221/* "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003222 "\n -s Skip authorization" \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003223 "\n -T Get messages with TOP instead of RETR" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003224 "\n -k Keep retrieved messages on the server" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003225 "\n -t SEC Network timeout" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003226 IF_FEATURE_POPMAILDIR_DELIVERY( \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003227 "\n -F \"PROG ARGS\" Filter program (may be repeated)" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003228 "\n -M \"PROG ARGS\" Delivery program" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003229 ) \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003230 "\n" \
3231 "\nFetch from plain POP3 server:" \
3232 "\npopmaildir -k DIR nc pop3.server.com 110 <user_and_pass.txt" \
3233 "\nFetch from SSLed POP3 server and delete fetched emails:" \
3234 "\npopmaildir DIR -- openssl s_client -quiet -connect pop3.server.com:995 <user_and_pass.txt"
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003235/* "\n -R BYTES Remove old messages on the server >= BYTES. Ignored" */
3236/* "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" */
3237/* "\n -L BYTES Don't retrieve new messages >= BYTES. Ignored" */
3238/* "\n -H LINES Type first LINES of a message. Ignored" */
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003239#define popmaildir_example_usage \
3240 "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n" \
3241 "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
3242
Mike Frysinger95d3c452005-04-21 23:29:24 +00003243#define printenv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003244 "[VARIABLE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003245#define printenv_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003246 "Print environment VARIABLEs.\n" \
3247 "If no VARIABLE specified, print all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003248
Eric Andersen7e9276b2001-02-22 01:15:47 +00003249#define printf_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003250 "FORMAT [ARGUMENT]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003251#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003252 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003253 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003254#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003255 "$ printf \"Val=%d\\n\" 5\n" \
3256 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003257
Denis Vlasenko94949192006-11-05 00:45:47 +00003258
3259#if ENABLE_DESKTOP
3260
3261#define ps_trivial_usage \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003262 "[-o COL1,COL2=HEADER]" IF_FEATURE_SHOW_THREADS(" [-T]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003263#define ps_full_usage "\n\n" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003264 "Show list of processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003265 "\nOptions:" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003266 "\n -o COL1,COL2=HEADER Select columns for display" \
Denys Vlasenko532609e2009-09-20 20:29:25 +02003267 IF_FEATURE_SHOW_THREADS( \
3268 "\n -T Show threads" \
3269 )
Denis Vlasenko94949192006-11-05 00:45:47 +00003270
3271#else /* !ENABLE_DESKTOP */
3272
Denis Vlasenko397de612008-03-17 08:55:44 +00003273#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003274#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003275#else
3276#define USAGE_PS "\nOptions:"
3277#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003278
Eric Andersen7e9276b2001-02-22 01:15:47 +00003279#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003280 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003281#define ps_full_usage "\n\n" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003282 "Show list of processes\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003283 USAGE_PS \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003284 IF_SELINUX( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003285 "\n -Z Show selinux context" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003286 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003287 IF_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003288 "\n w Wide output" \
3289 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003290
Denis Vlasenko94949192006-11-05 00:45:47 +00003291#endif /* ENABLE_DESKTOP */
3292
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003293#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003294 "$ ps\n" \
3295 " PID Uid Gid State Command\n" \
3296 " 1 root root S init\n" \
3297 " 2 root root S [kflushd]\n" \
3298 " 3 root root S [kupdate]\n" \
3299 " 4 root root S [kpiod]\n" \
3300 " 5 root root S [kswapd]\n" \
3301 " 742 andersen andersen S [bash]\n" \
3302 " 743 andersen andersen S -bash\n" \
3303 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003304 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003305
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003306#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003307 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003308#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003309 "Scan a host, print all open ports\n" \
3310 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003311 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003312 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003313 "\n -p Scan from this port (default 1)" \
3314 "\n -P Scan up to this port (default 1024)" \
3315 "\n -t Timeout (default 5000 ms)" \
3316 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3317
Eric Andersen7e9276b2001-02-22 01:15:47 +00003318#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003319 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003320#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003321 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003322#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003323 "$ pwd\n" \
3324 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003325
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003326#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003327 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003328#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003329 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003330#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003331 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003332
Eric Andersen7e9276b2001-02-22 01:15:47 +00003333#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003334 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003335#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003336 "Get and possibly set the system date and time from a remote HOST\n" \
3337 "\nOptions:" \
3338 "\n -s Set the system date and time (default)" \
3339 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003340
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00003341#define rdev_trivial_usage \
3342 ""
3343#define rdev_full_usage "\n\n" \
3344 "Print the device node associated with the filesystem mounted at '/'"
3345#define rdev_example_usage \
3346 "$ rdev\n" \
3347 "/dev/mtdblock9 /\n"
3348
Rob Landley0e4690d2006-08-20 22:12:18 +00003349#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003350 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003351#define readahead_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003352 "Preload FILEs to RAM"
Rob Landley0e4690d2006-08-20 22:12:18 +00003353
Eric Andersen7e9276b2001-02-22 01:15:47 +00003354#define readlink_trivial_usage \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003355 IF_FEATURE_READLINK_FOLLOW("[-fnv] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003356#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003357 "Display the value of a symlink" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003358 IF_FEATURE_READLINK_FOLLOW( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003359 "\nOptions:" \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003360 "\n -f Canonicalize by following all symlinks" \
3361 "\n -n Don't add newline" \
3362 "\n -v Verbose" \
3363 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003364
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003365#define readprofile_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003366 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003367#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003368 "Options:" \
3369 "\n -m mapfile (Default: /boot/System.map)" \
3370 "\n -p profile (Default: /proc/profile)" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003371 "\n -M NUM Set the profiling multiplier to NUM" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003372 "\n -i Print only info about the sampling step" \
3373 "\n -v Verbose" \
3374 "\n -a Print all symbols, even if count is 0" \
3375 "\n -b Print individual histogram-bin counts" \
3376 "\n -s Print individual counters within functions" \
3377 "\n -r Reset all the counters (root only)" \
3378 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003379
Glenn L McGrath62fae302002-12-10 00:14:33 +00003380#define realpath_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003381 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003382#define realpath_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003383 "Return the absolute pathnames of given FILE"
Tim Riker7b253f82003-12-28 05:02:40 +00003384
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003385#define reformime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003386 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003387#define reformime_full_usage "\n\n" \
3388 "Parse MIME-encoded message\n" \
3389 "\nOptions:" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003390 "\n -x PREFIX Extract content of MIME sections to files" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003391 "\n -X PROG ARGS Filter content of MIME sections through PROG" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003392 "\n Must be the last option" \
3393 "\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003394 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003395
Denys Vlasenko5e611152009-05-19 17:36:16 +02003396#define scriptreplay_trivial_usage \
3397 "timingfile [typescript [divisor]]"
3398#define scriptreplay_full_usage "\n\n" \
3399 "Play back typescripts, using timing information"
3400
Eric Andersen7e9276b2001-02-22 01:15:47 +00003401#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003402 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003403#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003404 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003405
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003406#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003407 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003408#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003409 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003410
Denis Vlasenko397137b2007-07-23 14:03:30 +00003411#define restorecon_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003412 "[-iFnRv] [-e EXCLUDEDIR]... [-o FILE] [-f FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003413#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003414 "Reset security contexts of files in pathname\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003415 "\n -i Ignore files that don't exist" \
3416 "\n -f FILE File with list of files to process" \
3417 "\n -e DIR Directory to exclude" \
3418 "\n -R,-r Recurse" \
3419 "\n -n Don't change any file labels" \
3420 "\n -o FILE Save list of files with incorrect context" \
3421 "\n -v Verbose" \
3422 "\n -vv Show changed labels" \
3423 "\n -F Force reset of context to match file_context" \
3424 "\n for customizable files, or the user section," \
3425 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003426
Souf Oued43afd752010-05-02 18:45:02 +02003427#define rfkill_trivial_usage \
3428 "COMMAND [INDEX|TYPE]"
3429#define rfkill_full_usage "\n\n" \
3430 "Enable/disable wireless devices\n" \
3431 "\nCommands:" \
3432 "\n list [INDEX|TYPE] List current state" \
3433 "\n block INDEX|TYPE Disable device" \
3434 "\n unblock INDEX|TYPE Enable device" \
3435 "\n" \
3436 "\n TYPE: all, wlan(wifi), bluetooth, uwb(ultrawideband)," \
3437 "\n wimax, wwan, gps, fm" \
3438
Eric Andersen7e9276b2001-02-22 01:15:47 +00003439#define rm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003440 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003441#define rm_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003442 "Remove (unlink) FILEs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003443 "\nOptions:" \
3444 "\n -i Always prompt before removing" \
3445 "\n -f Never prompt" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003446 "\n -R,-r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003447
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003448#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003449 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003450
Eric Andersen7e9276b2001-02-22 01:15:47 +00003451#define rmdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003452 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003453#define rmdir_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003454 "Remove DIRECTORY if it is empty\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003455 "\nOptions:" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003456 IF_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003457 "\n -p|--parents Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003458 "\n --ignore-fail-on-non-empty" \
3459 ) \
3460 IF_NOT_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003461 "\n -p Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003462 )
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003463
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003464#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003465 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003466
Eric Andersen7e9276b2001-02-22 01:15:47 +00003467#define rmmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003468 "[OPTIONS] [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003469#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003470 "Unload the specified kernel modules from the kernel\n" \
3471 "\nOptions:" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003472 "\n -w Wait until the module is no longer used" \
3473 "\n -f Force unloading" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003474 "\n -a Remove all unused modules (recursively)" \
3475
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003476#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003477 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003478
Eric Andersen7e9276b2001-02-22 01:15:47 +00003479#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003480 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003481#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003482 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003483 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003484 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003485 "\n -e Display other/more information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003486 "\n -A inet" IF_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003487
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003488#define rpm_trivial_usage \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02003489 "-i PACKAGE.rpm; rpm -qp[ildc] PACKAGE.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003490#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003491 "Manipulate RPM packages\n" \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02003492 "\nCommands:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003493 "\n -i Install package" \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02003494 "\n -qp Query package" \
3495 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003496 "\n -i Show information" \
3497 "\n -l List contents" \
3498 "\n -d List documents" \
3499 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003500
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003501#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003502 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003503#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003504 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003505
Mike Frysinger6b160e42008-02-15 02:27:19 +00003506#define rtcwake_trivial_usage \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003507 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SEC | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003508#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003509 "Enter a system sleep state until specified wakeup time\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003510 IF_LONG_OPTS( \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003511 "\n -a,--auto Read clock mode from adjtime" \
3512 "\n -l,--local Clock is set to local time" \
3513 "\n -u,--utc Clock is set to UTC time" \
3514 "\n -d,--device=DEV Specify the RTC device" \
3515 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003516 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003517 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003518 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003519 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003520 "\n -a Read clock mode from adjtime" \
3521 "\n -l Clock is set to local time" \
3522 "\n -u Clock is set to UTC time" \
3523 "\n -d DEV Specify the RTC device" \
3524 "\n -m MODE Set the sleep state (default: standby)" \
3525 "\n -s SEC Set the timeout in SEC seconds from now" \
3526 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003527 )
3528
Denis Vlasenko49622d72007-03-10 16:58:49 +00003529#define runcon_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003530 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] PROG ARGS\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003531 "runcon CONTEXT PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003532#define runcon_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003533 "Run PROG in a different security context\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003534 "\n CONTEXT Complete security context\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003535 IF_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003536 "\n -c,--compute Compute process transition context before modifying" \
3537 "\n -t,--type=TYPE Type (for same role as parent)" \
3538 "\n -u,--user=USER User identity" \
3539 "\n -r,--role=ROLE Role" \
3540 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003541 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003542 IF_NOT_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003543 "\n -c Compute process transition context before modifying" \
3544 "\n -t TYPE Type (for same role as parent)" \
3545 "\n -u USER User identity" \
3546 "\n -r ROLE Role" \
3547 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003548 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003549
Eric Andersen6cf47a72001-10-31 10:24:36 +00003550#define run_parts_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003551 "[-t] "IF_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003552#define run_parts_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003553 "Run a bunch of scripts in DIRECTORY\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003554 "\nOptions:" \
3555 "\n -t Print what would be run, but don't actually run anything" \
3556 "\n -a ARG Pass ARG as argument for every program" \
3557 "\n -u MASK Set the umask to MASK before running every program" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003558 IF_FEATURE_RUN_PARTS_FANCY( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003559 "\n -l Print names of all matching files even if they are not executable" \
3560 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003561
3562#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003563 "$ run-parts -a start /etc/init.d\n" \
3564 "$ run-parts -a stop=now /etc/init.d\n\n" \
3565 "Let's assume you have a script foo/dosomething:\n" \
3566 "#!/bin/sh\n" \
3567 "for i in $*; do eval $i; done; unset i\n" \
3568 "case \"$1\" in\n" \
3569 "start*) echo starting something;;\n" \
3570 "stop*) set -x; shutdown -h $stop;;\n" \
3571 "esac\n\n" \
3572 "Running this yields:\n" \
3573 "$run-parts -a stop=+4m foo/\n" \
3574 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003575
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003576#define runlevel_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003577 "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003578#define runlevel_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003579 "Find the current and previous system runlevel\n" \
3580 "\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003581 "If no utmp FILE exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003582 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003583#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003584 "$ runlevel /var/run/utmp\n" \
3585 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003586
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003587#define runsv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003588 "DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003589#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003590 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003591
3592#define runsvdir_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003593 "[-P] [-s SCRIPT] DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003594#define runsvdir_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003595 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
3596 "\n -P Put each runsv in a new session" \
3597 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003598
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003599#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003600 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003601#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003602 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003603#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003604 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003605
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003606#define script_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003607 "[-afq" IF_SCRIPTREPLAY("t") "] [-c PROG] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003608#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003609 "Options:" \
3610 "\n -a Append output" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003611 "\n -c PROG Run PROG, not shell" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003612 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003613 "\n -q Quiet" \
Denys Vlasenko5e611152009-05-19 17:36:16 +02003614 IF_SCRIPTREPLAY( \
3615 "\n -t Send timing to stderr" \
3616 )
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003617
Eric Andersen7e9276b2001-02-22 01:15:47 +00003618#define sed_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003619 "[-efinr] SED_CMD [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003620#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003621 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003622 "\n -e CMD Add CMD to sed commands to be executed" \
3623 "\n -f FILE Add FILE contents to sed commands to be executed" \
Denys Vlasenkodac863a2009-10-27 09:11:17 +01003624 "\n -i Edit files in-place (else sends result to stdout)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003625 "\n -n Suppress automatic printing of pattern space" \
3626 "\n -r Use extended regex syntax" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003627 "\n" \
Rob Landley7b284152009-10-26 16:04:07 -05003628 "\nIf no -e or -f, the first non-option argument is the sed command string." \
3629 "\nRemaining arguments are input files (stdin if none)."
Eric Andersenf802ff72004-04-12 15:12:06 +00003630
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003631#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003632 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3633 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003634
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003635#define selinuxenabled_trivial_usage NOUSAGE_STR
3636#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003637
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003638#define sendmail_trivial_usage \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003639 "[OPTIONS] [RECIPIENT_EMAIL]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003640#define sendmail_full_usage "\n\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003641 "Read email from stdin and send it\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003642 "\nStandard options:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003643 "\n -t Read additional recipients from message body" \
3644 "\n -f sender Sender (required)" \
3645 "\n -o options Various options. -oi implied, others are ignored" \
Vladimir Dronnikovb618dba2009-10-04 01:34:54 +02003646 "\n -i -oi synonym. implied and ignored" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003647 "\n" \
3648 "\nBusybox specific options:" \
3649 "\n -w seconds Network timeout" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003650 "\n -H 'PROG ARGS' Run connection helper" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003651 "\n Examples:" \
Denis Vlasenko7e0c2432009-03-02 16:12:00 +00003652 "\n -H 'exec openssl s_client -quiet -tls1 -starttls smtp" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003653 "\n -connect smtp.gmail.com:25' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003654 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003655 "\n -H 'exec openssl s_client -quiet -tls1" \
3656 "\n -connect smtp.gmail.com:465' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003657 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003658 "\n -S server[:port] Server" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003659 "\n -au<username> Username for AUTH LOGIN" \
3660 "\n -ap<password> Password for AUTH LOGIN" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003661 "\n -am<method> Authentication method. Ignored. LOGIN is implied" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003662 "\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003663 "\nOther options are silently ignored; -oi -t is implied" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003664 IF_MAKEMIME( \
3665 "\nUse makemime applet to create message with attachments" \
3666 )
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003667
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003668#define seq_trivial_usage \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003669 "[-w] [-s SEP] [FIRST [INC]] LAST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003670#define seq_full_usage "\n\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003671 "Print numbers from FIRST to LAST, in steps of INC.\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003672 "FIRST, INC default to 1.\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003673 "\nOptions:" \
3674 "\n -w Pad to last with leading zeros" \
3675 "\n -s SEP String separator" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003676
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003677#define sestatus_trivial_usage \
3678 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003679#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003680 " -v Verbose" \
3681 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003682
Paul Foxfc2256a2005-08-01 18:12:30 +00003683#define setconsole_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003684 "[-r" IF_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003685#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003686 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3687 "\nOptions:" \
3688 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003689
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003690#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003691 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003692#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003693
Denis Vlasenko397137b2007-07-23 14:03:30 +00003694#define setfiles_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003695 "[-dnpqsvW] [-e DIR]... [-o FILE] [-r alt_root_path]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003696 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003697 " [-c policyfile] spec_file" \
3698 ) \
3699 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003700#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003701 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003702 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003703 "\n -c FILE Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003704 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003705 "\n -d Show which specification matched each file" \
3706 "\n -l Log changes in file labels to syslog" \
3707 "\n -n Don't change any file labels" \
3708 "\n -q Suppress warnings" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003709 "\n -r DIR Use an alternate root path" \
3710 "\n -e DIR Exclude DIR" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003711 "\n -F Force reset of context to match file_context for customizable files" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003712 "\n -o FILE Save list of files with incorrect context" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003713 "\n -s Take a list of files from stdin (instead of command line)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003714 "\n -v Show changes in file labels, if type or role are changing" \
3715 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3716 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003717
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003718#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003719 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003720#define setfont_full_usage "\n\n" \
3721 "Load a console font\n" \
3722 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003723 "\n -m MAPFILE Load console screen map" \
3724 "\n -C TTY Affect TTY instead of /dev/tty" \
3725
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003726#define setfont_example_usage \
3727 "$ setfont -m koi8-r /etc/i18n/fontname\n"
3728
Eric Andersen7e9276b2001-02-22 01:15:47 +00003729#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003730 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003731#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003732 "Set entries into the kernel's scancode-to-keycode map,\n" \
3733 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3734 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003735 "and KEYCODE is given in decimal." \
Denis Vlasenko397de612008-03-17 08:55:44 +00003736
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003737#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003738 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003739
Rob Landley87848d92006-03-27 23:23:43 +00003740#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003741 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003742#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003743 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003744
Denis Vlasenkobe039372007-10-14 04:48:44 +00003745#define setsebool_trivial_usage \
3746 "boolean value"
3747
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003748#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00003749 "Change boolean setting"
3750
Paul Fox42403642005-08-01 22:52:09 +00003751#define setsid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003752 "PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003753#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003754 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3755 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3756 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003757
Eric Andersen2e9c2572003-08-08 22:26:06 +00003758#define last_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003759 ""IF_FEATURE_LAST_FANCY("[-HW] [-f FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003760#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003761 "Show listing of the last users that logged into the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003762 IF_FEATURE_LAST_FANCY( "\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003763 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00003764/* "\n -H Show header line" */ \
3765 "\n -W Display with no host column truncation" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003766 "\n -f FILE Read from FILE instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003767 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00003768
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00003769#define showkey_trivial_usage \
3770 "[-a | -k | -s]"
3771#define showkey_full_usage "\n\n" \
3772 "Show keys pressed\n" \
3773 "\nOptions:" \
3774 "\n -a Display decimal/octal/hex values of the keys" \
3775 "\n -k Display interpreted keycodes (default)" \
3776 "\n -s Display raw scan-codes" \
3777
Denis Vlasenko14923db2007-06-20 15:23:03 +00003778#define slattach_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003779 "[-cehmLF] [-s SPEED] [-p PROTOCOL] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003780#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003781 "Attach network interface(s) to serial line(s)\n" \
3782 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003783 "\n -p PROT Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3784 "\n -s SPD Set line speed" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003785 "\n -e Exit after initializing device" \
3786 "\n -h Exit when the carrier is lost" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003787 "\n -c PROG Run PROG when the line is hung up" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003788 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3789 "\n -L Enable 3-wire operation" \
3790 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003791
Eric Andersen7e9276b2001-02-22 01:15:47 +00003792#define sleep_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003793 IF_FEATURE_FANCY_SLEEP("[") "N" IF_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003794#define sleep_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003795 IF_NOT_FEATURE_FANCY_SLEEP("Pause for N seconds") \
3796 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003797 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003798 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003799#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003800 "$ sleep 2\n" \
3801 "[2 second delay results]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003802 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003803 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003804 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003805
Eric Andersen7e9276b2001-02-22 01:15:47 +00003806#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003807 "[-nru" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003808 IF_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003809 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003810#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003811 "Sort lines of text\n" \
3812 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003813 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003814 "\n -b Ignore leading blanks" \
3815 "\n -c Check whether input is sorted" \
3816 "\n -d Dictionary order (blank or alphanumeric only)" \
3817 "\n -f Ignore case" \
3818 "\n -g General numerical sort" \
3819 "\n -i Ignore unprintable characters" \
3820 "\n -k Sort key" \
3821 "\n -M Sort month" \
3822 ) \
3823 "\n -n Sort numbers" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003824 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003825 "\n -o Output to file" \
3826 "\n -k Sort by key" \
3827 "\n -t CHAR Key separator" \
3828 ) \
3829 "\n -r Reverse sort order" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003830 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003831 "\n -s Stable (don't sort ties alphabetically)" \
3832 ) \
3833 "\n -u Suppress duplicate lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003834 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003835 "\n -z Lines are terminated by NUL, not newline" \
3836 "\n -mST Ignored for GNU compatibility") \
3837
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003838#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003839 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3840 "a\n" \
3841 "b\n" \
3842 "c\n" \
3843 "d\n" \
3844 "e\n" \
3845 "f\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003846 IF_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003847 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3848 "d 2\n" \
3849 "b 2\n" \
3850 "c 3\n" \
3851 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003852 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003853
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003854#define split_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003855 "[OPTIONS] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003856#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003857 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003858 "\n -b n[k|m] Split by bytes" \
3859 "\n -l n Split by lines" \
3860 "\n -a n Use n letters as suffix" \
3861
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003862#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003863 "$ split TODO foo\n" \
3864 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003865
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003866#define start_stop_daemon_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003867 "[OPTIONS] [-S|-K] ... [-- ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003868#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003869 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003870 "-K: stop all matching processes.\n" \
3871 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003872 IF_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003873 "\nProcess matching:" \
3874 "\n -u,--user USERNAME|UID Match only this user's processes" \
3875 "\n -n,--name NAME Match processes with NAME" \
3876 "\n in comm field in /proc/PID/stat" \
3877 "\n -x,--exec EXECUTABLE Match processes with this command" \
3878 "\n in /proc/PID/cmdline" \
3879 "\n -p,--pidfile FILE Match a process with PID from the file" \
3880 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003881 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003882 "\n -x,--exec EXECUTABLE Program to run" \
3883 "\n -a,--startas NAME Zeroth argument" \
3884 "\n -b,--background Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003885 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003886 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003887 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003888 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
3889 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003890 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003891 "\n -s,--signal SIG Signal to send" \
3892 "\n -t,--test Match only, exit with 0 if a process is found" \
3893 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003894 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003895 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003896 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003897 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003898 "\n -q,--quiet Quiet" \
3899 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003900 IF_NOT_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003901 "\nProcess matching:" \
3902 "\n -u USERNAME|UID Match only this user's processes" \
3903 "\n -n NAME Match processes with NAME" \
3904 "\n in comm field in /proc/PID/stat" \
3905 "\n -x EXECUTABLE Match processes with this command" \
3906 "\n command in /proc/PID/cmdline" \
3907 "\n -p FILE Match a process with PID from the file" \
3908 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003909 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003910 "\n -x EXECUTABLE Program to run" \
3911 "\n -a NAME Zeroth argument" \
3912 "\n -b Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003913 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003914 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003915 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003916 "\n -c USER[:[GRP]] Change to user/group" \
3917 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003918 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003919 "\n -s SIG Signal to send" \
3920 "\n -t Match only, exit with 0 if a process is found" \
3921 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003922 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003923 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003924 "\n -v Verbose" \
3925 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003926 "\n -q Quiet" \
3927 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003928
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003929#define stat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003930 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003931#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003932 "Display file (default) or filesystem status\n" \
3933 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003934 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003935 "\n -c fmt Use the specified format" \
3936 ) \
3937 "\n -f Display filesystem status" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003938 "\n -L Follow links" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003939 "\n -t Display info in terse form" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003940 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003941 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003942 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003943 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003944 "\n\nValid format sequences for files:\n" \
3945 " %a Access rights in octal\n" \
3946 " %A Access rights in human readable form\n" \
3947 " %b Number of blocks allocated (see %B)\n" \
3948 " %B The size in bytes of each block reported by %b\n" \
3949 " %d Device number in decimal\n" \
3950 " %D Device number in hex\n" \
3951 " %f Raw mode in hex\n" \
3952 " %F File type\n" \
3953 " %g Group ID of owner\n" \
3954 " %G Group name of owner\n" \
3955 " %h Number of hard links\n" \
3956 " %i Inode number\n" \
3957 " %n File name\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003958 " %N File name, with -> TARGET if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003959 " %o I/O block size\n" \
3960 " %s Total size, in bytes\n" \
3961 " %t Major device type in hex\n" \
3962 " %T Minor device type in hex\n" \
3963 " %u User ID of owner\n" \
3964 " %U User name of owner\n" \
3965 " %x Time of last access\n" \
3966 " %X Time of last access as seconds since Epoch\n" \
3967 " %y Time of last modification\n" \
3968 " %Y Time of last modification as seconds since Epoch\n" \
3969 " %z Time of last change\n" \
3970 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003971 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003972 " %a Free blocks available to non-superuser\n" \
3973 " %b Total data blocks in file system\n" \
3974 " %c Total file nodes in file system\n" \
3975 " %d Free file nodes in file system\n" \
3976 " %f Free blocks in file system\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003977 IF_SELINUX( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003978 " %C Security context in selinux\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003979 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003980 " %i File System ID in hex\n" \
3981 " %l Maximum length of filenames\n" \
3982 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003983 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003984 " %S Fundamental block size (for block counts)\n" \
3985 " %t Type in hex\n" \
3986 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003987 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003988
Eric Andersenef5e8f82002-11-07 02:09:37 +00003989#define strings_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003990 "[-afo] [-n LEN] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003991#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003992 "Display printable strings in a binary file\n" \
3993 "\nOptions:" \
3994 "\n -a Scan whole file (default)" \
3995 "\n -f Precede strings with filenames" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003996 "\n -n LEN At least LEN characters form a string (default 4)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003997 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00003998
Eric Andersen7e9276b2001-02-22 01:15:47 +00003999#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004000 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004001#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004002 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004003 "and deviations from stty sane\n" \
4004 "\nOptions:" \
4005 "\n -F DEVICE Open device instead of stdin" \
4006 "\n -a Print all current settings in human-readable form" \
4007 "\n -g Print in stty-readable form" \
4008 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004009
Robert Griebl1fca5582002-06-04 20:45:46 +00004010#define su_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004011 "[OPTIONS] [-] [USERNAME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004012#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004013 "Change user id or become root\n" \
4014 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004015 "\n -p,-m Preserve environment" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004016 "\n -c CMD Command to pass to 'sh -c'" \
4017 "\n -s SH Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00004018
Eric Andersen27f64e12002-06-23 04:24:25 +00004019#define sulogin_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004020 "[-t N] [TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004021#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004022 "Single user login\n" \
4023 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004024 "\n -t N Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004025
Mike Frysinger95d3c452005-04-21 23:29:24 +00004026#define sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004027 "[-rs] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004028#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004029 "Checksum and count the blocks in a file\n" \
4030 "\nOptions:" \
4031 "\n -r Use BSD sum algorithm (1K blocks)" \
4032 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00004033
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004034#define sv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004035 "[-v] [-w SEC] CMD SERVICE_DIR..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004036#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004037 "Control services monitored by runsv supervisor.\n" \
4038 "Commands (only first character is enough):\n" \
4039 "\n" \
4040 "status: query service status\n" \
4041 "up: if service isn't running, start it. If service stops, restart it\n" \
4042 "once: like 'up', but if service stops, don't restart it\n" \
4043 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004044 " if it exists. After it stops, don't restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004045 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004046 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004047 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004048 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004049
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004050#define svlogd_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004051 "[-ttv] [-r C] [-R CHARS] [-l MATCHLEN] [-b BUFLEN] DIR..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004052#define svlogd_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004053 "Continuously read log data from stdin, optionally\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004054 "filter log messages, and write the data to one or more automatically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004055 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004056
Eric Andersen7e9276b2001-02-22 01:15:47 +00004057#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004058 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004059#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004060 "Stop swapping on DEVICE\n" \
4061 "\nOptions:" \
4062 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004063
Eric Andersen7e9276b2001-02-22 01:15:47 +00004064#define swapon_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004065 "[-a]" IF_FEATURE_SWAPON_PRI(" [-p PRI]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004066#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004067 "Start swapping on DEVICE\n" \
4068 "\nOptions:" \
4069 "\n -a Start swapping on all swap devices" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004070 IF_FEATURE_SWAPON_PRI( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004071 "\n -p PRI Set swap device priority" \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004072 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004073
Rob Landley0f34a822005-10-27 22:55:50 +00004074#define switch_root_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004075 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004076#define switch_root_full_usage "\n\n" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004077 "Free initramfs and switch to another root fs:\n" \
4078 "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n" \
4079 "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004080 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004081 "\n -c DEV Reopen stdio to DEV after switch" \
Rob Landley0f34a822005-10-27 22:55:50 +00004082
Eric Andersen7e9276b2001-02-22 01:15:47 +00004083#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004084 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004085#define sync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004086 "Write all buffered blocks to disk"
4087
4088#define fsync_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004089 "[OPTIONS] FILE..."
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004090#define fsync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004091 "Write files' buffered blocks to disk\n" \
4092 "\nOptions:" \
4093 "\n -d Avoid syncing metadata"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004094
Eric Andersenb9050282003-12-24 06:02:11 +00004095#define sysctl_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004096 "[OPTIONS] [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004097#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004098 "Configure kernel parameters at runtime\n" \
4099 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004100 "\n -n Don't print key names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004101 "\n -e Don't warn about unknown keys" \
4102 "\n -w Change sysctl setting" \
4103 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
4104 "\n -a Display all values" \
4105 "\n -A Display all values in table form" \
4106
Eric Andersen5d38f5b2005-09-12 21:42:48 +00004107#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00004108 "sysctl [-n] [-e] variable...\n" \
4109 "sysctl [-n] [-e] -w variable=value...\n" \
4110 "sysctl [-n] [-e] -a\n" \
4111 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
4112 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00004113
Eric Andersen7e9276b2001-02-22 01:15:47 +00004114#define syslogd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004115 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004116#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004117 "System logging utility.\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004118 "This version of syslogd ignores /etc/syslog.conf\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004119 "\nOptions:" \
4120 "\n -n Run in foreground" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004121 "\n -O FILE Log to given file (default:/var/log/messages)" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004122 "\n -l N Set local log level" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004123 "\n -S Smaller logging output" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004124 IF_FEATURE_ROTATE_LOGFILE( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004125 "\n -s SIZE Max size (KB) before rotate (default:200KB, 0=off)" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004126 "\n -b N N rotated logs to keep (default:1, max=99, 0=purge)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004127 IF_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004128 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
4129 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004130 IF_FEATURE_SYSLOGD_DUP( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004131 "\n -D Drop duplicates") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004132 IF_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004133 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00004134 /* NB: -Csize shouldn't have space (because size is optional) */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004135/* "\n -m MIN Minutes between MARK lines (default:20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00004136
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004137#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004138 "$ syslogd -R masterlog:514\n" \
4139 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004140
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004141#define tac_trivial_usage \
4142 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004143#define tac_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004144 "Concatenate FILEs and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004145
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004146#define taskset_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004147 "[-p] [MASK] [PID | PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004148#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004149 "Set or get CPU affinity\n" \
4150 "\nOptions:" \
4151 "\n -p Operate on an existing PID" \
4152
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004153#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004154 "$ taskset 0x7 ./dgemm_test&\n" \
4155 "$ taskset -p 0x1 $!\n" \
4156 "pid 4790's current affinity mask: 7\n" \
4157 "pid 4790's new affinity mask: 1\n" \
4158 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4159 "pid 6671's current affinity mask: 1\n" \
4160 "pid 6671's new affinity mask: 1\n" \
4161 "$ taskset -p 1\n" \
4162 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004163
Eric Andersen7e9276b2001-02-22 01:15:47 +00004164#define tee_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004165 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004166#define tee_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004167 "Copy stdin to each FILE, and also to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004168 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004169 "\n -a Append to the given FILEs, don't overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004170 "\n -i Ignore interrupt signals (SIGINT)" \
4171
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004172#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004173 "$ echo \"Hello\" | tee /tmp/foo\n" \
4174 "$ cat /tmp/foo\n" \
4175 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004176
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004177#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004178#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004179 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004180#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004181 "Connect to telnet server\n" \
4182 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004183 "\n -a Automatic login with $USER variable" \
4184 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004185
Eric Andersen539ffc92004-02-22 12:25:47 +00004186#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004187#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004188 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004189#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004190 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004191#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004192
Eric Andersen08a72202002-09-30 20:52:10 +00004193#define telnetd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004194 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004195#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004196 "Handle incoming telnet connections" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004197 IF_NOT_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004198 "\nOptions:" \
4199 "\n -l LOGIN Exec LOGIN on connect" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004200 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004201 "\n -K Close connection as soon as login exits" \
4202 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004203 IF_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004204 "\n -p PORT Port to listen on" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004205 "\n -b ADDR[:PORT] Address to bind to" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004206 "\n -F Run in foreground" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004207 "\n -i Inetd mode" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004208 IF_FEATURE_TELNETD_INETD_WAIT( \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004209 "\n -w SEC Inetd 'wait' mode, linger time SEC" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004210 "\n -S Log to syslog (implied by -i or without -F and -w)" \
4211 ) \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004212 )
Eric Andersen08a72202002-09-30 20:52:10 +00004213
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004214/* "test --help" does not print help (POSIX compat), only "[ --help" does.
Denys Vlasenko662078f2010-01-14 13:27:34 +01004215 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION")
4216 * Unfortunately, it screws up generated BusyBox.html. TODO. */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004217#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004218 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004219#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004220 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4221 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004222#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004223 "$ test 1 -eq 2\n" \
4224 "$ echo $?\n" \
4225 "1\n" \
4226 "$ test 1 -eq 1\n" \
4227 "$ echo $?\n" \
4228 "0\n" \
4229 "$ [ -d /etc ]\n" \
4230 "$ echo $?\n" \
4231 "0\n" \
4232 "$ [ -d /junk ]\n" \
4233 "$ echo $?\n" \
4234 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004235
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004236#define tc_trivial_usage \
4237 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
4238#define tc_full_usage "\n\n" \
4239 "OBJECT: {qdisc|class|filter}\n" \
4240 "CMD: {add|del|change|replace|show}\n" \
4241 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004242 "qdisc [ handle QHANDLE ] [ root |"IF_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004243 /* "[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4244 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4245 " QDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004246 "qdisc show [ dev STRING ]"IF_FEATURE_TC_INGRESS(" [ingress]")"\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004247 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004248 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004249 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
4250 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
4251 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004252 " [ root | classid CLASSID ] [ handle FILTERID ]\n" \
4253 " [ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004254 "filter show [ dev STRING ] [ root | parent CLASSID ]"
4255
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004256#define tcpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004257 "[-hEv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004258/* with not-implemented options: */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004259/* "[-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 +00004260#define tcpsvd_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004261 "Create TCP socket, bind to IP:PORT and listen\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004262 "for incoming connection. Run PROG for each connection.\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004263 "\n IP IP to listen on. '0' = all" \
4264 "\n PORT Port to listen on" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004265 "\n PROG ARGS Program to run" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004266 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4267 "\n -u USER[:GRP] Change to user/group after bind" \
4268 "\n -c N Handle up to N connections simultaneously" \
4269 "\n -b N Allow a backlog of approximately N TCP SYNs" \
4270 "\n -C N[:MSG] Allow only up to N connections from the same IP" \
4271 "\n New connections from this IP address are closed" \
4272 "\n immediately. MSG is written to the peer before close" \
4273 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004274 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004275 "\n -v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004276
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004277#define udpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004278 "[-hEv] [-c N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004279#define udpsvd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004280 "Create UDP socket, bind to IP:PORT and wait\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004281 "for incoming packets. Run PROG for each packet,\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004282 "redirecting all further packets with same peer ip:port to it.\n" \
4283 "\n IP IP to listen on. '0' = all" \
4284 "\n PORT Port to listen on" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004285 "\n PROG ARGS Program to run" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004286 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4287 "\n -u USER[:GRP] Change to user/group after bind" \
4288 "\n -c N Handle up to N connections simultaneously" \
4289 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004290 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004291 "\n -v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004292
Mark Whitley450736c2001-03-02 19:08:50 +00004293#define tftp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004294 "[OPTIONS] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004295#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004296 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004297 "\nOptions:" \
4298 "\n -l FILE Local FILE" \
4299 "\n -r FILE Remote FILE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004300 IF_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004301 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004302 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004303 IF_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004304 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004305 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004306 IF_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004307 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004308 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004309
4310#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004311 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004312#define tftpd_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004313 "Transfer a file on tftp client's request\n" \
Denis Vlasenko91f8f822008-10-30 23:42:37 +00004314 "\n" \
4315 "tftpd should be used as an inetd service.\n" \
4316 "tftpd's line for inetd.conf:\n" \
4317 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
4318 "It also can be ran from udpsvd:\n" \
4319 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004320 "\nOptions:" \
4321 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004322 "\n -c Allow file creation via upload" \
4323 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004324
Eric Andersenc3657422001-11-30 07:54:32 +00004325#define time_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004326 "[OPTIONS] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004327#define time_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004328 "Run PROG, display resource usage when it exits\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004329 "\nOptions:" \
4330 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004331
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004332#define timeout_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004333 "[-t SECS] [-s SIG] PROG ARGS"
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004334#define timeout_full_usage "\n\n" \
4335 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
Denis Vlasenko42404082008-11-24 13:42:24 +00004336 "Defaults: SECS: 10, SIG: TERM." \
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004337
Eric Andersen420b2082002-09-17 22:14:58 +00004338#define top_trivial_usage \
Denys Vlasenko00528822009-09-11 23:26:42 +02004339 "[-b] [-nCOUNT] [-dSECONDS]" IF_FEATURE_TOPMEM(" [-m]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004340#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004341 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004342 "Read the status of all processes from /proc each SECONDS\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004343 "and display a screenful of them." \
4344//TODO: add options and keyboard commands
Eric Andersen420b2082002-09-17 22:14:58 +00004345
Eric Andersen7e9276b2001-02-22 01:15:47 +00004346#define touch_trivial_usage \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004347 "[-c] [-d DATE] FILE [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004348#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004349 "Update the last-modified date on the given FILE[s]\n" \
4350 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004351 "\n -c Don't create files" \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004352 "\n -d DT Date/time to use" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004353
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004354#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004355 "$ ls -l /tmp/foo\n" \
4356 "/bin/ls: /tmp/foo: No such file or directory\n" \
4357 "$ touch /tmp/foo\n" \
4358 "$ ls -l /tmp/foo\n" \
4359 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004360
4361#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004362 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004363#define tr_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004364 "Translate, squeeze, or delete characters from stdin, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004365 "\nOptions:" \
4366 "\n -c Take complement of STRING1" \
4367 "\n -d Delete input characters coded STRING1" \
4368 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4369
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004370#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004371 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4372 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004373
Eric Andersen5c58d282001-07-10 16:29:00 +00004374#define traceroute_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004375 "[-"IF_TRACEROUTE6("46")"FIldnrv] [-f 1ST_TTL] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
4376 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-g GATEWAY] [-i IFACE]\n" \
4377 " [-z PAUSE_MSEC] HOST [BYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004378#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004379 "Trace the route to HOST\n" \
4380 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004381 IF_TRACEROUTE6( \
4382 "\n -4, -6 Force IP or IPv6 name resolution" \
4383 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004384 "\n -F Set the don't fragment bit" \
4385 "\n -I Use ICMP ECHO instead of UDP datagrams" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004386 "\n -l Display the TTL value of the returned packet" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004387 "\n -d Set SO_DEBUG options to socket" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004388 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004389 "\n -r Bypass routing tables, send directly to HOST" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004390 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004391 "\n -m Max time-to-live (max number of hops)" \
4392 "\n -p Base UDP port number used in probes" \
4393 "\n (default 33434)" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004394 "\n -q Number of probes per TTL (default 3)" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004395 "\n -s IP address to use as the source address" \
4396 "\n -t Type-of-service in probe packets (default 0)" \
4397 "\n -w Time in seconds to wait for a response (default 3)" \
4398 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004399
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004400#define traceroute6_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004401 "[-dnrv] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
4402 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-i IFACE]\n" \
4403 " HOST [BYTES]"
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004404#define traceroute6_full_usage "\n\n" \
4405 "Trace the route to HOST\n" \
4406 "\nOptions:" \
4407 "\n -d Set SO_DEBUG options to socket" \
4408 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004409 "\n -r Bypass routing tables, send directly to HOST" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004410 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004411 "\n -m Max time-to-live (max number of hops)" \
4412 "\n -p Base UDP port number used in probes" \
4413 "\n (default is 33434)" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004414 "\n -q Number of probes per TTL (default 3)" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004415 "\n -s IP address to use as the source address" \
4416 "\n -t Type-of-service in probe packets (default 0)" \
4417 "\n -w Time in seconds to wait for a response (default 3)" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004418
Eric Andersen7e9276b2001-02-22 01:15:47 +00004419#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004420 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004421#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004422 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004423#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004424 "$ true\n" \
4425 "$ echo $?\n" \
4426 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004427
Eric Andersen7e9276b2001-02-22 01:15:47 +00004428#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004429 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004430#define tty_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004431 "Print file name of stdin's terminal" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004432 IF_INCLUDE_SUSv2( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004433 "\nOptions:" \
4434 "\n -s Print nothing, only return exit status" \
4435 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004436#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004437 "$ tty\n" \
4438 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004439
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004440#define ttysize_trivial_usage \
4441 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004442#define ttysize_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004443 "Print dimension(s) of stdin's terminal, on error return 80x25"
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004444
Denis Vlasenko39b68132009-01-23 02:07:14 +00004445#define tunctl_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004446 "[-f device] ([-t name] | -d name)" IF_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]")
Denis Vlasenko39b68132009-01-23 02:07:14 +00004447#define tunctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004448 "Create or delete tun interfaces\n" \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004449 "\nOptions:" \
4450 "\n -f name tun device (/dev/net/tun)" \
4451 "\n -t name Create iface 'name'" \
4452 "\n -d name Delete iface 'name'" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004453 IF_FEATURE_TUNCTL_UG( \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004454 "\n -u owner Set iface owner" \
4455 "\n -g group Set iface group" \
4456 "\n -b Brief output" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004457 )
Denis Vlasenko39b68132009-01-23 02:07:14 +00004458#define tunctl_example_usage \
4459 "# tunctl\n" \
4460 "# tunctl -d tun0\n"
4461
Denys Vlasenko0d98b442010-08-07 02:56:43 +02004462#if defined CONFIG_UDHCP_DEBUG && CONFIG_UDHCP_DEBUG >= 1
4463# define IF_UDHCP_VERBOSE(...) __VA_ARGS__
4464#else
4465# define IF_UDHCP_VERBOSE(...)
4466#endif
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004467#define udhcpc_trivial_usage \
Denys Vlasenko0d98b442010-08-07 02:56:43 +02004468 "[-fbnq"IF_UDHCP_VERBOSE("v")"oCR] [-i IFACE] [-r IP] [-s PROG] [-p PIDFILE]\n" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004469 " [-H HOSTNAME] [-c CID] [-V VENDOR] [-O DHCP_OPT]..." IF_FEATURE_UDHCP_PORT(" [-P N]")
4470#define udhcpc_full_usage "\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004471 IF_LONG_OPTS( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004472 "\n -i,--interface IFACE Interface to use (default eth0)" \
4473 "\n -p,--pidfile FILE Create pidfile" \
4474 "\n -r,--request IP IP address to request" \
4475 "\n -s,--script PROG Run PROG at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
4476 "\n -t,--retries N Send up to N discover packets" \
4477 "\n -T,--timeout N Pause between packets (default 3 seconds)" \
Denys Vlasenkoe6080a42010-04-14 14:04:26 -07004478 "\n -A,--tryagain N Wait N seconds after failure (default 20)" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004479 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004480 USE_FOR_MMU( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004481 "\n -b,--background Background if lease is not obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004482 ) \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004483 "\n -S,--syslog Log to syslog too" \
4484 "\n -n,--now Exit if lease is not obtained" \
4485 "\n -q,--quit Exit after obtaining lease" \
4486 "\n -R,--release Release IP on exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004487 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004488 "\n -P,--client-port N Use port N (default 68)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004489 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004490 IF_FEATURE_UDHCPC_ARPING( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004491 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004492 ) \
Denys Vlasenkoe6080a42010-04-14 14:04:26 -07004493 "\n -O,--request-option OPT Request DHCP option OPT (cumulative)" \
4494 "\n -o,--no-default-options Don't request any options (unless -O is given)" \
4495 "\n -x OPT:VAL Include option OPT in sent packets (cumulative)" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004496 "\n -F,--fqdn NAME Ask server to update DNS mapping for NAME" \
4497 "\n -H,-h,--hostname NAME Send NAME as client hostname (default none)" \
4498 "\n -V,--vendorclass VENDOR Vendor identifier (default 'udhcp VERSION')" \
4499 "\n -c,--clientid CLIENTID Client identifier (default own MAC)" \
4500 "\n -C,--clientid-none Don't send client identifier" \
Denys Vlasenko0d98b442010-08-07 02:56:43 +02004501 IF_UDHCP_VERBOSE( \
4502 "\n -v Verbose" \
4503 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004504 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004505 IF_NOT_LONG_OPTS( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004506 "\n -i IFACE Interface to use (default eth0)" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +01004507 "\n -p FILE Create pidfile" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004508 "\n -r IP IP address to request" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004509 "\n -s PROG Run PROG at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
4510 "\n -t N Send up to N discover packets" \
4511 "\n -T N Pause between packets (default 3 seconds)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004512 "\n -A N Wait N seconds (default 20) after failure" \
Denys Vlasenko7e6add12010-03-25 20:32:38 +01004513 "\n -x OPT:VAL Include option OPT in sent packets" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004514 "\n -O OPT Request DHCP option OPT (cumulative)" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004515 "\n -o Don't request any options (unless -O is given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004516 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004517 USE_FOR_MMU( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004518 "\n -b Background if lease is not obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004519 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004520 "\n -S Log to syslog too" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004521 "\n -n Exit if lease is not obtained" \
4522 "\n -q Exit after obtaining lease" \
4523 "\n -R Release IP on exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004524 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004525 "\n -P N Use port N (default 68)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004526 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004527 IF_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004528 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004529 ) \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004530 "\n -F NAME Ask server to update DNS mapping for NAME" \
4531 "\n -H,-h NAME Send NAME as client hostname (default none)" \
4532 "\n -V VENDOR Vendor identifier (default 'udhcp VERSION')" \
4533 "\n -c CLIENTID Client identifier (default own MAC)" \
4534 "\n -C Don't send client identifier" \
Denys Vlasenko0d98b442010-08-07 02:56:43 +02004535 IF_UDHCP_VERBOSE( \
4536 "\n -v Verbose" \
4537 ) \
4538 ) \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004539
Russ Dill61fb4892002-10-14 21:41:28 +00004540#define udhcpd_trivial_usage \
Denys Vlasenkob1560002010-09-06 13:39:59 +02004541 "[-fS]" IF_FEATURE_UDHCP_PORT(" [-P N]") " [CONFFILE]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004542
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004543#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004544 "DHCP server\n" \
4545 "\n -f Run in foreground" \
4546 "\n -S Log to syslog too" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004547 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004548 "\n -P N Use port N (default 67)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004549 )
Russ Dill61fb4892002-10-14 21:41:28 +00004550
Eric Andersen7e9276b2001-02-22 01:15:47 +00004551#define umount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004552 "[OPTIONS] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004553#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004554 "Unmount file systems\n" \
4555 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004556 IF_FEATURE_UMOUNT_ALL( \
4557 "\n -a Unmount all file systems" IF_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004558 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004559 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004560 "\n -n Don't erase /etc/mtab entries" \
4561 ) \
4562 "\n -r Try to remount devices as read-only if mount is busy" \
4563 "\n -l Lazy umount (detach filesystem)" \
4564 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004565 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004566 "\n -d Free loop device if it has been used" \
4567 )
4568
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004569#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004570 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004571
4572#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004573 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004574#define uname_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004575 "Print system information\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004576 "\nOptions:" \
4577 "\n -a Print all" \
4578 "\n -m The machine (hardware) type" \
4579 "\n -n Hostname" \
4580 "\n -r OS release" \
4581 "\n -s OS name (default)" \
4582 "\n -p Processor type" \
4583 "\n -v OS version" \
4584
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004585#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004586 "$ uname -a\n" \
4587 "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 +00004588
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004589#define uncompress_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004590 "[-cf] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004591#define uncompress_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02004592 "Decompress .Z file[s]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004593 "\nOptions:" \
Denys Vlasenkoa3581402010-05-27 02:30:04 +02004594 "\n -c Write to stdout" \
4595 "\n -f Overwrite" \
Tim Riker7b253f82003-12-28 05:02:40 +00004596
Denis Vlasenko3952f202007-08-13 14:10:24 +00004597#define unexpand_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004598 "[-fa][-t N] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004599#define unexpand_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004600 "Convert spaces to tabs, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004601 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004602 IF_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004603 "\n -a,--all Convert all blanks" \
4604 "\n -f,--first-only Convert only leading blanks" \
4605 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004606 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004607 IF_NOT_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004608 "\n -a Convert all blanks" \
4609 "\n -f Convert only leading blanks" \
4610 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004611 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004612
Eric Andersen7e9276b2001-02-22 01:15:47 +00004613#define uniq_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004614 "[-cdu][-f,s,w N] [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004615#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004616 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004617 "\nOptions:" \
4618 "\n -c Prefix lines by the number of occurrences" \
4619 "\n -d Only print duplicate lines" \
4620 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004621 "\n -f N Skip first N fields" \
4622 "\n -s N Skip first N chars (after any skipped fields)" \
4623 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004624
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004625#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004626 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4627 "a\n" \
4628 "b\n" \
4629 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004630
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004631#define unzip_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004632 "[-opts[modifiers]] FILE[.zip] [LIST] [-x XLIST] [-d DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004633#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004634 "Extract files from ZIP archives\n" \
4635 "\nOptions:" \
4636 "\n -l List archive contents (with -q for short form)" \
Denys Vlasenkoa3581402010-05-27 02:30:04 +02004637 "\n -n Never overwrite files (default)" \
4638 "\n -o Overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004639 "\n -p Send output to stdout" \
4640 "\n -q Quiet" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004641 "\n -x XLST Exclude these files" \
4642 "\n -d DIR Extract files into DIR" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004643
Eric Andersen7e9276b2001-02-22 01:15:47 +00004644#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004645 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004646#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004647 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004648
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004649#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004650 "$ uptime\n" \
4651 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004652
4653#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004654 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004655#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004656 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004657
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004658#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004659 "$ usleep 1000000\n" \
4660 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004661
4662#define uudecode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004663 "[-o OUTFILE] [INFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004664#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004665 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004666 "Finds outfile name in uuencoded source unless -o is given"
4667
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004668#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004669 "$ uudecode -o busybox busybox.uu\n" \
4670 "$ ls -l busybox\n" \
4671 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004672
4673#define uuencode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004674 "[-m] [INFILE] STORED_FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004675#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004676 "Uuencode a file to stdout\n" \
4677 "\nOptions:" \
4678 "\n -m Use base64 encoding per RFC1521" \
4679
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004680#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004681 "$ uuencode busybox busybox\n" \
4682 "begin 755 busybox\n" \
4683 "<encoded file snipped>\n" \
4684 "$ uudecode busybox busybox > busybox.uu\n" \
4685 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004686
Eric Andersen853c4942003-01-23 05:59:32 +00004687#define vconfig_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004688 "COMMAND [OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004689#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004690 "Create and remove virtual ethernet devices\n" \
4691 "\nOptions:" \
4692 "\n add [interface-name] [vlan_id]" \
4693 "\n rem [vlan-name]" \
4694 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4695 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4696 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4697 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004698
Eric Andersen3f980402001-04-04 17:31:15 +00004699#define vi_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004700 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004701#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004702 "Edit FILE\n" \
4703 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004704 IF_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004705 "\n -c Initial command to run ($EXINIT also available)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004706 IF_FEATURE_VI_READONLY( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004707 "\n -R Read-only") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004708 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00004709
Eric Andersen27f64e12002-06-23 04:24:25 +00004710#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004711 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004712#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004713 "Lock a virtual terminal. A password is required to unlock.\n" \
4714 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00004715 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004716
Matthew Stoltenberg4803db52009-08-13 00:59:32 +02004717#define volname_trivial_usage \
4718 "[DEVICE]"
4719#define volname_full_usage "\n\n" \
4720 "Show CD volume name of the DEVICE (default /dev/cdrom)"
4721
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01004722#define wall_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004723 "[FILE]"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01004724#define wall_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004725 "Write content of FILE or stdin to all logged-in users"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01004726#define wall_sample_usage \
4727 "echo foo | wall\n" \
4728 "wall ./mymessage"
4729
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004730#define watch_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004731 "[-n SEC] [-t] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004732#define watch_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004733 "Run PROG periodically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004734 "\nOptions:" \
4735 "\n -n Loop period in seconds (default 2)" \
4736 "\n -t Don't print header" \
4737
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004738#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004739 "$ watch date\n" \
4740 "Mon Dec 17 10:31:40 GMT 2000\n" \
4741 "Mon Dec 17 10:31:42 GMT 2000\n" \
4742 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004743
Eric Andersen7e9276b2001-02-22 01:15:47 +00004744#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004745 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004746#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004747 "Periodically write to watchdog device DEV\n" \
4748 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004749 "\n -T N Reboot after N seconds if not reset (default 60)" \
4750 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004751 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004752 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004753 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004754
Eric Andersen7e9276b2001-02-22 01:15:47 +00004755#define wget_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004756 IF_FEATURE_WGET_LONG_OPTIONS( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004757 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document FILE]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004758 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
Bradley M. Kuhnc97131c2010-08-08 02:51:20 +02004759 " [--no-check-certificate] [-U|--user-agent AGENT]" \
4760 IF_FEATURE_WGET_TIMEOUT("[-T SEC] ") " URL" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004761 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004762 IF_NOT_FEATURE_WGET_LONG_OPTIONS( \
Bradley M. Kuhnc97131c2010-08-08 02:51:20 +02004763 "[-csq] [-O FILE] [-Y on/off] [-P DIR] [-U AGENT]" \
4764 IF_FEATURE_WGET_TIMEOUT("[-T SEC] ") " URL" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004765 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004766#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004767 "Retrieve files via HTTP or FTP\n" \
4768 "\nOptions:" \
4769 "\n -s Spider mode - only check file existence" \
4770 "\n -c Continue retrieval of aborted transfer" \
4771 "\n -q Quiet" \
Bradley M. Kuhnc97131c2010-08-08 02:51:20 +02004772 "\n -P DIR Save to DIR (default .)" \
4773 IF_FEATURE_WGET_TIMEOUT( \
4774 "\n -T SEC Network read timeout is SEC seconds" \
4775 ) \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004776 "\n -O FILE Save to FILE ('-' for stdout)" \
4777 "\n -U STR Use STR for User-Agent header" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004778 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004779
4780#define which_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004781 "[COMMAND]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004782#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004783 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004784#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004785 "$ which login\n" \
4786 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004787
Eric Andersen00a6a752002-04-26 23:53:10 +00004788#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004789 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004790#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004791 "Show who is logged on\n" \
4792 "\nOptions:" \
Denys Vlasenko838e0db2010-06-07 03:04:46 +02004793 "\n -a Show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004794
4795#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004796 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004797#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004798 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004799
Eric Andersen7e9276b2001-02-22 01:15:47 +00004800#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004801 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004802#define zcat_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02004803 "Decompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004804
Rob Landleyad8071f2005-04-30 03:49:37 +00004805#define zcip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004806 "[OPTIONS] IFACE SCRIPT"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004807#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004808 "Manage a ZeroConf IPv4 link-local address\n" \
4809 "\nOptions:" \
4810 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004811 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004812 "\n -r 169.254.x.x Request this address first" \
4813 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004814 "\n" \
4815 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
4816 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00004817
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00004818
4819#endif