blob: 29f7b2110b71bcc14eb2cc7e61c3cbfeb49e6909 [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" \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +0200104 "\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 Vlasenko6b0ac842010-10-07 13:25:09 +0200223 "[-cf] [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 \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +0200231 "-d [-cf] [FILE]..."
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200232#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 \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +0200245 "[-cf] [FILE]..."
Denys Vlasenko602ce692010-05-30 03:35:18 +0200246#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 \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +0200253 "-d [-cf] [FILE]..."
Denys Vlasenko602ce692010-05-30 03:35:18 +0200254#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 Vlasenko6b0ac842010-10-07 13:25:09 +0200537 "[-prfom] [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
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000595#define crond_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000596 "-fbS -l N " IF_FEATURE_CROND_D("-d N ") "-L LOGFILE -c DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000597#define crond_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000598 " -f Foreground" \
599 "\n -b Background (default)" \
600 "\n -S Log to syslog (default)" \
601 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000602 IF_FEATURE_CROND_D( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000603 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000604 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000605 "\n -L Log to file" \
606 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000607
608#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000609 "[-c DIR] [-u USER] [-ler]|[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000610#define crontab_full_usage "\n\n" \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000611 " -c Crontab directory" \
612 "\n -u User" \
613 "\n -l List crontab" \
614 "\n -e Edit crontab" \
615 "\n -r Delete crontab" \
616 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000617
Denis Vlasenko2211d522008-11-10 18:52:35 +0000618#define cryptpw_trivial_usage \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000619 "[OPTIONS] [PASSWORD] [SALT]"
620/* We do support -s, we just don't mention it */
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000621#define cryptpw_full_usage "\n\n" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000622 "Crypt the PASSWORD using crypt(3)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000623 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200624 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100625 "\n -P,--password-fd=N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000626/* "\n -s,--stdin Use stdin; like -P0" */ \
627 "\n -m,--method=TYPE Encryption method TYPE" \
628 "\n -S,--salt=SALT" \
629 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200630 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100631 "\n -P N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000632/* "\n -s Use stdin; like -P0" */ \
633 "\n -m TYPE Encryption method TYPE" \
634 "\n -S SALT" \
635 ) \
636
637/* mkpasswd is an alias to cryptpw */
638
639#define mkpasswd_trivial_usage \
640 "[OPTIONS] [PASSWORD] [SALT]"
641/* We do support -s, we just don't mention it */
642#define mkpasswd_full_usage "\n\n" \
643 "Crypt the PASSWORD using crypt(3)\n" \
644 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200645 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100646 "\n -P,--password-fd=N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000647/* "\n -s,--stdin Use stdin; like -P0" */ \
648 "\n -m,--method=TYPE Encryption method TYPE" \
649 "\n -S,--salt=SALT" \
650 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200651 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100652 "\n -P N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000653/* "\n -s Use stdin; like -P0" */ \
654 "\n -m TYPE Encryption method TYPE" \
655 "\n -S SALT" \
656 ) \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000657
Eric Andersen7e9276b2001-02-22 01:15:47 +0000658#define cut_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200659 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000660#define cut_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100661 "Print selected fields from each input FILE to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000662 "\nOptions:" \
663 "\n -b LIST Output only bytes from LIST" \
664 "\n -c LIST Output only characters from LIST" \
665 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
666 "\n -s Output only the lines containing delimiter" \
667 "\n -f N Print only these fields" \
668 "\n -n Ignored" \
669
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000670#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000671 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
672 "Hello\n" \
673 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
674 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000675
Eric Andersen7e9276b2001-02-22 01:15:47 +0000676#define dd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000677 "[if=FILE] [of=FILE] " IF_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
678 " [seek=N]" IF_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000679#define dd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000680 "Copy a file with converting and formatting\n" \
681 "\nOptions:" \
682 "\n if=FILE Read from FILE instead of stdin" \
683 "\n of=FILE Write to FILE instead of stdout" \
684 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000685 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000686 "\n ibs=N Read N bytes at a time" \
687 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000688 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000689 "\n obs=N Write N bytes at a time" \
690 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000691 "\n count=N Copy only N input blocks" \
692 "\n skip=N Skip N input blocks" \
693 "\n seek=N Skip N output blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000694 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000695 "\n conv=notrunc Don't truncate output file" \
696 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000697 "\n conv=sync Pad blocks with zeros" \
698 "\n conv=fsync Physically write data out before finishing" \
699 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000700 "\n" \
701 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
702 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
703
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000704#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000705 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
706 "4+0 records in\n" \
707 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000708
Eric Andersen7e9276b2001-02-22 01:15:47 +0000709#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000710 "[N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000711#define deallocvt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000712 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000713
Eric Andersenf349e972001-08-21 16:18:59 +0000714#define delgroup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000715 IF_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000716#define delgroup_full_usage "\n\n" \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000717 "Delete group GROUP from the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000718 IF_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000719
720#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000721 "USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000722#define deluser_full_usage "\n\n" \
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000723 "Delete USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000724
Denis Vlasenkoc94fa562008-10-26 11:08:14 +0000725#define devmem_trivial_usage \
726 "ADDRESS [WIDTH [VALUE]]"
727
728#define devmem_full_usage "\n\n" \
729 "Read/write from physical address\n" \
730 "\n ADDRESS Address to act upon" \
731 "\n WIDTH Width (8/16/...)" \
732 "\n VALUE Data to be written" \
733
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000734#define devfsd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000735 "mntpnt [-v]" IF_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000736#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000737 "Manage devfs permissions and old device name symlinks\n" \
738 "\nOptions:" \
739 "\n mntpnt The mount point where devfs is mounted" \
740 "\n -v Print the protocol version numbers for devfsd" \
741 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000742 IF_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000743 "\n -fg Run in foreground" \
744 "\n -np Exit after parsing the configuration file" \
745 "\n and processing synthetic REGISTER events," \
Denys Vlasenko07697852009-10-06 21:11:37 +0200746 "\n don't poll for events" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000747 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000748
Eric Andersen7e9276b2001-02-22 01:15:47 +0000749#define df_trivial_usage \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000750 "[-Pk" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000751 IF_FEATURE_HUMAN_READABLE("mh") \
752 IF_FEATURE_DF_FANCY("ai] [-B SIZE") \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100753 "] [FILESYSTEM]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000754#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000755 "Print filesystem usage statistics\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000756 "\nOptions:" \
757 "\n -P POSIX output format" \
758 "\n -k 1024-byte blocks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000759 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000760 "\n -m 1M-byte blocks" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000761 "\n -h Human readable (e.g. 1K 243M 2G)" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000762 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000763 IF_FEATURE_DF_FANCY( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000764 "\n -a Show all filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000765 "\n -i Inodes" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000766 "\n -B SIZE Blocksize" \
767 ) \
768
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000769#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000770 "$ df\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000771 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000772 "/dev/sda3 8690864 8553540 137324 98% /\n" \
773 "/dev/sda1 64216 36364 27852 57% /boot\n" \
774 "$ df /dev/sda3\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000775 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
776 "/dev/sda3 8690864 8553540 137324 98% /\n" \
777 "$ POSIXLY_CORRECT=sure df /dev/sda3\n" \
778 "Filesystem 512B-blocks Used Available Use% Mounted on\n" \
779 "/dev/sda3 17381728 17107080 274648 98% /\n" \
780 "$ POSIXLY_CORRECT=yep df -P /dev/sda3\n" \
781 "Filesystem 512-blocks Used Available Capacity Mounted on\n" \
782 "/dev/sda3 17381728 17107080 274648 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000783
Denis Vlasenko736230e2006-11-20 19:40:36 +0000784#define dhcprelay_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100785 "CLIENT_IFACE[,CLIENT_IFACE2]... SERVER_IFACE [SERVER_IP]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000786#define dhcprelay_full_usage "\n\n" \
Denis Vlasenkoe8a79682009-04-13 03:33:46 +0000787 "Relay DHCP requests between clients and server" \
Denis Vlasenko736230e2006-11-20 19:40:36 +0000788
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000789#define diff_trivial_usage \
Matheus Izvekovfe1ce2e2010-01-18 16:07:07 -0200790 "[-abBdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000791#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000792 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000793 "This implementation supports unified diffs only.\n" \
794 "\nOptions:" \
795 "\n -a Treat all files as text" \
796 "\n -b Ignore changes in the amount of whitespace" \
Matheus Izvekovfe1ce2e2010-01-18 16:07:07 -0200797 "\n -B Ignore changes whose lines are all blank" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000798 "\n -d Try hard to find a smaller set of changes" \
799 "\n -i Ignore case differences" \
800 "\n -L Use LABEL instead of the filename in the unified header" \
801 "\n -N Treat absent files as empty" \
802 "\n -q Output only whether files differ" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100803 "\n -r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000804 "\n -S Start with FILE when comparing directories" \
805 "\n -T Make tabs line up by prefixing a tab when necessary" \
806 "\n -s Report when two files are the same" \
807 "\n -t Expand tabs to spaces in output" \
808 "\n -U Output LINES lines of context" \
809 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000810
Eric Andersen7e9276b2001-02-22 01:15:47 +0000811#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000812 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000813#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000814 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000815#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000816 "$ dirname /tmp/foo\n" \
817 "/tmp\n" \
818 "$ dirname /tmp/foo/\n" \
819 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000820
Eric Andersen7e9276b2001-02-22 01:15:47 +0000821#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000822 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000823#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000824 "Print or control the kernel ring buffer\n" \
825 "\nOptions:" \
826 "\n -c Clear ring buffer after printing" \
827 "\n -n LEVEL Set console logging level" \
828 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000829
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000830#define dnsd_trivial_usage \
Denys Vlasenko343dfd72010-02-07 02:45:03 +0100831 "[-dvs] [-c CONFFILE] [-t TTL_SEC] [-p PORT] [-i ADDR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000832#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000833 "Small static DNS server daemon\n" \
834 "\nOptions:" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +0100835 "\n -c FILE Config file" \
836 "\n -t SEC TTL" \
837 "\n -p PORT Listen on PORT" \
838 "\n -i ADDR Listen on ADDR" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000839 "\n -d Daemonize" \
Denys Vlasenko343dfd72010-02-07 02:45:03 +0100840 "\n -v Verbose" \
841 "\n -s Send successful replies only. Use this if you want" \
842 "\n to use /etc/resolv.conf with two nameserver lines:" \
843 "\n nameserver DNSD_SERVER" \
844 "\n nameserver NORNAL_DNS_SERVER" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000845
Eric Andersen7e9276b2001-02-22 01:15:47 +0000846#define dos2unix_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +0200847 "[-ud] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000848#define dos2unix_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200849 "Convert FILE in-place from DOS to Unix format.\n" \
850 "When no file is given, use stdin/stdout.\n" \
851 "\nOptions:" \
852 "\n -u dos2unix" \
853 "\n -d unix2dos" \
854
855#define unix2dos_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +0200856 "[-ud] [FILE]"
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200857#define unix2dos_full_usage "\n\n" \
858 "Convert FILE in-place from Unix to DOS format.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000859 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000860 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000861 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000862 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000863
Eric Andersen7e9276b2001-02-22 01:15:47 +0000864#define dpkg_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100865 "[-ilCPru] [-F OPT] PACKAGE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000866#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000867 "Install, remove and manage Debian packages\n" \
868 "\nOptions:" \
Kim B. Heino3d43aed2010-03-29 14:18:27 +0200869 IF_LONG_OPTS( \
870 "\n -i,--install Install the package" \
871 "\n -l,--list List of installed packages" \
872 "\n --configure Configure an unpackaged package" \
873 "\n -P,--purge Purge all files of a package" \
874 "\n -r,--remove Remove all but the configuration files for a package" \
875 "\n --unpack Unpack a package, but don't configure it" \
876 "\n --force-depends Ignore dependency problems" \
877 "\n --force-confnew Overwrite existing config files when installing" \
878 "\n --force-confold Keep old config files when installing" \
879 ) \
880 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000881 "\n -i Install the package" \
882 "\n -l List of installed packages" \
883 "\n -C Configure an unpackaged package" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000884 "\n -P Purge all files of a package" \
885 "\n -r Remove all but the configuration files for a package" \
886 "\n -u Unpack a package, but don't configure it" \
Kim B. Heino3d43aed2010-03-29 14:18:27 +0200887 "\n -F depends Ignore dependency problems" \
888 "\n -F confnew Overwrite existing config files when installing" \
889 "\n -F confold Keep old config files when installing" \
890 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000891
Eric Andersen7e9276b2001-02-22 01:15:47 +0000892#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000893 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000894#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000895 "Perform actions on Debian packages (.debs)\n" \
896 "\nOptions:" \
897 "\n -c List contents of filesystem tree" \
898 "\n -e Extract control files to [argument] directory" \
899 "\n -f Display control field name starting with [argument]" \
900 "\n -x Extract packages filesystem tree to directory" \
901 "\n -X Verbose extract" \
902
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000903#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000904 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000905
Eric Andersen7e9276b2001-02-22 01:15:47 +0000906#define du_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000907 "[-aHLdclsx" IF_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000908#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000909 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000910 "Disk space is printed in units of " \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000911 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
912 IF_NOT_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000913 " bytes.\n" \
914 "\nOptions:" \
915 "\n -a Show file sizes too" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000916 "\n -L Follow all symlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100917 "\n -H Follow symlinks on command line" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000918 "\n -d N Limit output to directories (and files with -a) of depth < N" \
919 "\n -c Show grand total" \
920 "\n -l Count sizes many times if hard linked" \
921 "\n -s Display only a total for each argument" \
922 "\n -x Skip directories on different filesystems" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000923 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000924 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
925 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000926 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000927 "\n -k Sizes in kilobytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000928 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000929
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000930#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000931 "$ du\n" \
932 "16 ./CVS\n" \
933 "12 ./kernel-patches/CVS\n" \
934 "80 ./kernel-patches\n" \
935 "12 ./tests/CVS\n" \
936 "36 ./tests\n" \
937 "12 ./scripts/CVS\n" \
938 "16 ./scripts\n" \
939 "12 ./docs/CVS\n" \
940 "104 ./docs\n" \
941 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000942
Eric Andersen7e9276b2001-02-22 01:15:47 +0000943#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000944 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000945#define dumpkmap_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100946 "Print a binary keyboard translation table to stdout"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000947#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000948 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000949
Russ Dill61fb4892002-10-14 21:41:28 +0000950#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000951 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000952#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000953 "Display DHCP leases granted by udhcpd\n" \
954 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200955 IF_LONG_OPTS( \
Denys Vlasenkoc8a2ab12010-03-28 00:02:20 +0100956 "\n -f,--file=FILE Lease file" \
957 "\n -r,--remaining Show remaining time" \
958 "\n -a,--absolute Show expiration time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000959 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200960 IF_NOT_LONG_OPTS( \
Denys Vlasenkoc8a2ab12010-03-28 00:02:20 +0100961 "\n -f FILE Lease file" \
962 "\n -r Show remaining time" \
963 "\n -a Show expiration time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000964 )
Russ Dill61fb4892002-10-14 21:41:28 +0000965
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100966/*
Mike Frysinger51a43b42005-09-24 07:11:16 +0000967#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000968 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
969 "[-I inode_buffer_blocks] [-P process_inode_size] " \
970 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
971 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000972#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000973 "Check ext2/ext3 file system\n" \
974 "\nOptions:" \
975 "\n -p Automatic repair (no questions)" \
976 "\n -n Make no changes to the filesystem" \
977 "\n -y Assume 'yes' to all questions" \
978 "\n -c Check for bad blocks and add them to the badblock list" \
979 "\n -f Force checking even if filesystem is marked clean" \
980 "\n -v Verbose" \
981 "\n -b superblock Use alternative superblock" \
982 "\n -B blocksize Force blocksize when looking for superblock" \
983 "\n -j journal Set location of the external journal" \
984 "\n -l file Add to badblocks list" \
985 "\n -L file Set badblocks list" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100986*/
Mike Frysinger51a43b42005-09-24 07:11:16 +0000987
Eric Andersen7e9276b2001-02-22 01:15:47 +0000988#define echo_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100989 IF_FEATURE_FANCY_ECHO("[-neE] ") "[ARG]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000990#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000991 "Print the specified ARGs to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000992 IF_FEATURE_FANCY_ECHO( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000993 "\nOptions:" \
994 "\n -n Suppress trailing newline" \
Denys Vlasenkoc8a2ab12010-03-28 00:02:20 +0100995 "\n -e Interpret backslash escapes (i.e., \\t=tab)" \
996 "\n -E Don't interpret backslash escapes (default)" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000997 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000998#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000999 "$ echo \"Erik is cool\"\n" \
1000 "Erik is cool\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001001 IF_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001002 "Erik\n" \
1003 "is\n" \
1004 "cool\n" \
1005 "$ echo \"Erik\\nis\\ncool\"\n" \
1006 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001007
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001008#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001009 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001010#define eject_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001011 "Eject DEVICE or default /dev/cdrom\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001012 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001013 IF_FEATURE_EJECT_SCSI( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001014 "\n -s SCSI device" \
1015 ) \
1016 "\n -t Close tray" \
1017 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001018
Rob Landley3b890392006-05-04 20:56:43 +00001019#define ed_trivial_usage ""
1020#define ed_full_usage ""
1021
Eric Andersen84e229c2001-03-29 22:48:33 +00001022#define env_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001023 "[-iu] [-] [name=value]... [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001024#define env_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001025 "Print the current environment or run PROG after setting up\n" \
1026 "the specified environment\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001027 "\nOptions:" \
1028 "\n -, -i Start with an empty environment" \
1029 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +00001030
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001031#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001032 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001033#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001034 "Send a magic packet to wake up sleeping machines.\n" \
1035 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001036 "a hostname with a known 'ethers' entry.\n" \
1037 "\nOptions:" \
1038 "\n -b Send wake-up packet to the broadcast address" \
1039 "\n -i iface Interface to use (default eth0)" \
1040 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001041
Denis Vlasenko3952f202007-08-13 14:10:24 +00001042#define expand_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01001043 "[-i] [-t N] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001044#define expand_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001045 "Convert tabs to spaces, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001046 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001047 IF_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001048 "\n -i,--initial Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001049 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001050 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001051 IF_NOT_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001052 "\n -i Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001053 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001054 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00001055
Eric Andersen7e9276b2001-02-22 01:15:47 +00001056#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001057 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001058#define expr_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001059 "Print the value of EXPRESSION to stdout\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001060 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001061 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001062 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
1063 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1064 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1065 " ARG1 <= ARG2\n" \
1066 " ARG1 = ARG2\n" \
1067 " ARG1 != ARG2\n" \
1068 " ARG1 >= ARG2\n" \
1069 " ARG1 > ARG2\n" \
1070 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1071 " ARG1 - ARG2\n" \
1072 " ARG1 * ARG2\n" \
1073 " ARG1 / ARG2\n" \
1074 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001075 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1076 " match STRING REGEXP Same as STRING : REGEXP\n" \
1077 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1078 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1079 " length STRING Length of STRING\n" \
1080 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001081 " it is a keyword like 'match' or an\n" \
1082 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001083 " (EXPRESSION) Value of EXPRESSION\n" \
1084 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001085 "Beware that many operators need to be escaped or quoted for shells.\n" \
1086 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001087 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001088 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1089 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001090
Mike Frysingerfa69f112005-04-17 07:24:19 +00001091#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001092 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001093#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001094 "Provide fake ident (auth) service\n" \
1095 "\nOptions:" \
1096 "\n -f Run in foreground" \
1097 "\n -i Inetd mode" \
1098 "\n -w Inetd 'wait' mode" \
1099 "\n -b ADDR Bind to specified address" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001100 "\n STRING Ident answer string (default: nobody)" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001101
Eric Andersen7e9276b2001-02-22 01:15:47 +00001102#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001103 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001104#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001105 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001106
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001107#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001108 "$ false\n" \
1109 "$ echo $?\n" \
1110 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001111
Denys Vlasenkoff027d62010-05-04 15:45:25 +02001112#define fbsplash_trivial_usage \
1113 "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
1114#define fbsplash_full_usage "\n\n" \
1115 "Options:" \
1116 "\n -s Image" \
1117 "\n -c Hide cursor" \
1118 "\n -d Framebuffer device (default /dev/fb0)" \
1119 "\n -i Config file (var=value):" \
1120 "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT" \
1121 "\n BAR_R,BAR_G,BAR_B" \
1122 "\n -f Control pipe (else exit after drawing image)" \
1123 "\n commands: 'NN' (% for progress bar) or 'exit'" \
1124
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001125#define fbset_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001126 "[OPTIONS] [MODE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001127#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001128 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001129
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001130#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001131 "$ fbset\n" \
1132 "mode \"1024x768-76\"\n" \
1133 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1134 " geometry 1024 768 1024 768 16\n" \
1135 " timings 12714 128 32 16 4 128 4\n" \
1136 " accel false\n" \
1137 " rgba 5/11,6/5,5/0,0/0\n" \
1138 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001139
Eric Andersen7e9276b2001-02-22 01:15:47 +00001140#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001141 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001142#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001143 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001144
Eric Andersen01c3d402003-07-05 07:51:31 +00001145#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001146 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001147#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001148 "Format floppy disk\n" \
1149 "\nOptions:" \
1150 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001151
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001152/* Looks like someone forgot to add this to config system */
1153#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1154# define ENABLE_FEATURE_FDISK_BLKSIZE 0
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001155# define IF_FEATURE_FDISK_BLKSIZE(a)
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001156#endif
1157
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001158#define fdisk_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001159 "[-ul" IF_FEATURE_FDISK_BLKSIZE("s") "] " \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001160 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001161#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001162 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001163 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001164 "\n -u Start and End are in sectors (instead of cylinders)" \
1165 "\n -l Show partition table for each DISK, then exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001166 IF_FEATURE_FDISK_BLKSIZE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001167 "\n -s Show partition sizes in kb for each DISK, then exit" \
1168 ) \
1169 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1170 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
Denys Vlasenko37bc1eb2010-04-06 00:04:08 +02001171 "\n -H HEADS" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001172 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001173
Grigory Batalovad7a5d42010-05-23 23:22:10 +02001174#define fgconsole_trivial_usage \
1175 ""
1176#define fgconsole_full_usage "\n\n" \
1177 "Get active console"
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001178
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001179#define findfs_trivial_usage \
1180 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001181#define findfs_full_usage "\n\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02001182 "Find a filesystem device based on a label or UUID"
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001183#define findfs_example_usage \
1184 "$ findfs LABEL=MyDevice"
1185
Denys Vlasenkobf2af9a2009-05-25 04:15:37 +02001186#define flash_lock_trivial_usage \
1187 "MTD_DEVICE OFFSET SECTORS"
1188#define flash_lock_full_usage "\n\n" \
1189 "Lock part or all of an MTD device. If SECTORS is -1, then all sectors\n" \
1190 "will be locked, regardless of the value of OFFSET"
1191
1192#define flash_unlock_trivial_usage \
1193 "MTD_DEVICE"
1194#define flash_unlock_full_usage "\n\n" \
1195 "Unlock an MTD device"
1196
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001197#define flash_eraseall_trivial_usage \
1198 "[-jq] MTD_DEVICE"
1199#define flash_eraseall_full_usage "\n\n" \
1200 "Erase an MTD device\n" \
1201 "\nOptions:" \
Stefan Seyfriedd095fd42009-11-21 18:32:19 +01001202 "\n -j Format the device for jffs2" \
1203 "\n -q Don't display progress messages" \
1204
1205#define flashcp_trivial_usage \
1206 "-v FILE MTD_DEVICE"
1207#define flashcp_full_usage "\n\n" \
1208 "Copy an image to MTD device\n" \
1209 "\nOptions:" \
1210 "\n -v Verbose" \
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001211
Timo Teras892d4b62010-03-18 22:45:35 +01001212#define flock_trivial_usage \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001213 "[-sxun] FD|{FILE [-c] PROG ARGS}"
Timo Teras892d4b62010-03-18 22:45:35 +01001214#define flock_full_usage "\n\n" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +02001215 "[Un]lock file descriptor, or lock FILE, run PROG\n" \
Timo Teras892d4b62010-03-18 22:45:35 +01001216 "\nOptions:" \
1217 "\n -s Shared lock" \
1218 "\n -x Exclusive lock (default)" \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001219 "\n -u Unlock FD" \
Timo Teras892d4b62010-03-18 22:45:35 +01001220 "\n -n Fail rather than wait" \
1221
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001222#define fold_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001223 "[-bs] [-w WIDTH] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001224#define fold_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001225 "Wrap input lines in each FILE (or stdin), writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001226 "\nOptions:" \
1227 "\n -b Count bytes rather than columns" \
1228 "\n -s Break at spaces" \
1229 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001230
Eric Andersen7e9276b2001-02-22 01:15:47 +00001231#define free_trivial_usage \
Denys Vlasenko5657d372010-10-01 22:42:44 +02001232 "" IF_DESKTOP("[-b/k/m/g]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001233#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001234 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001235#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001236 "$ free\n" \
1237 " total used free shared buffers\n" \
1238 " Mem: 257628 248724 8904 59644 93124\n" \
1239 " Swap: 128516 8404 120112\n" \
1240 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001241
Eric Andersen7e9276b2001-02-22 01:15:47 +00001242#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001243 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001244#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001245 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001246#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001247 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001248
Mike Frysinger51a43b42005-09-24 07:11:16 +00001249#define fsck_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001250 "[-ANPRTV] [-C FD] [-t FSTYPE] [FS_OPTS] [BLOCKDEV]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001251#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001252 "Check and repair filesystems\n" \
1253 "\nOptions:" \
1254 "\n -A Walk /etc/fstab and check all filesystems" \
1255 "\n -N Don't execute, just show what would be done" \
1256 "\n -P With -A, check filesystems in parallel" \
1257 "\n -R With -A, skip the root filesystem" \
1258 "\n -T Don't show title on startup" \
1259 "\n -V Verbose" \
1260 "\n -C n Write status information to specified filedescriptor" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001261 "\n -t TYPE List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001262
Eric Andersen7e9276b2001-02-22 01:15:47 +00001263#define fsck_minix_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001264 "[-larvsmf] BLOCKDEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001265#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001266 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001267 "\nOptions:" \
1268 "\n -l List all filenames" \
1269 "\n -r Perform interactive repairs" \
1270 "\n -a Perform automatic repairs" \
1271 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001272 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001273 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001274 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001275
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001276#define ftpget_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001277 "[OPTIONS] HOST [LOCAL_FILE] REMOTE_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001278#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001279 "Retrieve a remote file via FTP\n" \
1280 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001281 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001282 "\n -c,--continue Continue previous transfer" \
1283 "\n -v,--verbose Verbose" \
1284 "\n -u,--username Username" \
1285 "\n -p,--password Password" \
1286 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001287 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001288 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001289 "\n -c Continue previous transfer" \
1290 "\n -v Verbose" \
1291 "\n -u Username" \
1292 "\n -p Password" \
1293 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001294 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001295
1296#define ftpput_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001297 "[OPTIONS] HOST [REMOTE_FILE] LOCAL_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001298#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001299 "Store a local file on a remote machine via FTP\n" \
1300 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001301 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001302 "\n -v,--verbose Verbose" \
1303 "\n -u,--username Username" \
1304 "\n -p,--password Password" \
1305 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001306 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001307 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001308 "\n -v Verbose" \
1309 "\n -u Username" \
1310 "\n -p Password" \
1311 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001312 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001313
Rob Landleyaa872762005-10-28 13:05:12 +00001314#define fuser_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001315 "[OPTIONS] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001316#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001317 "Find processes which use FILEs or PORTs\n" \
1318 "\nOptions:" \
1319 "\n -m Find processes which use same fs as FILEs" \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02001320 "\n -4,-6 Search only IPv4/IPv6 space" \
Maksym Kryzhanovskyyfef9ee72010-05-22 20:41:08 +02001321 "\n -s Don't display PIDs" \
1322 "\n -k Kill found processes" \
1323 "\n -SIGNAL Signal to send (default: KILL)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001324
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001325#define getenforce_trivial_usage NOUSAGE_STR
1326#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001327
Eric Andersen7e9276b2001-02-22 01:15:47 +00001328#define getopt_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001329 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001330#define getopt_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001331 "Options:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001332 IF_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001333 "\n -a,--alternative Allow long options starting with single -" \
1334 "\n -l,--longoptions=longopts Long options to be recognized" \
1335 "\n -n,--name=progname The name under which errors are reported" \
1336 "\n -o,--options=optstring Short options to be recognized" \
1337 "\n -q,--quiet Disable error reporting by getopt(3)" \
1338 "\n -Q,--quiet-output No normal output" \
1339 "\n -s,--shell=shell Set shell quoting conventions" \
1340 "\n -T,--test Test for getopt(1) version" \
1341 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001342 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001343 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001344 "\n -a Allow long options starting with single -" \
1345 "\n -l longopts Long options to be recognized" \
1346 "\n -n progname The name under which errors are reported" \
1347 "\n -o optstring Short options to be recognized" \
1348 "\n -q Disable error reporting by getopt(3)" \
1349 "\n -Q No normal output" \
1350 "\n -s shell Set shell quoting conventions" \
1351 "\n -T Test for getopt(1) version" \
1352 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001353 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001354#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001355 "$ cat getopt.test\n" \
1356 "#!/bin/sh\n" \
1357 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1358 " -n 'example.busybox' -- \"$@\"`\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001359 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001360 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001361 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001362 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001363 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1364 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001365 " -c|--c-long)\n" \
1366 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001367 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1368 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1369 " esac;;\n" \
1370 " --) shift; break;;\n" \
1371 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001372 " esac\n" \
1373 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001374
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001375#define getsebool_trivial_usage \
1376 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001377#define getsebool_full_usage "\n\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01001378 " -a Show all selinux booleans"
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001379
Eric Andersen7e9276b2001-02-22 01:15:47 +00001380#define gunzip_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02001381 "[-cft] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001382#define gunzip_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02001383 "Decompress FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001384 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001385 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001386 "\n -f Force" \
1387 "\n -t Test file integrity" \
1388
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001389#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001390 "$ ls -la /tmp/BusyBox*\n" \
1391 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1392 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1393 "$ ls -la /tmp/BusyBox*\n" \
1394 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001395
1396#define gzip_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02001397 "[-cfd] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001398#define gzip_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001399 "Compress FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001400 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001401 "\n -d Decompress" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02001402 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001403 "\n -f Force" \
1404
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001405#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001406 "$ ls -la /tmp/busybox*\n" \
1407 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1408 "$ gzip /tmp/busybox.tar\n" \
1409 "$ ls -la /tmp/busybox*\n" \
1410 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001411
Eric Andersen3443bd72003-07-22 07:30:36 +00001412#define hdparm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001413 "[OPTIONS] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001414#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001415 "Options:" \
1416 "\n -a Get/set fs readahead" \
1417 "\n -A Set drive read-lookahead flag (0/1)" \
1418 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1419 "\n -B Set Advanced Power Management setting (1-255)" \
1420 "\n -c Get/set IDE 32-bit IO setting" \
1421 "\n -C Check IDE power mode status" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001422 IF_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001423 "\n -d Get/set using_dma flag") \
1424 "\n -D Enable/disable drive defect-mgmt" \
1425 "\n -f Flush buffer cache for device on exit" \
1426 "\n -g Display drive geometry" \
1427 "\n -h Display terse usage information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001428 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001429 "\n -i Display drive identification") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001430 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001431 "\n -I Detailed/current information directly from drive") \
1432 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1433 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1434 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1435 "\n -m Get/set multiple sector count" \
1436 "\n -n Get/set ignore-write-errors flag (0/1)" \
1437 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1438 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001439/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001440 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1441 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001442 IF_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001443 "\n -R Register an IDE interface (DANGEROUS)") \
1444 "\n -S Set standby (spindown) timeout" \
1445 "\n -t Perform device read timings" \
1446 "\n -T Perform cache read timings" \
1447 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001448 IF_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001449 "\n -U Unregister an IDE interface (DANGEROUS)") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001450 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1451 "\n -V Display program version and exit immediately" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001452 IF_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001453 "\n -w Perform device reset (DANGEROUS)") \
1454 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001455 IF_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001456 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1457 "\n -X Set IDE xfer mode (DANGEROUS)" \
1458 "\n -y Put IDE drive in standby mode" \
1459 "\n -Y Put IDE drive to sleep" \
1460 "\n -Z Disable Seagate auto-powersaving mode" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001461 "\n -z Reread partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001462
Eric Andersen7e9276b2001-02-22 01:15:47 +00001463#define head_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001464 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001465#define head_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001466 "Print first 10 lines of each FILE (or stdin) to stdout.\n" \
Denys Vlasenko57493282010-03-02 16:18:14 +01001467 "With more than one FILE, precede each with a filename header.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001468 "\nOptions:" \
Denys Vlasenko57493282010-03-02 16:18:14 +01001469 "\n -n N[kbm] Print first N lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001470 IF_FEATURE_FANCY_HEAD( \
Denys Vlasenko57493282010-03-02 16:18:14 +01001471 "\n -c N[kbm] Print first N bytes" \
1472 "\n -q Never print headers" \
1473 "\n -v Always print headers" \
1474 ) \
1475 "\n" \
1476 "\nN may be suffixed by k (x1024), b (x512), or m (x1024^2)." \
Denis Vlasenko397de612008-03-17 08:55:44 +00001477
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001478#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001479 "$ head -n 2 /etc/passwd\n" \
1480 "root:x:0:0:root:/root:/bin/bash\n" \
1481 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001482
Denys Vlasenko57493282010-03-02 16:18:14 +01001483#define tail_trivial_usage \
1484 "[OPTIONS] [FILE]..."
1485#define tail_full_usage "\n\n" \
1486 "Print last 10 lines of each FILE (or stdin) to stdout.\n" \
1487 "With more than one FILE, precede each with a filename header.\n" \
1488 "\nOptions:" \
1489 "\n -f Print data as file grows" \
1490 IF_FEATURE_FANCY_TAIL( \
1491 "\n -s SECONDS Wait SECONDS between reads with -f" \
1492 ) \
1493 "\n -n N[kbm] Print last N lines" \
1494 IF_FEATURE_FANCY_TAIL( \
1495 "\n -c N[kbm] Print last N bytes" \
1496 "\n -q Never print headers" \
1497 "\n -v Always print headers" \
1498 "\n" \
1499 "\nN may be suffixed by k (x1024), b (x512), or m (x1024^2)." \
1500 "\nIf N starts with a '+', output begins with the Nth item from the start" \
1501 "\nof each file, not from the end." \
1502 ) \
1503
1504#define tail_example_usage \
1505 "$ tail -n 1 /etc/resolv.conf\n" \
1506 "nameserver 10.0.0.1\n"
1507
Glenn L McGrath60281112001-11-02 11:39:46 +00001508#define hexdump_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001509 "[-bcCdefnosvx" IF_FEATURE_HEXDUMP_REVERSE("R") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001510#define hexdump_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001511 "Display FILEs (or stdin) in a user specified format\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001512 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001513 "\n -b One-byte octal display" \
1514 "\n -c One-byte character display" \
1515 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1516 "\n -d Two-byte decimal display" \
Denys Vlasenkoa6041862010-12-13 15:17:22 +01001517 "\n -e FORMAT_STRING" \
1518 "\n -f FORMAT_FILE" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001519 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1520 "\n -o Two-byte octal display" \
1521 "\n -s OFFSET Skip OFFSET bytes" \
1522 "\n -v Display all input data" \
1523 "\n -x Two-byte hexadecimal display" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001524 IF_FEATURE_HEXDUMP_REVERSE( \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001525 "\n -R Reverse of 'hexdump -Cv'") \
1526
1527#define hd_trivial_usage \
1528 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001529#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001530 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001531
Eric Andersen7e9276b2001-02-22 01:15:47 +00001532#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001533 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001534#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001535 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001536
1537#define hostname_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001538 "[OPTIONS] [HOSTNAME | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001539#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001540 "Get or set hostname or DNS domain name\n" \
1541 "\nOptions:" \
1542 "\n -s Short" \
1543 "\n -i Addresses for the hostname" \
1544 "\n -d DNS domain name" \
1545 "\n -f Fully qualified domain name" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001546 "\n -F FILE Use FILE's content as hostname" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001547
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001548#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001549 "$ hostname\n" \
1550 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001551
Denys Vlasenkod30b89c2009-06-26 01:55:45 +02001552#define dnsdomainname_trivial_usage NOUSAGE_STR
1553#define dnsdomainname_full_usage ""
1554
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001555#define httpd_trivial_usage \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001556 "[-ifv[v]]" \
1557 " [-c CONFFILE]" \
1558 " [-p [IP:]PORT]" \
1559 IF_FEATURE_HTTPD_SETUID(" [-u USER[:GRP]]") \
1560 IF_FEATURE_HTTPD_BASIC_AUTH(" [-r REALM]") \
1561 " [-h HOME]\n" \
1562 "or httpd -d/-e" IF_FEATURE_HTTPD_AUTH_MD5("/-m") " STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001563#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001564 "Listen for incoming HTTP requests\n" \
1565 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001566 "\n -i Inetd mode" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001567 "\n -f Don't daemonize" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001568 "\n -v[v] Verbose" \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02001569 "\n -p [IP:]PORT Bind to IP:PORT (default *:80)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001570 IF_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001571 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001572 IF_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001573 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001574 "\n -h HOME Home directory (default .)" \
Denys Vlasenko8fc9e6a2010-04-02 10:40:58 +02001575 "\n -c FILE Configuration file (default {/etc,HOME}/httpd.conf)" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001576 IF_FEATURE_HTTPD_AUTH_MD5( \
1577 "\n -m STRING MD5 crypt STRING") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001578 "\n -e STRING HTML encode STRING" \
1579 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001580
Eric Andersen7e9276b2001-02-22 01:15:47 +00001581#define id_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001582 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001583#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001584 "Print information about USER or the current user\n" \
1585 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001586 IF_SELINUX( \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02001587 "\n -Z Security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001588 ) \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02001589 "\n -u User ID" \
1590 "\n -g Group ID" \
1591 "\n -G Supplementary group IDs" \
1592 "\n -n Print names instead of numbers" \
1593 "\n -r Print real ID instead of effective ID" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001594
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001595#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001596 "$ id\n" \
1597 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001598
Eric Andersen7e9276b2001-02-22 01:15:47 +00001599#define ifconfig_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001600 IF_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001601#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001602 "Configure a network interface\n" \
1603 "\nOptions:" \
1604 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001605 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001606 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001607 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001608 " [del ADDRESS[/PREFIXLEN]]\n") \
1609 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1610 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001611 IF_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001612 " [outfill NN] [keepalive NN]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001613 " " IF_FEATURE_IFCONFIG_HW("[hw ether" IF_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001614 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001615 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001616 IF_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001617 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001618 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001619
Denis Vlasenko06aed432008-02-26 18:25:24 +00001620#define ifenslave_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001621 "[-cdf] MASTER_IFACE SLAVE_IFACE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001622#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001623 "Configure network interfaces for parallel routing\n" \
1624 "\nOptions:" \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02001625 "\n -c,--change-active Change active slave" \
1626 "\n -d,--detach Remove slave interface from bonding device" \
1627 "\n -f,--force Force, even if interface is not Ethernet" \
1628/* "\n -r,--receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001629
Denis Vlasenko06aed432008-02-26 18:25:24 +00001630#define ifenslave_example_usage \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001631 "To create a bond device, simply follow these three steps:\n" \
1632 "- ensure that the required drivers are properly loaded:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001633 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001634 "- assign an IP address to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001635 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001636 "- attach all the interfaces you need to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001637 " # ifenslave bond0 eth0 eth1 eth2\n" \
1638 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1639 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001640 " To detach a dead interface without setting the bond device down:\n" \
1641 " # ifenslave -d bond0 eth1\n\n" \
1642 " To set the bond device down and automatically release all the slaves:\n" \
1643 " # ifconfig bond0 down\n\n" \
1644 " To change active slave:\n" \
1645 " # ifenslave -c bond0 eth0\n" \
1646
1647#define ifplugd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001648 "[OPTIONS]"
Denis Vlasenko71c16572009-04-26 01:08:51 +00001649#define ifplugd_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +02001650 "Network interface plug detection daemon\n" \
1651 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001652 "\n -n Don't daemonize" \
1653 "\n -s Don't log to syslog" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001654 "\n -i IFACE Interface" \
1655 "\n -f/-F Treat link detection error as link down/link up" \
1656 "\n (otherwise exit on error)" \
Denys Vlasenko999e4422010-01-08 13:03:48 +01001657 "\n -a Don't up interface at each link probe" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001658 "\n -M Monitor creation/destruction of interface" \
1659 "\n (otherwise it must exist)" \
1660 "\n -r PROG Script to run" \
1661 "\n -x ARG Extra argument for script" \
1662 "\n -I Don't exit on nonzero exit code from script" \
1663 "\n -p Don't run script on daemon startup" \
1664 "\n -q Don't run script on daemon quit" \
1665 "\n -l Run script on startup even if no cable is detected" \
1666 "\n -t SECS Poll time in seconds" \
1667 "\n -u SECS Delay before running script after link up" \
1668 "\n -d SECS Delay after link down" \
Denys Vlasenkob8f0e802010-01-07 14:56:50 +01001669 "\n -m MODE API mode (mii, priv, ethtool, wlan, iff, auto)" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001670 "\n -k Kill running daemon" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001671
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001672#define ifup_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02001673 "[-an"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] [-i FILE] IFACE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001674#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001675 "Options:" \
1676 "\n -a De/configure all interfaces automatically" \
1677 "\n -i FILE Use FILE for interface definitions" \
1678 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001679 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001680 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001681 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001682 ) \
1683 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001684 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001685
1686#define ifdown_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02001687 "[-an"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] [-i FILE] IFACE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001688#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001689 "Options:" \
1690 "\n -a De/configure all interfaces automatically" \
1691 "\n -i FILE Use FILE for interface definitions" \
1692 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001693 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001694 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001695 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001696 ) \
1697 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001698 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001699
Glenn L McGrath06e95652003-02-09 06:51:14 +00001700#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001701 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001702#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001703 "Listen for network connections and launch programs\n" \
1704 "\nOptions:" \
1705 "\n -f Run in foreground" \
1706 "\n -e Log to stderr" \
1707 "\n -q N Socket listen queue (default: 128)" \
1708 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001709 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001710
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001711#define inotifyd_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001712 "PROG FILE1[:MASK]..."
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001713#define inotifyd_full_usage "\n\n" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001714 "Run PROG on filesystem changes." \
1715 "\nWhen a filesystem event matching MASK occurs on FILEn," \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001716 "\nPROG ACTUAL_EVENTS FILEn [SUBFILE] is run." \
Denis Vlasenko289ff0e2008-11-14 21:52:16 +00001717 "\nEvents:" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001718 "\n a File is accessed" \
1719 "\n c File is modified" \
1720 "\n e Metadata changed" \
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001721 "\n w Writable file is closed" \
1722 "\n 0 Unwritable file is closed" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001723 "\n r File is opened" \
Denis Vlasenkoa09a42c2008-11-17 22:19:18 +00001724 "\n D File is deleted" \
1725 "\n M File is moved" \
1726 "\n u Backing fs is unmounted" \
1727 "\n o Event queue overflowed" \
1728 "\n x File can't be watched anymore" \
1729 "\nIf watching a directory:" \
1730 "\n m Subfile is moved into dir" \
1731 "\n y Subfile is moved out of dir" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001732 "\n n Subfile is created" \
1733 "\n d Subfile is deleted" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001734 "\n" \
1735 "\ninotifyd waits for PROG to exit." \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001736 "\nWhen x event happens for all FILEs, inotifyd exits." \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001737
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00001738/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001739#define install_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001740 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [SOURCE]... DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001741#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001742 "Copy files and set attributes\n" \
1743 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001744 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001745 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00001746 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001747 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001748 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001749 "\n -o USER Set ownership" \
1750 "\n -g GRP Set group ownership" \
1751 "\n -m MODE Set permissions" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001752 IF_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001753 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001754 )
Denis Vlasenko397de612008-03-17 08:55:44 +00001755
1756/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001757#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001758 "[OPTIONS] {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001759 IF_FEATURE_IP_ADDRESS("address | ") \
1760 IF_FEATURE_IP_ROUTE("route | ") \
1761 IF_FEATURE_IP_LINK("link | ") \
1762 IF_FEATURE_IP_TUNNEL("tunnel | ") \
1763 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001764 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001765#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001766 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001767 "where OBJECT := {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001768 IF_FEATURE_IP_ADDRESS("address | ") \
1769 IF_FEATURE_IP_ROUTE("route | ") \
1770 IF_FEATURE_IP_LINK("link | ") \
1771 IF_FEATURE_IP_TUNNEL("tunnel | ") \
1772 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001773 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001774 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001775
1776#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001777 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001778 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001779#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001780 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001781 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
1782 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001783 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001784 " [broadcast ADDR] [anycast ADDR]\n" \
1785 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001786 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001787
Eric Andersende4f07e2003-12-11 01:18:07 +00001788#define ipcalc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001789 "[OPTIONS] ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001790#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001791 "Calculate IP network settings from a IP address\n" \
1792 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001793 IF_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001794 "\n -b,--broadcast Display calculated broadcast address" \
1795 "\n -n,--network Display calculated network address" \
1796 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001797 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001798 "\n -p,--prefix Display the prefix for IP/NETMASK" \
1799 "\n -h,--hostname Display first resolved host name" \
1800 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001801 ) \
1802 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001803 IF_NOT_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001804 "\n -b Display calculated broadcast address" \
1805 "\n -n Display calculated network address" \
1806 "\n -m Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001807 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001808 "\n -p Display the prefix for IP/NETMASK" \
1809 "\n -h Display first resolved host name" \
1810 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001811 ) \
1812 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001813
Rob Landley6eb1e412005-06-20 04:30:36 +00001814#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001815 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001816#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001817 "Upper-case options MQS remove an object by shmkey value.\n" \
1818 "Lower-case options remove an object by shmid value.\n" \
1819 "\nOptions:" \
1820 "\n -mM Remove memory segment after last detach" \
1821 "\n -qQ Remove message queue" \
1822 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001823
1824#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001825 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001826#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001827 " -i Show specific resource" \
1828 "\nResource specification:" \
1829 "\n -m Shared memory segments" \
1830 "\n -q Message queues" \
1831 "\n -s Semaphore arrays" \
1832 "\n -a All (default)" \
1833 "\nOutput format:" \
1834 "\n -t Time" \
1835 "\n -c Creator" \
1836 "\n -p Pid" \
1837 "\n -l Limits" \
1838 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001839
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001840#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001841 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001842#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00001843 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001844 " dynamic { on | off } |\n" \
1845 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001846 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001847
1848#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001849 "{ list | flush | { add | del | change | append |\n" \
1850 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001851#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001852 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001853 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
1854 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001855 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001856 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00001857 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
1858 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001859
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001860#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001861 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001862#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001863 "iprule [list | add | del] SELECTOR ACTION\n" \
1864 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
1865 " [dev STRING] [pref NUMBER]\n" \
1866 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
1867 " [prohibit | reject | unreachable]\n" \
1868 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001869 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001870
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001871#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001872 "{ add | change | del | show } [NAME]\n" \
1873 " [mode { ipip | gre | sit }]\n" \
1874 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001875#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001876 "iptunnel { add | change | del | show } [NAME]\n" \
1877 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
1878 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001879 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001880
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00001881#define kbd_mode_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00001882 "[-a|k|s|u] [-C TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001883#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001884 "Report or set the keyboard mode\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001885 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001886 "\n -a Default (ASCII)" \
1887 "\n -k Medium-raw (keyboard)" \
1888 "\n -s Raw (scancode)" \
1889 "\n -u Unicode (utf-8)" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00001890 "\n -C TTY Affect TTY instead of /dev/tty" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00001891
Eric Andersen7e9276b2001-02-22 01:15:47 +00001892#define kill_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00001893 "[-l] [-SIG] PID..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001894#define kill_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001895 "Send a signal (default: TERM) to given PIDs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001896 "\nOptions:" \
1897 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00001898/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001899
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001900#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001901 "$ ps | grep apache\n" \
1902 "252 root root S [apache]\n" \
1903 "263 www-data www-data S [apache]\n" \
1904 "264 www-data www-data S [apache]\n" \
1905 "265 www-data www-data S [apache]\n" \
1906 "266 www-data www-data S [apache]\n" \
1907 "267 www-data www-data S [apache]\n" \
1908 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001909
1910#define killall_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001911 "[-l] [-q] [-SIG] PROCESS_NAME..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001912#define killall_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001913 "Send a signal (default: TERM) to given processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001914 "\nOptions:" \
1915 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00001916/* "\n -s SIG Yet another way of specifying SIG" */ \
Denys Vlasenko07697852009-10-06 21:11:37 +02001917 "\n -q Don't complain if no processes were killed" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001918
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001919#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001920 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001921
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001922#define killall5_trivial_usage \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00001923 "[-l] [-SIG] [-o PID]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001924#define killall5_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001925 "Send a signal (default: TERM) to all processes outside current session\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001926 "\nOptions:" \
1927 "\n -l List all signal names and numbers" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001928 "\n -o PID Don't signal this PID" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00001929/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001930
Mark Whitley6317c4b2001-03-12 22:51:50 +00001931#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00001932 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001933#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001934 "Kernel logger\n" \
1935 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00001936 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001937 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00001938
Eric Andersen7e9276b2001-02-22 01:15:47 +00001939#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001940 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001941#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001942 "Print STRING's length"
1943
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001944#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001945 "$ length Hello\n" \
1946 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001947
Rob Landley9200e792005-09-15 19:26:59 +00001948#define less_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001949 "[-EMNmh~I?] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001950#define less_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001951 "View FILE (or stdin) one screenful at a time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001952 "\nOptions:" \
1953 "\n -E Quit once the end of a file is reached" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001954 "\n -M,-m Display status line with line numbers" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001955 "\n and percentage through the file" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001956 "\n -N Prefix line number to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00001957 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001958 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00001959
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001960#define linux32_trivial_usage NOUSAGE_STR
1961#define linux32_full_usage ""
1962#define linux64_trivial_usage NOUSAGE_STR
1963#define linux64_full_usage ""
1964
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001965#define setarch_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001966 "personality PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001967#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001968 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001969 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001970 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001971
Eric Andersen7e9276b2001-02-22 01:15:47 +00001972#define ln_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001973 "[OPTIONS] TARGET... LINK|DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001974#define ln_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001975 "Create a link LINK or DIR/TARGET to the specified TARGET(s)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001976 "\nOptions:" \
1977 "\n -s Make symlinks instead of hardlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001978 "\n -f Remove existing destinations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001979 "\n -n Don't dereference symlinks - treat like normal file" \
1980 "\n -b Make a backup of the target (if exists) before link operation" \
1981 "\n -S suf Use suffix instead of ~ when making backup files" \
1982
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001983#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001984 "$ ln -s BusyBox /tmp/ls\n" \
1985 "$ ls -l /tmp/ls\n" \
1986 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001987
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001988#define load_policy_trivial_usage NOUSAGE_STR
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001989#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00001990
Eric Andersen7e9276b2001-02-22 01:15:47 +00001991#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001992 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001993#define loadfont_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001994 "Load a console font from stdin" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00001995/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
1996
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001997#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001998 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001999
2000#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002001 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002002#define loadkmap_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002003 "Load a binary keyboard translation table from stdin\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002004/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2005
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002006#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002007 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002008
2009#define logger_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002010 "[OPTIONS] [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002011#define logger_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002012 "Write MESSAGE (or stdin) to syslog\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002013 "\nOptions:" \
2014 "\n -s Log to stderr as well as the system log" \
2015 "\n -t TAG Log using the specified tag (defaults to user name)" \
2016 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002017
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002018#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002019 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002020
Robert Griebl1fca5582002-06-04 20:45:46 +00002021#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002022 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002023#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002024 "Begin a new session on the system\n" \
2025 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002026 "\n -f Don't authenticate (user already authenticated)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002027 "\n -h Name of the remote host" \
2028 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002029
Eric Andersen7e9276b2001-02-22 01:15:47 +00002030#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002031 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002032#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002033 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002034#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002035 "$ logname\n" \
2036 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002037
Mark Whitley6317c4b2001-03-12 22:51:50 +00002038#define logread_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002039 "[-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002040#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002041 "Show messages in syslogd's circular buffer\n" \
2042 "\nOptions:" \
2043 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002044
Matt Kraai83788da2002-03-20 17:38:37 +00002045#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002046 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2047 " losetup -d LOOPDEV - disassociate\n" \
2048 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002049#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002050 "Options:" \
2051 "\n -o OFS Start OFS bytes into FILE" \
2052 "\n -f Show first free loop device" \
2053
Rob Landley1d589b22005-11-29 23:47:10 +00002054#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002055 "No arguments will display all current associations.\n" \
2056 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002057 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002058 "and filename of the file the loop device is currently bound to.\n\n" \
2059 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002060 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2061 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002062
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002063#define lpd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002064 "SPOOLDIR [HELPER [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002065#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002066 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2067 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002068 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002069 "\ndirectory and HELPER program is called. Name of file to print" \
2070 "\nis passed in $DATAFILE variable." \
2071 "\nExample:" \
2072 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002073
Denis Vlasenko68444b92008-02-22 22:24:48 +00002074#define lpq_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002075 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID]... [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002076#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002077 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002078 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002079 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002080 "\n -f Force any waiting job to be printed" \
2081 "\n -s Short display" \
2082
2083#define lpr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002084 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE]..."
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002085/* -C CLASS exists too, not shown.
2086 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002087#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002088 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002089 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002090 "\n -m Send mail on completion" \
2091 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002092 "\n -V Verbose" \
2093
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002094#define lsattr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002095 "[-Radlv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002096#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002097 "List file attributes on an ext2 fs\n" \
2098 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002099 "\n -R Recurse" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002100 "\n -a Don't hide entries starting with ." \
Denis Vlasenko397de612008-03-17 08:55:44 +00002101 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002102 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002103 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002104
Souf Oued982bc712009-12-05 17:56:25 +01002105#define lspci_trivial_usage \
2106 "[-mk]"
2107#define lspci_full_usage "\n\n" \
2108 "List all PCI devices" \
2109 "\n" \
2110 "\n -m Parseable output" \
2111 "\n -k Show driver" \
2112
Souf Oued11a802a2009-12-07 01:37:34 +01002113#define lsusb_trivial_usage NOUSAGE_STR
2114#define lsusb_full_usage ""
2115
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002116#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002117#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002118 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002119#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002120 "Create a range of block or character special files" \
2121 "\n" \
2122 "\nTYPE is:" \
2123 "\n b Block device" \
2124 "\n c Character device" \
2125 "\n f FIFO, MAJOR and MINOR are ignored" \
2126 "\n" \
2127 "\nFIRST..LAST specify numbers appended to NAME." \
2128 "\nIf 's' is the last argument, the base device is created as well." \
2129 "\n" \
2130 "\nExamples:" \
2131 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2132 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002133#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002134 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2135 "[creates ttyS2-ttyS63]\n" \
2136 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2137 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002138#endif
2139
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002140#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002141#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002142 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002143#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002144 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002145 "Device table entries take the form of:\n" \
2146 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002147 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002148 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002149 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002150 " c Character device\n" \
2151 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002152 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002153 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002154 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2155 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002156#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002157 "For example:\n" \
2158 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2159 "/dev d 755 0 0 - - - - -\n" \
2160 "/dev/console c 666 0 0 5 1 - - -\n" \
2161 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2162 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2163 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2164 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2165 "Will Produce:\n" \
2166 "/dev\n" \
2167 "/dev/console\n" \
2168 "/dev/null\n" \
2169 "/dev/zero\n" \
2170 "/dev/hda\n" \
2171 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002172#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002173
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002174#define makemime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002175 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002176#define makemime_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002177 "Create multipart MIME-encoded message from FILEs\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002178/* "Transfer encoding is base64, disposition is inline (not attachment)\n" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002179 "\nOptions:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002180 "\n -o FILE Output. Default: stdout" \
2181 "\n -a HDR Add header. Examples:" \
2182 "\n \"From: user@host.org\", \"Date: `date -R`\"" \
2183 "\n -c CT Content type. Default: text/plain" \
2184 "\n -C CS Charset. Default: " CONFIG_FEATURE_MIME_CHARSET \
2185/* "\n -e ENC Transfer encoding. Ignored. base64 is assumed" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002186 "\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002187 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002188
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002189#define man_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002190 "[-aw] [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002191#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002192 "Format and display manual page\n" \
2193 "\nOptions:" \
2194 "\n -a Display all pages" \
2195 "\n -w Show page locations" \
2196
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002197#define matchpathcon_trivial_usage \
2198 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002199#define matchpathcon_full_usage "\n\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002200 " -n Don't display path" \
2201 "\n -N Don't use translations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002202 "\n -f Use alternate file_context file" \
2203 "\n -p Use prefix to speed translations" \
2204 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002205
Eric Andersen7e9276b2001-02-22 01:15:47 +00002206#define md5sum_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002207 "[FILE]..." \
2208 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum -c [-sw] [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002209#define md5sum_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002210 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2211 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002212 "\nOptions:" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002213 "\n -c Check sums against given list" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002214 "\n -s Don't output anything, status code shows success" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002215 "\n -w Warn about improperly formatted checksum lines" \
2216 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002217
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002218#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002219 "$ md5sum < busybox\n" \
2220 "6fd11e98b98a58f64ff3398d7b324003\n" \
2221 "$ md5sum busybox\n" \
2222 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2223 "$ md5sum -c -\n" \
2224 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2225 "busybox: OK\n" \
2226 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002227
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002228#define sha1sum_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002229 "[FILE]..." \
2230 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum -c [-sw] [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002231#define sha1sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002232 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002233 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002234 "\nOptions:" \
2235 "\n -c Check sums against given list" \
2236 "\n -s Don't output anything, status code shows success" \
2237 "\n -w Warn about improperly formatted checksum lines" \
2238 )
2239
2240#define sha256sum_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002241 "[FILE]..." \
2242 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha256sum -c [-sw] [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002243#define sha256sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002244 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA256 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002245 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002246 "\nOptions:" \
2247 "\n -c Check sums against given list" \
2248 "\n -s Don't output anything, status code shows success" \
2249 "\n -w Warn about improperly formatted checksum lines" \
2250 )
2251
2252#define sha512sum_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002253 "[FILE]..." \
2254 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha512sum -c [-sw] [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002255#define sha512sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002256 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA512 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002257 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002258 "\nOptions:" \
2259 "\n -c Check sums against given list" \
2260 "\n -s Don't output anything, status code shows success" \
2261 "\n -w Warn about improperly formatted checksum lines" \
2262 )
2263
Rob Landley70f7ef72005-12-13 08:21:33 +00002264#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002265 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002266#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002267 " -s Scan /sys and populate /dev during system boot\n" \
2268 "\n" \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002269 "It can be run by kernel as a hotplug helper. To activate it:\n" \
Denys Vlasenkof92874e2009-12-05 15:59:05 +01002270 " echo /sbin/mdev > /proc/sys/kernel/hotplug\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002271 IF_FEATURE_MDEV_CONF( \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002272 "It uses /etc/mdev.conf with lines\n" \
Denis Vlasenkof2b39e02009-04-13 23:18:52 +00002273 "[-]DEVNAME UID:GID PERM" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002274 IF_FEATURE_MDEV_RENAME(" [>|=PATH]") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002275 IF_FEATURE_MDEV_EXEC(" [@|$|*PROG]") \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002276 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002277
Rob Landleyef10d522006-06-26 14:11:33 +00002278#define mdev_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002279 IF_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002280 "The mdev config file contains lines that look like:\n" \
2281 " hd[a-z][0-9]* 0:3 660\n\n" \
2282 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002283 IF_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002284 "Optionally, that can be followed (on the same line) by a special character\n" \
2285 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002286 "device(s). The environment variable $MDEV indicates the active device node\n" \
2287 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002288 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2289 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002290 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002291 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002292 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002293 "Config file parsing stops on the first matching line. If no config\n" \
2294 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002295 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002296 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002297
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002298#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002299 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002300#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002301 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2302 "\nOptions:" \
2303 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2304 "\n next byte to it" \
2305 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2306 "\n -s Set serial line to SPEED" \
2307 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002308
Eric Andersen7e9276b2001-02-22 01:15:47 +00002309#define mkdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002310 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002311#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002312 "Create DIRECTORY\n" \
2313 "\nOptions:" \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002314 "\n -m MODE Mode" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002315 "\n -p No error if exists; make parent directories as needed" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002316 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002317 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002318 )
2319
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002320#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002321 "$ mkdir /tmp/foo\n" \
2322 "$ mkdir /tmp/foo\n" \
2323 "/tmp/foo: File exists\n" \
2324 "$ mkdir /tmp/foo/bar/baz\n" \
2325 "/tmp/foo/bar/baz: No such file or directory\n" \
2326 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002327
Eric Andersen7e9276b2001-02-22 01:15:47 +00002328#define mkfifo_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002329 "[-m MODE] " IF_SELINUX("[-Z] ") "NAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002330#define mkfifo_full_usage "\n\n" \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002331 "Create named pipe\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002332 "\nOptions:" \
2333 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002334 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002335 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002336 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002337
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002338#define mkfs_ext2_trivial_usage \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002339 "[-Fn] " \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002340 /* "[-c|-l filename] " */ \
2341 "[-b BLK_SIZE] " \
2342 /* "[-f fragment-size] [-g blocks-per-group] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002343 "[-i INODE_RATIO] [-I INODE_SIZE] " \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002344 /* "[-j] [-J journal-options] [-N number-of-inodes] " */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002345 "[-m RESERVED_PERCENT] " \
2346 /* "[-o creator-os] [-O feature[,...]] [-q] " */ \
2347 /* "[r fs-revision-level] [-E extended-options] [-v] [-F] " */ \
2348 "[-L LABEL] " \
2349 /* "[-M last-mounted-directory] [-S] [-T filesystem-type] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002350 "BLOCKDEV [KBYTES]"
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002351#define mkfs_ext2_full_usage "\n\n" \
2352 " -b BLK_SIZE Block size, bytes" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002353/* "\n -c Check device for bad blocks" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002354/* "\n -E opts Set extended options" */ \
2355/* "\n -f size Fragment size in bytes" */ \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002356 "\n -F Force" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002357/* "\n -g N Number of blocks in a block group" */ \
Denys Vlasenko838e07a2009-10-22 12:15:33 +02002358 "\n -i RATIO Max number of files is filesystem_size / RATIO" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002359 "\n -I BYTES Inode size (min 128)" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002360/* "\n -j Create a journal (ext3)" */ \
2361/* "\n -J opts Set journal options (size/device)" */ \
2362/* "\n -l file Read bad blocks list from file" */ \
Denys Vlasenko6a8cfdc2009-10-17 23:41:15 +02002363 "\n -L LBL Volume label" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002364 "\n -m PERCENT Percent of blocks to reserve for admin" \
2365/* "\n -M dir Set last mounted directory" */ \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002366 "\n -n Dry run" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002367/* "\n -N N Number of inodes to create" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002368/* "\n -o os Set the 'creator os' field" */ \
2369/* "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" */ \
2370/* "\n -q Quiet" */ \
2371/* "\n -r rev Set filesystem revision" */ \
2372/* "\n -S Write superblock and group descriptors only" */ \
2373/* "\n -T fs-type Set usage type (news/largefile/largefile4)" */ \
2374/* "\n -v Verbose" */ \
2375
Eric Andersen7e9276b2001-02-22 01:15:47 +00002376#define mkfs_minix_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002377 "[-c | -l FILE] [-nXX] [-iXX] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002378#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002379 "Make a MINIX filesystem\n" \
2380 "\nOptions:" \
2381 "\n -c Check device for bad blocks" \
2382 "\n -n [14|30] Maximum length of filenames" \
2383 "\n -i INODES Number of inodes for the filesystem" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002384 "\n -l FILE Read bad blocks list from FILE" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002385 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002386
Vladimir Dronnikov0d8ea642009-11-02 10:41:46 +01002387#define mkfs_reiser_trivial_usage \
2388 "[-f] [-l LABEL] BLOCKDEV [4K-BLOCKS]"
2389
2390#define mkfs_reiser_full_usage "\n\n" \
2391 "Make a ReiserFS V3 filesystem\n" \
2392 "\nOptions:" \
2393 "\n -f Force" \
2394 "\n -l LBL Volume label" \
2395
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002396#define mkfs_vfat_trivial_usage \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002397 "[-v] [-n LABEL] BLOCKDEV [KBYTES]"
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002398/* Accepted but ignored:
2399 "[-c] [-C] [-I] [-l bad-block-file] [-b backup-boot-sector] "
2400 "[-m boot-msg-file] [-i volume-id] "
2401 "[-s sectors-per-cluster] [-S logical-sector-size] [-f number-of-FATs] "
2402 "[-h hidden-sectors] [-F fat-size] [-r root-dir-entries] [-R reserved-sectors] "
2403*/
2404#define mkfs_vfat_full_usage "\n\n" \
2405 "Make a FAT32 filesystem\n" \
2406 "\nOptions:" \
2407/* "\n -c Check device for bad blocks" */ \
2408 "\n -v Verbose" \
2409/* "\n -I Allow to use entire disk device (e.g. /dev/hda)" */ \
2410 "\n -n LBL Volume label" \
2411
Eric Andersen7e9276b2001-02-22 01:15:47 +00002412#define mknod_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002413 "[-m MODE] " IF_SELINUX("[-Z] ") "NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002414#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002415 "Create a special file (block, character, or pipe)\n" \
2416 "\nOptions:" \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002417 "\n -m MODE Creation mode (default a=rw)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002418 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002419 "\n -Z Set security context" \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002420 ) \
Denys Vlasenko3b2acb72010-10-09 21:10:32 +02002421 "\nTYPE:" \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002422 "\n b Block device" \
2423 "\n c or u Character device" \
2424 "\n p Named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002425
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002426#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002427 "$ mknod /dev/fd0 b 2 0\n" \
2428 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002429
Eric Andersen7e9276b2001-02-22 01:15:47 +00002430#define mkswap_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002431 "[-L LBL] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002432#define mkswap_full_usage "\n\n" \
Denys Vlasenko68c67462009-11-03 05:51:20 +01002433 "Prepare BLOCKDEV to be used as swap partition\n" \
2434 "\nOptions:" \
2435 "\n -L LBL Label" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002436
Eric Andersen7e9276b2001-02-22 01:15:47 +00002437#define more_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002438 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002439#define more_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002440 "View FILE (or stdin) one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002441
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002442#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002443 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002444
Eric Andersen7e9276b2001-02-22 01:15:47 +00002445#define mount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002446 "[OPTIONS] [-o OPTS] DEVICE NODE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002447#define mount_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002448 "Mount a filesystem. Filesystem autodetection requires /proc.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002449 "\nOptions:" \
2450 "\n -a Mount all filesystems in fstab" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002451 IF_FEATURE_MOUNT_FAKE( \
2452 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002453 "\n -f Update /etc/mtab, but don't mount" \
2454 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002455 IF_NOT_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002456 "\n -f Dry run" \
2457 ) \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002458 ) \
Denys Vlasenkoe2e4cc22009-06-19 11:48:29 +02002459 IF_FEATURE_MOUNT_HELPERS( \
2460 "\n -i Don't run mount helper" \
2461 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002462 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002463 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002464 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002465 "\n -r Read-only mount" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002466 "\n -w Read-write mount (default)" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002467 "\n -t FSTYPE Filesystem type" \
2468 "\n -O OPT Mount only filesystems with option OPT (-a only)" \
2469 "\n-o OPT:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002470 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002471 "\n loop Ignored (loop devices are autodetected)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002472 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002473 IF_FEATURE_MOUNT_FLAGS( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002474 "\n [a]sync Writes are [a]synchronous" \
2475 "\n [no]atime Disable/enable updates to inode access times" \
2476 "\n [no]diratime Disable/enable atime updates to directories" \
2477 "\n [no]relatime Disable/enable atime updates relative to modification time" \
2478 "\n [no]dev (Dis)allow use of special device files" \
2479 "\n [no]exec (Dis)allow use of executable files" \
2480 "\n [no]suid (Dis)allow set-user-id-root programs" \
2481 "\n [r]shared Convert [recursively] to a shared subtree" \
2482 "\n [r]slave Convert [recursively] to a slave subtree" \
2483 "\n [r]private Convert [recursively] to a private subtree" \
2484 "\n [un]bindable Make mount point [un]able to be bind mounted" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002485 "\n bind Bind a file or directory to another location" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002486 "\n move Relocate an existing mount point" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002487 ) \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002488 "\n remount Remount a mounted filesystem, changing flags" \
2489 "\n ro/rw Same as -r/-w" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002490 "\n" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002491 "\nThere are filesystem-specific -o flags." \
Denis Vlasenko397de612008-03-17 08:55:44 +00002492
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002493#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002494 "$ mount\n" \
2495 "/dev/hda3 on / type minix (rw)\n" \
2496 "proc on /proc type proc (rw)\n" \
2497 "devpts on /dev/pts type devpts (rw)\n" \
2498 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2499 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2500 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002501#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002502 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002503
Rob Landleyd00b3a52005-08-20 05:07:08 +00002504#define mountpoint_trivial_usage \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002505 "[-q] <[-dn] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002506#define mountpoint_full_usage "\n\n" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002507 "Check if the directory is a mountpoint\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002508 "\nOptions:" \
2509 "\n -q Quiet" \
2510 "\n -d Print major/minor device number of the filesystem" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002511 "\n -n Print device name of the filesystem" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002512 "\n -x Print major/minor device number of the blockdevice" \
2513
Rob Landleyd00b3a52005-08-20 05:07:08 +00002514#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002515 "$ mountpoint /proc\n" \
2516 "/proc is not a mountpoint\n" \
2517 "$ mountpoint /sys\n" \
2518 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002519
Eric Andersen7e9276b2001-02-22 01:15:47 +00002520#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002521 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002522#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002523 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002524 "\n" \
2525 "Available Opcodes:\n" \
2526 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002527 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2528 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2529 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002530 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002531
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002532#define nohup_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002533 "PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002534#define nohup_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002535 "Run PROG immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002536#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002537 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002538
Eric Andersen7e9276b2001-02-22 01:15:47 +00002539#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002540 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002541#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002542 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002543 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002544#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002545 "$ nslookup localhost\n" \
2546 "Server: default\n" \
2547 "Address: default\n" \
2548 "\n" \
2549 "Name: debian\n" \
2550 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002551
Adam Tkacb1585062009-11-22 03:43:55 +01002552#define ntpd_trivial_usage \
Leonid Lisovskiy894ef602010-10-20 22:36:51 +02002553 "[-dnqNw"IF_FEATURE_NTPD_SERVER("l")"] [-S PROG] [-p PEER]..."
Adam Tkacb1585062009-11-22 03:43:55 +01002554#define ntpd_full_usage "\n\n" \
2555 "NTP client/server\n" \
2556 "\nOptions:" \
2557 "\n -d Verbose" \
2558 "\n -n Do not daemonize" \
Denys Vlasenko8d580c72009-11-23 16:27:16 +01002559 "\n -q Quit after clock is set" \
Denys Vlasenkof03fc7d2010-08-11 05:15:52 +02002560 "\n -N Run at high priority" \
Denys Vlasenko074e8dc2010-01-04 23:58:13 +01002561 "\n -w Do not set time (only query peers), implies -n" \
Leonid Lisovskiy894ef602010-10-20 22:36:51 +02002562 IF_FEATURE_NTPD_SERVER( \
Adam Tkacb1585062009-11-22 03:43:55 +01002563 "\n -l Run as server on port 123" \
Leonid Lisovskiy894ef602010-10-20 22:36:51 +02002564 ) \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002565 "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins" \
Adam Tkacb1585062009-11-22 03:43:55 +01002566 "\n -p PEER Obtain time from PEER (may be repeated)" \
2567
Glenn L McGrath60281112001-11-02 11:39:46 +00002568#define od_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002569 "[-aBbcDdeFfHhIiLlOovXx] " IF_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002570#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002571 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002572 "(or stdin) to stdout"
Glenn L McGrath60281112001-11-02 11:39:46 +00002573
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002574#define openvt_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002575 "[-c N] [-sw] [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002576#define openvt_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002577 "Start PROG on a new virtual terminal\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00002578 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002579 "\n -c N Use specified VT" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00002580 "\n -s Switch to the VT" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002581/* "\n -l Run PROG as login shell (by prepending '-')" */ \
2582 "\n -w Wait for PROG to exit" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00002583
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002584#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002585 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002586
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002587/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00002588#define parse_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002589 "[-n MAXTOKENS] [-m MINTOKENS] [-d DELIMS] [-f FLAGS] FILE..."
2590#define parse_full_usage ""
2591*/
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00002592
Eric Andersen27f64e12002-06-23 04:24:25 +00002593#define passwd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002594 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002595#define passwd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002596 "Change USER's password. If no USER is specified,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002597 "changes the password for the current user.\n" \
2598 "\nOptions:" \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002599 "\n -a ALG Algorithm to use for password (des, md5)" /* ", sha1)" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002600 "\n -d Delete password for the account" \
2601 "\n -l Lock (disable) account" \
2602 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00002603
Denis Vlasenko21d10142007-07-20 21:28:41 +00002604#define chpasswd_trivial_usage \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02002605 IF_LONG_OPTS("[--md5|--encrypted]") IF_NOT_LONG_OPTS("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002606#define chpasswd_full_usage "\n\n" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02002607 "Read user:password from stdin and update /etc/passwd\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002608 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02002609 IF_LONG_OPTS( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00002610 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002611 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002612 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02002613 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002614 "\n -e Supplied passwords are in encrypted form" \
2615 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002616 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00002617
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002618#define pgrep_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02002619 "[-flnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002620#define pgrep_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002621 "Display process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002622 "\nOptions:" \
2623 "\n -l Show command name too" \
2624 "\n -f Match against entire command line" \
2625 "\n -n Show the newest process only" \
2626 "\n -o Show the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02002627 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002628 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02002629 "\n -s Match session ID (0 for current)" \
2630 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002631
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002632#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00002633#define pidof_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002634 "[OPTIONS] [NAME]..."
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002635#define USAGE_PIDOF "\n\nOptions:"
2636#else
2637#define pidof_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002638 "[NAME]..."
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002639#define USAGE_PIDOF /* none */
2640#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002641#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002642 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002643 USAGE_PIDOF \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002644 IF_FEATURE_PIDOF_SINGLE( \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002645 "\n -s Show only one PID" \
2646 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002647 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002648 "\n -o PID Omit given pid" \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002649 "\n Use %PPID to omit pid of pidof's parent" \
2650 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002651
Eric Andersen221b2ea2001-07-31 19:06:07 +00002652#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002653 "$ pidof init\n" \
2654 "1\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002655 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002656 "$ pidof /bin/sh\n20351 5973 5950\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002657 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002658 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002659
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002660#define pipe_progress_trivial_usage NOUSAGE_STR
2661#define pipe_progress_full_usage ""
2662
Eric Andersen7e9276b2001-02-22 01:15:47 +00002663#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002664 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002665#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002666 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002667 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002668
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002669#define pkill_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02002670 "[-l|-SIGNAL] [-fnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002671#define pkill_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002672 "Send a signal to process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002673 "\nOptions:" \
2674 "\n -l List all signals" \
2675 "\n -f Match against entire command line" \
2676 "\n -n Signal the newest process only" \
2677 "\n -o Signal the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02002678 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002679 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02002680 "\n -s Match session ID (0 for current)" \
2681 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002682
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002683#define popmaildir_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002684 "[OPTIONS] MAILDIR [CONN_HELPER ARGS]"
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002685#define popmaildir_full_usage "\n\n" \
2686 "Fetch content of remote mailbox to local maildir\n" \
2687 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002688/* "\n -b Binary mode. Ignored" */ \
2689/* "\n -d Debug. Ignored" */ \
2690/* "\n -m Show used memory. Ignored" */ \
2691/* "\n -V Show version. Ignored" */ \
2692/* "\n -c Use tcpclient. Ignored" */ \
2693/* "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002694 "\n -s Skip authorization" \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01002695 "\n -T Get messages with TOP instead of RETR" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002696 "\n -k Keep retrieved messages on the server" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002697 "\n -t SEC Network timeout" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002698 IF_FEATURE_POPMAILDIR_DELIVERY( \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01002699 "\n -F \"PROG ARGS\" Filter program (may be repeated)" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002700 "\n -M \"PROG ARGS\" Delivery program" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002701 ) \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01002702 "\n" \
2703 "\nFetch from plain POP3 server:" \
2704 "\npopmaildir -k DIR nc pop3.server.com 110 <user_and_pass.txt" \
2705 "\nFetch from SSLed POP3 server and delete fetched emails:" \
2706 "\npopmaildir DIR -- openssl s_client -quiet -connect pop3.server.com:995 <user_and_pass.txt"
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002707/* "\n -R BYTES Remove old messages on the server >= BYTES. Ignored" */
2708/* "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" */
2709/* "\n -L BYTES Don't retrieve new messages >= BYTES. Ignored" */
2710/* "\n -H LINES Type first LINES of a message. Ignored" */
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002711#define popmaildir_example_usage \
2712 "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n" \
2713 "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
2714
Mike Frysinger95d3c452005-04-21 23:29:24 +00002715#define printenv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002716 "[VARIABLE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002717#define printenv_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002718 "Print environment VARIABLEs.\n" \
2719 "If no VARIABLE specified, print all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00002720
Eric Andersen7e9276b2001-02-22 01:15:47 +00002721#define printf_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002722 "FORMAT [ARGUMENT]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002723#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002724 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002725 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002726#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002727 "$ printf \"Val=%d\\n\" 5\n" \
2728 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002729
Denis Vlasenko94949192006-11-05 00:45:47 +00002730
2731#if ENABLE_DESKTOP
2732
2733#define ps_trivial_usage \
Denys Vlasenko9e072192010-05-23 00:34:42 +02002734 "[-o COL1,COL2=HEADER]" IF_FEATURE_SHOW_THREADS(" [-T]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002735#define ps_full_usage "\n\n" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02002736 "Show list of processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002737 "\nOptions:" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02002738 "\n -o COL1,COL2=HEADER Select columns for display" \
Denys Vlasenko532609e2009-09-20 20:29:25 +02002739 IF_FEATURE_SHOW_THREADS( \
2740 "\n -T Show threads" \
2741 )
Denis Vlasenko94949192006-11-05 00:45:47 +00002742
2743#else /* !ENABLE_DESKTOP */
2744
Denis Vlasenko397de612008-03-17 08:55:44 +00002745#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002746#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00002747#else
2748#define USAGE_PS "\nOptions:"
2749#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002750
Eric Andersen7e9276b2001-02-22 01:15:47 +00002751#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002752 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002753#define ps_full_usage "\n\n" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02002754 "Show list of processes\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002755 USAGE_PS \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002756 IF_SELINUX( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01002757 "\n -Z Show selinux context" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002758 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002759 IF_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002760 "\n w Wide output" \
2761 )
Rob Landley6eb1e412005-06-20 04:30:36 +00002762
Denis Vlasenko94949192006-11-05 00:45:47 +00002763#endif /* ENABLE_DESKTOP */
2764
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002765#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002766 "$ ps\n" \
2767 " PID Uid Gid State Command\n" \
2768 " 1 root root S init\n" \
2769 " 2 root root S [kflushd]\n" \
2770 " 3 root root S [kupdate]\n" \
2771 " 4 root root S [kpiod]\n" \
2772 " 5 root root S [kswapd]\n" \
2773 " 742 andersen andersen S [bash]\n" \
2774 " 743 andersen andersen S -bash\n" \
2775 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00002776 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002777
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00002778#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00002779 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002780#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002781 "Scan a host, print all open ports\n" \
2782 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00002783 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00002784 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00002785 "\n -p Scan from this port (default 1)" \
2786 "\n -P Scan up to this port (default 1024)" \
2787 "\n -t Timeout (default 5000 ms)" \
2788 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
2789
Eric Andersen7e9276b2001-02-22 01:15:47 +00002790#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002791 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002792#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002793 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002794#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002795 "$ pwd\n" \
2796 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002797
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002798#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002799 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002800#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002801 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002802#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002803 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002804
Eric Andersen7e9276b2001-02-22 01:15:47 +00002805#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002806 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002807#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002808 "Get and possibly set the system date and time from a remote HOST\n" \
2809 "\nOptions:" \
2810 "\n -s Set the system date and time (default)" \
2811 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002812
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00002813#define rdev_trivial_usage \
2814 ""
2815#define rdev_full_usage "\n\n" \
2816 "Print the device node associated with the filesystem mounted at '/'"
2817#define rdev_example_usage \
2818 "$ rdev\n" \
2819 "/dev/mtdblock9 /\n"
2820
Rob Landley0e4690d2006-08-20 22:12:18 +00002821#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002822 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002823#define readahead_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02002824 "Preload FILEs to RAM"
Rob Landley0e4690d2006-08-20 22:12:18 +00002825
Eric Andersen7e9276b2001-02-22 01:15:47 +00002826#define readlink_trivial_usage \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02002827 IF_FEATURE_READLINK_FOLLOW("[-fnv] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002828#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00002829 "Display the value of a symlink" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002830 IF_FEATURE_READLINK_FOLLOW( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002831 "\nOptions:" \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02002832 "\n -f Canonicalize by following all symlinks" \
2833 "\n -n Don't add newline" \
2834 "\n -v Verbose" \
2835 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002836
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002837#define readprofile_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002838 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002839#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002840 "Options:" \
2841 "\n -m mapfile (Default: /boot/System.map)" \
2842 "\n -p profile (Default: /proc/profile)" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01002843 "\n -M NUM Set the profiling multiplier to NUM" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002844 "\n -i Print only info about the sampling step" \
2845 "\n -v Verbose" \
2846 "\n -a Print all symbols, even if count is 0" \
2847 "\n -b Print individual histogram-bin counts" \
2848 "\n -s Print individual counters within functions" \
2849 "\n -r Reset all the counters (root only)" \
2850 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002851
Glenn L McGrath62fae302002-12-10 00:14:33 +00002852#define realpath_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002853 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002854#define realpath_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002855 "Return the absolute pathnames of given FILE"
Tim Riker7b253f82003-12-28 05:02:40 +00002856
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002857#define reformime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002858 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002859#define reformime_full_usage "\n\n" \
2860 "Parse MIME-encoded message\n" \
2861 "\nOptions:" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002862 "\n -x PREFIX Extract content of MIME sections to files" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002863 "\n -X PROG ARGS Filter content of MIME sections through PROG" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002864 "\n Must be the last option" \
2865 "\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002866 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002867
Denys Vlasenko5e611152009-05-19 17:36:16 +02002868#define scriptreplay_trivial_usage \
2869 "timingfile [typescript [divisor]]"
2870#define scriptreplay_full_usage "\n\n" \
2871 "Play back typescripts, using timing information"
2872
Eric Andersen7e9276b2001-02-22 01:15:47 +00002873#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002874 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002875#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002876 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002877
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002878#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002879 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002880#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002881 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002882
Denis Vlasenko397137b2007-07-23 14:03:30 +00002883#define restorecon_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01002884 "[-iFnRv] [-e EXCLUDEDIR]... [-o FILE] [-f FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002885#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00002886 "Reset security contexts of files in pathname\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01002887 "\n -i Ignore files that don't exist" \
2888 "\n -f FILE File with list of files to process" \
2889 "\n -e DIR Directory to exclude" \
2890 "\n -R,-r Recurse" \
2891 "\n -n Don't change any file labels" \
2892 "\n -o FILE Save list of files with incorrect context" \
2893 "\n -v Verbose" \
2894 "\n -vv Show changed labels" \
2895 "\n -F Force reset of context to match file_context" \
2896 "\n for customizable files, or the user section," \
2897 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00002898
Souf Oued43afd752010-05-02 18:45:02 +02002899#define rfkill_trivial_usage \
2900 "COMMAND [INDEX|TYPE]"
2901#define rfkill_full_usage "\n\n" \
2902 "Enable/disable wireless devices\n" \
2903 "\nCommands:" \
2904 "\n list [INDEX|TYPE] List current state" \
2905 "\n block INDEX|TYPE Disable device" \
2906 "\n unblock INDEX|TYPE Enable device" \
2907 "\n" \
2908 "\n TYPE: all, wlan(wifi), bluetooth, uwb(ultrawideband)," \
2909 "\n wimax, wwan, gps, fm" \
2910
Eric Andersen7e9276b2001-02-22 01:15:47 +00002911#define rm_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02002912 "[-irf] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002913#define rm_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02002914 "Remove (unlink) FILEs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002915 "\nOptions:" \
2916 "\n -i Always prompt before removing" \
2917 "\n -f Never prompt" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002918 "\n -R,-r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002919
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002920#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002921 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002922
Eric Andersen7e9276b2001-02-22 01:15:47 +00002923#define rmdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002924 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002925#define rmdir_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002926 "Remove DIRECTORY if it is empty\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00002927 "\nOptions:" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02002928 IF_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00002929 "\n -p|--parents Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02002930 "\n --ignore-fail-on-non-empty" \
2931 ) \
2932 IF_NOT_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00002933 "\n -p Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02002934 )
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00002935
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002936#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002937 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002938
Eric Andersen7e9276b2001-02-22 01:15:47 +00002939#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002940 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002941#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00002942 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002943 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00002944 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002945 "\n -e Display other/more information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002946 "\n -A inet" IF_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002947
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002948#define rpm_trivial_usage \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02002949 "-i PACKAGE.rpm; rpm -qp[ildc] PACKAGE.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002950#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002951 "Manipulate RPM packages\n" \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02002952 "\nCommands:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002953 "\n -i Install package" \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02002954 "\n -qp Query package" \
2955 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002956 "\n -i Show information" \
2957 "\n -l List contents" \
2958 "\n -d List documents" \
2959 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002960
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002961#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002962 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002963#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002964 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002965
Mike Frysinger6b160e42008-02-15 02:27:19 +00002966#define rtcwake_trivial_usage \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00002967 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SEC | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002968#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002969 "Enter a system sleep state until specified wakeup time\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02002970 IF_LONG_OPTS( \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00002971 "\n -a,--auto Read clock mode from adjtime" \
2972 "\n -l,--local Clock is set to local time" \
2973 "\n -u,--utc Clock is set to UTC time" \
2974 "\n -d,--device=DEV Specify the RTC device" \
2975 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002976 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00002977 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00002978 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02002979 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002980 "\n -a Read clock mode from adjtime" \
2981 "\n -l Clock is set to local time" \
2982 "\n -u Clock is set to UTC time" \
2983 "\n -d DEV Specify the RTC device" \
2984 "\n -m MODE Set the sleep state (default: standby)" \
2985 "\n -s SEC Set the timeout in SEC seconds from now" \
2986 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00002987 )
2988
Denis Vlasenko49622d72007-03-10 16:58:49 +00002989#define runcon_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002990 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] PROG ARGS\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01002991 "runcon CONTEXT PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002992#define runcon_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002993 "Run PROG in a different security context\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002994 "\n CONTEXT Complete security context\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002995 IF_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002996 "\n -c,--compute Compute process transition context before modifying" \
2997 "\n -t,--type=TYPE Type (for same role as parent)" \
2998 "\n -u,--user=USER User identity" \
2999 "\n -r,--role=ROLE Role" \
3000 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003001 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003002 IF_NOT_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003003 "\n -c Compute process transition context before modifying" \
3004 "\n -t TYPE Type (for same role as parent)" \
3005 "\n -u USER User identity" \
3006 "\n -r ROLE Role" \
3007 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003008 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003009
Eric Andersen6cf47a72001-10-31 10:24:36 +00003010#define run_parts_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003011 "[-t] "IF_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003012#define run_parts_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003013 "Run a bunch of scripts in DIRECTORY\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003014 "\nOptions:" \
3015 "\n -t Print what would be run, but don't actually run anything" \
3016 "\n -a ARG Pass ARG as argument for every program" \
3017 "\n -u MASK Set the umask to MASK before running every program" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003018 IF_FEATURE_RUN_PARTS_FANCY( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003019 "\n -l Print names of all matching files even if they are not executable" \
3020 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003021
3022#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003023 "$ run-parts -a start /etc/init.d\n" \
3024 "$ run-parts -a stop=now /etc/init.d\n\n" \
3025 "Let's assume you have a script foo/dosomething:\n" \
3026 "#!/bin/sh\n" \
3027 "for i in $*; do eval $i; done; unset i\n" \
3028 "case \"$1\" in\n" \
3029 "start*) echo starting something;;\n" \
3030 "stop*) set -x; shutdown -h $stop;;\n" \
3031 "esac\n\n" \
3032 "Running this yields:\n" \
3033 "$run-parts -a stop=+4m foo/\n" \
3034 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003035
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003036#define runlevel_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003037 "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003038#define runlevel_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003039 "Find the current and previous system runlevel\n" \
3040 "\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003041 "If no utmp FILE exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003042 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003043#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003044 "$ runlevel /var/run/utmp\n" \
3045 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003046
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003047#define runsv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003048 "DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003049#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003050 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003051
3052#define runsvdir_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003053 "[-P] [-s SCRIPT] DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003054#define runsvdir_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003055 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
3056 "\n -P Put each runsv in a new session" \
3057 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003058
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003059#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003060 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003061#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003062 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003063#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003064 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003065
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003066#define script_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003067 "[-afq" IF_SCRIPTREPLAY("t") "] [-c PROG] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003068#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003069 "Options:" \
3070 "\n -a Append output" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003071 "\n -c PROG Run PROG, not shell" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003072 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003073 "\n -q Quiet" \
Denys Vlasenko5e611152009-05-19 17:36:16 +02003074 IF_SCRIPTREPLAY( \
3075 "\n -t Send timing to stderr" \
3076 )
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003077
Eric Andersen7e9276b2001-02-22 01:15:47 +00003078#define sed_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003079 "[-efinr] SED_CMD [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003080#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003081 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003082 "\n -e CMD Add CMD to sed commands to be executed" \
3083 "\n -f FILE Add FILE contents to sed commands to be executed" \
Denys Vlasenkodac863a2009-10-27 09:11:17 +01003084 "\n -i Edit files in-place (else sends result to stdout)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003085 "\n -n Suppress automatic printing of pattern space" \
3086 "\n -r Use extended regex syntax" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003087 "\n" \
Rob Landley7b284152009-10-26 16:04:07 -05003088 "\nIf no -e or -f, the first non-option argument is the sed command string." \
3089 "\nRemaining arguments are input files (stdin if none)."
Eric Andersenf802ff72004-04-12 15:12:06 +00003090
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003091#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003092 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3093 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003094
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003095#define selinuxenabled_trivial_usage NOUSAGE_STR
3096#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003097
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003098#define seq_trivial_usage \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003099 "[-w] [-s SEP] [FIRST [INC]] LAST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003100#define seq_full_usage "\n\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003101 "Print numbers from FIRST to LAST, in steps of INC.\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003102 "FIRST, INC default to 1.\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003103 "\nOptions:" \
3104 "\n -w Pad to last with leading zeros" \
3105 "\n -s SEP String separator" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003106
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003107#define sestatus_trivial_usage \
3108 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003109#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003110 " -v Verbose" \
3111 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003112
Paul Foxfc2256a2005-08-01 18:12:30 +00003113#define setconsole_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003114 "[-r" IF_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003115#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003116 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3117 "\nOptions:" \
3118 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003119
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003120#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003121 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003122#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003123
Denis Vlasenko397137b2007-07-23 14:03:30 +00003124#define setfiles_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003125 "[-dnpqsvW] [-e DIR]... [-o FILE] [-r alt_root_path]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003126 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003127 " [-c policyfile] spec_file" \
3128 ) \
3129 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003130#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003131 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003132 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003133 "\n -c FILE Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003134 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003135 "\n -d Show which specification matched each file" \
3136 "\n -l Log changes in file labels to syslog" \
3137 "\n -n Don't change any file labels" \
3138 "\n -q Suppress warnings" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003139 "\n -r DIR Use an alternate root path" \
3140 "\n -e DIR Exclude DIR" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003141 "\n -F Force reset of context to match file_context for customizable files" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003142 "\n -o FILE Save list of files with incorrect context" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003143 "\n -s Take a list of files from stdin (instead of command line)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003144 "\n -v Show changes in file labels, if type or role are changing" \
3145 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3146 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003147
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003148#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003149 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003150#define setfont_full_usage "\n\n" \
3151 "Load a console font\n" \
3152 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003153 "\n -m MAPFILE Load console screen map" \
3154 "\n -C TTY Affect TTY instead of /dev/tty" \
3155
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003156#define setfont_example_usage \
3157 "$ setfont -m koi8-r /etc/i18n/fontname\n"
3158
Eric Andersen7e9276b2001-02-22 01:15:47 +00003159#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003160 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003161#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003162 "Set entries into the kernel's scancode-to-keycode map,\n" \
3163 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3164 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003165 "and KEYCODE is given in decimal." \
Denis Vlasenko397de612008-03-17 08:55:44 +00003166
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003167#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003168 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003169
Rob Landley87848d92006-03-27 23:23:43 +00003170#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003171 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003172#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003173 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003174
Denis Vlasenkobe039372007-10-14 04:48:44 +00003175#define setsebool_trivial_usage \
3176 "boolean value"
3177
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003178#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00003179 "Change boolean setting"
3180
Paul Fox42403642005-08-01 22:52:09 +00003181#define setsid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003182 "PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003183#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003184 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3185 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3186 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003187
Eric Andersen2e9c2572003-08-08 22:26:06 +00003188#define last_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003189 ""IF_FEATURE_LAST_FANCY("[-HW] [-f FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003190#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003191 "Show listing of the last users that logged into the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003192 IF_FEATURE_LAST_FANCY( "\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003193 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00003194/* "\n -H Show header line" */ \
3195 "\n -W Display with no host column truncation" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003196 "\n -f FILE Read from FILE instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003197 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00003198
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00003199#define showkey_trivial_usage \
3200 "[-a | -k | -s]"
3201#define showkey_full_usage "\n\n" \
3202 "Show keys pressed\n" \
3203 "\nOptions:" \
3204 "\n -a Display decimal/octal/hex values of the keys" \
3205 "\n -k Display interpreted keycodes (default)" \
3206 "\n -s Display raw scan-codes" \
3207
Denis Vlasenko14923db2007-06-20 15:23:03 +00003208#define slattach_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003209 "[-cehmLF] [-s SPEED] [-p PROTOCOL] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003210#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003211 "Attach network interface(s) to serial line(s)\n" \
3212 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003213 "\n -p PROT Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3214 "\n -s SPD Set line speed" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003215 "\n -e Exit after initializing device" \
3216 "\n -h Exit when the carrier is lost" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003217 "\n -c PROG Run PROG when the line is hung up" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003218 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3219 "\n -L Enable 3-wire operation" \
3220 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003221
Eric Andersen7e9276b2001-02-22 01:15:47 +00003222#define sleep_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003223 IF_FEATURE_FANCY_SLEEP("[") "N" IF_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003224#define sleep_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003225 IF_NOT_FEATURE_FANCY_SLEEP("Pause for N seconds") \
3226 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003227 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003228 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003229#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003230 "$ sleep 2\n" \
3231 "[2 second delay results]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003232 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003233 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003234 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003235
Eric Andersen7e9276b2001-02-22 01:15:47 +00003236#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003237 "[-nru" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003238 IF_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003239 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003240#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003241 "Sort lines of text\n" \
3242 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003243 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003244 "\n -b Ignore leading blanks" \
3245 "\n -c Check whether input is sorted" \
3246 "\n -d Dictionary order (blank or alphanumeric only)" \
3247 "\n -f Ignore case" \
3248 "\n -g General numerical sort" \
3249 "\n -i Ignore unprintable characters" \
3250 "\n -k Sort key" \
3251 "\n -M Sort month" \
3252 ) \
3253 "\n -n Sort numbers" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003254 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003255 "\n -o Output to file" \
3256 "\n -k Sort by key" \
3257 "\n -t CHAR Key separator" \
3258 ) \
3259 "\n -r Reverse sort order" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003260 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003261 "\n -s Stable (don't sort ties alphabetically)" \
3262 ) \
3263 "\n -u Suppress duplicate lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003264 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003265 "\n -z Lines are terminated by NUL, not newline" \
3266 "\n -mST Ignored for GNU compatibility") \
3267
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003268#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003269 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3270 "a\n" \
3271 "b\n" \
3272 "c\n" \
3273 "d\n" \
3274 "e\n" \
3275 "f\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003276 IF_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003277 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3278 "d 2\n" \
3279 "b 2\n" \
3280 "c 3\n" \
3281 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003282 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003283
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003284#define split_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003285 "[OPTIONS] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003286#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003287 "Options:" \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02003288 "\n -b N[k|m] Split by N (kilo|mega)bytes" \
3289 "\n -l N Split by N lines" \
3290 "\n -a N Use N letters as suffix" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003291
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003292#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003293 "$ split TODO foo\n" \
3294 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003295
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003296#define start_stop_daemon_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003297 "[OPTIONS] [-S|-K] ... [-- ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003298#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003299 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003300 "-K: stop all matching processes.\n" \
3301 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003302 IF_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003303 "\nProcess matching:" \
3304 "\n -u,--user USERNAME|UID Match only this user's processes" \
3305 "\n -n,--name NAME Match processes with NAME" \
3306 "\n in comm field in /proc/PID/stat" \
3307 "\n -x,--exec EXECUTABLE Match processes with this command" \
3308 "\n in /proc/PID/cmdline" \
3309 "\n -p,--pidfile FILE Match a process with PID from the file" \
3310 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003311 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003312 "\n -x,--exec EXECUTABLE Program to run" \
3313 "\n -a,--startas NAME Zeroth argument" \
3314 "\n -b,--background Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003315 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003316 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003317 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003318 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
3319 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003320 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003321 "\n -s,--signal SIG Signal to send" \
3322 "\n -t,--test Match only, exit with 0 if a process is found" \
3323 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003324 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003325 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003326 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003327 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003328 "\n -q,--quiet Quiet" \
3329 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003330 IF_NOT_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003331 "\nProcess matching:" \
3332 "\n -u USERNAME|UID Match only this user's processes" \
3333 "\n -n NAME Match processes with NAME" \
3334 "\n in comm field in /proc/PID/stat" \
3335 "\n -x EXECUTABLE Match processes with this command" \
3336 "\n command in /proc/PID/cmdline" \
3337 "\n -p FILE Match a process with PID from the file" \
3338 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003339 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003340 "\n -x EXECUTABLE Program to run" \
3341 "\n -a NAME Zeroth argument" \
3342 "\n -b Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003343 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003344 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003345 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003346 "\n -c USER[:[GRP]] Change to user/group" \
3347 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003348 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003349 "\n -s SIG Signal to send" \
3350 "\n -t Match only, exit with 0 if a process is found" \
3351 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003352 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003353 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003354 "\n -v Verbose" \
3355 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003356 "\n -q Quiet" \
3357 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003358
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003359#define stat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003360 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003361#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003362 "Display file (default) or filesystem status\n" \
3363 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003364 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003365 "\n -c fmt Use the specified format" \
3366 ) \
3367 "\n -f Display filesystem status" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003368 "\n -L Follow links" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003369 "\n -t Display info in terse form" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003370 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003371 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003372 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003373 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003374 "\n\nValid format sequences for files:\n" \
3375 " %a Access rights in octal\n" \
3376 " %A Access rights in human readable form\n" \
3377 " %b Number of blocks allocated (see %B)\n" \
3378 " %B The size in bytes of each block reported by %b\n" \
3379 " %d Device number in decimal\n" \
3380 " %D Device number in hex\n" \
3381 " %f Raw mode in hex\n" \
3382 " %F File type\n" \
3383 " %g Group ID of owner\n" \
3384 " %G Group name of owner\n" \
3385 " %h Number of hard links\n" \
3386 " %i Inode number\n" \
3387 " %n File name\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003388 " %N File name, with -> TARGET if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003389 " %o I/O block size\n" \
3390 " %s Total size, in bytes\n" \
3391 " %t Major device type in hex\n" \
3392 " %T Minor device type in hex\n" \
3393 " %u User ID of owner\n" \
3394 " %U User name of owner\n" \
3395 " %x Time of last access\n" \
3396 " %X Time of last access as seconds since Epoch\n" \
3397 " %y Time of last modification\n" \
3398 " %Y Time of last modification as seconds since Epoch\n" \
3399 " %z Time of last change\n" \
3400 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003401 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003402 " %a Free blocks available to non-superuser\n" \
3403 " %b Total data blocks in file system\n" \
3404 " %c Total file nodes in file system\n" \
3405 " %d Free file nodes in file system\n" \
3406 " %f Free blocks in file system\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003407 IF_SELINUX( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003408 " %C Security context in selinux\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003409 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003410 " %i File System ID in hex\n" \
3411 " %l Maximum length of filenames\n" \
3412 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003413 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003414 " %S Fundamental block size (for block counts)\n" \
3415 " %t Type in hex\n" \
3416 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003417 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003418
Eric Andersenef5e8f82002-11-07 02:09:37 +00003419#define strings_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003420 "[-afo] [-n LEN] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003421#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003422 "Display printable strings in a binary file\n" \
3423 "\nOptions:" \
3424 "\n -a Scan whole file (default)" \
3425 "\n -f Precede strings with filenames" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003426 "\n -n LEN At least LEN characters form a string (default 4)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003427 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00003428
Eric Andersen7e9276b2001-02-22 01:15:47 +00003429#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003430 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003431#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003432 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003433 "and deviations from stty sane\n" \
3434 "\nOptions:" \
3435 "\n -F DEVICE Open device instead of stdin" \
3436 "\n -a Print all current settings in human-readable form" \
3437 "\n -g Print in stty-readable form" \
3438 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003439
Eric Andersen27f64e12002-06-23 04:24:25 +00003440#define sulogin_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003441 "[-t N] [TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003442#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003443 "Single user login\n" \
3444 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003445 "\n -t N Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003446
Mike Frysinger95d3c452005-04-21 23:29:24 +00003447#define sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003448 "[-rs] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003449#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003450 "Checksum and count the blocks in a file\n" \
3451 "\nOptions:" \
3452 "\n -r Use BSD sum algorithm (1K blocks)" \
3453 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00003454
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003455#define sv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003456 "[-v] [-w SEC] CMD SERVICE_DIR..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003457#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003458 "Control services monitored by runsv supervisor.\n" \
3459 "Commands (only first character is enough):\n" \
3460 "\n" \
3461 "status: query service status\n" \
3462 "up: if service isn't running, start it. If service stops, restart it\n" \
3463 "once: like 'up', but if service stops, don't restart it\n" \
3464 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02003465 " if it exists. After it stops, don't restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003466 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003467 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003468 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003469 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003470
Eric Andersen7e9276b2001-02-22 01:15:47 +00003471#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003472 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003473#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003474 "Stop swapping on DEVICE\n" \
3475 "\nOptions:" \
3476 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003477
Eric Andersen7e9276b2001-02-22 01:15:47 +00003478#define swapon_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003479 "[-a]" IF_FEATURE_SWAPON_PRI(" [-p PRI]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003480#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003481 "Start swapping on DEVICE\n" \
3482 "\nOptions:" \
3483 "\n -a Start swapping on all swap devices" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003484 IF_FEATURE_SWAPON_PRI( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003485 "\n -p PRI Set swap device priority" \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00003486 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003487
Rob Landley0f34a822005-10-27 22:55:50 +00003488#define switch_root_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003489 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003490#define switch_root_full_usage "\n\n" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00003491 "Free initramfs and switch to another root fs:\n" \
3492 "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n" \
3493 "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003494 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00003495 "\n -c DEV Reopen stdio to DEV after switch" \
Rob Landley0f34a822005-10-27 22:55:50 +00003496
Eric Andersen7e9276b2001-02-22 01:15:47 +00003497#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003498 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003499#define sync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02003500 "Write all buffered blocks to disk"
3501
3502#define fsync_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02003503 "[-d] FILE..."
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003504#define fsync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02003505 "Write files' buffered blocks to disk\n" \
3506 "\nOptions:" \
3507 "\n -d Avoid syncing metadata"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003508
Eric Andersenb9050282003-12-24 06:02:11 +00003509#define sysctl_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003510 "[OPTIONS] [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003511#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003512 "Configure kernel parameters at runtime\n" \
3513 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00003514 "\n -n Don't print key names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003515 "\n -e Don't warn about unknown keys" \
3516 "\n -w Change sysctl setting" \
3517 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
3518 "\n -a Display all values" \
3519 "\n -A Display all values in table form" \
3520
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003521#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00003522 "sysctl [-n] [-e] variable...\n" \
3523 "sysctl [-n] [-e] -w variable=value...\n" \
3524 "sysctl [-n] [-e] -a\n" \
3525 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
3526 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003527
Eric Andersen7e9276b2001-02-22 01:15:47 +00003528#define syslogd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003529 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003530#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003531 "System logging utility.\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003532 "This version of syslogd ignores /etc/syslog.conf\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003533 "\nOptions:" \
3534 "\n -n Run in foreground" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003535 "\n -O FILE Log to given file (default:/var/log/messages)" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003536 "\n -l N Set local log level" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003537 "\n -S Smaller logging output" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003538 IF_FEATURE_ROTATE_LOGFILE( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003539 "\n -s SIZE Max size (KB) before rotate (default:200KB, 0=off)" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003540 "\n -b N N rotated logs to keep (default:1, max=99, 0=purge)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003541 IF_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003542 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
3543 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003544 IF_FEATURE_SYSLOGD_DUP( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003545 "\n -D Drop duplicates") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003546 IF_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003547 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00003548 /* NB: -Csize shouldn't have space (because size is optional) */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003549/* "\n -m MIN Minutes between MARK lines (default:20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00003550
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003551#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003552 "$ syslogd -R masterlog:514\n" \
3553 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003554
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003555#define tac_trivial_usage \
3556 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003557#define tac_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003558 "Concatenate FILEs and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003559
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003560#define taskset_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003561 "[-p] [MASK] [PID | PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003562#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003563 "Set or get CPU affinity\n" \
3564 "\nOptions:" \
3565 "\n -p Operate on an existing PID" \
3566
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003567#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003568 "$ taskset 0x7 ./dgemm_test&\n" \
3569 "$ taskset -p 0x1 $!\n" \
3570 "pid 4790's current affinity mask: 7\n" \
3571 "pid 4790's new affinity mask: 1\n" \
3572 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
3573 "pid 6671's current affinity mask: 1\n" \
3574 "pid 6671's new affinity mask: 1\n" \
3575 "$ taskset -p 1\n" \
3576 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003577
Eric Andersen7e9276b2001-02-22 01:15:47 +00003578#define tee_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02003579 "[-ai] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003580#define tee_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003581 "Copy stdin to each FILE, and also to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003582 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02003583 "\n -a Append to the given FILEs, don't overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003584 "\n -i Ignore interrupt signals (SIGINT)" \
3585
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003586#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003587 "$ echo \"Hello\" | tee /tmp/foo\n" \
3588 "$ cat /tmp/foo\n" \
3589 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003590
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003591#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00003592#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003593 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003594#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003595 "Connect to telnet server\n" \
3596 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00003597 "\n -a Automatic login with $USER variable" \
3598 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003599
Eric Andersen539ffc92004-02-22 12:25:47 +00003600#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003601#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003602 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003603#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003604 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00003605#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003606
Eric Andersen08a72202002-09-30 20:52:10 +00003607#define telnetd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003608 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003609#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003610 "Handle incoming telnet connections" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003611 IF_NOT_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003612 "\nOptions:" \
3613 "\n -l LOGIN Exec LOGIN on connect" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02003614 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003615 "\n -K Close connection as soon as login exits" \
3616 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003617 IF_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003618 "\n -p PORT Port to listen on" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02003619 "\n -b ADDR[:PORT] Address to bind to" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003620 "\n -F Run in foreground" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003621 "\n -i Inetd mode" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02003622 IF_FEATURE_TELNETD_INETD_WAIT( \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003623 "\n -w SEC Inetd 'wait' mode, linger time SEC" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02003624 "\n -S Log to syslog (implied by -i or without -F and -w)" \
3625 ) \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003626 )
Eric Andersen08a72202002-09-30 20:52:10 +00003627
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00003628/* "test --help" does not print help (POSIX compat), only "[ --help" does.
Denys Vlasenko662078f2010-01-14 13:27:34 +01003629 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION")
3630 * Unfortunately, it screws up generated BusyBox.html. TODO. */
Eric Andersen7e9276b2001-02-22 01:15:47 +00003631#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00003632 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003633#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00003634 "Check file types, compare values etc. Return a 0/1 exit code\n" \
3635 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003636#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003637 "$ test 1 -eq 2\n" \
3638 "$ echo $?\n" \
3639 "1\n" \
3640 "$ test 1 -eq 1\n" \
3641 "$ echo $?\n" \
3642 "0\n" \
3643 "$ [ -d /etc ]\n" \
3644 "$ echo $?\n" \
3645 "0\n" \
3646 "$ [ -d /junk ]\n" \
3647 "$ echo $?\n" \
3648 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003649
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00003650#define tc_trivial_usage \
3651 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
3652#define tc_full_usage "\n\n" \
3653 "OBJECT: {qdisc|class|filter}\n" \
3654 "CMD: {add|del|change|replace|show}\n" \
3655 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003656 "qdisc [ handle QHANDLE ] [ root |"IF_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00003657 /* "[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
3658 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
3659 " QDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003660 "qdisc show [ dev STRING ]"IF_FEATURE_TC_INGRESS(" [ingress]")"\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00003661 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00003662 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00003663 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
3664 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
3665 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
Denis Vlasenko71c16572009-04-26 01:08:51 +00003666 " [ root | classid CLASSID ] [ handle FILTERID ]\n" \
3667 " [ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00003668 "filter show [ dev STRING ] [ root | parent CLASSID ]"
3669
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003670#define tcpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003671 "[-hEv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003672/* with not-implemented options: */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003673/* "[-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 +00003674#define tcpsvd_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003675 "Create TCP socket, bind to IP:PORT and listen\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003676 "for incoming connection. Run PROG for each connection.\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003677 "\n IP IP to listen on. '0' = all" \
3678 "\n PORT Port to listen on" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003679 "\n PROG ARGS Program to run" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003680 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
3681 "\n -u USER[:GRP] Change to user/group after bind" \
3682 "\n -c N Handle up to N connections simultaneously" \
3683 "\n -b N Allow a backlog of approximately N TCP SYNs" \
Denys Vlasenkoc1e30272010-10-08 15:04:23 +02003684 "\n -C N[:MSG] Allow only up to N connections from the same IP." \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003685 "\n New connections from this IP address are closed" \
3686 "\n immediately. MSG is written to the peer before close" \
3687 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02003688 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003689 "\n -v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003690
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003691#define udpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003692 "[-hEv] [-c N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003693#define udpsvd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003694 "Create UDP socket, bind to IP:PORT and wait\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003695 "for incoming packets. Run PROG for each packet,\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003696 "redirecting all further packets with same peer ip:port to it.\n" \
3697 "\n IP IP to listen on. '0' = all" \
3698 "\n PORT Port to listen on" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003699 "\n PROG ARGS Program to run" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003700 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
3701 "\n -u USER[:GRP] Change to user/group after bind" \
3702 "\n -c N Handle up to N connections simultaneously" \
3703 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02003704 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003705 "\n -v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003706
Mark Whitley450736c2001-03-02 19:08:50 +00003707#define tftp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003708 "[OPTIONS] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003709#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00003710 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003711 "\nOptions:" \
3712 "\n -l FILE Local FILE" \
3713 "\n -r FILE Remote FILE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003714 IF_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003715 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003716 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003717 IF_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003718 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00003719 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003720 IF_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003721 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00003722 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00003723
3724#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00003725 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003726#define tftpd_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003727 "Transfer a file on tftp client's request\n" \
Denis Vlasenko91f8f822008-10-30 23:42:37 +00003728 "\n" \
3729 "tftpd should be used as an inetd service.\n" \
3730 "tftpd's line for inetd.conf:\n" \
3731 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
3732 "It also can be ran from udpsvd:\n" \
3733 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00003734 "\nOptions:" \
3735 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00003736 "\n -c Allow file creation via upload" \
3737 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00003738
Eric Andersenc3657422001-11-30 07:54:32 +00003739#define time_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02003740 "[-v] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003741#define time_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003742 "Run PROG, display resource usage when it exits\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003743 "\nOptions:" \
3744 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00003745
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00003746#define timeout_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003747 "[-t SECS] [-s SIG] PROG ARGS"
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00003748#define timeout_full_usage "\n\n" \
3749 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
Denis Vlasenko42404082008-11-24 13:42:24 +00003750 "Defaults: SECS: 10, SIG: TERM." \
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00003751
Eric Andersen7e9276b2001-02-22 01:15:47 +00003752#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003753 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003754#define tr_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003755 "Translate, squeeze, or delete characters from stdin, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003756 "\nOptions:" \
3757 "\n -c Take complement of STRING1" \
3758 "\n -d Delete input characters coded STRING1" \
3759 "\n -s Squeeze multiple output characters of STRING2 into one character" \
3760
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003761#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003762 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
3763 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003764
Eric Andersen5c58d282001-07-10 16:29:00 +00003765#define traceroute_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003766 "[-"IF_TRACEROUTE6("46")"FIldnrv] [-f 1ST_TTL] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
3767 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-g GATEWAY] [-i IFACE]\n" \
3768 " [-z PAUSE_MSEC] HOST [BYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003769#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003770 "Trace the route to HOST\n" \
3771 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003772 IF_TRACEROUTE6( \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02003773 "\n -4,-6 Force IP or IPv6 name resolution" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003774 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003775 "\n -F Set the don't fragment bit" \
3776 "\n -I Use ICMP ECHO instead of UDP datagrams" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01003777 "\n -l Display the TTL value of the returned packet" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003778 "\n -d Set SO_DEBUG options to socket" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01003779 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003780 "\n -r Bypass routing tables, send directly to HOST" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003781 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003782 "\n -m Max time-to-live (max number of hops)" \
3783 "\n -p Base UDP port number used in probes" \
3784 "\n (default 33434)" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01003785 "\n -q Number of probes per TTL (default 3)" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003786 "\n -s IP address to use as the source address" \
3787 "\n -t Type-of-service in probe packets (default 0)" \
3788 "\n -w Time in seconds to wait for a response (default 3)" \
3789 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00003790
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01003791#define traceroute6_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003792 "[-dnrv] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
3793 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-i IFACE]\n" \
3794 " HOST [BYTES]"
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01003795#define traceroute6_full_usage "\n\n" \
3796 "Trace the route to HOST\n" \
3797 "\nOptions:" \
3798 "\n -d Set SO_DEBUG options to socket" \
3799 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003800 "\n -r Bypass routing tables, send directly to HOST" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01003801 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003802 "\n -m Max time-to-live (max number of hops)" \
3803 "\n -p Base UDP port number used in probes" \
3804 "\n (default is 33434)" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01003805 "\n -q Number of probes per TTL (default 3)" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003806 "\n -s IP address to use as the source address" \
3807 "\n -t Type-of-service in probe packets (default 0)" \
3808 "\n -w Time in seconds to wait for a response (default 3)" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01003809
Eric Andersen7e9276b2001-02-22 01:15:47 +00003810#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003811 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003812#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003813 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003814#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003815 "$ true\n" \
3816 "$ echo $?\n" \
3817 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003818
Eric Andersen7e9276b2001-02-22 01:15:47 +00003819#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003820 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003821#define tty_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003822 "Print file name of stdin's terminal" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003823 IF_INCLUDE_SUSv2( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003824 "\nOptions:" \
3825 "\n -s Print nothing, only return exit status" \
3826 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003827#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003828 "$ tty\n" \
3829 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003830
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003831#define ttysize_trivial_usage \
3832 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003833#define ttysize_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003834 "Print dimension(s) of stdin's terminal, on error return 80x25"
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003835
Denis Vlasenko39b68132009-01-23 02:07:14 +00003836#define tunctl_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003837 "[-f device] ([-t name] | -d name)" IF_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]")
Denis Vlasenko39b68132009-01-23 02:07:14 +00003838#define tunctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003839 "Create or delete tun interfaces\n" \
Denis Vlasenko39b68132009-01-23 02:07:14 +00003840 "\nOptions:" \
3841 "\n -f name tun device (/dev/net/tun)" \
3842 "\n -t name Create iface 'name'" \
3843 "\n -d name Delete iface 'name'" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02003844 IF_FEATURE_TUNCTL_UG( \
Denis Vlasenko39b68132009-01-23 02:07:14 +00003845 "\n -u owner Set iface owner" \
3846 "\n -g group Set iface group" \
3847 "\n -b Brief output" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02003848 )
Denis Vlasenko39b68132009-01-23 02:07:14 +00003849#define tunctl_example_usage \
3850 "# tunctl\n" \
3851 "# tunctl -d tun0\n"
3852
Russ Dill61fb4892002-10-14 21:41:28 +00003853#define udhcpd_trivial_usage \
Denys Vlasenkob1560002010-09-06 13:39:59 +02003854 "[-fS]" IF_FEATURE_UDHCP_PORT(" [-P N]") " [CONFFILE]" \
Russ Dill61fb4892002-10-14 21:41:28 +00003855
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003856#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003857 "DHCP server\n" \
3858 "\n -f Run in foreground" \
3859 "\n -S Log to syslog too" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003860 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01003861 "\n -P N Use port N (default 67)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00003862 )
Russ Dill61fb4892002-10-14 21:41:28 +00003863
Eric Andersen7e9276b2001-02-22 01:15:47 +00003864#define umount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003865 "[OPTIONS] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003866#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003867 "Unmount file systems\n" \
3868 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003869 IF_FEATURE_UMOUNT_ALL( \
3870 "\n -a Unmount all file systems" IF_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
Denis Vlasenko397de612008-03-17 08:55:44 +00003871 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003872 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003873 "\n -n Don't erase /etc/mtab entries" \
3874 ) \
3875 "\n -r Try to remount devices as read-only if mount is busy" \
3876 "\n -l Lazy umount (detach filesystem)" \
3877 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003878 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003879 "\n -d Free loop device if it has been used" \
3880 )
3881
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003882#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003883 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003884
3885#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003886 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003887#define uname_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003888 "Print system information\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003889 "\nOptions:" \
3890 "\n -a Print all" \
3891 "\n -m The machine (hardware) type" \
3892 "\n -n Hostname" \
3893 "\n -r OS release" \
3894 "\n -s OS name (default)" \
3895 "\n -p Processor type" \
3896 "\n -v OS version" \
3897
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003898#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003899 "$ uname -a\n" \
3900 "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 +00003901
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003902#define uncompress_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003903 "[-cf] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003904#define uncompress_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02003905 "Decompress .Z file[s]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003906 "\nOptions:" \
Denys Vlasenkoa3581402010-05-27 02:30:04 +02003907 "\n -c Write to stdout" \
3908 "\n -f Overwrite" \
Tim Riker7b253f82003-12-28 05:02:40 +00003909
Denis Vlasenko3952f202007-08-13 14:10:24 +00003910#define unexpand_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003911 "[-fa][-t N] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003912#define unexpand_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003913 "Convert spaces to tabs, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003914 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003915 IF_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003916 "\n -a,--all Convert all blanks" \
3917 "\n -f,--first-only Convert only leading blanks" \
3918 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003919 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003920 IF_NOT_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003921 "\n -a Convert all blanks" \
3922 "\n -f Convert only leading blanks" \
3923 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003924 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00003925
Eric Andersen7e9276b2001-02-22 01:15:47 +00003926#define uniq_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003927 "[-cdu][-f,s,w N] [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003928#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00003929 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003930 "\nOptions:" \
3931 "\n -c Prefix lines by the number of occurrences" \
3932 "\n -d Only print duplicate lines" \
3933 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00003934 "\n -f N Skip first N fields" \
3935 "\n -s N Skip first N chars (after any skipped fields)" \
3936 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003937
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003938#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003939 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
3940 "a\n" \
3941 "b\n" \
3942 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003943
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003944#define unzip_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003945 "[-opts[modifiers]] FILE[.zip] [LIST] [-x XLIST] [-d DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003946#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003947 "Extract files from ZIP archives\n" \
3948 "\nOptions:" \
3949 "\n -l List archive contents (with -q for short form)" \
Denys Vlasenkoa3581402010-05-27 02:30:04 +02003950 "\n -n Never overwrite files (default)" \
3951 "\n -o Overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003952 "\n -p Send output to stdout" \
3953 "\n -q Quiet" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003954 "\n -x XLST Exclude these files" \
3955 "\n -d DIR Extract files into DIR" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003956
Eric Andersen7e9276b2001-02-22 01:15:47 +00003957#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003958 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003959#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003960 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00003961
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003962#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003963 "$ uptime\n" \
3964 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003965
3966#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003967 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003968#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003969 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00003970
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003971#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003972 "$ usleep 1000000\n" \
3973 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003974
3975#define uudecode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003976 "[-o OUTFILE] [INFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003977#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00003978 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003979 "Finds outfile name in uuencoded source unless -o is given"
3980
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003981#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003982 "$ uudecode -o busybox busybox.uu\n" \
3983 "$ ls -l busybox\n" \
3984 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003985
3986#define uuencode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003987 "[-m] [INFILE] STORED_FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003988#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003989 "Uuencode a file to stdout\n" \
3990 "\nOptions:" \
3991 "\n -m Use base64 encoding per RFC1521" \
3992
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003993#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003994 "$ uuencode busybox busybox\n" \
3995 "begin 755 busybox\n" \
3996 "<encoded file snipped>\n" \
3997 "$ uudecode busybox busybox > busybox.uu\n" \
3998 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003999
Eric Andersen853c4942003-01-23 05:59:32 +00004000#define vconfig_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004001 "COMMAND [OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004002#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004003 "Create and remove virtual ethernet devices\n" \
4004 "\nOptions:" \
4005 "\n add [interface-name] [vlan_id]" \
4006 "\n rem [vlan-name]" \
4007 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4008 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4009 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4010 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004011
Eric Andersen3f980402001-04-04 17:31:15 +00004012#define vi_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004013 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004014#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004015 "Edit FILE\n" \
4016 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004017 IF_FEATURE_VI_COLON( \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02004018 "\n -c Initial command to run ($EXINIT also available)" \
4019 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004020 IF_FEATURE_VI_READONLY( \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02004021 "\n -R Read-only" \
4022 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004023 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00004024
Eric Andersen27f64e12002-06-23 04:24:25 +00004025#define vlock_trivial_usage \
Denys Vlasenko6b0ac842010-10-07 13:25:09 +02004026 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004027#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004028 "Lock a virtual terminal. A password is required to unlock.\n" \
4029 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00004030 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004031
Matthew Stoltenberg4803db52009-08-13 00:59:32 +02004032#define volname_trivial_usage \
4033 "[DEVICE]"
4034#define volname_full_usage "\n\n" \
4035 "Show CD volume name of the DEVICE (default /dev/cdrom)"
4036
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01004037#define wall_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004038 "[FILE]"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01004039#define wall_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004040 "Write content of FILE or stdin to all logged-in users"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01004041#define wall_sample_usage \
4042 "echo foo | wall\n" \
4043 "wall ./mymessage"
4044
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004045#define watch_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004046 "[-n SEC] [-t] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004047#define watch_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004048 "Run PROG periodically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004049 "\nOptions:" \
4050 "\n -n Loop period in seconds (default 2)" \
4051 "\n -t Don't print header" \
4052
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004053#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004054 "$ watch date\n" \
4055 "Mon Dec 17 10:31:40 GMT 2000\n" \
4056 "Mon Dec 17 10:31:42 GMT 2000\n" \
4057 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004058
Eric Andersen7e9276b2001-02-22 01:15:47 +00004059#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004060 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004061#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004062 "Periodically write to watchdog device DEV\n" \
4063 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004064 "\n -T N Reboot after N seconds if not reset (default 60)" \
4065 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004066 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004067 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004068 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004069
Eric Andersen7e9276b2001-02-22 01:15:47 +00004070#define which_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004071 "[COMMAND]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004072#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004073 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004074#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004075 "$ which login\n" \
4076 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004077
Eric Andersen00a6a752002-04-26 23:53:10 +00004078#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004079 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004080#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004081 "Show who is logged on\n" \
4082 "\nOptions:" \
Denys Vlasenko838e0db2010-06-07 03:04:46 +02004083 "\n -a Show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004084
4085#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004086 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004087#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004088 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004089
Eric Andersen7e9276b2001-02-22 01:15:47 +00004090#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004091 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004092#define zcat_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02004093 "Decompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004094
Rob Landleyad8071f2005-04-30 03:49:37 +00004095#define zcip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004096 "[OPTIONS] IFACE SCRIPT"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004097#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004098 "Manage a ZeroConf IPv4 link-local address\n" \
4099 "\nOptions:" \
4100 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004101 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004102 "\n -r 169.254.x.x Request this address first" \
4103 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004104 "\n" \
4105 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
4106 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00004107
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00004108
4109#endif