blob: bd2e56385b103797394cd8dcbf3cb006779805f6 [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
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000118#define sh_trivial_usage NOUSAGE_STR
119#define sh_full_usage ""
120#define ash_trivial_usage NOUSAGE_STR
121#define ash_full_usage ""
122#define hush_trivial_usage NOUSAGE_STR
123#define hush_full_usage ""
Denys Vlasenko1cc4b132009-08-21 00:05:51 +0200124#define lash_trivial_usage NOUSAGE_STR
125#define lash_full_usage ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000126#define msh_trivial_usage NOUSAGE_STR
127#define msh_full_usage ""
Denys Vlasenko40477e22010-05-20 02:09:45 +0200128#define bash_trivial_usage NOUSAGE_STR
129#define bash_full_usage ""
Eric Andersen08f59e32004-03-12 22:07:10 +0000130
131#define awk_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200132 "[OPTIONS] [AWK_PROGRAM] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000133#define awk_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000134 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200135 "\n -v VAR=VAL Set variable" \
136 "\n -F SEP Use SEP as field separator" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +0100137 "\n -f FILE Read program from FILE" \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +0000138
Eric Andersen7e9276b2001-02-22 01:15:47 +0000139#define basename_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000140 "FILE [SUFFIX]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000141#define basename_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200142 "Strip directory path and .SUFFIX from FILE\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000143#define basename_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000144 "$ basename /usr/local/bin/foo\n" \
145 "foo\n" \
146 "$ basename /usr/local/bin/\n" \
147 "bin\n" \
148 "$ basename /foo/bar.txt .txt\n" \
149 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000150
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200151#define beep_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100152 "-f FREQ -l LEN -d DELAY -r COUNT -n"
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200153#define beep_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +0200154 "Options:" \
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200155 "\n -f Frequency in Hz" \
156 "\n -l Length in ms" \
157 "\n -d Delay in ms" \
158 "\n -r Repetitions" \
159 "\n -n Start new tone" \
160
Grigory Batalovad7a5d42010-05-23 23:22:10 +0200161#define blkid_trivial_usage \
162 ""
163#define blkid_full_usage "\n\n" \
164 "Print UUIDs of all filesystems"
165
Denys Vlasenkoff027d62010-05-04 15:45:25 +0200166#define bootchartd_trivial_usage \
167 "start [PROG ARGS]|stop|init"
168#define bootchartd_full_usage "\n\n" \
169 "Create /var/log/bootchart.tgz with boot chart data\n" \
170 "\nOptions:" \
171 "\nstart: start background logging; with PROG, run PROG, then kill logging with USR1" \
172 "\nstop: send USR1 to all bootchartd processes" \
173 "\ninit: start background logging; stop when getty/xdm is seen (for init scripts)" \
174 "\nUnder PID 1: as init, then exec $bootchart_init, /init, /sbin/init" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000175
Bernhard Reutner-Fischerd27d9252008-01-13 15:23:27 +0000176#define brctl_trivial_usage \
177 "COMMAND [BRIDGE [INTERFACE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000178#define brctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200179 "Manage ethernet bridges\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000180 "\nCommands:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000181 IF_FEATURE_BRCTL_SHOW( \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000182 "\n show Show a list of bridges" \
183 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000184 "\n addbr BRIDGE Create BRIDGE" \
185 "\n delbr BRIDGE Delete BRIDGE" \
186 "\n addif BRIDGE IFACE Add IFACE to BRIDGE" \
187 "\n delif BRIDGE IFACE Delete IFACE from BRIDGE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000188 IF_FEATURE_BRCTL_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000189 "\n setageing BRIDGE TIME Set ageing time" \
190 "\n setfd BRIDGE TIME Set bridge forward delay" \
191 "\n sethello BRIDGE TIME Set hello time" \
192 "\n setmaxage BRIDGE TIME Set max message age" \
193 "\n setpathcost BRIDGE COST Set path cost" \
194 "\n setportprio BRIDGE PRIO Set port priority" \
195 "\n setbridgeprio BRIDGE PRIO Set bridge priority" \
Maciek Borzecki30ebd7b2010-03-23 05:18:38 +0100196 "\n stp BRIDGE [1/yes/on|0/no/off] STP on/off" \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000197 ) \
198
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000199#define bzip2_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200200 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000201#define bzip2_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100202 "Compress FILEs (or stdin) with bzip2 algorithm\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000203 "\nOptions:" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200204 "\n -1..9 Compression level" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000205 "\n -d Decompress" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200206 "\n -c Write to stdout" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000207 "\n -f Force" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000208
Rob Landley6130b9b2006-01-23 21:10:38 +0000209#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000210 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000211
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000212#define lzop_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200213 "[-cfvd123456789CF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000214#define lzop_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200215 "Options:" \
216 "\n -1..9 Compression level" \
217 "\n -d Decompress" \
218 "\n -c Write to stdout" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000219 "\n -f Force" \
220 "\n -v Verbose" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000221 "\n -F Don't store or verify checksum" \
222 "\n -C Also write checksum of compressed block" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000223
224#define lzopcat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200225 "[-vCF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000226#define lzopcat_full_usage "\n\n" \
227 " -v Verbose" \
228 "\n -F Don't store or verify checksum" \
229
230#define unlzop_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200231 "[-cfvCF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000232#define unlzop_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200233 "Options:" \
234 "\n -c Write to stdout" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000235 "\n -f Force" \
236 "\n -v Verbose" \
237 "\n -F Don't store or verify checksum" \
238
Rob Landleyc1d69902006-01-20 18:28:50 +0000239#define unlzma_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100240 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000241#define unlzma_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200242 "Decompress FILE (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000243 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100244 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000245 "\n -f Force" \
Rob Landleyc1d69902006-01-20 18:28:50 +0000246
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200247#define lzma_trivial_usage \
248 "-d [OPTIONS] [FILE]..."
249#define lzma_full_usage "\n\n" \
250 "Decompress FILE (or stdin)\n" \
251 "\nOptions:" \
252 "\n -d Decompress" \
253 "\n -c Write to stdout" \
254 "\n -f Force" \
255
256#define lzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000257 "FILE"
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200258#define lzcat_full_usage "\n\n" \
259 "Decompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000260
Denys Vlasenko602ce692010-05-30 03:35:18 +0200261#define unxz_trivial_usage \
262 "[OPTIONS] [FILE]..."
263#define unxz_full_usage "\n\n" \
264 "Decompress FILE (or stdin)\n" \
265 "\nOptions:" \
266 "\n -c Write to stdout" \
267 "\n -f Force" \
268
269#define xz_trivial_usage \
270 "-d [OPTIONS] [FILE]..."
271#define xz_full_usage "\n\n" \
272 "Decompress FILE (or stdin)\n" \
273 "\nOptions:" \
274 "\n -d Decompress" \
275 "\n -c Write to stdout" \
276 "\n -f Force" \
277
278#define xzcat_trivial_usage \
279 "FILE"
280#define xzcat_full_usage "\n\n" \
281 "Decompress to stdout"
282
Eric Andersenc98c0622001-12-06 15:16:43 +0000283#define cal_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100284 "[-jy] [[MONTH] YEAR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000285#define cal_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000286 "Display a calendar\n" \
287 "\nOptions:" \
288 "\n -j Use julian dates" \
289 "\n -y Display the entire year" \
Eric Andersenc98c0622001-12-06 15:16:43 +0000290
Eric Andersen7e9276b2001-02-22 01:15:47 +0000291#define cat_trivial_usage \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200292 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000293#define cat_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +0200294 "Concatenate FILEs and print them to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000295
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000296#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000297 "$ cat /proc/uptime\n" \
298 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000299
Rob Landley8abbee42006-05-31 19:36:04 +0000300#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000301 "[-etv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000302#define catv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000303 "Display nonprinting characters as ^x or M-x\n" \
304 "\nOptions:" \
305 "\n -e End each line with $" \
306 "\n -t Show tabs as ^I" \
307 "\n -v Don't use ^x or M-x escapes" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000308
309#define chat_trivial_usage \
310 "EXPECT [SEND [EXPECT [SEND...]]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000311#define chat_full_usage "\n\n" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000312 "Useful for interacting with a modem connected to stdin/stdout.\n" \
313 "A script consists of one or more \"expect-send\" pairs of strings,\n" \
314 "each pair is a pair of arguments. Example:\n" \
315 "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \
316
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000317#define chattr_trivial_usage \
Denys Vlasenko79ae5342010-01-06 12:27:18 +0100318 "[-R] [-+=AacDdijsStTu] [-v VERSION] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000319#define chattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000320 "Change file attributes on an ext2 fs\n" \
321 "\nModifiers:" \
322 "\n - Remove attributes" \
323 "\n + Add attributes" \
324 "\n = Set attributes" \
325 "\nAttributes:" \
326 "\n A Don't track atime" \
327 "\n a Append mode only" \
328 "\n c Enable compress" \
329 "\n D Write dir contents synchronously" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200330 "\n d Don't backup with dump" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000331 "\n i Cannot be modified (immutable)" \
332 "\n j Write all data to journal first" \
333 "\n s Zero disk storage when deleted" \
334 "\n S Write file contents synchronously" \
335 "\n t Disable tail-merging of partial blocks with other files" \
336 "\n u Allow file to be undeleted" \
337 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100338 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000339 "\n -v Set the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000340
Denis Vlasenko49622d72007-03-10 16:58:49 +0000341#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000342 "[OPTIONS] CONTEXT FILE..." \
343 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000344 IF_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000345 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
346 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000347#define chcon_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000348 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000349 IF_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000350 "\n -v,--verbose Verbose" \
351 "\n -c,--changes Report changes made" \
352 "\n -h,--no-dereference Affect symlinks instead of their targets" \
353 "\n -f,--silent,--quiet Suppress most error messages" \
354 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
355 "\n -u,--user=USER Set user/role/type/range in the target" \
356 "\n -r,--role=ROLE security context" \
357 "\n -t,--type=TYPE" \
358 "\n -l,--range=RANGE" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200359 "\n -R,--recursive Recurse" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000360 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000361 IF_NOT_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000362 "\n -v Verbose" \
363 "\n -c Report changes made" \
364 "\n -h Affect symlinks instead of their targets" \
365 "\n -f Suppress most error messages" \
366 "\n -u USER Set user/role/type/range in the target security context" \
367 "\n -r ROLE" \
368 "\n -t TYPE" \
369 "\n -l RNG" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200370 "\n -R Recurse" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000371 )
372
Eric Andersen7e9276b2001-02-22 01:15:47 +0000373#define chmod_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000374 "[-R"IF_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000375#define chmod_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000376 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000377 "symbols +-= and one or more of the letters rwxst\n" \
378 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200379 "\n -R Recurse" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000380 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000381 "\n -c List changed files" \
382 "\n -v List all files" \
383 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000384 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000385#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000386 "$ ls -l /tmp/foo\n" \
387 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
388 "$ chmod u+x /tmp/foo\n" \
389 "$ ls -l /tmp/foo\n" \
390 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
391 "$ chmod 444 /tmp/foo\n" \
392 "$ ls -l /tmp/foo\n" \
393 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000394
Denis Vlasenko081ef792007-03-17 16:38:21 +0000395#define chgrp_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000396 "[-RhLHP"IF_DESKTOP("cvf")"]... GROUP FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000397#define chgrp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000398 "Change the group membership of each FILE to GROUP\n" \
399 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200400 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000401 "\n -h Affect symlinks instead of symlink targets" \
402 "\n -L Traverse all symlinks to directories" \
403 "\n -H Traverse symlinks on command line only" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200404 "\n -P Don't traverse symlinks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000405 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000406 "\n -c List changed files" \
407 "\n -v Verbose" \
408 "\n -f Hide errors" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000409 )
410#define chgrp_example_usage \
411 "$ ls -l /tmp/foo\n" \
412 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
413 "$ chgrp root /tmp/foo\n" \
414 "$ ls -l /tmp/foo\n" \
415 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
416
Eric Andersen7e9276b2001-02-22 01:15:47 +0000417#define chown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000418 "[-RhLHP"IF_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000419#define chown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000420 "Change the owner and/or group of each FILE to OWNER and/or GROUP\n" \
421 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200422 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000423 "\n -h Affect symlinks instead of symlink targets" \
424 "\n -L Traverse all symlinks to directories" \
425 "\n -H Traverse symlinks on command line only" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200426 "\n -P Don't traverse symlinks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000427 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000428 "\n -c List changed files" \
429 "\n -v List all files" \
430 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000431 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000432#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000433 "$ ls -l /tmp/foo\n" \
434 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
435 "$ chown root /tmp/foo\n" \
436 "$ ls -l /tmp/foo\n" \
437 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
438 "$ chown root.root /tmp/foo\n" \
439 "ls -l /tmp/foo\n" \
440 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000441
Denis Vlasenkofe544582006-10-03 15:57:40 +0000442#define chpst_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000443 "[-vP012] [-u USER[:GRP]] [-U USER[:GRP]] [-e DIR]\n" \
444 " [-/ DIR] [-n NICE] [-m BYTES] [-d BYTES] [-o N]\n" \
445 " [-p N] [-f BYTES] [-c BYTES] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000446#define chpst_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000447 "Change the process state and run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000448 "\nOptions:" \
449 "\n -u USER[:GRP] Set uid and gid" \
450 "\n -U USER[:GRP] Set $UID and $GID in environment" \
451 "\n -e DIR Set environment variables as specified by files" \
452 "\n in DIR: file=1st_line_of_file" \
453 "\n -/ DIR Chroot to DIR" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000454 "\n -n NICE Add NICE to nice value" \
455 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000456 "\n -d BYTES Limit data segment" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000457 "\n -o N Limit number of open files per process" \
458 "\n -p N Limit number of processes per uid" \
459 "\n -f BYTES Limit output file sizes" \
460 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000461 "\n -v Verbose" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000462 "\n -P Create new process group" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100463 "\n -0 Close stdin" \
464 "\n -1 Close stdout" \
465 "\n -2 Close stderr" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000466
Denis Vlasenkofe544582006-10-03 15:57:40 +0000467#define setuidgid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100468 "USER PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000469#define setuidgid_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100470 "Set uid and gid to USER's uid and gid, removing all supplementary\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000471 "groups and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000472#define envuidgid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100473 "USER PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000474#define envuidgid_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100475 "Set $UID to USER's uid and $GID to USER's gid and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000476#define envdir_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100477 "DIR PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000478#define envdir_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000479 "Set various environment variables as specified by files\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000480 "in the directory dir and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000481#define softlimit_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000482 "[-a BYTES] [-m BYTES] [-d BYTES] [-s BYTES] [-l BYTES]\n" \
483 " [-f BYTES] [-c BYTES] [-r BYTES] [-o N] [-p N] [-t N]\n" \
484 " PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000485#define softlimit_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000486 "Set soft resource limits, then run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000487 "\nOptions:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000488 "\n -a BYTES Limit total size of all segments" \
489 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES -a BYTES" \
490 "\n -d BYTES Limit data segment" \
491 "\n -s BYTES Limit stack segment" \
492 "\n -l BYTES Limit locked memory size" \
493 "\n -o N Limit number of open files per process" \
494 "\n -p N Limit number of processes per uid" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000495 "\nOptions controlling file sizes:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000496 "\n -f BYTES Limit output file sizes" \
497 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000498 "\nEfficiency opts:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000499 "\n -r BYTES Limit resident set size" \
500 "\n -t N Limit CPU time, process receives" \
501 "\n a SIGXCPU after N seconds" \
Denis Vlasenkofe544582006-10-03 15:57:40 +0000502
Eric Andersen7e9276b2001-02-22 01:15:47 +0000503#define chroot_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100504 "NEWROOT [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000505#define chroot_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200506 "Run PROG with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000507#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000508 "$ ls -l /bin/ls\n" \
509 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
510 "# mount /dev/hdc1 /mnt -t minix\n" \
511 "# chroot /mnt\n" \
512 "# ls -l /bin/ls\n" \
513 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000514
Eric Andersen7e9276b2001-02-22 01:15:47 +0000515#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000516 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000517#define chvt_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000518 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000519
Rob Landley856489b2006-04-18 20:57:28 +0000520#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000521 "FILES..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000522#define cksum_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000523 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000524
Eric Andersen7e9276b2001-02-22 01:15:47 +0000525#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000526 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000527#define clear_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000528 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000529
Eric Andersen7e9276b2001-02-22 01:15:47 +0000530#define cmp_trivial_usage \
Denys Vlasenko65ebbc52010-05-09 04:38:22 +0200531 "[-l] [-s] FILE1 [FILE2" IF_DESKTOP(" [SKIP1 [SKIP2]]") "]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000532#define cmp_full_usage "\n\n" \
Denys Vlasenko65ebbc52010-05-09 04:38:22 +0200533 "Compare FILE1 with FILE2 (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000534 "\nOptions:" \
535 "\n -l Write the byte numbers (decimal) and values (octal)" \
536 "\n for all differing bytes" \
537 "\n -s Quiet" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000538
Rob Landley2acfd7b2005-05-11 23:12:49 +0000539#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000540 "[-123] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000541#define comm_full_usage "\n\n" \
Denys Vlasenko65ebbc52010-05-09 04:38:22 +0200542 "Compare FILE1 with FILE2\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000543 "\nOptions:" \
544 "\n -1 Suppress lines unique to FILE1" \
545 "\n -2 Suppress lines unique to FILE2" \
546 "\n -3 Suppress lines common to both files" \
Rob Landley2acfd7b2005-05-11 23:12:49 +0000547
Paul Fox79c142d2005-08-01 16:04:40 +0000548#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000549 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000550#define bbconfig_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000551 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000552
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000553#define chrt_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100554 "[OPTIONS] [PRIO] [PID | PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000555#define chrt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000556 "Manipulate real-time attributes of a process\n" \
557 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100558 "\n -p Operate on PID" \
559 "\n -r Set SCHED_RR scheduling" \
560 "\n -f Set SCHED_FIFO scheduling" \
561 "\n -o Set SCHED_OTHER scheduling" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000562 "\n -m Show min and max priorities" \
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000563
564#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000565 "$ chrt -r 4 sleep 900; x=$!\n" \
566 "$ chrt -f -p 3 $x\n" \
567 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000568
Eric Andersen7e9276b2001-02-22 01:15:47 +0000569#define cp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200570 "[OPTIONS] SOURCE DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000571#define cp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000572 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY\n" \
573 "\nOptions:" \
574 "\n -a Same as -dpR" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000575 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000576 "\n -c Preserve security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000577 ) \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100578 "\n -R,-r Recurse" \
579 "\n -d,-P Preserve symlinks (default if -R)" \
580 "\n -L Follow all symlinks" \
581 "\n -H Follow symlinks on command line" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000582 "\n -p Preserve file attributes if possible" \
Denys Vlasenkoa3581402010-05-27 02:30:04 +0200583 "\n -f Overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000584 "\n -i Prompt before overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000585 "\n -l,-s Create (sym)links" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000586
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000587#define cpio_trivial_usage \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100588 "[-dmvu] [-F FILE]" IF_FEATURE_CPIO_O(" [-H newc]") \
589 " [-ti"IF_FEATURE_CPIO_O("o")"]" IF_FEATURE_CPIO_P(" [-p DIR]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000590#define cpio_full_usage "\n\n" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000591 "Extract or list files from a cpio archive" \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100592 IF_FEATURE_CPIO_O(", or" \
593 "\ncreate an archive" IF_FEATURE_CPIO_P(" (-o) or copy files (-p)") \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100594 " using file list on stdin" \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100595 ) \
596 "\n" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000597 "\nMain operation mode:" \
598 "\n -t List" \
599 "\n -i Extract" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000600 IF_FEATURE_CPIO_O( \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100601 "\n -o Create (requires -H newc)" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000602 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000603 IF_FEATURE_CPIO_P( \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100604 "\n -p DIR Copy files to DIR" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000605 ) \
606 "\nOptions:" \
607 "\n -d Make leading directories" \
608 "\n -m Preserve mtime" \
609 "\n -v Verbose" \
610 "\n -u Overwrite" \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100611 "\n -F FILE Input (-t,-i,-p) or output (-o) file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000612 IF_FEATURE_CPIO_O( \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100613 "\n -H newc Archive format" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000614 ) \
Tim Riker7b253f82003-12-28 05:02:40 +0000615
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000616#define crond_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000617 "-fbS -l N " IF_FEATURE_CROND_D("-d N ") "-L LOGFILE -c DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000618#define crond_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000619 " -f Foreground" \
620 "\n -b Background (default)" \
621 "\n -S Log to syslog (default)" \
622 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000623 IF_FEATURE_CROND_D( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000624 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000625 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000626 "\n -L Log to file" \
627 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000628
629#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000630 "[-c DIR] [-u USER] [-ler]|[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000631#define crontab_full_usage "\n\n" \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000632 " -c Crontab directory" \
633 "\n -u User" \
634 "\n -l List crontab" \
635 "\n -e Edit crontab" \
636 "\n -r Delete crontab" \
637 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000638
Denis Vlasenko2211d522008-11-10 18:52:35 +0000639#define cryptpw_trivial_usage \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000640 "[OPTIONS] [PASSWORD] [SALT]"
641/* We do support -s, we just don't mention it */
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000642#define cryptpw_full_usage "\n\n" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000643 "Crypt the PASSWORD using crypt(3)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000644 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200645 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100646 "\n -P,--password-fd=N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000647/* "\n -s,--stdin Use stdin; like -P0" */ \
648 "\n -m,--method=TYPE Encryption method TYPE" \
649 "\n -S,--salt=SALT" \
650 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200651 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100652 "\n -P N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000653/* "\n -s Use stdin; like -P0" */ \
654 "\n -m TYPE Encryption method TYPE" \
655 "\n -S SALT" \
656 ) \
657
658/* mkpasswd is an alias to cryptpw */
659
660#define mkpasswd_trivial_usage \
661 "[OPTIONS] [PASSWORD] [SALT]"
662/* We do support -s, we just don't mention it */
663#define mkpasswd_full_usage "\n\n" \
664 "Crypt the PASSWORD using crypt(3)\n" \
665 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200666 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100667 "\n -P,--password-fd=N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000668/* "\n -s,--stdin Use stdin; like -P0" */ \
669 "\n -m,--method=TYPE Encryption method TYPE" \
670 "\n -S,--salt=SALT" \
671 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200672 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100673 "\n -P N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000674/* "\n -s Use stdin; like -P0" */ \
675 "\n -m TYPE Encryption method TYPE" \
676 "\n -S SALT" \
677 ) \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000678
Denys Vlasenkob367bb22010-05-15 20:43:07 +0200679#define cttyhack_trivial_usage \
680 "PROG ARGS"
681#define cttyhack_full_usage "\n\n" \
682 "Give PROG a controlling tty if possible." \
683 "\nExample for /etc/inittab (for busybox init):" \
684 "\n ::respawn:/bin/cttyhack /bin/sh" \
685 "\nGiving controlling tty to shell running with PID 1:" \
686 "\n $ exec cttyhack sh" \
Denys Vlasenkoef215552010-05-17 09:55:13 +0200687 "\nStarting interactive shell from boot shell script:" \
Denys Vlasenkob367bb22010-05-15 20:43:07 +0200688 "\n setsid cttyhack sh" \
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000689
Eric Andersen7e9276b2001-02-22 01:15:47 +0000690#define cut_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200691 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000692#define cut_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100693 "Print selected fields from each input FILE to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000694 "\nOptions:" \
695 "\n -b LIST Output only bytes from LIST" \
696 "\n -c LIST Output only characters from LIST" \
697 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
698 "\n -s Output only the lines containing delimiter" \
699 "\n -f N Print only these fields" \
700 "\n -n Ignored" \
701
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000702#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000703 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
704 "Hello\n" \
705 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
706 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000707
Eric Andersen7e9276b2001-02-22 01:15:47 +0000708#define date_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200709 "[OPTIONS] [+FMT] [TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000710#define date_full_usage "\n\n" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000711 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000712 "\nOptions:" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200713 IF_NOT_LONG_OPTS( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200714 "\n [-s] TIME Set time to TIME" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000715 "\n -u Work in UTC (don't convert to local time)" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200716 "\n -R Output RFC-2822 compliant date string" \
717 ) IF_LONG_OPTS( \
718 "\n [-s,--set] TIME Set time to TIME" \
Denys Vlasenko50be9632009-10-23 16:25:20 +0200719 "\n -u,--utc Work in UTC (don't convert to local time)" \
720 "\n -R,--rfc-2822 Output RFC-2822 compliant date string" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200721 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000722 IF_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000723 "\n -I[SPEC] Output ISO-8601 compliant date string" \
724 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000725 "\n 'hours', 'minutes', or 'seconds' for date and" \
726 "\n time to the indicated precision" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200727 ) IF_NOT_LONG_OPTS( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000728 "\n -r FILE Display last modification time of FILE" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200729 "\n -d TIME Display TIME, not 'now'" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200730 ) IF_LONG_OPTS( \
Denys Vlasenko50be9632009-10-23 16:25:20 +0200731 "\n -r,--reference FILE Display last modification time of FILE" \
732 "\n -d,--date TIME Display TIME, not 'now'" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200733 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000734 IF_FEATURE_DATE_ISOFMT( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200735 "\n -D FMT Use FMT for -d TIME conversion" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000736 ) \
737 "\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +0200738 "\nRecognized TIME formats:" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000739 "\n hh:mm[:ss]" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000740 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000741 "\n YYYY-MM-DD hh:mm[:ss]" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200742 "\n [[[[[YY]YY]MM]DD]hh]mm[.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000743
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000744#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000745 "$ date\n" \
746 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000747
Eric Andersen7e9276b2001-02-22 01:15:47 +0000748#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000749 "expression..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000750#define dc_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +0000751 "Tiny RPN calculator. Operations:\n" \
752 "+, add, -, sub, *, mul, /, div, %, mod, **, exp, and, or, not, eor,\n" \
753 "p - print top of the stack (without altering the stack),\n" \
754 "f - print entire stack, o - pop the value and set output radix\n" \
755 "(value must be 10 or 16).\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100756 "Examples: 'dc 2 2 add' -> 4, 'dc 8 8 * 2 2 + /' -> 16\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000757
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000758#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000759 "$ dc 2 2 + p\n" \
760 "4\n" \
761 "$ dc 8 8 \\* 2 2 + / p\n" \
762 "16\n" \
763 "$ dc 0 1 and p\n" \
764 "0\n" \
765 "$ dc 0 1 or p\n" \
766 "1\n" \
767 "$ echo 72 9 div 8 mul p | dc\n" \
768 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000769
Eric Andersen7e9276b2001-02-22 01:15:47 +0000770#define dd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000771 "[if=FILE] [of=FILE] " IF_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
772 " [seek=N]" IF_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000773#define dd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000774 "Copy a file with converting and formatting\n" \
775 "\nOptions:" \
776 "\n if=FILE Read from FILE instead of stdin" \
777 "\n of=FILE Write to FILE instead of stdout" \
778 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000779 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000780 "\n ibs=N Read N bytes at a time" \
781 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000782 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000783 "\n obs=N Write N bytes at a time" \
784 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000785 "\n count=N Copy only N input blocks" \
786 "\n skip=N Skip N input blocks" \
787 "\n seek=N Skip N output blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000788 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000789 "\n conv=notrunc Don't truncate output file" \
790 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000791 "\n conv=sync Pad blocks with zeros" \
792 "\n conv=fsync Physically write data out before finishing" \
793 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000794 "\n" \
795 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
796 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
797
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000798#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000799 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
800 "4+0 records in\n" \
801 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000802
Eric Andersen7e9276b2001-02-22 01:15:47 +0000803#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000804 "[N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000805#define deallocvt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000806 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000807
Eric Andersenf349e972001-08-21 16:18:59 +0000808#define delgroup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000809 IF_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000810#define delgroup_full_usage "\n\n" \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000811 "Delete group GROUP from the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000812 IF_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000813
814#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000815 "USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000816#define deluser_full_usage "\n\n" \
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000817 "Delete USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000818
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000819#define depmod_trivial_usage NOUSAGE_STR
820#define depmod_full_usage ""
Bernhard Reutner-Fischer55e547e2008-05-26 12:01:49 +0000821
Denis Vlasenkoc94fa562008-10-26 11:08:14 +0000822#define devmem_trivial_usage \
823 "ADDRESS [WIDTH [VALUE]]"
824
825#define devmem_full_usage "\n\n" \
826 "Read/write from physical address\n" \
827 "\n ADDRESS Address to act upon" \
828 "\n WIDTH Width (8/16/...)" \
829 "\n VALUE Data to be written" \
830
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000831#define devfsd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000832 "mntpnt [-v]" IF_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000833#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000834 "Manage devfs permissions and old device name symlinks\n" \
835 "\nOptions:" \
836 "\n mntpnt The mount point where devfs is mounted" \
837 "\n -v Print the protocol version numbers for devfsd" \
838 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000839 IF_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000840 "\n -fg Run in foreground" \
841 "\n -np Exit after parsing the configuration file" \
842 "\n and processing synthetic REGISTER events," \
Denys Vlasenko07697852009-10-06 21:11:37 +0200843 "\n don't poll for events" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000844 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000845
Eric Andersen7e9276b2001-02-22 01:15:47 +0000846#define df_trivial_usage \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000847 "[-Pk" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000848 IF_FEATURE_HUMAN_READABLE("mh") \
849 IF_FEATURE_DF_FANCY("ai] [-B SIZE") \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100850 "] [FILESYSTEM]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000851#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000852 "Print filesystem usage statistics\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000853 "\nOptions:" \
854 "\n -P POSIX output format" \
855 "\n -k 1024-byte blocks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000856 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000857 "\n -m 1M-byte blocks" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000858 "\n -h Human readable (e.g. 1K 243M 2G)" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000859 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000860 IF_FEATURE_DF_FANCY( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000861 "\n -a Show all filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000862 "\n -i Inodes" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000863 "\n -B SIZE Blocksize" \
864 ) \
865
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000866#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000867 "$ df\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000868 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000869 "/dev/sda3 8690864 8553540 137324 98% /\n" \
870 "/dev/sda1 64216 36364 27852 57% /boot\n" \
871 "$ df /dev/sda3\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000872 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
873 "/dev/sda3 8690864 8553540 137324 98% /\n" \
874 "$ POSIXLY_CORRECT=sure df /dev/sda3\n" \
875 "Filesystem 512B-blocks Used Available Use% Mounted on\n" \
876 "/dev/sda3 17381728 17107080 274648 98% /\n" \
877 "$ POSIXLY_CORRECT=yep df -P /dev/sda3\n" \
878 "Filesystem 512-blocks Used Available Capacity Mounted on\n" \
879 "/dev/sda3 17381728 17107080 274648 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000880
Denis Vlasenko736230e2006-11-20 19:40:36 +0000881#define dhcprelay_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100882 "CLIENT_IFACE[,CLIENT_IFACE2]... SERVER_IFACE [SERVER_IP]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000883#define dhcprelay_full_usage "\n\n" \
Denis Vlasenkoe8a79682009-04-13 03:33:46 +0000884 "Relay DHCP requests between clients and server" \
Denis Vlasenko736230e2006-11-20 19:40:36 +0000885
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000886#define diff_trivial_usage \
Matheus Izvekovfe1ce2e2010-01-18 16:07:07 -0200887 "[-abBdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000888#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000889 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000890 "This implementation supports unified diffs only.\n" \
891 "\nOptions:" \
892 "\n -a Treat all files as text" \
893 "\n -b Ignore changes in the amount of whitespace" \
Matheus Izvekovfe1ce2e2010-01-18 16:07:07 -0200894 "\n -B Ignore changes whose lines are all blank" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000895 "\n -d Try hard to find a smaller set of changes" \
896 "\n -i Ignore case differences" \
897 "\n -L Use LABEL instead of the filename in the unified header" \
898 "\n -N Treat absent files as empty" \
899 "\n -q Output only whether files differ" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100900 "\n -r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000901 "\n -S Start with FILE when comparing directories" \
902 "\n -T Make tabs line up by prefixing a tab when necessary" \
903 "\n -s Report when two files are the same" \
904 "\n -t Expand tabs to spaces in output" \
905 "\n -U Output LINES lines of context" \
906 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000907
Eric Andersen7e9276b2001-02-22 01:15:47 +0000908#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000909 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000910#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000911 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000912#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000913 "$ dirname /tmp/foo\n" \
914 "/tmp\n" \
915 "$ dirname /tmp/foo/\n" \
916 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000917
Eric Andersen7e9276b2001-02-22 01:15:47 +0000918#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000919 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000920#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000921 "Print or control the kernel ring buffer\n" \
922 "\nOptions:" \
923 "\n -c Clear ring buffer after printing" \
924 "\n -n LEVEL Set console logging level" \
925 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000926
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000927#define dnsd_trivial_usage \
Denys Vlasenko343dfd72010-02-07 02:45:03 +0100928 "[-dvs] [-c CONFFILE] [-t TTL_SEC] [-p PORT] [-i ADDR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000929#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000930 "Small static DNS server daemon\n" \
931 "\nOptions:" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +0100932 "\n -c FILE Config file" \
933 "\n -t SEC TTL" \
934 "\n -p PORT Listen on PORT" \
935 "\n -i ADDR Listen on ADDR" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000936 "\n -d Daemonize" \
Denys Vlasenko343dfd72010-02-07 02:45:03 +0100937 "\n -v Verbose" \
938 "\n -s Send successful replies only. Use this if you want" \
939 "\n to use /etc/resolv.conf with two nameserver lines:" \
940 "\n nameserver DNSD_SERVER" \
941 "\n nameserver NORNAL_DNS_SERVER" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000942
Eric Andersen7e9276b2001-02-22 01:15:47 +0000943#define dos2unix_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +0200944 "[OPTIONS] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000945#define dos2unix_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200946 "Convert FILE in-place from DOS to Unix format.\n" \
947 "When no file is given, use stdin/stdout.\n" \
948 "\nOptions:" \
949 "\n -u dos2unix" \
950 "\n -d unix2dos" \
951
952#define unix2dos_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +0200953 "[OPTIONS] [FILE]"
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200954#define unix2dos_full_usage "\n\n" \
955 "Convert FILE in-place from Unix to DOS format.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000956 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000957 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000958 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000959 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000960
Eric Andersen7e9276b2001-02-22 01:15:47 +0000961#define dpkg_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100962 "[-ilCPru] [-F OPT] PACKAGE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000963#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000964 "Install, remove and manage Debian packages\n" \
965 "\nOptions:" \
Kim B. Heino3d43aed2010-03-29 14:18:27 +0200966 IF_LONG_OPTS( \
967 "\n -i,--install Install the package" \
968 "\n -l,--list List of installed packages" \
969 "\n --configure Configure an unpackaged package" \
970 "\n -P,--purge Purge all files of a package" \
971 "\n -r,--remove Remove all but the configuration files for a package" \
972 "\n --unpack Unpack a package, but don't configure it" \
973 "\n --force-depends Ignore dependency problems" \
974 "\n --force-confnew Overwrite existing config files when installing" \
975 "\n --force-confold Keep old config files when installing" \
976 ) \
977 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000978 "\n -i Install the package" \
979 "\n -l List of installed packages" \
980 "\n -C Configure an unpackaged package" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000981 "\n -P Purge all files of a package" \
982 "\n -r Remove all but the configuration files for a package" \
983 "\n -u Unpack a package, but don't configure it" \
Kim B. Heino3d43aed2010-03-29 14:18:27 +0200984 "\n -F depends Ignore dependency problems" \
985 "\n -F confnew Overwrite existing config files when installing" \
986 "\n -F confold Keep old config files when installing" \
987 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000988
Eric Andersen7e9276b2001-02-22 01:15:47 +0000989#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000990 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000991#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000992 "Perform actions on Debian packages (.debs)\n" \
993 "\nOptions:" \
994 "\n -c List contents of filesystem tree" \
995 "\n -e Extract control files to [argument] directory" \
996 "\n -f Display control field name starting with [argument]" \
997 "\n -x Extract packages filesystem tree to directory" \
998 "\n -X Verbose extract" \
999
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001000#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001001 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001002
Eric Andersen7e9276b2001-02-22 01:15:47 +00001003#define du_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001004 "[-aHLdclsx" IF_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001005#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001006 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001007 "Disk space is printed in units of " \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001008 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
1009 IF_NOT_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001010 " bytes.\n" \
1011 "\nOptions:" \
1012 "\n -a Show file sizes too" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001013 "\n -L Follow all symlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001014 "\n -H Follow symlinks on command line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001015 "\n -d N Limit output to directories (and files with -a) of depth < N" \
1016 "\n -c Show grand total" \
1017 "\n -l Count sizes many times if hard linked" \
1018 "\n -s Display only a total for each argument" \
1019 "\n -x Skip directories on different filesystems" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001020 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001021 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
1022 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001023 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001024 "\n -k Sizes in kilobytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001025 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001026
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001027#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001028 "$ du\n" \
1029 "16 ./CVS\n" \
1030 "12 ./kernel-patches/CVS\n" \
1031 "80 ./kernel-patches\n" \
1032 "12 ./tests/CVS\n" \
1033 "36 ./tests\n" \
1034 "12 ./scripts/CVS\n" \
1035 "16 ./scripts\n" \
1036 "12 ./docs/CVS\n" \
1037 "104 ./docs\n" \
1038 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001039
Eric Andersen7e9276b2001-02-22 01:15:47 +00001040#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001041 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001042#define dumpkmap_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001043 "Print a binary keyboard translation table to stdout"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001044#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001045 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001046
Russ Dill61fb4892002-10-14 21:41:28 +00001047#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001048 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001049#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001050 "Display DHCP leases granted by udhcpd\n" \
1051 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001052 IF_LONG_OPTS( \
Denys Vlasenkoc8a2ab12010-03-28 00:02:20 +01001053 "\n -f,--file=FILE Lease file" \
1054 "\n -r,--remaining Show remaining time" \
1055 "\n -a,--absolute Show expiration time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001056 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001057 IF_NOT_LONG_OPTS( \
Denys Vlasenkoc8a2ab12010-03-28 00:02:20 +01001058 "\n -f FILE Lease file" \
1059 "\n -r Show remaining time" \
1060 "\n -a Show expiration time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001061 )
Russ Dill61fb4892002-10-14 21:41:28 +00001062
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001063/*
Mike Frysinger51a43b42005-09-24 07:11:16 +00001064#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001065 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
1066 "[-I inode_buffer_blocks] [-P process_inode_size] " \
1067 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
1068 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001069#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001070 "Check ext2/ext3 file system\n" \
1071 "\nOptions:" \
1072 "\n -p Automatic repair (no questions)" \
1073 "\n -n Make no changes to the filesystem" \
1074 "\n -y Assume 'yes' to all questions" \
1075 "\n -c Check for bad blocks and add them to the badblock list" \
1076 "\n -f Force checking even if filesystem is marked clean" \
1077 "\n -v Verbose" \
1078 "\n -b superblock Use alternative superblock" \
1079 "\n -B blocksize Force blocksize when looking for superblock" \
1080 "\n -j journal Set location of the external journal" \
1081 "\n -l file Add to badblocks list" \
1082 "\n -L file Set badblocks list" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001083*/
Mike Frysinger51a43b42005-09-24 07:11:16 +00001084
Eric Andersen7e9276b2001-02-22 01:15:47 +00001085#define echo_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001086 IF_FEATURE_FANCY_ECHO("[-neE] ") "[ARG]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001087#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001088 "Print the specified ARGs to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001089 IF_FEATURE_FANCY_ECHO( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001090 "\nOptions:" \
1091 "\n -n Suppress trailing newline" \
Denys Vlasenkoc8a2ab12010-03-28 00:02:20 +01001092 "\n -e Interpret backslash escapes (i.e., \\t=tab)" \
1093 "\n -E Don't interpret backslash escapes (default)" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001094 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001095#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001096 "$ echo \"Erik is cool\"\n" \
1097 "Erik is cool\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001098 IF_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001099 "Erik\n" \
1100 "is\n" \
1101 "cool\n" \
1102 "$ echo \"Erik\\nis\\ncool\"\n" \
1103 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001104
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001105#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001106 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001107#define eject_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001108 "Eject DEVICE or default /dev/cdrom\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001109 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001110 IF_FEATURE_EJECT_SCSI( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001111 "\n -s SCSI device" \
1112 ) \
1113 "\n -t Close tray" \
1114 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001115
Rob Landley3b890392006-05-04 20:56:43 +00001116#define ed_trivial_usage ""
1117#define ed_full_usage ""
1118
Eric Andersen84e229c2001-03-29 22:48:33 +00001119#define env_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001120 "[-iu] [-] [name=value]... [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001121#define env_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001122 "Print the current environment or run PROG after setting up\n" \
1123 "the specified environment\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001124 "\nOptions:" \
1125 "\n -, -i Start with an empty environment" \
1126 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +00001127
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001128#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001129 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001130#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001131 "Send a magic packet to wake up sleeping machines.\n" \
1132 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001133 "a hostname with a known 'ethers' entry.\n" \
1134 "\nOptions:" \
1135 "\n -b Send wake-up packet to the broadcast address" \
1136 "\n -i iface Interface to use (default eth0)" \
1137 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001138
Denis Vlasenko3952f202007-08-13 14:10:24 +00001139#define expand_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01001140 "[-i] [-t N] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001141#define expand_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001142 "Convert tabs to spaces, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001143 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001144 IF_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001145 "\n -i,--initial Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001146 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001147 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001148 IF_NOT_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001149 "\n -i Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001150 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001151 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00001152
Eric Andersen7e9276b2001-02-22 01:15:47 +00001153#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001154 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001155#define expr_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001156 "Print the value of EXPRESSION to stdout\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001157 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001158 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001159 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
1160 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1161 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1162 " ARG1 <= ARG2\n" \
1163 " ARG1 = ARG2\n" \
1164 " ARG1 != ARG2\n" \
1165 " ARG1 >= ARG2\n" \
1166 " ARG1 > ARG2\n" \
1167 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1168 " ARG1 - ARG2\n" \
1169 " ARG1 * ARG2\n" \
1170 " ARG1 / ARG2\n" \
1171 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001172 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1173 " match STRING REGEXP Same as STRING : REGEXP\n" \
1174 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1175 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1176 " length STRING Length of STRING\n" \
1177 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001178 " it is a keyword like 'match' or an\n" \
1179 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001180 " (EXPRESSION) Value of EXPRESSION\n" \
1181 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001182 "Beware that many operators need to be escaped or quoted for shells.\n" \
1183 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001184 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001185 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1186 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001187
Mike Frysingerfa69f112005-04-17 07:24:19 +00001188#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001189 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001190#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001191 "Provide fake ident (auth) service\n" \
1192 "\nOptions:" \
1193 "\n -f Run in foreground" \
1194 "\n -i Inetd mode" \
1195 "\n -w Inetd 'wait' mode" \
1196 "\n -b ADDR Bind to specified address" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001197 "\n STRING Ident answer string (default: nobody)" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001198
Eric Andersen7e9276b2001-02-22 01:15:47 +00001199#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001200 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001201#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001202 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001203
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001204#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001205 "$ false\n" \
1206 "$ echo $?\n" \
1207 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001208
Denys Vlasenkoff027d62010-05-04 15:45:25 +02001209#define fbsplash_trivial_usage \
1210 "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
1211#define fbsplash_full_usage "\n\n" \
1212 "Options:" \
1213 "\n -s Image" \
1214 "\n -c Hide cursor" \
1215 "\n -d Framebuffer device (default /dev/fb0)" \
1216 "\n -i Config file (var=value):" \
1217 "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT" \
1218 "\n BAR_R,BAR_G,BAR_B" \
1219 "\n -f Control pipe (else exit after drawing image)" \
1220 "\n commands: 'NN' (% for progress bar) or 'exit'" \
1221
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001222#define fbset_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001223 "[OPTIONS] [MODE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001224#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001225 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001226
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001227#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001228 "$ fbset\n" \
1229 "mode \"1024x768-76\"\n" \
1230 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1231 " geometry 1024 768 1024 768 16\n" \
1232 " timings 12714 128 32 16 4 128 4\n" \
1233 " accel false\n" \
1234 " rgba 5/11,6/5,5/0,0/0\n" \
1235 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001236
Eric Andersen7e9276b2001-02-22 01:15:47 +00001237#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001238 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001239#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001240 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001241
Eric Andersen01c3d402003-07-05 07:51:31 +00001242#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001243 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001244#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001245 "Format floppy disk\n" \
1246 "\nOptions:" \
1247 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001248
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001249/* Looks like someone forgot to add this to config system */
1250#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1251# define ENABLE_FEATURE_FDISK_BLKSIZE 0
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001252# define IF_FEATURE_FDISK_BLKSIZE(a)
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001253#endif
1254
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001255#define fdisk_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001256 "[-ul" IF_FEATURE_FDISK_BLKSIZE("s") "] " \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001257 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001258#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001259 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001260 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001261 "\n -u Start and End are in sectors (instead of cylinders)" \
1262 "\n -l Show partition table for each DISK, then exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001263 IF_FEATURE_FDISK_BLKSIZE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001264 "\n -s Show partition sizes in kb for each DISK, then exit" \
1265 ) \
1266 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1267 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
Denys Vlasenko37bc1eb2010-04-06 00:04:08 +02001268 "\n -H HEADS" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001269 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001270
Grigory Batalovad7a5d42010-05-23 23:22:10 +02001271#define fgconsole_trivial_usage \
1272 ""
1273#define fgconsole_full_usage "\n\n" \
1274 "Get active console"
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001275
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001276#define findfs_trivial_usage \
1277 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001278#define findfs_full_usage "\n\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02001279 "Find a filesystem device based on a label or UUID"
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001280#define findfs_example_usage \
1281 "$ findfs LABEL=MyDevice"
1282
Eric Andersen7e9276b2001-02-22 01:15:47 +00001283#define find_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001284 "[PATH]... [EXPRESSION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001285#define find_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001286 "Search for files. The default PATH is the current directory,\n" \
1287 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001288 "\nEXPRESSION may consist of:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001289 "\n -follow Follow symlinks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001290 IF_FEATURE_FIND_XDEV( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001291 "\n -xdev Don't descend directories on other filesystems") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001292 IF_FEATURE_FIND_MAXDEPTH( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001293 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1294 "\n tests/actions to command line arguments only") \
Denys Vlasenko07697852009-10-06 21:11:37 +02001295 "\n -mindepth N Don't act on first N levels" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001296 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001297 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001298 IF_FEATURE_FIND_PATH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001299 "\n -path PATTERN Path matches PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001300 IF_FEATURE_FIND_REGEX( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001301 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001302 IF_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001303 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001304 IF_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001305 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001306 "\n or exactly NNN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001307 IF_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001308 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001309 "\n or exactly N days") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001310 IF_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001311 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001312 "\n or exactly N minutes") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001313 IF_FEATURE_FIND_NEWER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001314 "\n -newer FILE Modified time is more recent than FILE's") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001315 IF_FEATURE_FIND_INUM( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001316 "\n -inum N File has inode number N") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001317 IF_FEATURE_FIND_USER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001318 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001319 IF_FEATURE_FIND_GROUP( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001320 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001321 IF_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001322 "\n -depth Process directory name after traversing it") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001323 IF_FEATURE_FIND_SIZE( \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001324 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001325 "\n +/-N: file size is bigger/smaller than N") \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001326 IF_FEATURE_FIND_LINKS( \
1327 "\n -links N Number of links is greater than (+N), less than (-N)," \
1328 "\n or exactly N") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001329 "\n -print Print (default and assumed)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001330 IF_FEATURE_FIND_PRINT0( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001331 "\n -print0 Delimit output with null characters rather than" \
1332 "\n newlines") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001333 IF_FEATURE_FIND_CONTEXT ( \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001334 "\n -context File has specified security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001335 IF_FEATURE_FIND_EXEC( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001336 "\n -exec CMD ARG ; Run CMD with all instances of {} replaced by the" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001337 "\n matching files") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001338 IF_FEATURE_FIND_PRUNE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001339 "\n -prune Stop traversing current subtree") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001340 IF_FEATURE_FIND_DELETE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001341 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001342 IF_FEATURE_FIND_PAREN( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001343 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001344
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001345#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001346 "$ find / -name passwd\n" \
1347 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001348
Denys Vlasenkobf2af9a2009-05-25 04:15:37 +02001349#define flash_lock_trivial_usage \
1350 "MTD_DEVICE OFFSET SECTORS"
1351#define flash_lock_full_usage "\n\n" \
1352 "Lock part or all of an MTD device. If SECTORS is -1, then all sectors\n" \
1353 "will be locked, regardless of the value of OFFSET"
1354
1355#define flash_unlock_trivial_usage \
1356 "MTD_DEVICE"
1357#define flash_unlock_full_usage "\n\n" \
1358 "Unlock an MTD device"
1359
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001360#define flash_eraseall_trivial_usage \
1361 "[-jq] MTD_DEVICE"
1362#define flash_eraseall_full_usage "\n\n" \
1363 "Erase an MTD device\n" \
1364 "\nOptions:" \
Stefan Seyfriedd095fd42009-11-21 18:32:19 +01001365 "\n -j Format the device for jffs2" \
1366 "\n -q Don't display progress messages" \
1367
1368#define flashcp_trivial_usage \
1369 "-v FILE MTD_DEVICE"
1370#define flashcp_full_usage "\n\n" \
1371 "Copy an image to MTD device\n" \
1372 "\nOptions:" \
1373 "\n -v Verbose" \
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001374
Timo Teras892d4b62010-03-18 22:45:35 +01001375#define flock_trivial_usage \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001376 "[-sxun] FD|{FILE [-c] PROG ARGS}"
Timo Teras892d4b62010-03-18 22:45:35 +01001377#define flock_full_usage "\n\n" \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001378 "[Un]lock file descriptor, or lock FILE and run PROG\n" \
Timo Teras892d4b62010-03-18 22:45:35 +01001379 "\nOptions:" \
1380 "\n -s Shared lock" \
1381 "\n -x Exclusive lock (default)" \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001382 "\n -u Unlock FD" \
Timo Teras892d4b62010-03-18 22:45:35 +01001383 "\n -n Fail rather than wait" \
1384
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001385#define fold_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001386 "[-bs] [-w WIDTH] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001387#define fold_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001388 "Wrap input lines in each FILE (or stdin), writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001389 "\nOptions:" \
1390 "\n -b Count bytes rather than columns" \
1391 "\n -s Break at spaces" \
1392 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001393
Eric Andersen7e9276b2001-02-22 01:15:47 +00001394#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001395 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001396#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001397 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001398#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001399 "$ free\n" \
1400 " total used free shared buffers\n" \
1401 " Mem: 257628 248724 8904 59644 93124\n" \
1402 " Swap: 128516 8404 120112\n" \
1403 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001404
Eric Andersen7e9276b2001-02-22 01:15:47 +00001405#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001406 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001407#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001408 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001409#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001410 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001411
Mike Frysinger51a43b42005-09-24 07:11:16 +00001412#define fsck_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001413 "[-ANPRTV] [-C FD] [-t FSTYPE] [FS_OPTS] [BLOCKDEV]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001414#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001415 "Check and repair filesystems\n" \
1416 "\nOptions:" \
1417 "\n -A Walk /etc/fstab and check all filesystems" \
1418 "\n -N Don't execute, just show what would be done" \
1419 "\n -P With -A, check filesystems in parallel" \
1420 "\n -R With -A, skip the root filesystem" \
1421 "\n -T Don't show title on startup" \
1422 "\n -V Verbose" \
1423 "\n -C n Write status information to specified filedescriptor" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001424 "\n -t TYPE List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001425
Eric Andersen7e9276b2001-02-22 01:15:47 +00001426#define fsck_minix_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001427 "[-larvsmf] BLOCKDEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001428#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001429 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001430 "\nOptions:" \
1431 "\n -l List all filenames" \
1432 "\n -r Perform interactive repairs" \
1433 "\n -a Perform automatic repairs" \
1434 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001435 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001436 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001437 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001438
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001439#define ftpd_trivial_usage \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001440 "[-wvS] [-t N] [-T N] [DIR]"
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001441#define ftpd_full_usage "\n\n" \
Denys Vlasenkoae357bd2009-09-11 23:29:45 +02001442 "Anonymous FTP server\n" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001443 "\n" \
1444 "ftpd should be used as an inetd service.\n" \
1445 "ftpd's line for inetd.conf:\n" \
1446 " 21 stream tcp nowait root ftpd ftpd /files/to/serve\n" \
1447 "It also can be ran from tcpsvd:\n" \
1448 " tcpsvd -vE 0.0.0.0 21 ftpd /files/to/serve\n" \
1449 "\nOptions:" \
1450 "\n -w Allow upload" \
Denis Vlasenko4221e902009-03-11 15:07:44 +00001451 "\n -v Log to stderr" \
1452 "\n -S Log to syslog" \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001453 "\n -t,-T Idle and absolute timeouts" \
Denis Vlasenko92576712009-03-09 16:25:33 +00001454 "\n DIR Change root to this directory" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001455
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001456#define ftpget_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001457 "[OPTIONS] HOST [LOCAL_FILE] REMOTE_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001458#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001459 "Retrieve a remote file via FTP\n" \
1460 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001461 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001462 "\n -c,--continue Continue previous transfer" \
1463 "\n -v,--verbose Verbose" \
1464 "\n -u,--username Username" \
1465 "\n -p,--password Password" \
1466 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001467 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001468 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001469 "\n -c Continue previous transfer" \
1470 "\n -v Verbose" \
1471 "\n -u Username" \
1472 "\n -p Password" \
1473 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001474 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001475
1476#define ftpput_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001477 "[OPTIONS] HOST [REMOTE_FILE] LOCAL_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001478#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001479 "Store a local file on a remote machine via FTP\n" \
1480 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001481 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001482 "\n -v,--verbose Verbose" \
1483 "\n -u,--username Username" \
1484 "\n -p,--password Password" \
1485 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001486 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001487 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001488 "\n -v Verbose" \
1489 "\n -u Username" \
1490 "\n -p Password" \
1491 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001492 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001493
Rob Landleyaa872762005-10-28 13:05:12 +00001494#define fuser_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001495 "[OPTIONS] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001496#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001497 "Find processes which use FILEs or PORTs\n" \
1498 "\nOptions:" \
1499 "\n -m Find processes which use same fs as FILEs" \
1500 "\n -4 Search only IPv4 space" \
1501 "\n -6 Search only IPv6 space" \
Maksym Kryzhanovskyyfef9ee72010-05-22 20:41:08 +02001502 "\n -s Don't display PIDs" \
1503 "\n -k Kill found processes" \
1504 "\n -SIGNAL Signal to send (default: KILL)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001505
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001506#define getenforce_trivial_usage NOUSAGE_STR
1507#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001508
Eric Andersen7e9276b2001-02-22 01:15:47 +00001509#define getopt_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001510 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001511#define getopt_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001512 "Options:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001513 IF_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001514 "\n -a,--alternative Allow long options starting with single -" \
1515 "\n -l,--longoptions=longopts Long options to be recognized" \
1516 "\n -n,--name=progname The name under which errors are reported" \
1517 "\n -o,--options=optstring Short options to be recognized" \
1518 "\n -q,--quiet Disable error reporting by getopt(3)" \
1519 "\n -Q,--quiet-output No normal output" \
1520 "\n -s,--shell=shell Set shell quoting conventions" \
1521 "\n -T,--test Test for getopt(1) version" \
1522 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001523 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001524 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001525 "\n -a Allow long options starting with single -" \
1526 "\n -l longopts Long options to be recognized" \
1527 "\n -n progname The name under which errors are reported" \
1528 "\n -o optstring Short options to be recognized" \
1529 "\n -q Disable error reporting by getopt(3)" \
1530 "\n -Q No normal output" \
1531 "\n -s shell Set shell quoting conventions" \
1532 "\n -T Test for getopt(1) version" \
1533 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001534 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001535#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001536 "$ cat getopt.test\n" \
1537 "#!/bin/sh\n" \
1538 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1539 " -n 'example.busybox' -- \"$@\"`\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001540 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001541 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001542 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001543 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001544 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1545 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001546 " -c|--c-long)\n" \
1547 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001548 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1549 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1550 " esac;;\n" \
1551 " --) shift; break;;\n" \
1552 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001553 " esac\n" \
1554 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001555
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001556#define getsebool_trivial_usage \
1557 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001558#define getsebool_full_usage "\n\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01001559 " -a Show all selinux booleans"
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001560
Eric Andersenf349e972001-08-21 16:18:59 +00001561#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001562 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001563#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001564 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1565 "\nOptions:" \
1566 "\n -h Enable hardware (RTS/CTS) flow control" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001567 "\n -i Don't display /etc/issue before running login" \
1568 "\n -L Local line, don't do carrier detect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001569 "\n -m Get baud rate from modem's CONNECT status message" \
1570 "\n -w Wait for a CR or LF before sending /etc/issue" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001571 "\n -n Don't prompt the user for a login name" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02001572 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
1573 "\n -l LOGIN Invoke LOGIN instead of /bin/login" \
1574 "\n -t SEC Terminate after SEC if no username is read" \
1575 "\n -I INITSTR Send INITSTR before anything else" \
1576 "\n -H HOST Log HOST into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001577
Eric Andersen7e9276b2001-02-22 01:15:47 +00001578#define grep_trivial_usage \
Denys Vlasenko05273da2010-04-26 08:45:44 +02001579 "[-HhnlLoqvsriw" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001580 "F" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001581 IF_FEATURE_GREP_EGREP_ALIAS("E") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001582 IF_EXTRA_COMPAT("z") \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001583 "] [-m N] " \
1584 IF_FEATURE_GREP_CONTEXT("[-A/B/C N] ") \
1585 "PATTERN/-e PATTERN.../-f FILE [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001586#define grep_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001587 "Search for PATTERN in FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001588 "\nOptions:" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001589 "\n -H Add 'filename:' prefix" \
1590 "\n -h Do not add 'filename:' prefix" \
1591 "\n -n Add 'line_no:' prefix" \
1592 "\n -l Show only names of files that match" \
1593 "\n -L Show only names of files that don't match" \
1594 "\n -c Show only count of matching lines" \
1595 "\n -o Show only the matching part of line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001596 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1597 "\n -v Select non-matching lines" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001598 "\n -s Suppress open and read errors" \
1599 "\n -r Recurse" \
1600 "\n -i Ignore case" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001601 "\n -w Match whole words only" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001602 "\n -F PATTERN is a literal (not regexp)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001603 IF_FEATURE_GREP_EGREP_ALIAS( \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001604 "\n -E PATTERN is an extended regexp" \
1605 ) \
1606 IF_EXTRA_COMPAT( \
1607 "\n -z Input is NUL terminated" \
1608 ) \
1609 "\n -m N Match up to N times per file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001610 IF_FEATURE_GREP_CONTEXT( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001611 "\n -A N Print N lines of trailing context" \
1612 "\n -B N Print N lines of leading context" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001613 "\n -C N Same as '-A N -B N'" \
1614 ) \
1615 "\n -e PTRN Pattern to match" \
1616 "\n -f FILE Read pattern from file" \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001617
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001618#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001619 "$ grep root /etc/passwd\n" \
1620 "root:x:0:0:root:/root:/bin/bash\n" \
1621 "$ grep ^[rR]oo. /etc/passwd\n" \
1622 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001623
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001624#define egrep_trivial_usage NOUSAGE_STR
1625#define egrep_full_usage ""
1626
1627#define fgrep_trivial_usage NOUSAGE_STR
1628#define fgrep_full_usage ""
1629
Eric Andersen7e9276b2001-02-22 01:15:47 +00001630#define gunzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001631 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001632#define gunzip_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02001633 "Decompress FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001634 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001635 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001636 "\n -f Force" \
1637 "\n -t Test file integrity" \
1638
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001639#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001640 "$ ls -la /tmp/BusyBox*\n" \
1641 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1642 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1643 "$ ls -la /tmp/BusyBox*\n" \
1644 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001645
1646#define gzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001647 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001648#define gzip_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001649 "Compress FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001650 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001651 "\n -d Decompress" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02001652 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001653 "\n -f Force" \
1654
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001655#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001656 "$ ls -la /tmp/busybox*\n" \
1657 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1658 "$ gzip /tmp/busybox.tar\n" \
1659 "$ ls -la /tmp/busybox*\n" \
1660 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001661
1662#define halt_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001663 "[-d DELAY] [-n] [-f]" IF_FEATURE_WTMP(" [-w]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001664#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001665 "Halt the system\n" \
1666 "\nOptions:" \
1667 "\n -d Delay interval for halting" \
1668 "\n -n No call to sync()" \
1669 "\n -f Force halt (don't go through init)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001670 IF_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001671 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001672 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001673
Eric Andersen3443bd72003-07-22 07:30:36 +00001674#define hdparm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001675 "[OPTIONS] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001676#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001677 "Options:" \
1678 "\n -a Get/set fs readahead" \
1679 "\n -A Set drive read-lookahead flag (0/1)" \
1680 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1681 "\n -B Set Advanced Power Management setting (1-255)" \
1682 "\n -c Get/set IDE 32-bit IO setting" \
1683 "\n -C Check IDE power mode status" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001684 IF_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001685 "\n -d Get/set using_dma flag") \
1686 "\n -D Enable/disable drive defect-mgmt" \
1687 "\n -f Flush buffer cache for device on exit" \
1688 "\n -g Display drive geometry" \
1689 "\n -h Display terse usage information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001690 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001691 "\n -i Display drive identification") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001692 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001693 "\n -I Detailed/current information directly from drive") \
1694 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1695 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1696 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1697 "\n -m Get/set multiple sector count" \
1698 "\n -n Get/set ignore-write-errors flag (0/1)" \
1699 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1700 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001701/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001702 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1703 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001704 IF_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001705 "\n -R Register an IDE interface (DANGEROUS)") \
1706 "\n -S Set standby (spindown) timeout" \
1707 "\n -t Perform device read timings" \
1708 "\n -T Perform cache read timings" \
1709 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001710 IF_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001711 "\n -U Unregister an IDE interface (DANGEROUS)") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001712 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1713 "\n -V Display program version and exit immediately" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001714 IF_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001715 "\n -w Perform device reset (DANGEROUS)") \
1716 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001717 IF_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001718 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1719 "\n -X Set IDE xfer mode (DANGEROUS)" \
1720 "\n -y Put IDE drive in standby mode" \
1721 "\n -Y Put IDE drive to sleep" \
1722 "\n -Z Disable Seagate auto-powersaving mode" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001723 "\n -z Reread partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001724
Eric Andersen7e9276b2001-02-22 01:15:47 +00001725#define head_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001726 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001727#define head_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001728 "Print first 10 lines of each FILE (or stdin) to stdout.\n" \
Denys Vlasenko57493282010-03-02 16:18:14 +01001729 "With more than one FILE, precede each with a filename header.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001730 "\nOptions:" \
Denys Vlasenko57493282010-03-02 16:18:14 +01001731 "\n -n N[kbm] Print first N lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001732 IF_FEATURE_FANCY_HEAD( \
Denys Vlasenko57493282010-03-02 16:18:14 +01001733 "\n -c N[kbm] Print first N bytes" \
1734 "\n -q Never print headers" \
1735 "\n -v Always print headers" \
1736 ) \
1737 "\n" \
1738 "\nN may be suffixed by k (x1024), b (x512), or m (x1024^2)." \
Denis Vlasenko397de612008-03-17 08:55:44 +00001739
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001740#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001741 "$ head -n 2 /etc/passwd\n" \
1742 "root:x:0:0:root:/root:/bin/bash\n" \
1743 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001744
Denys Vlasenko57493282010-03-02 16:18:14 +01001745#define tail_trivial_usage \
1746 "[OPTIONS] [FILE]..."
1747#define tail_full_usage "\n\n" \
1748 "Print last 10 lines of each FILE (or stdin) to stdout.\n" \
1749 "With more than one FILE, precede each with a filename header.\n" \
1750 "\nOptions:" \
1751 "\n -f Print data as file grows" \
1752 IF_FEATURE_FANCY_TAIL( \
1753 "\n -s SECONDS Wait SECONDS between reads with -f" \
1754 ) \
1755 "\n -n N[kbm] Print last N lines" \
1756 IF_FEATURE_FANCY_TAIL( \
1757 "\n -c N[kbm] Print last N bytes" \
1758 "\n -q Never print headers" \
1759 "\n -v Always print headers" \
1760 "\n" \
1761 "\nN may be suffixed by k (x1024), b (x512), or m (x1024^2)." \
1762 "\nIf N starts with a '+', output begins with the Nth item from the start" \
1763 "\nof each file, not from the end." \
1764 ) \
1765
1766#define tail_example_usage \
1767 "$ tail -n 1 /etc/resolv.conf\n" \
1768 "nameserver 10.0.0.1\n"
1769
Glenn L McGrath60281112001-11-02 11:39:46 +00001770#define hexdump_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001771 "[-bcCdefnosvx" IF_FEATURE_HEXDUMP_REVERSE("R") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001772#define hexdump_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001773 "Display FILEs (or stdin) in a user specified format\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001774 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001775 "\n -b One-byte octal display" \
1776 "\n -c One-byte character display" \
1777 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1778 "\n -d Two-byte decimal display" \
1779 "\n -e FORMAT STRING" \
1780 "\n -f FORMAT FILE" \
1781 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1782 "\n -o Two-byte octal display" \
1783 "\n -s OFFSET Skip OFFSET bytes" \
1784 "\n -v Display all input data" \
1785 "\n -x Two-byte hexadecimal display" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001786 IF_FEATURE_HEXDUMP_REVERSE( \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001787 "\n -R Reverse of 'hexdump -Cv'") \
1788
1789#define hd_trivial_usage \
1790 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001791#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001792 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001793
Eric Andersen7e9276b2001-02-22 01:15:47 +00001794#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001795 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001796#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001797 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001798
1799#define hostname_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001800 "[OPTIONS] [HOSTNAME | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001801#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001802 "Get or set hostname or DNS domain name\n" \
1803 "\nOptions:" \
1804 "\n -s Short" \
1805 "\n -i Addresses for the hostname" \
1806 "\n -d DNS domain name" \
1807 "\n -f Fully qualified domain name" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001808 "\n -F FILE Use FILE's content as hostname" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001809
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001810#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001811 "$ hostname\n" \
1812 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001813
Denys Vlasenkod30b89c2009-06-26 01:55:45 +02001814#define dnsdomainname_trivial_usage NOUSAGE_STR
1815#define dnsdomainname_full_usage ""
1816
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001817#define httpd_trivial_usage \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001818 "[-ifv[v]]" \
1819 " [-c CONFFILE]" \
1820 " [-p [IP:]PORT]" \
1821 IF_FEATURE_HTTPD_SETUID(" [-u USER[:GRP]]") \
1822 IF_FEATURE_HTTPD_BASIC_AUTH(" [-r REALM]") \
1823 " [-h HOME]\n" \
1824 "or httpd -d/-e" IF_FEATURE_HTTPD_AUTH_MD5("/-m") " STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001825#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001826 "Listen for incoming HTTP requests\n" \
1827 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001828 "\n -i Inetd mode" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001829 "\n -f Don't daemonize" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001830 "\n -v[v] Verbose" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001831 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001832 IF_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001833 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001834 IF_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001835 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001836 "\n -h HOME Home directory (default .)" \
Denys Vlasenko8fc9e6a2010-04-02 10:40:58 +02001837 "\n -c FILE Configuration file (default {/etc,HOME}/httpd.conf)" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001838 IF_FEATURE_HTTPD_AUTH_MD5( \
1839 "\n -m STRING MD5 crypt STRING") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001840 "\n -e STRING HTML encode STRING" \
1841 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001842
Robert Griebl1cd04452002-07-21 16:50:49 +00001843#define hwclock_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001844 IF_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001845 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1846 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001847 " [-f FILE]" \
1848 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001849 IF_NOT_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001850 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1851 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001852#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001853 "Query and set hardware clock (RTC)\n" \
1854 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001855 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001856 "\n -s Set system time from hardware clock" \
1857 "\n -w Set hardware clock to system time" \
1858 "\n -u Hardware clock is in UTC" \
1859 "\n -l Hardware clock is in local time" \
1860 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001861
Eric Andersen7e9276b2001-02-22 01:15:47 +00001862#define id_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001863 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001864#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001865 "Print information about USER or the current user\n" \
1866 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001867 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001868 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001869 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001870 "\n -u Print user ID" \
Denis Vlasenko4f3209b2008-09-13 12:51:10 +00001871 "\n -g Print group ID" \
1872 "\n -G Print supplementary group IDs" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001873 "\n -n Print name instead of a number" \
1874 "\n -r Print real user ID instead of effective ID" \
1875
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001876#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001877 "$ id\n" \
1878 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001879
Eric Andersen7e9276b2001-02-22 01:15:47 +00001880#define ifconfig_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001881 IF_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001882#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001883 "Configure a network interface\n" \
1884 "\nOptions:" \
1885 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001886 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001887 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001888 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001889 " [del ADDRESS[/PREFIXLEN]]\n") \
1890 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1891 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001892 IF_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001893 " [outfill NN] [keepalive NN]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001894 " " IF_FEATURE_IFCONFIG_HW("[hw ether" IF_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001895 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001896 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001897 IF_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001898 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001899 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001900
Denis Vlasenko06aed432008-02-26 18:25:24 +00001901#define ifenslave_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001902 "[-cdf] MASTER_IFACE SLAVE_IFACE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001903#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001904 "Configure network interfaces for parallel routing\n" \
1905 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001906 "\n -c, --change-active Change active slave" \
1907 "\n -d, --detach Remove slave interface from bonding device" \
1908 "\n -f, --force Force, even if interface is not Ethernet" \
1909/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001910
Denis Vlasenko06aed432008-02-26 18:25:24 +00001911#define ifenslave_example_usage \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001912 "To create a bond device, simply follow these three steps:\n" \
1913 "- ensure that the required drivers are properly loaded:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001914 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001915 "- assign an IP address to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001916 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001917 "- attach all the interfaces you need to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001918 " # ifenslave bond0 eth0 eth1 eth2\n" \
1919 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1920 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001921 " To detach a dead interface without setting the bond device down:\n" \
1922 " # ifenslave -d bond0 eth1\n\n" \
1923 " To set the bond device down and automatically release all the slaves:\n" \
1924 " # ifconfig bond0 down\n\n" \
1925 " To change active slave:\n" \
1926 " # ifenslave -c bond0 eth0\n" \
1927
1928#define ifplugd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001929 "[OPTIONS]"
Denis Vlasenko71c16572009-04-26 01:08:51 +00001930#define ifplugd_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +02001931 "Network interface plug detection daemon\n" \
1932 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001933 "\n -n Don't daemonize" \
1934 "\n -s Don't log to syslog" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001935 "\n -i IFACE Interface" \
1936 "\n -f/-F Treat link detection error as link down/link up" \
1937 "\n (otherwise exit on error)" \
Denys Vlasenko999e4422010-01-08 13:03:48 +01001938 "\n -a Don't up interface at each link probe" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001939 "\n -M Monitor creation/destruction of interface" \
1940 "\n (otherwise it must exist)" \
1941 "\n -r PROG Script to run" \
1942 "\n -x ARG Extra argument for script" \
1943 "\n -I Don't exit on nonzero exit code from script" \
1944 "\n -p Don't run script on daemon startup" \
1945 "\n -q Don't run script on daemon quit" \
1946 "\n -l Run script on startup even if no cable is detected" \
1947 "\n -t SECS Poll time in seconds" \
1948 "\n -u SECS Delay before running script after link up" \
1949 "\n -d SECS Delay after link down" \
Denys Vlasenkob8f0e802010-01-07 14:56:50 +01001950 "\n -m MODE API mode (mii, priv, ethtool, wlan, iff, auto)" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001951 "\n -k Kill running daemon" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001952
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001953#define ifup_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001954 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] IFACE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001955#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001956 "Options:" \
1957 "\n -a De/configure all interfaces automatically" \
1958 "\n -i FILE Use FILE for interface definitions" \
1959 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001960 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001961 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001962 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001963 ) \
1964 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001965 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001966
1967#define ifdown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001968 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001969#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001970 "Options:" \
1971 "\n -a De/configure all interfaces automatically" \
1972 "\n -i FILE Use FILE for interface definitions" \
1973 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001974 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001975 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001976 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001977 ) \
1978 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001979 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001980
Glenn L McGrath06e95652003-02-09 06:51:14 +00001981#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001982 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001983#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001984 "Listen for network connections and launch programs\n" \
1985 "\nOptions:" \
1986 "\n -f Run in foreground" \
1987 "\n -e Log to stderr" \
1988 "\n -q N Socket listen queue (default: 128)" \
1989 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001990 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001991
Eric Andersen7e9276b2001-02-22 01:15:47 +00001992#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001993 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001994#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001995 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001996
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001997#define init_notes_usage \
1998"This version of init is designed to be run only by the kernel.\n" \
1999"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002000"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00002001"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002002"runlevels, use sysvinit.\n" \
2003"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002004"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002005"it has the following default behavior:\n" \
2006"\n" \
2007" ::sysinit:/etc/init.d/rcS\n" \
2008" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002009" ::ctrlaltdel:/sbin/reboot\n" \
2010" ::shutdown:/sbin/swapoff -a\n" \
2011" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00002012" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002013"\n" \
2014"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
2015"\n" \
2016" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002017" tty3::askfirst:/bin/sh\n" \
2018" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002019"\n" \
2020"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
2021"\n" \
2022" <id>:<runlevels>:<action>:<process>\n" \
2023"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002024" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002025"\n" \
2026" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
2027" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002028" the specified process to run on. The contents of this field are\n" \
2029" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
2030" be unique, although if it isn't you may have strange results. If this\n" \
2031" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002032" note that if BusyBox detects that a serial console is in use, then only\n" \
2033" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002034" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002035" stinkin' utmp.\n" \
2036"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002037" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002038"\n" \
2039" The runlevels field is completely ignored.\n" \
2040"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002041" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002042"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002043" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00002044" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002045"\n" \
2046" The available actions can be classified into two groups: actions\n" \
2047" that are run only once, and actions that are re-run when the specified\n" \
2048" process exits.\n" \
2049"\n" \
2050" Run only-once actions:\n" \
2051"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002052" 'sysinit' is the first item run on boot. init waits until all\n" \
2053" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002054" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002055" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002056" the specified task completes. 'once' actions are asynchronous,\n" \
2057" therefore, init does not wait for them to complete. 'restart' is\n" \
2058" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00002059" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002060" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002061" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002062" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002063" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002064" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002065" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002066" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002067"\n" \
2068" Run repeatedly actions:\n" \
2069"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002070" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002071" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002072" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
2073" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002074" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002075" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002076" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002077" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002078"\n" \
2079" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002080" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00002081" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002082"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002083" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002084"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00002085" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002086"\n" \
2087"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00002088"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002089" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002090" #\n" \
2091" ::sysinit:/etc/init.d/rcS\n" \
2092" \n" \
2093" # /bin/sh invocations on selected ttys\n" \
2094" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002095" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002096" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002097" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002098" tty2::askfirst:-/bin/sh\n" \
2099" tty3::askfirst:-/bin/sh\n" \
2100" tty4::askfirst:-/bin/sh\n" \
2101" \n" \
2102" # /sbin/getty invocations for selected ttys\n" \
2103" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00002104" tty4::respawn:/sbin/getty 38400 tty4\n" \
2105" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002106" \n" \
2107" \n" \
2108" # Example of how to put a getty on a serial line (for a terminal)\n" \
2109" #\n" \
2110" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
2111" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
2112" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002113" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002114" #::respawn:/sbin/getty 57600 ttyS2\n" \
2115" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00002116" # Stuff to do when restarting the init process\n" \
2117" ::restart:/sbin/init\n" \
2118" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002119" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002120" ::ctrlaltdel:/sbin/reboot\n" \
2121" ::shutdown:/bin/umount -a -r\n" \
2122" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002123
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002124#define inotifyd_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002125 "PROG FILE1[:MASK]..."
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002126#define inotifyd_full_usage "\n\n" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002127 "Run PROG on filesystem changes." \
2128 "\nWhen a filesystem event matching MASK occurs on FILEn," \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002129 "\nPROG ACTUAL_EVENTS FILEn [SUBFILE] is run." \
Denis Vlasenko289ff0e2008-11-14 21:52:16 +00002130 "\nEvents:" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002131 "\n a File is accessed" \
2132 "\n c File is modified" \
2133 "\n e Metadata changed" \
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02002134 "\n w Writable file is closed" \
2135 "\n 0 Unwritable file is closed" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002136 "\n r File is opened" \
Denis Vlasenkoa09a42c2008-11-17 22:19:18 +00002137 "\n D File is deleted" \
2138 "\n M File is moved" \
2139 "\n u Backing fs is unmounted" \
2140 "\n o Event queue overflowed" \
2141 "\n x File can't be watched anymore" \
2142 "\nIf watching a directory:" \
2143 "\n m Subfile is moved into dir" \
2144 "\n y Subfile is moved out of dir" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002145 "\n n Subfile is created" \
2146 "\n d Subfile is deleted" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002147 "\n" \
2148 "\ninotifyd waits for PROG to exit." \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002149 "\nWhen x event happens for all FILEs, inotifyd exits." \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002150
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002151/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00002152#define install_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002153 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [SOURCE]... DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002154#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002155 "Copy files and set attributes\n" \
2156 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002157 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002158 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002159 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002160 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002161 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002162 "\n -o USER Set ownership" \
2163 "\n -g GRP Set group ownership" \
2164 "\n -m MODE Set permissions" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002165 IF_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002166 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002167 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002168
Denis Vlasenko4acdb462009-01-31 21:45:57 +00002169#define ionice_trivial_usage \
2170 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
2171#define ionice_full_usage "\n\n" \
2172 "Change I/O scheduling class and priority\n" \
2173 "\nOptions:" \
2174 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
2175 "\n -n Priority" \
2176
Denis Vlasenko397de612008-03-17 08:55:44 +00002177/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002178#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00002179 "[OPTIONS] {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002180 IF_FEATURE_IP_ADDRESS("address | ") \
2181 IF_FEATURE_IP_ROUTE("route | ") \
2182 IF_FEATURE_IP_LINK("link | ") \
2183 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2184 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002185 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002186#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002187 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002188 "where OBJECT := {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002189 IF_FEATURE_IP_ADDRESS("address | ") \
2190 IF_FEATURE_IP_ROUTE("route | ") \
2191 IF_FEATURE_IP_LINK("link | ") \
2192 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2193 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002194 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002195 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002196
2197#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002198 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002199 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002200#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002201 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002202 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
2203 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002204 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002205 " [broadcast ADDR] [anycast ADDR]\n" \
2206 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002207 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002208
Eric Andersende4f07e2003-12-11 01:18:07 +00002209#define ipcalc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002210 "[OPTIONS] ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002211#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002212 "Calculate IP network settings from a IP address\n" \
2213 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002214 IF_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002215 "\n -b,--broadcast Display calculated broadcast address" \
2216 "\n -n,--network Display calculated network address" \
2217 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002218 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002219 "\n -p,--prefix Display the prefix for IP/NETMASK" \
2220 "\n -h,--hostname Display first resolved host name" \
2221 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002222 ) \
2223 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002224 IF_NOT_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002225 "\n -b Display calculated broadcast address" \
2226 "\n -n Display calculated network address" \
2227 "\n -m Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002228 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002229 "\n -p Display the prefix for IP/NETMASK" \
2230 "\n -h Display first resolved host name" \
2231 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002232 ) \
2233 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00002234
Rob Landley6eb1e412005-06-20 04:30:36 +00002235#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002236 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002237#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002238 "Upper-case options MQS remove an object by shmkey value.\n" \
2239 "Lower-case options remove an object by shmid value.\n" \
2240 "\nOptions:" \
2241 "\n -mM Remove memory segment after last detach" \
2242 "\n -qQ Remove message queue" \
2243 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002244
2245#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002246 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002247#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002248 " -i Show specific resource" \
2249 "\nResource specification:" \
2250 "\n -m Shared memory segments" \
2251 "\n -q Message queues" \
2252 "\n -s Semaphore arrays" \
2253 "\n -a All (default)" \
2254 "\nOutput format:" \
2255 "\n -t Time" \
2256 "\n -c Creator" \
2257 "\n -p Pid" \
2258 "\n -l Limits" \
2259 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002260
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002261#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002262 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002263#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00002264 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002265 " dynamic { on | off } |\n" \
2266 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002267 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002268
2269#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002270 "{ list | flush | { add | del | change | append |\n" \
2271 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002272#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002273 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002274 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
2275 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002276 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002277 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00002278 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
2279 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002280
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002281#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002282 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002283#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002284 "iprule [list | add | del] SELECTOR ACTION\n" \
2285 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2286 " [dev STRING] [pref NUMBER]\n" \
2287 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2288 " [prohibit | reject | unreachable]\n" \
2289 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002290 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002291
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002292#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002293 "{ add | change | del | show } [NAME]\n" \
2294 " [mode { ipip | gre | sit }]\n" \
2295 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002296#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002297 "iptunnel { add | change | del | show } [NAME]\n" \
2298 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2299 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002300 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002301
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002302#define kbd_mode_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002303 "[-a|k|s|u] [-C TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002304#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002305 "Report or set the keyboard mode\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002306 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002307 "\n -a Default (ASCII)" \
2308 "\n -k Medium-raw (keyboard)" \
2309 "\n -s Raw (scancode)" \
2310 "\n -u Unicode (utf-8)" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002311 "\n -C TTY Affect TTY instead of /dev/tty" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002312
Eric Andersen7e9276b2001-02-22 01:15:47 +00002313#define kill_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002314 "[-l] [-SIG] PID..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002315#define kill_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002316 "Send a signal (default: TERM) to given PIDs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002317 "\nOptions:" \
2318 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002319/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002320
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002321#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002322 "$ ps | grep apache\n" \
2323 "252 root root S [apache]\n" \
2324 "263 www-data www-data S [apache]\n" \
2325 "264 www-data www-data S [apache]\n" \
2326 "265 www-data www-data S [apache]\n" \
2327 "266 www-data www-data S [apache]\n" \
2328 "267 www-data www-data S [apache]\n" \
2329 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002330
2331#define killall_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002332 "[-l] [-q] [-SIG] PROCESS_NAME..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002333#define killall_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002334 "Send a signal (default: TERM) to given processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002335 "\nOptions:" \
2336 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002337/* "\n -s SIG Yet another way of specifying SIG" */ \
Denys Vlasenko07697852009-10-06 21:11:37 +02002338 "\n -q Don't complain if no processes were killed" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002339
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002340#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002341 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002342
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002343#define killall5_trivial_usage \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002344 "[-l] [-SIG] [-o PID]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002345#define killall5_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002346 "Send a signal (default: TERM) to all processes outside current session\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002347 "\nOptions:" \
2348 "\n -l List all signal names and numbers" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002349 "\n -o PID Don't signal this PID" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002350/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002351
Mark Whitley6317c4b2001-03-12 22:51:50 +00002352#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002353 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002354#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002355 "Kernel logger\n" \
2356 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002357 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002358 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002359
Eric Andersen7e9276b2001-02-22 01:15:47 +00002360#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002361 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002362#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002363 "Print STRING's length"
2364
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002365#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002366 "$ length Hello\n" \
2367 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002368
Rob Landley9200e792005-09-15 19:26:59 +00002369#define less_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002370 "[-EMNmh~I?] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002371#define less_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002372 "View FILE (or stdin) one screenful at a time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002373 "\nOptions:" \
2374 "\n -E Quit once the end of a file is reached" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002375 "\n -M,-m Display status line with line numbers" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002376 "\n and percentage through the file" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002377 "\n -N Prefix line number to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002378 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002379 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002380
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002381#define linux32_trivial_usage NOUSAGE_STR
2382#define linux32_full_usage ""
2383#define linux64_trivial_usage NOUSAGE_STR
2384#define linux64_full_usage ""
2385
2386#define linuxrc_trivial_usage NOUSAGE_STR
2387#define linuxrc_full_usage ""
2388
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002389#define setarch_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002390 "personality PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002391#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002392 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002393 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002394 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002395
Eric Andersen7e9276b2001-02-22 01:15:47 +00002396#define ln_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002397 "[OPTIONS] TARGET... LINK|DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002398#define ln_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002399 "Create a link LINK or DIR/TARGET to the specified TARGET(s)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002400 "\nOptions:" \
2401 "\n -s Make symlinks instead of hardlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002402 "\n -f Remove existing destinations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002403 "\n -n Don't dereference symlinks - treat like normal file" \
2404 "\n -b Make a backup of the target (if exists) before link operation" \
2405 "\n -S suf Use suffix instead of ~ when making backup files" \
2406
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002407#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002408 "$ ln -s BusyBox /tmp/ls\n" \
2409 "$ ls -l /tmp/ls\n" \
2410 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002411
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002412#define load_policy_trivial_usage NOUSAGE_STR
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002413#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002414
Eric Andersen7e9276b2001-02-22 01:15:47 +00002415#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002416 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002417#define loadfont_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002418 "Load a console font from stdin" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002419/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2420
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002421#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002422 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002423
2424#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002425 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002426#define loadkmap_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002427 "Load a binary keyboard translation table from stdin\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002428/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2429
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002430#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002431 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002432
2433#define logger_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002434 "[OPTIONS] [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002435#define logger_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002436 "Write MESSAGE (or stdin) to syslog\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002437 "\nOptions:" \
2438 "\n -s Log to stderr as well as the system log" \
2439 "\n -t TAG Log using the specified tag (defaults to user name)" \
2440 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002441
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002442#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002443 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002444
Robert Griebl1fca5582002-06-04 20:45:46 +00002445#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002446 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002447#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002448 "Begin a new session on the system\n" \
2449 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002450 "\n -f Don't authenticate (user already authenticated)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002451 "\n -h Name of the remote host" \
2452 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002453
Eric Andersen7e9276b2001-02-22 01:15:47 +00002454#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002455 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002456#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002457 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002458#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002459 "$ logname\n" \
2460 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002461
Mark Whitley6317c4b2001-03-12 22:51:50 +00002462#define logread_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002463 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002464#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002465 "Show messages in syslogd's circular buffer\n" \
2466 "\nOptions:" \
2467 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002468
Matt Kraai83788da2002-03-20 17:38:37 +00002469#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002470 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2471 " losetup -d LOOPDEV - disassociate\n" \
2472 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002473#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002474 "Options:" \
2475 "\n -o OFS Start OFS bytes into FILE" \
2476 "\n -f Show first free loop device" \
2477
Rob Landley1d589b22005-11-29 23:47:10 +00002478#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002479 "No arguments will display all current associations.\n" \
2480 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002481 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002482 "and filename of the file the loop device is currently bound to.\n\n" \
2483 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002484 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2485 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002486
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002487#define lpd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002488 "SPOOLDIR [HELPER [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002489#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002490 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2491 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002492 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002493 "\ndirectory and HELPER program is called. Name of file to print" \
2494 "\nis passed in $DATAFILE variable." \
2495 "\nExample:" \
2496 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002497
Denis Vlasenko68444b92008-02-22 22:24:48 +00002498#define lpq_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002499 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID]... [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002500#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002501 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002502 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002503 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002504 "\n -f Force any waiting job to be printed" \
2505 "\n -s Short display" \
2506
2507#define lpr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002508 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE]..."
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002509/* -C CLASS exists too, not shown.
2510 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002511#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002512 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002513 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002514 "\n -m Send mail on completion" \
2515 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002516 "\n -V Verbose" \
2517
Eric Andersen7e9276b2001-02-22 01:15:47 +00002518#define ls_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002519 "[-1Aa" IF_FEATURE_LS_TIMESTAMPS("c") "Cd" \
2520 IF_FEATURE_LS_TIMESTAMPS("e") IF_FEATURE_LS_FILETYPES("F") "iln" \
2521 IF_FEATURE_LS_FILETYPES("p") IF_FEATURE_LS_FOLLOWLINKS("L") \
2522 IF_FEATURE_LS_RECURSIVE("R") IF_FEATURE_LS_SORTFILES("rS") "s" \
2523 IF_FEATURE_AUTOWIDTH("T") IF_FEATURE_LS_TIMESTAMPS("tu") \
2524 IF_FEATURE_LS_SORTFILES("v") IF_FEATURE_AUTOWIDTH("w") "x" \
2525 IF_FEATURE_LS_SORTFILES("X") IF_FEATURE_HUMAN_READABLE("h") "k" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002526 IF_SELINUX("K") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002527#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002528 "List directory contents\n" \
2529 "\nOptions:" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002530 "\n -1 List in a single column" \
2531 "\n -A Don't list . and .." \
2532 "\n -a Don't hide entries starting with ." \
2533 "\n -C List by columns" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002534 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002535 "\n -c With -l: sort by ctime") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002536 IF_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002537 "\n --color[={always,never,auto}] Control coloring") \
2538 "\n -d List directory entries instead of contents" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002539 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002540 "\n -e List full date and time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002541 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002542 "\n -F Append indicator (one of */=@|) to entries") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002543 "\n -i List inode numbers" \
2544 "\n -l Long listing format" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002545 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002546 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002547 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002548 IF_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002549 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002550 IF_FEATURE_LS_RECURSIVE( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002551 "\n -R Recurse") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002552 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002553 "\n -r Sort in reverse order") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002554 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002555 "\n -S Sort by file size") \
Denis Vlasenko397de612008-03-17 08:55:44 +00002556 "\n -s List the size of each file, in blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002557 IF_FEATURE_AUTOWIDTH( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002558 "\n -T N Assume tabstop every N columns") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002559 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002560 "\n -t With -l: sort by modification time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002561 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002562 "\n -u With -l: sort by access time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002563 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002564 "\n -v Sort by version") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002565 IF_FEATURE_AUTOWIDTH( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002566 "\n -w N Assume the terminal is N columns wide") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002567 "\n -x List by lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002568 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002569 "\n -X Sort by extension") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002570 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002571 "\n -h List sizes in human readable format (1K 243M 2G)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002572 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002573 "\n -k List security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002574 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002575 "\n -K List security context in long format") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002576 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002577 "\n -Z List security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002578
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002579#define lsattr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002580 "[-Radlv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002581#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002582 "List file attributes on an ext2 fs\n" \
2583 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002584 "\n -R Recurse" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002585 "\n -a Don't hide entries starting with ." \
Denis Vlasenko397de612008-03-17 08:55:44 +00002586 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002587 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002588 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002589
Eric Andersen7e9276b2001-02-22 01:15:47 +00002590#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002591 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002592#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002593 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002594
Souf Oued982bc712009-12-05 17:56:25 +01002595#define lspci_trivial_usage \
2596 "[-mk]"
2597#define lspci_full_usage "\n\n" \
2598 "List all PCI devices" \
2599 "\n" \
2600 "\n -m Parseable output" \
2601 "\n -k Show driver" \
2602
Souf Oued11a802a2009-12-07 01:37:34 +01002603#define lsusb_trivial_usage NOUSAGE_STR
2604#define lsusb_full_usage ""
2605
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002606#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002607#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002608 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002609#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002610 "Create a range of block or character special files" \
2611 "\n" \
2612 "\nTYPE is:" \
2613 "\n b Block device" \
2614 "\n c Character device" \
2615 "\n f FIFO, MAJOR and MINOR are ignored" \
2616 "\n" \
2617 "\nFIRST..LAST specify numbers appended to NAME." \
2618 "\nIf 's' is the last argument, the base device is created as well." \
2619 "\n" \
2620 "\nExamples:" \
2621 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2622 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002623#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002624 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2625 "[creates ttyS2-ttyS63]\n" \
2626 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2627 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002628#endif
2629
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002630#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002631#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002632 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002633#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002634 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002635 "Device table entries take the form of:\n" \
2636 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002637 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002638 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002639 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002640 " c Character device\n" \
2641 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002642 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002643 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002644 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2645 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002646#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002647 "For example:\n" \
2648 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2649 "/dev d 755 0 0 - - - - -\n" \
2650 "/dev/console c 666 0 0 5 1 - - -\n" \
2651 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2652 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2653 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2654 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2655 "Will Produce:\n" \
2656 "/dev\n" \
2657 "/dev/console\n" \
2658 "/dev/null\n" \
2659 "/dev/zero\n" \
2660 "/dev/hda\n" \
2661 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002662#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002663
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002664#define makemime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002665 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002666#define makemime_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002667 "Create multipart MIME-encoded message from FILEs\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002668/* "Transfer encoding is base64, disposition is inline (not attachment)\n" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002669 "\nOptions:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002670 "\n -o FILE Output. Default: stdout" \
2671 "\n -a HDR Add header. Examples:" \
2672 "\n \"From: user@host.org\", \"Date: `date -R`\"" \
2673 "\n -c CT Content type. Default: text/plain" \
2674 "\n -C CS Charset. Default: " CONFIG_FEATURE_MIME_CHARSET \
2675/* "\n -e ENC Transfer encoding. Ignored. base64 is assumed" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002676 "\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002677 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002678
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002679#define man_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002680 "[OPTIONS] [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002681#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002682 "Format and display manual page\n" \
2683 "\nOptions:" \
2684 "\n -a Display all pages" \
2685 "\n -w Show page locations" \
2686
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002687#define matchpathcon_trivial_usage \
2688 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002689#define matchpathcon_full_usage "\n\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002690 " -n Don't display path" \
2691 "\n -N Don't use translations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002692 "\n -f Use alternate file_context file" \
2693 "\n -p Use prefix to speed translations" \
2694 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002695
Eric Andersen7e9276b2001-02-22 01:15:47 +00002696#define md5sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002697 "[OPTIONS] [FILE]..." \
2698 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTIONS] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002699#define md5sum_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002700 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2701 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002702 "\nOptions:" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002703 "\n -c Check sums against given list" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002704 "\n -s Don't output anything, status code shows success" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002705 "\n -w Warn about improperly formatted checksum lines" \
2706 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002707
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002708#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002709 "$ md5sum < busybox\n" \
2710 "6fd11e98b98a58f64ff3398d7b324003\n" \
2711 "$ md5sum busybox\n" \
2712 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2713 "$ md5sum -c -\n" \
2714 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2715 "busybox: OK\n" \
2716 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002717
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002718#define sha1sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002719 "[OPTIONS] [FILE]..." \
2720 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002721#define sha1sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002722 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002723 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002724 "\nOptions:" \
2725 "\n -c Check sums against given list" \
2726 "\n -s Don't output anything, status code shows success" \
2727 "\n -w Warn about improperly formatted checksum lines" \
2728 )
2729
2730#define sha256sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002731 "[OPTIONS] [FILE]..." \
2732 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha256sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002733#define sha256sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002734 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA256 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002735 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002736 "\nOptions:" \
2737 "\n -c Check sums against given list" \
2738 "\n -s Don't output anything, status code shows success" \
2739 "\n -w Warn about improperly formatted checksum lines" \
2740 )
2741
2742#define sha512sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002743 "[OPTIONS] [FILE]..." \
2744 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha512sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002745#define sha512sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002746 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA512 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002747 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002748 "\nOptions:" \
2749 "\n -c Check sums against given list" \
2750 "\n -s Don't output anything, status code shows success" \
2751 "\n -w Warn about improperly formatted checksum lines" \
2752 )
2753
Rob Landley70f7ef72005-12-13 08:21:33 +00002754#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002755 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002756#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002757 " -s Scan /sys and populate /dev during system boot\n" \
2758 "\n" \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002759 "It can be run by kernel as a hotplug helper. To activate it:\n" \
Denys Vlasenkof92874e2009-12-05 15:59:05 +01002760 " echo /sbin/mdev > /proc/sys/kernel/hotplug\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002761 IF_FEATURE_MDEV_CONF( \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002762 "It uses /etc/mdev.conf with lines\n" \
Denis Vlasenkof2b39e02009-04-13 23:18:52 +00002763 "[-]DEVNAME UID:GID PERM" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002764 IF_FEATURE_MDEV_RENAME(" [>|=PATH]") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002765 IF_FEATURE_MDEV_EXEC(" [@|$|*PROG]") \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002766 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002767
Rob Landleyef10d522006-06-26 14:11:33 +00002768#define mdev_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002769 IF_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002770 "The mdev config file contains lines that look like:\n" \
2771 " hd[a-z][0-9]* 0:3 660\n\n" \
2772 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002773 IF_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002774 "Optionally, that can be followed (on the same line) by a special character\n" \
2775 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002776 "device(s). The environment variable $MDEV indicates the active device node\n" \
2777 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002778 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2779 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002780 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002781 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002782 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002783 "Config file parsing stops on the first matching line. If no config\n" \
2784 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002785 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002786 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002787
Glenn L McGrath061c9002002-09-16 04:21:46 +00002788#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002789 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002790#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002791 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002792 " y Allow write access to your terminal\n" \
2793 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002794
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002795#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002796 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002797#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002798 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2799 "\nOptions:" \
2800 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2801 "\n next byte to it" \
2802 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2803 "\n -s Set serial line to SPEED" \
2804 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002805
Eric Andersen7e9276b2001-02-22 01:15:47 +00002806#define mkdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002807 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002808#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002809 "Create DIRECTORY\n" \
2810 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002811 "\n -m Mode" \
2812 "\n -p No error if exists; make parent directories as needed" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002813 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002814 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002815 )
2816
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002817#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002818 "$ mkdir /tmp/foo\n" \
2819 "$ mkdir /tmp/foo\n" \
2820 "/tmp/foo: File exists\n" \
2821 "$ mkdir /tmp/foo/bar/baz\n" \
2822 "/tmp/foo/bar/baz: No such file or directory\n" \
2823 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002824
Eric Andersen7e9276b2001-02-22 01:15:47 +00002825#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002826 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002827#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002828 "Create named pipe (identical to 'mknod name p')\n" \
2829 "\nOptions:" \
2830 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002831 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002832 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002833 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002834
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002835#define mkfs_ext2_trivial_usage \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002836 "[-Fn] " \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002837 /* "[-c|-l filename] " */ \
2838 "[-b BLK_SIZE] " \
2839 /* "[-f fragment-size] [-g blocks-per-group] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002840 "[-i INODE_RATIO] [-I INODE_SIZE] " \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002841 /* "[-j] [-J journal-options] [-N number-of-inodes] " */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002842 "[-m RESERVED_PERCENT] " \
2843 /* "[-o creator-os] [-O feature[,...]] [-q] " */ \
2844 /* "[r fs-revision-level] [-E extended-options] [-v] [-F] " */ \
2845 "[-L LABEL] " \
2846 /* "[-M last-mounted-directory] [-S] [-T filesystem-type] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002847 "BLOCKDEV [KBYTES]"
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002848#define mkfs_ext2_full_usage "\n\n" \
2849 " -b BLK_SIZE Block size, bytes" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002850/* "\n -c Check device for bad blocks" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002851/* "\n -E opts Set extended options" */ \
2852/* "\n -f size Fragment size in bytes" */ \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002853 "\n -F Force" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002854/* "\n -g N Number of blocks in a block group" */ \
Denys Vlasenko838e07a2009-10-22 12:15:33 +02002855 "\n -i RATIO Max number of files is filesystem_size / RATIO" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002856 "\n -I BYTES Inode size (min 128)" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002857/* "\n -j Create a journal (ext3)" */ \
2858/* "\n -J opts Set journal options (size/device)" */ \
2859/* "\n -l file Read bad blocks list from file" */ \
Denys Vlasenko6a8cfdc2009-10-17 23:41:15 +02002860 "\n -L LBL Volume label" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002861 "\n -m PERCENT Percent of blocks to reserve for admin" \
2862/* "\n -M dir Set last mounted directory" */ \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002863 "\n -n Dry run" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002864/* "\n -N N Number of inodes to create" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002865/* "\n -o os Set the 'creator os' field" */ \
2866/* "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" */ \
2867/* "\n -q Quiet" */ \
2868/* "\n -r rev Set filesystem revision" */ \
2869/* "\n -S Write superblock and group descriptors only" */ \
2870/* "\n -T fs-type Set usage type (news/largefile/largefile4)" */ \
2871/* "\n -v Verbose" */ \
2872
Eric Andersen7e9276b2001-02-22 01:15:47 +00002873#define mkfs_minix_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002874 "[-c | -l FILE] [-nXX] [-iXX] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002875#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002876 "Make a MINIX filesystem\n" \
2877 "\nOptions:" \
2878 "\n -c Check device for bad blocks" \
2879 "\n -n [14|30] Maximum length of filenames" \
2880 "\n -i INODES Number of inodes for the filesystem" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002881 "\n -l FILE Read bad blocks list from FILE" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002882 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002883
Vladimir Dronnikov0d8ea642009-11-02 10:41:46 +01002884#define mkfs_reiser_trivial_usage \
2885 "[-f] [-l LABEL] BLOCKDEV [4K-BLOCKS]"
2886
2887#define mkfs_reiser_full_usage "\n\n" \
2888 "Make a ReiserFS V3 filesystem\n" \
2889 "\nOptions:" \
2890 "\n -f Force" \
2891 "\n -l LBL Volume label" \
2892
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002893#define mkfs_vfat_trivial_usage \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002894 "[-v] [-n LABEL] BLOCKDEV [KBYTES]"
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002895/* Accepted but ignored:
2896 "[-c] [-C] [-I] [-l bad-block-file] [-b backup-boot-sector] "
2897 "[-m boot-msg-file] [-i volume-id] "
2898 "[-s sectors-per-cluster] [-S logical-sector-size] [-f number-of-FATs] "
2899 "[-h hidden-sectors] [-F fat-size] [-r root-dir-entries] [-R reserved-sectors] "
2900*/
2901#define mkfs_vfat_full_usage "\n\n" \
2902 "Make a FAT32 filesystem\n" \
2903 "\nOptions:" \
2904/* "\n -c Check device for bad blocks" */ \
2905 "\n -v Verbose" \
2906/* "\n -I Allow to use entire disk device (e.g. /dev/hda)" */ \
2907 "\n -n LBL Volume label" \
2908
Eric Andersen7e9276b2001-02-22 01:15:47 +00002909#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002910 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002911#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002912 "Create a special file (block, character, or pipe)\n" \
2913 "\nOptions:" \
2914 "\n -m Create the special file using the specified mode (default a=rw)" \
2915 "\nTYPEs include:" \
2916 "\n b: Make a block device" \
2917 "\n c or u: Make a character device" \
2918 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002919 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002920 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002921 )
2922
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002923#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002924 "$ mknod /dev/fd0 b 2 0\n" \
2925 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002926
Eric Andersen7e9276b2001-02-22 01:15:47 +00002927#define mkswap_trivial_usage \
Denys Vlasenko40e7d252010-02-01 23:48:27 +01002928 "[OPTIONS] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002929#define mkswap_full_usage "\n\n" \
Denys Vlasenko68c67462009-11-03 05:51:20 +01002930 "Prepare BLOCKDEV to be used as swap partition\n" \
2931 "\nOptions:" \
2932 "\n -L LBL Label" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002933
Eric Andersen7e9276b2001-02-22 01:15:47 +00002934#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002935 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002936#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002937 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002938 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002939 "\nOptions:" \
2940 "\n -d Make a directory instead of a file" \
2941/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2942 "\n -t Generate a path rooted in temporary directory" \
2943 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2944 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002945 "\nFor -t or -p, directory is chosen as follows:" \
2946 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002947
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002948#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002949 "$ mktemp /tmp/temp.XXXXXX\n" \
2950 "/tmp/temp.mWiLjM\n" \
2951 "$ ls -la /tmp/temp.mWiLjM\n" \
2952 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002953
Eric Andersen7e9276b2001-02-22 01:15:47 +00002954#define more_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002955 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002956#define more_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002957 "View FILE (or stdin) one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002958
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002959#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002960 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002961
Eric Andersen7e9276b2001-02-22 01:15:47 +00002962#define mount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002963 "[OPTIONS] [-o OPTS] DEVICE NODE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002964#define mount_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002965 "Mount a filesystem. Filesystem autodetection requires /proc.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002966 "\nOptions:" \
2967 "\n -a Mount all filesystems in fstab" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002968 IF_FEATURE_MOUNT_FAKE( \
2969 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002970 "\n -f Update /etc/mtab, but don't mount" \
2971 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002972 IF_NOT_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002973 "\n -f Dry run" \
2974 ) \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002975 ) \
Denys Vlasenkoe2e4cc22009-06-19 11:48:29 +02002976 IF_FEATURE_MOUNT_HELPERS( \
2977 "\n -i Don't run mount helper" \
2978 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002979 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002980 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002981 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002982 "\n -r Read-only mount" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002983 "\n -w Read-write mount (default)" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002984 "\n -t FSTYPE Filesystem type" \
2985 "\n -O OPT Mount only filesystems with option OPT (-a only)" \
2986 "\n-o OPT:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002987 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002988 "\n loop Ignored (loop devices are autodetected)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002989 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002990 IF_FEATURE_MOUNT_FLAGS( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002991 "\n [a]sync Writes are [a]synchronous" \
2992 "\n [no]atime Disable/enable updates to inode access times" \
2993 "\n [no]diratime Disable/enable atime updates to directories" \
2994 "\n [no]relatime Disable/enable atime updates relative to modification time" \
2995 "\n [no]dev (Dis)allow use of special device files" \
2996 "\n [no]exec (Dis)allow use of executable files" \
2997 "\n [no]suid (Dis)allow set-user-id-root programs" \
2998 "\n [r]shared Convert [recursively] to a shared subtree" \
2999 "\n [r]slave Convert [recursively] to a slave subtree" \
3000 "\n [r]private Convert [recursively] to a private subtree" \
3001 "\n [un]bindable Make mount point [un]able to be bind mounted" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003002 "\n bind Bind a file or directory to another location" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003003 "\n move Relocate an existing mount point" \
Rob Landleye55a73c2006-08-09 20:55:35 +00003004 ) \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003005 "\n remount Remount a mounted filesystem, changing flags" \
3006 "\n ro/rw Same as -r/-w" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003007 "\n" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003008 "\nThere are filesystem-specific -o flags." \
Denis Vlasenko397de612008-03-17 08:55:44 +00003009
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003010#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003011 "$ mount\n" \
3012 "/dev/hda3 on / type minix (rw)\n" \
3013 "proc on /proc type proc (rw)\n" \
3014 "devpts on /dev/pts type devpts (rw)\n" \
3015 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
3016 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
3017 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00003018#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003019 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003020
Rob Landleyd00b3a52005-08-20 05:07:08 +00003021#define mountpoint_trivial_usage \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003022 "[-q] <[-dn] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003023#define mountpoint_full_usage "\n\n" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003024 "Check if the directory is a mountpoint\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003025 "\nOptions:" \
3026 "\n -q Quiet" \
3027 "\n -d Print major/minor device number of the filesystem" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003028 "\n -n Print device name of the filesystem" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003029 "\n -x Print major/minor device number of the blockdevice" \
3030
Rob Landleyd00b3a52005-08-20 05:07:08 +00003031#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003032 "$ mountpoint /proc\n" \
3033 "/proc is not a mountpoint\n" \
3034 "$ mountpoint /sys\n" \
3035 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00003036
Eric Andersen7e9276b2001-02-22 01:15:47 +00003037#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003038 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003039#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003040 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003041 "\n" \
3042 "Available Opcodes:\n" \
3043 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003044 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
3045 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
3046 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003047 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003048
Eric Andersen7e9276b2001-02-22 01:15:47 +00003049#define mv_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003050 "[OPTIONS] SOURCE DEST\n" \
3051 "or: mv [OPTIONS] SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003052#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003053 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
3054 "\nOptions:" \
3055 "\n -f Don't prompt before overwriting" \
3056 "\n -i Interactive, prompt before overwrite" \
3057
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003058#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003059 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003060
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003061#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003062 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003063#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003064 "Rename network interface while it in the down state\n" \
3065 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003066 "\n -c FILE Use configuration file (default: /etc/mactab)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003067 "\n -s Use syslog (LOCAL0 facility)" \
3068 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
3069
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003070#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003071 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
3072 " or\n" \
3073 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003074
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003075#if !ENABLE_DESKTOP
3076
Rob Landley1cca9482006-07-10 19:45:20 +00003077#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003078#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003079#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003080#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003081#endif
Rob Landley1cca9482006-07-10 19:45:20 +00003082
Eric Andersen7e9276b2001-02-22 01:15:47 +00003083#define nc_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003084 IF_NC_EXTRA("[-iN] [-wN] ")IF_NC_SERVER("[-l] [-p PORT] ") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003085 "["IF_NC_EXTRA("-f FILENAME|")"IPADDR PORT]"IF_NC_EXTRA(" [-e PROG]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003086#define nc_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003087 "Open a pipe to IP:port" IF_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003088 NC_OPTIONS_STR \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003089 IF_NC_EXTRA( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003090 "\n -e PROG Run PROG after connect" \
3091 "\n -i SEC Delay interval for lines sent" \
3092 "\n -w SEC Timeout for connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003093 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003094 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003095 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003096 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003097 IF_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003098 "\n (use -l twice with -e for persistent server)") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003099 "\n -p PORT Local port" \
Rob Landley1cca9482006-07-10 19:45:20 +00003100 )
3101
Rob Landley1cca9482006-07-10 19:45:20 +00003102#define nc_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003103 IF_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003104 "To use netcat as a terminal emulator on a serial port:\n\n" \
3105 "$ stty 115200 -F /dev/ttyS0\n" \
3106 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
3107 )
Rob Landley1cca9482006-07-10 19:45:20 +00003108
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003109#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003110 "$ nc foobar.somedomain.com 25\n" \
3111 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
3112 "help\n" \
3113 "214-Commands supported:\n" \
3114 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
3115 "214 NOOP QUIT RSET HELP\n" \
3116 "quit\n" \
3117 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003118
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003119#else /* DESKTOP nc - much more compatible with nc 1.10 */
3120
3121#define nc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003122 "[OPTIONS] HOST PORT - connect" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003123 IF_NC_SERVER("\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003124 "nc [OPTIONS] -l -p PORT [HOST] [PORT] - listen")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003125#define nc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003126 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003127 "\n -e PROG Run PROG after connect (must be last)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003128 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003129 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003130 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003131 "\n -n Don't do DNS resolution" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003132 "\n -s ADDR Local address" \
3133 "\n -p PORT Local port" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003134 "\n -u UDP mode" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003135 "\n -v Verbose" \
3136 "\n -w SEC Timeout for connects and final net reads" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003137 IF_NC_EXTRA( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003138 "\n -i SEC Delay interval for lines sent" /* ", ports scanned" */ \
3139 "\n -o FILE Hex dump traffic" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003140 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003141 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003142/* "\n -r Randomize local and remote ports" */
3143/* "\n -g gateway Source-routing hop point[s], up to 8" */
3144/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003145/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
3146
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003147/* -e PROG can take ARGS too: "nc ... -e ls -l", but we don't document it
3148 * in help text: nc 1.10 does not allow that. We don't want to entice
3149 * users to use this incompatibility */
3150
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003151#endif
3152
Eric Andersen1552ff72001-10-31 11:07:12 +00003153#define netstat_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003154 "[-laentuwxr"IF_FEATURE_NETSTAT_WIDE("W")IF_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003155#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003156 "Display networking information\n" \
3157 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003158 "\n -l Display listening server sockets" \
3159 "\n -a Display all sockets (default: connected)" \
3160 "\n -e Display other/more information" \
3161 "\n -n Don't resolve names" \
3162 "\n -t Tcp sockets" \
3163 "\n -u Udp sockets" \
3164 "\n -w Raw sockets" \
3165 "\n -x Unix sockets" \
3166 "\n -r Display routing table" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003167 IF_FEATURE_NETSTAT_WIDE( \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003168 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003169 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003170 IF_FEATURE_NETSTAT_PRG( \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003171 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003172 )
Eric Andersen1552ff72001-10-31 11:07:12 +00003173
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003174#define nice_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003175 "[-n ADJUST] [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003176#define nice_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003177 "Run PROG with modified scheduling priority\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003178 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003179 "\n -n ADJUST Adjust priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003180
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003181#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003182 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003183#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003184 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003185 "Format specifiers:\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003186 " %Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003187 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003188 " %[niface] Monitor network interface 'iface'\n" \
3189 " %m Monitor allocated memory\n" \
3190 " %[mf] Monitor free memory\n" \
3191 " %[mt] Monitor total memory\n" \
3192 " %s Monitor allocated swap\n" \
3193 " %f Monitor number of used file descriptors\n" \
3194 " %Ni Monitor total/specific IRQ rate\n" \
3195 " %x Monitor context switch rate\n" \
3196 " %p Monitor forks\n" \
3197 " %[pn] Monitor # of processes\n" \
3198 " %b Monitor block io\n" \
3199 " %Nt Show time (with N decimal points)\n" \
3200 " %Nd Milliseconds between updates (default:1000)\n" \
3201 " %r Print <cr> instead of <lf> at EOL" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003202
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003203#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003204 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003205
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003206#define nohup_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003207 "PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003208#define nohup_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003209 "Run PROG immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003210#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003211 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003212
Eric Andersen7e9276b2001-02-22 01:15:47 +00003213#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003214 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003215#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003216 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003217 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003218#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003219 "$ nslookup localhost\n" \
3220 "Server: default\n" \
3221 "Address: default\n" \
3222 "\n" \
3223 "Name: debian\n" \
3224 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003225
Adam Tkacb1585062009-11-22 03:43:55 +01003226#define ntpd_trivial_usage \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01003227 "[-dnqwl] [-S PROG] [-p PEER]..."
Adam Tkacb1585062009-11-22 03:43:55 +01003228#define ntpd_full_usage "\n\n" \
3229 "NTP client/server\n" \
3230 "\nOptions:" \
3231 "\n -d Verbose" \
3232 "\n -n Do not daemonize" \
Denys Vlasenko8d580c72009-11-23 16:27:16 +01003233 "\n -q Quit after clock is set" \
Denys Vlasenko907647f2009-12-02 23:17:45 +01003234/* -N exists for mostly compat reasons, thus not essential to inform */ \
Denys Vlasenkob2e5fc32009-11-25 14:52:47 +01003235/* the user that it exists: user may use nice as well */ \
3236/* "\n -N Run at high priority" */ \
Denys Vlasenko074e8dc2010-01-04 23:58:13 +01003237 "\n -w Do not set time (only query peers), implies -n" \
Adam Tkacb1585062009-11-22 03:43:55 +01003238 "\n -l Run as server on port 123" \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01003239 "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins" \
Adam Tkacb1585062009-11-22 03:43:55 +01003240 "\n -p PEER Obtain time from PEER (may be repeated)" \
3241
Glenn L McGrath60281112001-11-02 11:39:46 +00003242#define od_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003243 "[-aBbcDdeFfHhIiLlOovXx] " IF_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003244#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003245 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003246 "(or stdin) to stdout"
Glenn L McGrath60281112001-11-02 11:39:46 +00003247
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003248#define openvt_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003249 "[-c N] [-sw] [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003250#define openvt_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003251 "Start PROG on a new virtual terminal\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003252 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003253 "\n -c N Use specified VT" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003254 "\n -s Switch to the VT" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003255/* "\n -l Run PROG as login shell (by prepending '-')" */ \
3256 "\n -w Wait for PROG to exit" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003257
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003258#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003259 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003260
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003261/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003262#define parse_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003263 "[-n MAXTOKENS] [-m MINTOKENS] [-d DELIMS] [-f FLAGS] FILE..."
3264#define parse_full_usage ""
3265*/
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003266
Eric Andersen27f64e12002-06-23 04:24:25 +00003267#define passwd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003268 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003269#define passwd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003270 "Change USER's password. If no USER is specified,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003271 "changes the password for the current user.\n" \
3272 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003273 "\n -a Algorithm to use for password (des, md5)" /* ", sha1)" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00003274 "\n -d Delete password for the account" \
3275 "\n -l Lock (disable) account" \
3276 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003277
Denis Vlasenko21d10142007-07-20 21:28:41 +00003278#define chpasswd_trivial_usage \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003279 IF_LONG_OPTS("[--md5|--encrypted]") IF_NOT_LONG_OPTS("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003280#define chpasswd_full_usage "\n\n" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003281 "Read user:password from stdin and update /etc/passwd\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003282 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003283 IF_LONG_OPTS( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003284 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003285 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003286 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003287 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003288 "\n -e Supplied passwords are in encrypted form" \
3289 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003290 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00003291
Glenn L McGrath655d8142003-06-22 15:32:41 +00003292#define patch_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003293 "[OPTIONS] [ORIGFILE [PATCHFILE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003294#define patch_full_usage "\n\n" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003295 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003296 " -p,--strip N Strip N leading components from file names" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003297 "\n -i,--input DIFF Read DIFF instead of stdin" \
3298 "\n -R,--reverse Reverse patch" \
3299 "\n -N,--forward Ignore already applied patches" \
3300 "\n --dry-run Don't actually change files" \
3301 ) \
3302 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003303 " -p N Strip N leading components from file names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003304 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003305 "\n -R Reverse patch" \
Denys Vlasenkod7874ed2009-08-20 23:33:19 +02003306 "\n -N Ignore already applied patches" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003307 )
Denis Vlasenko397de612008-03-17 08:55:44 +00003308
Glenn L McGrath655d8142003-06-22 15:32:41 +00003309#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003310 "$ patch -p1 < example.diff\n" \
3311 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00003312
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003313#define pgrep_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003314 "[-flnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003315#define pgrep_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003316 "Display process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003317 "\nOptions:" \
3318 "\n -l Show command name too" \
3319 "\n -f Match against entire command line" \
3320 "\n -n Show the newest process only" \
3321 "\n -o Show the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003322 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003323 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003324 "\n -s Match session ID (0 for current)" \
3325 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003326
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003327#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00003328#define pidof_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003329 "[OPTIONS] [NAME]..."
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003330#define USAGE_PIDOF "\n\nOptions:"
3331#else
3332#define pidof_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003333 "[NAME]..."
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003334#define USAGE_PIDOF /* none */
3335#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003336#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003337 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003338 USAGE_PIDOF \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003339 IF_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003340 "\n -s Show only one PID") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003341 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003342 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003343 "\n Use %PPID to omit pid of pidof's parent") \
3344
Eric Andersen221b2ea2001-07-31 19:06:07 +00003345#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003346 "$ pidof init\n" \
3347 "1\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003348 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003349 "$ pidof /bin/sh\n20351 5973 5950\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003350 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003351 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00003352
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003353#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003354#define ping_trivial_usage \
3355 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003356#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003357 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003358#define ping6_trivial_usage \
3359 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003360#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003361 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003362#else
3363#define ping_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003364 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003365#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003366 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3367 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003368 "\n -4, -6 Force IP or IPv6 name resolution" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003369 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003370 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3371 "\n -I IFACE/IP Use interface or IP address as source" \
3372 "\n -W SEC Seconds to wait for the first response (default:10)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003373 "\n (after all -c CNT packets are sent)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003374 "\n -w SEC Seconds until ping exits (default:infinite)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003375 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003376 "\n -q Quiet, only displays output at start" \
3377 "\n and when finished" \
3378
Eric Andersen51b8bd62002-07-03 11:46:38 +00003379#define ping6_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003380 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003381#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003382 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3383 "\nOptions:" \
3384 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003385 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3386 "\n -I IFACE/IP Use interface or IP address as source" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003387 "\n -q Quiet, only displays output at start" \
3388 "\n and when finished" \
3389
Eric Andersen51b8bd62002-07-03 11:46:38 +00003390#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003391#define ping_example_usage \
3392 "$ ping localhost\n" \
3393 "PING slag (127.0.0.1): 56 data bytes\n" \
3394 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3395 "\n" \
3396 "--- debian ping statistics ---\n" \
3397 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3398 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003399#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003400 "$ ping6 ip6-localhost\n" \
3401 "PING ip6-localhost (::1): 56 data bytes\n" \
3402 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3403 "\n" \
3404 "--- ip6-localhost ping statistics ---\n" \
3405 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3406 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003407
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003408#define pipe_progress_trivial_usage NOUSAGE_STR
3409#define pipe_progress_full_usage ""
3410
Eric Andersen7e9276b2001-02-22 01:15:47 +00003411#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003412 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003413#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003414 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003415 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003416
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003417#define pkill_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003418 "[-l|-SIGNAL] [-fnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003419#define pkill_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003420 "Send a signal to process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003421 "\nOptions:" \
3422 "\n -l List all signals" \
3423 "\n -f Match against entire command line" \
3424 "\n -n Signal the newest process only" \
3425 "\n -o Signal the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003426 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003427 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003428 "\n -s Match session ID (0 for current)" \
3429 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003430
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003431#define popmaildir_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003432 "[OPTIONS] MAILDIR [CONN_HELPER ARGS]"
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003433#define popmaildir_full_usage "\n\n" \
3434 "Fetch content of remote mailbox to local maildir\n" \
3435 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003436/* "\n -b Binary mode. Ignored" */ \
3437/* "\n -d Debug. Ignored" */ \
3438/* "\n -m Show used memory. Ignored" */ \
3439/* "\n -V Show version. Ignored" */ \
3440/* "\n -c Use tcpclient. Ignored" */ \
3441/* "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003442 "\n -s Skip authorization" \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003443 "\n -T Get messages with TOP instead of RETR" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003444 "\n -k Keep retrieved messages on the server" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003445 "\n -t SEC Network timeout" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003446 IF_FEATURE_POPMAILDIR_DELIVERY( \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003447 "\n -F \"PROG ARGS\" Filter program (may be repeated)" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003448 "\n -M \"PROG ARGS\" Delivery program" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003449 ) \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003450 "\n" \
3451 "\nFetch from plain POP3 server:" \
3452 "\npopmaildir -k DIR nc pop3.server.com 110 <user_and_pass.txt" \
3453 "\nFetch from SSLed POP3 server and delete fetched emails:" \
3454 "\npopmaildir DIR -- openssl s_client -quiet -connect pop3.server.com:995 <user_and_pass.txt"
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003455/* "\n -R BYTES Remove old messages on the server >= BYTES. Ignored" */
3456/* "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" */
3457/* "\n -L BYTES Don't retrieve new messages >= BYTES. Ignored" */
3458/* "\n -H LINES Type first LINES of a message. Ignored" */
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003459#define popmaildir_example_usage \
3460 "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n" \
3461 "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
3462
Eric Andersen7e9276b2001-02-22 01:15:47 +00003463#define poweroff_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003464 "[-d DELAY] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003465#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003466 "Halt and shut off power\n" \
3467 "\nOptions:" \
3468 "\n -d Delay interval for halting" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003469 "\n -n Do not sync" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003470 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003471
Mike Frysinger95d3c452005-04-21 23:29:24 +00003472#define printenv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003473 "[VARIABLE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003474#define printenv_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003475 "Print environment VARIABLEs.\n" \
3476 "If no VARIABLE specified, print all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003477
Eric Andersen7e9276b2001-02-22 01:15:47 +00003478#define printf_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003479 "FORMAT [ARGUMENT]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003480#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003481 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003482 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003483#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003484 "$ printf \"Val=%d\\n\" 5\n" \
3485 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003486
Denis Vlasenko94949192006-11-05 00:45:47 +00003487
3488#if ENABLE_DESKTOP
3489
3490#define ps_trivial_usage \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003491 "[-o COL1,COL2=HEADER]" IF_FEATURE_SHOW_THREADS(" [-T]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003492#define ps_full_usage "\n\n" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003493 "Show list of processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003494 "\nOptions:" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003495 "\n -o COL1,COL2=HEADER Select columns for display" \
Denys Vlasenko532609e2009-09-20 20:29:25 +02003496 IF_FEATURE_SHOW_THREADS( \
3497 "\n -T Show threads" \
3498 )
Denis Vlasenko94949192006-11-05 00:45:47 +00003499
3500#else /* !ENABLE_DESKTOP */
3501
Denis Vlasenko397de612008-03-17 08:55:44 +00003502#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003503#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003504#else
3505#define USAGE_PS "\nOptions:"
3506#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003507
Eric Andersen7e9276b2001-02-22 01:15:47 +00003508#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003509 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003510#define ps_full_usage "\n\n" \
Denys Vlasenko9e072192010-05-23 00:34:42 +02003511 "Show list of processes\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003512 USAGE_PS \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003513 IF_SELINUX( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003514 "\n -Z Show selinux context" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003515 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003516 IF_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003517 "\n w Wide output" \
3518 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003519
Denis Vlasenko94949192006-11-05 00:45:47 +00003520#endif /* ENABLE_DESKTOP */
3521
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003522#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003523 "$ ps\n" \
3524 " PID Uid Gid State Command\n" \
3525 " 1 root root S init\n" \
3526 " 2 root root S [kflushd]\n" \
3527 " 3 root root S [kupdate]\n" \
3528 " 4 root root S [kpiod]\n" \
3529 " 5 root root S [kswapd]\n" \
3530 " 742 andersen andersen S [bash]\n" \
3531 " 743 andersen andersen S -bash\n" \
3532 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003533 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003534
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003535#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003536 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003537#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003538 "Scan a host, print all open ports\n" \
3539 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003540 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003541 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003542 "\n -p Scan from this port (default 1)" \
3543 "\n -P Scan up to this port (default 1024)" \
3544 "\n -t Timeout (default 5000 ms)" \
3545 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3546
Eric Andersen7e9276b2001-02-22 01:15:47 +00003547#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003548 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003549#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003550 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003551#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003552 "$ pwd\n" \
3553 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003554
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003555#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003556 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003557#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003558 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003559#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003560 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003561
Eric Andersen7e9276b2001-02-22 01:15:47 +00003562#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003563 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003564#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003565 "Get and possibly set the system date and time from a remote HOST\n" \
3566 "\nOptions:" \
3567 "\n -s Set the system date and time (default)" \
3568 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003569
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00003570#define rdev_trivial_usage \
3571 ""
3572#define rdev_full_usage "\n\n" \
3573 "Print the device node associated with the filesystem mounted at '/'"
3574#define rdev_example_usage \
3575 "$ rdev\n" \
3576 "/dev/mtdblock9 /\n"
3577
Rob Landley0e4690d2006-08-20 22:12:18 +00003578#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003579 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003580#define readahead_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003581 "Preload FILEs to RAM"
Rob Landley0e4690d2006-08-20 22:12:18 +00003582
Eric Andersen7e9276b2001-02-22 01:15:47 +00003583#define readlink_trivial_usage \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003584 IF_FEATURE_READLINK_FOLLOW("[-fnv] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003585#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003586 "Display the value of a symlink" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003587 IF_FEATURE_READLINK_FOLLOW( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003588 "\nOptions:" \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003589 "\n -f Canonicalize by following all symlinks" \
3590 "\n -n Don't add newline" \
3591 "\n -v Verbose" \
3592 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003593
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003594#define readprofile_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003595 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003596#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003597 "Options:" \
3598 "\n -m mapfile (Default: /boot/System.map)" \
3599 "\n -p profile (Default: /proc/profile)" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003600 "\n -M NUM Set the profiling multiplier to NUM" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003601 "\n -i Print only info about the sampling step" \
3602 "\n -v Verbose" \
3603 "\n -a Print all symbols, even if count is 0" \
3604 "\n -b Print individual histogram-bin counts" \
3605 "\n -s Print individual counters within functions" \
3606 "\n -r Reset all the counters (root only)" \
3607 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003608
Glenn L McGrath62fae302002-12-10 00:14:33 +00003609#define realpath_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003610 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003611#define realpath_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003612 "Return the absolute pathnames of given FILE"
Tim Riker7b253f82003-12-28 05:02:40 +00003613
Eric Andersen7e9276b2001-02-22 01:15:47 +00003614#define reboot_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003615 "[-d DELAY] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003616#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003617 "Reboot the system\n" \
3618 "\nOptions:" \
3619 "\n -d Delay interval for rebooting" \
3620 "\n -n No call to sync()" \
3621 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003622
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003623#define reformime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003624 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003625#define reformime_full_usage "\n\n" \
3626 "Parse MIME-encoded message\n" \
3627 "\nOptions:" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003628 "\n -x PREFIX Extract content of MIME sections to files" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003629 "\n -X PROG ARGS Filter content of MIME sections through PROG" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003630 "\n Must be the last option" \
3631 "\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003632 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003633
Eric Andersen7e9276b2001-02-22 01:15:47 +00003634#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003635 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003636#define renice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003637 "Change priority of running processes\n" \
3638 "\nOptions:" \
3639 "\n -n Adjust current nice value (smaller is faster)" \
3640 "\n -p Process id(s) (default)" \
3641 "\n -g Process group id(s)" \
3642 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003643
Denys Vlasenko5e611152009-05-19 17:36:16 +02003644#define scriptreplay_trivial_usage \
3645 "timingfile [typescript [divisor]]"
3646#define scriptreplay_full_usage "\n\n" \
3647 "Play back typescripts, using timing information"
3648
Eric Andersen7e9276b2001-02-22 01:15:47 +00003649#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003650 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003651#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003652 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003653
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003654#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003655 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003656#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003657 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003658
Denis Vlasenko397137b2007-07-23 14:03:30 +00003659#define restorecon_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003660 "[-iFnRv] [-e EXCLUDEDIR]... [-o FILE] [-f FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003661#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003662 "Reset security contexts of files in pathname\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003663 "\n -i Ignore files that don't exist" \
3664 "\n -f FILE File with list of files to process" \
3665 "\n -e DIR Directory to exclude" \
3666 "\n -R,-r Recurse" \
3667 "\n -n Don't change any file labels" \
3668 "\n -o FILE Save list of files with incorrect context" \
3669 "\n -v Verbose" \
3670 "\n -vv Show changed labels" \
3671 "\n -F Force reset of context to match file_context" \
3672 "\n for customizable files, or the user section," \
3673 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003674
Souf Oued43afd752010-05-02 18:45:02 +02003675#define rfkill_trivial_usage \
3676 "COMMAND [INDEX|TYPE]"
3677#define rfkill_full_usage "\n\n" \
3678 "Enable/disable wireless devices\n" \
3679 "\nCommands:" \
3680 "\n list [INDEX|TYPE] List current state" \
3681 "\n block INDEX|TYPE Disable device" \
3682 "\n unblock INDEX|TYPE Enable device" \
3683 "\n" \
3684 "\n TYPE: all, wlan(wifi), bluetooth, uwb(ultrawideband)," \
3685 "\n wimax, wwan, gps, fm" \
3686
Eric Andersen7e9276b2001-02-22 01:15:47 +00003687#define rm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003688 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003689#define rm_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003690 "Remove (unlink) FILEs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003691 "\nOptions:" \
3692 "\n -i Always prompt before removing" \
3693 "\n -f Never prompt" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003694 "\n -R,-r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003695
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003696#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003697 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003698
Eric Andersen7e9276b2001-02-22 01:15:47 +00003699#define rmdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003700 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003701#define rmdir_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003702 "Remove DIRECTORY if it is empty\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003703 "\nOptions:" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003704 IF_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003705 "\n -p|--parents Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003706 "\n --ignore-fail-on-non-empty" \
3707 ) \
3708 IF_NOT_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003709 "\n -p Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003710 )
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003711
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003712#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003713 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003714
Eric Andersen7e9276b2001-02-22 01:15:47 +00003715#define rmmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003716 "[OPTIONS] [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003717#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003718 "Unload the specified kernel modules from the kernel\n" \
3719 "\nOptions:" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003720 "\n -w Wait until the module is no longer used" \
3721 "\n -f Force unloading" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003722 "\n -a Remove all unused modules (recursively)" \
3723
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003724#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003725 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003726
Eric Andersen7e9276b2001-02-22 01:15:47 +00003727#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003728 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003729#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003730 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003731 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003732 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003733 "\n -e Display other/more information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003734 "\n -A inet" IF_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003735
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003736#define rpm_trivial_usage \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02003737 "-i PACKAGE.rpm; rpm -qp[ildc] PACKAGE.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003738#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003739 "Manipulate RPM packages\n" \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02003740 "\nCommands:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003741 "\n -i Install package" \
Denys Vlasenko5dfd9c42010-05-06 16:56:38 +02003742 "\n -qp Query package" \
3743 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003744 "\n -i Show information" \
3745 "\n -l List contents" \
3746 "\n -d List documents" \
3747 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003748
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003749#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003750 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003751#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003752 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003753
Mike Frysinger6b160e42008-02-15 02:27:19 +00003754#define rtcwake_trivial_usage \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003755 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SEC | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003756#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003757 "Enter a system sleep state until specified wakeup time\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003758 IF_LONG_OPTS( \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003759 "\n -a,--auto Read clock mode from adjtime" \
3760 "\n -l,--local Clock is set to local time" \
3761 "\n -u,--utc Clock is set to UTC time" \
3762 "\n -d,--device=DEV Specify the RTC device" \
3763 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003764 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003765 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003766 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003767 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003768 "\n -a Read clock mode from adjtime" \
3769 "\n -l Clock is set to local time" \
3770 "\n -u Clock is set to UTC time" \
3771 "\n -d DEV Specify the RTC device" \
3772 "\n -m MODE Set the sleep state (default: standby)" \
3773 "\n -s SEC Set the timeout in SEC seconds from now" \
3774 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003775 )
3776
Denis Vlasenko49622d72007-03-10 16:58:49 +00003777#define runcon_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003778 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] PROG ARGS\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003779 "runcon CONTEXT PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003780#define runcon_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003781 "Run PROG in a different security context\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003782 "\n CONTEXT Complete security context\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003783 IF_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003784 "\n -c,--compute Compute process transition context before modifying" \
3785 "\n -t,--type=TYPE Type (for same role as parent)" \
3786 "\n -u,--user=USER User identity" \
3787 "\n -r,--role=ROLE Role" \
3788 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003789 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003790 IF_NOT_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003791 "\n -c Compute process transition context before modifying" \
3792 "\n -t TYPE Type (for same role as parent)" \
3793 "\n -u USER User identity" \
3794 "\n -r ROLE Role" \
3795 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003796 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003797
Eric Andersen6cf47a72001-10-31 10:24:36 +00003798#define run_parts_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003799 "[-t] "IF_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003800#define run_parts_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003801 "Run a bunch of scripts in DIRECTORY\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003802 "\nOptions:" \
3803 "\n -t Print what would be run, but don't actually run anything" \
3804 "\n -a ARG Pass ARG as argument for every program" \
3805 "\n -u MASK Set the umask to MASK before running every program" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003806 IF_FEATURE_RUN_PARTS_FANCY( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003807 "\n -l Print names of all matching files even if they are not executable" \
3808 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003809
3810#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003811 "$ run-parts -a start /etc/init.d\n" \
3812 "$ run-parts -a stop=now /etc/init.d\n\n" \
3813 "Let's assume you have a script foo/dosomething:\n" \
3814 "#!/bin/sh\n" \
3815 "for i in $*; do eval $i; done; unset i\n" \
3816 "case \"$1\" in\n" \
3817 "start*) echo starting something;;\n" \
3818 "stop*) set -x; shutdown -h $stop;;\n" \
3819 "esac\n\n" \
3820 "Running this yields:\n" \
3821 "$run-parts -a stop=+4m foo/\n" \
3822 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003823
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003824#define runlevel_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003825 "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003826#define runlevel_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003827 "Find the current and previous system runlevel\n" \
3828 "\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003829 "If no utmp FILE exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003830 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003831#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003832 "$ runlevel /var/run/utmp\n" \
3833 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003834
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003835#define runsv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003836 "DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003837#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003838 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003839
3840#define runsvdir_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003841 "[-P] [-s SCRIPT] DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003842#define runsvdir_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003843 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
3844 "\n -P Put each runsv in a new session" \
3845 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003846
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003847#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003848 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003849#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003850 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003851#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003852 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003853
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003854#define script_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003855 "[-afq" IF_SCRIPTREPLAY("t") "] [-c PROG] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003856#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003857 "Options:" \
3858 "\n -a Append output" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01003859 "\n -c PROG Run PROG, not shell" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003860 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003861 "\n -q Quiet" \
Denys Vlasenko5e611152009-05-19 17:36:16 +02003862 IF_SCRIPTREPLAY( \
3863 "\n -t Send timing to stderr" \
3864 )
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003865
Eric Andersen7e9276b2001-02-22 01:15:47 +00003866#define sed_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003867 "[-efinr] SED_CMD [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003868#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003869 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003870 "\n -e CMD Add CMD to sed commands to be executed" \
3871 "\n -f FILE Add FILE contents to sed commands to be executed" \
Denys Vlasenkodac863a2009-10-27 09:11:17 +01003872 "\n -i Edit files in-place (else sends result to stdout)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003873 "\n -n Suppress automatic printing of pattern space" \
3874 "\n -r Use extended regex syntax" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003875 "\n" \
Rob Landley7b284152009-10-26 16:04:07 -05003876 "\nIf no -e or -f, the first non-option argument is the sed command string." \
3877 "\nRemaining arguments are input files (stdin if none)."
Eric Andersenf802ff72004-04-12 15:12:06 +00003878
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003879#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003880 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3881 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003882
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003883#define selinuxenabled_trivial_usage NOUSAGE_STR
3884#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003885
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003886#define sendmail_trivial_usage \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003887 "[OPTIONS] [RECIPIENT_EMAIL]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003888#define sendmail_full_usage "\n\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003889 "Read email from stdin and send it\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003890 "\nStandard options:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003891 "\n -t Read additional recipients from message body" \
3892 "\n -f sender Sender (required)" \
3893 "\n -o options Various options. -oi implied, others are ignored" \
Vladimir Dronnikovb618dba2009-10-04 01:34:54 +02003894 "\n -i -oi synonym. implied and ignored" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003895 "\n" \
3896 "\nBusybox specific options:" \
3897 "\n -w seconds Network timeout" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003898 "\n -H 'PROG ARGS' Run connection helper" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003899 "\n Examples:" \
Denis Vlasenko7e0c2432009-03-02 16:12:00 +00003900 "\n -H 'exec openssl s_client -quiet -tls1 -starttls smtp" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003901 "\n -connect smtp.gmail.com:25' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003902 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003903 "\n -H 'exec openssl s_client -quiet -tls1" \
3904 "\n -connect smtp.gmail.com:465' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003905 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003906 "\n -S server[:port] Server" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003907 "\n -au<username> Username for AUTH LOGIN" \
3908 "\n -ap<password> Password for AUTH LOGIN" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003909 "\n -am<method> Authentication method. Ignored. LOGIN is implied" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003910 "\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003911 "\nOther options are silently ignored; -oi -t is implied" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003912 IF_MAKEMIME( \
3913 "\nUse makemime applet to create message with attachments" \
3914 )
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003915
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003916#define seq_trivial_usage \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003917 "[-w] [-s SEP] [FIRST [INC]] LAST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003918#define seq_full_usage "\n\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003919 "Print numbers from FIRST to LAST, in steps of INC.\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003920 "FIRST, INC default to 1.\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003921 "\nOptions:" \
3922 "\n -w Pad to last with leading zeros" \
3923 "\n -s SEP String separator" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003924
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003925#define sestatus_trivial_usage \
3926 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003927#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003928 " -v Verbose" \
3929 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003930
Paul Foxfc2256a2005-08-01 18:12:30 +00003931#define setconsole_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003932 "[-r" IF_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003933#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003934 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3935 "\nOptions:" \
3936 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003937
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003938#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003939 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003940#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003941
Denis Vlasenko397137b2007-07-23 14:03:30 +00003942#define setfiles_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003943 "[-dnpqsvW] [-e DIR]... [-o FILE] [-r alt_root_path]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003944 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003945 " [-c policyfile] spec_file" \
3946 ) \
3947 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003948#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003949 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003950 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003951 "\n -c FILE Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003952 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003953 "\n -d Show which specification matched each file" \
3954 "\n -l Log changes in file labels to syslog" \
3955 "\n -n Don't change any file labels" \
3956 "\n -q Suppress warnings" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003957 "\n -r DIR Use an alternate root path" \
3958 "\n -e DIR Exclude DIR" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003959 "\n -F Force reset of context to match file_context for customizable files" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003960 "\n -o FILE Save list of files with incorrect context" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003961 "\n -s Take a list of files from stdin (instead of command line)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003962 "\n -v Show changes in file labels, if type or role are changing" \
3963 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3964 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003965
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003966#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003967 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003968#define setfont_full_usage "\n\n" \
3969 "Load a console font\n" \
3970 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003971 "\n -m MAPFILE Load console screen map" \
3972 "\n -C TTY Affect TTY instead of /dev/tty" \
3973
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003974#define setfont_example_usage \
3975 "$ setfont -m koi8-r /etc/i18n/fontname\n"
3976
Eric Andersen7e9276b2001-02-22 01:15:47 +00003977#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003978 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003979#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003980 "Set entries into the kernel's scancode-to-keycode map,\n" \
3981 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3982 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003983 "and KEYCODE is given in decimal." \
Denis Vlasenko397de612008-03-17 08:55:44 +00003984
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003985#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003986 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003987
Rob Landley87848d92006-03-27 23:23:43 +00003988#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003989 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003990#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003991 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003992
Denis Vlasenkobe039372007-10-14 04:48:44 +00003993#define setsebool_trivial_usage \
3994 "boolean value"
3995
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003996#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00003997 "Change boolean setting"
3998
Paul Fox42403642005-08-01 22:52:09 +00003999#define setsid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004000 "PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004001#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004002 "Run PROG in a new session. PROG will have no controlling terminal\n" \
4003 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
4004 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00004005
Eric Andersen2e9c2572003-08-08 22:26:06 +00004006#define last_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004007 ""IF_FEATURE_LAST_FANCY("[-HW] [-f FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004008#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004009 "Show listing of the last users that logged into the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004010 IF_FEATURE_LAST_FANCY( "\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004011 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00004012/* "\n -H Show header line" */ \
4013 "\n -W Display with no host column truncation" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004014 "\n -f FILE Read from FILE instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004015 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00004016
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00004017#define showkey_trivial_usage \
4018 "[-a | -k | -s]"
4019#define showkey_full_usage "\n\n" \
4020 "Show keys pressed\n" \
4021 "\nOptions:" \
4022 "\n -a Display decimal/octal/hex values of the keys" \
4023 "\n -k Display interpreted keycodes (default)" \
4024 "\n -s Display raw scan-codes" \
4025
Denis Vlasenko14923db2007-06-20 15:23:03 +00004026#define slattach_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004027 "[-cehmLF] [-s SPEED] [-p PROTOCOL] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004028#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004029 "Attach network interface(s) to serial line(s)\n" \
4030 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004031 "\n -p PROT Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
4032 "\n -s SPD Set line speed" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004033 "\n -e Exit after initializing device" \
4034 "\n -h Exit when the carrier is lost" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004035 "\n -c PROG Run PROG when the line is hung up" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004036 "\n -m Do NOT initialize the line in raw 8 bits mode" \
4037 "\n -L Enable 3-wire operation" \
4038 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00004039
Eric Andersen7e9276b2001-02-22 01:15:47 +00004040#define sleep_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004041 IF_FEATURE_FANCY_SLEEP("[") "N" IF_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004042#define sleep_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004043 IF_NOT_FEATURE_FANCY_SLEEP("Pause for N seconds") \
4044 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004045 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004046 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004047#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004048 "$ sleep 2\n" \
4049 "[2 second delay results]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004050 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004051 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004052 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00004053
Eric Andersen7e9276b2001-02-22 01:15:47 +00004054#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004055 "[-nru" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004056 IF_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004057 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004058#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004059 "Sort lines of text\n" \
4060 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004061 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004062 "\n -b Ignore leading blanks" \
4063 "\n -c Check whether input is sorted" \
4064 "\n -d Dictionary order (blank or alphanumeric only)" \
4065 "\n -f Ignore case" \
4066 "\n -g General numerical sort" \
4067 "\n -i Ignore unprintable characters" \
4068 "\n -k Sort key" \
4069 "\n -M Sort month" \
4070 ) \
4071 "\n -n Sort numbers" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004072 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004073 "\n -o Output to file" \
4074 "\n -k Sort by key" \
4075 "\n -t CHAR Key separator" \
4076 ) \
4077 "\n -r Reverse sort order" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004078 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004079 "\n -s Stable (don't sort ties alphabetically)" \
4080 ) \
4081 "\n -u Suppress duplicate lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004082 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004083 "\n -z Lines are terminated by NUL, not newline" \
4084 "\n -mST Ignored for GNU compatibility") \
4085
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004086#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004087 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
4088 "a\n" \
4089 "b\n" \
4090 "c\n" \
4091 "d\n" \
4092 "e\n" \
4093 "f\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004094 IF_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00004095 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
4096 "d 2\n" \
4097 "b 2\n" \
4098 "c 3\n" \
4099 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004100 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004101
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00004102#define split_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004103 "[OPTIONS] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004104#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00004105 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004106 "\n -b n[k|m] Split by bytes" \
4107 "\n -l n Split by lines" \
4108 "\n -a n Use n letters as suffix" \
4109
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00004110#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00004111 "$ split TODO foo\n" \
4112 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00004113
Eric Andersenc2af1ee2001-10-18 19:33:06 +00004114#define start_stop_daemon_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004115 "[OPTIONS] [-S|-K] ... [-- ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004116#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004117 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004118 "-K: stop all matching processes.\n" \
4119 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004120 IF_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004121 "\nProcess matching:" \
4122 "\n -u,--user USERNAME|UID Match only this user's processes" \
4123 "\n -n,--name NAME Match processes with NAME" \
4124 "\n in comm field in /proc/PID/stat" \
4125 "\n -x,--exec EXECUTABLE Match processes with this command" \
4126 "\n in /proc/PID/cmdline" \
4127 "\n -p,--pidfile FILE Match a process with PID from the file" \
4128 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004129 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004130 "\n -x,--exec EXECUTABLE Program to run" \
4131 "\n -a,--startas NAME Zeroth argument" \
4132 "\n -b,--background Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004133 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004134 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004135 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004136 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
4137 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004138 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004139 "\n -s,--signal SIG Signal to send" \
4140 "\n -t,--test Match only, exit with 0 if a process is found" \
4141 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004142 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004143 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004144 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00004145 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00004146 "\n -q,--quiet Quiet" \
4147 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004148 IF_NOT_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004149 "\nProcess matching:" \
4150 "\n -u USERNAME|UID Match only this user's processes" \
4151 "\n -n NAME Match processes with NAME" \
4152 "\n in comm field in /proc/PID/stat" \
4153 "\n -x EXECUTABLE Match processes with this command" \
4154 "\n command in /proc/PID/cmdline" \
4155 "\n -p FILE Match a process with PID from the file" \
4156 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004157 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004158 "\n -x EXECUTABLE Program to run" \
4159 "\n -a NAME Zeroth argument" \
4160 "\n -b Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004161 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004162 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00004163 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004164 "\n -c USER[:[GRP]] Change to user/group" \
4165 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004166 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004167 "\n -s SIG Signal to send" \
4168 "\n -t Match only, exit with 0 if a process is found" \
4169 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004170 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004171 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004172 "\n -v Verbose" \
4173 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00004174 "\n -q Quiet" \
4175 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00004176
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004177#define stat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004178 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004179#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004180 "Display file (default) or filesystem status\n" \
4181 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004182 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004183 "\n -c fmt Use the specified format" \
4184 ) \
4185 "\n -f Display filesystem status" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004186 "\n -L Follow links" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004187 "\n -t Display info in terse form" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004188 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004189 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004190 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004191 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004192 "\n\nValid format sequences for files:\n" \
4193 " %a Access rights in octal\n" \
4194 " %A Access rights in human readable form\n" \
4195 " %b Number of blocks allocated (see %B)\n" \
4196 " %B The size in bytes of each block reported by %b\n" \
4197 " %d Device number in decimal\n" \
4198 " %D Device number in hex\n" \
4199 " %f Raw mode in hex\n" \
4200 " %F File type\n" \
4201 " %g Group ID of owner\n" \
4202 " %G Group name of owner\n" \
4203 " %h Number of hard links\n" \
4204 " %i Inode number\n" \
4205 " %n File name\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004206 " %N File name, with -> TARGET if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004207 " %o I/O block size\n" \
4208 " %s Total size, in bytes\n" \
4209 " %t Major device type in hex\n" \
4210 " %T Minor device type in hex\n" \
4211 " %u User ID of owner\n" \
4212 " %U User name of owner\n" \
4213 " %x Time of last access\n" \
4214 " %X Time of last access as seconds since Epoch\n" \
4215 " %y Time of last modification\n" \
4216 " %Y Time of last modification as seconds since Epoch\n" \
4217 " %z Time of last change\n" \
4218 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004219 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004220 " %a Free blocks available to non-superuser\n" \
4221 " %b Total data blocks in file system\n" \
4222 " %c Total file nodes in file system\n" \
4223 " %d Free file nodes in file system\n" \
4224 " %f Free blocks in file system\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004225 IF_SELINUX( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004226 " %C Security context in selinux\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004227 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004228 " %i File System ID in hex\n" \
4229 " %l Maximum length of filenames\n" \
4230 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004231 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004232 " %S Fundamental block size (for block counts)\n" \
4233 " %t Type in hex\n" \
4234 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004235 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004236
Eric Andersenef5e8f82002-11-07 02:09:37 +00004237#define strings_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004238 "[-afo] [-n LEN] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004239#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004240 "Display printable strings in a binary file\n" \
4241 "\nOptions:" \
4242 "\n -a Scan whole file (default)" \
4243 "\n -f Precede strings with filenames" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004244 "\n -n LEN At least LEN characters form a string (default 4)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004245 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00004246
Eric Andersen7e9276b2001-02-22 01:15:47 +00004247#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004248 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004249#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004250 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004251 "and deviations from stty sane\n" \
4252 "\nOptions:" \
4253 "\n -F DEVICE Open device instead of stdin" \
4254 "\n -a Print all current settings in human-readable form" \
4255 "\n -g Print in stty-readable form" \
4256 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004257
Robert Griebl1fca5582002-06-04 20:45:46 +00004258#define su_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004259 "[OPTIONS] [-] [USERNAME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004260#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004261 "Change user id or become root\n" \
4262 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004263 "\n -p,-m Preserve environment" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004264 "\n -c CMD Command to pass to 'sh -c'" \
4265 "\n -s SH Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00004266
Eric Andersen27f64e12002-06-23 04:24:25 +00004267#define sulogin_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004268 "[-t N] [TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004269#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004270 "Single user login\n" \
4271 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004272 "\n -t N Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004273
Mike Frysinger95d3c452005-04-21 23:29:24 +00004274#define sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004275 "[-rs] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004276#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004277 "Checksum and count the blocks in a file\n" \
4278 "\nOptions:" \
4279 "\n -r Use BSD sum algorithm (1K blocks)" \
4280 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00004281
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004282#define sv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004283 "[-v] [-w SEC] CMD SERVICE_DIR..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004284#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004285 "Control services monitored by runsv supervisor.\n" \
4286 "Commands (only first character is enough):\n" \
4287 "\n" \
4288 "status: query service status\n" \
4289 "up: if service isn't running, start it. If service stops, restart it\n" \
4290 "once: like 'up', but if service stops, don't restart it\n" \
4291 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004292 " if it exists. After it stops, don't restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004293 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004294 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004295 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004296 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004297
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004298#define svlogd_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004299 "[-ttv] [-r C] [-R CHARS] [-l MATCHLEN] [-b BUFLEN] DIR..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004300#define svlogd_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004301 "Continuously read log data from stdin, optionally\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004302 "filter log messages, and write the data to one or more automatically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004303 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004304
Eric Andersen7e9276b2001-02-22 01:15:47 +00004305#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004306 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004307#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004308 "Stop swapping on DEVICE\n" \
4309 "\nOptions:" \
4310 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004311
Eric Andersen7e9276b2001-02-22 01:15:47 +00004312#define swapon_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004313 "[-a]" IF_FEATURE_SWAPON_PRI(" [-p PRI]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004314#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004315 "Start swapping on DEVICE\n" \
4316 "\nOptions:" \
4317 "\n -a Start swapping on all swap devices" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004318 IF_FEATURE_SWAPON_PRI( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004319 "\n -p PRI Set swap device priority" \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004320 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004321
Rob Landley0f34a822005-10-27 22:55:50 +00004322#define switch_root_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004323 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004324#define switch_root_full_usage "\n\n" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004325 "Free initramfs and switch to another root fs:\n" \
4326 "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n" \
4327 "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004328 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004329 "\n -c DEV Reopen stdio to DEV after switch" \
Rob Landley0f34a822005-10-27 22:55:50 +00004330
Eric Andersen7e9276b2001-02-22 01:15:47 +00004331#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004332 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004333#define sync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004334 "Write all buffered blocks to disk"
4335
4336#define fsync_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004337 "[OPTIONS] FILE..."
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004338#define fsync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004339 "Write files' buffered blocks to disk\n" \
4340 "\nOptions:" \
4341 "\n -d Avoid syncing metadata"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004342
Eric Andersenb9050282003-12-24 06:02:11 +00004343#define sysctl_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004344 "[OPTIONS] [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004345#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004346 "Configure kernel parameters at runtime\n" \
4347 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004348 "\n -n Don't print key names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004349 "\n -e Don't warn about unknown keys" \
4350 "\n -w Change sysctl setting" \
4351 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
4352 "\n -a Display all values" \
4353 "\n -A Display all values in table form" \
4354
Eric Andersen5d38f5b2005-09-12 21:42:48 +00004355#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00004356 "sysctl [-n] [-e] variable...\n" \
4357 "sysctl [-n] [-e] -w variable=value...\n" \
4358 "sysctl [-n] [-e] -a\n" \
4359 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
4360 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00004361
Eric Andersen7e9276b2001-02-22 01:15:47 +00004362#define syslogd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004363 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004364#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004365 "System logging utility.\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004366 "This version of syslogd ignores /etc/syslog.conf\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004367 "\nOptions:" \
4368 "\n -n Run in foreground" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004369 "\n -O FILE Log to given file (default:/var/log/messages)" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004370 "\n -l N Set local log level" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004371 "\n -S Smaller logging output" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004372 IF_FEATURE_ROTATE_LOGFILE( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004373 "\n -s SIZE Max size (KB) before rotate (default:200KB, 0=off)" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004374 "\n -b N N rotated logs to keep (default:1, max=99, 0=purge)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004375 IF_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004376 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
4377 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004378 IF_FEATURE_SYSLOGD_DUP( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004379 "\n -D Drop duplicates") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004380 IF_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004381 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00004382 /* NB: -Csize shouldn't have space (because size is optional) */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004383/* "\n -m MIN Minutes between MARK lines (default:20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00004384
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004385#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004386 "$ syslogd -R masterlog:514\n" \
4387 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004388
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004389#define tac_trivial_usage \
4390 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004391#define tac_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004392 "Concatenate FILEs and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004393
Eric Andersen7e9276b2001-02-22 01:15:47 +00004394#define tar_trivial_usage \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004395 "-[" IF_FEATURE_TAR_CREATE("c") "xt" IF_FEATURE_SEAMLESS_GZ("z") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004396 IF_FEATURE_SEAMLESS_BZ2("j") IF_FEATURE_SEAMLESS_LZMA("a") \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004397 IF_FEATURE_SEAMLESS_Z("Z") IF_FEATURE_TAR_NOPRESERVE_TIME("m") "vO] " \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004398 IF_FEATURE_TAR_FROM("[-X FILE] ") \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004399 "[-f TARFILE] [-C DIR] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004400#define tar_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004401 IF_FEATURE_TAR_CREATE("Create, extract, ") \
4402 IF_NOT_FEATURE_TAR_CREATE("Extract ") \
4403 "or list files from a tar file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004404 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004405 IF_FEATURE_TAR_CREATE( \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004406 "\n c Create" \
4407 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004408 "\n x Extract" \
4409 "\n t List" \
4410 "\nArchive format selection:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004411 IF_FEATURE_SEAMLESS_GZ( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004412 "\n z Filter the archive through gzip" \
4413 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004414 IF_FEATURE_SEAMLESS_BZ2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004415 "\n j Filter the archive through bzip2" \
4416 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004417 IF_FEATURE_SEAMLESS_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004418 "\n a Filter the archive through lzma" \
4419 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004420 IF_FEATURE_SEAMLESS_Z( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004421 "\n Z Filter the archive through compress" \
4422 ) \
Mikhail Gusarov0d478332010-01-19 20:22:30 +06004423 IF_FEATURE_TAR_NOPRESERVE_TIME( \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004424 "\n m Do not restore mtime" \
Mikhail Gusarov0d478332010-01-19 20:22:30 +06004425 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004426 "\nFile selection:" \
4427 "\n f Name of TARFILE or \"-\" for stdin" \
4428 "\n O Extract to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004429 IF_FEATURE_TAR_FROM( \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004430 IF_FEATURE_TAR_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004431 "\n exclude File to exclude" \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004432 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004433 "\n X File with names to exclude" \
4434 ) \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004435 "\n C Change to DIR before operation" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004436 "\n v Verbose" \
4437
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004438#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004439 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
4440 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004441
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004442#define taskset_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004443 "[-p] [MASK] [PID | PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004444#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004445 "Set or get CPU affinity\n" \
4446 "\nOptions:" \
4447 "\n -p Operate on an existing PID" \
4448
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004449#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004450 "$ taskset 0x7 ./dgemm_test&\n" \
4451 "$ taskset -p 0x1 $!\n" \
4452 "pid 4790's current affinity mask: 7\n" \
4453 "pid 4790's new affinity mask: 1\n" \
4454 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4455 "pid 6671's current affinity mask: 1\n" \
4456 "pid 6671's new affinity mask: 1\n" \
4457 "$ taskset -p 1\n" \
4458 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004459
Eric Andersen7e9276b2001-02-22 01:15:47 +00004460#define tee_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004461 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004462#define tee_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004463 "Copy stdin to each FILE, and also to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004464 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004465 "\n -a Append to the given FILEs, don't overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004466 "\n -i Ignore interrupt signals (SIGINT)" \
4467
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004468#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004469 "$ echo \"Hello\" | tee /tmp/foo\n" \
4470 "$ cat /tmp/foo\n" \
4471 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004472
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004473#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004474#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004475 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004476#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004477 "Connect to telnet server\n" \
4478 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004479 "\n -a Automatic login with $USER variable" \
4480 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004481
Eric Andersen539ffc92004-02-22 12:25:47 +00004482#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004483#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004484 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004485#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004486 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004487#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004488
Eric Andersen08a72202002-09-30 20:52:10 +00004489#define telnetd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004490 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004491#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004492 "Handle incoming telnet connections" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004493 IF_NOT_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004494 "\nOptions:" \
4495 "\n -l LOGIN Exec LOGIN on connect" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004496 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004497 "\n -K Close connection as soon as login exits" \
4498 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004499 IF_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004500 "\n -p PORT Port to listen on" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004501 "\n -b ADDR[:PORT] Address to bind to" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004502 "\n -F Run in foreground" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004503 "\n -i Inetd mode" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004504 IF_FEATURE_TELNETD_INETD_WAIT( \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004505 "\n -w SEC Inetd 'wait' mode, linger time SEC" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004506 "\n -S Log to syslog (implied by -i or without -F and -w)" \
4507 ) \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004508 )
Eric Andersen08a72202002-09-30 20:52:10 +00004509
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004510/* "test --help" does not print help (POSIX compat), only "[ --help" does.
Denys Vlasenko662078f2010-01-14 13:27:34 +01004511 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION")
4512 * Unfortunately, it screws up generated BusyBox.html. TODO. */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004513#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004514 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004515#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004516 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4517 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004518#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004519 "$ test 1 -eq 2\n" \
4520 "$ echo $?\n" \
4521 "1\n" \
4522 "$ test 1 -eq 1\n" \
4523 "$ echo $?\n" \
4524 "0\n" \
4525 "$ [ -d /etc ]\n" \
4526 "$ echo $?\n" \
4527 "0\n" \
4528 "$ [ -d /junk ]\n" \
4529 "$ echo $?\n" \
4530 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004531
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004532#define tc_trivial_usage \
4533 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
4534#define tc_full_usage "\n\n" \
4535 "OBJECT: {qdisc|class|filter}\n" \
4536 "CMD: {add|del|change|replace|show}\n" \
4537 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004538 "qdisc [ handle QHANDLE ] [ root |"IF_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004539 /* "[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4540 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4541 " QDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004542 "qdisc show [ dev STRING ]"IF_FEATURE_TC_INGRESS(" [ingress]")"\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004543 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004544 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004545 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
4546 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
4547 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004548 " [ root | classid CLASSID ] [ handle FILTERID ]\n" \
4549 " [ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004550 "filter show [ dev STRING ] [ root | parent CLASSID ]"
4551
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004552#define tcpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004553 "[-hEv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004554/* with not-implemented options: */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004555/* "[-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 +00004556#define tcpsvd_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004557 "Create TCP socket, bind to IP:PORT and listen\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004558 "for incoming connection. Run PROG for each connection.\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004559 "\n IP IP to listen on. '0' = all" \
4560 "\n PORT Port to listen on" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004561 "\n PROG ARGS Program to run" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004562 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4563 "\n -u USER[:GRP] Change to user/group after bind" \
4564 "\n -c N Handle up to N connections simultaneously" \
4565 "\n -b N Allow a backlog of approximately N TCP SYNs" \
4566 "\n -C N[:MSG] Allow only up to N connections from the same IP" \
4567 "\n New connections from this IP address are closed" \
4568 "\n immediately. MSG is written to the peer before close" \
4569 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004570 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004571 "\n -v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004572
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004573#define udpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004574 "[-hEv] [-c N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004575#define udpsvd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004576 "Create UDP socket, bind to IP:PORT and wait\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004577 "for incoming packets. Run PROG for each packet,\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004578 "redirecting all further packets with same peer ip:port to it.\n" \
4579 "\n IP IP to listen on. '0' = all" \
4580 "\n PORT Port to listen on" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004581 "\n PROG ARGS Program to run" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004582 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4583 "\n -u USER[:GRP] Change to user/group after bind" \
4584 "\n -c N Handle up to N connections simultaneously" \
4585 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004586 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004587 "\n -v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004588
Mark Whitley450736c2001-03-02 19:08:50 +00004589#define tftp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004590 "[OPTIONS] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004591#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004592 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004593 "\nOptions:" \
4594 "\n -l FILE Local FILE" \
4595 "\n -r FILE Remote FILE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004596 IF_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004597 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004598 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004599 IF_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004600 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004601 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004602 IF_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004603 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004604 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004605
4606#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004607 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004608#define tftpd_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004609 "Transfer a file on tftp client's request\n" \
Denis Vlasenko91f8f822008-10-30 23:42:37 +00004610 "\n" \
4611 "tftpd should be used as an inetd service.\n" \
4612 "tftpd's line for inetd.conf:\n" \
4613 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
4614 "It also can be ran from udpsvd:\n" \
4615 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004616 "\nOptions:" \
4617 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004618 "\n -c Allow file creation via upload" \
4619 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004620
Eric Andersenc3657422001-11-30 07:54:32 +00004621#define time_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004622 "[OPTIONS] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004623#define time_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004624 "Run PROG, display resource usage when it exits\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004625 "\nOptions:" \
4626 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004627
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004628#define timeout_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004629 "[-t SECS] [-s SIG] PROG ARGS"
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004630#define timeout_full_usage "\n\n" \
4631 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
Denis Vlasenko42404082008-11-24 13:42:24 +00004632 "Defaults: SECS: 10, SIG: TERM." \
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004633
Eric Andersen420b2082002-09-17 22:14:58 +00004634#define top_trivial_usage \
Denys Vlasenko00528822009-09-11 23:26:42 +02004635 "[-b] [-nCOUNT] [-dSECONDS]" IF_FEATURE_TOPMEM(" [-m]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004636#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004637 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004638 "Read the status of all processes from /proc each SECONDS\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004639 "and display a screenful of them." \
4640//TODO: add options and keyboard commands
Eric Andersen420b2082002-09-17 22:14:58 +00004641
Eric Andersen7e9276b2001-02-22 01:15:47 +00004642#define touch_trivial_usage \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004643 "[-c] [-d DATE] FILE [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004644#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004645 "Update the last-modified date on the given FILE[s]\n" \
4646 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004647 "\n -c Don't create files" \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004648 "\n -d DT Date/time to use" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004649
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004650#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004651 "$ ls -l /tmp/foo\n" \
4652 "/bin/ls: /tmp/foo: No such file or directory\n" \
4653 "$ touch /tmp/foo\n" \
4654 "$ ls -l /tmp/foo\n" \
4655 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004656
4657#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004658 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004659#define tr_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004660 "Translate, squeeze, or delete characters from stdin, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004661 "\nOptions:" \
4662 "\n -c Take complement of STRING1" \
4663 "\n -d Delete input characters coded STRING1" \
4664 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4665
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004666#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004667 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4668 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004669
Eric Andersen5c58d282001-07-10 16:29:00 +00004670#define traceroute_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004671 "[-"IF_TRACEROUTE6("46")"FIldnrv] [-f 1ST_TTL] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
4672 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-g GATEWAY] [-i IFACE]\n" \
4673 " [-z PAUSE_MSEC] HOST [BYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004674#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004675 "Trace the route to HOST\n" \
4676 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004677 IF_TRACEROUTE6( \
4678 "\n -4, -6 Force IP or IPv6 name resolution" \
4679 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004680 "\n -F Set the don't fragment bit" \
4681 "\n -I Use ICMP ECHO instead of UDP datagrams" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004682 "\n -l Display the TTL value of the returned packet" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004683 "\n -d Set SO_DEBUG options to socket" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004684 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004685 "\n -r Bypass routing tables, send directly to HOST" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004686 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004687 "\n -m Max time-to-live (max number of hops)" \
4688 "\n -p Base UDP port number used in probes" \
4689 "\n (default 33434)" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004690 "\n -q Number of probes per TTL (default 3)" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004691 "\n -s IP address to use as the source address" \
4692 "\n -t Type-of-service in probe packets (default 0)" \
4693 "\n -w Time in seconds to wait for a response (default 3)" \
4694 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004695
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004696#define traceroute6_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004697 "[-dnrv] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
4698 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-i IFACE]\n" \
4699 " HOST [BYTES]"
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004700#define traceroute6_full_usage "\n\n" \
4701 "Trace the route to HOST\n" \
4702 "\nOptions:" \
4703 "\n -d Set SO_DEBUG options to socket" \
4704 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004705 "\n -r Bypass routing tables, send directly to HOST" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004706 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004707 "\n -m Max time-to-live (max number of hops)" \
4708 "\n -p Base UDP port number used in probes" \
4709 "\n (default is 33434)" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004710 "\n -q Number of probes per TTL (default 3)" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004711 "\n -s IP address to use as the source address" \
4712 "\n -t Type-of-service in probe packets (default 0)" \
4713 "\n -w Time in seconds to wait for a response (default 3)" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004714
Eric Andersen7e9276b2001-02-22 01:15:47 +00004715#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004716 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004717#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004718 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004719#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004720 "$ true\n" \
4721 "$ echo $?\n" \
4722 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004723
Eric Andersen7e9276b2001-02-22 01:15:47 +00004724#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004725 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004726#define tty_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004727 "Print file name of stdin's terminal" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004728 IF_INCLUDE_SUSv2( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004729 "\nOptions:" \
4730 "\n -s Print nothing, only return exit status" \
4731 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004732#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004733 "$ tty\n" \
4734 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004735
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004736#define ttysize_trivial_usage \
4737 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004738#define ttysize_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004739 "Print dimension(s) of stdin's terminal, on error return 80x25"
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004740
Denis Vlasenko39b68132009-01-23 02:07:14 +00004741#define tunctl_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004742 "[-f device] ([-t name] | -d name)" IF_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]")
Denis Vlasenko39b68132009-01-23 02:07:14 +00004743#define tunctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004744 "Create or delete tun interfaces\n" \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004745 "\nOptions:" \
4746 "\n -f name tun device (/dev/net/tun)" \
4747 "\n -t name Create iface 'name'" \
4748 "\n -d name Delete iface 'name'" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004749 IF_FEATURE_TUNCTL_UG( \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004750 "\n -u owner Set iface owner" \
4751 "\n -g group Set iface group" \
4752 "\n -b Brief output" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004753 )
Denis Vlasenko39b68132009-01-23 02:07:14 +00004754#define tunctl_example_usage \
4755 "# tunctl\n" \
4756 "# tunctl -d tun0\n"
4757
Mike Frysinger174808c2005-06-11 01:14:09 +00004758#define tune2fs_trivial_usage \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004759/* "[-c max-mounts-count] [-e errors-behavior] [-g group] " */ \
4760/* "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " */ \
4761/* "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " */ \
4762/* "[-r reserved-blocks-count] [-u user] [-C mount-count] " */ \
4763 "[-L LABEL] " \
4764/* "[-M last-mounted-dir] [-O [^]feature[,...]] " */ \
4765/* "[-T last-check-time] [-U UUID] " */ \
4766 "BLOCKDEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004767#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004768 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004769
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004770#define udhcpc_trivial_usage \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004771 "[-fbnqvoCR] [-i IFACE] [-r IP] [-s PROG] [-p PIDFILE]\n" \
4772 " [-H HOSTNAME] [-c CID] [-V VENDOR] [-O DHCP_OPT]..." IF_FEATURE_UDHCP_PORT(" [-P N]")
4773#define udhcpc_full_usage "\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004774 IF_LONG_OPTS( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004775 "\n -i,--interface IFACE Interface to use (default eth0)" \
4776 "\n -p,--pidfile FILE Create pidfile" \
4777 "\n -r,--request IP IP address to request" \
4778 "\n -s,--script PROG Run PROG at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
4779 "\n -t,--retries N Send up to N discover packets" \
4780 "\n -T,--timeout N Pause between packets (default 3 seconds)" \
Denys Vlasenkoe6080a42010-04-14 14:04:26 -07004781 "\n -A,--tryagain N Wait N seconds after failure (default 20)" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004782 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004783 USE_FOR_MMU( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004784 "\n -b,--background Background if lease is not obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004785 ) \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004786 "\n -S,--syslog Log to syslog too" \
4787 "\n -n,--now Exit if lease is not obtained" \
4788 "\n -q,--quit Exit after obtaining lease" \
4789 "\n -R,--release Release IP on exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004790 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004791 "\n -P,--client-port N Use port N (default 68)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004792 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004793 IF_FEATURE_UDHCPC_ARPING( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004794 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004795 ) \
Denys Vlasenkoe6080a42010-04-14 14:04:26 -07004796 "\n -O,--request-option OPT Request DHCP option OPT (cumulative)" \
4797 "\n -o,--no-default-options Don't request any options (unless -O is given)" \
4798 "\n -x OPT:VAL Include option OPT in sent packets (cumulative)" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004799 "\n -F,--fqdn NAME Ask server to update DNS mapping for NAME" \
4800 "\n -H,-h,--hostname NAME Send NAME as client hostname (default none)" \
4801 "\n -V,--vendorclass VENDOR Vendor identifier (default 'udhcp VERSION')" \
4802 "\n -c,--clientid CLIENTID Client identifier (default own MAC)" \
4803 "\n -C,--clientid-none Don't send client identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004804 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004805 IF_NOT_LONG_OPTS( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004806 "\n -i IFACE Interface to use (default eth0)" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +01004807 "\n -p FILE Create pidfile" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004808 "\n -r IP IP address to request" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004809 "\n -s PROG Run PROG at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
4810 "\n -t N Send up to N discover packets" \
4811 "\n -T N Pause between packets (default 3 seconds)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004812 "\n -A N Wait N seconds (default 20) after failure" \
Denys Vlasenko7e6add12010-03-25 20:32:38 +01004813 "\n -x OPT:VAL Include option OPT in sent packets" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004814 "\n -O OPT Request DHCP option OPT (cumulative)" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004815 "\n -o Don't request any options (unless -O is given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004816 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004817 USE_FOR_MMU( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004818 "\n -b Background if lease is not obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004819 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004820 "\n -S Log to syslog too" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004821 "\n -n Exit if lease is not obtained" \
4822 "\n -q Exit after obtaining lease" \
4823 "\n -R Release IP on exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004824 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004825 "\n -P N Use port N (default 68)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004826 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004827 IF_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004828 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004829 ) \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004830 "\n -F NAME Ask server to update DNS mapping for NAME" \
4831 "\n -H,-h NAME Send NAME as client hostname (default none)" \
4832 "\n -V VENDOR Vendor identifier (default 'udhcp VERSION')" \
4833 "\n -c CLIENTID Client identifier (default own MAC)" \
4834 "\n -C Don't send client identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004835 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004836
Russ Dill61fb4892002-10-14 21:41:28 +00004837#define udhcpd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004838 "[-fS]" IF_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004839
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004840#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004841 "DHCP server\n" \
4842 "\n -f Run in foreground" \
4843 "\n -S Log to syslog too" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004844 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004845 "\n -P N Use port N (default 67)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004846 )
Russ Dill61fb4892002-10-14 21:41:28 +00004847
Eric Andersen7e9276b2001-02-22 01:15:47 +00004848#define umount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004849 "[OPTIONS] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004850#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004851 "Unmount file systems\n" \
4852 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004853 IF_FEATURE_UMOUNT_ALL( \
4854 "\n -a Unmount all file systems" IF_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004855 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004856 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004857 "\n -n Don't erase /etc/mtab entries" \
4858 ) \
4859 "\n -r Try to remount devices as read-only if mount is busy" \
4860 "\n -l Lazy umount (detach filesystem)" \
4861 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004862 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004863 "\n -d Free loop device if it has been used" \
4864 )
4865
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004866#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004867 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004868
4869#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004870 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004871#define uname_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004872 "Print system information\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004873 "\nOptions:" \
4874 "\n -a Print all" \
4875 "\n -m The machine (hardware) type" \
4876 "\n -n Hostname" \
4877 "\n -r OS release" \
4878 "\n -s OS name (default)" \
4879 "\n -p Processor type" \
4880 "\n -v OS version" \
4881
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004882#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004883 "$ uname -a\n" \
4884 "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 +00004885
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004886#define uncompress_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004887 "[-cf] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004888#define uncompress_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02004889 "Decompress .Z file[s]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004890 "\nOptions:" \
Denys Vlasenkoa3581402010-05-27 02:30:04 +02004891 "\n -c Write to stdout" \
4892 "\n -f Overwrite" \
Tim Riker7b253f82003-12-28 05:02:40 +00004893
Denis Vlasenko3952f202007-08-13 14:10:24 +00004894#define unexpand_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004895 "[-fa][-t N] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004896#define unexpand_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004897 "Convert spaces to tabs, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004898 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004899 IF_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004900 "\n -a,--all Convert all blanks" \
4901 "\n -f,--first-only Convert only leading blanks" \
4902 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004903 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004904 IF_NOT_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004905 "\n -a Convert all blanks" \
4906 "\n -f Convert only leading blanks" \
4907 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004908 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004909
Eric Andersen7e9276b2001-02-22 01:15:47 +00004910#define uniq_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004911 "[-cdu][-f,s,w N] [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004912#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004913 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004914 "\nOptions:" \
4915 "\n -c Prefix lines by the number of occurrences" \
4916 "\n -d Only print duplicate lines" \
4917 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004918 "\n -f N Skip first N fields" \
4919 "\n -s N Skip first N chars (after any skipped fields)" \
4920 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004921
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004922#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004923 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4924 "a\n" \
4925 "b\n" \
4926 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004927
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004928#define unzip_trivial_usage \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004929 "[-opts[modifiers]] FILE[.zip] [LIST] [-x XLIST] [-d DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004930#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004931 "Extract files from ZIP archives\n" \
4932 "\nOptions:" \
4933 "\n -l List archive contents (with -q for short form)" \
Denys Vlasenkoa3581402010-05-27 02:30:04 +02004934 "\n -n Never overwrite files (default)" \
4935 "\n -o Overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004936 "\n -p Send output to stdout" \
4937 "\n -q Quiet" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01004938 "\n -x XLST Exclude these files" \
4939 "\n -d DIR Extract files into DIR" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004940
Eric Andersen7e9276b2001-02-22 01:15:47 +00004941#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004942 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004943#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004944 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004945
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004946#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004947 "$ uptime\n" \
4948 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004949
4950#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004951 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004952#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004953 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004954
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004955#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004956 "$ usleep 1000000\n" \
4957 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004958
4959#define uudecode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004960 "[-o OUTFILE] [INFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004961#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004962 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004963 "Finds outfile name in uuencoded source unless -o is given"
4964
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004965#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004966 "$ uudecode -o busybox busybox.uu\n" \
4967 "$ ls -l busybox\n" \
4968 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004969
4970#define uuencode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004971 "[-m] [INFILE] STORED_FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004972#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004973 "Uuencode a file to stdout\n" \
4974 "\nOptions:" \
4975 "\n -m Use base64 encoding per RFC1521" \
4976
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004977#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004978 "$ uuencode busybox busybox\n" \
4979 "begin 755 busybox\n" \
4980 "<encoded file snipped>\n" \
4981 "$ uudecode busybox busybox > busybox.uu\n" \
4982 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004983
Eric Andersen853c4942003-01-23 05:59:32 +00004984#define vconfig_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004985 "COMMAND [OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004986#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004987 "Create and remove virtual ethernet devices\n" \
4988 "\nOptions:" \
4989 "\n add [interface-name] [vlan_id]" \
4990 "\n rem [vlan-name]" \
4991 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4992 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4993 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4994 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004995
Eric Andersen3f980402001-04-04 17:31:15 +00004996#define vi_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004997 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004998#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004999 "Edit FILE\n" \
5000 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005001 IF_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00005002 "\n -c Initial command to run ($EXINIT also available)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005003 IF_FEATURE_VI_READONLY( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01005004 "\n -R Read-only") \
Denis Vlasenko397de612008-03-17 08:55:44 +00005005 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00005006
Eric Andersen27f64e12002-06-23 04:24:25 +00005007#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005008 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005009#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005010 "Lock a virtual terminal. A password is required to unlock.\n" \
5011 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00005012 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00005013
Matthew Stoltenberg4803db52009-08-13 00:59:32 +02005014#define volname_trivial_usage \
5015 "[DEVICE]"
5016#define volname_full_usage "\n\n" \
5017 "Show CD volume name of the DEVICE (default /dev/cdrom)"
5018
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005019#define wall_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01005020 "[FILE]"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005021#define wall_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01005022 "Write content of FILE or stdin to all logged-in users"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005023#define wall_sample_usage \
5024 "echo foo | wall\n" \
5025 "wall ./mymessage"
5026
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005027#define watch_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01005028 "[-n SEC] [-t] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005029#define watch_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005030 "Run PROG periodically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005031 "\nOptions:" \
5032 "\n -n Loop period in seconds (default 2)" \
5033 "\n -t Don't print header" \
5034
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005035#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005036 "$ watch date\n" \
5037 "Mon Dec 17 10:31:40 GMT 2000\n" \
5038 "Mon Dec 17 10:31:42 GMT 2000\n" \
5039 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005040
Eric Andersen7e9276b2001-02-22 01:15:47 +00005041#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005042 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005043#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005044 "Periodically write to watchdog device DEV\n" \
5045 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005046 "\n -T N Reboot after N seconds if not reset (default 60)" \
5047 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00005048 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00005049 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005050 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005051
5052#define wc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005053 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005054#define wc_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01005055 "Print line, word, and byte counts for each FILE (or stdin),\n" \
5056 "and a total line if more than one FILE is specified\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005057 "\nOptions:" \
5058 "\n -c Print the byte counts" \
5059 "\n -l Print the newline counts" \
5060 "\n -L Print the length of the longest line" \
5061 "\n -w Print the word counts" \
5062
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005063#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005064 "$ wc /etc/passwd\n" \
5065 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005066
5067#define wget_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005068 IF_FEATURE_WGET_LONG_OPTIONS( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005069 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document FILE]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00005070 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005071 " [--no-check-certificate] [-U|--user-agent AGENT] URL" \
Denis Vlasenko03630782007-10-18 11:11:12 +00005072 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005073 IF_NOT_FEATURE_WGET_LONG_OPTIONS( \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005074 "[-csq] [-O FILE] [-Y on/off] [-P DIR] [-U AGENT] URL" \
Denis Vlasenko03630782007-10-18 11:11:12 +00005075 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005076#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005077 "Retrieve files via HTTP or FTP\n" \
5078 "\nOptions:" \
5079 "\n -s Spider mode - only check file existence" \
5080 "\n -c Continue retrieval of aborted transfer" \
5081 "\n -q Quiet" \
5082 "\n -P Set directory prefix to DIR" \
Denys Vlasenko4816fe92010-03-28 00:30:35 +01005083 "\n -O FILE Save to FILE ('-' for stdout)" \
5084 "\n -U STR Use STR for User-Agent header" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005085 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005086
5087#define which_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005088 "[COMMAND]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005089#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005090 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005091#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005092 "$ which login\n" \
5093 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00005094
Eric Andersen00a6a752002-04-26 23:53:10 +00005095#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00005096 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005097#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005098 "Show who is logged on\n" \
5099 "\nOptions:" \
Denys Vlasenko838e0db2010-06-07 03:04:46 +02005100 "\n -a Show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005101
5102#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005103 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005104#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005105 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005106
5107#define xargs_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01005108 "[OPTIONS] [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005109#define xargs_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01005110 "Run PROG on every item given by stdin\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005111 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005112 IF_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005113 "\n -p Ask user whether to run each command") \
Denys Vlasenko07697852009-10-06 21:11:37 +02005114 "\n -r Don't run command if input is empty" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005115 IF_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005116 "\n -0 Input is separated by NUL characters") \
5117 "\n -t Print the command on stderr before execution" \
Denis Vlasenkoe82da4d2008-08-21 19:59:30 +00005118 "\n -e[STR] STR stops input processing" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005119 "\n -n N Pass no more than N args to PROG" \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005120 "\n -s N Pass command line of no more than N bytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005121 IF_FEATURE_XARGS_SUPPORT_TERMOPT( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005122 "\n -x Exit if size is exceeded") \
Denis Vlasenko397de612008-03-17 08:55:44 +00005123
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005124#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005125 "$ ls | xargs gzip\n" \
5126 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005127
Eric Andersen7e9276b2001-02-22 01:15:47 +00005128#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005129 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005130#define zcat_full_usage "\n\n" \
Denys Vlasenkoccb88a62010-05-27 02:22:54 +02005131 "Decompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00005132
Rob Landleyad8071f2005-04-30 03:49:37 +00005133#define zcip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005134 "[OPTIONS] IFACE SCRIPT"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005135#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005136 "Manage a ZeroConf IPv4 link-local address\n" \
5137 "\nOptions:" \
5138 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00005139 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005140 "\n -r 169.254.x.x Request this address first" \
5141 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00005142 "\n" \
5143 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
5144 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00005145
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00005146
5147#endif