blob: 57c25a0f82943e722a7609e5ff0c8ba91bc126b1 [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 \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010021 "[-d] [-c CONFDIR] [-l LOGFILE] [-e PROC_EVENT_FILE] [EVDEV_EVENT_FILE]..."
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:" \
Denys Vlasenko07697852009-10-06 21:11:37 +020025 "\n -d Don't daemonize, log to stderr" \
Denis Vlasenkod16950d2008-11-29 09:05:50 +000026 "\n -c DIR Config directory [/etc/acpi]" \
27 "\n -e FILE /proc event file [/proc/acpi/event]" \
28 "\n -l FILE Log file [/var/log/acpid]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +000029 IF_FEATURE_ACPID_COMPAT( \
Denis Vlasenkod16950d2008-11-29 09:05:50 +000030 "\n\nAccept and ignore compatibility options -g -m -s -S -v" \
31 )
32
33#define acpid_example_usage \
34 "# acpid -l /var/log/my-acpi-log\n" \
35 "# acpid -d /dev/input/event*\n"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000036
Eric Andersenf349e972001-08-21 16:18:59 +000037#define addgroup_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010038 "[-g GID] " IF_FEATURE_ADDUSER_TO_GROUP("[USER] ") "GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000039#define addgroup_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +000040 "Add a group " IF_FEATURE_ADDUSER_TO_GROUP("or add a user to a group") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000041 "\nOptions:" \
Denis Vlasenko4f98e192008-04-13 22:12:19 +000042 "\n -g GID Group id" \
Denis Vlasenkoc2931aa2009-04-22 21:35:52 +000043 "\n -S Create a system group" \
Eric Andersenf349e972001-08-21 16:18:59 +000044
45#define adduser_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010046 "[OPTIONS] USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000047#define adduser_full_usage "\n\n" \
Denis Vlasenko73ac0562008-12-25 01:01:23 +000048 "Add a user\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000049 "\nOptions:" \
50 "\n -h DIR Home directory" \
51 "\n -g GECOS GECOS field" \
52 "\n -s SHELL Login shell" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +020053 "\n -G GRP Add user to existing group" \
Denis Vlasenko397de612008-03-17 08:55:44 +000054 "\n -S Create a system user" \
Denys Vlasenko07697852009-10-06 21:11:37 +020055 "\n -D Don't assign a password" \
56 "\n -H Don't create home directory" \
Denis Vlasenkoc2931aa2009-04-22 21:35:52 +000057 "\n -u UID User id" \
Eric Andersenf349e972001-08-21 16:18:59 +000058
Mark Whitley6f932772001-03-20 19:18:10 +000059#define adjtimex_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010060 "[-q] [-o OFF] [-f FREQ] [-p TCONST] [-t TICK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000061#define adjtimex_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +010062 "Read and optionally set system timebase parameters. See adjtimex(2)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000063 "\nOptions:" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010064 "\n -q Quiet" \
65 "\n -o OFF Time offset, microseconds" \
66 "\n -f FREQ Frequency adjust, integer kernel units (65536 is 1ppm)" \
67 "\n (positive values make clock run faster)" \
68 "\n -t TICK Microseconds per tick, usually 10000" \
69 "\n -p TCONST" \
Mark Whitley6f932772001-03-20 19:18:10 +000070
Eric Andersen7e9276b2001-02-22 01:15:47 +000071#define ar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000072 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000073#define ar_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000074 "Extract or list FILES from an ar archive\n" \
75 "\nOptions:" \
76 "\n -o Preserve original dates" \
77 "\n -p Extract to stdout" \
78 "\n -t List" \
79 "\n -x Extract" \
80 "\n -v Verbose" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000081
Denis Vlasenkofa85b862007-01-07 01:24:12 +000082#define arp_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010083 "\n[-vn] [-H HWTYPE] [-i IF] -a [HOSTNAME]" \
84 "\n[-v] [-i IF] -d HOSTNAME [pub]" \
85 "\n[-v] [-H HWTYPE] [-i IF] -s HOSTNAME HWADDR [temp]" \
86 "\n[-v] [-H HWTYPE] [-i IF] -s HOSTNAME HWADDR [netmask MASK] pub" \
87 "\n[-v] [-H HWTYPE] [-i IF] -Ds HOSTNAME IFACE [netmask MASK] pub"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000088#define arp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000089 "Manipulate ARP cache\n" \
90 "\nOptions:" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000091 "\n -a Display (all) hosts" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000092 "\n -s Set new ARP entry" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000093 "\n -d Delete a specified entry" \
94 "\n -v Verbose" \
95 "\n -n Don't resolve names" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000096 "\n -i IF Network interface" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000097 "\n -D Read <hwaddr> from given device" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000098 "\n -A, -p AF Protocol family" \
Denis Vlasenko397de612008-03-17 08:55:44 +000099 "\n -H HWTYPE Hardware address type" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +0000100
Glenn L McGrath9e598412003-01-09 10:06:01 +0000101#define arping_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100102 "[-fqbDUA] [-c CNT] [-w TIMEOUT] [-I IFACE] [-s SRC_IP] DST_IP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000103#define arping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000104 "Send ARP requests/replies\n" \
105 "\nOptions:" \
106 "\n -f Quit on first ARP reply" \
107 "\n -q Quiet" \
108 "\n -b Keep broadcasting, don't go unicast" \
109 "\n -D Duplicated address detection mode" \
110 "\n -U Unsolicited ARP mode, update your neighbors" \
111 "\n -A ARP answer mode, update your neighbors" \
112 "\n -c N Stop after sending N ARP requests" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100113 "\n -w TIMEOUT Time to wait for ARP reply, seconds" \
114 "\n -I IFACE Interface to use (default eth0)" \
115 "\n -s SRC_IP Sender IP address" \
116 "\n DST_IP Target IP address" \
Glenn L McGrath9e598412003-01-09 10:06:01 +0000117
Eric Andersen08f59e32004-03-12 22:07:10 +0000118#define awk_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200119 "[OPTIONS] [AWK_PROGRAM] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000120#define awk_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000121 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200122 "\n -v VAR=VAL Set variable" \
123 "\n -F SEP Use SEP as field separator" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +0100124 "\n -f FILE Read program from FILE" \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +0000125
Eric Andersen7e9276b2001-02-22 01:15:47 +0000126#define basename_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000127 "FILE [SUFFIX]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000128#define basename_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200129 "Strip directory path and .SUFFIX from FILE\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000130#define basename_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000131 "$ basename /usr/local/bin/foo\n" \
132 "foo\n" \
133 "$ basename /usr/local/bin/\n" \
134 "bin\n" \
135 "$ basename /foo/bar.txt .txt\n" \
136 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000137
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200138#define beep_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100139 "-f FREQ -l LEN -d DELAY -r COUNT -n"
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200140#define beep_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +0200141 "Options:" \
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200142 "\n -f Frequency in Hz" \
143 "\n -l Length in ms" \
144 "\n -d Delay in ms" \
145 "\n -r Repetitions" \
146 "\n -n Start new tone" \
147
Grigory Batalovad7a5d42010-05-23 23:22:10 +0200148#define blkid_trivial_usage \
149 ""
150#define blkid_full_usage "\n\n" \
151 "Print UUIDs of all filesystems"
152
Bernhard Reutner-Fischerd27d9252008-01-13 15:23:27 +0000153#define brctl_trivial_usage \
154 "COMMAND [BRIDGE [INTERFACE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000155#define brctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200156 "Manage ethernet bridges\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000157 "\nCommands:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000158 IF_FEATURE_BRCTL_SHOW( \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000159 "\n show Show a list of bridges" \
160 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000161 "\n addbr BRIDGE Create BRIDGE" \
162 "\n delbr BRIDGE Delete BRIDGE" \
163 "\n addif BRIDGE IFACE Add IFACE to BRIDGE" \
164 "\n delif BRIDGE IFACE Delete IFACE from BRIDGE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000165 IF_FEATURE_BRCTL_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000166 "\n setageing BRIDGE TIME Set ageing time" \
167 "\n setfd BRIDGE TIME Set bridge forward delay" \
168 "\n sethello BRIDGE TIME Set hello time" \
169 "\n setmaxage BRIDGE TIME Set max message age" \
170 "\n setpathcost BRIDGE COST Set path cost" \
171 "\n setportprio BRIDGE PRIO Set port priority" \
172 "\n setbridgeprio BRIDGE PRIO Set bridge priority" \
Maciek Borzecki30ebd7b2010-03-23 05:18:38 +0100173 "\n stp BRIDGE [1/yes/on|0/no/off] STP on/off" \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000174 ) \
175
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000176#define bzip2_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200177 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000178#define bzip2_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100179 "Compress FILEs (or stdin) with bzip2 algorithm\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000180 "\nOptions:" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200181 "\n -1..9 Compression level" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000182 "\n -d Decompress" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200183 "\n -c Write to stdout" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000184 "\n -f Force" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000185
Rob Landley6130b9b2006-01-23 21:10:38 +0000186#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000187 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000188
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000189#define lzop_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200190 "[-cfvd123456789CF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000191#define lzop_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200192 "Options:" \
193 "\n -1..9 Compression level" \
194 "\n -d Decompress" \
195 "\n -c Write to stdout" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000196 "\n -f Force" \
197 "\n -v Verbose" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000198 "\n -F Don't store or verify checksum" \
199 "\n -C Also write checksum of compressed block" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000200
201#define lzopcat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200202 "[-vCF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000203#define lzopcat_full_usage "\n\n" \
204 " -v Verbose" \
205 "\n -F Don't store or verify checksum" \
206
207#define unlzop_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200208 "[-cfvCF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000209#define unlzop_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200210 "Options:" \
211 "\n -c Write to stdout" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000212 "\n -f Force" \
213 "\n -v Verbose" \
214 "\n -F Don't store or verify checksum" \
215
Rob Landleyc1d69902006-01-20 18:28:50 +0000216#define unlzma_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100217 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000218#define unlzma_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200219 "Decompress FILE (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000220 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100221 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000222 "\n -f Force" \
Rob Landleyc1d69902006-01-20 18:28:50 +0000223
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200224#define lzma_trivial_usage \
225 "-d [OPTIONS] [FILE]..."
226#define lzma_full_usage "\n\n" \
227 "Decompress FILE (or stdin)\n" \
228 "\nOptions:" \
229 "\n -d Decompress" \
230 "\n -c Write to stdout" \
231 "\n -f Force" \
232
233#define lzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000234 "FILE"
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200235#define lzcat_full_usage "\n\n" \
236 "Decompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000237
Denys Vlasenko602ce692010-05-30 03:35:18 +0200238#define unxz_trivial_usage \
239 "[OPTIONS] [FILE]..."
240#define unxz_full_usage "\n\n" \
241 "Decompress FILE (or stdin)\n" \
242 "\nOptions:" \
243 "\n -c Write to stdout" \
244 "\n -f Force" \
245
246#define xz_trivial_usage \
247 "-d [OPTIONS] [FILE]..."
248#define xz_full_usage "\n\n" \
249 "Decompress FILE (or stdin)\n" \
250 "\nOptions:" \
251 "\n -d Decompress" \
252 "\n -c Write to stdout" \
253 "\n -f Force" \
254
255#define xzcat_trivial_usage \
256 "FILE"
257#define xzcat_full_usage "\n\n" \
258 "Decompress to stdout"
259
Eric Andersenc98c0622001-12-06 15:16:43 +0000260#define cal_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100261 "[-jy] [[MONTH] YEAR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000262#define cal_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000263 "Display a calendar\n" \
264 "\nOptions:" \
265 "\n -j Use julian dates" \
266 "\n -y Display the entire year" \
Eric Andersenc98c0622001-12-06 15:16:43 +0000267
Eric Andersen7e9276b2001-02-22 01:15:47 +0000268#define cat_trivial_usage \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200269 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000270#define cat_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200271 "Concatenate FILEs and print them to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000272
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000273#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000274 "$ cat /proc/uptime\n" \
275 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000276
Rob Landley8abbee42006-05-31 19:36:04 +0000277#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000278 "[-etv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000279#define catv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000280 "Display nonprinting characters as ^x or M-x\n" \
281 "\nOptions:" \
282 "\n -e End each line with $" \
283 "\n -t Show tabs as ^I" \
284 "\n -v Don't use ^x or M-x escapes" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000285
286#define chat_trivial_usage \
287 "EXPECT [SEND [EXPECT [SEND...]]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000288#define chat_full_usage "\n\n" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000289 "Useful for interacting with a modem connected to stdin/stdout.\n" \
290 "A script consists of one or more \"expect-send\" pairs of strings,\n" \
291 "each pair is a pair of arguments. Example:\n" \
292 "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \
293
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000294#define chattr_trivial_usage \
Denys Vlasenko79ae5342010-01-06 12:27:18 +0100295 "[-R] [-+=AacDdijsStTu] [-v VERSION] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000296#define chattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000297 "Change file attributes on an ext2 fs\n" \
298 "\nModifiers:" \
299 "\n - Remove attributes" \
300 "\n + Add attributes" \
301 "\n = Set attributes" \
302 "\nAttributes:" \
303 "\n A Don't track atime" \
304 "\n a Append mode only" \
305 "\n c Enable compress" \
306 "\n D Write dir contents synchronously" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200307 "\n d Don't backup with dump" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000308 "\n i Cannot be modified (immutable)" \
309 "\n j Write all data to journal first" \
310 "\n s Zero disk storage when deleted" \
311 "\n S Write file contents synchronously" \
312 "\n t Disable tail-merging of partial blocks with other files" \
313 "\n u Allow file to be undeleted" \
314 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100315 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000316 "\n -v Set the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000317
Denis Vlasenko49622d72007-03-10 16:58:49 +0000318#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000319 "[OPTIONS] CONTEXT FILE..." \
320 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000321 IF_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000322 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
323 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000324#define chcon_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000325 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000326 IF_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000327 "\n -v,--verbose Verbose" \
328 "\n -c,--changes Report changes made" \
329 "\n -h,--no-dereference Affect symlinks instead of their targets" \
330 "\n -f,--silent,--quiet Suppress most error messages" \
331 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
332 "\n -u,--user=USER Set user/role/type/range in the target" \
333 "\n -r,--role=ROLE security context" \
334 "\n -t,--type=TYPE" \
335 "\n -l,--range=RANGE" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200336 "\n -R,--recursive Recurse" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000337 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000338 IF_NOT_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000339 "\n -v Verbose" \
340 "\n -c Report changes made" \
341 "\n -h Affect symlinks instead of their targets" \
342 "\n -f Suppress most error messages" \
343 "\n -u USER Set user/role/type/range in the target security context" \
344 "\n -r ROLE" \
345 "\n -t TYPE" \
346 "\n -l RNG" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200347 "\n -R Recurse" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000348 )
349
Eric Andersen7e9276b2001-02-22 01:15:47 +0000350#define chmod_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000351 "[-R"IF_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000352#define chmod_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000353 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000354 "symbols +-= and one or more of the letters rwxst\n" \
355 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200356 "\n -R Recurse" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000357 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000358 "\n -c List changed files" \
359 "\n -v List all files" \
360 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000361 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000362#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000363 "$ ls -l /tmp/foo\n" \
364 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
365 "$ chmod u+x /tmp/foo\n" \
366 "$ ls -l /tmp/foo\n" \
367 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
368 "$ chmod 444 /tmp/foo\n" \
369 "$ ls -l /tmp/foo\n" \
370 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000371
Denis Vlasenko081ef792007-03-17 16:38:21 +0000372#define chgrp_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000373 "[-RhLHP"IF_DESKTOP("cvf")"]... GROUP FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000374#define chgrp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000375 "Change the group membership of each FILE to GROUP\n" \
376 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200377 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000378 "\n -h Affect symlinks instead of symlink targets" \
379 "\n -L Traverse all symlinks to directories" \
380 "\n -H Traverse symlinks on command line only" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200381 "\n -P Don't traverse symlinks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000382 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000383 "\n -c List changed files" \
384 "\n -v Verbose" \
385 "\n -f Hide errors" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000386 )
387#define chgrp_example_usage \
388 "$ ls -l /tmp/foo\n" \
389 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
390 "$ chgrp root /tmp/foo\n" \
391 "$ ls -l /tmp/foo\n" \
392 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
393
Eric Andersen7e9276b2001-02-22 01:15:47 +0000394#define chown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000395 "[-RhLHP"IF_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000396#define chown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000397 "Change the owner and/or group of each FILE to OWNER and/or GROUP\n" \
398 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200399 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000400 "\n -h Affect symlinks instead of symlink targets" \
401 "\n -L Traverse all symlinks to directories" \
402 "\n -H Traverse symlinks on command line only" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200403 "\n -P Don't traverse symlinks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000404 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000405 "\n -c List changed files" \
406 "\n -v List all files" \
407 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000408 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000409#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000410 "$ ls -l /tmp/foo\n" \
411 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
412 "$ chown root /tmp/foo\n" \
413 "$ ls -l /tmp/foo\n" \
414 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
415 "$ chown root.root /tmp/foo\n" \
416 "ls -l /tmp/foo\n" \
417 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000418
Denis Vlasenkofe544582006-10-03 15:57:40 +0000419#define chpst_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000420 "[-vP012] [-u USER[:GRP]] [-U USER[:GRP]] [-e DIR]\n" \
421 " [-/ DIR] [-n NICE] [-m BYTES] [-d BYTES] [-o N]\n" \
422 " [-p N] [-f BYTES] [-c BYTES] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000423#define chpst_full_usage "\n\n" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +0200424 "Change the process state, run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000425 "\nOptions:" \
426 "\n -u USER[:GRP] Set uid and gid" \
427 "\n -U USER[:GRP] Set $UID and $GID in environment" \
428 "\n -e DIR Set environment variables as specified by files" \
429 "\n in DIR: file=1st_line_of_file" \
430 "\n -/ DIR Chroot to DIR" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000431 "\n -n NICE Add NICE to nice value" \
432 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000433 "\n -d BYTES Limit data segment" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000434 "\n -o N Limit number of open files per process" \
435 "\n -p N Limit number of processes per uid" \
436 "\n -f BYTES Limit output file sizes" \
437 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000438 "\n -v Verbose" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000439 "\n -P Create new process group" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100440 "\n -0 Close stdin" \
441 "\n -1 Close stdout" \
442 "\n -2 Close stderr" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000443
Denis Vlasenkofe544582006-10-03 15:57:40 +0000444#define setuidgid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100445 "USER PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000446#define setuidgid_full_usage "\n\n" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +0200447 "Set uid and gid to USER's uid and gid, drop supplementary group ids,\n" \
448 "run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000449#define envuidgid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100450 "USER PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000451#define envuidgid_full_usage "\n\n" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +0200452 "Set $UID to USER's uid and $GID to USER's gid, run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000453#define envdir_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100454 "DIR PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000455#define envdir_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000456 "Set various environment variables as specified by files\n" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +0200457 "in the directory DIR, run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000458#define softlimit_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000459 "[-a BYTES] [-m BYTES] [-d BYTES] [-s BYTES] [-l BYTES]\n" \
460 " [-f BYTES] [-c BYTES] [-r BYTES] [-o N] [-p N] [-t N]\n" \
461 " PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000462#define softlimit_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000463 "Set soft resource limits, then run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000464 "\nOptions:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000465 "\n -a BYTES Limit total size of all segments" \
466 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES -a BYTES" \
467 "\n -d BYTES Limit data segment" \
468 "\n -s BYTES Limit stack segment" \
469 "\n -l BYTES Limit locked memory size" \
470 "\n -o N Limit number of open files per process" \
471 "\n -p N Limit number of processes per uid" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000472 "\nOptions controlling file sizes:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000473 "\n -f BYTES Limit output file sizes" \
474 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000475 "\nEfficiency opts:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000476 "\n -r BYTES Limit resident set size" \
477 "\n -t N Limit CPU time, process receives" \
478 "\n a SIGXCPU after N seconds" \
Denis Vlasenkofe544582006-10-03 15:57:40 +0000479
Eric Andersen7e9276b2001-02-22 01:15:47 +0000480#define chroot_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100481 "NEWROOT [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000482#define chroot_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200483 "Run PROG with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000484#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000485 "$ ls -l /bin/ls\n" \
486 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
487 "# mount /dev/hdc1 /mnt -t minix\n" \
488 "# chroot /mnt\n" \
489 "# ls -l /bin/ls\n" \
490 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000491
Eric Andersen7e9276b2001-02-22 01:15:47 +0000492#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000493 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000494#define chvt_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000495 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000496
Rob Landley856489b2006-04-18 20:57:28 +0000497#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000498 "FILES..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000499#define cksum_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000500 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000501
Eric Andersen7e9276b2001-02-22 01:15:47 +0000502#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000503 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000504#define clear_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000505 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000506
Eric Andersen7e9276b2001-02-22 01:15:47 +0000507#define cmp_trivial_usage \
Denys Vlasenko65ebbc52010-05-09 04:38:22 +0200508 "[-l] [-s] FILE1 [FILE2" IF_DESKTOP(" [SKIP1 [SKIP2]]") "]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000509#define cmp_full_usage "\n\n" \
Denys Vlasenko65ebbc52010-05-09 04:38:22 +0200510 "Compare FILE1 with FILE2 (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000511 "\nOptions:" \
512 "\n -l Write the byte numbers (decimal) and values (octal)" \
513 "\n for all differing bytes" \
514 "\n -s Quiet" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000515
Rob Landley2acfd7b2005-05-11 23:12:49 +0000516#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000517 "[-123] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000518#define comm_full_usage "\n\n" \
Denys Vlasenko65ebbc52010-05-09 04:38:22 +0200519 "Compare FILE1 with FILE2\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000520 "\nOptions:" \
521 "\n -1 Suppress lines unique to FILE1" \
522 "\n -2 Suppress lines unique to FILE2" \
523 "\n -3 Suppress lines common to both files" \
Rob Landley2acfd7b2005-05-11 23:12:49 +0000524
Paul Fox79c142d2005-08-01 16:04:40 +0000525#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000526 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000527#define bbconfig_full_usage "\n\n" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +0200528 "Print the config file used by busybox build"
Mike Frysinger036f2992005-09-24 23:50:14 +0000529
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000530#define chrt_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100531 "[OPTIONS] [PRIO] [PID | PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000532#define chrt_full_usage "\n\n" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +0200533 "Change scheduling priority and class for a process\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000534 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100535 "\n -p Operate on PID" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +0200536 "\n -r Set SCHED_RR class" \
537 "\n -f Set SCHED_FIFO class" \
538 "\n -o Set SCHED_OTHER class" \
539 "\n -m Show min/max priorities" \
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000540
541#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000542 "$ chrt -r 4 sleep 900; x=$!\n" \
543 "$ chrt -f -p 3 $x\n" \
544 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000545
Denys Vlasenko922f6f52010-07-01 16:42:27 +0200546#define nice_trivial_usage \
547 "[-n ADJUST] [PROG ARGS]"
548#define nice_full_usage "\n\n" \
549 "Change scheduling priority, run PROG\n" \
550 "\nOptions:" \
551 "\n -n ADJUST Adjust priority by ADJUST" \
552
553#define renice_trivial_usage \
554 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
555#define renice_full_usage "\n\n" \
556 "Change scheduling priority for a running process\n" \
557 "\nOptions:" \
558 "\n -n Adjust current nice value (smaller is faster)" \
559 "\n -p Process id(s) (default)" \
560 "\n -g Process group id(s)" \
561 "\n -u Process user name(s) and/or id(s)" \
562
563#define ionice_trivial_usage \
564 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
565#define ionice_full_usage "\n\n" \
566 "Change I/O priority and class\n" \
567 "\nOptions:" \
568 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
569 "\n -n Priority" \
570
Eric Andersen7e9276b2001-02-22 01:15:47 +0000571#define cp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200572 "[OPTIONS] SOURCE DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000573#define cp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000574 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY\n" \
575 "\nOptions:" \
576 "\n -a Same as -dpR" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000577 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000578 "\n -c Preserve security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000579 ) \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100580 "\n -R,-r Recurse" \
581 "\n -d,-P Preserve symlinks (default if -R)" \
582 "\n -L Follow all symlinks" \
583 "\n -H Follow symlinks on command line" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000584 "\n -p Preserve file attributes if possible" \
Denys Vlasenkoa3581402010-05-27 02:30:04 +0200585 "\n -f Overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000586 "\n -i Prompt before overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000587 "\n -l,-s Create (sym)links" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000588
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000589#define cpio_trivial_usage \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100590 "[-dmvu] [-F FILE]" IF_FEATURE_CPIO_O(" [-H newc]") \
591 " [-ti"IF_FEATURE_CPIO_O("o")"]" IF_FEATURE_CPIO_P(" [-p DIR]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000592#define cpio_full_usage "\n\n" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000593 "Extract or list files from a cpio archive" \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100594 IF_FEATURE_CPIO_O(", or" \
595 "\ncreate an archive" IF_FEATURE_CPIO_P(" (-o) or copy files (-p)") \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100596 " using file list on stdin" \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100597 ) \
598 "\n" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000599 "\nMain operation mode:" \
600 "\n -t List" \
601 "\n -i Extract" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000602 IF_FEATURE_CPIO_O( \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100603 "\n -o Create (requires -H newc)" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000604 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000605 IF_FEATURE_CPIO_P( \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100606 "\n -p DIR Copy files to DIR" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000607 ) \
608 "\nOptions:" \
609 "\n -d Make leading directories" \
610 "\n -m Preserve mtime" \
611 "\n -v Verbose" \
612 "\n -u Overwrite" \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100613 "\n -F FILE Input (-t,-i,-p) or output (-o) file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000614 IF_FEATURE_CPIO_O( \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100615 "\n -H newc Archive format" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000616 ) \
Tim Riker7b253f82003-12-28 05:02:40 +0000617
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000618#define crond_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000619 "-fbS -l N " IF_FEATURE_CROND_D("-d N ") "-L LOGFILE -c DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000620#define crond_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000621 " -f Foreground" \
622 "\n -b Background (default)" \
623 "\n -S Log to syslog (default)" \
624 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000625 IF_FEATURE_CROND_D( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000626 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000627 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000628 "\n -L Log to file" \
629 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000630
631#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000632 "[-c DIR] [-u USER] [-ler]|[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000633#define crontab_full_usage "\n\n" \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000634 " -c Crontab directory" \
635 "\n -u User" \
636 "\n -l List crontab" \
637 "\n -e Edit crontab" \
638 "\n -r Delete crontab" \
639 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000640
Denis Vlasenko2211d522008-11-10 18:52:35 +0000641#define cryptpw_trivial_usage \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000642 "[OPTIONS] [PASSWORD] [SALT]"
643/* We do support -s, we just don't mention it */
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000644#define cryptpw_full_usage "\n\n" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000645 "Crypt the PASSWORD using crypt(3)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000646 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200647 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100648 "\n -P,--password-fd=N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000649/* "\n -s,--stdin Use stdin; like -P0" */ \
650 "\n -m,--method=TYPE Encryption method TYPE" \
651 "\n -S,--salt=SALT" \
652 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200653 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100654 "\n -P N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000655/* "\n -s Use stdin; like -P0" */ \
656 "\n -m TYPE Encryption method TYPE" \
657 "\n -S SALT" \
658 ) \
659
660/* mkpasswd is an alias to cryptpw */
661
662#define mkpasswd_trivial_usage \
663 "[OPTIONS] [PASSWORD] [SALT]"
664/* We do support -s, we just don't mention it */
665#define mkpasswd_full_usage "\n\n" \
666 "Crypt the PASSWORD using crypt(3)\n" \
667 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200668 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100669 "\n -P,--password-fd=N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000670/* "\n -s,--stdin Use stdin; like -P0" */ \
671 "\n -m,--method=TYPE Encryption method TYPE" \
672 "\n -S,--salt=SALT" \
673 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200674 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100675 "\n -P N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000676/* "\n -s Use stdin; like -P0" */ \
677 "\n -m TYPE Encryption method TYPE" \
678 "\n -S SALT" \
679 ) \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000680
Eric Andersen7e9276b2001-02-22 01:15:47 +0000681#define cut_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200682 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000683#define cut_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100684 "Print selected fields from each input FILE to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000685 "\nOptions:" \
686 "\n -b LIST Output only bytes from LIST" \
687 "\n -c LIST Output only characters from LIST" \
688 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
689 "\n -s Output only the lines containing delimiter" \
690 "\n -f N Print only these fields" \
691 "\n -n Ignored" \
692
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000693#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000694 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
695 "Hello\n" \
696 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
697 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000698
Eric Andersen7e9276b2001-02-22 01:15:47 +0000699#define date_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200700 "[OPTIONS] [+FMT] [TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000701#define date_full_usage "\n\n" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000702 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000703 "\nOptions:" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200704 IF_NOT_LONG_OPTS( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200705 "\n [-s] TIME Set time to TIME" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000706 "\n -u Work in UTC (don't convert to local time)" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200707 "\n -R Output RFC-2822 compliant date string" \
708 ) IF_LONG_OPTS( \
709 "\n [-s,--set] TIME Set time to TIME" \
Denys Vlasenko50be9632009-10-23 16:25:20 +0200710 "\n -u,--utc Work in UTC (don't convert to local time)" \
711 "\n -R,--rfc-2822 Output RFC-2822 compliant date string" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200712 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000713 IF_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000714 "\n -I[SPEC] Output ISO-8601 compliant date string" \
715 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000716 "\n 'hours', 'minutes', or 'seconds' for date and" \
717 "\n time to the indicated precision" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200718 ) IF_NOT_LONG_OPTS( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000719 "\n -r FILE Display last modification time of FILE" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200720 "\n -d TIME Display TIME, not 'now'" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200721 ) IF_LONG_OPTS( \
Denys Vlasenko50be9632009-10-23 16:25:20 +0200722 "\n -r,--reference FILE Display last modification time of FILE" \
723 "\n -d,--date TIME Display TIME, not 'now'" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200724 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000725 IF_FEATURE_DATE_ISOFMT( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200726 "\n -D FMT Use FMT for -d TIME conversion" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000727 ) \
728 "\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +0200729 "\nRecognized TIME formats:" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000730 "\n hh:mm[:ss]" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000731 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000732 "\n YYYY-MM-DD hh:mm[:ss]" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200733 "\n [[[[[YY]YY]MM]DD]hh]mm[.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000734
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000735#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000736 "$ date\n" \
737 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000738
Eric Andersen7e9276b2001-02-22 01:15:47 +0000739#define dd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000740 "[if=FILE] [of=FILE] " IF_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
741 " [seek=N]" IF_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000742#define dd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000743 "Copy a file with converting and formatting\n" \
744 "\nOptions:" \
745 "\n if=FILE Read from FILE instead of stdin" \
746 "\n of=FILE Write to FILE instead of stdout" \
747 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000748 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000749 "\n ibs=N Read N bytes at a time" \
750 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000751 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000752 "\n obs=N Write N bytes at a time" \
753 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000754 "\n count=N Copy only N input blocks" \
755 "\n skip=N Skip N input blocks" \
756 "\n seek=N Skip N output blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000757 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000758 "\n conv=notrunc Don't truncate output file" \
759 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000760 "\n conv=sync Pad blocks with zeros" \
761 "\n conv=fsync Physically write data out before finishing" \
762 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000763 "\n" \
764 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
765 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
766
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000767#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000768 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
769 "4+0 records in\n" \
770 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000771
Eric Andersen7e9276b2001-02-22 01:15:47 +0000772#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000773 "[N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000774#define deallocvt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000775 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000776
Eric Andersenf349e972001-08-21 16:18:59 +0000777#define delgroup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000778 IF_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000779#define delgroup_full_usage "\n\n" \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000780 "Delete group GROUP from the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000781 IF_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000782
783#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000784 "USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000785#define deluser_full_usage "\n\n" \
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000786 "Delete USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000787
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000788#define depmod_trivial_usage NOUSAGE_STR
789#define depmod_full_usage ""
Bernhard Reutner-Fischer55e547e2008-05-26 12:01:49 +0000790
Denis Vlasenkoc94fa562008-10-26 11:08:14 +0000791#define devmem_trivial_usage \
792 "ADDRESS [WIDTH [VALUE]]"
793
794#define devmem_full_usage "\n\n" \
795 "Read/write from physical address\n" \
796 "\n ADDRESS Address to act upon" \
797 "\n WIDTH Width (8/16/...)" \
798 "\n VALUE Data to be written" \
799
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000800#define devfsd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000801 "mntpnt [-v]" IF_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000802#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000803 "Manage devfs permissions and old device name symlinks\n" \
804 "\nOptions:" \
805 "\n mntpnt The mount point where devfs is mounted" \
806 "\n -v Print the protocol version numbers for devfsd" \
807 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000808 IF_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000809 "\n -fg Run in foreground" \
810 "\n -np Exit after parsing the configuration file" \
811 "\n and processing synthetic REGISTER events," \
Denys Vlasenko07697852009-10-06 21:11:37 +0200812 "\n don't poll for events" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000813 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000814
Eric Andersen7e9276b2001-02-22 01:15:47 +0000815#define df_trivial_usage \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000816 "[-Pk" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000817 IF_FEATURE_HUMAN_READABLE("mh") \
818 IF_FEATURE_DF_FANCY("ai] [-B SIZE") \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100819 "] [FILESYSTEM]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000820#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000821 "Print filesystem usage statistics\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000822 "\nOptions:" \
823 "\n -P POSIX output format" \
824 "\n -k 1024-byte blocks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000825 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000826 "\n -m 1M-byte blocks" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000827 "\n -h Human readable (e.g. 1K 243M 2G)" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000828 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000829 IF_FEATURE_DF_FANCY( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000830 "\n -a Show all filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000831 "\n -i Inodes" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000832 "\n -B SIZE Blocksize" \
833 ) \
834
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000835#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000836 "$ df\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000837 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000838 "/dev/sda3 8690864 8553540 137324 98% /\n" \
839 "/dev/sda1 64216 36364 27852 57% /boot\n" \
840 "$ df /dev/sda3\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000841 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
842 "/dev/sda3 8690864 8553540 137324 98% /\n" \
843 "$ POSIXLY_CORRECT=sure df /dev/sda3\n" \
844 "Filesystem 512B-blocks Used Available Use% Mounted on\n" \
845 "/dev/sda3 17381728 17107080 274648 98% /\n" \
846 "$ POSIXLY_CORRECT=yep df -P /dev/sda3\n" \
847 "Filesystem 512-blocks Used Available Capacity Mounted on\n" \
848 "/dev/sda3 17381728 17107080 274648 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000849
Denis Vlasenko736230e2006-11-20 19:40:36 +0000850#define dhcprelay_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100851 "CLIENT_IFACE[,CLIENT_IFACE2]... SERVER_IFACE [SERVER_IP]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000852#define dhcprelay_full_usage "\n\n" \
Denis Vlasenkoe8a79682009-04-13 03:33:46 +0000853 "Relay DHCP requests between clients and server" \
Denis Vlasenko736230e2006-11-20 19:40:36 +0000854
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000855#define diff_trivial_usage \
Matheus Izvekovfe1ce2e2010-01-18 16:07:07 -0200856 "[-abBdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000857#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000858 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000859 "This implementation supports unified diffs only.\n" \
860 "\nOptions:" \
861 "\n -a Treat all files as text" \
862 "\n -b Ignore changes in the amount of whitespace" \
Matheus Izvekovfe1ce2e2010-01-18 16:07:07 -0200863 "\n -B Ignore changes whose lines are all blank" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000864 "\n -d Try hard to find a smaller set of changes" \
865 "\n -i Ignore case differences" \
866 "\n -L Use LABEL instead of the filename in the unified header" \
867 "\n -N Treat absent files as empty" \
868 "\n -q Output only whether files differ" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100869 "\n -r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000870 "\n -S Start with FILE when comparing directories" \
871 "\n -T Make tabs line up by prefixing a tab when necessary" \
872 "\n -s Report when two files are the same" \
873 "\n -t Expand tabs to spaces in output" \
874 "\n -U Output LINES lines of context" \
875 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000876
Eric Andersen7e9276b2001-02-22 01:15:47 +0000877#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000878 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000879#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000880 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000881#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000882 "$ dirname /tmp/foo\n" \
883 "/tmp\n" \
884 "$ dirname /tmp/foo/\n" \
885 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000886
Eric Andersen7e9276b2001-02-22 01:15:47 +0000887#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000888 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000889#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000890 "Print or control the kernel ring buffer\n" \
891 "\nOptions:" \
892 "\n -c Clear ring buffer after printing" \
893 "\n -n LEVEL Set console logging level" \
894 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000895
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000896#define dnsd_trivial_usage \
Denys Vlasenko343dfd72010-02-07 02:45:03 +0100897 "[-dvs] [-c CONFFILE] [-t TTL_SEC] [-p PORT] [-i ADDR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000898#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000899 "Small static DNS server daemon\n" \
900 "\nOptions:" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +0100901 "\n -c FILE Config file" \
902 "\n -t SEC TTL" \
903 "\n -p PORT Listen on PORT" \
904 "\n -i ADDR Listen on ADDR" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000905 "\n -d Daemonize" \
Denys Vlasenko343dfd72010-02-07 02:45:03 +0100906 "\n -v Verbose" \
907 "\n -s Send successful replies only. Use this if you want" \
908 "\n to use /etc/resolv.conf with two nameserver lines:" \
909 "\n nameserver DNSD_SERVER" \
910 "\n nameserver NORNAL_DNS_SERVER" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000911
Eric Andersen7e9276b2001-02-22 01:15:47 +0000912#define dos2unix_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +0200913 "[OPTIONS] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000914#define dos2unix_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200915 "Convert FILE in-place from DOS to Unix format.\n" \
916 "When no file is given, use stdin/stdout.\n" \
917 "\nOptions:" \
918 "\n -u dos2unix" \
919 "\n -d unix2dos" \
920
921#define unix2dos_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +0200922 "[OPTIONS] [FILE]"
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200923#define unix2dos_full_usage "\n\n" \
924 "Convert FILE in-place from Unix to DOS format.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000925 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000926 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000927 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000928 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000929
Eric Andersen7e9276b2001-02-22 01:15:47 +0000930#define dpkg_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100931 "[-ilCPru] [-F OPT] PACKAGE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000932#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000933 "Install, remove and manage Debian packages\n" \
934 "\nOptions:" \
Kim B. Heino3d43aed2010-03-29 14:18:27 +0200935 IF_LONG_OPTS( \
936 "\n -i,--install Install the package" \
937 "\n -l,--list List of installed packages" \
938 "\n --configure Configure an unpackaged package" \
939 "\n -P,--purge Purge all files of a package" \
940 "\n -r,--remove Remove all but the configuration files for a package" \
941 "\n --unpack Unpack a package, but don't configure it" \
942 "\n --force-depends Ignore dependency problems" \
943 "\n --force-confnew Overwrite existing config files when installing" \
944 "\n --force-confold Keep old config files when installing" \
945 ) \
946 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000947 "\n -i Install the package" \
948 "\n -l List of installed packages" \
949 "\n -C Configure an unpackaged package" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000950 "\n -P Purge all files of a package" \
951 "\n -r Remove all but the configuration files for a package" \
952 "\n -u Unpack a package, but don't configure it" \
Kim B. Heino3d43aed2010-03-29 14:18:27 +0200953 "\n -F depends Ignore dependency problems" \
954 "\n -F confnew Overwrite existing config files when installing" \
955 "\n -F confold Keep old config files when installing" \
956 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000957
Eric Andersen7e9276b2001-02-22 01:15:47 +0000958#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000959 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000960#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000961 "Perform actions on Debian packages (.debs)\n" \
962 "\nOptions:" \
963 "\n -c List contents of filesystem tree" \
964 "\n -e Extract control files to [argument] directory" \
965 "\n -f Display control field name starting with [argument]" \
966 "\n -x Extract packages filesystem tree to directory" \
967 "\n -X Verbose extract" \
968
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000969#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000970 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000971
Eric Andersen7e9276b2001-02-22 01:15:47 +0000972#define du_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000973 "[-aHLdclsx" IF_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000974#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000975 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000976 "Disk space is printed in units of " \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000977 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
978 IF_NOT_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000979 " bytes.\n" \
980 "\nOptions:" \
981 "\n -a Show file sizes too" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000982 "\n -L Follow all symlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100983 "\n -H Follow symlinks on command line" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000984 "\n -d N Limit output to directories (and files with -a) of depth < N" \
985 "\n -c Show grand total" \
986 "\n -l Count sizes many times if hard linked" \
987 "\n -s Display only a total for each argument" \
988 "\n -x Skip directories on different filesystems" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000989 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000990 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
991 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000992 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000993 "\n -k Sizes in kilobytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000994 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000995
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000996#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000997 "$ du\n" \
998 "16 ./CVS\n" \
999 "12 ./kernel-patches/CVS\n" \
1000 "80 ./kernel-patches\n" \
1001 "12 ./tests/CVS\n" \
1002 "36 ./tests\n" \
1003 "12 ./scripts/CVS\n" \
1004 "16 ./scripts\n" \
1005 "12 ./docs/CVS\n" \
1006 "104 ./docs\n" \
1007 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001008
Eric Andersen7e9276b2001-02-22 01:15:47 +00001009#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001010 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001011#define dumpkmap_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001012 "Print a binary keyboard translation table to stdout"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001013#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001014 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001015
Russ Dill61fb4892002-10-14 21:41:28 +00001016#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001017 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001018#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001019 "Display DHCP leases granted by udhcpd\n" \
1020 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001021 IF_LONG_OPTS( \
Denys Vlasenkoc8a2ab12010-03-28 00:02:20 +01001022 "\n -f,--file=FILE Lease file" \
1023 "\n -r,--remaining Show remaining time" \
1024 "\n -a,--absolute Show expiration time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001025 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001026 IF_NOT_LONG_OPTS( \
Denys Vlasenkoc8a2ab12010-03-28 00:02:20 +01001027 "\n -f FILE Lease file" \
1028 "\n -r Show remaining time" \
1029 "\n -a Show expiration time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001030 )
Russ Dill61fb4892002-10-14 21:41:28 +00001031
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001032/*
Mike Frysinger51a43b42005-09-24 07:11:16 +00001033#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001034 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
1035 "[-I inode_buffer_blocks] [-P process_inode_size] " \
1036 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
1037 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001038#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001039 "Check ext2/ext3 file system\n" \
1040 "\nOptions:" \
1041 "\n -p Automatic repair (no questions)" \
1042 "\n -n Make no changes to the filesystem" \
1043 "\n -y Assume 'yes' to all questions" \
1044 "\n -c Check for bad blocks and add them to the badblock list" \
1045 "\n -f Force checking even if filesystem is marked clean" \
1046 "\n -v Verbose" \
1047 "\n -b superblock Use alternative superblock" \
1048 "\n -B blocksize Force blocksize when looking for superblock" \
1049 "\n -j journal Set location of the external journal" \
1050 "\n -l file Add to badblocks list" \
1051 "\n -L file Set badblocks list" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001052*/
Mike Frysinger51a43b42005-09-24 07:11:16 +00001053
Eric Andersen7e9276b2001-02-22 01:15:47 +00001054#define echo_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001055 IF_FEATURE_FANCY_ECHO("[-neE] ") "[ARG]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001056#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001057 "Print the specified ARGs to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001058 IF_FEATURE_FANCY_ECHO( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001059 "\nOptions:" \
1060 "\n -n Suppress trailing newline" \
Denys Vlasenkoc8a2ab12010-03-28 00:02:20 +01001061 "\n -e Interpret backslash escapes (i.e., \\t=tab)" \
1062 "\n -E Don't interpret backslash escapes (default)" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001063 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001064#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001065 "$ echo \"Erik is cool\"\n" \
1066 "Erik is cool\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001067 IF_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001068 "Erik\n" \
1069 "is\n" \
1070 "cool\n" \
1071 "$ echo \"Erik\\nis\\ncool\"\n" \
1072 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001073
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001074#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001075 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001076#define eject_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001077 "Eject DEVICE or default /dev/cdrom\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001078 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001079 IF_FEATURE_EJECT_SCSI( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001080 "\n -s SCSI device" \
1081 ) \
1082 "\n -t Close tray" \
1083 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001084
Rob Landley3b890392006-05-04 20:56:43 +00001085#define ed_trivial_usage ""
1086#define ed_full_usage ""
1087
Eric Andersen84e229c2001-03-29 22:48:33 +00001088#define env_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001089 "[-iu] [-] [name=value]... [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001090#define env_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001091 "Print the current environment or run PROG after setting up\n" \
1092 "the specified environment\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001093 "\nOptions:" \
1094 "\n -, -i Start with an empty environment" \
1095 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +00001096
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001097#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001098 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001099#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001100 "Send a magic packet to wake up sleeping machines.\n" \
1101 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001102 "a hostname with a known 'ethers' entry.\n" \
1103 "\nOptions:" \
1104 "\n -b Send wake-up packet to the broadcast address" \
1105 "\n -i iface Interface to use (default eth0)" \
1106 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001107
Denis Vlasenko3952f202007-08-13 14:10:24 +00001108#define expand_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01001109 "[-i] [-t N] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001110#define expand_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001111 "Convert tabs to spaces, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001112 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001113 IF_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001114 "\n -i,--initial Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001115 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001116 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001117 IF_NOT_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001118 "\n -i Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001119 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001120 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00001121
Eric Andersen7e9276b2001-02-22 01:15:47 +00001122#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001123 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001124#define expr_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001125 "Print the value of EXPRESSION to stdout\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001126 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001127 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001128 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
1129 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1130 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1131 " ARG1 <= ARG2\n" \
1132 " ARG1 = ARG2\n" \
1133 " ARG1 != ARG2\n" \
1134 " ARG1 >= ARG2\n" \
1135 " ARG1 > ARG2\n" \
1136 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1137 " ARG1 - ARG2\n" \
1138 " ARG1 * ARG2\n" \
1139 " ARG1 / ARG2\n" \
1140 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001141 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1142 " match STRING REGEXP Same as STRING : REGEXP\n" \
1143 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1144 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1145 " length STRING Length of STRING\n" \
1146 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001147 " it is a keyword like 'match' or an\n" \
1148 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001149 " (EXPRESSION) Value of EXPRESSION\n" \
1150 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001151 "Beware that many operators need to be escaped or quoted for shells.\n" \
1152 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001153 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001154 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1155 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001156
Mike Frysingerfa69f112005-04-17 07:24:19 +00001157#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001158 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001159#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001160 "Provide fake ident (auth) service\n" \
1161 "\nOptions:" \
1162 "\n -f Run in foreground" \
1163 "\n -i Inetd mode" \
1164 "\n -w Inetd 'wait' mode" \
1165 "\n -b ADDR Bind to specified address" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001166 "\n STRING Ident answer string (default: nobody)" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001167
Eric Andersen7e9276b2001-02-22 01:15:47 +00001168#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001169 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001170#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001171 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001172
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001173#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001174 "$ false\n" \
1175 "$ echo $?\n" \
1176 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001177
Denys Vlasenkoff027d62010-05-04 15:45:25 +02001178#define fbsplash_trivial_usage \
1179 "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
1180#define fbsplash_full_usage "\n\n" \
1181 "Options:" \
1182 "\n -s Image" \
1183 "\n -c Hide cursor" \
1184 "\n -d Framebuffer device (default /dev/fb0)" \
1185 "\n -i Config file (var=value):" \
1186 "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT" \
1187 "\n BAR_R,BAR_G,BAR_B" \
1188 "\n -f Control pipe (else exit after drawing image)" \
1189 "\n commands: 'NN' (% for progress bar) or 'exit'" \
1190
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001191#define fbset_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001192 "[OPTIONS] [MODE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001193#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001194 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001195
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001196#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001197 "$ fbset\n" \
1198 "mode \"1024x768-76\"\n" \
1199 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1200 " geometry 1024 768 1024 768 16\n" \
1201 " timings 12714 128 32 16 4 128 4\n" \
1202 " accel false\n" \
1203 " rgba 5/11,6/5,5/0,0/0\n" \
1204 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001205
Eric Andersen7e9276b2001-02-22 01:15:47 +00001206#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001207 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001208#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001209 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001210
Eric Andersen01c3d402003-07-05 07:51:31 +00001211#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001212 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001213#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001214 "Format floppy disk\n" \
1215 "\nOptions:" \
1216 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001217
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001218/* Looks like someone forgot to add this to config system */
1219#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1220# define ENABLE_FEATURE_FDISK_BLKSIZE 0
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001221# define IF_FEATURE_FDISK_BLKSIZE(a)
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001222#endif
1223
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001224#define fdisk_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001225 "[-ul" IF_FEATURE_FDISK_BLKSIZE("s") "] " \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001226 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001227#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001228 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001229 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001230 "\n -u Start and End are in sectors (instead of cylinders)" \
1231 "\n -l Show partition table for each DISK, then exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001232 IF_FEATURE_FDISK_BLKSIZE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001233 "\n -s Show partition sizes in kb for each DISK, then exit" \
1234 ) \
1235 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1236 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
Denys Vlasenko37bc1eb2010-04-06 00:04:08 +02001237 "\n -H HEADS" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001238 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001239
Grigory Batalovad7a5d42010-05-23 23:22:10 +02001240#define fgconsole_trivial_usage \
1241 ""
1242#define fgconsole_full_usage "\n\n" \
1243 "Get active console"
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001244
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001245#define findfs_trivial_usage \
1246 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001247#define findfs_full_usage "\n\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02001248 "Find a filesystem device based on a label or UUID"
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001249#define findfs_example_usage \
1250 "$ findfs LABEL=MyDevice"
1251
Denys Vlasenkobf2af9a2009-05-25 04:15:37 +02001252#define flash_lock_trivial_usage \
1253 "MTD_DEVICE OFFSET SECTORS"
1254#define flash_lock_full_usage "\n\n" \
1255 "Lock part or all of an MTD device. If SECTORS is -1, then all sectors\n" \
1256 "will be locked, regardless of the value of OFFSET"
1257
1258#define flash_unlock_trivial_usage \
1259 "MTD_DEVICE"
1260#define flash_unlock_full_usage "\n\n" \
1261 "Unlock an MTD device"
1262
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001263#define flash_eraseall_trivial_usage \
1264 "[-jq] MTD_DEVICE"
1265#define flash_eraseall_full_usage "\n\n" \
1266 "Erase an MTD device\n" \
1267 "\nOptions:" \
Stefan Seyfriedd095fd42009-11-21 18:32:19 +01001268 "\n -j Format the device for jffs2" \
1269 "\n -q Don't display progress messages" \
1270
1271#define flashcp_trivial_usage \
1272 "-v FILE MTD_DEVICE"
1273#define flashcp_full_usage "\n\n" \
1274 "Copy an image to MTD device\n" \
1275 "\nOptions:" \
1276 "\n -v Verbose" \
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001277
Timo Teras892d4b62010-03-18 22:45:35 +01001278#define flock_trivial_usage \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001279 "[-sxun] FD|{FILE [-c] PROG ARGS}"
Timo Teras892d4b62010-03-18 22:45:35 +01001280#define flock_full_usage "\n\n" \
Denys Vlasenko922f6f52010-07-01 16:42:27 +02001281 "[Un]lock file descriptor, or lock FILE, run PROG\n" \
Timo Teras892d4b62010-03-18 22:45:35 +01001282 "\nOptions:" \
1283 "\n -s Shared lock" \
1284 "\n -x Exclusive lock (default)" \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001285 "\n -u Unlock FD" \
Timo Teras892d4b62010-03-18 22:45:35 +01001286 "\n -n Fail rather than wait" \
1287
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001288#define fold_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001289 "[-bs] [-w WIDTH] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001290#define fold_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001291 "Wrap input lines in each FILE (or stdin), writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001292 "\nOptions:" \
1293 "\n -b Count bytes rather than columns" \
1294 "\n -s Break at spaces" \
1295 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001296
Eric Andersen7e9276b2001-02-22 01:15:47 +00001297#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001298 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001299#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001300 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001301#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001302 "$ free\n" \
1303 " total used free shared buffers\n" \
1304 " Mem: 257628 248724 8904 59644 93124\n" \
1305 " Swap: 128516 8404 120112\n" \
1306 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001307
Eric Andersen7e9276b2001-02-22 01:15:47 +00001308#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001309 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001310#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001311 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001312#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001313 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001314
Mike Frysinger51a43b42005-09-24 07:11:16 +00001315#define fsck_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001316 "[-ANPRTV] [-C FD] [-t FSTYPE] [FS_OPTS] [BLOCKDEV]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001317#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001318 "Check and repair filesystems\n" \
1319 "\nOptions:" \
1320 "\n -A Walk /etc/fstab and check all filesystems" \
1321 "\n -N Don't execute, just show what would be done" \
1322 "\n -P With -A, check filesystems in parallel" \
1323 "\n -R With -A, skip the root filesystem" \
1324 "\n -T Don't show title on startup" \
1325 "\n -V Verbose" \
1326 "\n -C n Write status information to specified filedescriptor" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001327 "\n -t TYPE List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001328
Eric Andersen7e9276b2001-02-22 01:15:47 +00001329#define fsck_minix_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001330 "[-larvsmf] BLOCKDEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001331#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001332 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001333 "\nOptions:" \
1334 "\n -l List all filenames" \
1335 "\n -r Perform interactive repairs" \
1336 "\n -a Perform automatic repairs" \
1337 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001338 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001339 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001340 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001341
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001342#define ftpd_trivial_usage \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001343 "[-wvS] [-t N] [-T N] [DIR]"
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001344#define ftpd_full_usage "\n\n" \
Denys Vlasenkoae357bd2009-09-11 23:29:45 +02001345 "Anonymous FTP server\n" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001346 "\n" \
1347 "ftpd should be used as an inetd service.\n" \
1348 "ftpd's line for inetd.conf:\n" \
1349 " 21 stream tcp nowait root ftpd ftpd /files/to/serve\n" \
1350 "It also can be ran from tcpsvd:\n" \
1351 " tcpsvd -vE 0.0.0.0 21 ftpd /files/to/serve\n" \
1352 "\nOptions:" \
1353 "\n -w Allow upload" \
Denis Vlasenko4221e902009-03-11 15:07:44 +00001354 "\n -v Log to stderr" \
1355 "\n -S Log to syslog" \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001356 "\n -t,-T Idle and absolute timeouts" \
Denis Vlasenko92576712009-03-09 16:25:33 +00001357 "\n DIR Change root to this directory" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001358
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001359#define ftpget_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001360 "[OPTIONS] HOST [LOCAL_FILE] REMOTE_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001361#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001362 "Retrieve a remote file via FTP\n" \
1363 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001364 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001365 "\n -c,--continue Continue previous transfer" \
1366 "\n -v,--verbose Verbose" \
1367 "\n -u,--username Username" \
1368 "\n -p,--password Password" \
1369 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001370 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001371 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001372 "\n -c Continue previous transfer" \
1373 "\n -v Verbose" \
1374 "\n -u Username" \
1375 "\n -p Password" \
1376 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001377 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001378
1379#define ftpput_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001380 "[OPTIONS] HOST [REMOTE_FILE] LOCAL_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001381#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001382 "Store a local file on a remote machine via FTP\n" \
1383 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001384 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001385 "\n -v,--verbose Verbose" \
1386 "\n -u,--username Username" \
1387 "\n -p,--password Password" \
1388 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001389 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001390 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001391 "\n -v Verbose" \
1392 "\n -u Username" \
1393 "\n -p Password" \
1394 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001395 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001396
Rob Landleyaa872762005-10-28 13:05:12 +00001397#define fuser_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001398 "[OPTIONS] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001399#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001400 "Find processes which use FILEs or PORTs\n" \
1401 "\nOptions:" \
1402 "\n -m Find processes which use same fs as FILEs" \
1403 "\n -4 Search only IPv4 space" \
1404 "\n -6 Search only IPv6 space" \
Maksym Kryzhanovskyyfef9ee72010-05-22 20:41:08 +02001405 "\n -s Don't display PIDs" \
1406 "\n -k Kill found processes" \
1407 "\n -SIGNAL Signal to send (default: KILL)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001408
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001409#define getenforce_trivial_usage NOUSAGE_STR
1410#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001411
Eric Andersen7e9276b2001-02-22 01:15:47 +00001412#define getopt_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001413 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001414#define getopt_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001415 "Options:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001416 IF_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001417 "\n -a,--alternative Allow long options starting with single -" \
1418 "\n -l,--longoptions=longopts Long options to be recognized" \
1419 "\n -n,--name=progname The name under which errors are reported" \
1420 "\n -o,--options=optstring Short options to be recognized" \
1421 "\n -q,--quiet Disable error reporting by getopt(3)" \
1422 "\n -Q,--quiet-output No normal output" \
1423 "\n -s,--shell=shell Set shell quoting conventions" \
1424 "\n -T,--test Test for getopt(1) version" \
1425 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001426 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001427 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001428 "\n -a Allow long options starting with single -" \
1429 "\n -l longopts Long options to be recognized" \
1430 "\n -n progname The name under which errors are reported" \
1431 "\n -o optstring Short options to be recognized" \
1432 "\n -q Disable error reporting by getopt(3)" \
1433 "\n -Q No normal output" \
1434 "\n -s shell Set shell quoting conventions" \
1435 "\n -T Test for getopt(1) version" \
1436 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001437 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001438#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001439 "$ cat getopt.test\n" \
1440 "#!/bin/sh\n" \
1441 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1442 " -n 'example.busybox' -- \"$@\"`\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001443 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001444 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001445 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001446 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001447 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1448 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001449 " -c|--c-long)\n" \
1450 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001451 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1452 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1453 " esac;;\n" \
1454 " --) shift; break;;\n" \
1455 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001456 " esac\n" \
1457 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001458
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001459#define getsebool_trivial_usage \
1460 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001461#define getsebool_full_usage "\n\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01001462 " -a Show all selinux booleans"
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001463
Eric Andersenf349e972001-08-21 16:18:59 +00001464#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001465 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001466#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001467 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1468 "\nOptions:" \
1469 "\n -h Enable hardware (RTS/CTS) flow control" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001470 "\n -i Don't display /etc/issue before running login" \
1471 "\n -L Local line, don't do carrier detect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001472 "\n -m Get baud rate from modem's CONNECT status message" \
1473 "\n -w Wait for a CR or LF before sending /etc/issue" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001474 "\n -n Don't prompt the user for a login name" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02001475 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
1476 "\n -l LOGIN Invoke LOGIN instead of /bin/login" \
1477 "\n -t SEC Terminate after SEC if no username is read" \
1478 "\n -I INITSTR Send INITSTR before anything else" \
1479 "\n -H HOST Log HOST into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001480
Eric Andersen7e9276b2001-02-22 01:15:47 +00001481#define gunzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001482 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001483#define gunzip_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02001484 "Decompress FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001485 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001486 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001487 "\n -f Force" \
1488 "\n -t Test file integrity" \
1489
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001490#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001491 "$ ls -la /tmp/BusyBox*\n" \
1492 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1493 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1494 "$ ls -la /tmp/BusyBox*\n" \
1495 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001496
1497#define gzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001498 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001499#define gzip_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001500 "Compress FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001501 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001502 "\n -d Decompress" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02001503 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001504 "\n -f Force" \
1505
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001506#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001507 "$ ls -la /tmp/busybox*\n" \
1508 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1509 "$ gzip /tmp/busybox.tar\n" \
1510 "$ ls -la /tmp/busybox*\n" \
1511 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001512
1513#define halt_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001514 "[-d DELAY] [-n] [-f]" IF_FEATURE_WTMP(" [-w]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001515#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001516 "Halt the system\n" \
1517 "\nOptions:" \
1518 "\n -d Delay interval for halting" \
1519 "\n -n No call to sync()" \
1520 "\n -f Force halt (don't go through init)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001521 IF_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001522 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001523 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001524
Eric Andersen3443bd72003-07-22 07:30:36 +00001525#define hdparm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001526 "[OPTIONS] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001527#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001528 "Options:" \
1529 "\n -a Get/set fs readahead" \
1530 "\n -A Set drive read-lookahead flag (0/1)" \
1531 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1532 "\n -B Set Advanced Power Management setting (1-255)" \
1533 "\n -c Get/set IDE 32-bit IO setting" \
1534 "\n -C Check IDE power mode status" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001535 IF_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001536 "\n -d Get/set using_dma flag") \
1537 "\n -D Enable/disable drive defect-mgmt" \
1538 "\n -f Flush buffer cache for device on exit" \
1539 "\n -g Display drive geometry" \
1540 "\n -h Display terse usage information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001541 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001542 "\n -i Display drive identification") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001543 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001544 "\n -I Detailed/current information directly from drive") \
1545 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1546 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1547 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1548 "\n -m Get/set multiple sector count" \
1549 "\n -n Get/set ignore-write-errors flag (0/1)" \
1550 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1551 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001552/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001553 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1554 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001555 IF_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001556 "\n -R Register an IDE interface (DANGEROUS)") \
1557 "\n -S Set standby (spindown) timeout" \
1558 "\n -t Perform device read timings" \
1559 "\n -T Perform cache read timings" \
1560 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001561 IF_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001562 "\n -U Unregister an IDE interface (DANGEROUS)") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001563 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1564 "\n -V Display program version and exit immediately" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001565 IF_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001566 "\n -w Perform device reset (DANGEROUS)") \
1567 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001568 IF_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001569 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1570 "\n -X Set IDE xfer mode (DANGEROUS)" \
1571 "\n -y Put IDE drive in standby mode" \
1572 "\n -Y Put IDE drive to sleep" \
1573 "\n -Z Disable Seagate auto-powersaving mode" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001574 "\n -z Reread partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001575
Eric Andersen7e9276b2001-02-22 01:15:47 +00001576#define head_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001577 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001578#define head_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001579 "Print first 10 lines of each FILE (or stdin) to stdout.\n" \
Denys Vlasenko57493282010-03-02 16:18:14 +01001580 "With more than one FILE, precede each with a filename header.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001581 "\nOptions:" \
Denys Vlasenko57493282010-03-02 16:18:14 +01001582 "\n -n N[kbm] Print first N lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001583 IF_FEATURE_FANCY_HEAD( \
Denys Vlasenko57493282010-03-02 16:18:14 +01001584 "\n -c N[kbm] Print first N bytes" \
1585 "\n -q Never print headers" \
1586 "\n -v Always print headers" \
1587 ) \
1588 "\n" \
1589 "\nN may be suffixed by k (x1024), b (x512), or m (x1024^2)." \
Denis Vlasenko397de612008-03-17 08:55:44 +00001590
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001591#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001592 "$ head -n 2 /etc/passwd\n" \
1593 "root:x:0:0:root:/root:/bin/bash\n" \
1594 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001595
Denys Vlasenko57493282010-03-02 16:18:14 +01001596#define tail_trivial_usage \
1597 "[OPTIONS] [FILE]..."
1598#define tail_full_usage "\n\n" \
1599 "Print last 10 lines of each FILE (or stdin) to stdout.\n" \
1600 "With more than one FILE, precede each with a filename header.\n" \
1601 "\nOptions:" \
1602 "\n -f Print data as file grows" \
1603 IF_FEATURE_FANCY_TAIL( \
1604 "\n -s SECONDS Wait SECONDS between reads with -f" \
1605 ) \
1606 "\n -n N[kbm] Print last N lines" \
1607 IF_FEATURE_FANCY_TAIL( \
1608 "\n -c N[kbm] Print last N bytes" \
1609 "\n -q Never print headers" \
1610 "\n -v Always print headers" \
1611 "\n" \
1612 "\nN may be suffixed by k (x1024), b (x512), or m (x1024^2)." \
1613 "\nIf N starts with a '+', output begins with the Nth item from the start" \
1614 "\nof each file, not from the end." \
1615 ) \
1616
1617#define tail_example_usage \
1618 "$ tail -n 1 /etc/resolv.conf\n" \
1619 "nameserver 10.0.0.1\n"
1620
Glenn L McGrath60281112001-11-02 11:39:46 +00001621#define hexdump_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001622 "[-bcCdefnosvx" IF_FEATURE_HEXDUMP_REVERSE("R") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001623#define hexdump_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001624 "Display FILEs (or stdin) in a user specified format\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001625 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001626 "\n -b One-byte octal display" \
1627 "\n -c One-byte character display" \
1628 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1629 "\n -d Two-byte decimal display" \
1630 "\n -e FORMAT STRING" \
1631 "\n -f FORMAT FILE" \
1632 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1633 "\n -o Two-byte octal display" \
1634 "\n -s OFFSET Skip OFFSET bytes" \
1635 "\n -v Display all input data" \
1636 "\n -x Two-byte hexadecimal display" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001637 IF_FEATURE_HEXDUMP_REVERSE( \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001638 "\n -R Reverse of 'hexdump -Cv'") \
1639
1640#define hd_trivial_usage \
1641 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001642#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001643 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001644
Eric Andersen7e9276b2001-02-22 01:15:47 +00001645#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001646 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001647#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001648 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001649
1650#define hostname_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001651 "[OPTIONS] [HOSTNAME | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001652#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001653 "Get or set hostname or DNS domain name\n" \
1654 "\nOptions:" \
1655 "\n -s Short" \
1656 "\n -i Addresses for the hostname" \
1657 "\n -d DNS domain name" \
1658 "\n -f Fully qualified domain name" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001659 "\n -F FILE Use FILE's content as hostname" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001660
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001661#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001662 "$ hostname\n" \
1663 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001664
Denys Vlasenkod30b89c2009-06-26 01:55:45 +02001665#define dnsdomainname_trivial_usage NOUSAGE_STR
1666#define dnsdomainname_full_usage ""
1667
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001668#define httpd_trivial_usage \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001669 "[-ifv[v]]" \
1670 " [-c CONFFILE]" \
1671 " [-p [IP:]PORT]" \
1672 IF_FEATURE_HTTPD_SETUID(" [-u USER[:GRP]]") \
1673 IF_FEATURE_HTTPD_BASIC_AUTH(" [-r REALM]") \
1674 " [-h HOME]\n" \
1675 "or httpd -d/-e" IF_FEATURE_HTTPD_AUTH_MD5("/-m") " STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001676#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001677 "Listen for incoming HTTP requests\n" \
1678 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001679 "\n -i Inetd mode" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001680 "\n -f Don't daemonize" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001681 "\n -v[v] Verbose" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001682 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001683 IF_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001684 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001685 IF_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001686 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001687 "\n -h HOME Home directory (default .)" \
Denys Vlasenko8fc9e6a2010-04-02 10:40:58 +02001688 "\n -c FILE Configuration file (default {/etc,HOME}/httpd.conf)" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001689 IF_FEATURE_HTTPD_AUTH_MD5( \
1690 "\n -m STRING MD5 crypt STRING") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001691 "\n -e STRING HTML encode STRING" \
1692 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001693
Robert Griebl1cd04452002-07-21 16:50:49 +00001694#define hwclock_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001695 IF_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001696 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1697 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001698 " [-f FILE]" \
1699 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001700 IF_NOT_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001701 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1702 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001703#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001704 "Query and set hardware clock (RTC)\n" \
1705 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001706 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001707 "\n -s Set system time from hardware clock" \
1708 "\n -w Set hardware clock to system time" \
1709 "\n -u Hardware clock is in UTC" \
1710 "\n -l Hardware clock is in local time" \
1711 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001712
Eric Andersen7e9276b2001-02-22 01:15:47 +00001713#define id_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001714 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001715#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001716 "Print information about USER or the current user\n" \
1717 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001718 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001719 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001720 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001721 "\n -u Print user ID" \
Denis Vlasenko4f3209b2008-09-13 12:51:10 +00001722 "\n -g Print group ID" \
1723 "\n -G Print supplementary group IDs" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001724 "\n -n Print name instead of a number" \
1725 "\n -r Print real user ID instead of effective ID" \
1726
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001727#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001728 "$ id\n" \
1729 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001730
Eric Andersen7e9276b2001-02-22 01:15:47 +00001731#define ifconfig_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001732 IF_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001733#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001734 "Configure a network interface\n" \
1735 "\nOptions:" \
1736 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001737 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001738 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001739 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001740 " [del ADDRESS[/PREFIXLEN]]\n") \
1741 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1742 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001743 IF_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001744 " [outfill NN] [keepalive NN]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001745 " " IF_FEATURE_IFCONFIG_HW("[hw ether" IF_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001746 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001747 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001748 IF_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001749 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001750 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001751
Denis Vlasenko06aed432008-02-26 18:25:24 +00001752#define ifenslave_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001753 "[-cdf] MASTER_IFACE SLAVE_IFACE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001754#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001755 "Configure network interfaces for parallel routing\n" \
1756 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001757 "\n -c, --change-active Change active slave" \
1758 "\n -d, --detach Remove slave interface from bonding device" \
1759 "\n -f, --force Force, even if interface is not Ethernet" \
1760/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001761
Denis Vlasenko06aed432008-02-26 18:25:24 +00001762#define ifenslave_example_usage \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001763 "To create a bond device, simply follow these three steps:\n" \
1764 "- ensure that the required drivers are properly loaded:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001765 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001766 "- assign an IP address to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001767 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001768 "- attach all the interfaces you need to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001769 " # ifenslave bond0 eth0 eth1 eth2\n" \
1770 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1771 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001772 " To detach a dead interface without setting the bond device down:\n" \
1773 " # ifenslave -d bond0 eth1\n\n" \
1774 " To set the bond device down and automatically release all the slaves:\n" \
1775 " # ifconfig bond0 down\n\n" \
1776 " To change active slave:\n" \
1777 " # ifenslave -c bond0 eth0\n" \
1778
1779#define ifplugd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001780 "[OPTIONS]"
Denis Vlasenko71c16572009-04-26 01:08:51 +00001781#define ifplugd_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +02001782 "Network interface plug detection daemon\n" \
1783 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001784 "\n -n Don't daemonize" \
1785 "\n -s Don't log to syslog" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001786 "\n -i IFACE Interface" \
1787 "\n -f/-F Treat link detection error as link down/link up" \
1788 "\n (otherwise exit on error)" \
Denys Vlasenko999e4422010-01-08 13:03:48 +01001789 "\n -a Don't up interface at each link probe" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001790 "\n -M Monitor creation/destruction of interface" \
1791 "\n (otherwise it must exist)" \
1792 "\n -r PROG Script to run" \
1793 "\n -x ARG Extra argument for script" \
1794 "\n -I Don't exit on nonzero exit code from script" \
1795 "\n -p Don't run script on daemon startup" \
1796 "\n -q Don't run script on daemon quit" \
1797 "\n -l Run script on startup even if no cable is detected" \
1798 "\n -t SECS Poll time in seconds" \
1799 "\n -u SECS Delay before running script after link up" \
1800 "\n -d SECS Delay after link down" \
Denys Vlasenkob8f0e802010-01-07 14:56:50 +01001801 "\n -m MODE API mode (mii, priv, ethtool, wlan, iff, auto)" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001802 "\n -k Kill running daemon" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001803
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001804#define ifup_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001805 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] IFACE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001806#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001807 "Options:" \
1808 "\n -a De/configure all interfaces automatically" \
1809 "\n -i FILE Use FILE for interface definitions" \
1810 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001811 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001812 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001813 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001814 ) \
1815 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001816 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001817
1818#define ifdown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001819 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001820#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001821 "Options:" \
1822 "\n -a De/configure all interfaces automatically" \
1823 "\n -i FILE Use FILE for interface definitions" \
1824 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001825 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001826 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001827 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001828 ) \
1829 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001830 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001831
Glenn L McGrath06e95652003-02-09 06:51:14 +00001832#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001833 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001834#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001835 "Listen for network connections and launch programs\n" \
1836 "\nOptions:" \
1837 "\n -f Run in foreground" \
1838 "\n -e Log to stderr" \
1839 "\n -q N Socket listen queue (default: 128)" \
1840 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001841 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001842
Eric Andersen7e9276b2001-02-22 01:15:47 +00001843#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001844 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001845#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001846 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001847
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001848#define init_notes_usage \
1849"This version of init is designed to be run only by the kernel.\n" \
1850"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001851"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001852"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001853"runlevels, use sysvinit.\n" \
1854"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001855"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001856"it has the following default behavior:\n" \
1857"\n" \
1858" ::sysinit:/etc/init.d/rcS\n" \
1859" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001860" ::ctrlaltdel:/sbin/reboot\n" \
1861" ::shutdown:/sbin/swapoff -a\n" \
1862" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001863" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001864"\n" \
1865"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1866"\n" \
1867" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001868" tty3::askfirst:/bin/sh\n" \
1869" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001870"\n" \
1871"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1872"\n" \
1873" <id>:<runlevels>:<action>:<process>\n" \
1874"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001875" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001876"\n" \
1877" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1878" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001879" the specified process to run on. The contents of this field are\n" \
1880" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1881" be unique, although if it isn't you may have strange results. If this\n" \
1882" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001883" note that if BusyBox detects that a serial console is in use, then only\n" \
1884" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001885" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001886" stinkin' utmp.\n" \
1887"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001888" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001889"\n" \
1890" The runlevels field is completely ignored.\n" \
1891"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001892" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001893"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001894" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001895" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001896"\n" \
1897" The available actions can be classified into two groups: actions\n" \
1898" that are run only once, and actions that are re-run when the specified\n" \
1899" process exits.\n" \
1900"\n" \
1901" Run only-once actions:\n" \
1902"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001903" 'sysinit' is the first item run on boot. init waits until all\n" \
1904" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001905" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001906" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001907" the specified task completes. 'once' actions are asynchronous,\n" \
1908" therefore, init does not wait for them to complete. 'restart' is\n" \
1909" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001910" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001911" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001912" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001913" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001914" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001915" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001916" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001917" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001918"\n" \
1919" Run repeatedly actions:\n" \
1920"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001921" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001922" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001923" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1924" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001925" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001926" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001927" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001928" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001929"\n" \
1930" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001931" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001932" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001933"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001934" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001935"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001936" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001937"\n" \
1938"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001939"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001940" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001941" #\n" \
1942" ::sysinit:/etc/init.d/rcS\n" \
1943" \n" \
1944" # /bin/sh invocations on selected ttys\n" \
1945" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001946" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001947" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001948" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001949" tty2::askfirst:-/bin/sh\n" \
1950" tty3::askfirst:-/bin/sh\n" \
1951" tty4::askfirst:-/bin/sh\n" \
1952" \n" \
1953" # /sbin/getty invocations for selected ttys\n" \
1954" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001955" tty4::respawn:/sbin/getty 38400 tty4\n" \
1956" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001957" \n" \
1958" \n" \
1959" # Example of how to put a getty on a serial line (for a terminal)\n" \
1960" #\n" \
1961" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1962" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1963" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001964" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001965" #::respawn:/sbin/getty 57600 ttyS2\n" \
1966" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001967" # Stuff to do when restarting the init process\n" \
1968" ::restart:/sbin/init\n" \
1969" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001970" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001971" ::ctrlaltdel:/sbin/reboot\n" \
1972" ::shutdown:/bin/umount -a -r\n" \
1973" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001974
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001975#define inotifyd_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001976 "PROG FILE1[:MASK]..."
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001977#define inotifyd_full_usage "\n\n" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001978 "Run PROG on filesystem changes." \
1979 "\nWhen a filesystem event matching MASK occurs on FILEn," \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001980 "\nPROG ACTUAL_EVENTS FILEn [SUBFILE] is run." \
Denis Vlasenko289ff0e2008-11-14 21:52:16 +00001981 "\nEvents:" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001982 "\n a File is accessed" \
1983 "\n c File is modified" \
1984 "\n e Metadata changed" \
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001985 "\n w Writable file is closed" \
1986 "\n 0 Unwritable file is closed" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001987 "\n r File is opened" \
Denis Vlasenkoa09a42c2008-11-17 22:19:18 +00001988 "\n D File is deleted" \
1989 "\n M File is moved" \
1990 "\n u Backing fs is unmounted" \
1991 "\n o Event queue overflowed" \
1992 "\n x File can't be watched anymore" \
1993 "\nIf watching a directory:" \
1994 "\n m Subfile is moved into dir" \
1995 "\n y Subfile is moved out of dir" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001996 "\n n Subfile is created" \
1997 "\n d Subfile is deleted" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001998 "\n" \
1999 "\ninotifyd waits for PROG to exit." \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002000 "\nWhen x event happens for all FILEs, inotifyd exits." \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002001
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002002/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00002003#define install_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002004 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [SOURCE]... DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002005#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002006 "Copy files and set attributes\n" \
2007 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002008 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002009 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002010 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002011 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002012 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002013 "\n -o USER Set ownership" \
2014 "\n -g GRP Set group ownership" \
2015 "\n -m MODE Set permissions" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002016 IF_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002017 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002018 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002019
2020/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002021#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00002022 "[OPTIONS] {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002023 IF_FEATURE_IP_ADDRESS("address | ") \
2024 IF_FEATURE_IP_ROUTE("route | ") \
2025 IF_FEATURE_IP_LINK("link | ") \
2026 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2027 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002028 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002029#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002030 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002031 "where OBJECT := {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002032 IF_FEATURE_IP_ADDRESS("address | ") \
2033 IF_FEATURE_IP_ROUTE("route | ") \
2034 IF_FEATURE_IP_LINK("link | ") \
2035 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2036 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002037 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002038 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002039
2040#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002041 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002042 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002043#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002044 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002045 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
2046 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002047 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002048 " [broadcast ADDR] [anycast ADDR]\n" \
2049 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002050 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002051
Eric Andersende4f07e2003-12-11 01:18:07 +00002052#define ipcalc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002053 "[OPTIONS] ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002054#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002055 "Calculate IP network settings from a IP address\n" \
2056 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002057 IF_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002058 "\n -b,--broadcast Display calculated broadcast address" \
2059 "\n -n,--network Display calculated network address" \
2060 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002061 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002062 "\n -p,--prefix Display the prefix for IP/NETMASK" \
2063 "\n -h,--hostname Display first resolved host name" \
2064 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002065 ) \
2066 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002067 IF_NOT_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002068 "\n -b Display calculated broadcast address" \
2069 "\n -n Display calculated network address" \
2070 "\n -m Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002071 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002072 "\n -p Display the prefix for IP/NETMASK" \
2073 "\n -h Display first resolved host name" \
2074 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002075 ) \
2076 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00002077
Rob Landley6eb1e412005-06-20 04:30:36 +00002078#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002079 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002080#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002081 "Upper-case options MQS remove an object by shmkey value.\n" \
2082 "Lower-case options remove an object by shmid value.\n" \
2083 "\nOptions:" \
2084 "\n -mM Remove memory segment after last detach" \
2085 "\n -qQ Remove message queue" \
2086 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002087
2088#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002089 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002090#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002091 " -i Show specific resource" \
2092 "\nResource specification:" \
2093 "\n -m Shared memory segments" \
2094 "\n -q Message queues" \
2095 "\n -s Semaphore arrays" \
2096 "\n -a All (default)" \
2097 "\nOutput format:" \
2098 "\n -t Time" \
2099 "\n -c Creator" \
2100 "\n -p Pid" \
2101 "\n -l Limits" \
2102 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002103
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002104#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002105 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002106#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00002107 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002108 " dynamic { on | off } |\n" \
2109 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002110 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002111
2112#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002113 "{ list | flush | { add | del | change | append |\n" \
2114 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002115#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002116 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002117 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
2118 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002119 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002120 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00002121 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
2122 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002123
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002124#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002125 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002126#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002127 "iprule [list | add | del] SELECTOR ACTION\n" \
2128 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2129 " [dev STRING] [pref NUMBER]\n" \
2130 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2131 " [prohibit | reject | unreachable]\n" \
2132 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002133 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002134
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002135#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002136 "{ add | change | del | show } [NAME]\n" \
2137 " [mode { ipip | gre | sit }]\n" \
2138 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002139#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002140 "iptunnel { add | change | del | show } [NAME]\n" \
2141 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2142 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002143 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002144
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002145#define kbd_mode_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002146 "[-a|k|s|u] [-C TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002147#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002148 "Report or set the keyboard mode\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002149 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002150 "\n -a Default (ASCII)" \
2151 "\n -k Medium-raw (keyboard)" \
2152 "\n -s Raw (scancode)" \
2153 "\n -u Unicode (utf-8)" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002154 "\n -C TTY Affect TTY instead of /dev/tty" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002155
Eric Andersen7e9276b2001-02-22 01:15:47 +00002156#define kill_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002157 "[-l] [-SIG] PID..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002158#define kill_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002159 "Send a signal (default: TERM) to given PIDs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002160 "\nOptions:" \
2161 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002162/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002163
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002164#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002165 "$ ps | grep apache\n" \
2166 "252 root root S [apache]\n" \
2167 "263 www-data www-data S [apache]\n" \
2168 "264 www-data www-data S [apache]\n" \
2169 "265 www-data www-data S [apache]\n" \
2170 "266 www-data www-data S [apache]\n" \
2171 "267 www-data www-data S [apache]\n" \
2172 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002173
2174#define killall_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002175 "[-l] [-q] [-SIG] PROCESS_NAME..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002176#define killall_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002177 "Send a signal (default: TERM) to given processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002178 "\nOptions:" \
2179 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002180/* "\n -s SIG Yet another way of specifying SIG" */ \
Denys Vlasenko07697852009-10-06 21:11:37 +02002181 "\n -q Don't complain if no processes were killed" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002182
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002183#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002184 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002185
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002186#define killall5_trivial_usage \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002187 "[-l] [-SIG] [-o PID]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002188#define killall5_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002189 "Send a signal (default: TERM) to all processes outside current session\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002190 "\nOptions:" \
2191 "\n -l List all signal names and numbers" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002192 "\n -o PID Don't signal this PID" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002193/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002194
Mark Whitley6317c4b2001-03-12 22:51:50 +00002195#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002196 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002197#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002198 "Kernel logger\n" \
2199 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002200 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002201 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002202
Eric Andersen7e9276b2001-02-22 01:15:47 +00002203#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002204 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002205#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002206 "Print STRING's length"
2207
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002208#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002209 "$ length Hello\n" \
2210 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002211
Rob Landley9200e792005-09-15 19:26:59 +00002212#define less_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002213 "[-EMNmh~I?] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002214#define less_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002215 "View FILE (or stdin) one screenful at a time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002216 "\nOptions:" \
2217 "\n -E Quit once the end of a file is reached" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002218 "\n -M,-m Display status line with line numbers" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002219 "\n and percentage through the file" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002220 "\n -N Prefix line number to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002221 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002222 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002223
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002224#define linux32_trivial_usage NOUSAGE_STR
2225#define linux32_full_usage ""
2226#define linux64_trivial_usage NOUSAGE_STR
2227#define linux64_full_usage ""
2228
2229#define linuxrc_trivial_usage NOUSAGE_STR
2230#define linuxrc_full_usage ""
2231
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002232#define setarch_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002233 "personality PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002234#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002235 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002236 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002237 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002238
Eric Andersen7e9276b2001-02-22 01:15:47 +00002239#define ln_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002240 "[OPTIONS] TARGET... LINK|DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002241#define ln_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002242 "Create a link LINK or DIR/TARGET to the specified TARGET(s)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002243 "\nOptions:" \
2244 "\n -s Make symlinks instead of hardlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002245 "\n -f Remove existing destinations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002246 "\n -n Don't dereference symlinks - treat like normal file" \
2247 "\n -b Make a backup of the target (if exists) before link operation" \
2248 "\n -S suf Use suffix instead of ~ when making backup files" \
2249
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002250#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002251 "$ ln -s BusyBox /tmp/ls\n" \
2252 "$ ls -l /tmp/ls\n" \
2253 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002254
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002255#define load_policy_trivial_usage NOUSAGE_STR
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002256#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002257
Eric Andersen7e9276b2001-02-22 01:15:47 +00002258#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002259 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002260#define loadfont_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002261 "Load a console font from stdin" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002262/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2263
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002264#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002265 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002266
2267#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002268 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002269#define loadkmap_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002270 "Load a binary keyboard translation table from stdin\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002271/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2272
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002273#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002274 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002275
2276#define logger_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002277 "[OPTIONS] [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002278#define logger_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002279 "Write MESSAGE (or stdin) to syslog\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002280 "\nOptions:" \
2281 "\n -s Log to stderr as well as the system log" \
2282 "\n -t TAG Log using the specified tag (defaults to user name)" \
2283 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002284
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002285#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002286 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002287
Robert Griebl1fca5582002-06-04 20:45:46 +00002288#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002289 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002290#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002291 "Begin a new session on the system\n" \
2292 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002293 "\n -f Don't authenticate (user already authenticated)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002294 "\n -h Name of the remote host" \
2295 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002296
Eric Andersen7e9276b2001-02-22 01:15:47 +00002297#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002298 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002299#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002300 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002301#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002302 "$ logname\n" \
2303 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002304
Mark Whitley6317c4b2001-03-12 22:51:50 +00002305#define logread_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002306 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002307#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002308 "Show messages in syslogd's circular buffer\n" \
2309 "\nOptions:" \
2310 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002311
Matt Kraai83788da2002-03-20 17:38:37 +00002312#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002313 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2314 " losetup -d LOOPDEV - disassociate\n" \
2315 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002316#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002317 "Options:" \
2318 "\n -o OFS Start OFS bytes into FILE" \
2319 "\n -f Show first free loop device" \
2320
Rob Landley1d589b22005-11-29 23:47:10 +00002321#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002322 "No arguments will display all current associations.\n" \
2323 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002324 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002325 "and filename of the file the loop device is currently bound to.\n\n" \
2326 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002327 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2328 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002329
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002330#define lpd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002331 "SPOOLDIR [HELPER [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002332#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002333 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2334 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002335 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002336 "\ndirectory and HELPER program is called. Name of file to print" \
2337 "\nis passed in $DATAFILE variable." \
2338 "\nExample:" \
2339 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002340
Denis Vlasenko68444b92008-02-22 22:24:48 +00002341#define lpq_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002342 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID]... [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002343#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002344 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002345 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002346 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002347 "\n -f Force any waiting job to be printed" \
2348 "\n -s Short display" \
2349
2350#define lpr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002351 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE]..."
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002352/* -C CLASS exists too, not shown.
2353 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002354#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002355 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002356 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002357 "\n -m Send mail on completion" \
2358 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002359 "\n -V Verbose" \
2360
Eric Andersen7e9276b2001-02-22 01:15:47 +00002361#define ls_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002362 "[-1Aa" IF_FEATURE_LS_TIMESTAMPS("c") "Cd" \
2363 IF_FEATURE_LS_TIMESTAMPS("e") IF_FEATURE_LS_FILETYPES("F") "iln" \
2364 IF_FEATURE_LS_FILETYPES("p") IF_FEATURE_LS_FOLLOWLINKS("L") \
2365 IF_FEATURE_LS_RECURSIVE("R") IF_FEATURE_LS_SORTFILES("rS") "s" \
2366 IF_FEATURE_AUTOWIDTH("T") IF_FEATURE_LS_TIMESTAMPS("tu") \
2367 IF_FEATURE_LS_SORTFILES("v") IF_FEATURE_AUTOWIDTH("w") "x" \
2368 IF_FEATURE_LS_SORTFILES("X") IF_FEATURE_HUMAN_READABLE("h") "k" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002369 IF_SELINUX("K") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002370#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002371 "List directory contents\n" \
2372 "\nOptions:" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002373 "\n -1 List in a single column" \
2374 "\n -A Don't list . and .." \
2375 "\n -a Don't hide entries starting with ." \
2376 "\n -C List by columns" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002377 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002378 "\n -c With -l: sort by ctime") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002379 IF_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002380 "\n --color[={always,never,auto}] Control coloring") \
2381 "\n -d List directory entries instead of contents" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002382 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002383 "\n -e List full date and time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002384 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002385 "\n -F Append indicator (one of */=@|) to entries") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002386 "\n -i List inode numbers" \
2387 "\n -l Long listing format" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002388 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002389 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002390 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002391 IF_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002392 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002393 IF_FEATURE_LS_RECURSIVE( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002394 "\n -R Recurse") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002395 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002396 "\n -r Sort in reverse order") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002397 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002398 "\n -S Sort by file size") \
Denis Vlasenko397de612008-03-17 08:55:44 +00002399 "\n -s List the size of each file, in blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002400 IF_FEATURE_AUTOWIDTH( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002401 "\n -T N Assume tabstop every N columns") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002402 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002403 "\n -t With -l: sort by modification time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002404 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002405 "\n -u With -l: sort by access time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002406 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002407 "\n -v Sort by version") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002408 IF_FEATURE_AUTOWIDTH( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002409 "\n -w N Assume the terminal is N columns wide") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002410 "\n -x List by lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002411 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002412 "\n -X Sort by extension") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002413 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002414 "\n -h List sizes in human readable format (1K 243M 2G)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002415 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002416 "\n -k List security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002417 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002418 "\n -K List security context in long format") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002419 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002420 "\n -Z List security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002421
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002422#define lsattr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002423 "[-Radlv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002424#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002425 "List file attributes on an ext2 fs\n" \
2426 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002427 "\n -R Recurse" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002428 "\n -a Don't hide entries starting with ." \
Denis Vlasenko397de612008-03-17 08:55:44 +00002429 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002430 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002431 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002432
Eric Andersen7e9276b2001-02-22 01:15:47 +00002433#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002434 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002435#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002436 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002437
Souf Oued982bc712009-12-05 17:56:25 +01002438#define lspci_trivial_usage \
2439 "[-mk]"
2440#define lspci_full_usage "\n\n" \
2441 "List all PCI devices" \
2442 "\n" \
2443 "\n -m Parseable output" \
2444 "\n -k Show driver" \
2445
Souf Oued11a802a2009-12-07 01:37:34 +01002446#define lsusb_trivial_usage NOUSAGE_STR
2447#define lsusb_full_usage ""
2448
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002449#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002450#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002451 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002452#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002453 "Create a range of block or character special files" \
2454 "\n" \
2455 "\nTYPE is:" \
2456 "\n b Block device" \
2457 "\n c Character device" \
2458 "\n f FIFO, MAJOR and MINOR are ignored" \
2459 "\n" \
2460 "\nFIRST..LAST specify numbers appended to NAME." \
2461 "\nIf 's' is the last argument, the base device is created as well." \
2462 "\n" \
2463 "\nExamples:" \
2464 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2465 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002466#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002467 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2468 "[creates ttyS2-ttyS63]\n" \
2469 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2470 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002471#endif
2472
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002473#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002474#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002475 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002476#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002477 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002478 "Device table entries take the form of:\n" \
2479 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002480 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002481 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002482 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002483 " c Character device\n" \
2484 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002485 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002486 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002487 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2488 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002489#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002490 "For example:\n" \
2491 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2492 "/dev d 755 0 0 - - - - -\n" \
2493 "/dev/console c 666 0 0 5 1 - - -\n" \
2494 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2495 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2496 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2497 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2498 "Will Produce:\n" \
2499 "/dev\n" \
2500 "/dev/console\n" \
2501 "/dev/null\n" \
2502 "/dev/zero\n" \
2503 "/dev/hda\n" \
2504 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002505#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002506
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002507#define makemime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002508 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002509#define makemime_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002510 "Create multipart MIME-encoded message from FILEs\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002511/* "Transfer encoding is base64, disposition is inline (not attachment)\n" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002512 "\nOptions:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002513 "\n -o FILE Output. Default: stdout" \
2514 "\n -a HDR Add header. Examples:" \
2515 "\n \"From: user@host.org\", \"Date: `date -R`\"" \
2516 "\n -c CT Content type. Default: text/plain" \
2517 "\n -C CS Charset. Default: " CONFIG_FEATURE_MIME_CHARSET \
2518/* "\n -e ENC Transfer encoding. Ignored. base64 is assumed" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002519 "\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002520 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002521
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002522#define man_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002523 "[OPTIONS] [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002524#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002525 "Format and display manual page\n" \
2526 "\nOptions:" \
2527 "\n -a Display all pages" \
2528 "\n -w Show page locations" \
2529
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002530#define matchpathcon_trivial_usage \
2531 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002532#define matchpathcon_full_usage "\n\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002533 " -n Don't display path" \
2534 "\n -N Don't use translations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002535 "\n -f Use alternate file_context file" \
2536 "\n -p Use prefix to speed translations" \
2537 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002538
Eric Andersen7e9276b2001-02-22 01:15:47 +00002539#define md5sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002540 "[OPTIONS] [FILE]..." \
2541 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTIONS] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002542#define md5sum_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002543 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2544 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002545 "\nOptions:" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002546 "\n -c Check sums against given list" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002547 "\n -s Don't output anything, status code shows success" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002548 "\n -w Warn about improperly formatted checksum lines" \
2549 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002550
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002551#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002552 "$ md5sum < busybox\n" \
2553 "6fd11e98b98a58f64ff3398d7b324003\n" \
2554 "$ md5sum busybox\n" \
2555 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2556 "$ md5sum -c -\n" \
2557 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2558 "busybox: OK\n" \
2559 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002560
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002561#define sha1sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002562 "[OPTIONS] [FILE]..." \
2563 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002564#define sha1sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002565 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002566 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002567 "\nOptions:" \
2568 "\n -c Check sums against given list" \
2569 "\n -s Don't output anything, status code shows success" \
2570 "\n -w Warn about improperly formatted checksum lines" \
2571 )
2572
2573#define sha256sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002574 "[OPTIONS] [FILE]..." \
2575 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha256sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002576#define sha256sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002577 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA256 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002578 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002579 "\nOptions:" \
2580 "\n -c Check sums against given list" \
2581 "\n -s Don't output anything, status code shows success" \
2582 "\n -w Warn about improperly formatted checksum lines" \
2583 )
2584
2585#define sha512sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002586 "[OPTIONS] [FILE]..." \
2587 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha512sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002588#define sha512sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002589 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA512 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002590 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002591 "\nOptions:" \
2592 "\n -c Check sums against given list" \
2593 "\n -s Don't output anything, status code shows success" \
2594 "\n -w Warn about improperly formatted checksum lines" \
2595 )
2596
Rob Landley70f7ef72005-12-13 08:21:33 +00002597#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002598 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002599#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002600 " -s Scan /sys and populate /dev during system boot\n" \
2601 "\n" \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002602 "It can be run by kernel as a hotplug helper. To activate it:\n" \
Denys Vlasenkof92874e2009-12-05 15:59:05 +01002603 " echo /sbin/mdev > /proc/sys/kernel/hotplug\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002604 IF_FEATURE_MDEV_CONF( \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002605 "It uses /etc/mdev.conf with lines\n" \
Denis Vlasenkof2b39e02009-04-13 23:18:52 +00002606 "[-]DEVNAME UID:GID PERM" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002607 IF_FEATURE_MDEV_RENAME(" [>|=PATH]") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002608 IF_FEATURE_MDEV_EXEC(" [@|$|*PROG]") \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002609 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002610
Rob Landleyef10d522006-06-26 14:11:33 +00002611#define mdev_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002612 IF_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002613 "The mdev config file contains lines that look like:\n" \
2614 " hd[a-z][0-9]* 0:3 660\n\n" \
2615 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002616 IF_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002617 "Optionally, that can be followed (on the same line) by a special character\n" \
2618 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002619 "device(s). The environment variable $MDEV indicates the active device node\n" \
2620 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002621 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2622 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002623 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002624 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002625 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002626 "Config file parsing stops on the first matching line. If no config\n" \
2627 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002628 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002629 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002630
Glenn L McGrath061c9002002-09-16 04:21:46 +00002631#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002632 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002633#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002634 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002635 " y Allow write access to your terminal\n" \
2636 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002637
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002638#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002639 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002640#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002641 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2642 "\nOptions:" \
2643 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2644 "\n next byte to it" \
2645 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2646 "\n -s Set serial line to SPEED" \
2647 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002648
Eric Andersen7e9276b2001-02-22 01:15:47 +00002649#define mkdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002650 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002651#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002652 "Create DIRECTORY\n" \
2653 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002654 "\n -m Mode" \
2655 "\n -p No error if exists; make parent directories as needed" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002656 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002657 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002658 )
2659
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002660#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002661 "$ mkdir /tmp/foo\n" \
2662 "$ mkdir /tmp/foo\n" \
2663 "/tmp/foo: File exists\n" \
2664 "$ mkdir /tmp/foo/bar/baz\n" \
2665 "/tmp/foo/bar/baz: No such file or directory\n" \
2666 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002667
Eric Andersen7e9276b2001-02-22 01:15:47 +00002668#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002669 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002670#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002671 "Create named pipe (identical to 'mknod name p')\n" \
2672 "\nOptions:" \
2673 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002674 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002675 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002676 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002677
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002678#define mkfs_ext2_trivial_usage \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002679 "[-Fn] " \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002680 /* "[-c|-l filename] " */ \
2681 "[-b BLK_SIZE] " \
2682 /* "[-f fragment-size] [-g blocks-per-group] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002683 "[-i INODE_RATIO] [-I INODE_SIZE] " \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002684 /* "[-j] [-J journal-options] [-N number-of-inodes] " */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002685 "[-m RESERVED_PERCENT] " \
2686 /* "[-o creator-os] [-O feature[,...]] [-q] " */ \
2687 /* "[r fs-revision-level] [-E extended-options] [-v] [-F] " */ \
2688 "[-L LABEL] " \
2689 /* "[-M last-mounted-directory] [-S] [-T filesystem-type] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002690 "BLOCKDEV [KBYTES]"
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002691#define mkfs_ext2_full_usage "\n\n" \
2692 " -b BLK_SIZE Block size, bytes" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002693/* "\n -c Check device for bad blocks" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002694/* "\n -E opts Set extended options" */ \
2695/* "\n -f size Fragment size in bytes" */ \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002696 "\n -F Force" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002697/* "\n -g N Number of blocks in a block group" */ \
Denys Vlasenko838e07a2009-10-22 12:15:33 +02002698 "\n -i RATIO Max number of files is filesystem_size / RATIO" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002699 "\n -I BYTES Inode size (min 128)" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002700/* "\n -j Create a journal (ext3)" */ \
2701/* "\n -J opts Set journal options (size/device)" */ \
2702/* "\n -l file Read bad blocks list from file" */ \
Denys Vlasenko6a8cfdc2009-10-17 23:41:15 +02002703 "\n -L LBL Volume label" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002704 "\n -m PERCENT Percent of blocks to reserve for admin" \
2705/* "\n -M dir Set last mounted directory" */ \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002706 "\n -n Dry run" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002707/* "\n -N N Number of inodes to create" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002708/* "\n -o os Set the 'creator os' field" */ \
2709/* "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" */ \
2710/* "\n -q Quiet" */ \
2711/* "\n -r rev Set filesystem revision" */ \
2712/* "\n -S Write superblock and group descriptors only" */ \
2713/* "\n -T fs-type Set usage type (news/largefile/largefile4)" */ \
2714/* "\n -v Verbose" */ \
2715
Eric Andersen7e9276b2001-02-22 01:15:47 +00002716#define mkfs_minix_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002717 "[-c | -l FILE] [-nXX] [-iXX] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002718#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002719 "Make a MINIX filesystem\n" \
2720 "\nOptions:" \
2721 "\n -c Check device for bad blocks" \
2722 "\n -n [14|30] Maximum length of filenames" \
2723 "\n -i INODES Number of inodes for the filesystem" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002724 "\n -l FILE Read bad blocks list from FILE" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002725 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002726
Vladimir Dronnikov0d8ea642009-11-02 10:41:46 +01002727#define mkfs_reiser_trivial_usage \
2728 "[-f] [-l LABEL] BLOCKDEV [4K-BLOCKS]"
2729
2730#define mkfs_reiser_full_usage "\n\n" \
2731 "Make a ReiserFS V3 filesystem\n" \
2732 "\nOptions:" \
2733 "\n -f Force" \
2734 "\n -l LBL Volume label" \
2735
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002736#define mkfs_vfat_trivial_usage \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002737 "[-v] [-n LABEL] BLOCKDEV [KBYTES]"
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002738/* Accepted but ignored:
2739 "[-c] [-C] [-I] [-l bad-block-file] [-b backup-boot-sector] "
2740 "[-m boot-msg-file] [-i volume-id] "
2741 "[-s sectors-per-cluster] [-S logical-sector-size] [-f number-of-FATs] "
2742 "[-h hidden-sectors] [-F fat-size] [-r root-dir-entries] [-R reserved-sectors] "
2743*/
2744#define mkfs_vfat_full_usage "\n\n" \
2745 "Make a FAT32 filesystem\n" \
2746 "\nOptions:" \
2747/* "\n -c Check device for bad blocks" */ \
2748 "\n -v Verbose" \
2749/* "\n -I Allow to use entire disk device (e.g. /dev/hda)" */ \
2750 "\n -n LBL Volume label" \
2751
Eric Andersen7e9276b2001-02-22 01:15:47 +00002752#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002753 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002754#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002755 "Create a special file (block, character, or pipe)\n" \
2756 "\nOptions:" \
2757 "\n -m Create the special file using the specified mode (default a=rw)" \
2758 "\nTYPEs include:" \
2759 "\n b: Make a block device" \
2760 "\n c or u: Make a character device" \
2761 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002762 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002763 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002764 )
2765
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002766#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002767 "$ mknod /dev/fd0 b 2 0\n" \
2768 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002769
Eric Andersen7e9276b2001-02-22 01:15:47 +00002770#define mkswap_trivial_usage \
Denys Vlasenko40e7d252010-02-01 23:48:27 +01002771 "[OPTIONS] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002772#define mkswap_full_usage "\n\n" \
Denys Vlasenko68c67462009-11-03 05:51:20 +01002773 "Prepare BLOCKDEV to be used as swap partition\n" \
2774 "\nOptions:" \
2775 "\n -L LBL Label" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002776
Eric Andersen7e9276b2001-02-22 01:15:47 +00002777#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002778 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002779#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002780 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002781 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002782 "\nOptions:" \
2783 "\n -d Make a directory instead of a file" \
2784/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2785 "\n -t Generate a path rooted in temporary directory" \
2786 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2787 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002788 "\nFor -t or -p, directory is chosen as follows:" \
2789 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002790
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002791#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002792 "$ mktemp /tmp/temp.XXXXXX\n" \
2793 "/tmp/temp.mWiLjM\n" \
2794 "$ ls -la /tmp/temp.mWiLjM\n" \
2795 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002796
Eric Andersen7e9276b2001-02-22 01:15:47 +00002797#define more_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002798 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002799#define more_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002800 "View FILE (or stdin) one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002801
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002802#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002803 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002804
Eric Andersen7e9276b2001-02-22 01:15:47 +00002805#define mount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002806 "[OPTIONS] [-o OPTS] DEVICE NODE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002807#define mount_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002808 "Mount a filesystem. Filesystem autodetection requires /proc.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002809 "\nOptions:" \
2810 "\n -a Mount all filesystems in fstab" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002811 IF_FEATURE_MOUNT_FAKE( \
2812 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002813 "\n -f Update /etc/mtab, but don't mount" \
2814 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002815 IF_NOT_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002816 "\n -f Dry run" \
2817 ) \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002818 ) \
Denys Vlasenkoe2e4cc22009-06-19 11:48:29 +02002819 IF_FEATURE_MOUNT_HELPERS( \
2820 "\n -i Don't run mount helper" \
2821 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002822 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002823 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002824 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002825 "\n -r Read-only mount" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002826 "\n -w Read-write mount (default)" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002827 "\n -t FSTYPE Filesystem type" \
2828 "\n -O OPT Mount only filesystems with option OPT (-a only)" \
2829 "\n-o OPT:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002830 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002831 "\n loop Ignored (loop devices are autodetected)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002832 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002833 IF_FEATURE_MOUNT_FLAGS( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002834 "\n [a]sync Writes are [a]synchronous" \
2835 "\n [no]atime Disable/enable updates to inode access times" \
2836 "\n [no]diratime Disable/enable atime updates to directories" \
2837 "\n [no]relatime Disable/enable atime updates relative to modification time" \
2838 "\n [no]dev (Dis)allow use of special device files" \
2839 "\n [no]exec (Dis)allow use of executable files" \
2840 "\n [no]suid (Dis)allow set-user-id-root programs" \
2841 "\n [r]shared Convert [recursively] to a shared subtree" \
2842 "\n [r]slave Convert [recursively] to a slave subtree" \
2843 "\n [r]private Convert [recursively] to a private subtree" \
2844 "\n [un]bindable Make mount point [un]able to be bind mounted" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002845 "\n bind Bind a file or directory to another location" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002846 "\n move Relocate an existing mount point" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002847 ) \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002848 "\n remount Remount a mounted filesystem, changing flags" \
2849 "\n ro/rw Same as -r/-w" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002850 "\n" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002851 "\nThere are filesystem-specific -o flags." \
Denis Vlasenko397de612008-03-17 08:55:44 +00002852
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002853#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002854 "$ mount\n" \
2855 "/dev/hda3 on / type minix (rw)\n" \
2856 "proc on /proc type proc (rw)\n" \
2857 "devpts on /dev/pts type devpts (rw)\n" \
2858 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2859 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2860 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002861#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002862 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002863
Rob Landleyd00b3a52005-08-20 05:07:08 +00002864#define mountpoint_trivial_usage \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002865 "[-q] <[-dn] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002866#define mountpoint_full_usage "\n\n" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002867 "Check if the directory is a mountpoint\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002868 "\nOptions:" \
2869 "\n -q Quiet" \
2870 "\n -d Print major/minor device number of the filesystem" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002871 "\n -n Print device name of the filesystem" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002872 "\n -x Print major/minor device number of the blockdevice" \
2873
Rob Landleyd00b3a52005-08-20 05:07:08 +00002874#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002875 "$ mountpoint /proc\n" \
2876 "/proc is not a mountpoint\n" \
2877 "$ mountpoint /sys\n" \
2878 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002879
Eric Andersen7e9276b2001-02-22 01:15:47 +00002880#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002881 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002882#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002883 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002884 "\n" \
2885 "Available Opcodes:\n" \
2886 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002887 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2888 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2889 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002890 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002891
Eric Andersen7e9276b2001-02-22 01:15:47 +00002892#define mv_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002893 "[OPTIONS] SOURCE DEST\n" \
2894 "or: mv [OPTIONS] SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002895#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002896 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
2897 "\nOptions:" \
2898 "\n -f Don't prompt before overwriting" \
2899 "\n -i Interactive, prompt before overwrite" \
2900
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002901#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002902 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002903
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002904#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002905 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002906#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002907 "Rename network interface while it in the down state\n" \
2908 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002909 "\n -c FILE Use configuration file (default: /etc/mactab)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002910 "\n -s Use syslog (LOCAL0 facility)" \
2911 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
2912
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002913#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002914 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2915 " or\n" \
2916 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002917
Eric Andersen1552ff72001-10-31 11:07:12 +00002918#define netstat_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002919 "[-laentuwxr"IF_FEATURE_NETSTAT_WIDE("W")IF_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002920#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002921 "Display networking information\n" \
2922 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002923 "\n -l Display listening server sockets" \
2924 "\n -a Display all sockets (default: connected)" \
2925 "\n -e Display other/more information" \
2926 "\n -n Don't resolve names" \
2927 "\n -t Tcp sockets" \
2928 "\n -u Udp sockets" \
2929 "\n -w Raw sockets" \
2930 "\n -x Unix sockets" \
2931 "\n -r Display routing table" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002932 IF_FEATURE_NETSTAT_WIDE( \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002933 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00002934 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002935 IF_FEATURE_NETSTAT_PRG( \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00002936 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002937 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002938
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002939#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002940 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002941#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002942 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002943 "Format specifiers:\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02002944 " %Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002945 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02002946 " %[niface] Monitor network interface 'iface'\n" \
2947 " %m Monitor allocated memory\n" \
2948 " %[mf] Monitor free memory\n" \
2949 " %[mt] Monitor total memory\n" \
2950 " %s Monitor allocated swap\n" \
2951 " %f Monitor number of used file descriptors\n" \
2952 " %Ni Monitor total/specific IRQ rate\n" \
2953 " %x Monitor context switch rate\n" \
2954 " %p Monitor forks\n" \
2955 " %[pn] Monitor # of processes\n" \
2956 " %b Monitor block io\n" \
2957 " %Nt Show time (with N decimal points)\n" \
2958 " %Nd Milliseconds between updates (default:1000)\n" \
2959 " %r Print <cr> instead of <lf> at EOL" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002960
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002961#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002962 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002963
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002964#define nohup_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002965 "PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002966#define nohup_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002967 "Run PROG immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002968#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002969 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002970
Eric Andersen7e9276b2001-02-22 01:15:47 +00002971#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002972 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002973#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002974 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002975 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002976#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002977 "$ nslookup localhost\n" \
2978 "Server: default\n" \
2979 "Address: default\n" \
2980 "\n" \
2981 "Name: debian\n" \
2982 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002983
Adam Tkacb1585062009-11-22 03:43:55 +01002984#define ntpd_trivial_usage \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002985 "[-dnqwl] [-S PROG] [-p PEER]..."
Adam Tkacb1585062009-11-22 03:43:55 +01002986#define ntpd_full_usage "\n\n" \
2987 "NTP client/server\n" \
2988 "\nOptions:" \
2989 "\n -d Verbose" \
2990 "\n -n Do not daemonize" \
Denys Vlasenko8d580c72009-11-23 16:27:16 +01002991 "\n -q Quit after clock is set" \
Denys Vlasenko907647f2009-12-02 23:17:45 +01002992/* -N exists for mostly compat reasons, thus not essential to inform */ \
Denys Vlasenkob2e5fc32009-11-25 14:52:47 +01002993/* the user that it exists: user may use nice as well */ \
2994/* "\n -N Run at high priority" */ \
Denys Vlasenko074e8dc2010-01-04 23:58:13 +01002995 "\n -w Do not set time (only query peers), implies -n" \
Adam Tkacb1585062009-11-22 03:43:55 +01002996 "\n -l Run as server on port 123" \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002997 "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins" \
Adam Tkacb1585062009-11-22 03:43:55 +01002998 "\n -p PEER Obtain time from PEER (may be repeated)" \
2999
Glenn L McGrath60281112001-11-02 11:39:46 +00003000#define od_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003001 "[-aBbcDdeFfHhIiLlOovXx] " IF_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003002#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003003 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003004 "(or stdin) to stdout"
Glenn L McGrath60281112001-11-02 11:39:46 +00003005
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003006#define openvt_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003007 "[-c N] [-sw] [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003008#define openvt_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003009 "Start PROG on a new virtual terminal\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003010 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003011 "\n -c N Use specified VT" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003012 "\n -s Switch to the VT" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003013/* "\n -l Run PROG as login shell (by prepending '-')" */ \
3014 "\n -w Wait for PROG to exit" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003015
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003016#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003017 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003018
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003019/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003020#define parse_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003021 "[-n MAXTOKENS] [-m MINTOKENS] [-d DELIMS] [-f FLAGS] FILE..."
3022#define parse_full_usage ""
3023*/
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003024
Eric Andersen27f64e12002-06-23 04:24:25 +00003025#define passwd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003026 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003027#define passwd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003028 "Change USER's password. If no USER is specified,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003029 "changes the password for the current user.\n" \
3030 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003031 "\n -a Algorithm to use for password (des, md5)" /* ", sha1)" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00003032 "\n -d Delete password for the account" \
3033 "\n -l Lock (disable) account" \
3034 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003035
Denis Vlasenko21d10142007-07-20 21:28:41 +00003036#define chpasswd_trivial_usage \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003037 IF_LONG_OPTS("[--md5|--encrypted]") IF_NOT_LONG_OPTS("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003038#define chpasswd_full_usage "\n\n" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003039 "Read user:password from stdin and update /etc/passwd\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003040 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003041 IF_LONG_OPTS( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003042 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003043 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003044 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003045 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003046 "\n -e Supplied passwords are in encrypted form" \
3047 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003048 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00003049
Glenn L McGrath655d8142003-06-22 15:32:41 +00003050#define patch_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003051 "[OPTIONS] [ORIGFILE [PATCHFILE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003052#define patch_full_usage "\n\n" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003053 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003054 " -p,--strip N Strip N leading components from file names" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003055 "\n -i,--input DIFF Read DIFF instead of stdin" \
3056 "\n -R,--reverse Reverse patch" \
3057 "\n -N,--forward Ignore already applied patches" \
3058 "\n --dry-run Don't actually change files" \
3059 ) \
3060 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003061 " -p N Strip N leading components from file names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003062 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003063 "\n -R Reverse patch" \
Denys Vlasenkod7874ed2009-08-20 23:33:19 +02003064 "\n -N Ignore already applied patches" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003065 )
Denis Vlasenko397de612008-03-17 08:55:44 +00003066
Glenn L McGrath655d8142003-06-22 15:32:41 +00003067#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003068 "$ patch -p1 < example.diff\n" \
3069 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00003070
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003071#define pgrep_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003072 "[-flnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003073#define pgrep_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003074 "Display process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003075 "\nOptions:" \
3076 "\n -l Show command name too" \
3077 "\n -f Match against entire command line" \
3078 "\n -n Show the newest process only" \
3079 "\n -o Show the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003080 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003081 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003082 "\n -s Match session ID (0 for current)" \
3083 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003084
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003085#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00003086#define pidof_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003087 "[OPTIONS] [NAME]..."
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003088#define USAGE_PIDOF "\n\nOptions:"
3089#else
3090#define pidof_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003091 "[NAME]..."
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003092#define USAGE_PIDOF /* none */
3093#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003094#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003095 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003096 USAGE_PIDOF \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003097 IF_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003098 "\n -s Show only one PID") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003099 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003100 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003101 "\n Use %PPID to omit pid of pidof's parent") \
3102
Eric Andersen221b2ea2001-07-31 19:06:07 +00003103#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003104 "$ pidof init\n" \
3105 "1\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003106 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003107 "$ pidof /bin/sh\n20351 5973 5950\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003108 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003109 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00003110
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003111#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003112#define ping_trivial_usage \
3113 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003114#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003115 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003116#define ping6_trivial_usage \
3117 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003118#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003119 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003120#else
3121#define ping_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003122 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003123#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003124 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3125 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003126 "\n -4, -6 Force IP or IPv6 name resolution" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003127 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003128 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3129 "\n -I IFACE/IP Use interface or IP address as source" \
3130 "\n -W SEC Seconds to wait for the first response (default:10)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003131 "\n (after all -c CNT packets are sent)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003132 "\n -w SEC Seconds until ping exits (default:infinite)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003133 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003134 "\n -q Quiet, only displays output at start" \
3135 "\n and when finished" \
3136
Eric Andersen51b8bd62002-07-03 11:46:38 +00003137#define ping6_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003138 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003139#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003140 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3141 "\nOptions:" \
3142 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003143 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3144 "\n -I IFACE/IP Use interface or IP address as source" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003145 "\n -q Quiet, only displays output at start" \
3146 "\n and when finished" \
3147
Eric Andersen51b8bd62002-07-03 11:46:38 +00003148#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003149#define ping_example_usage \
3150 "$ ping localhost\n" \
3151 "PING slag (127.0.0.1): 56 data bytes\n" \
3152 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3153 "\n" \
3154 "--- debian ping statistics ---\n" \
3155 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3156 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003157#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003158 "$ ping6 ip6-localhost\n" \
3159 "PING ip6-localhost (::1): 56 data bytes\n" \
3160 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3161 "\n" \
3162 "--- ip6-localhost ping statistics ---\n" \
3163 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3164 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003165
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003166#define pipe_progress_trivial_usage NOUSAGE_STR
3167#define pipe_progress_full_usage ""
3168
Eric Andersen7e9276b2001-02-22 01:15:47 +00003169#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003170 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003171#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003172 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003173 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003174
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003175#define pkill_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003176 "[-l|-SIGNAL] [-fnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003177#define pkill_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003178 "Send a signal to process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003179 "\nOptions:" \
3180 "\n -l List all signals" \
3181 "\n -f Match against entire command line" \
3182 "\n -n Signal the newest process only" \
3183 "\n -o Signal the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003184 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003185 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003186 "\n -s Match session ID (0 for current)" \
3187 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003188
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003189#define popmaildir_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003190 "[OPTIONS] MAILDIR [CONN_HELPER ARGS]"
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003191#define popmaildir_full_usage "\n\n" \
3192 "Fetch content of remote mailbox to local maildir\n" \
3193 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003194/* "\n -b Binary mode. Ignored" */ \
3195/* "\n -d Debug. Ignored" */ \
3196/* "\n -m Show used memory. Ignored" */ \
3197/* "\n -V Show version. Ignored" */ \
3198/* "\n -c Use tcpclient. Ignored" */ \
3199/* "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003200 "\n -s Skip authorization" \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003201 "\n -T Get messages with TOP instead of RETR" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003202 "\n -k Keep retrieved messages on the server" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003203 "\n -t SEC Network timeout" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003204 IF_FEATURE_POPMAILDIR_DELIVERY( \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003205 "\n -F \"PROG ARGS\" Filter program (may be repeated)" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003206 "\n -M \"PROG ARGS\" Delivery program" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003207 ) \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003208 "\n" \
3209 "\nFetch from plain POP3 server:" \
3210 "\npopmaildir -k DIR nc pop3.server.com 110 <user_and_pass.txt" \
3211 "\nFetch from SSLed POP3 server and delete fetched emails:" \
3212 "\npopmaildir DIR -- openssl s_client -quiet -connect pop3.server.com:995 <user_and_pass.txt"
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003213/* "\n -R BYTES Remove old messages on the server >= BYTES. Ignored" */
3214/* "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" */
3215/* "\n -L BYTES Don't retrieve new messages >= BYTES. Ignored" */
3216/* "\n -H LINES Type first LINES of a message. Ignored" */
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003217#define popmaildir_example_usage \
3218 "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n" \
3219 "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
3220
Eric Andersen7e9276b2001-02-22 01:15:47 +00003221#define poweroff_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003222 "[-d DELAY] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003223#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003224 "Halt and shut off power\n" \
3225 "\nOptions:" \
3226 "\n -d Delay interval for halting" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003227 "\n -n Do not sync" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003228 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003229
Mike Frysinger95d3c452005-04-21 23:29:24 +00003230#define printenv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003231 "[VARIABLE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003232#define printenv_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003233 "Print environment VARIABLEs.\n" \
3234 "If no VARIABLE specified, print all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003235
Eric Andersen7e9276b2001-02-22 01:15:47 +00003236#define printf_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003237 "FORMAT [ARGUMENT]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003238#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003239 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003240 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003241#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003242 "$ printf \"Val=%d\\n\" 5\n" \
3243 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003244
Denis Vlasenko94949192006-11-05 00:45:47 +00003245
3246#if ENABLE_DESKTOP
3247
3248#define ps_trivial_usage \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003249 "[-o COL1,COL2=HEADER]" IF_FEATURE_SHOW_THREADS(" [-T]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003250#define ps_full_usage "\n\n" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003251 "Show list of processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003252 "\nOptions:" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003253 "\n -o COL1,COL2=HEADER Select columns for display" \
Denys Vlasenko532609e2009-09-20 20:29:25 +02003254 IF_FEATURE_SHOW_THREADS( \
3255 "\n -T Show threads" \
3256 )
Denis Vlasenko94949192006-11-05 00:45:47 +00003257
3258#else /* !ENABLE_DESKTOP */
3259
Denis Vlasenko397de612008-03-17 08:55:44 +00003260#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003261#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003262#else
3263#define USAGE_PS "\nOptions:"
3264#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003265
Eric Andersen7e9276b2001-02-22 01:15:47 +00003266#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003267 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003268#define ps_full_usage "\n\n" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003269 "Show list of processes\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003270 USAGE_PS \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003271 IF_SELINUX( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003272 "\n -Z Show selinux context" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003273 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003274 IF_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003275 "\n w Wide output" \
3276 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003277
Denis Vlasenko94949192006-11-05 00:45:47 +00003278#endif /* ENABLE_DESKTOP */
3279
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003280#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003281 "$ ps\n" \
3282 " PID Uid Gid State Command\n" \
3283 " 1 root root S init\n" \
3284 " 2 root root S [kflushd]\n" \
3285 " 3 root root S [kupdate]\n" \
3286 " 4 root root S [kpiod]\n" \
3287 " 5 root root S [kswapd]\n" \
3288 " 742 andersen andersen S [bash]\n" \
3289 " 743 andersen andersen S -bash\n" \
3290 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003291 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003292
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003293#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003294 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003295#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003296 "Scan a host, print all open ports\n" \
3297 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003298 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003299 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003300 "\n -p Scan from this port (default 1)" \
3301 "\n -P Scan up to this port (default 1024)" \
3302 "\n -t Timeout (default 5000 ms)" \
3303 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3304
Eric Andersen7e9276b2001-02-22 01:15:47 +00003305#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003306 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003307#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003308 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003309#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003310 "$ pwd\n" \
3311 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003312
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003313#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003314 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003315#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003316 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003317#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003318 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003319
Eric Andersen7e9276b2001-02-22 01:15:47 +00003320#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003321 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003322#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003323 "Get and possibly set the system date and time from a remote HOST\n" \
3324 "\nOptions:" \
3325 "\n -s Set the system date and time (default)" \
3326 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003327
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00003328#define rdev_trivial_usage \
3329 ""
3330#define rdev_full_usage "\n\n" \
3331 "Print the device node associated with the filesystem mounted at '/'"
3332#define rdev_example_usage \
3333 "$ rdev\n" \
3334 "/dev/mtdblock9 /\n"
3335
Rob Landley0e4690d2006-08-20 22:12:18 +00003336#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003337 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003338#define readahead_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003339 "Preload FILEs to RAM"
Rob Landley0e4690d2006-08-20 22:12:18 +00003340
Eric Andersen7e9276b2001-02-22 01:15:47 +00003341#define readlink_trivial_usage \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003342 IF_FEATURE_READLINK_FOLLOW("[-fnv] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003343#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003344 "Display the value of a symlink" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003345 IF_FEATURE_READLINK_FOLLOW( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003346 "\nOptions:" \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003347 "\n -f Canonicalize by following all symlinks" \
3348 "\n -n Don't add newline" \
3349 "\n -v Verbose" \
3350 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003351
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003352#define readprofile_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003353 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003354#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003355 "Options:" \
3356 "\n -m mapfile (Default: /boot/System.map)" \
3357 "\n -p profile (Default: /proc/profile)" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003358 "\n -M NUM Set the profiling multiplier to NUM" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003359 "\n -i Print only info about the sampling step" \
3360 "\n -v Verbose" \
3361 "\n -a Print all symbols, even if count is 0" \
3362 "\n -b Print individual histogram-bin counts" \
3363 "\n -s Print individual counters within functions" \
3364 "\n -r Reset all the counters (root only)" \
3365 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003366
Glenn L McGrath62fae302002-12-10 00:14:33 +00003367#define realpath_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003368 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003369#define realpath_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003370 "Return the absolute pathnames of given FILE"
Tim Riker7b253f82003-12-28 05:02:40 +00003371
Eric Andersen7e9276b2001-02-22 01:15:47 +00003372#define reboot_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003373 "[-d DELAY] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003374#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003375 "Reboot the system\n" \
3376 "\nOptions:" \
3377 "\n -d Delay interval for rebooting" \
3378 "\n -n No call to sync()" \
3379 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003380
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003381#define reformime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003382 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003383#define reformime_full_usage "\n\n" \
3384 "Parse MIME-encoded message\n" \
3385 "\nOptions:" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003386 "\n -x PREFIX Extract content of MIME sections to files" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003387 "\n -X PROG ARGS Filter content of MIME sections through PROG" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003388 "\n Must be the last option" \
3389 "\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003390 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003391
Denys Vlasenko5e611152009-05-19 17:36:16 +02003392#define scriptreplay_trivial_usage \
3393 "timingfile [typescript [divisor]]"
3394#define scriptreplay_full_usage "\n\n" \
3395 "Play back typescripts, using timing information"
3396
Eric Andersen7e9276b2001-02-22 01:15:47 +00003397#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003398 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003399#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003400 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003401
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003402#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003403 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003404#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003405 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003406
Denis Vlasenko397137b2007-07-23 14:03:30 +00003407#define restorecon_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003408 "[-iFnRv] [-e EXCLUDEDIR]... [-o FILE] [-f FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003409#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003410 "Reset security contexts of files in pathname\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003411 "\n -i Ignore files that don't exist" \
3412 "\n -f FILE File with list of files to process" \
3413 "\n -e DIR Directory to exclude" \
3414 "\n -R,-r Recurse" \
3415 "\n -n Don't change any file labels" \
3416 "\n -o FILE Save list of files with incorrect context" \
3417 "\n -v Verbose" \
3418 "\n -vv Show changed labels" \
3419 "\n -F Force reset of context to match file_context" \
3420 "\n for customizable files, or the user section," \
3421 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003422
Souf Oued43afd752010-05-02 18:45:02 +02003423#define rfkill_trivial_usage \
3424 "COMMAND [INDEX|TYPE]"
3425#define rfkill_full_usage "\n\n" \
3426 "Enable/disable wireless devices\n" \
3427 "\nCommands:" \
3428 "\n list [INDEX|TYPE] List current state" \
3429 "\n block INDEX|TYPE Disable device" \
3430 "\n unblock INDEX|TYPE Enable device" \
3431 "\n" \
3432 "\n TYPE: all, wlan(wifi), bluetooth, uwb(ultrawideband)," \
3433 "\n wimax, wwan, gps, fm" \
3434
Eric Andersen7e9276b2001-02-22 01:15:47 +00003435#define rm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003436 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003437#define rm_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003438 "Remove (unlink) FILEs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003439 "\nOptions:" \
3440 "\n -i Always prompt before removing" \
3441 "\n -f Never prompt" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003442 "\n -R,-r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003443
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003444#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003445 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003446
Eric Andersen7e9276b2001-02-22 01:15:47 +00003447#define rmdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003448 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003449#define rmdir_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003450 "Remove DIRECTORY if it is empty\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003451 "\nOptions:" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003452 IF_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003453 "\n -p|--parents Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003454 "\n --ignore-fail-on-non-empty" \
3455 ) \
3456 IF_NOT_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003457 "\n -p Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003458 )
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003459
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003460#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003461 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003462
Eric Andersen7e9276b2001-02-22 01:15:47 +00003463#define rmmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003464 "[OPTIONS] [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003465#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003466 "Unload the specified kernel modules from the kernel\n" \
3467 "\nOptions:" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003468 "\n -w Wait until the module is no longer used" \
3469 "\n -f Force unloading" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003470 "\n -a Remove all unused modules (recursively)" \
3471
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003472#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003473 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003474
Eric Andersen7e9276b2001-02-22 01:15:47 +00003475#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003476 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003477#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003478 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003479 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003480 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003481 "\n -e Display other/more information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003482 "\n -A inet" IF_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003483
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003484#define rpm_trivial_usage \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02003485 "-i PACKAGE.rpm; rpm -qp[ildc] PACKAGE.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003486#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003487 "Manipulate RPM packages\n" \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02003488 "\nCommands:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003489 "\n -i Install package" \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02003490 "\n -qp Query package" \
3491 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003492 "\n -i Show information" \
3493 "\n -l List contents" \
3494 "\n -d List documents" \
3495 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003496
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003497#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003498 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003499#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003500 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003501
Mike Frysinger6b160e42008-02-15 02:27:19 +00003502#define rtcwake_trivial_usage \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003503 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SEC | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003504#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003505 "Enter a system sleep state until specified wakeup time\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003506 IF_LONG_OPTS( \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003507 "\n -a,--auto Read clock mode from adjtime" \
3508 "\n -l,--local Clock is set to local time" \
3509 "\n -u,--utc Clock is set to UTC time" \
3510 "\n -d,--device=DEV Specify the RTC device" \
3511 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003512 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003513 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003514 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003515 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003516 "\n -a Read clock mode from adjtime" \
3517 "\n -l Clock is set to local time" \
3518 "\n -u Clock is set to UTC time" \
3519 "\n -d DEV Specify the RTC device" \
3520 "\n -m MODE Set the sleep state (default: standby)" \
3521 "\n -s SEC Set the timeout in SEC seconds from now" \
3522 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003523 )
3524
Denis Vlasenko49622d72007-03-10 16:58:49 +00003525#define runcon_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003526 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] PROG ARGS\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003527 "runcon CONTEXT PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003528#define runcon_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003529 "Run PROG in a different security context\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003530 "\n CONTEXT Complete security context\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003531 IF_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003532 "\n -c,--compute Compute process transition context before modifying" \
3533 "\n -t,--type=TYPE Type (for same role as parent)" \
3534 "\n -u,--user=USER User identity" \
3535 "\n -r,--role=ROLE Role" \
3536 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003537 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003538 IF_NOT_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003539 "\n -c Compute process transition context before modifying" \
3540 "\n -t TYPE Type (for same role as parent)" \
3541 "\n -u USER User identity" \
3542 "\n -r ROLE Role" \
3543 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003544 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003545
Eric Andersen6cf47a72001-10-31 10:24:36 +00003546#define run_parts_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003547 "[-t] "IF_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003548#define run_parts_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003549 "Run a bunch of scripts in DIRECTORY\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003550 "\nOptions:" \
3551 "\n -t Print what would be run, but don't actually run anything" \
3552 "\n -a ARG Pass ARG as argument for every program" \
3553 "\n -u MASK Set the umask to MASK before running every program" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003554 IF_FEATURE_RUN_PARTS_FANCY( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003555 "\n -l Print names of all matching files even if they are not executable" \
3556 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003557
3558#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003559 "$ run-parts -a start /etc/init.d\n" \
3560 "$ run-parts -a stop=now /etc/init.d\n\n" \
3561 "Let's assume you have a script foo/dosomething:\n" \
3562 "#!/bin/sh\n" \
3563 "for i in $*; do eval $i; done; unset i\n" \
3564 "case \"$1\" in\n" \
3565 "start*) echo starting something;;\n" \
3566 "stop*) set -x; shutdown -h $stop;;\n" \
3567 "esac\n\n" \
3568 "Running this yields:\n" \
3569 "$run-parts -a stop=+4m foo/\n" \
3570 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003571
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003572#define runlevel_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003573 "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003574#define runlevel_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003575 "Find the current and previous system runlevel\n" \
3576 "\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003577 "If no utmp FILE exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003578 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003579#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003580 "$ runlevel /var/run/utmp\n" \
3581 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003582
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003583#define runsv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003584 "DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003585#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003586 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003587
3588#define runsvdir_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003589 "[-P] [-s SCRIPT] DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003590#define runsvdir_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003591 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
3592 "\n -P Put each runsv in a new session" \
3593 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003594
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003595#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003596 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003597#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003598 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003599#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003600 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003601
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003602#define script_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003603 "[-afq" IF_SCRIPTREPLAY("t") "] [-c PROG] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003604#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003605 "Options:" \
3606 "\n -a Append output" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003607 "\n -c PROG Run PROG, not shell" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003608 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003609 "\n -q Quiet" \
Denys Vlasenko5e611152009-05-19 17:36:16 +02003610 IF_SCRIPTREPLAY( \
3611 "\n -t Send timing to stderr" \
3612 )
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003613
Eric Andersen7e9276b2001-02-22 01:15:47 +00003614#define sed_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003615 "[-efinr] SED_CMD [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003616#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003617 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003618 "\n -e CMD Add CMD to sed commands to be executed" \
3619 "\n -f FILE Add FILE contents to sed commands to be executed" \
Denys Vlasenkodac863a2009-10-27 09:11:17 +01003620 "\n -i Edit files in-place (else sends result to stdout)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003621 "\n -n Suppress automatic printing of pattern space" \
3622 "\n -r Use extended regex syntax" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003623 "\n" \
Rob Landley7b284152009-10-26 16:04:07 -05003624 "\nIf no -e or -f, the first non-option argument is the sed command string." \
3625 "\nRemaining arguments are input files (stdin if none)."
Eric Andersenf802ff72004-04-12 15:12:06 +00003626
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003627#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003628 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3629 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003630
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003631#define selinuxenabled_trivial_usage NOUSAGE_STR
3632#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003633
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003634#define sendmail_trivial_usage \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003635 "[OPTIONS] [RECIPIENT_EMAIL]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003636#define sendmail_full_usage "\n\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003637 "Read email from stdin and send it\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003638 "\nStandard options:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003639 "\n -t Read additional recipients from message body" \
3640 "\n -f sender Sender (required)" \
3641 "\n -o options Various options. -oi implied, others are ignored" \
Vladimir Dronnikovb618dba2009-10-04 01:34:54 +02003642 "\n -i -oi synonym. implied and ignored" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003643 "\n" \
3644 "\nBusybox specific options:" \
3645 "\n -w seconds Network timeout" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003646 "\n -H 'PROG ARGS' Run connection helper" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003647 "\n Examples:" \
Denis Vlasenko7e0c2432009-03-02 16:12:00 +00003648 "\n -H 'exec openssl s_client -quiet -tls1 -starttls smtp" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003649 "\n -connect smtp.gmail.com:25' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003650 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003651 "\n -H 'exec openssl s_client -quiet -tls1" \
3652 "\n -connect smtp.gmail.com:465' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003653 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003654 "\n -S server[:port] Server" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003655 "\n -au<username> Username for AUTH LOGIN" \
3656 "\n -ap<password> Password for AUTH LOGIN" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003657 "\n -am<method> Authentication method. Ignored. LOGIN is implied" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003658 "\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003659 "\nOther options are silently ignored; -oi -t is implied" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003660 IF_MAKEMIME( \
3661 "\nUse makemime applet to create message with attachments" \
3662 )
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003663
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003664#define seq_trivial_usage \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003665 "[-w] [-s SEP] [FIRST [INC]] LAST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003666#define seq_full_usage "\n\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003667 "Print numbers from FIRST to LAST, in steps of INC.\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003668 "FIRST, INC default to 1.\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003669 "\nOptions:" \
3670 "\n -w Pad to last with leading zeros" \
3671 "\n -s SEP String separator" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003672
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003673#define sestatus_trivial_usage \
3674 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003675#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003676 " -v Verbose" \
3677 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003678
Paul Foxfc2256a2005-08-01 18:12:30 +00003679#define setconsole_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003680 "[-r" IF_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003681#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003682 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3683 "\nOptions:" \
3684 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003685
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003686#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003687 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003688#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003689
Denis Vlasenko397137b2007-07-23 14:03:30 +00003690#define setfiles_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003691 "[-dnpqsvW] [-e DIR]... [-o FILE] [-r alt_root_path]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003692 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003693 " [-c policyfile] spec_file" \
3694 ) \
3695 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003696#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003697 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003698 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003699 "\n -c FILE Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003700 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003701 "\n -d Show which specification matched each file" \
3702 "\n -l Log changes in file labels to syslog" \
3703 "\n -n Don't change any file labels" \
3704 "\n -q Suppress warnings" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003705 "\n -r DIR Use an alternate root path" \
3706 "\n -e DIR Exclude DIR" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003707 "\n -F Force reset of context to match file_context for customizable files" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003708 "\n -o FILE Save list of files with incorrect context" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003709 "\n -s Take a list of files from stdin (instead of command line)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003710 "\n -v Show changes in file labels, if type or role are changing" \
3711 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3712 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003713
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003714#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003715 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003716#define setfont_full_usage "\n\n" \
3717 "Load a console font\n" \
3718 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003719 "\n -m MAPFILE Load console screen map" \
3720 "\n -C TTY Affect TTY instead of /dev/tty" \
3721
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003722#define setfont_example_usage \
3723 "$ setfont -m koi8-r /etc/i18n/fontname\n"
3724
Eric Andersen7e9276b2001-02-22 01:15:47 +00003725#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003726 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003727#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003728 "Set entries into the kernel's scancode-to-keycode map,\n" \
3729 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3730 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003731 "and KEYCODE is given in decimal." \
Denis Vlasenko397de612008-03-17 08:55:44 +00003732
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003733#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003734 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003735
Rob Landley87848d92006-03-27 23:23:43 +00003736#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003737 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003738#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003739 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003740
Denis Vlasenkobe039372007-10-14 04:48:44 +00003741#define setsebool_trivial_usage \
3742 "boolean value"
3743
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003744#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00003745 "Change boolean setting"
3746
Paul Fox42403642005-08-01 22:52:09 +00003747#define setsid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003748 "PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003749#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003750 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3751 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3752 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003753
Eric Andersen2e9c2572003-08-08 22:26:06 +00003754#define last_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003755 ""IF_FEATURE_LAST_FANCY("[-HW] [-f FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003756#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003757 "Show listing of the last users that logged into the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003758 IF_FEATURE_LAST_FANCY( "\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003759 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00003760/* "\n -H Show header line" */ \
3761 "\n -W Display with no host column truncation" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003762 "\n -f FILE Read from FILE instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003763 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00003764
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00003765#define showkey_trivial_usage \
3766 "[-a | -k | -s]"
3767#define showkey_full_usage "\n\n" \
3768 "Show keys pressed\n" \
3769 "\nOptions:" \
3770 "\n -a Display decimal/octal/hex values of the keys" \
3771 "\n -k Display interpreted keycodes (default)" \
3772 "\n -s Display raw scan-codes" \
3773
Denis Vlasenko14923db2007-06-20 15:23:03 +00003774#define slattach_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003775 "[-cehmLF] [-s SPEED] [-p PROTOCOL] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003776#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003777 "Attach network interface(s) to serial line(s)\n" \
3778 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003779 "\n -p PROT Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3780 "\n -s SPD Set line speed" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003781 "\n -e Exit after initializing device" \
3782 "\n -h Exit when the carrier is lost" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003783 "\n -c PROG Run PROG when the line is hung up" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003784 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3785 "\n -L Enable 3-wire operation" \
3786 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003787
Eric Andersen7e9276b2001-02-22 01:15:47 +00003788#define sleep_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003789 IF_FEATURE_FANCY_SLEEP("[") "N" IF_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003790#define sleep_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003791 IF_NOT_FEATURE_FANCY_SLEEP("Pause for N seconds") \
3792 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003793 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003794 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003795#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003796 "$ sleep 2\n" \
3797 "[2 second delay results]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003798 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003799 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003800 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003801
Eric Andersen7e9276b2001-02-22 01:15:47 +00003802#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003803 "[-nru" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003804 IF_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003805 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003806#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003807 "Sort lines of text\n" \
3808 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003809 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003810 "\n -b Ignore leading blanks" \
3811 "\n -c Check whether input is sorted" \
3812 "\n -d Dictionary order (blank or alphanumeric only)" \
3813 "\n -f Ignore case" \
3814 "\n -g General numerical sort" \
3815 "\n -i Ignore unprintable characters" \
3816 "\n -k Sort key" \
3817 "\n -M Sort month" \
3818 ) \
3819 "\n -n Sort numbers" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003820 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003821 "\n -o Output to file" \
3822 "\n -k Sort by key" \
3823 "\n -t CHAR Key separator" \
3824 ) \
3825 "\n -r Reverse sort order" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003826 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003827 "\n -s Stable (don't sort ties alphabetically)" \
3828 ) \
3829 "\n -u Suppress duplicate lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003830 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003831 "\n -z Lines are terminated by NUL, not newline" \
3832 "\n -mST Ignored for GNU compatibility") \
3833
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003834#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003835 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3836 "a\n" \
3837 "b\n" \
3838 "c\n" \
3839 "d\n" \
3840 "e\n" \
3841 "f\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003842 IF_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003843 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3844 "d 2\n" \
3845 "b 2\n" \
3846 "c 3\n" \
3847 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003848 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003849
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003850#define split_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003851 "[OPTIONS] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003852#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003853 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003854 "\n -b n[k|m] Split by bytes" \
3855 "\n -l n Split by lines" \
3856 "\n -a n Use n letters as suffix" \
3857
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003858#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003859 "$ split TODO foo\n" \
3860 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003861
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003862#define start_stop_daemon_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003863 "[OPTIONS] [-S|-K] ... [-- ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003864#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003865 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003866 "-K: stop all matching processes.\n" \
3867 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003868 IF_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003869 "\nProcess matching:" \
3870 "\n -u,--user USERNAME|UID Match only this user's processes" \
3871 "\n -n,--name NAME Match processes with NAME" \
3872 "\n in comm field in /proc/PID/stat" \
3873 "\n -x,--exec EXECUTABLE Match processes with this command" \
3874 "\n in /proc/PID/cmdline" \
3875 "\n -p,--pidfile FILE Match a process with PID from the file" \
3876 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003877 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003878 "\n -x,--exec EXECUTABLE Program to run" \
3879 "\n -a,--startas NAME Zeroth argument" \
3880 "\n -b,--background Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003881 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003882 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003883 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003884 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
3885 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003886 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003887 "\n -s,--signal SIG Signal to send" \
3888 "\n -t,--test Match only, exit with 0 if a process is found" \
3889 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003890 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003891 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003892 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003893 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003894 "\n -q,--quiet Quiet" \
3895 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003896 IF_NOT_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003897 "\nProcess matching:" \
3898 "\n -u USERNAME|UID Match only this user's processes" \
3899 "\n -n NAME Match processes with NAME" \
3900 "\n in comm field in /proc/PID/stat" \
3901 "\n -x EXECUTABLE Match processes with this command" \
3902 "\n command in /proc/PID/cmdline" \
3903 "\n -p FILE Match a process with PID from the file" \
3904 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003905 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003906 "\n -x EXECUTABLE Program to run" \
3907 "\n -a NAME Zeroth argument" \
3908 "\n -b Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003909 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003910 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003911 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003912 "\n -c USER[:[GRP]] Change to user/group" \
3913 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003914 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003915 "\n -s SIG Signal to send" \
3916 "\n -t Match only, exit with 0 if a process is found" \
3917 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003918 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003919 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003920 "\n -v Verbose" \
3921 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003922 "\n -q Quiet" \
3923 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003924
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003925#define stat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003926 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003927#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003928 "Display file (default) or filesystem status\n" \
3929 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003930 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003931 "\n -c fmt Use the specified format" \
3932 ) \
3933 "\n -f Display filesystem status" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003934 "\n -L Follow links" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003935 "\n -t Display info in terse form" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003936 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003937 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003938 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003939 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003940 "\n\nValid format sequences for files:\n" \
3941 " %a Access rights in octal\n" \
3942 " %A Access rights in human readable form\n" \
3943 " %b Number of blocks allocated (see %B)\n" \
3944 " %B The size in bytes of each block reported by %b\n" \
3945 " %d Device number in decimal\n" \
3946 " %D Device number in hex\n" \
3947 " %f Raw mode in hex\n" \
3948 " %F File type\n" \
3949 " %g Group ID of owner\n" \
3950 " %G Group name of owner\n" \
3951 " %h Number of hard links\n" \
3952 " %i Inode number\n" \
3953 " %n File name\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003954 " %N File name, with -> TARGET if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003955 " %o I/O block size\n" \
3956 " %s Total size, in bytes\n" \
3957 " %t Major device type in hex\n" \
3958 " %T Minor device type in hex\n" \
3959 " %u User ID of owner\n" \
3960 " %U User name of owner\n" \
3961 " %x Time of last access\n" \
3962 " %X Time of last access as seconds since Epoch\n" \
3963 " %y Time of last modification\n" \
3964 " %Y Time of last modification as seconds since Epoch\n" \
3965 " %z Time of last change\n" \
3966 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003967 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003968 " %a Free blocks available to non-superuser\n" \
3969 " %b Total data blocks in file system\n" \
3970 " %c Total file nodes in file system\n" \
3971 " %d Free file nodes in file system\n" \
3972 " %f Free blocks in file system\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003973 IF_SELINUX( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003974 " %C Security context in selinux\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003975 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003976 " %i File System ID in hex\n" \
3977 " %l Maximum length of filenames\n" \
3978 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003979 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003980 " %S Fundamental block size (for block counts)\n" \
3981 " %t Type in hex\n" \
3982 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003983 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003984
Eric Andersenef5e8f82002-11-07 02:09:37 +00003985#define strings_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003986 "[-afo] [-n LEN] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003987#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003988 "Display printable strings in a binary file\n" \
3989 "\nOptions:" \
3990 "\n -a Scan whole file (default)" \
3991 "\n -f Precede strings with filenames" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003992 "\n -n LEN At least LEN characters form a string (default 4)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003993 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00003994
Eric Andersen7e9276b2001-02-22 01:15:47 +00003995#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003996 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003997#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003998 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003999 "and deviations from stty sane\n" \
4000 "\nOptions:" \
4001 "\n -F DEVICE Open device instead of stdin" \
4002 "\n -a Print all current settings in human-readable form" \
4003 "\n -g Print in stty-readable form" \
4004 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004005
Robert Griebl1fca5582002-06-04 20:45:46 +00004006#define su_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004007 "[OPTIONS] [-] [USERNAME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004008#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004009 "Change user id or become root\n" \
4010 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004011 "\n -p,-m Preserve environment" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004012 "\n -c CMD Command to pass to 'sh -c'" \
4013 "\n -s SH Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00004014
Eric Andersen27f64e12002-06-23 04:24:25 +00004015#define sulogin_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004016 "[-t N] [TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004017#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004018 "Single user login\n" \
4019 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004020 "\n -t N Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004021
Mike Frysinger95d3c452005-04-21 23:29:24 +00004022#define sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004023 "[-rs] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004024#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004025 "Checksum and count the blocks in a file\n" \
4026 "\nOptions:" \
4027 "\n -r Use BSD sum algorithm (1K blocks)" \
4028 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00004029
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004030#define sv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004031 "[-v] [-w SEC] CMD SERVICE_DIR..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004032#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004033 "Control services monitored by runsv supervisor.\n" \
4034 "Commands (only first character is enough):\n" \
4035 "\n" \
4036 "status: query service status\n" \
4037 "up: if service isn't running, start it. If service stops, restart it\n" \
4038 "once: like 'up', but if service stops, don't restart it\n" \
4039 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004040 " if it exists. After it stops, don't restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004041 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004042 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004043 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004044 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004045
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004046#define svlogd_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004047 "[-ttv] [-r C] [-R CHARS] [-l MATCHLEN] [-b BUFLEN] DIR..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004048#define svlogd_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004049 "Continuously read log data from stdin, optionally\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004050 "filter log messages, and write the data to one or more automatically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004051 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004052
Eric Andersen7e9276b2001-02-22 01:15:47 +00004053#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004054 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004055#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004056 "Stop swapping on DEVICE\n" \
4057 "\nOptions:" \
4058 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004059
Eric Andersen7e9276b2001-02-22 01:15:47 +00004060#define swapon_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004061 "[-a]" IF_FEATURE_SWAPON_PRI(" [-p PRI]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004062#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004063 "Start swapping on DEVICE\n" \
4064 "\nOptions:" \
4065 "\n -a Start swapping on all swap devices" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004066 IF_FEATURE_SWAPON_PRI( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004067 "\n -p PRI Set swap device priority" \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004068 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004069
Rob Landley0f34a822005-10-27 22:55:50 +00004070#define switch_root_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004071 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004072#define switch_root_full_usage "\n\n" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004073 "Free initramfs and switch to another root fs:\n" \
4074 "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n" \
4075 "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004076 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004077 "\n -c DEV Reopen stdio to DEV after switch" \
Rob Landley0f34a822005-10-27 22:55:50 +00004078
Eric Andersen7e9276b2001-02-22 01:15:47 +00004079#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004080 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004081#define sync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004082 "Write all buffered blocks to disk"
4083
4084#define fsync_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004085 "[OPTIONS] FILE..."
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004086#define fsync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004087 "Write files' buffered blocks to disk\n" \
4088 "\nOptions:" \
4089 "\n -d Avoid syncing metadata"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004090
Eric Andersenb9050282003-12-24 06:02:11 +00004091#define sysctl_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004092 "[OPTIONS] [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004093#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004094 "Configure kernel parameters at runtime\n" \
4095 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004096 "\n -n Don't print key names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004097 "\n -e Don't warn about unknown keys" \
4098 "\n -w Change sysctl setting" \
4099 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
4100 "\n -a Display all values" \
4101 "\n -A Display all values in table form" \
4102
Eric Andersen5d38f5b2005-09-12 21:42:48 +00004103#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00004104 "sysctl [-n] [-e] variable...\n" \
4105 "sysctl [-n] [-e] -w variable=value...\n" \
4106 "sysctl [-n] [-e] -a\n" \
4107 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
4108 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00004109
Eric Andersen7e9276b2001-02-22 01:15:47 +00004110#define syslogd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004111 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004112#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004113 "System logging utility.\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004114 "This version of syslogd ignores /etc/syslog.conf\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004115 "\nOptions:" \
4116 "\n -n Run in foreground" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004117 "\n -O FILE Log to given file (default:/var/log/messages)" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004118 "\n -l N Set local log level" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004119 "\n -S Smaller logging output" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004120 IF_FEATURE_ROTATE_LOGFILE( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004121 "\n -s SIZE Max size (KB) before rotate (default:200KB, 0=off)" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004122 "\n -b N N rotated logs to keep (default:1, max=99, 0=purge)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004123 IF_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004124 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
4125 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004126 IF_FEATURE_SYSLOGD_DUP( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004127 "\n -D Drop duplicates") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004128 IF_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004129 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00004130 /* NB: -Csize shouldn't have space (because size is optional) */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004131/* "\n -m MIN Minutes between MARK lines (default:20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00004132
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004133#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004134 "$ syslogd -R masterlog:514\n" \
4135 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004136
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004137#define tac_trivial_usage \
4138 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004139#define tac_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004140 "Concatenate FILEs and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004141
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004142#define taskset_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004143 "[-p] [MASK] [PID | PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004144#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004145 "Set or get CPU affinity\n" \
4146 "\nOptions:" \
4147 "\n -p Operate on an existing PID" \
4148
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004149#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004150 "$ taskset 0x7 ./dgemm_test&\n" \
4151 "$ taskset -p 0x1 $!\n" \
4152 "pid 4790's current affinity mask: 7\n" \
4153 "pid 4790's new affinity mask: 1\n" \
4154 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4155 "pid 6671's current affinity mask: 1\n" \
4156 "pid 6671's new affinity mask: 1\n" \
4157 "$ taskset -p 1\n" \
4158 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004159
Eric Andersen7e9276b2001-02-22 01:15:47 +00004160#define tee_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004161 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004162#define tee_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004163 "Copy stdin to each FILE, and also to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004164 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004165 "\n -a Append to the given FILEs, don't overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004166 "\n -i Ignore interrupt signals (SIGINT)" \
4167
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004168#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004169 "$ echo \"Hello\" | tee /tmp/foo\n" \
4170 "$ cat /tmp/foo\n" \
4171 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004172
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004173#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004174#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004175 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004176#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004177 "Connect to telnet server\n" \
4178 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004179 "\n -a Automatic login with $USER variable" \
4180 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004181
Eric Andersen539ffc92004-02-22 12:25:47 +00004182#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004183#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004184 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004185#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004186 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004187#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004188
Eric Andersen08a72202002-09-30 20:52:10 +00004189#define telnetd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004190 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004191#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004192 "Handle incoming telnet connections" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004193 IF_NOT_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004194 "\nOptions:" \
4195 "\n -l LOGIN Exec LOGIN on connect" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004196 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004197 "\n -K Close connection as soon as login exits" \
4198 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004199 IF_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004200 "\n -p PORT Port to listen on" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004201 "\n -b ADDR[:PORT] Address to bind to" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004202 "\n -F Run in foreground" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004203 "\n -i Inetd mode" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004204 IF_FEATURE_TELNETD_INETD_WAIT( \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004205 "\n -w SEC Inetd 'wait' mode, linger time SEC" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004206 "\n -S Log to syslog (implied by -i or without -F and -w)" \
4207 ) \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004208 )
Eric Andersen08a72202002-09-30 20:52:10 +00004209
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004210/* "test --help" does not print help (POSIX compat), only "[ --help" does.
Denys Vlasenko662078f2010-01-14 13:27:34 +01004211 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION")
4212 * Unfortunately, it screws up generated BusyBox.html. TODO. */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004213#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004214 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004215#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004216 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4217 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004218#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004219 "$ test 1 -eq 2\n" \
4220 "$ echo $?\n" \
4221 "1\n" \
4222 "$ test 1 -eq 1\n" \
4223 "$ echo $?\n" \
4224 "0\n" \
4225 "$ [ -d /etc ]\n" \
4226 "$ echo $?\n" \
4227 "0\n" \
4228 "$ [ -d /junk ]\n" \
4229 "$ echo $?\n" \
4230 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004231
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004232#define tc_trivial_usage \
4233 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
4234#define tc_full_usage "\n\n" \
4235 "OBJECT: {qdisc|class|filter}\n" \
4236 "CMD: {add|del|change|replace|show}\n" \
4237 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004238 "qdisc [ handle QHANDLE ] [ root |"IF_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004239 /* "[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4240 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4241 " QDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004242 "qdisc show [ dev STRING ]"IF_FEATURE_TC_INGRESS(" [ingress]")"\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004243 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004244 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004245 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
4246 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
4247 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004248 " [ root | classid CLASSID ] [ handle FILTERID ]\n" \
4249 " [ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004250 "filter show [ dev STRING ] [ root | parent CLASSID ]"
4251
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004252#define tcpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004253 "[-hEv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004254/* with not-implemented options: */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004255/* "[-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 +00004256#define tcpsvd_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004257 "Create TCP socket, bind to IP:PORT and listen\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004258 "for incoming connection. Run PROG for each connection.\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004259 "\n IP IP to listen on. '0' = all" \
4260 "\n PORT Port to listen on" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004261 "\n PROG ARGS Program to run" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004262 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4263 "\n -u USER[:GRP] Change to user/group after bind" \
4264 "\n -c N Handle up to N connections simultaneously" \
4265 "\n -b N Allow a backlog of approximately N TCP SYNs" \
4266 "\n -C N[:MSG] Allow only up to N connections from the same IP" \
4267 "\n New connections from this IP address are closed" \
4268 "\n immediately. MSG is written to the peer before close" \
4269 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004270 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004271 "\n -v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004272
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004273#define udpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004274 "[-hEv] [-c N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004275#define udpsvd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004276 "Create UDP socket, bind to IP:PORT and wait\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004277 "for incoming packets. Run PROG for each packet,\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004278 "redirecting all further packets with same peer ip:port to it.\n" \
4279 "\n IP IP to listen on. '0' = all" \
4280 "\n PORT Port to listen on" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004281 "\n PROG ARGS Program to run" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004282 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4283 "\n -u USER[:GRP] Change to user/group after bind" \
4284 "\n -c N Handle up to N connections simultaneously" \
4285 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004286 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004287 "\n -v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004288
Mark Whitley450736c2001-03-02 19:08:50 +00004289#define tftp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004290 "[OPTIONS] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004291#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004292 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004293 "\nOptions:" \
4294 "\n -l FILE Local FILE" \
4295 "\n -r FILE Remote FILE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004296 IF_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004297 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004298 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004299 IF_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004300 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004301 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004302 IF_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004303 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004304 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004305
4306#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004307 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004308#define tftpd_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004309 "Transfer a file on tftp client's request\n" \
Denis Vlasenko91f8f822008-10-30 23:42:37 +00004310 "\n" \
4311 "tftpd should be used as an inetd service.\n" \
4312 "tftpd's line for inetd.conf:\n" \
4313 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
4314 "It also can be ran from udpsvd:\n" \
4315 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004316 "\nOptions:" \
4317 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004318 "\n -c Allow file creation via upload" \
4319 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004320
Eric Andersenc3657422001-11-30 07:54:32 +00004321#define time_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004322 "[OPTIONS] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004323#define time_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004324 "Run PROG, display resource usage when it exits\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004325 "\nOptions:" \
4326 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004327
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004328#define timeout_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004329 "[-t SECS] [-s SIG] PROG ARGS"
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004330#define timeout_full_usage "\n\n" \
4331 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
Denis Vlasenko42404082008-11-24 13:42:24 +00004332 "Defaults: SECS: 10, SIG: TERM." \
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004333
Eric Andersen420b2082002-09-17 22:14:58 +00004334#define top_trivial_usage \
Denys Vlasenko00528822009-09-11 23:26:42 +02004335 "[-b] [-nCOUNT] [-dSECONDS]" IF_FEATURE_TOPMEM(" [-m]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004336#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004337 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004338 "Read the status of all processes from /proc each SECONDS\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004339 "and display a screenful of them." \
4340//TODO: add options and keyboard commands
Eric Andersen420b2082002-09-17 22:14:58 +00004341
Eric Andersen7e9276b2001-02-22 01:15:47 +00004342#define touch_trivial_usage \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004343 "[-c] [-d DATE] FILE [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004344#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004345 "Update the last-modified date on the given FILE[s]\n" \
4346 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004347 "\n -c Don't create files" \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004348 "\n -d DT Date/time to use" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004349
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004350#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004351 "$ ls -l /tmp/foo\n" \
4352 "/bin/ls: /tmp/foo: No such file or directory\n" \
4353 "$ touch /tmp/foo\n" \
4354 "$ ls -l /tmp/foo\n" \
4355 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004356
4357#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004358 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004359#define tr_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004360 "Translate, squeeze, or delete characters from stdin, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004361 "\nOptions:" \
4362 "\n -c Take complement of STRING1" \
4363 "\n -d Delete input characters coded STRING1" \
4364 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4365
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004366#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004367 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4368 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004369
Eric Andersen5c58d282001-07-10 16:29:00 +00004370#define traceroute_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004371 "[-"IF_TRACEROUTE6("46")"FIldnrv] [-f 1ST_TTL] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
4372 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-g GATEWAY] [-i IFACE]\n" \
4373 " [-z PAUSE_MSEC] HOST [BYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004374#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004375 "Trace the route to HOST\n" \
4376 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004377 IF_TRACEROUTE6( \
4378 "\n -4, -6 Force IP or IPv6 name resolution" \
4379 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004380 "\n -F Set the don't fragment bit" \
4381 "\n -I Use ICMP ECHO instead of UDP datagrams" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004382 "\n -l Display the TTL value of the returned packet" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004383 "\n -d Set SO_DEBUG options to socket" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004384 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004385 "\n -r Bypass routing tables, send directly to HOST" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004386 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004387 "\n -m Max time-to-live (max number of hops)" \
4388 "\n -p Base UDP port number used in probes" \
4389 "\n (default 33434)" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004390 "\n -q Number of probes per TTL (default 3)" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004391 "\n -s IP address to use as the source address" \
4392 "\n -t Type-of-service in probe packets (default 0)" \
4393 "\n -w Time in seconds to wait for a response (default 3)" \
4394 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004395
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004396#define traceroute6_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004397 "[-dnrv] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
4398 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-i IFACE]\n" \
4399 " HOST [BYTES]"
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004400#define traceroute6_full_usage "\n\n" \
4401 "Trace the route to HOST\n" \
4402 "\nOptions:" \
4403 "\n -d Set SO_DEBUG options to socket" \
4404 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004405 "\n -r Bypass routing tables, send directly to HOST" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004406 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004407 "\n -m Max time-to-live (max number of hops)" \
4408 "\n -p Base UDP port number used in probes" \
4409 "\n (default is 33434)" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004410 "\n -q Number of probes per TTL (default 3)" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004411 "\n -s IP address to use as the source address" \
4412 "\n -t Type-of-service in probe packets (default 0)" \
4413 "\n -w Time in seconds to wait for a response (default 3)" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004414
Eric Andersen7e9276b2001-02-22 01:15:47 +00004415#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004416 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004417#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004418 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004419#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004420 "$ true\n" \
4421 "$ echo $?\n" \
4422 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004423
Eric Andersen7e9276b2001-02-22 01:15:47 +00004424#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004425 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004426#define tty_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004427 "Print file name of stdin's terminal" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004428 IF_INCLUDE_SUSv2( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004429 "\nOptions:" \
4430 "\n -s Print nothing, only return exit status" \
4431 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004432#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004433 "$ tty\n" \
4434 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004435
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004436#define ttysize_trivial_usage \
4437 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004438#define ttysize_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004439 "Print dimension(s) of stdin's terminal, on error return 80x25"
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004440
Denis Vlasenko39b68132009-01-23 02:07:14 +00004441#define tunctl_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004442 "[-f device] ([-t name] | -d name)" IF_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]")
Denis Vlasenko39b68132009-01-23 02:07:14 +00004443#define tunctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004444 "Create or delete tun interfaces\n" \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004445 "\nOptions:" \
4446 "\n -f name tun device (/dev/net/tun)" \
4447 "\n -t name Create iface 'name'" \
4448 "\n -d name Delete iface 'name'" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004449 IF_FEATURE_TUNCTL_UG( \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004450 "\n -u owner Set iface owner" \
4451 "\n -g group Set iface group" \
4452 "\n -b Brief output" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004453 )
Denis Vlasenko39b68132009-01-23 02:07:14 +00004454#define tunctl_example_usage \
4455 "# tunctl\n" \
4456 "# tunctl -d tun0\n"
4457
Mike Frysinger174808c2005-06-11 01:14:09 +00004458#define tune2fs_trivial_usage \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004459/* "[-c max-mounts-count] [-e errors-behavior] [-g group] " */ \
4460/* "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " */ \
4461/* "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " */ \
4462/* "[-r reserved-blocks-count] [-u user] [-C mount-count] " */ \
4463 "[-L LABEL] " \
4464/* "[-M last-mounted-dir] [-O [^]feature[,...]] " */ \
4465/* "[-T last-check-time] [-U UUID] " */ \
4466 "BLOCKDEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004467#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004468 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004469
Denys Vlasenko0d98b442010-08-07 02:56:43 +02004470#if defined CONFIG_UDHCP_DEBUG && CONFIG_UDHCP_DEBUG >= 1
4471# define IF_UDHCP_VERBOSE(...) __VA_ARGS__
4472#else
4473# define IF_UDHCP_VERBOSE(...)
4474#endif
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004475#define udhcpc_trivial_usage \
Denys Vlasenko0d98b442010-08-07 02:56:43 +02004476 "[-fbnq"IF_UDHCP_VERBOSE("v")"oCR] [-i IFACE] [-r IP] [-s PROG] [-p PIDFILE]\n" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004477 " [-H HOSTNAME] [-c CID] [-V VENDOR] [-O DHCP_OPT]..." IF_FEATURE_UDHCP_PORT(" [-P N]")
4478#define udhcpc_full_usage "\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004479 IF_LONG_OPTS( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004480 "\n -i,--interface IFACE Interface to use (default eth0)" \
4481 "\n -p,--pidfile FILE Create pidfile" \
4482 "\n -r,--request IP IP address to request" \
4483 "\n -s,--script PROG Run PROG at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
4484 "\n -t,--retries N Send up to N discover packets" \
4485 "\n -T,--timeout N Pause between packets (default 3 seconds)" \
Denys Vlasenkoe6080a42010-04-14 14:04:26 -07004486 "\n -A,--tryagain N Wait N seconds after failure (default 20)" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004487 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004488 USE_FOR_MMU( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004489 "\n -b,--background Background if lease is not obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004490 ) \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004491 "\n -S,--syslog Log to syslog too" \
4492 "\n -n,--now Exit if lease is not obtained" \
4493 "\n -q,--quit Exit after obtaining lease" \
4494 "\n -R,--release Release IP on exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004495 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004496 "\n -P,--client-port N Use port N (default 68)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004497 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004498 IF_FEATURE_UDHCPC_ARPING( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004499 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004500 ) \
Denys Vlasenkoe6080a42010-04-14 14:04:26 -07004501 "\n -O,--request-option OPT Request DHCP option OPT (cumulative)" \
4502 "\n -o,--no-default-options Don't request any options (unless -O is given)" \
4503 "\n -x OPT:VAL Include option OPT in sent packets (cumulative)" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004504 "\n -F,--fqdn NAME Ask server to update DNS mapping for NAME" \
4505 "\n -H,-h,--hostname NAME Send NAME as client hostname (default none)" \
4506 "\n -V,--vendorclass VENDOR Vendor identifier (default 'udhcp VERSION')" \
4507 "\n -c,--clientid CLIENTID Client identifier (default own MAC)" \
4508 "\n -C,--clientid-none Don't send client identifier" \
Denys Vlasenko0d98b442010-08-07 02:56:43 +02004509 IF_UDHCP_VERBOSE( \
4510 "\n -v Verbose" \
4511 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004512 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004513 IF_NOT_LONG_OPTS( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004514 "\n -i IFACE Interface to use (default eth0)" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +01004515 "\n -p FILE Create pidfile" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004516 "\n -r IP IP address to request" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004517 "\n -s PROG Run PROG at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
4518 "\n -t N Send up to N discover packets" \
4519 "\n -T N Pause between packets (default 3 seconds)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004520 "\n -A N Wait N seconds (default 20) after failure" \
Denys Vlasenko7e6add12010-03-25 20:32:38 +01004521 "\n -x OPT:VAL Include option OPT in sent packets" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004522 "\n -O OPT Request DHCP option OPT (cumulative)" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004523 "\n -o Don't request any options (unless -O is given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004524 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004525 USE_FOR_MMU( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004526 "\n -b Background if lease is not obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004527 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004528 "\n -S Log to syslog too" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004529 "\n -n Exit if lease is not obtained" \
4530 "\n -q Exit after obtaining lease" \
4531 "\n -R Release IP on exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004532 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004533 "\n -P N Use port N (default 68)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004534 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004535 IF_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004536 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004537 ) \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004538 "\n -F NAME Ask server to update DNS mapping for NAME" \
4539 "\n -H,-h NAME Send NAME as client hostname (default none)" \
4540 "\n -V VENDOR Vendor identifier (default 'udhcp VERSION')" \
4541 "\n -c CLIENTID Client identifier (default own MAC)" \
4542 "\n -C Don't send client identifier" \
Denys Vlasenko0d98b442010-08-07 02:56:43 +02004543 IF_UDHCP_VERBOSE( \
4544 "\n -v Verbose" \
4545 ) \
4546 ) \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004547
Russ Dill61fb4892002-10-14 21:41:28 +00004548#define udhcpd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004549 "[-fS]" IF_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004550
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004551#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004552 "DHCP server\n" \
4553 "\n -f Run in foreground" \
4554 "\n -S Log to syslog too" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004555 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004556 "\n -P N Use port N (default 67)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004557 )
Russ Dill61fb4892002-10-14 21:41:28 +00004558
Eric Andersen7e9276b2001-02-22 01:15:47 +00004559#define umount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004560 "[OPTIONS] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004561#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004562 "Unmount file systems\n" \
4563 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004564 IF_FEATURE_UMOUNT_ALL( \
4565 "\n -a Unmount all file systems" IF_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004566 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004567 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004568 "\n -n Don't erase /etc/mtab entries" \
4569 ) \
4570 "\n -r Try to remount devices as read-only if mount is busy" \
4571 "\n -l Lazy umount (detach filesystem)" \
4572 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004573 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004574 "\n -d Free loop device if it has been used" \
4575 )
4576
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004577#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004578 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004579
4580#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004581 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004582#define uname_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004583 "Print system information\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004584 "\nOptions:" \
4585 "\n -a Print all" \
4586 "\n -m The machine (hardware) type" \
4587 "\n -n Hostname" \
4588 "\n -r OS release" \
4589 "\n -s OS name (default)" \
4590 "\n -p Processor type" \
4591 "\n -v OS version" \
4592
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004593#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004594 "$ uname -a\n" \
4595 "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 +00004596
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004597#define uncompress_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004598 "[-cf] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004599#define uncompress_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02004600 "Decompress .Z file[s]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004601 "\nOptions:" \
Denys Vlasenkoa3581402010-05-27 02:30:04 +02004602 "\n -c Write to stdout" \
4603 "\n -f Overwrite" \
Tim Riker7b253f82003-12-28 05:02:40 +00004604
Denis Vlasenko3952f202007-08-13 14:10:24 +00004605#define unexpand_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004606 "[-fa][-t N] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004607#define unexpand_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004608 "Convert spaces to tabs, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004609 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004610 IF_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004611 "\n -a,--all Convert all blanks" \
4612 "\n -f,--first-only Convert only leading blanks" \
4613 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004614 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004615 IF_NOT_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004616 "\n -a Convert all blanks" \
4617 "\n -f Convert only leading blanks" \
4618 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004619 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004620
Eric Andersen7e9276b2001-02-22 01:15:47 +00004621#define uniq_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004622 "[-cdu][-f,s,w N] [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004623#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004624 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004625 "\nOptions:" \
4626 "\n -c Prefix lines by the number of occurrences" \
4627 "\n -d Only print duplicate lines" \
4628 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004629 "\n -f N Skip first N fields" \
4630 "\n -s N Skip first N chars (after any skipped fields)" \
4631 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004632
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004633#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004634 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4635 "a\n" \
4636 "b\n" \
4637 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004638
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004639#define unzip_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004640 "[-opts[modifiers]] FILE[.zip] [LIST] [-x XLIST] [-d DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004641#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004642 "Extract files from ZIP archives\n" \
4643 "\nOptions:" \
4644 "\n -l List archive contents (with -q for short form)" \
Denys Vlasenkoa3581402010-05-27 02:30:04 +02004645 "\n -n Never overwrite files (default)" \
4646 "\n -o Overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004647 "\n -p Send output to stdout" \
4648 "\n -q Quiet" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004649 "\n -x XLST Exclude these files" \
4650 "\n -d DIR Extract files into DIR" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004651
Eric Andersen7e9276b2001-02-22 01:15:47 +00004652#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004653 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004654#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004655 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004656
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004657#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004658 "$ uptime\n" \
4659 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004660
4661#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004662 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004663#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004664 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004665
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004666#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004667 "$ usleep 1000000\n" \
4668 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004669
4670#define uudecode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004671 "[-o OUTFILE] [INFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004672#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004673 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004674 "Finds outfile name in uuencoded source unless -o is given"
4675
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004676#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004677 "$ uudecode -o busybox busybox.uu\n" \
4678 "$ ls -l busybox\n" \
4679 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004680
4681#define uuencode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004682 "[-m] [INFILE] STORED_FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004683#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004684 "Uuencode a file to stdout\n" \
4685 "\nOptions:" \
4686 "\n -m Use base64 encoding per RFC1521" \
4687
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004688#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004689 "$ uuencode busybox busybox\n" \
4690 "begin 755 busybox\n" \
4691 "<encoded file snipped>\n" \
4692 "$ uudecode busybox busybox > busybox.uu\n" \
4693 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004694
Eric Andersen853c4942003-01-23 05:59:32 +00004695#define vconfig_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004696 "COMMAND [OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004697#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004698 "Create and remove virtual ethernet devices\n" \
4699 "\nOptions:" \
4700 "\n add [interface-name] [vlan_id]" \
4701 "\n rem [vlan-name]" \
4702 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4703 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4704 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4705 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004706
Eric Andersen3f980402001-04-04 17:31:15 +00004707#define vi_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004708 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004709#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004710 "Edit FILE\n" \
4711 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004712 IF_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004713 "\n -c Initial command to run ($EXINIT also available)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004714 IF_FEATURE_VI_READONLY( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004715 "\n -R Read-only") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004716 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00004717
Eric Andersen27f64e12002-06-23 04:24:25 +00004718#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004719 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004720#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004721 "Lock a virtual terminal. A password is required to unlock.\n" \
4722 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00004723 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004724
Matthew Stoltenberg4803db52009-08-13 00:59:32 +02004725#define volname_trivial_usage \
4726 "[DEVICE]"
4727#define volname_full_usage "\n\n" \
4728 "Show CD volume name of the DEVICE (default /dev/cdrom)"
4729
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01004730#define wall_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004731 "[FILE]"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01004732#define wall_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004733 "Write content of FILE or stdin to all logged-in users"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01004734#define wall_sample_usage \
4735 "echo foo | wall\n" \
4736 "wall ./mymessage"
4737
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004738#define watch_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004739 "[-n SEC] [-t] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004740#define watch_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004741 "Run PROG periodically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004742 "\nOptions:" \
4743 "\n -n Loop period in seconds (default 2)" \
4744 "\n -t Don't print header" \
4745
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004746#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004747 "$ watch date\n" \
4748 "Mon Dec 17 10:31:40 GMT 2000\n" \
4749 "Mon Dec 17 10:31:42 GMT 2000\n" \
4750 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004751
Eric Andersen7e9276b2001-02-22 01:15:47 +00004752#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004753 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004754#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004755 "Periodically write to watchdog device DEV\n" \
4756 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004757 "\n -T N Reboot after N seconds if not reset (default 60)" \
4758 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004759 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004760 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004761 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004762
4763#define wc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004764 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004765#define wc_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004766 "Print line, word, and byte counts for each FILE (or stdin),\n" \
4767 "and a total line if more than one FILE is specified\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004768 "\nOptions:" \
4769 "\n -c Print the byte counts" \
4770 "\n -l Print the newline counts" \
4771 "\n -L Print the length of the longest line" \
4772 "\n -w Print the word counts" \
4773
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004774#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004775 "$ wc /etc/passwd\n" \
4776 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004777
4778#define wget_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004779 IF_FEATURE_WGET_LONG_OPTIONS( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004780 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document FILE]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004781 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004782 " [--no-check-certificate] [-U|--user-agent AGENT] URL" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004783 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004784 IF_NOT_FEATURE_WGET_LONG_OPTIONS( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004785 "[-csq] [-O FILE] [-Y on/off] [-P DIR] [-U AGENT] URL" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004786 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004787#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004788 "Retrieve files via HTTP or FTP\n" \
4789 "\nOptions:" \
4790 "\n -s Spider mode - only check file existence" \
4791 "\n -c Continue retrieval of aborted transfer" \
4792 "\n -q Quiet" \
4793 "\n -P Set directory prefix to DIR" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004794 "\n -O FILE Save to FILE ('-' for stdout)" \
4795 "\n -U STR Use STR for User-Agent header" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004796 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004797
4798#define which_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004799 "[COMMAND]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004800#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004801 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004802#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004803 "$ which login\n" \
4804 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004805
Eric Andersen00a6a752002-04-26 23:53:10 +00004806#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004807 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004808#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004809 "Show who is logged on\n" \
4810 "\nOptions:" \
Denys Vlasenko838e0db2010-06-07 03:04:46 +02004811 "\n -a Show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004812
4813#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004814 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004815#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004816 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004817
Eric Andersen7e9276b2001-02-22 01:15:47 +00004818#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004819 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004820#define zcat_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02004821 "Decompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004822
Rob Landleyad8071f2005-04-30 03:49:37 +00004823#define zcip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004824 "[OPTIONS] IFACE SCRIPT"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004825#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004826 "Manage a ZeroConf IPv4 link-local address\n" \
4827 "\nOptions:" \
4828 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004829 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004830 "\n -r 169.254.x.x Request this address first" \
4831 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004832 "\n" \
4833 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
4834 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00004835
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00004836
4837#endif