blob: 109a35d058796d776471adf008edc9fc6ee2d1be [file] [log] [blame]
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001/* vi: set sw=8 ts=8: */
Denis Vlasenkoe2d3ded2006-11-27 23:43:28 +00002/*
3 * This file suffers from chronically incorrect tabification
4 * of messages. Before editing this file:
5 * 1. Switch you editor to 8-space tab mode.
6 * 2. Do not use \t in messages, use real tab character.
7 * 3. Start each source line with message as follows:
Denis Vlasenko1fffe382006-11-28 00:06:39 +00008 * |<7 spaces>"text with tabs"....
Denis Vlasenkocdf62772008-03-17 08:42:43 +00009 * or
10 * |<5 spaces>"\ntext with tabs"....
Denis Vlasenkoe2d3ded2006-11-27 23:43:28 +000011 */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +000012#ifndef BB_USAGE_H
13#define BB_USAGE_H 1
Eric Andersen178de172004-04-06 16:36:20 +000014
Denis Vlasenko4f98e192008-04-13 22:12:19 +000015
16#define NOUSAGE_STR "\b"
17
Denis Vlasenkod16950d2008-11-29 09:05:50 +000018#define acpid_trivial_usage \
19 "[-d] [-c CONFDIR] [-l LOGFILE] [-e PROC_EVENT_FILE] [EVDEV_EVENT_FILE...]"
Denis Vlasenkod16950d2008-11-29 09:05:50 +000020#define acpid_full_usage "\n\n" \
21 "Listen to ACPI events and spawn specific helpers on event arrival\n" \
22 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +020023 "\n -d Don't daemonize, log to stderr" \
Denis Vlasenkod16950d2008-11-29 09:05:50 +000024 "\n -c DIR Config directory [/etc/acpi]" \
25 "\n -e FILE /proc event file [/proc/acpi/event]" \
26 "\n -l FILE Log file [/var/log/acpid]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +000027 IF_FEATURE_ACPID_COMPAT( \
Denis Vlasenkod16950d2008-11-29 09:05:50 +000028 "\n\nAccept and ignore compatibility options -g -m -s -S -v" \
29 )
30
31#define acpid_example_usage \
32 "# acpid -l /var/log/my-acpi-log\n" \
33 "# acpid -d /dev/input/event*\n"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000034
Eric Andersenf349e972001-08-21 16:18:59 +000035#define addgroup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +000036 "[-g GID] " IF_FEATURE_ADDUSER_TO_GROUP("[user_name] ") "group_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000037#define addgroup_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +000038 "Add a group " IF_FEATURE_ADDUSER_TO_GROUP("or add a user to a group") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000039 "\nOptions:" \
Denis Vlasenko4f98e192008-04-13 22:12:19 +000040 "\n -g GID Group id" \
Denis Vlasenkoc2931aa2009-04-22 21:35:52 +000041 "\n -S Create a system group" \
Eric Andersenf349e972001-08-21 16:18:59 +000042
43#define adduser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000044 "[OPTIONS] user_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000045#define adduser_full_usage "\n\n" \
Denis Vlasenko73ac0562008-12-25 01:01:23 +000046 "Add a user\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000047 "\nOptions:" \
48 "\n -h DIR Home directory" \
49 "\n -g GECOS GECOS field" \
50 "\n -s SHELL Login shell" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +020051 "\n -G GRP Add user to existing group" \
Denis Vlasenko397de612008-03-17 08:55:44 +000052 "\n -S Create a system user" \
Denys Vlasenko07697852009-10-06 21:11:37 +020053 "\n -D Don't assign a password" \
54 "\n -H Don't create home directory" \
Denis Vlasenkoc2931aa2009-04-22 21:35:52 +000055 "\n -u UID User id" \
Eric Andersenf349e972001-08-21 16:18:59 +000056
Mark Whitley6f932772001-03-20 19:18:10 +000057#define adjtimex_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000058 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000059#define adjtimex_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000060 "Read and optionally set system timebase parameters. See adjtimex(2).\n" \
61 "\nOptions:" \
62 "\n -q Quiet" \
63 "\n -o offset Time offset, microseconds" \
64 "\n -f frequency Frequency adjust, integer kernel units (65536 is 1ppm)" \
65 "\n (positive values make clock run faster)" \
66 "\n -t tick Microseconds per tick, usually 10000" \
67 "\n -p timeconstant" \
Mark Whitley6f932772001-03-20 19:18:10 +000068
Eric Andersen7e9276b2001-02-22 01:15:47 +000069#define ar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000070 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000071#define ar_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000072 "Extract or list FILES from an ar archive\n" \
73 "\nOptions:" \
74 "\n -o Preserve original dates" \
75 "\n -p Extract to stdout" \
76 "\n -t List" \
77 "\n -x Extract" \
78 "\n -v Verbose" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000079
Denis Vlasenkofa85b862007-01-07 01:24:12 +000080#define arp_trivial_usage \
Denis Vlasenko4d476922008-11-13 00:05:17 +000081 "\n[-vn] [-H type] [-i if] -a [hostname]" \
82 "\n[-v] [-i if] -d hostname [pub]" \
83 "\n[-v] [-H type] [-i if] -s hostname hw_addr [temp]" \
84 "\n[-v] [-H type] [-i if] -s hostname hw_addr [netmask nm] pub" \
85 "\n[-v] [-H type] [-i if] -Ds hostname ifa [netmask nm] pub"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000086#define arp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000087 "Manipulate ARP cache\n" \
88 "\nOptions:" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000089 "\n -a Display (all) hosts" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000090 "\n -s Set new ARP entry" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000091 "\n -d Delete a specified entry" \
92 "\n -v Verbose" \
93 "\n -n Don't resolve names" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000094 "\n -i IF Network interface" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000095 "\n -D Read <hwaddr> from given device" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000096 "\n -A, -p AF Protocol family" \
Denis Vlasenko397de612008-03-17 08:55:44 +000097 "\n -H HWTYPE Hardware address type" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000098
Glenn L McGrath9e598412003-01-09 10:06:01 +000099#define arping_trivial_usage \
Denis Vlasenkof23c3f92007-11-23 09:27:05 +0000100 "[-fqbDUA] [-c count] [-w timeout] [-I dev] [-s sender] target"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000101#define arping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000102 "Send ARP requests/replies\n" \
103 "\nOptions:" \
104 "\n -f Quit on first ARP reply" \
105 "\n -q Quiet" \
106 "\n -b Keep broadcasting, don't go unicast" \
107 "\n -D Duplicated address detection mode" \
108 "\n -U Unsolicited ARP mode, update your neighbors" \
109 "\n -A ARP answer mode, update your neighbors" \
110 "\n -c N Stop after sending N ARP requests" \
111 "\n -w timeout Time to wait for ARP reply, in seconds" \
112 "\n -I dev Interface to use (default eth0)" \
113 "\n -s sender Sender IP address" \
114 "\n target Target IP address" \
Glenn L McGrath9e598412003-01-09 10:06:01 +0000115
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000116#define sh_trivial_usage NOUSAGE_STR
117#define sh_full_usage ""
118#define ash_trivial_usage NOUSAGE_STR
119#define ash_full_usage ""
120#define hush_trivial_usage NOUSAGE_STR
121#define hush_full_usage ""
Denys Vlasenko1cc4b132009-08-21 00:05:51 +0200122#define lash_trivial_usage NOUSAGE_STR
123#define lash_full_usage ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000124#define msh_trivial_usage NOUSAGE_STR
125#define msh_full_usage ""
Eric Andersen08f59e32004-03-12 22:07:10 +0000126
127#define awk_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200128 "[OPTIONS] [AWK_PROGRAM] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000129#define awk_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000130 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200131 "\n -v VAR=VAL Set variable" \
132 "\n -F SEP Use SEP as field separator" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +0100133 "\n -f FILE Read program from FILE" \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +0000134
Eric Andersen7e9276b2001-02-22 01:15:47 +0000135#define basename_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000136 "FILE [SUFFIX]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000137#define basename_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200138 "Strip directory path and .SUFFIX from FILE\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000139#define basename_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000140 "$ basename /usr/local/bin/foo\n" \
141 "foo\n" \
142 "$ basename /usr/local/bin/\n" \
143 "bin\n" \
144 "$ basename /foo/bar.txt .txt\n" \
145 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000146
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200147#define beep_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100148 "-f FREQ -l LEN -d DELAY -r COUNT -n"
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200149#define beep_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +0200150 "Options:" \
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200151 "\n -f Frequency in Hz" \
152 "\n -l Length in ms" \
153 "\n -d Delay in ms" \
154 "\n -r Repetitions" \
155 "\n -n Start new tone" \
156
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000157#define fbsplash_trivial_usage \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000158 "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000159#define fbsplash_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +0200160 "Options:" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000161 "\n -s Image" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000162 "\n -c Hide cursor" \
163 "\n -d Framebuffer device (default /dev/fb0)" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000164 "\n -i Config file (var=value):" \
165 "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT" \
166 "\n BAR_R,BAR_G,BAR_B" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000167 "\n -f Control pipe (else exit after drawing image)" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000168 "\n commands: 'NN' (% for progress bar) or 'exit'" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000169
Bernhard Reutner-Fischerd27d9252008-01-13 15:23:27 +0000170#define brctl_trivial_usage \
171 "COMMAND [BRIDGE [INTERFACE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000172#define brctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200173 "Manage ethernet bridges\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000174 "\nCommands:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000175 IF_FEATURE_BRCTL_SHOW( \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000176 "\n show Show a list of bridges" \
177 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000178 "\n addbr BRIDGE Create BRIDGE" \
179 "\n delbr BRIDGE Delete BRIDGE" \
180 "\n addif BRIDGE IFACE Add IFACE to BRIDGE" \
181 "\n delif BRIDGE IFACE Delete IFACE from BRIDGE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000182 IF_FEATURE_BRCTL_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000183 "\n setageing BRIDGE TIME Set ageing time" \
184 "\n setfd BRIDGE TIME Set bridge forward delay" \
185 "\n sethello BRIDGE TIME Set hello time" \
186 "\n setmaxage BRIDGE TIME Set max message age" \
187 "\n setpathcost BRIDGE COST Set path cost" \
188 "\n setportprio BRIDGE PRIO Set port priority" \
189 "\n setbridgeprio BRIDGE PRIO Set bridge priority" \
190 "\n stp BRIDGE [1|0] STP on/off" \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000191 ) \
192
Glenn L McGrath24e28332001-10-05 03:48:57 +0000193#define bunzip2_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200194 "[OPTIONS] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000195#define bunzip2_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +0200196 "Uncompress FILE (or standard input)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000197 "\nOptions:" \
198 "\n -c Write to standard output" \
199 "\n -f Force" \
Glenn L McGrath24e28332001-10-05 03:48:57 +0000200
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000201#define bzip2_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200202 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000203#define bzip2_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +0200204 "Compress FILEs (or standard input) with bzip2 algorithm.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000205 "\nOptions:" \
206 "\n -c Write to standard output" \
207 "\n -d Decompress" \
208 "\n -f Force" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000209 "\n -1..-9 Compression level" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000210
Rob Landley6130b9b2006-01-23 21:10:38 +0000211#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000212 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000213
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000214#define lzop_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200215 "[-cfvd123456789CF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000216#define lzop_full_usage "\n\n" \
217 " -c Write to standard output" \
218 "\n -f Force" \
219 "\n -v Verbose" \
220 "\n -d Decompress" \
221 "\n -F Don't store or verify checksum" \
222 "\n -C Also write checksum of compressed block" \
223 "\n -1..9 Compression level" \
224
225#define lzopcat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200226 "[-vCF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000227#define lzopcat_full_usage "\n\n" \
228 " -v Verbose" \
229 "\n -F Don't store or verify checksum" \
230
231#define unlzop_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200232 "[-cfvCF] [FILE]..."
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000233#define unlzop_full_usage "\n\n" \
234 " -c Write to standard output" \
235 "\n -f Force" \
236 "\n -v Verbose" \
237 "\n -F Don't store or verify checksum" \
238
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000239#define bzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000240 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000241#define bzcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000242 "Uncompress to stdout"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000243
Rob Landleyc1d69902006-01-20 18:28:50 +0000244#define unlzma_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200245 "[OPTIONS] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000246#define unlzma_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +0200247 "Uncompress FILE (or standard input)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000248 "\nOptions:" \
249 "\n -c Write to standard output" \
250 "\n -f Force" \
Rob Landleyc1d69902006-01-20 18:28:50 +0000251
252#define lzmacat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000253 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000254#define lzmacat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000255 "Uncompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000256
Eric Andersenc98c0622001-12-06 15:16:43 +0000257#define cal_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000258 "[-jy] [[month] year]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000259#define cal_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000260 "Display a calendar\n" \
261 "\nOptions:" \
262 "\n -j Use julian dates" \
263 "\n -y Display the entire year" \
Eric Andersenc98c0622001-12-06 15:16:43 +0000264
Eric Andersen7e9276b2001-02-22 01:15:47 +0000265#define cat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000266 "[-u] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000267#define cat_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +0200268 "Concatenate FILEs and print them to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000269 "\nOptions:" \
270 "\n -u Use unbuffered i/o (ignored)" \
271
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000272#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000273 "$ cat /proc/uptime\n" \
274 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000275
Rob Landley8abbee42006-05-31 19:36:04 +0000276#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000277 "[-etv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000278#define catv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000279 "Display nonprinting characters as ^x or M-x\n" \
280 "\nOptions:" \
281 "\n -e End each line with $" \
282 "\n -t Show tabs as ^I" \
283 "\n -v Don't use ^x or M-x escapes" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000284
285#define chat_trivial_usage \
286 "EXPECT [SEND [EXPECT [SEND...]]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000287#define chat_full_usage "\n\n" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000288 "Useful for interacting with a modem connected to stdin/stdout.\n" \
289 "A script consists of one or more \"expect-send\" pairs of strings,\n" \
290 "each pair is a pair of arguments. Example:\n" \
291 "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \
292
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000293#define chattr_trivial_usage \
Denys Vlasenko79ae5342010-01-06 12:27:18 +0100294 "[-R] [-+=AacDdijsStTu] [-v VERSION] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000295#define chattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000296 "Change file attributes on an ext2 fs\n" \
297 "\nModifiers:" \
298 "\n - Remove attributes" \
299 "\n + Add attributes" \
300 "\n = Set attributes" \
301 "\nAttributes:" \
302 "\n A Don't track atime" \
303 "\n a Append mode only" \
304 "\n c Enable compress" \
305 "\n D Write dir contents synchronously" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200306 "\n d Don't backup with dump" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000307 "\n i Cannot be modified (immutable)" \
308 "\n j Write all data to journal first" \
309 "\n s Zero disk storage when deleted" \
310 "\n S Write file contents synchronously" \
311 "\n t Disable tail-merging of partial blocks with other files" \
312 "\n u Allow file to be undeleted" \
313 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100314 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000315 "\n -v Set the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000316
Denis Vlasenko49622d72007-03-10 16:58:49 +0000317#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000318 "[OPTIONS] CONTEXT FILE..." \
319 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000320 IF_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000321 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
322 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000323#define chcon_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000324 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000325 IF_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000326 "\n -v,--verbose Verbose" \
327 "\n -c,--changes Report changes made" \
328 "\n -h,--no-dereference Affect symlinks instead of their targets" \
329 "\n -f,--silent,--quiet Suppress most error messages" \
330 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
331 "\n -u,--user=USER Set user/role/type/range in the target" \
332 "\n -r,--role=ROLE security context" \
333 "\n -t,--type=TYPE" \
334 "\n -l,--range=RANGE" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200335 "\n -R,--recursive Recurse" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000336 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000337 IF_NOT_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000338 "\n -v Verbose" \
339 "\n -c Report changes made" \
340 "\n -h Affect symlinks instead of their targets" \
341 "\n -f Suppress most error messages" \
342 "\n -u USER Set user/role/type/range in the target security context" \
343 "\n -r ROLE" \
344 "\n -t TYPE" \
345 "\n -l RNG" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200346 "\n -R Recurse" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000347 )
348
Eric Andersen7e9276b2001-02-22 01:15:47 +0000349#define chmod_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000350 "[-R"IF_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000351#define chmod_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000352 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000353 "symbols +-= and one or more of the letters rwxst\n" \
354 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200355 "\n -R Recurse" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000356 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000357 "\n -c List changed files" \
358 "\n -v List all files" \
359 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000360 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000361#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000362 "$ ls -l /tmp/foo\n" \
363 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
364 "$ chmod u+x /tmp/foo\n" \
365 "$ ls -l /tmp/foo\n" \
366 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
367 "$ chmod 444 /tmp/foo\n" \
368 "$ ls -l /tmp/foo\n" \
369 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000370
Denis Vlasenko081ef792007-03-17 16:38:21 +0000371#define chgrp_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000372 "[-RhLHP"IF_DESKTOP("cvf")"]... GROUP FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000373#define chgrp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000374 "Change the group membership of each FILE to GROUP\n" \
375 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200376 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000377 "\n -h Affect symlinks instead of symlink targets" \
378 "\n -L Traverse all symlinks to directories" \
379 "\n -H Traverse symlinks on command line only" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200380 "\n -P Don't traverse symlinks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000381 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000382 "\n -c List changed files" \
383 "\n -v Verbose" \
384 "\n -f Hide errors" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000385 )
386#define chgrp_example_usage \
387 "$ ls -l /tmp/foo\n" \
388 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
389 "$ chgrp root /tmp/foo\n" \
390 "$ ls -l /tmp/foo\n" \
391 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
392
Eric Andersen7e9276b2001-02-22 01:15:47 +0000393#define chown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000394 "[-RhLHP"IF_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000395#define chown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000396 "Change the owner and/or group of each FILE to OWNER and/or GROUP\n" \
397 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200398 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000399 "\n -h Affect symlinks instead of symlink targets" \
400 "\n -L Traverse all symlinks to directories" \
401 "\n -H Traverse symlinks on command line only" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200402 "\n -P Don't traverse symlinks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000403 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000404 "\n -c List changed files" \
405 "\n -v List all files" \
406 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000407 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000408#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000409 "$ ls -l /tmp/foo\n" \
410 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
411 "$ chown root /tmp/foo\n" \
412 "$ ls -l /tmp/foo\n" \
413 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
414 "$ chown root.root /tmp/foo\n" \
415 "ls -l /tmp/foo\n" \
416 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000417
Denis Vlasenkofe544582006-10-03 15:57:40 +0000418#define chpst_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000419 "[-vP012] [-u USER[:GRP]] [-U USER[:GRP]] [-e DIR]\n" \
420 " [-/ DIR] [-n NICE] [-m BYTES] [-d BYTES] [-o N]\n" \
421 " [-p N] [-f BYTES] [-c BYTES] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000422#define chpst_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000423 "Change the process state and run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000424 "\nOptions:" \
425 "\n -u USER[:GRP] Set uid and gid" \
426 "\n -U USER[:GRP] Set $UID and $GID in environment" \
427 "\n -e DIR Set environment variables as specified by files" \
428 "\n in DIR: file=1st_line_of_file" \
429 "\n -/ DIR Chroot to DIR" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000430 "\n -n NICE Add NICE to nice value" \
431 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000432 "\n -d BYTES Limit data segment" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000433 "\n -o N Limit number of open files per process" \
434 "\n -p N Limit number of processes per uid" \
435 "\n -f BYTES Limit output file sizes" \
436 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000437 "\n -v Verbose" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000438 "\n -P Create new process group" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000439 "\n -0 Close standard input" \
440 "\n -1 Close standard output" \
441 "\n -2 Close standard error" \
442
Denis Vlasenkofe544582006-10-03 15:57:40 +0000443#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000444 "account prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000445#define setuidgid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000446 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000447 "groups and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000448#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000449 "account prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000450#define envuidgid_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000451 "Set $UID to account's uid and $GID to account's gid and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000452#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000453 "dir prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000454#define envdir_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000455 "Set various environment variables as specified by files\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000456 "in the directory dir and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000457#define softlimit_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000458 "[-a BYTES] [-m BYTES] [-d BYTES] [-s BYTES] [-l BYTES]\n" \
459 " [-f BYTES] [-c BYTES] [-r BYTES] [-o N] [-p N] [-t N]\n" \
460 " PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000461#define softlimit_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000462 "Set soft resource limits, then run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000463 "\nOptions:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000464 "\n -a BYTES Limit total size of all segments" \
465 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES -a BYTES" \
466 "\n -d BYTES Limit data segment" \
467 "\n -s BYTES Limit stack segment" \
468 "\n -l BYTES Limit locked memory size" \
469 "\n -o N Limit number of open files per process" \
470 "\n -p N Limit number of processes per uid" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000471 "\nOptions controlling file sizes:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000472 "\n -f BYTES Limit output file sizes" \
473 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000474 "\nEfficiency opts:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000475 "\n -r BYTES Limit resident set size" \
476 "\n -t N Limit CPU time, process receives" \
477 "\n a SIGXCPU after N seconds" \
Denis Vlasenkofe544582006-10-03 15:57:40 +0000478
Eric Andersen7e9276b2001-02-22 01:15:47 +0000479#define chroot_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200480 "NEWROOT [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000481#define chroot_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200482 "Run PROG with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000483#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000484 "$ ls -l /bin/ls\n" \
485 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
486 "# mount /dev/hdc1 /mnt -t minix\n" \
487 "# chroot /mnt\n" \
488 "# ls -l /bin/ls\n" \
489 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000490
Eric Andersen7e9276b2001-02-22 01:15:47 +0000491#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000492 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000493#define chvt_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000494 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000495
Rob Landley856489b2006-04-18 20:57:28 +0000496#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000497 "FILES..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000498#define cksum_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000499 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000500
Eric Andersen7e9276b2001-02-22 01:15:47 +0000501#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000502 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000503#define clear_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000504 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000505
Eric Andersen7e9276b2001-02-22 01:15:47 +0000506#define cmp_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000507 "[-l] [-s] FILE1 [FILE2" IF_DESKTOP(" [SKIP1 [SKIP2]") "]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000508#define cmp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000509 "Compares FILE1 vs stdin if FILE2 is not specified\n" \
510 "\nOptions:" \
511 "\n -l Write the byte numbers (decimal) and values (octal)" \
512 "\n for all differing bytes" \
513 "\n -s Quiet" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000514
Rob Landley2acfd7b2005-05-11 23:12:49 +0000515#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000516 "[-123] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000517#define comm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000518 "Compare FILE1 to FILE2, or to stdin if - is specified\n" \
519 "\nOptions:" \
520 "\n -1 Suppress lines unique to FILE1" \
521 "\n -2 Suppress lines unique to FILE2" \
522 "\n -3 Suppress lines common to both files" \
Rob Landley2acfd7b2005-05-11 23:12:49 +0000523
Paul Fox79c142d2005-08-01 16:04:40 +0000524#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000525 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000526#define bbconfig_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000527 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000528
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000529#define chrt_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200530 "[OPTIONS] [PRIO] [PID | PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000531#define chrt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000532 "Manipulate real-time attributes of a process\n" \
533 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100534 "\n -p Operate on PID" \
535 "\n -r Set SCHED_RR scheduling" \
536 "\n -f Set SCHED_FIFO scheduling" \
537 "\n -o Set SCHED_OTHER scheduling" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000538 "\n -m Show min and max priorities" \
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000539
540#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000541 "$ chrt -r 4 sleep 900; x=$!\n" \
542 "$ chrt -f -p 3 $x\n" \
543 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000544
Eric Andersen7e9276b2001-02-22 01:15:47 +0000545#define cp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200546 "[OPTIONS] SOURCE DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000547#define cp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000548 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY\n" \
549 "\nOptions:" \
550 "\n -a Same as -dpR" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000551 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000552 "\n -c Preserve security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000553 ) \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100554 "\n -R,-r Recurse" \
555 "\n -d,-P Preserve symlinks (default if -R)" \
556 "\n -L Follow all symlinks" \
557 "\n -H Follow symlinks on command line" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000558 "\n -p Preserve file attributes if possible" \
559 "\n -f Force overwrite" \
560 "\n -i Prompt before overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000561 "\n -l,-s Create (sym)links" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000562
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000563#define cpio_trivial_usage \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100564 "[-dmvu] [-F FILE]" IF_FEATURE_CPIO_O(" [-H newc]") \
565 " [-ti"IF_FEATURE_CPIO_O("o")"]" IF_FEATURE_CPIO_P(" [-p DIR]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000566#define cpio_full_usage "\n\n" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000567 "Extract or list files from a cpio archive" \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100568 IF_FEATURE_CPIO_O(", or" \
569 "\ncreate an archive" IF_FEATURE_CPIO_P(" (-o) or copy files (-p)") \
570 " using file list on standard input" \
571 ) \
572 "\n" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000573 "\nMain operation mode:" \
574 "\n -t List" \
575 "\n -i Extract" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000576 IF_FEATURE_CPIO_O( \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100577 "\n -o Create (requires -H newc)" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000578 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000579 IF_FEATURE_CPIO_P( \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100580 "\n -p DIR Copy files to DIR" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000581 ) \
582 "\nOptions:" \
583 "\n -d Make leading directories" \
584 "\n -m Preserve mtime" \
585 "\n -v Verbose" \
586 "\n -u Overwrite" \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100587 "\n -F FILE Input (-t,-i,-p) or output (-o) file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000588 IF_FEATURE_CPIO_O( \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100589 "\n -H newc Archive format" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000590 ) \
Tim Riker7b253f82003-12-28 05:02:40 +0000591
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000592#define crond_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000593 "-fbS -l N " IF_FEATURE_CROND_D("-d N ") "-L LOGFILE -c DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000594#define crond_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000595 " -f Foreground" \
596 "\n -b Background (default)" \
597 "\n -S Log to syslog (default)" \
598 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000599 IF_FEATURE_CROND_D( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000600 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000601 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000602 "\n -L Log to file" \
603 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000604
605#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000606 "[-c DIR] [-u USER] [-ler]|[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000607#define crontab_full_usage "\n\n" \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000608 " -c Crontab directory" \
609 "\n -u User" \
610 "\n -l List crontab" \
611 "\n -e Edit crontab" \
612 "\n -r Delete crontab" \
613 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000614
Denis Vlasenko2211d522008-11-10 18:52:35 +0000615#define cryptpw_trivial_usage \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000616 "[OPTIONS] [PASSWORD] [SALT]"
617/* We do support -s, we just don't mention it */
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000618#define cryptpw_full_usage "\n\n" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000619 "Crypt the PASSWORD using crypt(3)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000620 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200621 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100622 "\n -P,--password-fd=N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000623/* "\n -s,--stdin Use stdin; like -P0" */ \
624 "\n -m,--method=TYPE Encryption method TYPE" \
625 "\n -S,--salt=SALT" \
626 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200627 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100628 "\n -P N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000629/* "\n -s Use stdin; like -P0" */ \
630 "\n -m TYPE Encryption method TYPE" \
631 "\n -S SALT" \
632 ) \
633
634/* mkpasswd is an alias to cryptpw */
635
636#define mkpasswd_trivial_usage \
637 "[OPTIONS] [PASSWORD] [SALT]"
638/* We do support -s, we just don't mention it */
639#define mkpasswd_full_usage "\n\n" \
640 "Crypt the PASSWORD using crypt(3)\n" \
641 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200642 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100643 "\n -P,--password-fd=N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000644/* "\n -s,--stdin Use stdin; like -P0" */ \
645 "\n -m,--method=TYPE Encryption method TYPE" \
646 "\n -S,--salt=SALT" \
647 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200648 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100649 "\n -P N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000650/* "\n -s Use stdin; like -P0" */ \
651 "\n -m TYPE Encryption method TYPE" \
652 "\n -S SALT" \
653 ) \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000654
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000655#define cttyhack_trivial_usage NOUSAGE_STR
656#define cttyhack_full_usage ""
657
Eric Andersen7e9276b2001-02-22 01:15:47 +0000658#define cut_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200659 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000660#define cut_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000661 "Print selected fields from each input FILE to standard output\n" \
662 "\nOptions:" \
663 "\n -b LIST Output only bytes from LIST" \
664 "\n -c LIST Output only characters from LIST" \
665 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
666 "\n -s Output only the lines containing delimiter" \
667 "\n -f N Print only these fields" \
668 "\n -n Ignored" \
669
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000670#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000671 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
672 "Hello\n" \
673 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
674 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000675
Eric Andersen7e9276b2001-02-22 01:15:47 +0000676#define date_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200677 "[OPTIONS] [+FMT] [TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000678#define date_full_usage "\n\n" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000679 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000680 "\nOptions:" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200681 IF_NOT_LONG_OPTS( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200682 "\n [-s] TIME Set time to TIME" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000683 "\n -u Work in UTC (don't convert to local time)" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200684 "\n -R Output RFC-2822 compliant date string" \
685 ) IF_LONG_OPTS( \
686 "\n [-s,--set] TIME Set time to TIME" \
Denys Vlasenko50be9632009-10-23 16:25:20 +0200687 "\n -u,--utc Work in UTC (don't convert to local time)" \
688 "\n -R,--rfc-2822 Output RFC-2822 compliant date string" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200689 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000690 IF_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000691 "\n -I[SPEC] Output ISO-8601 compliant date string" \
692 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000693 "\n 'hours', 'minutes', or 'seconds' for date and" \
694 "\n time to the indicated precision" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200695 ) IF_NOT_LONG_OPTS( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000696 "\n -r FILE Display last modification time of FILE" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200697 "\n -d TIME Display TIME, not 'now'" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200698 ) IF_LONG_OPTS( \
Denys Vlasenko50be9632009-10-23 16:25:20 +0200699 "\n -r,--reference FILE Display last modification time of FILE" \
700 "\n -d,--date TIME Display TIME, not 'now'" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200701 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000702 IF_FEATURE_DATE_ISOFMT( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200703 "\n -D FMT Use FMT for -d TIME conversion" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000704 ) \
705 "\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +0200706 "\nRecognized TIME formats:" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000707 "\n hh:mm[:ss]" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000708 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000709 "\n YYYY-MM-DD hh:mm[:ss]" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200710 "\n [[[[[YY]YY]MM]DD]hh]mm[.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000711
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000712#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000713 "$ date\n" \
714 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000715
Eric Andersen7e9276b2001-02-22 01:15:47 +0000716#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000717 "expression..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000718#define dc_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +0000719 "Tiny RPN calculator. Operations:\n" \
720 "+, add, -, sub, *, mul, /, div, %, mod, **, exp, and, or, not, eor,\n" \
721 "p - print top of the stack (without altering the stack),\n" \
722 "f - print entire stack, o - pop the value and set output radix\n" \
723 "(value must be 10 or 16).\n" \
724 "Examples: 'dc 2 2 add' -> 4, 'dc 8 8 * 2 2 + /' -> 16.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000725
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000726#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000727 "$ dc 2 2 + p\n" \
728 "4\n" \
729 "$ dc 8 8 \\* 2 2 + / p\n" \
730 "16\n" \
731 "$ dc 0 1 and p\n" \
732 "0\n" \
733 "$ dc 0 1 or p\n" \
734 "1\n" \
735 "$ echo 72 9 div 8 mul p | dc\n" \
736 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000737
Eric Andersen7e9276b2001-02-22 01:15:47 +0000738#define dd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000739 "[if=FILE] [of=FILE] " IF_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
740 " [seek=N]" IF_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000741#define dd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000742 "Copy a file with converting and formatting\n" \
743 "\nOptions:" \
744 "\n if=FILE Read from FILE instead of stdin" \
745 "\n of=FILE Write to FILE instead of stdout" \
746 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000747 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000748 "\n ibs=N Read N bytes at a time" \
749 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000750 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000751 "\n obs=N Write N bytes at a time" \
752 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000753 "\n count=N Copy only N input blocks" \
754 "\n skip=N Skip N input blocks" \
755 "\n seek=N Skip N output blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000756 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000757 "\n conv=notrunc Don't truncate output file" \
758 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000759 "\n conv=sync Pad blocks with zeros" \
760 "\n conv=fsync Physically write data out before finishing" \
761 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000762 "\n" \
763 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
764 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
765
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000766#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000767 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
768 "4+0 records in\n" \
769 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000770
Eric Andersen7e9276b2001-02-22 01:15:47 +0000771#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000772 "[N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000773#define deallocvt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000774 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000775
Eric Andersenf349e972001-08-21 16:18:59 +0000776#define delgroup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000777 IF_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000778#define delgroup_full_usage "\n\n" \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000779 "Delete group GROUP from the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000780 IF_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000781
782#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000783 "USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000784#define deluser_full_usage "\n\n" \
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000785 "Delete USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000786
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000787#define depmod_trivial_usage NOUSAGE_STR
788#define depmod_full_usage ""
Bernhard Reutner-Fischer55e547e2008-05-26 12:01:49 +0000789
Denis Vlasenkoc94fa562008-10-26 11:08:14 +0000790#define devmem_trivial_usage \
791 "ADDRESS [WIDTH [VALUE]]"
792
793#define devmem_full_usage "\n\n" \
794 "Read/write from physical address\n" \
795 "\n ADDRESS Address to act upon" \
796 "\n WIDTH Width (8/16/...)" \
797 "\n VALUE Data to be written" \
798
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000799#define devfsd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000800 "mntpnt [-v]" IF_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000801#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000802 "Manage devfs permissions and old device name symlinks\n" \
803 "\nOptions:" \
804 "\n mntpnt The mount point where devfs is mounted" \
805 "\n -v Print the protocol version numbers for devfsd" \
806 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000807 IF_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000808 "\n -fg Run in foreground" \
809 "\n -np Exit after parsing the configuration file" \
810 "\n and processing synthetic REGISTER events," \
Denys Vlasenko07697852009-10-06 21:11:37 +0200811 "\n don't poll for events" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000812 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000813
Eric Andersen7e9276b2001-02-22 01:15:47 +0000814#define df_trivial_usage \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000815 "[-Pk" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000816 IF_FEATURE_HUMAN_READABLE("mh") \
817 IF_FEATURE_DF_FANCY("ai] [-B SIZE") \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000818 "] [FILESYSTEM...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000819#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000820 "Print filesystem usage statistics\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000821 "\nOptions:" \
822 "\n -P POSIX output format" \
823 "\n -k 1024-byte blocks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000824 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000825 "\n -m 1M-byte blocks" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000826 "\n -h Human readable (e.g. 1K 243M 2G)" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000827 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000828 IF_FEATURE_DF_FANCY( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000829 "\n -a Show all filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000830 "\n -i Inodes" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000831 "\n -B SIZE Blocksize" \
832 ) \
833
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000834#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000835 "$ df\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000836 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000837 "/dev/sda3 8690864 8553540 137324 98% /\n" \
838 "/dev/sda1 64216 36364 27852 57% /boot\n" \
839 "$ df /dev/sda3\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000840 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
841 "/dev/sda3 8690864 8553540 137324 98% /\n" \
842 "$ POSIXLY_CORRECT=sure df /dev/sda3\n" \
843 "Filesystem 512B-blocks Used Available Use% Mounted on\n" \
844 "/dev/sda3 17381728 17107080 274648 98% /\n" \
845 "$ POSIXLY_CORRECT=yep df -P /dev/sda3\n" \
846 "Filesystem 512-blocks Used Available Capacity Mounted on\n" \
847 "/dev/sda3 17381728 17107080 274648 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000848
Denis Vlasenko736230e2006-11-20 19:40:36 +0000849#define dhcprelay_trivial_usage \
Denis Vlasenkoe8a79682009-04-13 03:33:46 +0000850 "CLIENT_IFACE[,CLIENT_IFACE2...] SERVER_IFACE [SERVER_IP]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000851#define dhcprelay_full_usage "\n\n" \
Denis Vlasenkoe8a79682009-04-13 03:33:46 +0000852 "Relay DHCP requests between clients and server" \
Denis Vlasenko736230e2006-11-20 19:40:36 +0000853
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000854#define diff_trivial_usage \
Matheus Izvekovfe1ce2e2010-01-18 16:07:07 -0200855 "[-abBdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000856#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000857 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000858 "This implementation supports unified diffs only.\n" \
859 "\nOptions:" \
860 "\n -a Treat all files as text" \
861 "\n -b Ignore changes in the amount of whitespace" \
Matheus Izvekovfe1ce2e2010-01-18 16:07:07 -0200862 "\n -B Ignore changes whose lines are all blank" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000863 "\n -d Try hard to find a smaller set of changes" \
864 "\n -i Ignore case differences" \
865 "\n -L Use LABEL instead of the filename in the unified header" \
866 "\n -N Treat absent files as empty" \
867 "\n -q Output only whether files differ" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100868 "\n -r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000869 "\n -S Start with FILE when comparing directories" \
870 "\n -T Make tabs line up by prefixing a tab when necessary" \
871 "\n -s Report when two files are the same" \
872 "\n -t Expand tabs to spaces in output" \
873 "\n -U Output LINES lines of context" \
874 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000875
Eric Andersen7e9276b2001-02-22 01:15:47 +0000876#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000877 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000878#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000879 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000880#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000881 "$ dirname /tmp/foo\n" \
882 "/tmp\n" \
883 "$ dirname /tmp/foo/\n" \
884 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000885
Eric Andersen7e9276b2001-02-22 01:15:47 +0000886#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000887 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000888#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000889 "Print or control the kernel ring buffer\n" \
890 "\nOptions:" \
891 "\n -c Clear ring buffer after printing" \
892 "\n -n LEVEL Set console logging level" \
893 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000894
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000895#define dnsd_trivial_usage \
Denys Vlasenkob55d6522010-02-06 23:44:59 +0100896 "[-c CONFFILE] [-t TTL_SEC] [-p PORT] [-i ADDR] [-d]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000897#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000898 "Small static DNS server daemon\n" \
899 "\nOptions:" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +0100900 "\n -c FILE Config file" \
901 "\n -t SEC TTL" \
902 "\n -p PORT Listen on PORT" \
903 "\n -i ADDR Listen on ADDR" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000904 "\n -d Daemonize" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000905
Eric Andersen7e9276b2001-02-22 01:15:47 +0000906#define dos2unix_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +0200907 "[OPTIONS] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000908#define dos2unix_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200909 "Convert FILE in-place from DOS to Unix format.\n" \
910 "When no file is given, use stdin/stdout.\n" \
911 "\nOptions:" \
912 "\n -u dos2unix" \
913 "\n -d unix2dos" \
914
915#define unix2dos_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +0200916 "[OPTIONS] [FILE]"
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200917#define unix2dos_full_usage "\n\n" \
918 "Convert FILE in-place from Unix to DOS format.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000919 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000920 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000921 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000922 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000923
Eric Andersen7e9276b2001-02-22 01:15:47 +0000924#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000925 "[-ilCPru] [-F option] package_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000926#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000927 "Install, remove and manage Debian packages\n" \
928 "\nOptions:" \
929 "\n -i Install the package" \
930 "\n -l List of installed packages" \
931 "\n -C Configure an unpackaged package" \
932 "\n -F depends Ignore dependency problems" \
933 "\n -P Purge all files of a package" \
934 "\n -r Remove all but the configuration files for a package" \
935 "\n -u Unpack a package, but don't configure it" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000936
Eric Andersen7e9276b2001-02-22 01:15:47 +0000937#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000938 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000939#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000940 "Perform actions on Debian packages (.debs)\n" \
941 "\nOptions:" \
942 "\n -c List contents of filesystem tree" \
943 "\n -e Extract control files to [argument] directory" \
944 "\n -f Display control field name starting with [argument]" \
945 "\n -x Extract packages filesystem tree to directory" \
946 "\n -X Verbose extract" \
947
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000948#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000949 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000950
Eric Andersen7e9276b2001-02-22 01:15:47 +0000951#define du_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000952 "[-aHLdclsx" IF_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000953#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000954 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000955 "Disk space is printed in units of " \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000956 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
957 IF_NOT_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000958 " bytes.\n" \
959 "\nOptions:" \
960 "\n -a Show file sizes too" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000961 "\n -L Follow all symlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100962 "\n -H Follow symlinks on command line" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000963 "\n -d N Limit output to directories (and files with -a) of depth < N" \
964 "\n -c Show grand total" \
965 "\n -l Count sizes many times if hard linked" \
966 "\n -s Display only a total for each argument" \
967 "\n -x Skip directories on different filesystems" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000968 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000969 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
970 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000971 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000972 "\n -k Sizes in kilobytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000973 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000974
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000975#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000976 "$ du\n" \
977 "16 ./CVS\n" \
978 "12 ./kernel-patches/CVS\n" \
979 "80 ./kernel-patches\n" \
980 "12 ./tests/CVS\n" \
981 "36 ./tests\n" \
982 "12 ./scripts/CVS\n" \
983 "16 ./scripts\n" \
984 "12 ./docs/CVS\n" \
985 "104 ./docs\n" \
986 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000987
Eric Andersen7e9276b2001-02-22 01:15:47 +0000988#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000989 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000990#define dumpkmap_full_usage "\n\n" \
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000991 "Print a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000992#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000993 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000994
Russ Dill61fb4892002-10-14 21:41:28 +0000995#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000996 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000997#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000998 "Display DHCP leases granted by udhcpd\n" \
999 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001000 IF_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001001 "\n -f,--file=FILE Leases file to load" \
1002 "\n -r,--remaining Interpret lease times as time remaining" \
1003 "\n -a,--absolute Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001004 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001005 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001006 "\n -f FILE Leases file to load" \
1007 "\n -r Interpret lease times as time remaining" \
1008 "\n -a Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001009 )
Russ Dill61fb4892002-10-14 21:41:28 +00001010
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001011/*
Mike Frysinger51a43b42005-09-24 07:11:16 +00001012#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001013 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
1014 "[-I inode_buffer_blocks] [-P process_inode_size] " \
1015 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
1016 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001017#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001018 "Check ext2/ext3 file system\n" \
1019 "\nOptions:" \
1020 "\n -p Automatic repair (no questions)" \
1021 "\n -n Make no changes to the filesystem" \
1022 "\n -y Assume 'yes' to all questions" \
1023 "\n -c Check for bad blocks and add them to the badblock list" \
1024 "\n -f Force checking even if filesystem is marked clean" \
1025 "\n -v Verbose" \
1026 "\n -b superblock Use alternative superblock" \
1027 "\n -B blocksize Force blocksize when looking for superblock" \
1028 "\n -j journal Set location of the external journal" \
1029 "\n -l file Add to badblocks list" \
1030 "\n -L file Set badblocks list" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001031*/
Mike Frysinger51a43b42005-09-24 07:11:16 +00001032
Eric Andersen7e9276b2001-02-22 01:15:47 +00001033#define echo_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001034 IF_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001035#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001036 "Print the specified ARGs to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001037 IF_FEATURE_FANCY_ECHO( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001038 "\nOptions:" \
1039 "\n -n Suppress trailing newline" \
1040 "\n -e Interpret backslash-escaped characters (i.e., \\t=tab)" \
1041 "\n -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001042 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001043#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001044 "$ echo \"Erik is cool\"\n" \
1045 "Erik is cool\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001046 IF_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001047 "Erik\n" \
1048 "is\n" \
1049 "cool\n" \
1050 "$ echo \"Erik\\nis\\ncool\"\n" \
1051 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001052
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001053#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001054 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001055#define eject_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001056 "Eject specified DEVICE (or default /dev/cdrom)\n" \
1057 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001058 IF_FEATURE_EJECT_SCSI( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001059 "\n -s SCSI device" \
1060 ) \
1061 "\n -t Close tray" \
1062 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001063
Rob Landley3b890392006-05-04 20:56:43 +00001064#define ed_trivial_usage ""
1065#define ed_full_usage ""
1066
Eric Andersen84e229c2001-03-29 22:48:33 +00001067#define env_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001068 "[-iu] [-] [name=value]... [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001069#define env_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001070 "Print the current environment or run PROG after setting up\n" \
1071 "the specified environment\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001072 "\nOptions:" \
1073 "\n -, -i Start with an empty environment" \
1074 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +00001075
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001076#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001077 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001078#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001079 "Send a magic packet to wake up sleeping machines.\n" \
1080 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001081 "a hostname with a known 'ethers' entry.\n" \
1082 "\nOptions:" \
1083 "\n -b Send wake-up packet to the broadcast address" \
1084 "\n -i iface Interface to use (default eth0)" \
1085 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001086
Denis Vlasenko3952f202007-08-13 14:10:24 +00001087#define expand_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001088 "[-i] [-t N] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001089#define expand_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001090 "Convert tabs to spaces, writing to standard output\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001091 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001092 IF_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001093 "\n -i,--initial Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001094 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001095 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001096 IF_NOT_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001097 "\n -i Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001098 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001099 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00001100
Eric Andersen7e9276b2001-02-22 01:15:47 +00001101#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001102 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001103#define expr_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001104 "Print the value of EXPRESSION to standard output\n" \
1105 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001106 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001107 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
1108 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1109 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1110 " ARG1 <= ARG2\n" \
1111 " ARG1 = ARG2\n" \
1112 " ARG1 != ARG2\n" \
1113 " ARG1 >= ARG2\n" \
1114 " ARG1 > ARG2\n" \
1115 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1116 " ARG1 - ARG2\n" \
1117 " ARG1 * ARG2\n" \
1118 " ARG1 / ARG2\n" \
1119 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001120 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1121 " match STRING REGEXP Same as STRING : REGEXP\n" \
1122 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1123 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1124 " length STRING Length of STRING\n" \
1125 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001126 " it is a keyword like 'match' or an\n" \
1127 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001128 " (EXPRESSION) Value of EXPRESSION\n" \
1129 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001130 "Beware that many operators need to be escaped or quoted for shells.\n" \
1131 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001132 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001133 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1134 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001135
Mike Frysingerfa69f112005-04-17 07:24:19 +00001136#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001137 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001138#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001139 "Provide fake ident (auth) service\n" \
1140 "\nOptions:" \
1141 "\n -f Run in foreground" \
1142 "\n -i Inetd mode" \
1143 "\n -w Inetd 'wait' mode" \
1144 "\n -b ADDR Bind to specified address" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001145 "\n STRING Ident answer string (default: nobody)" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001146
Eric Andersen7e9276b2001-02-22 01:15:47 +00001147#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001148 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001149#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001150 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001151
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001152#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001153 "$ false\n" \
1154 "$ echo $?\n" \
1155 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001156
1157#define fbset_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001158 "[OPTIONS] [MODE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001159#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001160 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001161
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001162#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001163 "$ fbset\n" \
1164 "mode \"1024x768-76\"\n" \
1165 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1166 " geometry 1024 768 1024 768 16\n" \
1167 " timings 12714 128 32 16 4 128 4\n" \
1168 " accel false\n" \
1169 " rgba 5/11,6/5,5/0,0/0\n" \
1170 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001171
Eric Andersen7e9276b2001-02-22 01:15:47 +00001172#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001173 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001174#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001175 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001176
Eric Andersen01c3d402003-07-05 07:51:31 +00001177#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001178 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001179#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001180 "Format floppy disk\n" \
1181 "\nOptions:" \
1182 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001183
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001184/* Looks like someone forgot to add this to config system */
1185#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1186# define ENABLE_FEATURE_FDISK_BLKSIZE 0
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001187# define IF_FEATURE_FDISK_BLKSIZE(a)
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001188#endif
1189
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001190#define fdisk_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001191 "[-ul" IF_FEATURE_FDISK_BLKSIZE("s") "] " \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001192 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001193#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001194 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001195 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001196 "\n -u Start and End are in sectors (instead of cylinders)" \
1197 "\n -l Show partition table for each DISK, then exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001198 IF_FEATURE_FDISK_BLKSIZE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001199 "\n -s Show partition sizes in kb for each DISK, then exit" \
1200 ) \
1201 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1202 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
1203 "\n -H HEADS\n" \
1204 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001205
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001206#define blkid_trivial_usage \
1207 ""
1208#define blkid_full_usage "\n\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02001209 "Print UUIDs of all filesystems"
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001210
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001211#define findfs_trivial_usage \
1212 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001213#define findfs_full_usage "\n\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02001214 "Find a filesystem device based on a label or UUID"
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001215#define findfs_example_usage \
1216 "$ findfs LABEL=MyDevice"
1217
Eric Andersen7e9276b2001-02-22 01:15:47 +00001218#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001219 "[PATH...] [EXPRESSION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001220#define find_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001221 "Search for files. The default PATH is the current directory,\n" \
1222 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001223 "\nEXPRESSION may consist of:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001224 "\n -follow Follow symlinks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001225 IF_FEATURE_FIND_XDEV( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001226 "\n -xdev Don't descend directories on other filesystems") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001227 IF_FEATURE_FIND_MAXDEPTH( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001228 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1229 "\n tests/actions to command line arguments only") \
Denys Vlasenko07697852009-10-06 21:11:37 +02001230 "\n -mindepth N Don't act on first N levels" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001231 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001232 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001233 IF_FEATURE_FIND_PATH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001234 "\n -path PATTERN Path matches PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001235 IF_FEATURE_FIND_REGEX( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001236 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001237 IF_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001238 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001239 IF_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001240 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001241 "\n or exactly NNN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001242 IF_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001243 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001244 "\n or exactly N days") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001245 IF_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001246 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001247 "\n or exactly N minutes") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001248 IF_FEATURE_FIND_NEWER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001249 "\n -newer FILE Modified time is more recent than FILE's") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001250 IF_FEATURE_FIND_INUM( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001251 "\n -inum N File has inode number N") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001252 IF_FEATURE_FIND_USER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001253 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001254 IF_FEATURE_FIND_GROUP( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001255 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001256 IF_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001257 "\n -depth Process directory name after traversing it") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001258 IF_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001259 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1260 "\n +/-N: file size is bigger/smaller than N") \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001261 IF_FEATURE_FIND_LINKS( \
1262 "\n -links N Number of links is greater than (+N), less than (-N)," \
1263 "\n or exactly N") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001264 "\n -print Print (default and assumed)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001265 IF_FEATURE_FIND_PRINT0( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001266 "\n -print0 Delimit output with null characters rather than" \
1267 "\n newlines") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001268 IF_FEATURE_FIND_CONTEXT ( \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001269 "\n -context File has specified security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001270 IF_FEATURE_FIND_EXEC( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001271 "\n -exec CMD ARG ; Run CMD with all instances of {} replaced by the" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001272 "\n matching files") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001273 IF_FEATURE_FIND_PRUNE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001274 "\n -prune Stop traversing current subtree") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001275 IF_FEATURE_FIND_DELETE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001276 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001277 IF_FEATURE_FIND_PAREN( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001278 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001279
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001280#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001281 "$ find / -name passwd\n" \
1282 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001283
Denys Vlasenkobf2af9a2009-05-25 04:15:37 +02001284#define flash_lock_trivial_usage \
1285 "MTD_DEVICE OFFSET SECTORS"
1286#define flash_lock_full_usage "\n\n" \
1287 "Lock part or all of an MTD device. If SECTORS is -1, then all sectors\n" \
1288 "will be locked, regardless of the value of OFFSET"
1289
1290#define flash_unlock_trivial_usage \
1291 "MTD_DEVICE"
1292#define flash_unlock_full_usage "\n\n" \
1293 "Unlock an MTD device"
1294
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001295#define flash_eraseall_trivial_usage \
1296 "[-jq] MTD_DEVICE"
1297#define flash_eraseall_full_usage "\n\n" \
1298 "Erase an MTD device\n" \
1299 "\nOptions:" \
Stefan Seyfriedd095fd42009-11-21 18:32:19 +01001300 "\n -j Format the device for jffs2" \
1301 "\n -q Don't display progress messages" \
1302
1303#define flashcp_trivial_usage \
1304 "-v FILE MTD_DEVICE"
1305#define flashcp_full_usage "\n\n" \
1306 "Copy an image to MTD device\n" \
1307 "\nOptions:" \
1308 "\n -v Verbose" \
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001309
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001310#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001311 "[-bs] [-w WIDTH] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001312#define fold_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001313 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001314 "standard output\n" \
1315 "\nOptions:" \
1316 "\n -b Count bytes rather than columns" \
1317 "\n -s Break at spaces" \
1318 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001319
Eric Andersen7e9276b2001-02-22 01:15:47 +00001320#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001321 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001322#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001323 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001324#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001325 "$ free\n" \
1326 " total used free shared buffers\n" \
1327 " Mem: 257628 248724 8904 59644 93124\n" \
1328 " Swap: 128516 8404 120112\n" \
1329 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001330
Eric Andersen7e9276b2001-02-22 01:15:47 +00001331#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001332 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001333#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001334 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001335#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001336 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001337
Mike Frysinger51a43b42005-09-24 07:11:16 +00001338#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001339 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001340#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001341 "Check and repair filesystems\n" \
1342 "\nOptions:" \
1343 "\n -A Walk /etc/fstab and check all filesystems" \
1344 "\n -N Don't execute, just show what would be done" \
1345 "\n -P With -A, check filesystems in parallel" \
1346 "\n -R With -A, skip the root filesystem" \
1347 "\n -T Don't show title on startup" \
1348 "\n -V Verbose" \
1349 "\n -C n Write status information to specified filedescriptor" \
1350 "\n -t type List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001351
Eric Andersen7e9276b2001-02-22 01:15:47 +00001352#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001353 "[-larvsmf] /dev/name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001354#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001355 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001356 "\nOptions:" \
1357 "\n -l List all filenames" \
1358 "\n -r Perform interactive repairs" \
1359 "\n -a Perform automatic repairs" \
1360 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001361 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001362 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001363 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001364
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001365#define ftpd_trivial_usage \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001366 "[-wvS] [-t N] [-T N] [DIR]"
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001367#define ftpd_full_usage "\n\n" \
Denys Vlasenkoae357bd2009-09-11 23:29:45 +02001368 "Anonymous FTP server\n" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001369 "\n" \
1370 "ftpd should be used as an inetd service.\n" \
1371 "ftpd's line for inetd.conf:\n" \
1372 " 21 stream tcp nowait root ftpd ftpd /files/to/serve\n" \
1373 "It also can be ran from tcpsvd:\n" \
1374 " tcpsvd -vE 0.0.0.0 21 ftpd /files/to/serve\n" \
1375 "\nOptions:" \
1376 "\n -w Allow upload" \
Denis Vlasenko4221e902009-03-11 15:07:44 +00001377 "\n -v Log to stderr" \
1378 "\n -S Log to syslog" \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001379 "\n -t,-T Idle and absolute timeouts" \
Denis Vlasenko92576712009-03-09 16:25:33 +00001380 "\n DIR Change root to this directory" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001381
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001382#define ftpget_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001383 "[OPTIONS] HOST [LOCAL_FILE] REMOTE_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001384#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001385 "Retrieve a remote file via FTP\n" \
1386 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001387 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001388 "\n -c,--continue Continue previous transfer" \
1389 "\n -v,--verbose Verbose" \
1390 "\n -u,--username Username" \
1391 "\n -p,--password Password" \
1392 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001393 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001394 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001395 "\n -c Continue previous transfer" \
1396 "\n -v Verbose" \
1397 "\n -u Username" \
1398 "\n -p Password" \
1399 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001400 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001401
1402#define ftpput_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001403 "[OPTIONS] HOST [REMOTE_FILE] LOCAL_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001404#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001405 "Store a local file on a remote machine via FTP\n" \
1406 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001407 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001408 "\n -v,--verbose Verbose" \
1409 "\n -u,--username Username" \
1410 "\n -p,--password Password" \
1411 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001412 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001413 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001414 "\n -v Verbose" \
1415 "\n -u Username" \
1416 "\n -p Password" \
1417 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001418 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001419
Rob Landleyaa872762005-10-28 13:05:12 +00001420#define fuser_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001421 "[OPTIONS] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001422#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001423 "Find processes which use FILEs or PORTs\n" \
1424 "\nOptions:" \
1425 "\n -m Find processes which use same fs as FILEs" \
1426 "\n -4 Search only IPv4 space" \
1427 "\n -6 Search only IPv6 space" \
1428 "\n -s Silent: just exit with 0 if any processes are found" \
1429 "\n -k Kill found processes (otherwise display PIDs)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001430 "\n -SIGNAL Signal to send (default: TERM)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001431
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001432#define getenforce_trivial_usage NOUSAGE_STR
1433#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001434
Eric Andersen7e9276b2001-02-22 01:15:47 +00001435#define getopt_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001436 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001437#define getopt_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001438 "Options:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001439 IF_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001440 "\n -a,--alternative Allow long options starting with single -" \
1441 "\n -l,--longoptions=longopts Long options to be recognized" \
1442 "\n -n,--name=progname The name under which errors are reported" \
1443 "\n -o,--options=optstring Short options to be recognized" \
1444 "\n -q,--quiet Disable error reporting by getopt(3)" \
1445 "\n -Q,--quiet-output No normal output" \
1446 "\n -s,--shell=shell Set shell quoting conventions" \
1447 "\n -T,--test Test for getopt(1) version" \
1448 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001449 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001450 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001451 "\n -a Allow long options starting with single -" \
1452 "\n -l longopts Long options to be recognized" \
1453 "\n -n progname The name under which errors are reported" \
1454 "\n -o optstring Short options to be recognized" \
1455 "\n -q Disable error reporting by getopt(3)" \
1456 "\n -Q No normal output" \
1457 "\n -s shell Set shell quoting conventions" \
1458 "\n -T Test for getopt(1) version" \
1459 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001460 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001461#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001462 "$ cat getopt.test\n" \
1463 "#!/bin/sh\n" \
1464 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1465 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001466 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001467 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001468 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001469 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001470 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1471 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001472 " -c|--c-long)\n" \
1473 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001474 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1475 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1476 " esac;;\n" \
1477 " --) shift; break;;\n" \
1478 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001479 " esac\n" \
1480 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001481
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001482#define getsebool_trivial_usage \
1483 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001484#define getsebool_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001485 " -a Show all SELinux booleans"
1486
Eric Andersenf349e972001-08-21 16:18:59 +00001487#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001488 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001489#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001490 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1491 "\nOptions:" \
1492 "\n -h Enable hardware (RTS/CTS) flow control" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001493 "\n -i Don't display /etc/issue before running login" \
1494 "\n -L Local line, don't do carrier detect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001495 "\n -m Get baud rate from modem's CONNECT status message" \
1496 "\n -w Wait for a CR or LF before sending /etc/issue" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001497 "\n -n Don't prompt the user for a login name" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02001498 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
1499 "\n -l LOGIN Invoke LOGIN instead of /bin/login" \
1500 "\n -t SEC Terminate after SEC if no username is read" \
1501 "\n -I INITSTR Send INITSTR before anything else" \
1502 "\n -H HOST Log HOST into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001503
Eric Andersen7e9276b2001-02-22 01:15:47 +00001504#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001505 "[-HhrilLnqvso" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001506 IF_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001507 "eF" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001508 IF_FEATURE_GREP_EGREP_ALIAS("E") \
1509 IF_FEATURE_GREP_CONTEXT("ABC") \
1510 IF_EXTRA_COMPAT("z") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001511 "] PATTERN [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001512#define grep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001513 "Search for PATTERN in each FILE or standard input\n" \
1514 "\nOptions:" \
1515 "\n -H Prefix output lines with filename where match was found" \
1516 "\n -h Suppress the prefixing filename on output" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001517 "\n -r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001518 "\n -i Ignore case distinctions" \
1519 "\n -l List names of files that match" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001520 "\n -L List names of files that don't match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001521 "\n -n Print line number with output lines" \
1522 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1523 "\n -v Select non-matching lines" \
1524 "\n -s Suppress file open/read error messages" \
1525 "\n -c Only print count of matching lines" \
1526 "\n -o Show only the part of a line that matches PATTERN" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001527 "\n -m N Match up to N times per file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001528 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001529 "\n -w Match whole words only") \
1530 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001531 IF_FEATURE_GREP_EGREP_ALIAS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001532 "\n -E PATTERN is an extended regular expression") \
1533 "\n -e PTRN Pattern to match" \
1534 "\n -f FILE Read pattern from file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001535 IF_FEATURE_GREP_CONTEXT( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001536 "\n -A N Print N lines of trailing context" \
1537 "\n -B N Print N lines of leading context" \
1538 "\n -C N Print N lines of output context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001539 IF_EXTRA_COMPAT( \
Denis Vlasenko83518d12009-03-20 22:17:13 +00001540 "\n -z Input is NUL terminated") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001541
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001542#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001543 "$ grep root /etc/passwd\n" \
1544 "root:x:0:0:root:/root:/bin/bash\n" \
1545 "$ grep ^[rR]oo. /etc/passwd\n" \
1546 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001547
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001548#define egrep_trivial_usage NOUSAGE_STR
1549#define egrep_full_usage ""
1550
1551#define fgrep_trivial_usage NOUSAGE_STR
1552#define fgrep_full_usage ""
1553
Eric Andersen7e9276b2001-02-22 01:15:47 +00001554#define gunzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001555 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001556#define gunzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001557 "Uncompress FILEs (or standard input)\n" \
1558 "\nOptions:" \
1559 "\n -c Write to standard output" \
1560 "\n -f Force" \
1561 "\n -t Test file integrity" \
1562
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001563#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001564 "$ ls -la /tmp/BusyBox*\n" \
1565 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1566 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1567 "$ ls -la /tmp/BusyBox*\n" \
1568 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001569
1570#define gzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001571 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001572#define gzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001573 "Compress FILEs (or standard input)\n" \
1574 "\nOptions:" \
1575 "\n -c Write to standard output" \
1576 "\n -d Decompress" \
1577 "\n -f Force" \
1578
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001579#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001580 "$ ls -la /tmp/busybox*\n" \
1581 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1582 "$ gzip /tmp/busybox.tar\n" \
1583 "$ ls -la /tmp/busybox*\n" \
1584 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001585
1586#define halt_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001587 "[-d DELAY] [-n] [-f]" IF_FEATURE_WTMP(" [-w]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001588#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001589 "Halt the system\n" \
1590 "\nOptions:" \
1591 "\n -d Delay interval for halting" \
1592 "\n -n No call to sync()" \
1593 "\n -f Force halt (don't go through init)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001594 IF_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001595 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001596 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001597
Eric Andersen3443bd72003-07-22 07:30:36 +00001598#define hdparm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001599 "[OPTIONS] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001600#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001601 "Options:" \
1602 "\n -a Get/set fs readahead" \
1603 "\n -A Set drive read-lookahead flag (0/1)" \
1604 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1605 "\n -B Set Advanced Power Management setting (1-255)" \
1606 "\n -c Get/set IDE 32-bit IO setting" \
1607 "\n -C Check IDE power mode status" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001608 IF_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001609 "\n -d Get/set using_dma flag") \
1610 "\n -D Enable/disable drive defect-mgmt" \
1611 "\n -f Flush buffer cache for device on exit" \
1612 "\n -g Display drive geometry" \
1613 "\n -h Display terse usage information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001614 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001615 "\n -i Display drive identification") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001616 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001617 "\n -I Detailed/current information directly from drive") \
1618 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1619 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1620 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1621 "\n -m Get/set multiple sector count" \
1622 "\n -n Get/set ignore-write-errors flag (0/1)" \
1623 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1624 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001625/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001626 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1627 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001628 IF_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001629 "\n -R Register an IDE interface (DANGEROUS)") \
1630 "\n -S Set standby (spindown) timeout" \
1631 "\n -t Perform device read timings" \
1632 "\n -T Perform cache read timings" \
1633 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001634 IF_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001635 "\n -U Unregister an IDE interface (DANGEROUS)") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001636 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1637 "\n -V Display program version and exit immediately" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001638 IF_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001639 "\n -w Perform device reset (DANGEROUS)") \
1640 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001641 IF_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001642 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1643 "\n -X Set IDE xfer mode (DANGEROUS)" \
1644 "\n -y Put IDE drive in standby mode" \
1645 "\n -Y Put IDE drive to sleep" \
1646 "\n -Z Disable Seagate auto-powersaving mode" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001647 "\n -z Reread partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001648
Eric Andersen7e9276b2001-02-22 01:15:47 +00001649#define head_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001650 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001651#define head_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02001652 "Print first 10 lines of each FILE (or standard input) to standard output.\n" \
1653 "With more than one FILE, precede each with a header giving the file name.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001654 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001655 "\n -n N Print first N lines instead of first 10" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001656 IF_FEATURE_FANCY_HEAD( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001657 "\n -c N Output the first N bytes" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001658 "\n -q Never output headers giving file names" \
1659 "\n -v Always output headers giving file names") \
1660
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001661#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001662 "$ head -n 2 /etc/passwd\n" \
1663 "root:x:0:0:root:/root:/bin/bash\n" \
1664 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001665
Glenn L McGrath60281112001-11-02 11:39:46 +00001666#define hexdump_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001667 "[-bcCdefnosvx" IF_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001668#define hexdump_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02001669 "Display FILEs or standard input in a user specified format\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001670 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001671 "\n -b One-byte octal display" \
1672 "\n -c One-byte character display" \
1673 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1674 "\n -d Two-byte decimal display" \
1675 "\n -e FORMAT STRING" \
1676 "\n -f FORMAT FILE" \
1677 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1678 "\n -o Two-byte octal display" \
1679 "\n -s OFFSET Skip OFFSET bytes" \
1680 "\n -v Display all input data" \
1681 "\n -x Two-byte hexadecimal display" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001682 IF_FEATURE_HEXDUMP_REVERSE( \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001683 "\n -R Reverse of 'hexdump -Cv'") \
1684
1685#define hd_trivial_usage \
1686 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001687#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001688 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001689
Eric Andersen7e9276b2001-02-22 01:15:47 +00001690#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001691 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001692#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001693 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001694
1695#define hostname_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001696 "[OPTIONS] [HOSTNAME | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001697#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001698 "Get or set hostname or DNS domain name\n" \
1699 "\nOptions:" \
1700 "\n -s Short" \
1701 "\n -i Addresses for the hostname" \
1702 "\n -d DNS domain name" \
1703 "\n -f Fully qualified domain name" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001704 "\n -F FILE Use FILE's content as hostname" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001705
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001706#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001707 "$ hostname\n" \
1708 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001709
Denys Vlasenkod30b89c2009-06-26 01:55:45 +02001710#define dnsdomainname_trivial_usage NOUSAGE_STR
1711#define dnsdomainname_full_usage ""
1712
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001713#define httpd_trivial_usage \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001714 "[-ifv[v]]" \
1715 " [-c CONFFILE]" \
1716 " [-p [IP:]PORT]" \
1717 IF_FEATURE_HTTPD_SETUID(" [-u USER[:GRP]]") \
1718 IF_FEATURE_HTTPD_BASIC_AUTH(" [-r REALM]") \
1719 " [-h HOME]\n" \
1720 "or httpd -d/-e" IF_FEATURE_HTTPD_AUTH_MD5("/-m") " STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001721#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001722 "Listen for incoming HTTP requests\n" \
1723 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001724 "\n -i Inetd mode" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001725 "\n -f Don't daemonize" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001726 "\n -v[v] Verbose" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001727 "\n -c FILE Configuration file (default httpd.conf)" \
1728 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001729 IF_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001730 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001731 IF_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001732 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001733 "\n -h HOME Home directory (default .)" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001734 IF_FEATURE_HTTPD_AUTH_MD5( \
1735 "\n -m STRING MD5 crypt STRING") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001736 "\n -e STRING HTML encode STRING" \
1737 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001738
Robert Griebl1cd04452002-07-21 16:50:49 +00001739#define hwclock_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001740 IF_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001741 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1742 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001743 " [-f FILE]" \
1744 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001745 IF_NOT_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001746 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1747 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001748#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001749 "Query and set hardware clock (RTC)\n" \
1750 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001751 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001752 "\n -s Set system time from hardware clock" \
1753 "\n -w Set hardware clock to system time" \
1754 "\n -u Hardware clock is in UTC" \
1755 "\n -l Hardware clock is in local time" \
1756 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001757
Eric Andersen7e9276b2001-02-22 01:15:47 +00001758#define id_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001759 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001760#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001761 "Print information about USER or the current user\n" \
1762 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001763 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001764 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001765 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001766 "\n -u Print user ID" \
Denis Vlasenko4f3209b2008-09-13 12:51:10 +00001767 "\n -g Print group ID" \
1768 "\n -G Print supplementary group IDs" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001769 "\n -n Print name instead of a number" \
1770 "\n -r Print real user ID instead of effective ID" \
1771
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001772#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001773 "$ id\n" \
1774 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001775
Eric Andersen7e9276b2001-02-22 01:15:47 +00001776#define ifconfig_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001777 IF_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001778#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001779 "Configure a network interface\n" \
1780 "\nOptions:" \
1781 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001782 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001783 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001784 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001785 " [del ADDRESS[/PREFIXLEN]]\n") \
1786 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1787 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001788 IF_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001789 " [outfill NN] [keepalive NN]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001790 " " IF_FEATURE_IFCONFIG_HW("[hw ether" IF_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001791 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001792 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001793 IF_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001794 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001795 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001796
Denis Vlasenko06aed432008-02-26 18:25:24 +00001797#define ifenslave_trivial_usage \
1798 "[-cdf] master-iface <slave-iface...>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001799#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001800 "Configure network interfaces for parallel routing\n" \
1801 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001802 "\n -c, --change-active Change active slave" \
1803 "\n -d, --detach Remove slave interface from bonding device" \
1804 "\n -f, --force Force, even if interface is not Ethernet" \
1805/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001806
Denis Vlasenko06aed432008-02-26 18:25:24 +00001807#define ifenslave_example_usage \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001808 "To create a bond device, simply follow these three steps:\n" \
1809 "- ensure that the required drivers are properly loaded:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001810 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001811 "- assign an IP address to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001812 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001813 "- attach all the interfaces you need to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001814 " # ifenslave bond0 eth0 eth1 eth2\n" \
1815 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1816 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001817 " To detach a dead interface without setting the bond device down:\n" \
1818 " # ifenslave -d bond0 eth1\n\n" \
1819 " To set the bond device down and automatically release all the slaves:\n" \
1820 " # ifconfig bond0 down\n\n" \
1821 " To change active slave:\n" \
1822 " # ifenslave -c bond0 eth0\n" \
1823
1824#define ifplugd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001825 "[OPTIONS]"
Denis Vlasenko71c16572009-04-26 01:08:51 +00001826#define ifplugd_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +02001827 "Network interface plug detection daemon\n" \
1828 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001829 "\n -n Don't daemonize" \
1830 "\n -s Don't log to syslog" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001831 "\n -i IFACE Interface" \
1832 "\n -f/-F Treat link detection error as link down/link up" \
1833 "\n (otherwise exit on error)" \
Denys Vlasenko999e4422010-01-08 13:03:48 +01001834 "\n -a Don't up interface at each link probe" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001835 "\n -M Monitor creation/destruction of interface" \
1836 "\n (otherwise it must exist)" \
1837 "\n -r PROG Script to run" \
1838 "\n -x ARG Extra argument for script" \
1839 "\n -I Don't exit on nonzero exit code from script" \
1840 "\n -p Don't run script on daemon startup" \
1841 "\n -q Don't run script on daemon quit" \
1842 "\n -l Run script on startup even if no cable is detected" \
1843 "\n -t SECS Poll time in seconds" \
1844 "\n -u SECS Delay before running script after link up" \
1845 "\n -d SECS Delay after link down" \
Denys Vlasenkob8f0e802010-01-07 14:56:50 +01001846 "\n -m MODE API mode (mii, priv, ethtool, wlan, iff, auto)" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001847 "\n -k Kill running daemon" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001848
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001849#define ifup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001850 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001851#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001852 "Options:" \
1853 "\n -a De/configure all interfaces automatically" \
1854 "\n -i FILE Use FILE for interface definitions" \
1855 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001856 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001857 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001858 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001859 ) \
1860 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001861 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001862
1863#define ifdown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001864 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001865#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001866 "Options:" \
1867 "\n -a De/configure all interfaces automatically" \
1868 "\n -i FILE Use FILE for interface definitions" \
1869 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001870 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001871 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001872 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001873 ) \
1874 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001875 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001876
Glenn L McGrath06e95652003-02-09 06:51:14 +00001877#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001878 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001879#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001880 "Listen for network connections and launch programs\n" \
1881 "\nOptions:" \
1882 "\n -f Run in foreground" \
1883 "\n -e Log to stderr" \
1884 "\n -q N Socket listen queue (default: 128)" \
1885 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001886 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001887
Eric Andersen7e9276b2001-02-22 01:15:47 +00001888#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001889 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001890#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001891 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001892
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001893#define init_notes_usage \
1894"This version of init is designed to be run only by the kernel.\n" \
1895"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001896"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001897"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001898"runlevels, use sysvinit.\n" \
1899"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001900"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001901"it has the following default behavior:\n" \
1902"\n" \
1903" ::sysinit:/etc/init.d/rcS\n" \
1904" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001905" ::ctrlaltdel:/sbin/reboot\n" \
1906" ::shutdown:/sbin/swapoff -a\n" \
1907" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001908" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001909"\n" \
1910"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1911"\n" \
1912" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001913" tty3::askfirst:/bin/sh\n" \
1914" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001915"\n" \
1916"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1917"\n" \
1918" <id>:<runlevels>:<action>:<process>\n" \
1919"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001920" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001921"\n" \
1922" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1923" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001924" the specified process to run on. The contents of this field are\n" \
1925" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1926" be unique, although if it isn't you may have strange results. If this\n" \
1927" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001928" note that if BusyBox detects that a serial console is in use, then only\n" \
1929" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001930" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001931" stinkin' utmp.\n" \
1932"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001933" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001934"\n" \
1935" The runlevels field is completely ignored.\n" \
1936"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001937" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001938"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001939" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001940" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001941"\n" \
1942" The available actions can be classified into two groups: actions\n" \
1943" that are run only once, and actions that are re-run when the specified\n" \
1944" process exits.\n" \
1945"\n" \
1946" Run only-once actions:\n" \
1947"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001948" 'sysinit' is the first item run on boot. init waits until all\n" \
1949" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001950" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001951" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001952" the specified task completes. 'once' actions are asynchronous,\n" \
1953" therefore, init does not wait for them to complete. 'restart' is\n" \
1954" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001955" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001956" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001957" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001958" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001959" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001960" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001961" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001962" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001963"\n" \
1964" Run repeatedly actions:\n" \
1965"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001966" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001967" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001968" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1969" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001970" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001971" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001972" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001973" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001974"\n" \
1975" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001976" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001977" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001978"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001979" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001980"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001981" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001982"\n" \
1983"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001984"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001985" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001986" #\n" \
1987" ::sysinit:/etc/init.d/rcS\n" \
1988" \n" \
1989" # /bin/sh invocations on selected ttys\n" \
1990" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001991" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001992" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001993" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001994" tty2::askfirst:-/bin/sh\n" \
1995" tty3::askfirst:-/bin/sh\n" \
1996" tty4::askfirst:-/bin/sh\n" \
1997" \n" \
1998" # /sbin/getty invocations for selected ttys\n" \
1999" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00002000" tty4::respawn:/sbin/getty 38400 tty4\n" \
2001" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002002" \n" \
2003" \n" \
2004" # Example of how to put a getty on a serial line (for a terminal)\n" \
2005" #\n" \
2006" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
2007" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
2008" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002009" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002010" #::respawn:/sbin/getty 57600 ttyS2\n" \
2011" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00002012" # Stuff to do when restarting the init process\n" \
2013" ::restart:/sbin/init\n" \
2014" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002015" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002016" ::ctrlaltdel:/sbin/reboot\n" \
2017" ::shutdown:/bin/umount -a -r\n" \
2018" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002019
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002020#define inotifyd_trivial_usage \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002021 "PROG FILE1[:MASK] ..."
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002022#define inotifyd_full_usage "\n\n" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002023 "Run PROG on filesystem changes." \
2024 "\nWhen a filesystem event matching MASK occurs on FILEn," \
2025 "\nPROG <actual_event(s)> <FILEn> [<subfile_name>] is run." \
Denis Vlasenko289ff0e2008-11-14 21:52:16 +00002026 "\nEvents:" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002027 "\n a File is accessed" \
2028 "\n c File is modified" \
2029 "\n e Metadata changed" \
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02002030 "\n w Writable file is closed" \
2031 "\n 0 Unwritable file is closed" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002032 "\n r File is opened" \
Denis Vlasenkoa09a42c2008-11-17 22:19:18 +00002033 "\n D File is deleted" \
2034 "\n M File is moved" \
2035 "\n u Backing fs is unmounted" \
2036 "\n o Event queue overflowed" \
2037 "\n x File can't be watched anymore" \
2038 "\nIf watching a directory:" \
2039 "\n m Subfile is moved into dir" \
2040 "\n y Subfile is moved out of dir" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002041 "\n n Subfile is created" \
2042 "\n d Subfile is deleted" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002043 "\n" \
2044 "\ninotifyd waits for PROG to exit." \
2045 "\nWhen x event happens for all FILEs, inotifyd exits" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002046
Denis Vlasenko36309cf2008-11-22 18:29:01 +00002047/* 2.6 style insmod has no options and required filename
2048 * (not module name - .ko can't be omitted) */
Eric Andersen7e9276b2001-02-22 01:15:47 +00002049#define insmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002050 IF_FEATURE_2_4_MODULES("[OPTIONS] MODULE ") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002051 IF_NOT_FEATURE_2_4_MODULES("FILE ") \
Denis Vlasenko36309cf2008-11-22 18:29:01 +00002052 "[symbol=value]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002053#define insmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002054 "Load the specified kernel modules into the kernel" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002055 IF_FEATURE_2_4_MODULES( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002056 "\nOptions:" \
2057 "\n -f Force module to load into the wrong kernel version" \
2058 "\n -k Make module autoclean-able" \
2059 "\n -v Verbose" \
2060 "\n -q Quiet" \
2061 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002062 IF_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002063 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00002064 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002065 "\n -o NAME Set internal module name to NAME" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002066 "\n -x Don't export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00002067 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00002068
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002069/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00002070#define install_trivial_usage \
Denis Vlasenko4acdb462009-01-31 21:45:57 +00002071 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [source] dest|directory"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002072#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002073 "Copy files and set attributes\n" \
2074 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002075 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002076 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002077 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002078 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002079 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002080 "\n -o USER Set ownership" \
2081 "\n -g GRP Set group ownership" \
2082 "\n -m MODE Set permissions" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002083 IF_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002084 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002085 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002086
Denis Vlasenko4acdb462009-01-31 21:45:57 +00002087#define ionice_trivial_usage \
2088 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
2089#define ionice_full_usage "\n\n" \
2090 "Change I/O scheduling class and priority\n" \
2091 "\nOptions:" \
2092 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
2093 "\n -n Priority" \
2094
Denis Vlasenko397de612008-03-17 08:55:44 +00002095/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002096#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00002097 "[OPTIONS] {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002098 IF_FEATURE_IP_ADDRESS("address | ") \
2099 IF_FEATURE_IP_ROUTE("route | ") \
2100 IF_FEATURE_IP_LINK("link | ") \
2101 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2102 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002103 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002104#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002105 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002106 "where OBJECT := {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002107 IF_FEATURE_IP_ADDRESS("address | ") \
2108 IF_FEATURE_IP_ROUTE("route | ") \
2109 IF_FEATURE_IP_LINK("link | ") \
2110 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2111 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002112 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002113 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002114
2115#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002116 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002117 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002118#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002119 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002120 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
2121 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002122 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002123 " [broadcast ADDR] [anycast ADDR]\n" \
2124 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002125 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002126
Eric Andersende4f07e2003-12-11 01:18:07 +00002127#define ipcalc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002128 "[OPTIONS] ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002129#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002130 "Calculate IP network settings from a IP address\n" \
2131 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002132 IF_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002133 "\n -b,--broadcast Display calculated broadcast address" \
2134 "\n -n,--network Display calculated network address" \
2135 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002136 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002137 "\n -p,--prefix Display the prefix for IP/NETMASK" \
2138 "\n -h,--hostname Display first resolved host name" \
2139 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002140 ) \
2141 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002142 IF_NOT_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002143 "\n -b Display calculated broadcast address" \
2144 "\n -n Display calculated network address" \
2145 "\n -m Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002146 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002147 "\n -p Display the prefix for IP/NETMASK" \
2148 "\n -h Display first resolved host name" \
2149 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002150 ) \
2151 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00002152
Rob Landley6eb1e412005-06-20 04:30:36 +00002153#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002154 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002155#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002156 "Upper-case options MQS remove an object by shmkey value.\n" \
2157 "Lower-case options remove an object by shmid value.\n" \
2158 "\nOptions:" \
2159 "\n -mM Remove memory segment after last detach" \
2160 "\n -qQ Remove message queue" \
2161 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002162
2163#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002164 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002165#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002166 " -i Show specific resource" \
2167 "\nResource specification:" \
2168 "\n -m Shared memory segments" \
2169 "\n -q Message queues" \
2170 "\n -s Semaphore arrays" \
2171 "\n -a All (default)" \
2172 "\nOutput format:" \
2173 "\n -t Time" \
2174 "\n -c Creator" \
2175 "\n -p Pid" \
2176 "\n -l Limits" \
2177 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002178
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002179#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002180 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002181#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00002182 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002183 " dynamic { on | off } |\n" \
2184 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002185 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002186
2187#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002188 "{ list | flush | { add | del | change | append |\n" \
2189 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002190#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002191 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002192 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
2193 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002194 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002195 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00002196 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
2197 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002198
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002199#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002200 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002201#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002202 "iprule [list | add | del] SELECTOR ACTION\n" \
2203 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2204 " [dev STRING] [pref NUMBER]\n" \
2205 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2206 " [prohibit | reject | unreachable]\n" \
2207 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002208 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002209
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002210#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002211 "{ add | change | del | show } [NAME]\n" \
2212 " [mode { ipip | gre | sit }]\n" \
2213 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002214#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002215 "iptunnel { add | change | del | show } [NAME]\n" \
2216 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2217 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002218 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002219
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002220#define kbd_mode_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002221 "[-a|k|s|u] [-C TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002222#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002223 "Report or set the keyboard mode\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002224 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002225 "\n -a Default (ASCII)" \
2226 "\n -k Medium-raw (keyboard)" \
2227 "\n -s Raw (scancode)" \
2228 "\n -u Unicode (utf-8)" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002229 "\n -C TTY Affect TTY instead of /dev/tty" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002230
Eric Andersen7e9276b2001-02-22 01:15:47 +00002231#define kill_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002232 "[-l] [-SIG] PID..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002233#define kill_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002234 "Send a signal (default: TERM) to given PIDs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002235 "\nOptions:" \
2236 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002237/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002238
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002239#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002240 "$ ps | grep apache\n" \
2241 "252 root root S [apache]\n" \
2242 "263 www-data www-data S [apache]\n" \
2243 "264 www-data www-data S [apache]\n" \
2244 "265 www-data www-data S [apache]\n" \
2245 "266 www-data www-data S [apache]\n" \
2246 "267 www-data www-data S [apache]\n" \
2247 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002248
2249#define killall_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002250 "[-l] [-q] [-SIG] process-name..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002251#define killall_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002252 "Send a signal (default: TERM) to given processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002253 "\nOptions:" \
2254 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002255/* "\n -s SIG Yet another way of specifying SIG" */ \
Denys Vlasenko07697852009-10-06 21:11:37 +02002256 "\n -q Don't complain if no processes were killed" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002257
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002258#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002259 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002260
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002261#define killall5_trivial_usage \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002262 "[-l] [-SIG] [-o PID]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002263#define killall5_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002264 "Send a signal (default: TERM) to all processes outside current session\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002265 "\nOptions:" \
2266 "\n -l List all signal names and numbers" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002267 "\n -o PID Don't signal this PID" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002268/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002269
Mark Whitley6317c4b2001-03-12 22:51:50 +00002270#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002271 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002272#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002273 "Kernel logger\n" \
2274 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002275 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002276 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002277
Eric Andersen7e9276b2001-02-22 01:15:47 +00002278#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002279 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002280#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002281 "Print STRING's length"
2282
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002283#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002284 "$ length Hello\n" \
2285 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002286
Rob Landley9200e792005-09-15 19:26:59 +00002287#define less_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002288 "[-EMNmh~I?] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002289#define less_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002290 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002291 "changed, and files can be manipulated in various ways.\n" \
2292 "\nOptions:" \
2293 "\n -E Quit once the end of a file is reached" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002294 "\n -M,-m Display status line with line numbers" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002295 "\n and percentage through the file" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002296 "\n -N Prefix line number to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002297 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002298 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002299
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002300#define linux32_trivial_usage NOUSAGE_STR
2301#define linux32_full_usage ""
2302#define linux64_trivial_usage NOUSAGE_STR
2303#define linux64_full_usage ""
2304
2305#define linuxrc_trivial_usage NOUSAGE_STR
2306#define linuxrc_full_usage ""
2307
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002308#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002309 "personality program [args...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002310#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002311 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002312 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002313 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002314
Eric Andersen7e9276b2001-02-22 01:15:47 +00002315#define ln_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002316 "[OPTIONS] TARGET... LINK|DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002317#define ln_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002318 "Create a link LINK or DIR/TARGET to the specified TARGET(s)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002319 "\nOptions:" \
2320 "\n -s Make symlinks instead of hardlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002321 "\n -f Remove existing destinations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002322 "\n -n Don't dereference symlinks - treat like normal file" \
2323 "\n -b Make a backup of the target (if exists) before link operation" \
2324 "\n -S suf Use suffix instead of ~ when making backup files" \
2325
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002326#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002327 "$ ln -s BusyBox /tmp/ls\n" \
2328 "$ ls -l /tmp/ls\n" \
2329 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002330
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002331#define load_policy_trivial_usage NOUSAGE_STR
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002332#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002333
Eric Andersen7e9276b2001-02-22 01:15:47 +00002334#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002335 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002336#define loadfont_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002337 "Load a console font from standard input" \
2338/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2339
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002340#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002341 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002342
2343#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002344 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002345#define loadkmap_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002346 "Load a binary keyboard translation table from standard input\n" \
2347/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2348
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002349#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002350 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002351
2352#define logger_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002353 "[OPTIONS] [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002354#define logger_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002355 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n" \
2356 "\nOptions:" \
2357 "\n -s Log to stderr as well as the system log" \
2358 "\n -t TAG Log using the specified tag (defaults to user name)" \
2359 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002360
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002361#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002362 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002363
Robert Griebl1fca5582002-06-04 20:45:46 +00002364#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002365 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002366#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002367 "Begin a new session on the system\n" \
2368 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002369 "\n -f Don't authenticate (user already authenticated)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002370 "\n -h Name of the remote host" \
2371 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002372
Eric Andersen7e9276b2001-02-22 01:15:47 +00002373#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002374 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002375#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002376 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002377#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002378 "$ logname\n" \
2379 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002380
Mark Whitley6317c4b2001-03-12 22:51:50 +00002381#define logread_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002382 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002383#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002384 "Show messages in syslogd's circular buffer\n" \
2385 "\nOptions:" \
2386 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002387
Matt Kraai83788da2002-03-20 17:38:37 +00002388#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002389 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2390 " losetup -d LOOPDEV - disassociate\n" \
2391 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002392#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002393 "Options:" \
2394 "\n -o OFS Start OFS bytes into FILE" \
2395 "\n -f Show first free loop device" \
2396
Rob Landley1d589b22005-11-29 23:47:10 +00002397#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002398 "No arguments will display all current associations.\n" \
2399 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002400 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002401 "and filename of the file the loop device is currently bound to.\n\n" \
2402 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002403 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2404 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002405
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002406#define lpd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002407 "SPOOLDIR [HELPER [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002408#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002409 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2410 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002411 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002412 "\ndirectory and HELPER program is called. Name of file to print" \
2413 "\nis passed in $DATAFILE variable." \
2414 "\nExample:" \
2415 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002416
Denis Vlasenko68444b92008-02-22 22:24:48 +00002417#define lpq_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002418 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID...] [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002419#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002420 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002421 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002422 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002423 "\n -f Force any waiting job to be printed" \
2424 "\n -s Short display" \
2425
2426#define lpr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002427 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE]..."
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002428/* -C CLASS exists too, not shown.
2429 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002430#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002431 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002432 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002433 "\n -m Send mail on completion" \
2434 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002435 "\n -V Verbose" \
2436
Eric Andersen7e9276b2001-02-22 01:15:47 +00002437#define ls_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002438 "[-1Aa" IF_FEATURE_LS_TIMESTAMPS("c") "Cd" \
2439 IF_FEATURE_LS_TIMESTAMPS("e") IF_FEATURE_LS_FILETYPES("F") "iln" \
2440 IF_FEATURE_LS_FILETYPES("p") IF_FEATURE_LS_FOLLOWLINKS("L") \
2441 IF_FEATURE_LS_RECURSIVE("R") IF_FEATURE_LS_SORTFILES("rS") "s" \
2442 IF_FEATURE_AUTOWIDTH("T") IF_FEATURE_LS_TIMESTAMPS("tu") \
2443 IF_FEATURE_LS_SORTFILES("v") IF_FEATURE_AUTOWIDTH("w") "x" \
2444 IF_FEATURE_LS_SORTFILES("X") IF_FEATURE_HUMAN_READABLE("h") "k" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002445 IF_SELINUX("K") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002446#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002447 "List directory contents\n" \
2448 "\nOptions:" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002449 "\n -1 List in a single column" \
2450 "\n -A Don't list . and .." \
2451 "\n -a Don't hide entries starting with ." \
2452 "\n -C List by columns" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002453 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002454 "\n -c With -l: sort by ctime") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002455 IF_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002456 "\n --color[={always,never,auto}] Control coloring") \
2457 "\n -d List directory entries instead of contents" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002458 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002459 "\n -e List full date and time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002460 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002461 "\n -F Append indicator (one of */=@|) to entries") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002462 "\n -i List inode numbers" \
2463 "\n -l Long listing format" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002464 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002465 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002466 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002467 IF_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002468 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002469 IF_FEATURE_LS_RECURSIVE( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002470 "\n -R Recurse") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002471 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002472 "\n -r Sort in reverse order") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002473 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002474 "\n -S Sort by file size") \
Denis Vlasenko397de612008-03-17 08:55:44 +00002475 "\n -s List the size of each file, in blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002476 IF_FEATURE_AUTOWIDTH( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002477 "\n -T N Assume tabstop every N columns") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002478 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002479 "\n -t With -l: sort by modification time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002480 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002481 "\n -u With -l: sort by access time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002482 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002483 "\n -v Sort by version") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002484 IF_FEATURE_AUTOWIDTH( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002485 "\n -w N Assume the terminal is N columns wide") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002486 "\n -x List by lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002487 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002488 "\n -X Sort by extension") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002489 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002490 "\n -h List sizes in human readable format (1K 243M 2G)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002491 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002492 "\n -k List security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002493 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002494 "\n -K List security context in long format") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002495 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002496 "\n -Z List security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002497
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002498#define lsattr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002499 "[-Radlv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002500#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002501 "List file attributes on an ext2 fs\n" \
2502 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002503 "\n -R Recurse" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002504 "\n -a Don't hide entries starting with ." \
Denis Vlasenko397de612008-03-17 08:55:44 +00002505 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002506 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002507 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002508
Eric Andersen7e9276b2001-02-22 01:15:47 +00002509#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002510 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002511#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002512 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002513
Souf Oued982bc712009-12-05 17:56:25 +01002514#define lspci_trivial_usage \
2515 "[-mk]"
2516#define lspci_full_usage "\n\n" \
2517 "List all PCI devices" \
2518 "\n" \
2519 "\n -m Parseable output" \
2520 "\n -k Show driver" \
2521
Souf Oued11a802a2009-12-07 01:37:34 +01002522#define lsusb_trivial_usage NOUSAGE_STR
2523#define lsusb_full_usage ""
2524
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002525#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002526#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002527 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002528#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002529 "Create a range of block or character special files" \
2530 "\n" \
2531 "\nTYPE is:" \
2532 "\n b Block device" \
2533 "\n c Character device" \
2534 "\n f FIFO, MAJOR and MINOR are ignored" \
2535 "\n" \
2536 "\nFIRST..LAST specify numbers appended to NAME." \
2537 "\nIf 's' is the last argument, the base device is created as well." \
2538 "\n" \
2539 "\nExamples:" \
2540 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2541 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002542#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002543 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2544 "[creates ttyS2-ttyS63]\n" \
2545 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2546 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002547#endif
2548
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002549#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002550#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002551 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002552#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002553 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002554 "Device table entries take the form of:\n" \
2555 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002556 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002557 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002558 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002559 " c Character device\n" \
2560 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002561 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002562 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002563 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2564 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002565#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002566 "For example:\n" \
2567 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2568 "/dev d 755 0 0 - - - - -\n" \
2569 "/dev/console c 666 0 0 5 1 - - -\n" \
2570 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2571 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2572 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2573 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2574 "Will Produce:\n" \
2575 "/dev\n" \
2576 "/dev/console\n" \
2577 "/dev/null\n" \
2578 "/dev/zero\n" \
2579 "/dev/hda\n" \
2580 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002581#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002582
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002583#define makemime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002584 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002585#define makemime_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002586 "Create multipart MIME-encoded message from FILEs\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002587/* "Transfer encoding is base64, disposition is inline (not attachment)\n" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002588 "\nOptions:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002589 "\n -o FILE Output. Default: stdout" \
2590 "\n -a HDR Add header. Examples:" \
2591 "\n \"From: user@host.org\", \"Date: `date -R`\"" \
2592 "\n -c CT Content type. Default: text/plain" \
2593 "\n -C CS Charset. Default: " CONFIG_FEATURE_MIME_CHARSET \
2594/* "\n -e ENC Transfer encoding. Ignored. base64 is assumed" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002595 "\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002596 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002597
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002598#define man_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002599 "[OPTIONS] [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002600#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002601 "Format and display manual page\n" \
2602 "\nOptions:" \
2603 "\n -a Display all pages" \
2604 "\n -w Show page locations" \
2605
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002606#define matchpathcon_trivial_usage \
2607 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002608#define matchpathcon_full_usage "\n\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002609 " -n Don't display path" \
2610 "\n -N Don't use translations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002611 "\n -f Use alternate file_context file" \
2612 "\n -p Use prefix to speed translations" \
2613 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002614
Eric Andersen7e9276b2001-02-22 01:15:47 +00002615#define md5sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002616 "[OPTIONS] [FILE]..." \
2617 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTIONS] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002618#define md5sum_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002619 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2620 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002621 "\nOptions:" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002622 "\n -c Check sums against given list" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002623 "\n -s Don't output anything, status code shows success" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002624 "\n -w Warn about improperly formatted checksum lines" \
2625 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002626
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002627#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002628 "$ md5sum < busybox\n" \
2629 "6fd11e98b98a58f64ff3398d7b324003\n" \
2630 "$ md5sum busybox\n" \
2631 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2632 "$ md5sum -c -\n" \
2633 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2634 "busybox: OK\n" \
2635 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002636
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002637#define sha1sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002638 "[OPTIONS] [FILE]..." \
2639 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002640#define sha1sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002641 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002642 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002643 "\nOptions:" \
2644 "\n -c Check sums against given list" \
2645 "\n -s Don't output anything, status code shows success" \
2646 "\n -w Warn about improperly formatted checksum lines" \
2647 )
2648
2649#define sha256sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002650 "[OPTIONS] [FILE]..." \
2651 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha256sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002652#define sha256sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002653 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA256 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002654 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002655 "\nOptions:" \
2656 "\n -c Check sums against given list" \
2657 "\n -s Don't output anything, status code shows success" \
2658 "\n -w Warn about improperly formatted checksum lines" \
2659 )
2660
2661#define sha512sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002662 "[OPTIONS] [FILE]..." \
2663 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha512sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002664#define sha512sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002665 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA512 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002666 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002667 "\nOptions:" \
2668 "\n -c Check sums against given list" \
2669 "\n -s Don't output anything, status code shows success" \
2670 "\n -w Warn about improperly formatted checksum lines" \
2671 )
2672
Rob Landley70f7ef72005-12-13 08:21:33 +00002673#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002674 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002675#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002676 " -s Scan /sys and populate /dev during system boot\n" \
2677 "\n" \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002678 "It can be run by kernel as a hotplug helper. To activate it:\n" \
Denys Vlasenkof92874e2009-12-05 15:59:05 +01002679 " echo /sbin/mdev > /proc/sys/kernel/hotplug\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002680 IF_FEATURE_MDEV_CONF( \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002681 "It uses /etc/mdev.conf with lines\n" \
Denis Vlasenkof2b39e02009-04-13 23:18:52 +00002682 "[-]DEVNAME UID:GID PERM" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002683 IF_FEATURE_MDEV_RENAME(" [>|=PATH]") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002684 IF_FEATURE_MDEV_EXEC(" [@|$|*PROG]") \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002685 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002686
Rob Landleyef10d522006-06-26 14:11:33 +00002687#define mdev_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002688 IF_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002689 "The mdev config file contains lines that look like:\n" \
2690 " hd[a-z][0-9]* 0:3 660\n\n" \
2691 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002692 IF_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002693 "Optionally, that can be followed (on the same line) by a special character\n" \
2694 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002695 "device(s). The environment variable $MDEV indicates the active device node\n" \
2696 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002697 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2698 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002699 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002700 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002701 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002702 "Config file parsing stops on the first matching line. If no config\n" \
2703 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002704 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002705 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002706
Glenn L McGrath061c9002002-09-16 04:21:46 +00002707#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002708 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002709#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002710 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002711 " y Allow write access to your terminal\n" \
2712 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002713
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002714#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002715 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002716#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002717 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2718 "\nOptions:" \
2719 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2720 "\n next byte to it" \
2721 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2722 "\n -s Set serial line to SPEED" \
2723 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002724
Eric Andersen7e9276b2001-02-22 01:15:47 +00002725#define mkdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002726 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002727#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002728 "Create DIRECTORY\n" \
2729 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002730 "\n -m Mode" \
2731 "\n -p No error if exists; make parent directories as needed" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002732 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002733 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002734 )
2735
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002736#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002737 "$ mkdir /tmp/foo\n" \
2738 "$ mkdir /tmp/foo\n" \
2739 "/tmp/foo: File exists\n" \
2740 "$ mkdir /tmp/foo/bar/baz\n" \
2741 "/tmp/foo/bar/baz: No such file or directory\n" \
2742 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002743
Eric Andersen7e9276b2001-02-22 01:15:47 +00002744#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002745 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002746#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002747 "Create named pipe (identical to 'mknod name p')\n" \
2748 "\nOptions:" \
2749 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002750 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002751 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002752 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002753
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002754#define mkfs_ext2_trivial_usage \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002755 "[-Fn] " \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002756 /* "[-c|-l filename] " */ \
2757 "[-b BLK_SIZE] " \
2758 /* "[-f fragment-size] [-g blocks-per-group] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002759 "[-i INODE_RATIO] [-I INODE_SIZE] " \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002760 /* "[-j] [-J journal-options] [-N number-of-inodes] " */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002761 "[-m RESERVED_PERCENT] " \
2762 /* "[-o creator-os] [-O feature[,...]] [-q] " */ \
2763 /* "[r fs-revision-level] [-E extended-options] [-v] [-F] " */ \
2764 "[-L LABEL] " \
2765 /* "[-M last-mounted-directory] [-S] [-T filesystem-type] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002766 "BLOCKDEV [KBYTES]"
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002767#define mkfs_ext2_full_usage "\n" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002768 "\n -b BLK_SIZE Block size, bytes" \
2769/* "\n -c Check device for bad blocks" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002770/* "\n -E opts Set extended options" */ \
2771/* "\n -f size Fragment size in bytes" */ \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002772 "\n -F Force" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002773/* "\n -g N Number of blocks in a block group" */ \
Denys Vlasenko838e07a2009-10-22 12:15:33 +02002774 "\n -i RATIO Max number of files is filesystem_size / RATIO" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002775 "\n -I BYTES Inode size (min 128)" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002776/* "\n -j Create a journal (ext3)" */ \
2777/* "\n -J opts Set journal options (size/device)" */ \
2778/* "\n -l file Read bad blocks list from file" */ \
Denys Vlasenko6a8cfdc2009-10-17 23:41:15 +02002779 "\n -L LBL Volume label" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002780 "\n -m PERCENT Percent of blocks to reserve for admin" \
2781/* "\n -M dir Set last mounted directory" */ \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002782 "\n -n Dry run" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002783/* "\n -N N Number of inodes to create" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002784/* "\n -o os Set the 'creator os' field" */ \
2785/* "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" */ \
2786/* "\n -q Quiet" */ \
2787/* "\n -r rev Set filesystem revision" */ \
2788/* "\n -S Write superblock and group descriptors only" */ \
2789/* "\n -T fs-type Set usage type (news/largefile/largefile4)" */ \
2790/* "\n -v Verbose" */ \
2791
Eric Andersen7e9276b2001-02-22 01:15:47 +00002792#define mkfs_minix_trivial_usage \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002793 "[-c | -l filename] [-nXX] [-iXX] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002794#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002795 "Make a MINIX filesystem\n" \
2796 "\nOptions:" \
2797 "\n -c Check device for bad blocks" \
2798 "\n -n [14|30] Maximum length of filenames" \
2799 "\n -i INODES Number of inodes for the filesystem" \
2800 "\n -l FILENAME Read bad blocks list from FILENAME" \
2801 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002802
Vladimir Dronnikov0d8ea642009-11-02 10:41:46 +01002803#define mkfs_reiser_trivial_usage \
2804 "[-f] [-l LABEL] BLOCKDEV [4K-BLOCKS]"
2805
2806#define mkfs_reiser_full_usage "\n\n" \
2807 "Make a ReiserFS V3 filesystem\n" \
2808 "\nOptions:" \
2809 "\n -f Force" \
2810 "\n -l LBL Volume label" \
2811
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002812#define mkfs_vfat_trivial_usage \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002813 "[-v] [-n LABEL] BLOCKDEV [KBYTES]"
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002814/* Accepted but ignored:
2815 "[-c] [-C] [-I] [-l bad-block-file] [-b backup-boot-sector] "
2816 "[-m boot-msg-file] [-i volume-id] "
2817 "[-s sectors-per-cluster] [-S logical-sector-size] [-f number-of-FATs] "
2818 "[-h hidden-sectors] [-F fat-size] [-r root-dir-entries] [-R reserved-sectors] "
2819*/
2820#define mkfs_vfat_full_usage "\n\n" \
2821 "Make a FAT32 filesystem\n" \
2822 "\nOptions:" \
2823/* "\n -c Check device for bad blocks" */ \
2824 "\n -v Verbose" \
2825/* "\n -I Allow to use entire disk device (e.g. /dev/hda)" */ \
2826 "\n -n LBL Volume label" \
2827
Eric Andersen7e9276b2001-02-22 01:15:47 +00002828#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002829 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002830#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002831 "Create a special file (block, character, or pipe)\n" \
2832 "\nOptions:" \
2833 "\n -m Create the special file using the specified mode (default a=rw)" \
2834 "\nTYPEs include:" \
2835 "\n b: Make a block device" \
2836 "\n c or u: Make a character device" \
2837 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002838 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002839 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002840 )
2841
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002842#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002843 "$ mknod /dev/fd0 b 2 0\n" \
2844 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002845
Eric Andersen7e9276b2001-02-22 01:15:47 +00002846#define mkswap_trivial_usage \
Denys Vlasenko40e7d252010-02-01 23:48:27 +01002847 "[OPTIONS] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002848#define mkswap_full_usage "\n\n" \
Denys Vlasenko68c67462009-11-03 05:51:20 +01002849 "Prepare BLOCKDEV to be used as swap partition\n" \
2850 "\nOptions:" \
2851 "\n -L LBL Label" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002852
Eric Andersen7e9276b2001-02-22 01:15:47 +00002853#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002854 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002855#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002856 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002857 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002858 "\nOptions:" \
2859 "\n -d Make a directory instead of a file" \
2860/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2861 "\n -t Generate a path rooted in temporary directory" \
2862 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2863 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002864 "\nFor -t or -p, directory is chosen as follows:" \
2865 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002866
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002867#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002868 "$ mktemp /tmp/temp.XXXXXX\n" \
2869 "/tmp/temp.mWiLjM\n" \
2870 "$ ls -la /tmp/temp.mWiLjM\n" \
2871 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002872
Eric Andersen8d79ce82001-07-22 23:00:15 +00002873#define modprobe_trivial_usage \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002874 IF_MODPROBE_SMALL("[-qfwrsv] MODULE [symbol=value...]") \
2875 IF_NOT_MODPROBE_SMALL("[-" \
2876 IF_FEATURE_2_4_MODULES("k")"nqrsv" \
2877 IF_FEATURE_MODPROBE_BLACKLIST("b")"] MODULE [symbol=value...]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002878#define modprobe_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002879 "Options:" \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002880 IF_MODPROBE_SMALL( \
2881 "\n -q Quiet" \
2882 "\n -f Force" \
2883 "\n -w Wait for unload" \
2884 "\n -r Remove module (stacks) or do autoclean" \
2885 "\n -s Report via syslog instead of stderr" \
2886 "\n -v Verbose" \
2887 ) \
2888 IF_NOT_MODPROBE_SMALL( \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002889 IF_FEATURE_2_4_MODULES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002890 "\n -k Make module autoclean-able" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002891 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002892 "\n -n Dry run" \
2893 "\n -q Quiet" \
2894 "\n -r Remove module (stacks) or do autoclean" \
2895 "\n -s Report via syslog instead of stderr" \
2896 "\n -v Verbose" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002897 IF_FEATURE_MODPROBE_BLACKLIST( \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002898 "\n -b Apply blacklist to module names too" \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002899 ) \
2900 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002901
Rob Landley9c32a152005-12-11 20:12:24 +00002902#define modprobe_notes_usage \
2903"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2904"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2905"pass each module it loads.\n" \
2906"\n" \
Bernhard Reutner-Fischer12aca792009-02-24 10:03:22 +00002907"The configuration file is searched (in this order):\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002908"\n" \
2909" /etc/modprobe.conf (2.6 only)\n" \
2910" /etc/modules.conf\n" \
2911" /etc/conf.modules (deprecated)\n" \
2912"\n" \
2913"They all have the same syntax (see below). If none is present, it is\n" \
2914"_not_ an error; each loaded module is then expected to load without\n" \
2915"options. Once a file is found, the others are tested for.\n" \
2916"\n" \
2917"/etc/modules.conf entry format:\n" \
2918"\n" \
2919" alias <alias_name> <mod_name>\n" \
2920" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002921" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002922" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2923" This makes it also possible to use a different set of options (below) for\n" \
2924" the module and the alias.\n" \
2925" A module can be aliased more than once.\n" \
2926"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002927" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002928" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2929" the \"symbol=value\" pairs as option to that module.\n" \
2930"\n" \
2931"Sample /etc/modules.conf file:\n" \
2932"\n" \
2933" options tulip irq=3\n" \
2934" alias tulip tulip2\n" \
2935" options tulip2 irq=4 io=0x308\n" \
2936"\n" \
2937"Other functionality offered by 'classic' modprobe is not available in\n" \
2938"this implementation.\n" \
2939"\n" \
2940"If module options are present both in the config file, and on the command line,\n" \
2941"then the options from the command line will be passed to the module _after_\n" \
2942"the options from the config file. That way, you can have defaults in the config\n" \
2943"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002944#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002945 "(with the above /etc/modules.conf):\n\n" \
2946 "$ modprobe tulip\n" \
2947 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2948 "$ modprobe tulip irq=5\n" \
2949 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2950 "$ modprobe tulip2\n" \
2951 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2952 " which are the default for alias 'tulip2'\n\n" \
2953 "$ modprobe tulip2 irq=8\n" \
2954 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2955 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2956 " from the command line\n\n" \
2957 "$ modprobe tulip2 irq=2 io=0x210\n" \
2958 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2959 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2960 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002961
Eric Andersen7e9276b2001-02-22 01:15:47 +00002962#define more_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002963 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002964#define more_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002965 "View FILE or standard input one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002966
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002967#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002968 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002969
Eric Andersen7e9276b2001-02-22 01:15:47 +00002970#define mount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002971 "[OPTIONS] [-o OPTS] DEVICE NODE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002972#define mount_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002973 "Mount a filesystem. Filesystem autodetection requires /proc.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002974 "\nOptions:" \
2975 "\n -a Mount all filesystems in fstab" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002976 IF_FEATURE_MOUNT_FAKE( \
2977 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002978 "\n -f Update /etc/mtab, but don't mount" \
2979 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002980 IF_NOT_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002981 "\n -f Dry run" \
2982 ) \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002983 ) \
Denys Vlasenkoe2e4cc22009-06-19 11:48:29 +02002984 IF_FEATURE_MOUNT_HELPERS( \
2985 "\n -i Don't run mount helper" \
2986 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002987 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002988 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002989 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002990 "\n -r Read-only mount" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002991 "\n -w Read-write mount (default)" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002992 "\n -t FSTYPE Filesystem type" \
2993 "\n -O OPT Mount only filesystems with option OPT (-a only)" \
2994 "\n-o OPT:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002995 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002996 "\n loop Ignored (loop devices are autodetected)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002997 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002998 IF_FEATURE_MOUNT_FLAGS( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002999 "\n [a]sync Writes are [a]synchronous" \
3000 "\n [no]atime Disable/enable updates to inode access times" \
3001 "\n [no]diratime Disable/enable atime updates to directories" \
3002 "\n [no]relatime Disable/enable atime updates relative to modification time" \
3003 "\n [no]dev (Dis)allow use of special device files" \
3004 "\n [no]exec (Dis)allow use of executable files" \
3005 "\n [no]suid (Dis)allow set-user-id-root programs" \
3006 "\n [r]shared Convert [recursively] to a shared subtree" \
3007 "\n [r]slave Convert [recursively] to a slave subtree" \
3008 "\n [r]private Convert [recursively] to a private subtree" \
3009 "\n [un]bindable Make mount point [un]able to be bind mounted" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003010 "\n bind Bind a file or directory to another location" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003011 "\n move Relocate an existing mount point" \
Rob Landleye55a73c2006-08-09 20:55:35 +00003012 ) \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003013 "\n remount Remount a mounted filesystem, changing flags" \
3014 "\n ro/rw Same as -r/-w" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003015 "\n" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003016 "\nThere are filesystem-specific -o flags." \
Denis Vlasenko397de612008-03-17 08:55:44 +00003017
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003018#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003019 "$ mount\n" \
3020 "/dev/hda3 on / type minix (rw)\n" \
3021 "proc on /proc type proc (rw)\n" \
3022 "devpts on /dev/pts type devpts (rw)\n" \
3023 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
3024 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
3025 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00003026#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003027 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003028
Rob Landleyd00b3a52005-08-20 05:07:08 +00003029#define mountpoint_trivial_usage \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003030 "[-q] <[-dn] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003031#define mountpoint_full_usage "\n\n" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003032 "Check if the directory is a mountpoint\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003033 "\nOptions:" \
3034 "\n -q Quiet" \
3035 "\n -d Print major/minor device number of the filesystem" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003036 "\n -n Print device name of the filesystem" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003037 "\n -x Print major/minor device number of the blockdevice" \
3038
Rob Landleyd00b3a52005-08-20 05:07:08 +00003039#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003040 "$ mountpoint /proc\n" \
3041 "/proc is not a mountpoint\n" \
3042 "$ mountpoint /sys\n" \
3043 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00003044
Eric Andersen7e9276b2001-02-22 01:15:47 +00003045#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003046 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003047#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003048 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003049 "\n" \
3050 "Available Opcodes:\n" \
3051 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003052 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
3053 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
3054 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003055 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003056
Eric Andersen7e9276b2001-02-22 01:15:47 +00003057#define mv_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003058 "[OPTIONS] SOURCE DEST\n" \
3059 "or: mv [OPTIONS] SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003060#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003061 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
3062 "\nOptions:" \
3063 "\n -f Don't prompt before overwriting" \
3064 "\n -i Interactive, prompt before overwrite" \
3065
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003066#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003067 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003068
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003069#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003070 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003071#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003072 "Rename network interface while it in the down state\n" \
3073 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003074 "\n -c FILE Use configuration file (default: /etc/mactab)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003075 "\n -s Use syslog (LOCAL0 facility)" \
3076 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
3077
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003078#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003079 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
3080 " or\n" \
3081 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003082
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003083#if !ENABLE_DESKTOP
3084
Rob Landley1cca9482006-07-10 19:45:20 +00003085#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003086#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003087#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003088#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003089#endif
Rob Landley1cca9482006-07-10 19:45:20 +00003090
Eric Andersen7e9276b2001-02-22 01:15:47 +00003091#define nc_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003092 IF_NC_EXTRA("[-iN] [-wN] ")IF_NC_SERVER("[-l] [-p PORT] ") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003093 "["IF_NC_EXTRA("-f FILENAME|")"IPADDR PORT]"IF_NC_EXTRA(" [-e PROG]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003094#define nc_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003095 "Open a pipe to IP:port" IF_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003096 NC_OPTIONS_STR \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003097 IF_NC_EXTRA( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003098 "\n -e PROG Run PROG after connect" \
3099 "\n -i SEC Delay interval for lines sent" \
3100 "\n -w SEC Timeout for connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003101 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003102 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003103 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003104 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003105 IF_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003106 "\n (use -l twice with -e for persistent server)") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003107 "\n -p PORT Local port" \
Rob Landley1cca9482006-07-10 19:45:20 +00003108 )
3109
Rob Landley1cca9482006-07-10 19:45:20 +00003110#define nc_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003111 IF_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003112 "To use netcat as a terminal emulator on a serial port:\n\n" \
3113 "$ stty 115200 -F /dev/ttyS0\n" \
3114 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
3115 )
Rob Landley1cca9482006-07-10 19:45:20 +00003116
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003117#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003118 "$ nc foobar.somedomain.com 25\n" \
3119 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
3120 "help\n" \
3121 "214-Commands supported:\n" \
3122 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
3123 "214 NOOP QUIT RSET HELP\n" \
3124 "quit\n" \
3125 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003126
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003127#else /* DESKTOP nc - much more compatible with nc 1.10 */
3128
3129#define nc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003130 "[OPTIONS] HOST PORT - connect" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003131 IF_NC_SERVER("\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003132 "nc [OPTIONS] -l -p PORT [HOST] [PORT] - listen")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003133#define nc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003134 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003135 "\n -e PROG Run PROG after connect (must be last)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003136 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003137 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003138 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003139 "\n -n Don't do DNS resolution" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003140 "\n -s ADDR Local address" \
3141 "\n -p PORT Local port" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003142 "\n -u UDP mode" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003143 "\n -v Verbose" \
3144 "\n -w SEC Timeout for connects and final net reads" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003145 IF_NC_EXTRA( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003146 "\n -i SEC Delay interval for lines sent" /* ", ports scanned" */ \
3147 "\n -o FILE Hex dump traffic" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003148 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003149 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003150/* "\n -r Randomize local and remote ports" */
3151/* "\n -g gateway Source-routing hop point[s], up to 8" */
3152/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003153/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
3154
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003155/* -e PROG can take ARGS too: "nc ... -e ls -l", but we don't document it
3156 * in help text: nc 1.10 does not allow that. We don't want to entice
3157 * users to use this incompatibility */
3158
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003159#endif
3160
Eric Andersen1552ff72001-10-31 11:07:12 +00003161#define netstat_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003162 "[-laentuwxr"IF_FEATURE_NETSTAT_WIDE("W")IF_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003163#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003164 "Display networking information\n" \
3165 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003166 "\n -l Display listening server sockets" \
3167 "\n -a Display all sockets (default: connected)" \
3168 "\n -e Display other/more information" \
3169 "\n -n Don't resolve names" \
3170 "\n -t Tcp sockets" \
3171 "\n -u Udp sockets" \
3172 "\n -w Raw sockets" \
3173 "\n -x Unix sockets" \
3174 "\n -r Display routing table" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003175 IF_FEATURE_NETSTAT_WIDE( \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003176 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003177 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003178 IF_FEATURE_NETSTAT_PRG( \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003179 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003180 )
Eric Andersen1552ff72001-10-31 11:07:12 +00003181
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003182#define nice_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003183 "[-n ADJUST] [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003184#define nice_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003185 "Run PROG with modified scheduling priority\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003186 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003187 "\n -n ADJUST Adjust priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003188
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003189#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003190 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003191#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003192 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003193 "Format specifiers:\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003194 " %Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003195 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003196 " %[niface] Monitor network interface 'iface'\n" \
3197 " %m Monitor allocated memory\n" \
3198 " %[mf] Monitor free memory\n" \
3199 " %[mt] Monitor total memory\n" \
3200 " %s Monitor allocated swap\n" \
3201 " %f Monitor number of used file descriptors\n" \
3202 " %Ni Monitor total/specific IRQ rate\n" \
3203 " %x Monitor context switch rate\n" \
3204 " %p Monitor forks\n" \
3205 " %[pn] Monitor # of processes\n" \
3206 " %b Monitor block io\n" \
3207 " %Nt Show time (with N decimal points)\n" \
3208 " %Nd Milliseconds between updates (default:1000)\n" \
3209 " %r Print <cr> instead of <lf> at EOL" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003210
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003211#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003212 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003213
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003214#define nohup_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003215 "PROG [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003216#define nohup_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003217 "Run PROG immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003218#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003219 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003220
Eric Andersen7e9276b2001-02-22 01:15:47 +00003221#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003222 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003223#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003224 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003225 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003226#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003227 "$ nslookup localhost\n" \
3228 "Server: default\n" \
3229 "Address: default\n" \
3230 "\n" \
3231 "Name: debian\n" \
3232 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003233
Adam Tkacb1585062009-11-22 03:43:55 +01003234#define ntpd_trivial_usage \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01003235 "[-dnqwl] [-S PROG] [-p PEER]..."
Adam Tkacb1585062009-11-22 03:43:55 +01003236#define ntpd_full_usage "\n\n" \
3237 "NTP client/server\n" \
3238 "\nOptions:" \
3239 "\n -d Verbose" \
3240 "\n -n Do not daemonize" \
Denys Vlasenko8d580c72009-11-23 16:27:16 +01003241 "\n -q Quit after clock is set" \
Denys Vlasenko907647f2009-12-02 23:17:45 +01003242/* -N exists for mostly compat reasons, thus not essential to inform */ \
Denys Vlasenkob2e5fc32009-11-25 14:52:47 +01003243/* the user that it exists: user may use nice as well */ \
3244/* "\n -N Run at high priority" */ \
Denys Vlasenko074e8dc2010-01-04 23:58:13 +01003245 "\n -w Do not set time (only query peers), implies -n" \
Adam Tkacb1585062009-11-22 03:43:55 +01003246 "\n -l Run as server on port 123" \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01003247 "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins" \
Adam Tkacb1585062009-11-22 03:43:55 +01003248 "\n -p PEER Obtain time from PEER (may be repeated)" \
3249
Glenn L McGrath60281112001-11-02 11:39:46 +00003250#define od_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003251 "[-aBbcDdeFfHhIiLlOovXx] " IF_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003252#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003253 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003254 "(or standard input) to standard output."
Glenn L McGrath60281112001-11-02 11:39:46 +00003255
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003256#define openvt_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003257 "[-c N] [-sw] [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003258#define openvt_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003259 "Start PROG on a new virtual terminal\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003260 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003261 "\n -c N Use specified VT" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003262 "\n -s Switch to the VT" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003263/* "\n -l Run PROG as login shell (by prepending '-')" */ \
3264 "\n -w Wait for PROG to exit" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003265
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003266#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003267 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003268
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003269/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003270#define parse_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003271 "[-n MAXTOKENS] [-m MINTOKENS] [-d DELIMS] [-f FLAGS] FILE..."
3272#define parse_full_usage ""
3273*/
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003274
Eric Andersen27f64e12002-06-23 04:24:25 +00003275#define passwd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003276 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003277#define passwd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003278 "Change USER's password. If no USER is specified,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003279 "changes the password for the current user.\n" \
3280 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003281 "\n -a Algorithm to use for password (des, md5)" /* ", sha1)" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00003282 "\n -d Delete password for the account" \
3283 "\n -l Lock (disable) account" \
3284 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003285
Denis Vlasenko21d10142007-07-20 21:28:41 +00003286#define chpasswd_trivial_usage \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003287 IF_LONG_OPTS("[--md5|--encrypted]") IF_NOT_LONG_OPTS("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003288#define chpasswd_full_usage "\n\n" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003289 "Read user:password from stdin and update /etc/passwd\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003290 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003291 IF_LONG_OPTS( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003292 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003293 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003294 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003295 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003296 "\n -e Supplied passwords are in encrypted form" \
3297 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003298 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00003299
Glenn L McGrath655d8142003-06-22 15:32:41 +00003300#define patch_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003301 "[OPTIONS] [ORIGFILE [PATCHFILE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003302#define patch_full_usage "\n\n" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003303 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003304 " -p,--strip N Strip N leading components from file names" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003305 "\n -i,--input DIFF Read DIFF instead of stdin" \
3306 "\n -R,--reverse Reverse patch" \
3307 "\n -N,--forward Ignore already applied patches" \
3308 "\n --dry-run Don't actually change files" \
3309 ) \
3310 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003311 " -p N Strip N leading components from file names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003312 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003313 "\n -R Reverse patch" \
Denys Vlasenkod7874ed2009-08-20 23:33:19 +02003314 "\n -N Ignore already applied patches" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003315 )
Denis Vlasenko397de612008-03-17 08:55:44 +00003316
Glenn L McGrath655d8142003-06-22 15:32:41 +00003317#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003318 "$ patch -p1 < example.diff\n" \
3319 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00003320
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003321#define pgrep_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003322 "[-flnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003323#define pgrep_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003324 "Display process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003325 "\nOptions:" \
3326 "\n -l Show command name too" \
3327 "\n -f Match against entire command line" \
3328 "\n -n Show the newest process only" \
3329 "\n -o Show the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003330 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003331 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003332 "\n -s Match session ID (0 for current)" \
3333 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003334
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003335#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00003336#define pidof_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003337 "[OPTIONS] [NAME...]"
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003338#define USAGE_PIDOF "\n\nOptions:"
3339#else
3340#define pidof_trivial_usage \
3341 "[NAME...]"
3342#define USAGE_PIDOF /* none */
3343#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003344#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003345 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003346 USAGE_PIDOF \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003347 IF_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003348 "\n -s Show only one PID") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003349 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003350 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003351 "\n Use %PPID to omit pid of pidof's parent") \
3352
Eric Andersen221b2ea2001-07-31 19:06:07 +00003353#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003354 "$ pidof init\n" \
3355 "1\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003356 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003357 "$ pidof /bin/sh\n20351 5973 5950\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003358 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003359 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00003360
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003361#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003362#define ping_trivial_usage \
3363 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003364#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003365 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003366#define ping6_trivial_usage \
3367 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003368#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003369 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003370#else
3371#define ping_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003372 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003373#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003374 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3375 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003376 "\n -4, -6 Force IP or IPv6 name resolution" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003377 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003378 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3379 "\n -I IFACE/IP Use interface or IP address as source" \
3380 "\n -W SEC Seconds to wait for the first response (default:10)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003381 "\n (after all -c CNT packets are sent)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003382 "\n -w SEC Seconds until ping exits (default:infinite)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003383 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003384 "\n -q Quiet, only displays output at start" \
3385 "\n and when finished" \
3386
Eric Andersen51b8bd62002-07-03 11:46:38 +00003387#define ping6_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003388 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003389#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003390 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3391 "\nOptions:" \
3392 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003393 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3394 "\n -I IFACE/IP Use interface or IP address as source" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003395 "\n -q Quiet, only displays output at start" \
3396 "\n and when finished" \
3397
Eric Andersen51b8bd62002-07-03 11:46:38 +00003398#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003399#define ping_example_usage \
3400 "$ ping localhost\n" \
3401 "PING slag (127.0.0.1): 56 data bytes\n" \
3402 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3403 "\n" \
3404 "--- debian 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#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003408 "$ ping6 ip6-localhost\n" \
3409 "PING ip6-localhost (::1): 56 data bytes\n" \
3410 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3411 "\n" \
3412 "--- ip6-localhost ping statistics ---\n" \
3413 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3414 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003415
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003416#define pipe_progress_trivial_usage NOUSAGE_STR
3417#define pipe_progress_full_usage ""
3418
Eric Andersen7e9276b2001-02-22 01:15:47 +00003419#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003420 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003421#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003422 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003423 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003424
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003425#define pkill_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003426 "[-l|-SIGNAL] [-fnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003427#define pkill_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003428 "Send a signal to process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003429 "\nOptions:" \
3430 "\n -l List all signals" \
3431 "\n -f Match against entire command line" \
3432 "\n -n Signal the newest process only" \
3433 "\n -o Signal the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003434 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003435 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003436 "\n -s Match session ID (0 for current)" \
3437 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003438
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003439#define popmaildir_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003440 "[OPTIONS] MAILDIR [CONN_HELPER ARGS]"
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003441#define popmaildir_full_usage "\n\n" \
3442 "Fetch content of remote mailbox to local maildir\n" \
3443 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003444/* "\n -b Binary mode. Ignored" */ \
3445/* "\n -d Debug. Ignored" */ \
3446/* "\n -m Show used memory. Ignored" */ \
3447/* "\n -V Show version. Ignored" */ \
3448/* "\n -c Use tcpclient. Ignored" */ \
3449/* "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003450 "\n -s Skip authorization" \
3451 "\n -T Get messages with TOP instead with RETR" \
3452 "\n -k Keep retrieved messages on the server" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003453 "\n -t SEC Network timeout" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003454 IF_FEATURE_POPMAILDIR_DELIVERY( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003455 "\n -F \"PROG ARGS\" Filter program. May be multiple" \
3456 "\n -M \"PROG ARGS\" Delivery program" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003457 ) \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003458/* "\n -R BYTES Remove old messages on the server >= BYTES. Ignored" */
3459/* "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" */
3460/* "\n -L BYTES Don't retrieve new messages >= BYTES. Ignored" */
3461/* "\n -H LINES Type first LINES of a message. Ignored" */
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003462#define popmaildir_example_usage \
3463 "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n" \
3464 "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
3465
Eric Andersen7e9276b2001-02-22 01:15:47 +00003466#define poweroff_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003467 "[-d DELAY] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003468#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003469 "Halt and shut off power\n" \
3470 "\nOptions:" \
3471 "\n -d Delay interval for halting" \
3472 "\n -n No call to sync()" \
3473 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003474
Mike Frysinger95d3c452005-04-21 23:29:24 +00003475#define printenv_trivial_usage \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003476 "[VARIABLE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003477#define printenv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003478 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003479 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003480
Eric Andersen7e9276b2001-02-22 01:15:47 +00003481#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003482 "FORMAT [ARGUMENT...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003483#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003484 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003485 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003486#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003487 "$ printf \"Val=%d\\n\" 5\n" \
3488 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003489
Denis Vlasenko94949192006-11-05 00:45:47 +00003490
3491#if ENABLE_DESKTOP
3492
3493#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003494 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003495#define ps_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003496 "Report process status\n" \
3497 "\nOptions:" \
3498 "\n -o col1,col2=header Select columns for display" \
Denys Vlasenko532609e2009-09-20 20:29:25 +02003499 IF_FEATURE_SHOW_THREADS( \
3500 "\n -T Show threads" \
3501 )
Denis Vlasenko94949192006-11-05 00:45:47 +00003502
3503#else /* !ENABLE_DESKTOP */
3504
Denis Vlasenko397de612008-03-17 08:55:44 +00003505#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003506#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003507#else
3508#define USAGE_PS "\nOptions:"
3509#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003510
Eric Andersen7e9276b2001-02-22 01:15:47 +00003511#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003512 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003513#define ps_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003514 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003515 USAGE_PS \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003516 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003517 "\n -Z Show SE Linux context" \
3518 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003519 IF_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003520 "\n w Wide output" \
3521 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003522
Denis Vlasenko94949192006-11-05 00:45:47 +00003523#endif /* ENABLE_DESKTOP */
3524
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003525#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003526 "$ ps\n" \
3527 " PID Uid Gid State Command\n" \
3528 " 1 root root S init\n" \
3529 " 2 root root S [kflushd]\n" \
3530 " 3 root root S [kupdate]\n" \
3531 " 4 root root S [kpiod]\n" \
3532 " 5 root root S [kswapd]\n" \
3533 " 742 andersen andersen S [bash]\n" \
3534 " 743 andersen andersen S -bash\n" \
3535 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003536 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003537
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003538#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003539 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003540#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003541 "Scan a host, print all open ports\n" \
3542 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003543 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003544 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003545 "\n -p Scan from this port (default 1)" \
3546 "\n -P Scan up to this port (default 1024)" \
3547 "\n -t Timeout (default 5000 ms)" \
3548 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3549
Eric Andersen7e9276b2001-02-22 01:15:47 +00003550#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003551 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003552#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003553 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003554#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003555 "$ pwd\n" \
3556 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003557
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003558#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003559 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003560#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003561 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003562#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003563 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003564
Eric Andersen7e9276b2001-02-22 01:15:47 +00003565#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003566 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003567#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003568 "Get and possibly set the system date and time from a remote HOST\n" \
3569 "\nOptions:" \
3570 "\n -s Set the system date and time (default)" \
3571 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003572
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00003573#define rdev_trivial_usage \
3574 ""
3575#define rdev_full_usage "\n\n" \
3576 "Print the device node associated with the filesystem mounted at '/'"
3577#define rdev_example_usage \
3578 "$ rdev\n" \
3579 "/dev/mtdblock9 /\n"
3580
Rob Landley0e4690d2006-08-20 22:12:18 +00003581#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003582 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003583#define readahead_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003584 "Preload FILEs to RAM"
Rob Landley0e4690d2006-08-20 22:12:18 +00003585
Eric Andersen7e9276b2001-02-22 01:15:47 +00003586#define readlink_trivial_usage \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003587 IF_FEATURE_READLINK_FOLLOW("[-fnv] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003588#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003589 "Display the value of a symlink" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003590 IF_FEATURE_READLINK_FOLLOW( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003591 "\nOptions:" \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003592 "\n -f Canonicalize by following all symlinks" \
3593 "\n -n Don't add newline" \
3594 "\n -v Verbose" \
3595 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003596
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003597#define readprofile_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003598 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003599#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003600 "Options:" \
3601 "\n -m mapfile (Default: /boot/System.map)" \
3602 "\n -p profile (Default: /proc/profile)" \
3603 "\n -M mult Set the profiling multiplier to mult" \
3604 "\n -i Print only info about the sampling step" \
3605 "\n -v Verbose" \
3606 "\n -a Print all symbols, even if count is 0" \
3607 "\n -b Print individual histogram-bin counts" \
3608 "\n -s Print individual counters within functions" \
3609 "\n -r Reset all the counters (root only)" \
3610 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003611
Glenn L McGrath62fae302002-12-10 00:14:33 +00003612#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003613 "pathname..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003614#define realpath_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003615 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00003616
Eric Andersen7e9276b2001-02-22 01:15:47 +00003617#define reboot_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003618 "[-d DELAY] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003619#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003620 "Reboot the system\n" \
3621 "\nOptions:" \
3622 "\n -d Delay interval for rebooting" \
3623 "\n -n No call to sync()" \
3624 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003625
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003626#define reformime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003627 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003628#define reformime_full_usage "\n\n" \
3629 "Parse MIME-encoded message\n" \
3630 "\nOptions:" \
3631 "\n -x prefix Extract content of MIME sections to files" \
3632 "\n -X prog [args] Filter content of MIME sections through prog." \
3633 "\n Must be the last option" \
3634 "\n" \
3635 "\nOther options are silently ignored." \
3636
Eric Andersen7e9276b2001-02-22 01:15:47 +00003637#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003638 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003639#define renice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003640 "Change priority of running processes\n" \
3641 "\nOptions:" \
3642 "\n -n Adjust current nice value (smaller is faster)" \
3643 "\n -p Process id(s) (default)" \
3644 "\n -g Process group id(s)" \
3645 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003646
Denys Vlasenko5e611152009-05-19 17:36:16 +02003647#define scriptreplay_trivial_usage \
3648 "timingfile [typescript [divisor]]"
3649#define scriptreplay_full_usage "\n\n" \
3650 "Play back typescripts, using timing information"
3651
Eric Andersen7e9276b2001-02-22 01:15:47 +00003652#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003653 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003654#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003655 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003656
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003657#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003658 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003659#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003660 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003661
Denis Vlasenko397137b2007-07-23 14:03:30 +00003662#define restorecon_trivial_usage \
3663 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003664#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003665 "Reset security contexts of files in pathname\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02003666 "\n -i Ignore files that don't exist" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003667 "\n -f file File with list of files to process. Use - for stdin" \
3668 "\n -e directory Directory to exclude" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003669 "\n -R,-r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003670 "\n -n Don't change any file labels" \
3671 "\n -o file Save list of files with incorrect context" \
3672 "\n -v Verbose" \
3673 "\n -vv Show changed labels" \
3674 "\n -F Force reset of context to match file_context" \
3675 "\n for customizable files, or the user section," \
3676 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003677
Eric Andersen7e9276b2001-02-22 01:15:47 +00003678#define rm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003679 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003680#define rm_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003681 "Remove (unlink) FILEs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003682 "\nOptions:" \
3683 "\n -i Always prompt before removing" \
3684 "\n -f Never prompt" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003685 "\n -R,-r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003686
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003687#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003688 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003689
Eric Andersen7e9276b2001-02-22 01:15:47 +00003690#define rmdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003691 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003692#define rmdir_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003693 "Remove DIRECTORY if it is empty\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003694 "\nOptions:" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003695 IF_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003696 "\n -p|--parents Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003697 "\n --ignore-fail-on-non-empty" \
3698 ) \
3699 IF_NOT_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003700 "\n -p Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003701 )
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003702
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003703#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003704 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003705
Eric Andersen7e9276b2001-02-22 01:15:47 +00003706#define rmmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003707 "[OPTIONS] [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003708#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003709 "Unload the specified kernel modules from the kernel\n" \
3710 "\nOptions:" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003711 "\n -w Wait until the module is no longer used" \
3712 "\n -f Force unloading" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003713 "\n -a Remove all unused modules (recursively)" \
3714
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003715#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003716 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003717
Eric Andersen7e9276b2001-02-22 01:15:47 +00003718#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003719 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003720#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003721 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003722 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003723 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003724 "\n -e Display other/more information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003725 "\n -A inet" IF_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003726
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003727#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003728 "-i -q[ildc]p package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003729#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003730 "Manipulate RPM packages\n" \
3731 "\nOptions:" \
3732 "\n -i Install package" \
3733 "\n -q Query package" \
3734 "\n -p Query uninstalled package" \
3735 "\n -i Show information" \
3736 "\n -l List contents" \
3737 "\n -d List documents" \
3738 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003739
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003740#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003741 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003742#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003743 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003744
Mike Frysinger6b160e42008-02-15 02:27:19 +00003745#define rtcwake_trivial_usage \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003746 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SEC | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003747#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003748 "Enter a system sleep state until specified wakeup time\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003749 IF_LONG_OPTS( \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003750 "\n -a,--auto Read clock mode from adjtime" \
3751 "\n -l,--local Clock is set to local time" \
3752 "\n -u,--utc Clock is set to UTC time" \
3753 "\n -d,--device=DEV Specify the RTC device" \
3754 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003755 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003756 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003757 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003758 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003759 "\n -a Read clock mode from adjtime" \
3760 "\n -l Clock is set to local time" \
3761 "\n -u Clock is set to UTC time" \
3762 "\n -d DEV Specify the RTC device" \
3763 "\n -m MODE Set the sleep state (default: standby)" \
3764 "\n -s SEC Set the timeout in SEC seconds from now" \
3765 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003766 )
3767
Denis Vlasenko49622d72007-03-10 16:58:49 +00003768#define runcon_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003769 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] PROG [ARGS]\n" \
3770 " runcon CONTEXT PROG [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003771#define runcon_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003772 "Run PROG in a different security context\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003773 "\n CONTEXT Complete security context\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003774 IF_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003775 "\n -c,--compute Compute process transition context before modifying" \
3776 "\n -t,--type=TYPE Type (for same role as parent)" \
3777 "\n -u,--user=USER User identity" \
3778 "\n -r,--role=ROLE Role" \
3779 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003780 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003781 IF_NOT_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003782 "\n -c Compute process transition context before modifying" \
3783 "\n -t TYPE Type (for same role as parent)" \
3784 "\n -u USER User identity" \
3785 "\n -r ROLE Role" \
3786 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003787 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003788
Eric Andersen6cf47a72001-10-31 10:24:36 +00003789#define run_parts_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003790 "[-t] "IF_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003791#define run_parts_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003792 "Run a bunch of scripts in DIRECTORY\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003793 "\nOptions:" \
3794 "\n -t Print what would be run, but don't actually run anything" \
3795 "\n -a ARG Pass ARG as argument for every program" \
3796 "\n -u MASK Set the umask to MASK before running every program" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003797 IF_FEATURE_RUN_PARTS_FANCY( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003798 "\n -l Print names of all matching files even if they are not executable" \
3799 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003800
3801#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003802 "$ run-parts -a start /etc/init.d\n" \
3803 "$ run-parts -a stop=now /etc/init.d\n\n" \
3804 "Let's assume you have a script foo/dosomething:\n" \
3805 "#!/bin/sh\n" \
3806 "for i in $*; do eval $i; done; unset i\n" \
3807 "case \"$1\" in\n" \
3808 "start*) echo starting something;;\n" \
3809 "stop*) set -x; shutdown -h $stop;;\n" \
3810 "esac\n\n" \
3811 "Running this yields:\n" \
3812 "$run-parts -a stop=+4m foo/\n" \
3813 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003814
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003815#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003816 "[utmp]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003817#define runlevel_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003818 "Find the current and previous system runlevel\n" \
3819 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003820 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003821 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003822#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003823 "$ runlevel /var/run/utmp\n" \
3824 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003825
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003826#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003827 "dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003828#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003829 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003830
3831#define runsvdir_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003832 "[-P] [-s SCRIPT] dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003833#define runsvdir_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003834 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
3835 "\n -P Put each runsv in a new session" \
3836 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003837
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003838#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003839 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003840#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003841 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003842#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003843 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003844
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003845#define script_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003846 "[-afq" IF_SCRIPTREPLAY("t") "] [-c PROG] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003847#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003848 "Options:" \
3849 "\n -a Append output" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003850 "\n -c Run PROG, not shell" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003851 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003852 "\n -q Quiet" \
Denys Vlasenko5e611152009-05-19 17:36:16 +02003853 IF_SCRIPTREPLAY( \
3854 "\n -t Send timing to stderr" \
3855 )
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003856
Eric Andersen7e9276b2001-02-22 01:15:47 +00003857#define sed_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003858 "[-efinr] SED_CMD [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003859#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003860 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003861 "\n -e CMD Add CMD to sed commands to be executed" \
3862 "\n -f FILE Add FILE contents to sed commands to be executed" \
Denys Vlasenkodac863a2009-10-27 09:11:17 +01003863 "\n -i Edit files in-place (else sends result to stdout)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003864 "\n -n Suppress automatic printing of pattern space" \
3865 "\n -r Use extended regex syntax" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003866 "\n" \
Rob Landley7b284152009-10-26 16:04:07 -05003867 "\nIf no -e or -f, the first non-option argument is the sed command string." \
3868 "\nRemaining arguments are input files (stdin if none)."
Eric Andersenf802ff72004-04-12 15:12:06 +00003869
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003870#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003871 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3872 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003873
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003874#define selinuxenabled_trivial_usage NOUSAGE_STR
3875#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003876
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003877#define sendmail_trivial_usage \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003878 "[OPTIONS] [RECIPIENT_EMAIL]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003879#define sendmail_full_usage "\n\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003880 "Read email from stdin and send it\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003881 "\nStandard options:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003882 "\n -t Read additional recipients from message body" \
3883 "\n -f sender Sender (required)" \
3884 "\n -o options Various options. -oi implied, others are ignored" \
Vladimir Dronnikovb618dba2009-10-04 01:34:54 +02003885 "\n -i -oi synonym. implied and ignored" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003886 "\n" \
3887 "\nBusybox specific options:" \
3888 "\n -w seconds Network timeout" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003889 "\n -H 'PROG ARGS' Run connection helper" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003890 "\n Examples:" \
Denis Vlasenko7e0c2432009-03-02 16:12:00 +00003891 "\n -H 'exec openssl s_client -quiet -tls1 -starttls smtp" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003892 "\n -connect smtp.gmail.com:25' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003893 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003894 "\n -H 'exec openssl s_client -quiet -tls1" \
3895 "\n -connect smtp.gmail.com:465' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003896 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003897 "\n -S server[:port] Server" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003898 "\n -au<username> Username for AUTH LOGIN" \
3899 "\n -ap<password> Password for AUTH LOGIN" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003900 "\n -am<method> Authentication method. Ignored. LOGIN is implied" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003901 "\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003902 "\nOther options are silently ignored; -oi -t is implied" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003903 IF_MAKEMIME( \
3904 "\nUse makemime applet to create message with attachments" \
3905 )
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003906
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003907#define seq_trivial_usage \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003908 "[-w] [-s SEP] [FIRST [INC]] LAST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003909#define seq_full_usage "\n\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003910 "Print numbers from FIRST to LAST, in steps of INC.\n" \
3911 "FIRST, INC default to 1\n" \
3912 "\nOptions:" \
3913 "\n -w Pad to last with leading zeros" \
3914 "\n -s SEP String separator" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003915
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003916#define sestatus_trivial_usage \
3917 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003918#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003919 " -v Verbose" \
3920 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003921
Paul Foxfc2256a2005-08-01 18:12:30 +00003922#define setconsole_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003923 "[-r" IF_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003924#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003925 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3926 "\nOptions:" \
3927 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003928
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003929#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003930 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003931#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003932
Denis Vlasenko397137b2007-07-23 14:03:30 +00003933#define setfiles_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003934 "[-dnpqsvW] [-e DIR]... [-o FILE] [-r alt_root_path]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003935 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003936 " [-c policyfile] spec_file" \
3937 ) \
3938 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003939#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003940 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003941 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003942 "\n -c FILE Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003943 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003944 "\n -d Show which specification matched each file" \
3945 "\n -l Log changes in file labels to syslog" \
3946 "\n -n Don't change any file labels" \
3947 "\n -q Suppress warnings" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003948 "\n -r DIR Use an alternate root path" \
3949 "\n -e DIR Exclude DIR" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003950 "\n -F Force reset of context to match file_context for customizable files" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003951 "\n -o FILE Save list of files with incorrect context" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003952 "\n -s Take a list of files from standard input (instead of command line)" \
3953 "\n -v Show changes in file labels, if type or role are changing" \
3954 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3955 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003956
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003957#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003958 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003959#define setfont_full_usage "\n\n" \
3960 "Load a console font\n" \
3961 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003962 "\n -m MAPFILE Load console screen map" \
3963 "\n -C TTY Affect TTY instead of /dev/tty" \
3964
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003965#define setfont_example_usage \
3966 "$ setfont -m koi8-r /etc/i18n/fontname\n"
3967
Eric Andersen7e9276b2001-02-22 01:15:47 +00003968#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003969 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003970#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003971 "Set entries into the kernel's scancode-to-keycode map,\n" \
3972 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3973 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003974 "and KEYCODE is given in decimal" \
3975
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003976#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003977 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003978
Rob Landley87848d92006-03-27 23:23:43 +00003979#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003980 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003981#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003982 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003983
Denis Vlasenkobe039372007-10-14 04:48:44 +00003984#define setsebool_trivial_usage \
3985 "boolean value"
3986
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003987#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00003988 "Change boolean setting"
3989
Paul Fox42403642005-08-01 22:52:09 +00003990#define setsid_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003991 "PROG [ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003992#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003993 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3994 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3995 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003996
Eric Andersen2e9c2572003-08-08 22:26:06 +00003997#define last_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003998 ""IF_FEATURE_LAST_FANCY("[-HW] [-f file]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003999#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004000 "Show listing of the last users that logged into the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004001 IF_FEATURE_LAST_FANCY( "\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004002 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00004003/* "\n -H Show header line" */ \
4004 "\n -W Display with no host column truncation" \
4005 "\n -f file Read from file instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004006 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00004007
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00004008#define showkey_trivial_usage \
4009 "[-a | -k | -s]"
4010#define showkey_full_usage "\n\n" \
4011 "Show keys pressed\n" \
4012 "\nOptions:" \
4013 "\n -a Display decimal/octal/hex values of the keys" \
4014 "\n -k Display interpreted keycodes (default)" \
4015 "\n -s Display raw scan-codes" \
4016
Denis Vlasenko14923db2007-06-20 15:23:03 +00004017#define slattach_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004018 "[-cehmLF] [-s SPEED] [-p PROTOCOL] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004019#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004020 "Attach network interface(s) to serial line(s)\n" \
4021 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004022 "\n -p PROT Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
4023 "\n -s SPD Set line speed" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004024 "\n -e Exit after initializing device" \
4025 "\n -h Exit when the carrier is lost" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004026 "\n -c PROG Run PROG when the line is hung up" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004027 "\n -m Do NOT initialize the line in raw 8 bits mode" \
4028 "\n -L Enable 3-wire operation" \
4029 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00004030
Eric Andersen7e9276b2001-02-22 01:15:47 +00004031#define sleep_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004032 IF_FEATURE_FANCY_SLEEP("[") "N" IF_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004033#define sleep_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004034 IF_NOT_FEATURE_FANCY_SLEEP("Pause for N seconds") \
4035 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004036 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004037 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004038#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004039 "$ sleep 2\n" \
4040 "[2 second delay results]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004041 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004042 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004043 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00004044
Eric Andersen7e9276b2001-02-22 01:15:47 +00004045#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004046 "[-nru" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004047 IF_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004048 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004049#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004050 "Sort lines of text\n" \
4051 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004052 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004053 "\n -b Ignore leading blanks" \
4054 "\n -c Check whether input is sorted" \
4055 "\n -d Dictionary order (blank or alphanumeric only)" \
4056 "\n -f Ignore case" \
4057 "\n -g General numerical sort" \
4058 "\n -i Ignore unprintable characters" \
4059 "\n -k Sort key" \
4060 "\n -M Sort month" \
4061 ) \
4062 "\n -n Sort numbers" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004063 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004064 "\n -o Output to file" \
4065 "\n -k Sort by key" \
4066 "\n -t CHAR Key separator" \
4067 ) \
4068 "\n -r Reverse sort order" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004069 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004070 "\n -s Stable (don't sort ties alphabetically)" \
4071 ) \
4072 "\n -u Suppress duplicate lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004073 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004074 "\n -z Lines are terminated by NUL, not newline" \
4075 "\n -mST Ignored for GNU compatibility") \
4076
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004077#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004078 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
4079 "a\n" \
4080 "b\n" \
4081 "c\n" \
4082 "d\n" \
4083 "e\n" \
4084 "f\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004085 IF_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00004086 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
4087 "d 2\n" \
4088 "b 2\n" \
4089 "c 3\n" \
4090 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004091 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004092
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00004093#define split_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004094 "[OPTIONS] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004095#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00004096 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004097 "\n -b n[k|m] Split by bytes" \
4098 "\n -l n Split by lines" \
4099 "\n -a n Use n letters as suffix" \
4100
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00004101#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00004102 "$ split TODO foo\n" \
4103 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00004104
Eric Andersenc2af1ee2001-10-18 19:33:06 +00004105#define start_stop_daemon_trivial_usage \
Denis Vlasenko7987a182008-07-01 10:00:46 +00004106 "[OPTIONS] [-S|-K] ... [-- arguments...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004107#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004108 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004109 "-K: stop all matching processes.\n" \
4110 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004111 IF_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004112 "\nProcess matching:" \
4113 "\n -u,--user USERNAME|UID Match only this user's processes" \
4114 "\n -n,--name NAME Match processes with NAME" \
4115 "\n in comm field in /proc/PID/stat" \
4116 "\n -x,--exec EXECUTABLE Match processes with this command" \
4117 "\n in /proc/PID/cmdline" \
4118 "\n -p,--pidfile FILE Match a process with PID from the file" \
4119 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004120 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004121 "\n -x,--exec EXECUTABLE Program to run" \
4122 "\n -a,--startas NAME Zeroth argument" \
4123 "\n -b,--background Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004124 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004125 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004126 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004127 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
4128 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004129 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004130 "\n -s,--signal SIG Signal to send" \
4131 "\n -t,--test Match only, exit with 0 if a process is found" \
4132 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004133 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004134 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004135 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00004136 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00004137 "\n -q,--quiet Quiet" \
4138 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004139 IF_NOT_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004140 "\nProcess matching:" \
4141 "\n -u USERNAME|UID Match only this user's processes" \
4142 "\n -n NAME Match processes with NAME" \
4143 "\n in comm field in /proc/PID/stat" \
4144 "\n -x EXECUTABLE Match processes with this command" \
4145 "\n command in /proc/PID/cmdline" \
4146 "\n -p FILE Match a process with PID from the file" \
4147 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004148 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004149 "\n -x EXECUTABLE Program to run" \
4150 "\n -a NAME Zeroth argument" \
4151 "\n -b Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004152 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004153 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00004154 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004155 "\n -c USER[:[GRP]] Change to user/group" \
4156 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004157 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004158 "\n -s SIG Signal to send" \
4159 "\n -t Match only, exit with 0 if a process is found" \
4160 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004161 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004162 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004163 "\n -v Verbose" \
4164 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00004165 "\n -q Quiet" \
4166 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00004167
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004168#define stat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004169 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004170#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004171 "Display file (default) or filesystem status\n" \
4172 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004173 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004174 "\n -c fmt Use the specified format" \
4175 ) \
4176 "\n -f Display filesystem status" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004177 "\n -L Follow links" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004178 "\n -t Display info in terse form" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004179 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004180 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004181 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004182 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004183 "\n\nValid format sequences for files:\n" \
4184 " %a Access rights in octal\n" \
4185 " %A Access rights in human readable form\n" \
4186 " %b Number of blocks allocated (see %B)\n" \
4187 " %B The size in bytes of each block reported by %b\n" \
4188 " %d Device number in decimal\n" \
4189 " %D Device number in hex\n" \
4190 " %f Raw mode in hex\n" \
4191 " %F File type\n" \
4192 " %g Group ID of owner\n" \
4193 " %G Group name of owner\n" \
4194 " %h Number of hard links\n" \
4195 " %i Inode number\n" \
4196 " %n File name\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004197 " %N File name, with -> TARGET if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004198 " %o I/O block size\n" \
4199 " %s Total size, in bytes\n" \
4200 " %t Major device type in hex\n" \
4201 " %T Minor device type in hex\n" \
4202 " %u User ID of owner\n" \
4203 " %U User name of owner\n" \
4204 " %x Time of last access\n" \
4205 " %X Time of last access as seconds since Epoch\n" \
4206 " %y Time of last modification\n" \
4207 " %Y Time of last modification as seconds since Epoch\n" \
4208 " %z Time of last change\n" \
4209 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004210 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004211 " %a Free blocks available to non-superuser\n" \
4212 " %b Total data blocks in file system\n" \
4213 " %c Total file nodes in file system\n" \
4214 " %d Free file nodes in file system\n" \
4215 " %f Free blocks in file system\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004216 IF_SELINUX( \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004217 " %C Security context in SELinux\n" \
4218 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004219 " %i File System ID in hex\n" \
4220 " %l Maximum length of filenames\n" \
4221 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004222 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004223 " %S Fundamental block size (for block counts)\n" \
4224 " %t Type in hex\n" \
4225 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004226 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004227
Eric Andersenef5e8f82002-11-07 02:09:37 +00004228#define strings_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004229 "[-afo] [-n LEN] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004230#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004231 "Display printable strings in a binary file\n" \
4232 "\nOptions:" \
4233 "\n -a Scan whole file (default)" \
4234 "\n -f Precede strings with filenames" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004235 "\n -n LEN At least LEN characters form a string (default 4)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004236 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00004237
Eric Andersen7e9276b2001-02-22 01:15:47 +00004238#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004239 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004240#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004241 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004242 "and deviations from stty sane\n" \
4243 "\nOptions:" \
4244 "\n -F DEVICE Open device instead of stdin" \
4245 "\n -a Print all current settings in human-readable form" \
4246 "\n -g Print in stty-readable form" \
4247 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004248
Robert Griebl1fca5582002-06-04 20:45:46 +00004249#define su_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004250 "[OPTIONS] [-] [USERNAME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004251#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004252 "Change user id or become root\n" \
4253 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004254 "\n -p,-m Preserve environment" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004255 "\n -c CMD Command to pass to 'sh -c'" \
4256 "\n -s SH Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00004257
Eric Andersen27f64e12002-06-23 04:24:25 +00004258#define sulogin_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004259 "[OPTIONS] [TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004260#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004261 "Single user login\n" \
4262 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004263 "\n -t N Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004264
Mike Frysinger95d3c452005-04-21 23:29:24 +00004265#define sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004266 "[-rs] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004267#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004268 "Checksum and count the blocks in a file\n" \
4269 "\nOptions:" \
4270 "\n -r Use BSD sum algorithm (1K blocks)" \
4271 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00004272
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004273#define sv_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004274 "[-v] [-w SEC] command service..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004275#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004276 "Control services monitored by runsv supervisor.\n" \
4277 "Commands (only first character is enough):\n" \
4278 "\n" \
4279 "status: query service status\n" \
4280 "up: if service isn't running, start it. If service stops, restart it\n" \
4281 "once: like 'up', but if service stops, don't restart it\n" \
4282 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004283 " if it exists. After it stops, don't restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004284 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004285 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004286 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004287 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004288
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004289#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004290 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004291#define svlogd_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004292 "Continuously read log data from standard input, optionally\n" \
4293 "filter log messages, and write the data to one or more automatically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004294 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004295
Eric Andersen7e9276b2001-02-22 01:15:47 +00004296#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004297 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004298#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004299 "Stop swapping on DEVICE\n" \
4300 "\nOptions:" \
4301 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004302
Eric Andersen7e9276b2001-02-22 01:15:47 +00004303#define swapon_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004304 "[-a]" IF_FEATURE_SWAPON_PRI(" [-p PRI]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004305#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004306 "Start swapping on DEVICE\n" \
4307 "\nOptions:" \
4308 "\n -a Start swapping on all swap devices" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004309 IF_FEATURE_SWAPON_PRI( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004310 "\n -p PRI Set swap device priority" \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004311 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004312
Rob Landley0f34a822005-10-27 22:55:50 +00004313#define switch_root_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004314 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004315#define switch_root_full_usage "\n\n" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004316 "Free initramfs and switch to another root fs:\n" \
4317 "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n" \
4318 "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004319 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004320 "\n -c DEV Reopen stdio to DEV after switch" \
Rob Landley0f34a822005-10-27 22:55:50 +00004321
Eric Andersen7e9276b2001-02-22 01:15:47 +00004322#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004323 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004324#define sync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004325 "Write all buffered blocks to disk"
4326
4327#define fsync_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004328 "[OPTIONS] FILE..."
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004329#define fsync_full_usage \
4330 "Write files' buffered blocks to disk\n" \
4331 "\nOptions:" \
4332 "\n -d Avoid syncing metadata"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004333
Eric Andersenb9050282003-12-24 06:02:11 +00004334#define sysctl_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004335 "[OPTIONS] [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004336#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004337 "Configure kernel parameters at runtime\n" \
4338 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004339 "\n -n Don't print key names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004340 "\n -e Don't warn about unknown keys" \
4341 "\n -w Change sysctl setting" \
4342 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
4343 "\n -a Display all values" \
4344 "\n -A Display all values in table form" \
4345
Eric Andersen5d38f5b2005-09-12 21:42:48 +00004346#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00004347 "sysctl [-n] [-e] variable...\n" \
4348 "sysctl [-n] [-e] -w variable=value...\n" \
4349 "sysctl [-n] [-e] -a\n" \
4350 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
4351 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00004352
Eric Andersen7e9276b2001-02-22 01:15:47 +00004353#define syslogd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004354 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004355#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004356 "System logging utility.\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004357 "Note that this version of syslogd ignores /etc/syslog.conf.\n" \
4358 "\nOptions:" \
4359 "\n -n Run in foreground" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004360 "\n -O FILE Log to given file (default:/var/log/messages)" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004361 "\n -l n Set local log level" \
4362 "\n -S Smaller logging output" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004363 IF_FEATURE_ROTATE_LOGFILE( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004364 "\n -s SIZE Max size (KB) before rotate (default:200KB, 0=off)" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004365 "\n -b N N rotated logs to keep (default:1, max=99, 0=purge)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004366 IF_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004367 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
4368 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004369 IF_FEATURE_SYSLOGD_DUP( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004370 "\n -D Drop duplicates") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004371 IF_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004372 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00004373 /* NB: -Csize shouldn't have space (because size is optional) */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004374/* "\n -m MIN Minutes between MARK lines (default:20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00004375
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004376#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004377 "$ syslogd -R masterlog:514\n" \
4378 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004379
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004380#define tac_trivial_usage \
4381 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004382#define tac_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004383 "Concatenate FILEs and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004384
Eric Andersen7e9276b2001-02-22 01:15:47 +00004385#define tail_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004386 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004387#define tail_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004388 "Print last 10 lines of each FILE (or standard input) to standard output.\n" \
4389 "With more than one FILE, precede each with a header giving the file name.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004390 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004391 IF_FEATURE_FANCY_TAIL( \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004392 "\n -c N[kbm] Output last N bytes") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004393 "\n -n N[kbm] Print last N lines instead of last 10" \
4394 "\n -f Output data as the file grows" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004395 IF_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004396 "\n -q Never output headers giving file names" \
4397 "\n -s SEC Wait SEC seconds between reads with -f" \
4398 "\n -v Always output headers giving file names" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004399 "\n" \
4400 "\nIf the first character of N (bytes or lines) is a '+', output begins with" \
4401 "\nthe Nth item from the start of each file, otherwise, print the last N items" \
4402 "\nin the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004403
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004404#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004405 "$ tail -n 1 /etc/resolv.conf\n" \
4406 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004407
Eric Andersen7e9276b2001-02-22 01:15:47 +00004408#define tar_trivial_usage \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004409 "-[" IF_FEATURE_TAR_CREATE("c") "xt" IF_FEATURE_SEAMLESS_GZ("z") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004410 IF_FEATURE_SEAMLESS_BZ2("j") IF_FEATURE_SEAMLESS_LZMA("a") \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004411 IF_FEATURE_SEAMLESS_Z("Z") IF_FEATURE_TAR_NOPRESERVE_TIME("m") "vO] " \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004412 IF_FEATURE_TAR_FROM("[-X FILE] ") \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004413 "[-f TARFILE] [-C DIR] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004414#define tar_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004415 IF_FEATURE_TAR_CREATE("Create, extract, ") \
4416 IF_NOT_FEATURE_TAR_CREATE("Extract ") \
4417 "or list files from a tar file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004418 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004419 IF_FEATURE_TAR_CREATE( \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004420 "\n c Create" \
4421 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004422 "\n x Extract" \
4423 "\n t List" \
4424 "\nArchive format selection:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004425 IF_FEATURE_SEAMLESS_GZ( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004426 "\n z Filter the archive through gzip" \
4427 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004428 IF_FEATURE_SEAMLESS_BZ2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004429 "\n j Filter the archive through bzip2" \
4430 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004431 IF_FEATURE_SEAMLESS_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004432 "\n a Filter the archive through lzma" \
4433 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004434 IF_FEATURE_SEAMLESS_Z( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004435 "\n Z Filter the archive through compress" \
4436 ) \
Mikhail Gusarov0d478332010-01-19 20:22:30 +06004437 IF_FEATURE_TAR_NOPRESERVE_TIME( \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004438 "\n m Do not restore mtime" \
Mikhail Gusarov0d478332010-01-19 20:22:30 +06004439 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004440 "\nFile selection:" \
4441 "\n f Name of TARFILE or \"-\" for stdin" \
4442 "\n O Extract to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004443 IF_FEATURE_TAR_FROM( \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004444 IF_FEATURE_TAR_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004445 "\n exclude File to exclude" \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004446 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004447 "\n X File with names to exclude" \
4448 ) \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004449 "\n C Change to DIR before operation" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004450 "\n v Verbose" \
4451
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004452#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004453 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
4454 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004455
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004456#define taskset_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004457 "[-p] [MASK] [PID | PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004458#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004459 "Set or get CPU affinity\n" \
4460 "\nOptions:" \
4461 "\n -p Operate on an existing PID" \
4462
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004463#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004464 "$ taskset 0x7 ./dgemm_test&\n" \
4465 "$ taskset -p 0x1 $!\n" \
4466 "pid 4790's current affinity mask: 7\n" \
4467 "pid 4790's new affinity mask: 1\n" \
4468 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4469 "pid 6671's current affinity mask: 1\n" \
4470 "pid 6671's new affinity mask: 1\n" \
4471 "$ taskset -p 1\n" \
4472 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004473
Eric Andersen7e9276b2001-02-22 01:15:47 +00004474#define tee_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004475 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004476#define tee_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004477 "Copy standard input to each FILE, and also to standard output\n" \
4478 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004479 "\n -a Append to the given FILEs, don't overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004480 "\n -i Ignore interrupt signals (SIGINT)" \
4481
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004482#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004483 "$ echo \"Hello\" | tee /tmp/foo\n" \
4484 "$ cat /tmp/foo\n" \
4485 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004486
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004487#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004488#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004489 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004490#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004491 "Connect to telnet server\n" \
4492 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004493 "\n -a Automatic login with $USER variable" \
4494 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004495
Eric Andersen539ffc92004-02-22 12:25:47 +00004496#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004497#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004498 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004499#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004500 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004501#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004502
Eric Andersen08a72202002-09-30 20:52:10 +00004503#define telnetd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004504 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004505#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004506 "Handle incoming telnet connections" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004507 IF_NOT_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004508 "\nOptions:" \
4509 "\n -l LOGIN Exec LOGIN on connect" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004510 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004511 "\n -K Close connection as soon as login exits" \
4512 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004513 IF_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004514 "\n -p PORT Port to listen on" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004515 "\n -b ADDR[:PORT] Address to bind to" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004516 "\n -F Run in foreground" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004517 "\n -i Run as inetd service" \
4518 IF_FEATURE_TELNETD_INETD_WAIT( \
4519 "\n -w SEC Run as inetd service in wait mode, linger time SEC" \
4520 "\n -S Log to syslog (implied by -i or without -F and -w)" \
4521 ) \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004522 )
Eric Andersen08a72202002-09-30 20:52:10 +00004523
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004524/* "test --help" does not print help (POSIX compat), only "[ --help" does.
Denys Vlasenko662078f2010-01-14 13:27:34 +01004525 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION")
4526 * Unfortunately, it screws up generated BusyBox.html. TODO. */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004527#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004528 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004529#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004530 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4531 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004532#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004533 "$ test 1 -eq 2\n" \
4534 "$ echo $?\n" \
4535 "1\n" \
4536 "$ test 1 -eq 1\n" \
4537 "$ echo $?\n" \
4538 "0\n" \
4539 "$ [ -d /etc ]\n" \
4540 "$ echo $?\n" \
4541 "0\n" \
4542 "$ [ -d /junk ]\n" \
4543 "$ echo $?\n" \
4544 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004545
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004546#define tc_trivial_usage \
4547 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
4548#define tc_full_usage "\n\n" \
4549 "OBJECT: {qdisc|class|filter}\n" \
4550 "CMD: {add|del|change|replace|show}\n" \
4551 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004552 "qdisc [ handle QHANDLE ] [ root |"IF_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004553 /* "[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4554 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4555 " QDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004556 "qdisc show [ dev STRING ]"IF_FEATURE_TC_INGRESS(" [ingress]")"\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004557 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004558 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004559 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
4560 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
4561 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004562 " [ root | classid CLASSID ] [ handle FILTERID ]\n" \
4563 " [ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004564 "filter show [ dev STRING ] [ root | parent CLASSID ]"
4565
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004566#define tcpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004567 "[-hEv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004568/* with not-implemented options: */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004569/* "[-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 +00004570#define tcpsvd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004571 "Create TCP socket, bind to IP:PORT and listen\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004572 "for incoming connection. Run PROG for each connection.\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004573 "\n IP IP to listen on. '0' = all" \
4574 "\n PORT Port to listen on" \
4575 "\n PROG [ARGS] Program to run" \
4576 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4577 "\n -u USER[:GRP] Change to user/group after bind" \
4578 "\n -c N Handle up to N connections simultaneously" \
4579 "\n -b N Allow a backlog of approximately N TCP SYNs" \
4580 "\n -C N[:MSG] Allow only up to N connections from the same IP" \
4581 "\n New connections from this IP address are closed" \
4582 "\n immediately. MSG is written to the peer before close" \
4583 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004584 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004585 "\n -v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004586
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004587#define udpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004588 "[-hEv] [-c N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004589#define udpsvd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004590 "Create UDP socket, bind to IP:PORT and wait\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004591 "for incoming packets. Run PROG for each packet,\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004592 "redirecting all further packets with same peer ip:port to it.\n" \
4593 "\n IP IP to listen on. '0' = all" \
4594 "\n PORT Port to listen on" \
4595 "\n PROG [ARGS] Program to run" \
4596 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4597 "\n -u USER[:GRP] Change to user/group after bind" \
4598 "\n -c N Handle up to N connections simultaneously" \
4599 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004600 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004601 "\n -v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004602
Mark Whitley450736c2001-03-02 19:08:50 +00004603#define tftp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004604 "[OPTIONS] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004605#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004606 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004607 "\nOptions:" \
4608 "\n -l FILE Local FILE" \
4609 "\n -r FILE Remote FILE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004610 IF_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004611 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004612 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004613 IF_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004614 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004615 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004616 IF_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004617 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004618 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004619
4620#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004621 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004622#define tftpd_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004623 "Transfer a file on tftp client's request\n" \
Denis Vlasenko91f8f822008-10-30 23:42:37 +00004624 "\n" \
4625 "tftpd should be used as an inetd service.\n" \
4626 "tftpd's line for inetd.conf:\n" \
4627 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
4628 "It also can be ran from udpsvd:\n" \
4629 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004630 "\nOptions:" \
4631 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004632 "\n -c Allow file creation via upload" \
4633 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004634
Eric Andersenc3657422001-11-30 07:54:32 +00004635#define time_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004636 "[OPTIONS] PROG [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004637#define time_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004638 "Run PROG. When it finishes, its resource usage is displayed.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004639 "\nOptions:" \
4640 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004641
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004642#define timeout_trivial_usage \
4643 "[-t SECS] [-s SIG] PROG [ARGS]"
4644#define timeout_full_usage "\n\n" \
4645 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
Denis Vlasenko42404082008-11-24 13:42:24 +00004646 "Defaults: SECS: 10, SIG: TERM." \
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004647
Eric Andersen420b2082002-09-17 22:14:58 +00004648#define top_trivial_usage \
Denys Vlasenko00528822009-09-11 23:26:42 +02004649 "[-b] [-nCOUNT] [-dSECONDS]" IF_FEATURE_TOPMEM(" [-m]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004650#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004651 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004652 "Read the status of all processes from /proc each SECONDS\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004653 "and show the status for however many processes will fit on the screen." \
Eric Andersen420b2082002-09-17 22:14:58 +00004654
Eric Andersen7e9276b2001-02-22 01:15:47 +00004655#define touch_trivial_usage \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004656 "[-c] [-d DATE] FILE [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004657#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004658 "Update the last-modified date on the given FILE[s]\n" \
4659 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004660 "\n -c Don't create files" \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004661 "\n -d DT Date/time to use" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004662
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004663#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004664 "$ ls -l /tmp/foo\n" \
4665 "/bin/ls: /tmp/foo: No such file or directory\n" \
4666 "$ touch /tmp/foo\n" \
4667 "$ ls -l /tmp/foo\n" \
4668 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004669
4670#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004671 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004672#define tr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004673 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004674 "standard input, writing to standard output\n" \
4675 "\nOptions:" \
4676 "\n -c Take complement of STRING1" \
4677 "\n -d Delete input characters coded STRING1" \
4678 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4679
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004680#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004681 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4682 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004683
Eric Andersen5c58d282001-07-10 16:29:00 +00004684#define traceroute_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004685 "[-"IF_TRACEROUTE6("46")"FIldnrv] [-f 1ST_TTL] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
4686 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-g GATEWAY] [-i IFACE]\n" \
4687 " [-z PAUSE_MSEC] HOST [BYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004688#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004689 "Trace the route to HOST\n" \
4690 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004691 IF_TRACEROUTE6( \
4692 "\n -4, -6 Force IP or IPv6 name resolution" \
4693 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004694 "\n -F Set the don't fragment bit" \
4695 "\n -I Use ICMP ECHO instead of UDP datagrams" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004696 "\n -l Display the TTL value of the returned packet" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004697 "\n -d Set SO_DEBUG options to socket" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004698 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004699 "\n -r Bypass routing tables, send directly to HOST" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004700 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004701 "\n -m Max time-to-live (max number of hops)" \
4702 "\n -p Base UDP port number used in probes" \
4703 "\n (default 33434)" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004704 "\n -q Number of probes per TTL (default 3)" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004705 "\n -s IP address to use as the source address" \
4706 "\n -t Type-of-service in probe packets (default 0)" \
4707 "\n -w Time in seconds to wait for a response (default 3)" \
4708 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004709
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004710#define traceroute6_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004711 "[-dnrv] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
4712 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-i IFACE]\n" \
4713 " HOST [BYTES]"
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004714#define traceroute6_full_usage "\n\n" \
4715 "Trace the route to HOST\n" \
4716 "\nOptions:" \
4717 "\n -d Set SO_DEBUG options to socket" \
4718 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004719 "\n -r Bypass routing tables, send directly to HOST" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004720 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004721 "\n -m Max time-to-live (max number of hops)" \
4722 "\n -p Base UDP port number used in probes" \
4723 "\n (default is 33434)" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004724 "\n -q Number of probes per TTL (default 3)" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004725 "\n -s IP address to use as the source address" \
4726 "\n -t Type-of-service in probe packets (default 0)" \
4727 "\n -w Time in seconds to wait for a response (default 3)" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004728
Eric Andersen7e9276b2001-02-22 01:15:47 +00004729#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004730 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004731#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004732 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004733#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004734 "$ true\n" \
4735 "$ echo $?\n" \
4736 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004737
Eric Andersen7e9276b2001-02-22 01:15:47 +00004738#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004739 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004740#define tty_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004741 "Print file name of standard input's terminal" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004742 IF_INCLUDE_SUSv2( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004743 "\nOptions:" \
4744 "\n -s Print nothing, only return exit status" \
4745 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004746#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004747 "$ tty\n" \
4748 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004749
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004750#define ttysize_trivial_usage \
4751 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004752#define ttysize_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004753 "Print dimension(s) of standard input's terminal, on error return 80x25"
4754
Denis Vlasenko39b68132009-01-23 02:07:14 +00004755#define tunctl_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004756 "[-f device] ([-t name] | -d name)" IF_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]")
Denis Vlasenko39b68132009-01-23 02:07:14 +00004757#define tunctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004758 "Create or delete tun interfaces\n" \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004759 "\nOptions:" \
4760 "\n -f name tun device (/dev/net/tun)" \
4761 "\n -t name Create iface 'name'" \
4762 "\n -d name Delete iface 'name'" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004763 IF_FEATURE_TUNCTL_UG( \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004764 "\n -u owner Set iface owner" \
4765 "\n -g group Set iface group" \
4766 "\n -b Brief output" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004767 )
Denis Vlasenko39b68132009-01-23 02:07:14 +00004768#define tunctl_example_usage \
4769 "# tunctl\n" \
4770 "# tunctl -d tun0\n"
4771
Mike Frysinger174808c2005-06-11 01:14:09 +00004772#define tune2fs_trivial_usage \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004773/* "[-c max-mounts-count] [-e errors-behavior] [-g group] " */ \
4774/* "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " */ \
4775/* "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " */ \
4776/* "[-r reserved-blocks-count] [-u user] [-C mount-count] " */ \
4777 "[-L LABEL] " \
4778/* "[-M last-mounted-dir] [-O [^]feature[,...]] " */ \
4779/* "[-T last-check-time] [-U UUID] " */ \
4780 "BLOCKDEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004781#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004782 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004783
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004784#define udhcpc_trivial_usage \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004785 "[-Cfbnqtvo] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004786 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." IF_FEATURE_UDHCP_PORT(" [-P N]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004787#define udhcpc_full_usage "\n\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004788 IF_LONG_OPTS( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004789 " -V,--vendorclass=CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004790 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
4791 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
4792 "\n -c,--clientid=CLIENTID Client identifier" \
4793 "\n -C,--clientid-none Suppress default client identifier" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +01004794 "\n -p,--pidfile=FILE Create pidfile" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004795 "\n -r,--request=IP IP address to request" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +01004796 "\n -s,--script=FILE Run FILE at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denys Vlasenkof26e98f2009-10-10 16:14:41 +02004797 "\n -t,--retries=N Send up to N discover packets" \
Denys Vlasenko84e1caf2009-10-10 16:13:17 +02004798 "\n -T,--timeout=N Pause between packets (default 3 seconds)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004799 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004800 "\n -O,--request-option=OPT Request DHCP option OPT (cumulative)" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004801 "\n -o,--no-default-options Don't request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004802 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004803 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004804 "\n -b,--background Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004805 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004806 "\n -S,--syslog Log to syslog too" \
4807 "\n -n,--now Exit with failure if lease is not immediately obtained" \
4808 "\n -q,--quit Quit after obtaining lease" \
4809 "\n -R,--release Release IP on quit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004810 IF_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004811 "\n -P,--client-port N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004812 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004813 IF_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004814 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004815 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004816 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004817 IF_NOT_LONG_OPTS( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004818 " -V CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004819 "\n -i INTERFACE Interface to use (default: eth0)" \
4820 "\n -H,-h HOSTNAME Client hostname" \
4821 "\n -c CLIENTID Client identifier" \
4822 "\n -C Suppress default client identifier" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +01004823 "\n -p FILE Create pidfile" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004824 "\n -r IP IP address to request" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +01004825 "\n -s FILE Run FILE at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004826 "\n -t N Send up to N request packets" \
4827 "\n -T N Try to get a lease for N seconds (default 3)" \
4828 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004829 "\n -O OPT Request DHCP option OPT (cumulative)" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004830 "\n -o Don't request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004831 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004832 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004833 "\n -b Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004834 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004835 "\n -S Log to syslog too" \
4836 "\n -n Exit with failure if lease is not immediately obtained" \
4837 "\n -q Quit after obtaining lease" \
4838 "\n -R Release IP on quit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004839 IF_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004840 "\n -P N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004841 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004842 IF_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004843 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004844 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004845 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004846
Russ Dill61fb4892002-10-14 21:41:28 +00004847#define udhcpd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004848 "[-fS]" IF_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004849
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004850#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004851 "DHCP server\n" \
4852 "\n -f Run in foreground" \
4853 "\n -S Log to syslog too" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004854 IF_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004855 "\n -P N Use port N instead of default 67" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004856 )
Russ Dill61fb4892002-10-14 21:41:28 +00004857
Eric Andersen7e9276b2001-02-22 01:15:47 +00004858#define umount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004859 "[OPTIONS] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004860#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004861 "Unmount file systems\n" \
4862 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004863 IF_FEATURE_UMOUNT_ALL( \
4864 "\n -a Unmount all file systems" IF_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004865 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004866 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004867 "\n -n Don't erase /etc/mtab entries" \
4868 ) \
4869 "\n -r Try to remount devices as read-only if mount is busy" \
4870 "\n -l Lazy umount (detach filesystem)" \
4871 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004872 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004873 "\n -d Free loop device if it has been used" \
4874 )
4875
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004876#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004877 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004878
4879#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004880 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004881#define uname_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004882 "Print system information\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004883 "\nOptions:" \
4884 "\n -a Print all" \
4885 "\n -m The machine (hardware) type" \
4886 "\n -n Hostname" \
4887 "\n -r OS release" \
4888 "\n -s OS name (default)" \
4889 "\n -p Processor type" \
4890 "\n -v OS version" \
4891
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004892#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004893 "$ uname -a\n" \
4894 "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 +00004895
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004896#define uncompress_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004897 "[-c] [-f] [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004898#define uncompress_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004899 "Uncompress .Z file[s]\n" \
4900 "\nOptions:" \
4901 "\n -c Extract to stdout" \
4902 "\n -f Overwrite an existing file" \
Tim Riker7b253f82003-12-28 05:02:40 +00004903
Denis Vlasenko3952f202007-08-13 14:10:24 +00004904#define unexpand_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004905 "[-f][-a][-t N] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004906#define unexpand_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004907 "Convert spaces to tabs, writing to standard output\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004908 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004909 IF_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004910 "\n -a,--all Convert all blanks" \
4911 "\n -f,--first-only Convert only leading blanks" \
4912 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004913 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004914 IF_NOT_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004915 "\n -a Convert all blanks" \
4916 "\n -f Convert only leading blanks" \
4917 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004918 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004919
Eric Andersen7e9276b2001-02-22 01:15:47 +00004920#define uniq_trivial_usage \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004921 "[-fscduw]... [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004922#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004923 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004924 "\nOptions:" \
4925 "\n -c Prefix lines by the number of occurrences" \
4926 "\n -d Only print duplicate lines" \
4927 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004928 "\n -f N Skip first N fields" \
4929 "\n -s N Skip first N chars (after any skipped fields)" \
4930 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004931
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004932#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004933 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4934 "a\n" \
4935 "b\n" \
4936 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004937
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004938#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004939 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004940#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004941 "Extract files from ZIP archives\n" \
4942 "\nOptions:" \
4943 "\n -l List archive contents (with -q for short form)" \
4944 "\n -n Never overwrite existing files (default)" \
4945 "\n -o Overwrite files without prompting" \
4946 "\n -p Send output to stdout" \
4947 "\n -q Quiet" \
4948 "\n -x Exclude these files" \
4949 "\n -d Extract files into this directory" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004950
Eric Andersen7e9276b2001-02-22 01:15:47 +00004951#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004952 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004953#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004954 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004955
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004956#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004957 "$ uptime\n" \
4958 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004959
4960#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004961 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004962#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004963 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004964
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004965#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004966 "$ usleep 1000000\n" \
4967 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004968
4969#define uudecode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004970 "[-o OUTFILE] [INFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004971#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004972 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004973 "Finds outfile name in uuencoded source unless -o is given"
4974
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004975#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004976 "$ uudecode -o busybox busybox.uu\n" \
4977 "$ ls -l busybox\n" \
4978 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004979
4980#define uuencode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004981 "[-m] [INFILE] STORED_FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004982#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004983 "Uuencode a file to stdout\n" \
4984 "\nOptions:" \
4985 "\n -m Use base64 encoding per RFC1521" \
4986
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004987#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004988 "$ uuencode busybox busybox\n" \
4989 "begin 755 busybox\n" \
4990 "<encoded file snipped>\n" \
4991 "$ uudecode busybox busybox > busybox.uu\n" \
4992 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004993
Eric Andersen853c4942003-01-23 05:59:32 +00004994#define vconfig_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004995 "COMMAND [OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004996#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004997 "Create and remove virtual ethernet devices\n" \
4998 "\nOptions:" \
4999 "\n add [interface-name] [vlan_id]" \
5000 "\n rem [vlan-name]" \
5001 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
5002 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
5003 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
5004 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00005005
Eric Andersen3f980402001-04-04 17:31:15 +00005006#define vi_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005007 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005008#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005009 "Edit FILE\n" \
5010 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005011 IF_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00005012 "\n -c Initial command to run ($EXINIT also available)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005013 IF_FEATURE_VI_READONLY( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01005014 "\n -R Read-only") \
Denis Vlasenko397de612008-03-17 08:55:44 +00005015 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00005016
Eric Andersen27f64e12002-06-23 04:24:25 +00005017#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005018 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005019#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005020 "Lock a virtual terminal. A password is required to unlock.\n" \
5021 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00005022 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00005023
Matthew Stoltenberg4803db52009-08-13 00:59:32 +02005024#define volname_trivial_usage \
5025 "[DEVICE]"
5026#define volname_full_usage "\n\n" \
5027 "Show CD volume name of the DEVICE (default /dev/cdrom)"
5028
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005029#define wall_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01005030 "[FILE]"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005031#define wall_full_usage "\n\n" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01005032 "Write content of FILE or standard-input to all logged-in users"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005033#define wall_sample_usage \
5034 "echo foo | wall\n" \
5035 "wall ./mymessage"
5036
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005037#define watch_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005038 "[-n seconds] [-t] PROG [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005039#define watch_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005040 "Run PROG periodically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005041 "\nOptions:" \
5042 "\n -n Loop period in seconds (default 2)" \
5043 "\n -t Don't print header" \
5044
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005045#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005046 "$ watch date\n" \
5047 "Mon Dec 17 10:31:40 GMT 2000\n" \
5048 "Mon Dec 17 10:31:42 GMT 2000\n" \
5049 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005050
Eric Andersen7e9276b2001-02-22 01:15:47 +00005051#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005052 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005053#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005054 "Periodically write to watchdog device DEV\n" \
5055 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005056 "\n -T N Reboot after N seconds if not reset (default 60)" \
5057 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00005058 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00005059 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005060 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005061
5062#define wc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005063 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005064#define wc_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005065 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005066 "more than one FILE is specified. With no FILE, read standard input.\n" \
5067 "\nOptions:" \
5068 "\n -c Print the byte counts" \
5069 "\n -l Print the newline counts" \
5070 "\n -L Print the length of the longest line" \
5071 "\n -w Print the word counts" \
5072
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005073#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005074 "$ wc /etc/passwd\n" \
5075 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005076
5077#define wget_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005078 IF_FEATURE_WGET_LONG_OPTIONS( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00005079 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00005080 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
5081 " [-U|--user-agent agent] url" \
5082 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005083 IF_NOT_FEATURE_WGET_LONG_OPTIONS( \
Denis Vlasenko03630782007-10-18 11:11:12 +00005084 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
5085 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005086#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005087 "Retrieve files via HTTP or FTP\n" \
5088 "\nOptions:" \
5089 "\n -s Spider mode - only check file existence" \
5090 "\n -c Continue retrieval of aborted transfer" \
5091 "\n -q Quiet" \
5092 "\n -P Set directory prefix to DIR" \
5093 "\n -O Save to filename ('-' for stdout)" \
5094 "\n -U Adjust 'User-Agent' field" \
5095 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005096
5097#define which_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005098 "[COMMAND]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005099#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005100 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005101#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005102 "$ which login\n" \
5103 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00005104
Eric Andersen00a6a752002-04-26 23:53:10 +00005105#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00005106 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005107#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005108 "Show who is logged on\n" \
5109 "\nOptions:" \
5110 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005111
5112#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005113 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005114#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005115 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005116
5117#define xargs_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005118 "[OPTIONS] [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005119#define xargs_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005120 "Run PROG on every item given by standard input\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005121 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005122 IF_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005123 "\n -p Ask user whether to run each command") \
Denys Vlasenko07697852009-10-06 21:11:37 +02005124 "\n -r Don't run command if input is empty" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005125 IF_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005126 "\n -0 Input is separated by NUL characters") \
5127 "\n -t Print the command on stderr before execution" \
Denis Vlasenkoe82da4d2008-08-21 19:59:30 +00005128 "\n -e[STR] STR stops input processing" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005129 "\n -n N Pass no more than N args to PROG" \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005130 "\n -s N Pass command line of no more than N bytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005131 IF_FEATURE_XARGS_SUPPORT_TERMOPT( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005132 "\n -x Exit if size is exceeded") \
Denis Vlasenko397de612008-03-17 08:55:44 +00005133
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005134#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005135 "$ ls | xargs gzip\n" \
5136 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005137
5138#define yes_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005139 "[OPTIONS] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005140#define yes_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005141 "Repeatedly output a line with STRING, or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00005142
Eric Andersen7e9276b2001-02-22 01:15:47 +00005143#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005144 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005145#define zcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005146 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00005147
Rob Landleyad8071f2005-04-30 03:49:37 +00005148#define zcip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005149 "[OPTIONS] IFACE SCRIPT"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005150#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005151 "Manage a ZeroConf IPv4 link-local address\n" \
5152 "\nOptions:" \
5153 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00005154 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005155 "\n -r 169.254.x.x Request this address first" \
5156 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00005157 "\n" \
5158 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
5159 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00005160
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00005161
5162#endif