blob: 168d6e1e5a2856937b3811b68b3351123a47cb3d [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 \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000855 "[-abdiNqrTstw] [-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" \
862 "\n -d Try hard to find a smaller set of changes" \
863 "\n -i Ignore case differences" \
864 "\n -L Use LABEL instead of the filename in the unified header" \
865 "\n -N Treat absent files as empty" \
866 "\n -q Output only whether files differ" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100867 "\n -r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000868 "\n -S Start with FILE when comparing directories" \
869 "\n -T Make tabs line up by prefixing a tab when necessary" \
870 "\n -s Report when two files are the same" \
871 "\n -t Expand tabs to spaces in output" \
872 "\n -U Output LINES lines of context" \
873 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000874
Eric Andersen7e9276b2001-02-22 01:15:47 +0000875#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000876 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000877#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000878 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000879#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000880 "$ dirname /tmp/foo\n" \
881 "/tmp\n" \
882 "$ dirname /tmp/foo/\n" \
883 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000884
Eric Andersen7e9276b2001-02-22 01:15:47 +0000885#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000886 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000887#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000888 "Print or control the kernel ring buffer\n" \
889 "\nOptions:" \
890 "\n -c Clear ring buffer after printing" \
891 "\n -n LEVEL Set console logging level" \
892 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000893
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000894#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000895 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000896#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000897 "Small static DNS server daemon\n" \
898 "\nOptions:" \
899 "\n -c Config filename" \
900 "\n -t TTL in seconds" \
901 "\n -p Listening port" \
902 "\n -i Listening ip (default all)" \
903 "\n -d Daemonize" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000904
Eric Andersen7e9276b2001-02-22 01:15:47 +0000905#define dos2unix_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +0200906 "[OPTIONS] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000907#define dos2unix_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200908 "Convert FILE in-place from DOS to Unix format.\n" \
909 "When no file is given, use stdin/stdout.\n" \
910 "\nOptions:" \
911 "\n -u dos2unix" \
912 "\n -d unix2dos" \
913
914#define unix2dos_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +0200915 "[OPTIONS] [FILE]"
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200916#define unix2dos_full_usage "\n\n" \
917 "Convert FILE in-place from Unix to DOS format.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000918 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000919 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000920 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000921 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000922
Eric Andersen7e9276b2001-02-22 01:15:47 +0000923#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000924 "[-ilCPru] [-F option] package_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000925#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000926 "Install, remove and manage Debian packages\n" \
927 "\nOptions:" \
928 "\n -i Install the package" \
929 "\n -l List of installed packages" \
930 "\n -C Configure an unpackaged package" \
931 "\n -F depends Ignore dependency problems" \
932 "\n -P Purge all files of a package" \
933 "\n -r Remove all but the configuration files for a package" \
934 "\n -u Unpack a package, but don't configure it" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000935
Eric Andersen7e9276b2001-02-22 01:15:47 +0000936#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000937 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000938#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000939 "Perform actions on Debian packages (.debs)\n" \
940 "\nOptions:" \
941 "\n -c List contents of filesystem tree" \
942 "\n -e Extract control files to [argument] directory" \
943 "\n -f Display control field name starting with [argument]" \
944 "\n -x Extract packages filesystem tree to directory" \
945 "\n -X Verbose extract" \
946
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000947#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000948 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000949
Eric Andersen7e9276b2001-02-22 01:15:47 +0000950#define du_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000951 "[-aHLdclsx" IF_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000952#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000953 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000954 "Disk space is printed in units of " \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000955 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
956 IF_NOT_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000957 " bytes.\n" \
958 "\nOptions:" \
959 "\n -a Show file sizes too" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000960 "\n -L Follow all symlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100961 "\n -H Follow symlinks on command line" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000962 "\n -d N Limit output to directories (and files with -a) of depth < N" \
963 "\n -c Show grand total" \
964 "\n -l Count sizes many times if hard linked" \
965 "\n -s Display only a total for each argument" \
966 "\n -x Skip directories on different filesystems" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000967 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000968 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
969 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000970 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000971 "\n -k Sizes in kilobytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000972 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000973
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000974#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000975 "$ du\n" \
976 "16 ./CVS\n" \
977 "12 ./kernel-patches/CVS\n" \
978 "80 ./kernel-patches\n" \
979 "12 ./tests/CVS\n" \
980 "36 ./tests\n" \
981 "12 ./scripts/CVS\n" \
982 "16 ./scripts\n" \
983 "12 ./docs/CVS\n" \
984 "104 ./docs\n" \
985 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000986
Eric Andersen7e9276b2001-02-22 01:15:47 +0000987#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000988 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000989#define dumpkmap_full_usage "\n\n" \
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000990 "Print a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000991#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000992 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000993
Russ Dill61fb4892002-10-14 21:41:28 +0000994#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000995 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000996#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000997 "Display DHCP leases granted by udhcpd\n" \
998 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200999 IF_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001000 "\n -f,--file=FILE Leases file to load" \
1001 "\n -r,--remaining Interpret lease times as time remaining" \
1002 "\n -a,--absolute Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001003 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001004 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001005 "\n -f FILE Leases file to load" \
1006 "\n -r Interpret lease times as time remaining" \
1007 "\n -a Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001008 )
Russ Dill61fb4892002-10-14 21:41:28 +00001009
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001010/*
Mike Frysinger51a43b42005-09-24 07:11:16 +00001011#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001012 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
1013 "[-I inode_buffer_blocks] [-P process_inode_size] " \
1014 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
1015 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001016#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001017 "Check ext2/ext3 file system\n" \
1018 "\nOptions:" \
1019 "\n -p Automatic repair (no questions)" \
1020 "\n -n Make no changes to the filesystem" \
1021 "\n -y Assume 'yes' to all questions" \
1022 "\n -c Check for bad blocks and add them to the badblock list" \
1023 "\n -f Force checking even if filesystem is marked clean" \
1024 "\n -v Verbose" \
1025 "\n -b superblock Use alternative superblock" \
1026 "\n -B blocksize Force blocksize when looking for superblock" \
1027 "\n -j journal Set location of the external journal" \
1028 "\n -l file Add to badblocks list" \
1029 "\n -L file Set badblocks list" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001030*/
Mike Frysinger51a43b42005-09-24 07:11:16 +00001031
Eric Andersen7e9276b2001-02-22 01:15:47 +00001032#define echo_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001033 IF_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001034#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001035 "Print the specified ARGs to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001036 IF_FEATURE_FANCY_ECHO( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001037 "\nOptions:" \
1038 "\n -n Suppress trailing newline" \
1039 "\n -e Interpret backslash-escaped characters (i.e., \\t=tab)" \
1040 "\n -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001041 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001042#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001043 "$ echo \"Erik is cool\"\n" \
1044 "Erik is cool\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001045 IF_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001046 "Erik\n" \
1047 "is\n" \
1048 "cool\n" \
1049 "$ echo \"Erik\\nis\\ncool\"\n" \
1050 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001051
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001052#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001053 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001054#define eject_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001055 "Eject specified DEVICE (or default /dev/cdrom)\n" \
1056 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001057 IF_FEATURE_EJECT_SCSI( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001058 "\n -s SCSI device" \
1059 ) \
1060 "\n -t Close tray" \
1061 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001062
Rob Landley3b890392006-05-04 20:56:43 +00001063#define ed_trivial_usage ""
1064#define ed_full_usage ""
1065
Eric Andersen84e229c2001-03-29 22:48:33 +00001066#define env_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001067 "[-iu] [-] [name=value]... [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001068#define env_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001069 "Print the current environment or run PROG after setting up\n" \
1070 "the specified environment\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001071 "\nOptions:" \
1072 "\n -, -i Start with an empty environment" \
1073 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +00001074
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001075#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001076 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001077#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001078 "Send a magic packet to wake up sleeping machines.\n" \
1079 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001080 "a hostname with a known 'ethers' entry.\n" \
1081 "\nOptions:" \
1082 "\n -b Send wake-up packet to the broadcast address" \
1083 "\n -i iface Interface to use (default eth0)" \
1084 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001085
Denis Vlasenko3952f202007-08-13 14:10:24 +00001086#define expand_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001087 "[-i] [-t N] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001088#define expand_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001089 "Convert tabs to spaces, writing to standard output\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001090 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001091 IF_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001092 "\n -i,--initial Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001093 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001094 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001095 IF_NOT_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001096 "\n -i Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001097 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001098 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00001099
Eric Andersen7e9276b2001-02-22 01:15:47 +00001100#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001101 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001102#define expr_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001103 "Print the value of EXPRESSION to standard output\n" \
1104 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001105 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001106 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
1107 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1108 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1109 " ARG1 <= ARG2\n" \
1110 " ARG1 = ARG2\n" \
1111 " ARG1 != ARG2\n" \
1112 " ARG1 >= ARG2\n" \
1113 " ARG1 > ARG2\n" \
1114 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1115 " ARG1 - ARG2\n" \
1116 " ARG1 * ARG2\n" \
1117 " ARG1 / ARG2\n" \
1118 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001119 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1120 " match STRING REGEXP Same as STRING : REGEXP\n" \
1121 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1122 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1123 " length STRING Length of STRING\n" \
1124 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001125 " it is a keyword like 'match' or an\n" \
1126 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001127 " (EXPRESSION) Value of EXPRESSION\n" \
1128 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001129 "Beware that many operators need to be escaped or quoted for shells.\n" \
1130 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001131 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001132 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1133 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001134
Mike Frysingerfa69f112005-04-17 07:24:19 +00001135#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001136 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001137#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001138 "Provide fake ident (auth) service\n" \
1139 "\nOptions:" \
1140 "\n -f Run in foreground" \
1141 "\n -i Inetd mode" \
1142 "\n -w Inetd 'wait' mode" \
1143 "\n -b ADDR Bind to specified address" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001144 "\n STRING Ident answer string (default: nobody)" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001145
Eric Andersen7e9276b2001-02-22 01:15:47 +00001146#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001147 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001148#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001149 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001150
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001151#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001152 "$ false\n" \
1153 "$ echo $?\n" \
1154 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001155
1156#define fbset_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001157 "[OPTIONS] [MODE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001158#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001159 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001160
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001161#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001162 "$ fbset\n" \
1163 "mode \"1024x768-76\"\n" \
1164 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1165 " geometry 1024 768 1024 768 16\n" \
1166 " timings 12714 128 32 16 4 128 4\n" \
1167 " accel false\n" \
1168 " rgba 5/11,6/5,5/0,0/0\n" \
1169 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001170
Eric Andersen7e9276b2001-02-22 01:15:47 +00001171#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001172 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001173#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001174 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001175
Eric Andersen01c3d402003-07-05 07:51:31 +00001176#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001177 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001178#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001179 "Format floppy disk\n" \
1180 "\nOptions:" \
1181 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001182
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001183/* Looks like someone forgot to add this to config system */
1184#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1185# define ENABLE_FEATURE_FDISK_BLKSIZE 0
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001186# define IF_FEATURE_FDISK_BLKSIZE(a)
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001187#endif
1188
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001189#define fdisk_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001190 "[-ul" IF_FEATURE_FDISK_BLKSIZE("s") "] " \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001191 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001192#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001193 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001194 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001195 "\n -u Start and End are in sectors (instead of cylinders)" \
1196 "\n -l Show partition table for each DISK, then exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001197 IF_FEATURE_FDISK_BLKSIZE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001198 "\n -s Show partition sizes in kb for each DISK, then exit" \
1199 ) \
1200 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1201 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
1202 "\n -H HEADS\n" \
1203 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001204
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001205#define blkid_trivial_usage \
1206 ""
1207#define blkid_full_usage "\n\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02001208 "Print UUIDs of all filesystems"
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001209
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001210#define findfs_trivial_usage \
1211 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001212#define findfs_full_usage "\n\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02001213 "Find a filesystem device based on a label or UUID"
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001214#define findfs_example_usage \
1215 "$ findfs LABEL=MyDevice"
1216
Eric Andersen7e9276b2001-02-22 01:15:47 +00001217#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001218 "[PATH...] [EXPRESSION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001219#define find_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001220 "Search for files. The default PATH is the current directory,\n" \
1221 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001222 "\nEXPRESSION may consist of:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001223 "\n -follow Follow symlinks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001224 IF_FEATURE_FIND_XDEV( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001225 "\n -xdev Don't descend directories on other filesystems") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001226 IF_FEATURE_FIND_MAXDEPTH( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001227 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1228 "\n tests/actions to command line arguments only") \
Denys Vlasenko07697852009-10-06 21:11:37 +02001229 "\n -mindepth N Don't act on first N levels" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001230 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001231 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001232 IF_FEATURE_FIND_PATH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001233 "\n -path PATTERN Path matches PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001234 IF_FEATURE_FIND_REGEX( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001235 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001236 IF_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001237 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001238 IF_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001239 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001240 "\n or exactly NNN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001241 IF_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001242 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001243 "\n or exactly N days") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001244 IF_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001245 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001246 "\n or exactly N minutes") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001247 IF_FEATURE_FIND_NEWER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001248 "\n -newer FILE Modified time is more recent than FILE's") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001249 IF_FEATURE_FIND_INUM( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001250 "\n -inum N File has inode number N") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001251 IF_FEATURE_FIND_USER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001252 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001253 IF_FEATURE_FIND_GROUP( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001254 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001255 IF_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001256 "\n -depth Process directory name after traversing it") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001257 IF_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001258 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1259 "\n +/-N: file size is bigger/smaller than N") \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001260 IF_FEATURE_FIND_LINKS( \
1261 "\n -links N Number of links is greater than (+N), less than (-N)," \
1262 "\n or exactly N") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001263 "\n -print Print (default and assumed)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001264 IF_FEATURE_FIND_PRINT0( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001265 "\n -print0 Delimit output with null characters rather than" \
1266 "\n newlines") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001267 IF_FEATURE_FIND_CONTEXT ( \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001268 "\n -context File has specified security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001269 IF_FEATURE_FIND_EXEC( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001270 "\n -exec CMD ARG ; Run CMD with all instances of {} replaced by the" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001271 "\n matching files") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001272 IF_FEATURE_FIND_PRUNE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001273 "\n -prune Stop traversing current subtree") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001274 IF_FEATURE_FIND_DELETE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001275 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001276 IF_FEATURE_FIND_PAREN( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001277 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001278
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001279#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001280 "$ find / -name passwd\n" \
1281 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001282
Denys Vlasenkobf2af9a2009-05-25 04:15:37 +02001283#define flash_lock_trivial_usage \
1284 "MTD_DEVICE OFFSET SECTORS"
1285#define flash_lock_full_usage "\n\n" \
1286 "Lock part or all of an MTD device. If SECTORS is -1, then all sectors\n" \
1287 "will be locked, regardless of the value of OFFSET"
1288
1289#define flash_unlock_trivial_usage \
1290 "MTD_DEVICE"
1291#define flash_unlock_full_usage "\n\n" \
1292 "Unlock an MTD device"
1293
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001294#define flash_eraseall_trivial_usage \
1295 "[-jq] MTD_DEVICE"
1296#define flash_eraseall_full_usage "\n\n" \
1297 "Erase an MTD device\n" \
1298 "\nOptions:" \
Stefan Seyfriedd095fd42009-11-21 18:32:19 +01001299 "\n -j Format the device for jffs2" \
1300 "\n -q Don't display progress messages" \
1301
1302#define flashcp_trivial_usage \
1303 "-v FILE MTD_DEVICE"
1304#define flashcp_full_usage "\n\n" \
1305 "Copy an image to MTD device\n" \
1306 "\nOptions:" \
1307 "\n -v Verbose" \
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001308
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001309#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001310 "[-bs] [-w WIDTH] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001311#define fold_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001312 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001313 "standard output\n" \
1314 "\nOptions:" \
1315 "\n -b Count bytes rather than columns" \
1316 "\n -s Break at spaces" \
1317 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001318
Eric Andersen7e9276b2001-02-22 01:15:47 +00001319#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001320 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001321#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001322 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001323#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001324 "$ free\n" \
1325 " total used free shared buffers\n" \
1326 " Mem: 257628 248724 8904 59644 93124\n" \
1327 " Swap: 128516 8404 120112\n" \
1328 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001329
Eric Andersen7e9276b2001-02-22 01:15:47 +00001330#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001331 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001332#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001333 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001334#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001335 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001336
Mike Frysinger51a43b42005-09-24 07:11:16 +00001337#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001338 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001339#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001340 "Check and repair filesystems\n" \
1341 "\nOptions:" \
1342 "\n -A Walk /etc/fstab and check all filesystems" \
1343 "\n -N Don't execute, just show what would be done" \
1344 "\n -P With -A, check filesystems in parallel" \
1345 "\n -R With -A, skip the root filesystem" \
1346 "\n -T Don't show title on startup" \
1347 "\n -V Verbose" \
1348 "\n -C n Write status information to specified filedescriptor" \
1349 "\n -t type List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001350
Eric Andersen7e9276b2001-02-22 01:15:47 +00001351#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001352 "[-larvsmf] /dev/name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001353#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001354 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001355 "\nOptions:" \
1356 "\n -l List all filenames" \
1357 "\n -r Perform interactive repairs" \
1358 "\n -a Perform automatic repairs" \
1359 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001360 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001361 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001362 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001363
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001364#define ftpd_trivial_usage \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001365 "[-wvS] [-t N] [-T N] [DIR]"
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001366#define ftpd_full_usage "\n\n" \
Denys Vlasenkoae357bd2009-09-11 23:29:45 +02001367 "Anonymous FTP server\n" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001368 "\n" \
1369 "ftpd should be used as an inetd service.\n" \
1370 "ftpd's line for inetd.conf:\n" \
1371 " 21 stream tcp nowait root ftpd ftpd /files/to/serve\n" \
1372 "It also can be ran from tcpsvd:\n" \
1373 " tcpsvd -vE 0.0.0.0 21 ftpd /files/to/serve\n" \
1374 "\nOptions:" \
1375 "\n -w Allow upload" \
Denis Vlasenko4221e902009-03-11 15:07:44 +00001376 "\n -v Log to stderr" \
1377 "\n -S Log to syslog" \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001378 "\n -t,-T Idle and absolute timeouts" \
Denis Vlasenko92576712009-03-09 16:25:33 +00001379 "\n DIR Change root to this directory" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001380
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001381#define ftpget_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001382 "[OPTIONS] HOST [LOCAL_FILE] REMOTE_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001383#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001384 "Retrieve a remote file via FTP\n" \
1385 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001386 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001387 "\n -c,--continue Continue previous transfer" \
1388 "\n -v,--verbose Verbose" \
1389 "\n -u,--username Username" \
1390 "\n -p,--password Password" \
1391 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001392 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001393 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001394 "\n -c Continue previous transfer" \
1395 "\n -v Verbose" \
1396 "\n -u Username" \
1397 "\n -p Password" \
1398 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001399 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001400
1401#define ftpput_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001402 "[OPTIONS] HOST [REMOTE_FILE] LOCAL_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001403#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001404 "Store a local file on a remote machine via FTP\n" \
1405 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001406 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001407 "\n -v,--verbose Verbose" \
1408 "\n -u,--username Username" \
1409 "\n -p,--password Password" \
1410 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001411 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001412 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001413 "\n -v Verbose" \
1414 "\n -u Username" \
1415 "\n -p Password" \
1416 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001417 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001418
Rob Landleyaa872762005-10-28 13:05:12 +00001419#define fuser_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001420 "[OPTIONS] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001421#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001422 "Find processes which use FILEs or PORTs\n" \
1423 "\nOptions:" \
1424 "\n -m Find processes which use same fs as FILEs" \
1425 "\n -4 Search only IPv4 space" \
1426 "\n -6 Search only IPv6 space" \
1427 "\n -s Silent: just exit with 0 if any processes are found" \
1428 "\n -k Kill found processes (otherwise display PIDs)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001429 "\n -SIGNAL Signal to send (default: TERM)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001430
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001431#define getenforce_trivial_usage NOUSAGE_STR
1432#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001433
Eric Andersen7e9276b2001-02-22 01:15:47 +00001434#define getopt_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001435 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001436#define getopt_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001437 "Options:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001438 IF_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001439 "\n -a,--alternative Allow long options starting with single -" \
1440 "\n -l,--longoptions=longopts Long options to be recognized" \
1441 "\n -n,--name=progname The name under which errors are reported" \
1442 "\n -o,--options=optstring Short options to be recognized" \
1443 "\n -q,--quiet Disable error reporting by getopt(3)" \
1444 "\n -Q,--quiet-output No normal output" \
1445 "\n -s,--shell=shell Set shell quoting conventions" \
1446 "\n -T,--test Test for getopt(1) version" \
1447 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001448 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001449 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001450 "\n -a Allow long options starting with single -" \
1451 "\n -l longopts Long options to be recognized" \
1452 "\n -n progname The name under which errors are reported" \
1453 "\n -o optstring Short options to be recognized" \
1454 "\n -q Disable error reporting by getopt(3)" \
1455 "\n -Q No normal output" \
1456 "\n -s shell Set shell quoting conventions" \
1457 "\n -T Test for getopt(1) version" \
1458 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001459 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001460#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001461 "$ cat getopt.test\n" \
1462 "#!/bin/sh\n" \
1463 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1464 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001465 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001466 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001467 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001468 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001469 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1470 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001471 " -c|--c-long)\n" \
1472 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001473 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1474 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1475 " esac;;\n" \
1476 " --) shift; break;;\n" \
1477 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001478 " esac\n" \
1479 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001480
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001481#define getsebool_trivial_usage \
1482 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001483#define getsebool_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001484 " -a Show all SELinux booleans"
1485
Eric Andersenf349e972001-08-21 16:18:59 +00001486#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001487 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001488#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001489 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1490 "\nOptions:" \
1491 "\n -h Enable hardware (RTS/CTS) flow control" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001492 "\n -i Don't display /etc/issue before running login" \
1493 "\n -L Local line, don't do carrier detect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001494 "\n -m Get baud rate from modem's CONNECT status message" \
1495 "\n -w Wait for a CR or LF before sending /etc/issue" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001496 "\n -n Don't prompt the user for a login name" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02001497 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
1498 "\n -l LOGIN Invoke LOGIN instead of /bin/login" \
1499 "\n -t SEC Terminate after SEC if no username is read" \
1500 "\n -I INITSTR Send INITSTR before anything else" \
1501 "\n -H HOST Log HOST into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001502
Eric Andersen7e9276b2001-02-22 01:15:47 +00001503#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001504 "[-HhrilLnqvso" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001505 IF_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001506 "eF" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001507 IF_FEATURE_GREP_EGREP_ALIAS("E") \
1508 IF_FEATURE_GREP_CONTEXT("ABC") \
1509 IF_EXTRA_COMPAT("z") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001510 "] PATTERN [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001511#define grep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001512 "Search for PATTERN in each FILE or standard input\n" \
1513 "\nOptions:" \
1514 "\n -H Prefix output lines with filename where match was found" \
1515 "\n -h Suppress the prefixing filename on output" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001516 "\n -r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001517 "\n -i Ignore case distinctions" \
1518 "\n -l List names of files that match" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001519 "\n -L List names of files that don't match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001520 "\n -n Print line number with output lines" \
1521 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1522 "\n -v Select non-matching lines" \
1523 "\n -s Suppress file open/read error messages" \
1524 "\n -c Only print count of matching lines" \
1525 "\n -o Show only the part of a line that matches PATTERN" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001526 "\n -m N Match up to N times per file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001527 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001528 "\n -w Match whole words only") \
1529 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001530 IF_FEATURE_GREP_EGREP_ALIAS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001531 "\n -E PATTERN is an extended regular expression") \
1532 "\n -e PTRN Pattern to match" \
1533 "\n -f FILE Read pattern from file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001534 IF_FEATURE_GREP_CONTEXT( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001535 "\n -A N Print N lines of trailing context" \
1536 "\n -B N Print N lines of leading context" \
1537 "\n -C N Print N lines of output context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001538 IF_EXTRA_COMPAT( \
Denis Vlasenko83518d12009-03-20 22:17:13 +00001539 "\n -z Input is NUL terminated") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001540
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001541#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001542 "$ grep root /etc/passwd\n" \
1543 "root:x:0:0:root:/root:/bin/bash\n" \
1544 "$ grep ^[rR]oo. /etc/passwd\n" \
1545 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001546
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001547#define egrep_trivial_usage NOUSAGE_STR
1548#define egrep_full_usage ""
1549
1550#define fgrep_trivial_usage NOUSAGE_STR
1551#define fgrep_full_usage ""
1552
Eric Andersen7e9276b2001-02-22 01:15:47 +00001553#define gunzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001554 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001555#define gunzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001556 "Uncompress FILEs (or standard input)\n" \
1557 "\nOptions:" \
1558 "\n -c Write to standard output" \
1559 "\n -f Force" \
1560 "\n -t Test file integrity" \
1561
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001562#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001563 "$ ls -la /tmp/BusyBox*\n" \
1564 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1565 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1566 "$ ls -la /tmp/BusyBox*\n" \
1567 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001568
1569#define gzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001570 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001571#define gzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001572 "Compress FILEs (or standard input)\n" \
1573 "\nOptions:" \
1574 "\n -c Write to standard output" \
1575 "\n -d Decompress" \
1576 "\n -f Force" \
1577
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001578#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001579 "$ ls -la /tmp/busybox*\n" \
1580 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1581 "$ gzip /tmp/busybox.tar\n" \
1582 "$ ls -la /tmp/busybox*\n" \
1583 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001584
1585#define halt_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001586 "[-d DELAY] [-n] [-f]" IF_FEATURE_WTMP(" [-w]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001587#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001588 "Halt the system\n" \
1589 "\nOptions:" \
1590 "\n -d Delay interval for halting" \
1591 "\n -n No call to sync()" \
1592 "\n -f Force halt (don't go through init)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001593 IF_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001594 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001595 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001596
Eric Andersen3443bd72003-07-22 07:30:36 +00001597#define hdparm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001598 "[OPTIONS] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001599#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001600 "Options:" \
1601 "\n -a Get/set fs readahead" \
1602 "\n -A Set drive read-lookahead flag (0/1)" \
1603 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1604 "\n -B Set Advanced Power Management setting (1-255)" \
1605 "\n -c Get/set IDE 32-bit IO setting" \
1606 "\n -C Check IDE power mode status" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001607 IF_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001608 "\n -d Get/set using_dma flag") \
1609 "\n -D Enable/disable drive defect-mgmt" \
1610 "\n -f Flush buffer cache for device on exit" \
1611 "\n -g Display drive geometry" \
1612 "\n -h Display terse usage information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001613 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001614 "\n -i Display drive identification") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001615 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001616 "\n -I Detailed/current information directly from drive") \
1617 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1618 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1619 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1620 "\n -m Get/set multiple sector count" \
1621 "\n -n Get/set ignore-write-errors flag (0/1)" \
1622 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1623 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001624/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001625 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1626 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001627 IF_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001628 "\n -R Register an IDE interface (DANGEROUS)") \
1629 "\n -S Set standby (spindown) timeout" \
1630 "\n -t Perform device read timings" \
1631 "\n -T Perform cache read timings" \
1632 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001633 IF_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001634 "\n -U Unregister an IDE interface (DANGEROUS)") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001635 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1636 "\n -V Display program version and exit immediately" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001637 IF_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001638 "\n -w Perform device reset (DANGEROUS)") \
1639 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001640 IF_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001641 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1642 "\n -X Set IDE xfer mode (DANGEROUS)" \
1643 "\n -y Put IDE drive in standby mode" \
1644 "\n -Y Put IDE drive to sleep" \
1645 "\n -Z Disable Seagate auto-powersaving mode" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001646 "\n -z Reread partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001647
Eric Andersen7e9276b2001-02-22 01:15:47 +00001648#define head_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001649 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001650#define head_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02001651 "Print first 10 lines of each FILE (or standard input) to standard output.\n" \
1652 "With more than one FILE, precede each with a header giving the file name.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001653 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001654 "\n -n N Print first N lines instead of first 10" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001655 IF_FEATURE_FANCY_HEAD( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001656 "\n -c N Output the first N bytes" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001657 "\n -q Never output headers giving file names" \
1658 "\n -v Always output headers giving file names") \
1659
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001660#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001661 "$ head -n 2 /etc/passwd\n" \
1662 "root:x:0:0:root:/root:/bin/bash\n" \
1663 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001664
Glenn L McGrath60281112001-11-02 11:39:46 +00001665#define hexdump_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001666 "[-bcCdefnosvx" IF_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001667#define hexdump_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02001668 "Display FILEs or standard input in a user specified format\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001669 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001670 "\n -b One-byte octal display" \
1671 "\n -c One-byte character display" \
1672 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1673 "\n -d Two-byte decimal display" \
1674 "\n -e FORMAT STRING" \
1675 "\n -f FORMAT FILE" \
1676 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1677 "\n -o Two-byte octal display" \
1678 "\n -s OFFSET Skip OFFSET bytes" \
1679 "\n -v Display all input data" \
1680 "\n -x Two-byte hexadecimal display" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001681 IF_FEATURE_HEXDUMP_REVERSE( \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001682 "\n -R Reverse of 'hexdump -Cv'") \
1683
1684#define hd_trivial_usage \
1685 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001686#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001687 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001688
Eric Andersen7e9276b2001-02-22 01:15:47 +00001689#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001690 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001691#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001692 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001693
1694#define hostname_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001695 "[OPTIONS] [HOSTNAME | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001696#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001697 "Get or set hostname or DNS domain name\n" \
1698 "\nOptions:" \
1699 "\n -s Short" \
1700 "\n -i Addresses for the hostname" \
1701 "\n -d DNS domain name" \
1702 "\n -f Fully qualified domain name" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001703 "\n -F FILE Use FILE's content as hostname" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001704
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001705#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001706 "$ hostname\n" \
1707 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001708
Denys Vlasenkod30b89c2009-06-26 01:55:45 +02001709#define dnsdomainname_trivial_usage NOUSAGE_STR
1710#define dnsdomainname_full_usage ""
1711
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001712#define httpd_trivial_usage \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001713 "[-ifv[v]]" \
1714 " [-c CONFFILE]" \
1715 " [-p [IP:]PORT]" \
1716 IF_FEATURE_HTTPD_SETUID(" [-u USER[:GRP]]") \
1717 IF_FEATURE_HTTPD_BASIC_AUTH(" [-r REALM]") \
1718 " [-h HOME]\n" \
1719 "or httpd -d/-e" IF_FEATURE_HTTPD_AUTH_MD5("/-m") " STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001720#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001721 "Listen for incoming HTTP requests\n" \
1722 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001723 "\n -i Inetd mode" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001724 "\n -f Don't daemonize" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001725 "\n -v[v] Verbose" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001726 "\n -c FILE Configuration file (default httpd.conf)" \
1727 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001728 IF_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001729 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001730 IF_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001731 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001732 "\n -h HOME Home directory (default .)" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001733 IF_FEATURE_HTTPD_AUTH_MD5( \
1734 "\n -m STRING MD5 crypt STRING") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001735 "\n -e STRING HTML encode STRING" \
1736 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001737
Robert Griebl1cd04452002-07-21 16:50:49 +00001738#define hwclock_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001739 IF_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001740 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1741 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001742 " [-f FILE]" \
1743 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001744 IF_NOT_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001745 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1746 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001747#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001748 "Query and set hardware clock (RTC)\n" \
1749 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001750 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001751 "\n -s Set system time from hardware clock" \
1752 "\n -w Set hardware clock to system time" \
1753 "\n -u Hardware clock is in UTC" \
1754 "\n -l Hardware clock is in local time" \
1755 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001756
Eric Andersen7e9276b2001-02-22 01:15:47 +00001757#define id_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001758 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001759#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001760 "Print information about USER or the current user\n" \
1761 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001762 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001763 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001764 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001765 "\n -u Print user ID" \
Denis Vlasenko4f3209b2008-09-13 12:51:10 +00001766 "\n -g Print group ID" \
1767 "\n -G Print supplementary group IDs" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001768 "\n -n Print name instead of a number" \
1769 "\n -r Print real user ID instead of effective ID" \
1770
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001771#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001772 "$ id\n" \
1773 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001774
Eric Andersen7e9276b2001-02-22 01:15:47 +00001775#define ifconfig_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001776 IF_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001777#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001778 "Configure a network interface\n" \
1779 "\nOptions:" \
1780 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001781 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001782 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001783 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001784 " [del ADDRESS[/PREFIXLEN]]\n") \
1785 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1786 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001787 IF_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001788 " [outfill NN] [keepalive NN]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001789 " " IF_FEATURE_IFCONFIG_HW("[hw ether" IF_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001790 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001791 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001792 IF_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001793 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001794 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001795
Denis Vlasenko06aed432008-02-26 18:25:24 +00001796#define ifenslave_trivial_usage \
1797 "[-cdf] master-iface <slave-iface...>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001798#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001799 "Configure network interfaces for parallel routing\n" \
1800 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001801 "\n -c, --change-active Change active slave" \
1802 "\n -d, --detach Remove slave interface from bonding device" \
1803 "\n -f, --force Force, even if interface is not Ethernet" \
1804/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001805
Denis Vlasenko06aed432008-02-26 18:25:24 +00001806#define ifenslave_example_usage \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001807 "To create a bond device, simply follow these three steps:\n" \
1808 "- ensure that the required drivers are properly loaded:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001809 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001810 "- assign an IP address to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001811 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001812 "- attach all the interfaces you need to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001813 " # ifenslave bond0 eth0 eth1 eth2\n" \
1814 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1815 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001816 " To detach a dead interface without setting the bond device down:\n" \
1817 " # ifenslave -d bond0 eth1\n\n" \
1818 " To set the bond device down and automatically release all the slaves:\n" \
1819 " # ifconfig bond0 down\n\n" \
1820 " To change active slave:\n" \
1821 " # ifenslave -c bond0 eth0\n" \
1822
1823#define ifplugd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001824 "[OPTIONS]"
Denis Vlasenko71c16572009-04-26 01:08:51 +00001825#define ifplugd_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +02001826 "Network interface plug detection daemon\n" \
1827 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001828 "\n -n Don't daemonize" \
1829 "\n -s Don't log to syslog" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001830 "\n -i IFACE Interface" \
1831 "\n -f/-F Treat link detection error as link down/link up" \
1832 "\n (otherwise exit on error)" \
Denys Vlasenko999e4422010-01-08 13:03:48 +01001833 "\n -a Don't up interface at each link probe" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001834 "\n -M Monitor creation/destruction of interface" \
1835 "\n (otherwise it must exist)" \
1836 "\n -r PROG Script to run" \
1837 "\n -x ARG Extra argument for script" \
1838 "\n -I Don't exit on nonzero exit code from script" \
1839 "\n -p Don't run script on daemon startup" \
1840 "\n -q Don't run script on daemon quit" \
1841 "\n -l Run script on startup even if no cable is detected" \
1842 "\n -t SECS Poll time in seconds" \
1843 "\n -u SECS Delay before running script after link up" \
1844 "\n -d SECS Delay after link down" \
Denys Vlasenkob8f0e802010-01-07 14:56:50 +01001845 "\n -m MODE API mode (mii, priv, ethtool, wlan, iff, auto)" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001846 "\n -k Kill running daemon" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001847
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001848#define ifup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001849 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001850#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001851 "Options:" \
1852 "\n -a De/configure all interfaces automatically" \
1853 "\n -i FILE Use FILE for interface definitions" \
1854 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001855 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001856 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001857 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001858 ) \
1859 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001860 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001861
1862#define ifdown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001863 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001864#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001865 "Options:" \
1866 "\n -a De/configure all interfaces automatically" \
1867 "\n -i FILE Use FILE for interface definitions" \
1868 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001869 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001870 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001871 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001872 ) \
1873 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001874 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001875
Glenn L McGrath06e95652003-02-09 06:51:14 +00001876#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001877 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001878#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001879 "Listen for network connections and launch programs\n" \
1880 "\nOptions:" \
1881 "\n -f Run in foreground" \
1882 "\n -e Log to stderr" \
1883 "\n -q N Socket listen queue (default: 128)" \
1884 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001885 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001886
Eric Andersen7e9276b2001-02-22 01:15:47 +00001887#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001888 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001889#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001890 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001891
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001892#define init_notes_usage \
1893"This version of init is designed to be run only by the kernel.\n" \
1894"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001895"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001896"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001897"runlevels, use sysvinit.\n" \
1898"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001899"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001900"it has the following default behavior:\n" \
1901"\n" \
1902" ::sysinit:/etc/init.d/rcS\n" \
1903" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001904" ::ctrlaltdel:/sbin/reboot\n" \
1905" ::shutdown:/sbin/swapoff -a\n" \
1906" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001907" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001908"\n" \
1909"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1910"\n" \
1911" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001912" tty3::askfirst:/bin/sh\n" \
1913" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001914"\n" \
1915"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1916"\n" \
1917" <id>:<runlevels>:<action>:<process>\n" \
1918"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001919" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001920"\n" \
1921" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1922" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001923" the specified process to run on. The contents of this field are\n" \
1924" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1925" be unique, although if it isn't you may have strange results. If this\n" \
1926" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001927" note that if BusyBox detects that a serial console is in use, then only\n" \
1928" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001929" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001930" stinkin' utmp.\n" \
1931"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001932" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001933"\n" \
1934" The runlevels field is completely ignored.\n" \
1935"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001936" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001937"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001938" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001939" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001940"\n" \
1941" The available actions can be classified into two groups: actions\n" \
1942" that are run only once, and actions that are re-run when the specified\n" \
1943" process exits.\n" \
1944"\n" \
1945" Run only-once actions:\n" \
1946"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001947" 'sysinit' is the first item run on boot. init waits until all\n" \
1948" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001949" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001950" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001951" the specified task completes. 'once' actions are asynchronous,\n" \
1952" therefore, init does not wait for them to complete. 'restart' is\n" \
1953" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001954" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001955" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001956" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001957" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001958" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001959" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001960" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001961" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001962"\n" \
1963" Run repeatedly actions:\n" \
1964"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001965" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001966" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001967" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1968" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001969" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001970" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001971" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001972" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001973"\n" \
1974" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001975" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001976" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001977"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001978" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001979"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001980" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001981"\n" \
1982"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001983"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001984" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001985" #\n" \
1986" ::sysinit:/etc/init.d/rcS\n" \
1987" \n" \
1988" # /bin/sh invocations on selected ttys\n" \
1989" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001990" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001991" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001992" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001993" tty2::askfirst:-/bin/sh\n" \
1994" tty3::askfirst:-/bin/sh\n" \
1995" tty4::askfirst:-/bin/sh\n" \
1996" \n" \
1997" # /sbin/getty invocations for selected ttys\n" \
1998" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001999" tty4::respawn:/sbin/getty 38400 tty4\n" \
2000" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002001" \n" \
2002" \n" \
2003" # Example of how to put a getty on a serial line (for a terminal)\n" \
2004" #\n" \
2005" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
2006" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
2007" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002008" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002009" #::respawn:/sbin/getty 57600 ttyS2\n" \
2010" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00002011" # Stuff to do when restarting the init process\n" \
2012" ::restart:/sbin/init\n" \
2013" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002014" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002015" ::ctrlaltdel:/sbin/reboot\n" \
2016" ::shutdown:/bin/umount -a -r\n" \
2017" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002018
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002019#define inotifyd_trivial_usage \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002020 "PROG FILE1[:MASK] ..."
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002021#define inotifyd_full_usage "\n\n" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002022 "Run PROG on filesystem changes." \
2023 "\nWhen a filesystem event matching MASK occurs on FILEn," \
2024 "\nPROG <actual_event(s)> <FILEn> [<subfile_name>] is run." \
Denis Vlasenko289ff0e2008-11-14 21:52:16 +00002025 "\nEvents:" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002026 "\n a File is accessed" \
2027 "\n c File is modified" \
2028 "\n e Metadata changed" \
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02002029 "\n w Writable file is closed" \
2030 "\n 0 Unwritable file is closed" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002031 "\n r File is opened" \
Denis Vlasenkoa09a42c2008-11-17 22:19:18 +00002032 "\n D File is deleted" \
2033 "\n M File is moved" \
2034 "\n u Backing fs is unmounted" \
2035 "\n o Event queue overflowed" \
2036 "\n x File can't be watched anymore" \
2037 "\nIf watching a directory:" \
2038 "\n m Subfile is moved into dir" \
2039 "\n y Subfile is moved out of dir" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002040 "\n n Subfile is created" \
2041 "\n d Subfile is deleted" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002042 "\n" \
2043 "\ninotifyd waits for PROG to exit." \
2044 "\nWhen x event happens for all FILEs, inotifyd exits" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002045
Denis Vlasenko36309cf2008-11-22 18:29:01 +00002046/* 2.6 style insmod has no options and required filename
2047 * (not module name - .ko can't be omitted) */
Eric Andersen7e9276b2001-02-22 01:15:47 +00002048#define insmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002049 IF_FEATURE_2_4_MODULES("[OPTIONS] MODULE ") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002050 IF_NOT_FEATURE_2_4_MODULES("FILE ") \
Denis Vlasenko36309cf2008-11-22 18:29:01 +00002051 "[symbol=value]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002052#define insmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002053 "Load the specified kernel modules into the kernel" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002054 IF_FEATURE_2_4_MODULES( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002055 "\nOptions:" \
2056 "\n -f Force module to load into the wrong kernel version" \
2057 "\n -k Make module autoclean-able" \
2058 "\n -v Verbose" \
2059 "\n -q Quiet" \
2060 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002061 IF_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002062 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00002063 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002064 "\n -o NAME Set internal module name to NAME" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002065 "\n -x Don't export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00002066 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00002067
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002068/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00002069#define install_trivial_usage \
Denis Vlasenko4acdb462009-01-31 21:45:57 +00002070 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [source] dest|directory"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002071#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002072 "Copy files and set attributes\n" \
2073 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002074 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002075 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002076 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002077 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002078 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002079 "\n -o USER Set ownership" \
2080 "\n -g GRP Set group ownership" \
2081 "\n -m MODE Set permissions" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002082 IF_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002083 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002084 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002085
Denis Vlasenko4acdb462009-01-31 21:45:57 +00002086#define ionice_trivial_usage \
2087 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
2088#define ionice_full_usage "\n\n" \
2089 "Change I/O scheduling class and priority\n" \
2090 "\nOptions:" \
2091 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
2092 "\n -n Priority" \
2093
Denis Vlasenko397de612008-03-17 08:55:44 +00002094/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002095#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00002096 "[OPTIONS] {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002097 IF_FEATURE_IP_ADDRESS("address | ") \
2098 IF_FEATURE_IP_ROUTE("route | ") \
2099 IF_FEATURE_IP_LINK("link | ") \
2100 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2101 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002102 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002103#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002104 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002105 "where OBJECT := {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002106 IF_FEATURE_IP_ADDRESS("address | ") \
2107 IF_FEATURE_IP_ROUTE("route | ") \
2108 IF_FEATURE_IP_LINK("link | ") \
2109 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2110 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002111 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002112 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002113
2114#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002115 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002116 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002117#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002118 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002119 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
2120 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002121 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002122 " [broadcast ADDR] [anycast ADDR]\n" \
2123 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002124 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002125
Eric Andersende4f07e2003-12-11 01:18:07 +00002126#define ipcalc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002127 "[OPTIONS] ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002128#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002129 "Calculate IP network settings from a IP address\n" \
2130 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002131 IF_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002132 "\n -b,--broadcast Display calculated broadcast address" \
2133 "\n -n,--network Display calculated network address" \
2134 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002135 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002136 "\n -p,--prefix Display the prefix for IP/NETMASK" \
2137 "\n -h,--hostname Display first resolved host name" \
2138 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002139 ) \
2140 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002141 IF_NOT_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002142 "\n -b Display calculated broadcast address" \
2143 "\n -n Display calculated network address" \
2144 "\n -m Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002145 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002146 "\n -p Display the prefix for IP/NETMASK" \
2147 "\n -h Display first resolved host name" \
2148 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002149 ) \
2150 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00002151
Rob Landley6eb1e412005-06-20 04:30:36 +00002152#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002153 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002154#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002155 "Upper-case options MQS remove an object by shmkey value.\n" \
2156 "Lower-case options remove an object by shmid value.\n" \
2157 "\nOptions:" \
2158 "\n -mM Remove memory segment after last detach" \
2159 "\n -qQ Remove message queue" \
2160 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002161
2162#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002163 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002164#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002165 " -i Show specific resource" \
2166 "\nResource specification:" \
2167 "\n -m Shared memory segments" \
2168 "\n -q Message queues" \
2169 "\n -s Semaphore arrays" \
2170 "\n -a All (default)" \
2171 "\nOutput format:" \
2172 "\n -t Time" \
2173 "\n -c Creator" \
2174 "\n -p Pid" \
2175 "\n -l Limits" \
2176 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002177
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002178#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002179 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002180#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00002181 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002182 " dynamic { on | off } |\n" \
2183 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002184 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002185
2186#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002187 "{ list | flush | { add | del | change | append |\n" \
2188 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002189#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002190 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002191 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
2192 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002193 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002194 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00002195 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
2196 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002197
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002198#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002199 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002200#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002201 "iprule [list | add | del] SELECTOR ACTION\n" \
2202 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2203 " [dev STRING] [pref NUMBER]\n" \
2204 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2205 " [prohibit | reject | unreachable]\n" \
2206 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002207 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002208
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002209#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002210 "{ add | change | del | show } [NAME]\n" \
2211 " [mode { ipip | gre | sit }]\n" \
2212 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002213#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002214 "iptunnel { add | change | del | show } [NAME]\n" \
2215 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2216 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002217 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002218
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002219#define kbd_mode_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002220 "[-a|k|s|u] [-C TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002221#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002222 "Report or set the keyboard mode\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002223 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002224 "\n -a Default (ASCII)" \
2225 "\n -k Medium-raw (keyboard)" \
2226 "\n -s Raw (scancode)" \
2227 "\n -u Unicode (utf-8)" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002228 "\n -C TTY Affect TTY instead of /dev/tty" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002229
Eric Andersen7e9276b2001-02-22 01:15:47 +00002230#define kill_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002231 "[-l] [-SIG] PID..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002232#define kill_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002233 "Send a signal (default: TERM) to given PIDs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002234 "\nOptions:" \
2235 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002236/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002237
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002238#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002239 "$ ps | grep apache\n" \
2240 "252 root root S [apache]\n" \
2241 "263 www-data www-data S [apache]\n" \
2242 "264 www-data www-data S [apache]\n" \
2243 "265 www-data www-data S [apache]\n" \
2244 "266 www-data www-data S [apache]\n" \
2245 "267 www-data www-data S [apache]\n" \
2246 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002247
2248#define killall_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002249 "[-l] [-q] [-SIG] process-name..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002250#define killall_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002251 "Send a signal (default: TERM) to given processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002252 "\nOptions:" \
2253 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002254/* "\n -s SIG Yet another way of specifying SIG" */ \
Denys Vlasenko07697852009-10-06 21:11:37 +02002255 "\n -q Don't complain if no processes were killed" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002256
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002257#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002258 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002259
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002260#define killall5_trivial_usage \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002261 "[-l] [-SIG] [-o PID]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002262#define killall5_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002263 "Send a signal (default: TERM) to all processes outside current session\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002264 "\nOptions:" \
2265 "\n -l List all signal names and numbers" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002266 "\n -o PID Don't signal this PID" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002267/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002268
Mark Whitley6317c4b2001-03-12 22:51:50 +00002269#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002270 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002271#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002272 "Kernel logger\n" \
2273 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002274 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002275 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002276
Eric Andersen7e9276b2001-02-22 01:15:47 +00002277#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002278 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002279#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002280 "Print STRING's length"
2281
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002282#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002283 "$ length Hello\n" \
2284 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002285
Rob Landley9200e792005-09-15 19:26:59 +00002286#define less_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002287 "[-EMNmh~I?] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002288#define less_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002289 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002290 "changed, and files can be manipulated in various ways.\n" \
2291 "\nOptions:" \
2292 "\n -E Quit once the end of a file is reached" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002293 "\n -M,-m Display status line with line numbers" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002294 "\n and percentage through the file" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002295 "\n -N Prefix line number to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002296 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002297 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002298
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002299#define linux32_trivial_usage NOUSAGE_STR
2300#define linux32_full_usage ""
2301#define linux64_trivial_usage NOUSAGE_STR
2302#define linux64_full_usage ""
2303
2304#define linuxrc_trivial_usage NOUSAGE_STR
2305#define linuxrc_full_usage ""
2306
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002307#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002308 "personality program [args...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002309#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002310 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002311 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002312 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002313
Eric Andersen7e9276b2001-02-22 01:15:47 +00002314#define ln_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002315 "[OPTIONS] TARGET... LINK|DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002316#define ln_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002317 "Create a link LINK or DIR/TARGET to the specified TARGET(s)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002318 "\nOptions:" \
2319 "\n -s Make symlinks instead of hardlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002320 "\n -f Remove existing destinations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002321 "\n -n Don't dereference symlinks - treat like normal file" \
2322 "\n -b Make a backup of the target (if exists) before link operation" \
2323 "\n -S suf Use suffix instead of ~ when making backup files" \
2324
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002325#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002326 "$ ln -s BusyBox /tmp/ls\n" \
2327 "$ ls -l /tmp/ls\n" \
2328 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002329
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002330#define load_policy_trivial_usage NOUSAGE_STR
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002331#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002332
Eric Andersen7e9276b2001-02-22 01:15:47 +00002333#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002334 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002335#define loadfont_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002336 "Load a console font from standard input" \
2337/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2338
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002339#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002340 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002341
2342#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002343 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002344#define loadkmap_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002345 "Load a binary keyboard translation table from standard input\n" \
2346/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2347
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002348#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002349 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002350
2351#define logger_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002352 "[OPTIONS] [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002353#define logger_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002354 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n" \
2355 "\nOptions:" \
2356 "\n -s Log to stderr as well as the system log" \
2357 "\n -t TAG Log using the specified tag (defaults to user name)" \
2358 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002359
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002360#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002361 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002362
Robert Griebl1fca5582002-06-04 20:45:46 +00002363#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002364 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002365#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002366 "Begin a new session on the system\n" \
2367 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002368 "\n -f Don't authenticate (user already authenticated)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002369 "\n -h Name of the remote host" \
2370 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002371
Eric Andersen7e9276b2001-02-22 01:15:47 +00002372#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002373 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002374#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002375 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002376#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002377 "$ logname\n" \
2378 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002379
Mark Whitley6317c4b2001-03-12 22:51:50 +00002380#define logread_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002381 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002382#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002383 "Show messages in syslogd's circular buffer\n" \
2384 "\nOptions:" \
2385 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002386
Matt Kraai83788da2002-03-20 17:38:37 +00002387#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002388 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2389 " losetup -d LOOPDEV - disassociate\n" \
2390 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002391#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002392 "Options:" \
2393 "\n -o OFS Start OFS bytes into FILE" \
2394 "\n -f Show first free loop device" \
2395
Rob Landley1d589b22005-11-29 23:47:10 +00002396#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002397 "No arguments will display all current associations.\n" \
2398 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002399 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002400 "and filename of the file the loop device is currently bound to.\n\n" \
2401 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002402 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2403 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002404
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002405#define lpd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002406 "SPOOLDIR [HELPER [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002407#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002408 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2409 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002410 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002411 "\ndirectory and HELPER program is called. Name of file to print" \
2412 "\nis passed in $DATAFILE variable." \
2413 "\nExample:" \
2414 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002415
Denis Vlasenko68444b92008-02-22 22:24:48 +00002416#define lpq_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002417 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID...] [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002418#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002419 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002420 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002421 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002422 "\n -f Force any waiting job to be printed" \
2423 "\n -s Short display" \
2424
2425#define lpr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002426 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE]..."
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002427/* -C CLASS exists too, not shown.
2428 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002429#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002430 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002431 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002432 "\n -m Send mail on completion" \
2433 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002434 "\n -V Verbose" \
2435
Eric Andersen7e9276b2001-02-22 01:15:47 +00002436#define ls_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002437 "[-1Aa" IF_FEATURE_LS_TIMESTAMPS("c") "Cd" \
2438 IF_FEATURE_LS_TIMESTAMPS("e") IF_FEATURE_LS_FILETYPES("F") "iln" \
2439 IF_FEATURE_LS_FILETYPES("p") IF_FEATURE_LS_FOLLOWLINKS("L") \
2440 IF_FEATURE_LS_RECURSIVE("R") IF_FEATURE_LS_SORTFILES("rS") "s" \
2441 IF_FEATURE_AUTOWIDTH("T") IF_FEATURE_LS_TIMESTAMPS("tu") \
2442 IF_FEATURE_LS_SORTFILES("v") IF_FEATURE_AUTOWIDTH("w") "x" \
2443 IF_FEATURE_LS_SORTFILES("X") IF_FEATURE_HUMAN_READABLE("h") "k" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002444 IF_SELINUX("K") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002445#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002446 "List directory contents\n" \
2447 "\nOptions:" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002448 "\n -1 List in a single column" \
2449 "\n -A Don't list . and .." \
2450 "\n -a Don't hide entries starting with ." \
2451 "\n -C List by columns" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002452 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002453 "\n -c With -l: sort by ctime") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002454 IF_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002455 "\n --color[={always,never,auto}] Control coloring") \
2456 "\n -d List directory entries instead of contents" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002457 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002458 "\n -e List full date and time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002459 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002460 "\n -F Append indicator (one of */=@|) to entries") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002461 "\n -i List inode numbers" \
2462 "\n -l Long listing format" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002463 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002464 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002465 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002466 IF_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002467 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002468 IF_FEATURE_LS_RECURSIVE( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002469 "\n -R Recurse") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002470 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002471 "\n -r Sort in reverse order") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002472 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002473 "\n -S Sort by file size") \
Denis Vlasenko397de612008-03-17 08:55:44 +00002474 "\n -s List the size of each file, in blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002475 IF_FEATURE_AUTOWIDTH( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002476 "\n -T N Assume tabstop every N columns") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002477 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002478 "\n -t With -l: sort by modification time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002479 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002480 "\n -u With -l: sort by access time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002481 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002482 "\n -v Sort by version") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002483 IF_FEATURE_AUTOWIDTH( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002484 "\n -w N Assume the terminal is N columns wide") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002485 "\n -x List by lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002486 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002487 "\n -X Sort by extension") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002488 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002489 "\n -h List sizes in human readable format (1K 243M 2G)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002490 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002491 "\n -k List security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002492 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002493 "\n -K List security context in long format") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002494 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002495 "\n -Z List security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002496
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002497#define lsattr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002498 "[-Radlv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002499#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002500 "List file attributes on an ext2 fs\n" \
2501 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002502 "\n -R Recurse" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002503 "\n -a Don't hide entries starting with ." \
Denis Vlasenko397de612008-03-17 08:55:44 +00002504 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002505 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002506 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002507
Eric Andersen7e9276b2001-02-22 01:15:47 +00002508#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002509 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002510#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002511 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002512
Souf Oued982bc712009-12-05 17:56:25 +01002513#define lspci_trivial_usage \
2514 "[-mk]"
2515#define lspci_full_usage "\n\n" \
2516 "List all PCI devices" \
2517 "\n" \
2518 "\n -m Parseable output" \
2519 "\n -k Show driver" \
2520
Souf Oued11a802a2009-12-07 01:37:34 +01002521#define lsusb_trivial_usage NOUSAGE_STR
2522#define lsusb_full_usage ""
2523
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002524#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002525#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002526 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002527#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002528 "Create a range of block or character special files" \
2529 "\n" \
2530 "\nTYPE is:" \
2531 "\n b Block device" \
2532 "\n c Character device" \
2533 "\n f FIFO, MAJOR and MINOR are ignored" \
2534 "\n" \
2535 "\nFIRST..LAST specify numbers appended to NAME." \
2536 "\nIf 's' is the last argument, the base device is created as well." \
2537 "\n" \
2538 "\nExamples:" \
2539 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2540 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002541#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002542 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2543 "[creates ttyS2-ttyS63]\n" \
2544 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2545 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002546#endif
2547
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002548#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002549#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002550 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002551#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002552 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002553 "Device table entries take the form of:\n" \
2554 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002555 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002556 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002557 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002558 " c Character device\n" \
2559 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002560 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002561 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002562 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2563 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002564#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002565 "For example:\n" \
2566 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2567 "/dev d 755 0 0 - - - - -\n" \
2568 "/dev/console c 666 0 0 5 1 - - -\n" \
2569 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2570 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2571 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2572 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2573 "Will Produce:\n" \
2574 "/dev\n" \
2575 "/dev/console\n" \
2576 "/dev/null\n" \
2577 "/dev/zero\n" \
2578 "/dev/hda\n" \
2579 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002580#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002581
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002582#define makemime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002583 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002584#define makemime_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002585 "Create multipart MIME-encoded message from FILEs\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002586/* "Transfer encoding is base64, disposition is inline (not attachment)\n" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002587 "\nOptions:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002588 "\n -o FILE Output. Default: stdout" \
2589 "\n -a HDR Add header. Examples:" \
2590 "\n \"From: user@host.org\", \"Date: `date -R`\"" \
2591 "\n -c CT Content type. Default: text/plain" \
2592 "\n -C CS Charset. Default: " CONFIG_FEATURE_MIME_CHARSET \
2593/* "\n -e ENC Transfer encoding. Ignored. base64 is assumed" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002594 "\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002595 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002596
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002597#define man_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002598 "[OPTIONS] [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002599#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002600 "Format and display manual page\n" \
2601 "\nOptions:" \
2602 "\n -a Display all pages" \
2603 "\n -w Show page locations" \
2604
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002605#define matchpathcon_trivial_usage \
2606 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002607#define matchpathcon_full_usage "\n\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002608 " -n Don't display path" \
2609 "\n -N Don't use translations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002610 "\n -f Use alternate file_context file" \
2611 "\n -p Use prefix to speed translations" \
2612 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002613
Eric Andersen7e9276b2001-02-22 01:15:47 +00002614#define md5sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002615 "[OPTIONS] [FILE]..." \
2616 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTIONS] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002617#define md5sum_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002618 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2619 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002620 "\nOptions:" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002621 "\n -c Check sums against given list" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002622 "\n -s Don't output anything, status code shows success" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002623 "\n -w Warn about improperly formatted checksum lines" \
2624 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002625
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002626#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002627 "$ md5sum < busybox\n" \
2628 "6fd11e98b98a58f64ff3398d7b324003\n" \
2629 "$ md5sum busybox\n" \
2630 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2631 "$ md5sum -c -\n" \
2632 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2633 "busybox: OK\n" \
2634 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002635
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002636#define sha1sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002637 "[OPTIONS] [FILE]..." \
2638 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002639#define sha1sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002640 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002641 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002642 "\nOptions:" \
2643 "\n -c Check sums against given list" \
2644 "\n -s Don't output anything, status code shows success" \
2645 "\n -w Warn about improperly formatted checksum lines" \
2646 )
2647
2648#define sha256sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002649 "[OPTIONS] [FILE]..." \
2650 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha256sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002651#define sha256sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002652 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA256 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002653 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002654 "\nOptions:" \
2655 "\n -c Check sums against given list" \
2656 "\n -s Don't output anything, status code shows success" \
2657 "\n -w Warn about improperly formatted checksum lines" \
2658 )
2659
2660#define sha512sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002661 "[OPTIONS] [FILE]..." \
2662 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha512sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002663#define sha512sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002664 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA512 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002665 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002666 "\nOptions:" \
2667 "\n -c Check sums against given list" \
2668 "\n -s Don't output anything, status code shows success" \
2669 "\n -w Warn about improperly formatted checksum lines" \
2670 )
2671
Rob Landley70f7ef72005-12-13 08:21:33 +00002672#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002673 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002674#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002675 " -s Scan /sys and populate /dev during system boot\n" \
2676 "\n" \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002677 "It can be run by kernel as a hotplug helper. To activate it:\n" \
Denys Vlasenkof92874e2009-12-05 15:59:05 +01002678 " echo /sbin/mdev > /proc/sys/kernel/hotplug\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002679 IF_FEATURE_MDEV_CONF( \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002680 "It uses /etc/mdev.conf with lines\n" \
Denis Vlasenkof2b39e02009-04-13 23:18:52 +00002681 "[-]DEVNAME UID:GID PERM" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002682 IF_FEATURE_MDEV_RENAME(" [>|=PATH]") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002683 IF_FEATURE_MDEV_EXEC(" [@|$|*PROG]") \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002684 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002685
Rob Landleyef10d522006-06-26 14:11:33 +00002686#define mdev_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002687 IF_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002688 "The mdev config file contains lines that look like:\n" \
2689 " hd[a-z][0-9]* 0:3 660\n\n" \
2690 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002691 IF_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002692 "Optionally, that can be followed (on the same line) by a special character\n" \
2693 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002694 "device(s). The environment variable $MDEV indicates the active device node\n" \
2695 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002696 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2697 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002698 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002699 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002700 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002701 "Config file parsing stops on the first matching line. If no config\n" \
2702 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002703 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002704 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002705
Glenn L McGrath061c9002002-09-16 04:21:46 +00002706#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002707 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002708#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002709 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002710 " y Allow write access to your terminal\n" \
2711 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002712
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002713#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002714 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002715#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002716 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2717 "\nOptions:" \
2718 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2719 "\n next byte to it" \
2720 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2721 "\n -s Set serial line to SPEED" \
2722 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002723
Eric Andersen7e9276b2001-02-22 01:15:47 +00002724#define mkdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002725 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002726#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002727 "Create DIRECTORY\n" \
2728 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002729 "\n -m Mode" \
2730 "\n -p No error if exists; make parent directories as needed" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002731 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002732 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002733 )
2734
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002735#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002736 "$ mkdir /tmp/foo\n" \
2737 "$ mkdir /tmp/foo\n" \
2738 "/tmp/foo: File exists\n" \
2739 "$ mkdir /tmp/foo/bar/baz\n" \
2740 "/tmp/foo/bar/baz: No such file or directory\n" \
2741 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002742
Eric Andersen7e9276b2001-02-22 01:15:47 +00002743#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002744 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002745#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002746 "Create named pipe (identical to 'mknod name p')\n" \
2747 "\nOptions:" \
2748 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002749 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002750 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002751 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002752
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002753#define mkfs_ext2_trivial_usage \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002754 "[-Fn] " \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002755 /* "[-c|-l filename] " */ \
2756 "[-b BLK_SIZE] " \
2757 /* "[-f fragment-size] [-g blocks-per-group] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002758 "[-i INODE_RATIO] [-I INODE_SIZE] " \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002759 /* "[-j] [-J journal-options] [-N number-of-inodes] " */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002760 "[-m RESERVED_PERCENT] " \
2761 /* "[-o creator-os] [-O feature[,...]] [-q] " */ \
2762 /* "[r fs-revision-level] [-E extended-options] [-v] [-F] " */ \
2763 "[-L LABEL] " \
2764 /* "[-M last-mounted-directory] [-S] [-T filesystem-type] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002765 "BLOCKDEV [KBYTES]"
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002766#define mkfs_ext2_full_usage "\n" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002767 "\n -b BLK_SIZE Block size, bytes" \
2768/* "\n -c Check device for bad blocks" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002769/* "\n -E opts Set extended options" */ \
2770/* "\n -f size Fragment size in bytes" */ \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002771 "\n -F Force" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002772/* "\n -g N Number of blocks in a block group" */ \
Denys Vlasenko838e07a2009-10-22 12:15:33 +02002773 "\n -i RATIO Max number of files is filesystem_size / RATIO" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002774 "\n -I BYTES Inode size (min 128)" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002775/* "\n -j Create a journal (ext3)" */ \
2776/* "\n -J opts Set journal options (size/device)" */ \
2777/* "\n -l file Read bad blocks list from file" */ \
Denys Vlasenko6a8cfdc2009-10-17 23:41:15 +02002778 "\n -L LBL Volume label" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002779 "\n -m PERCENT Percent of blocks to reserve for admin" \
2780/* "\n -M dir Set last mounted directory" */ \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002781 "\n -n Dry run" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002782/* "\n -N N Number of inodes to create" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002783/* "\n -o os Set the 'creator os' field" */ \
2784/* "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" */ \
2785/* "\n -q Quiet" */ \
2786/* "\n -r rev Set filesystem revision" */ \
2787/* "\n -S Write superblock and group descriptors only" */ \
2788/* "\n -T fs-type Set usage type (news/largefile/largefile4)" */ \
2789/* "\n -v Verbose" */ \
2790
Eric Andersen7e9276b2001-02-22 01:15:47 +00002791#define mkfs_minix_trivial_usage \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002792 "[-c | -l filename] [-nXX] [-iXX] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002793#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002794 "Make a MINIX filesystem\n" \
2795 "\nOptions:" \
2796 "\n -c Check device for bad blocks" \
2797 "\n -n [14|30] Maximum length of filenames" \
2798 "\n -i INODES Number of inodes for the filesystem" \
2799 "\n -l FILENAME Read bad blocks list from FILENAME" \
2800 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002801
Vladimir Dronnikov0d8ea642009-11-02 10:41:46 +01002802#define mkfs_reiser_trivial_usage \
2803 "[-f] [-l LABEL] BLOCKDEV [4K-BLOCKS]"
2804
2805#define mkfs_reiser_full_usage "\n\n" \
2806 "Make a ReiserFS V3 filesystem\n" \
2807 "\nOptions:" \
2808 "\n -f Force" \
2809 "\n -l LBL Volume label" \
2810
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002811#define mkfs_vfat_trivial_usage \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002812 "[-v] [-n LABEL] BLOCKDEV [KBYTES]"
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002813/* Accepted but ignored:
2814 "[-c] [-C] [-I] [-l bad-block-file] [-b backup-boot-sector] "
2815 "[-m boot-msg-file] [-i volume-id] "
2816 "[-s sectors-per-cluster] [-S logical-sector-size] [-f number-of-FATs] "
2817 "[-h hidden-sectors] [-F fat-size] [-r root-dir-entries] [-R reserved-sectors] "
2818*/
2819#define mkfs_vfat_full_usage "\n\n" \
2820 "Make a FAT32 filesystem\n" \
2821 "\nOptions:" \
2822/* "\n -c Check device for bad blocks" */ \
2823 "\n -v Verbose" \
2824/* "\n -I Allow to use entire disk device (e.g. /dev/hda)" */ \
2825 "\n -n LBL Volume label" \
2826
Eric Andersen7e9276b2001-02-22 01:15:47 +00002827#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002828 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002829#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002830 "Create a special file (block, character, or pipe)\n" \
2831 "\nOptions:" \
2832 "\n -m Create the special file using the specified mode (default a=rw)" \
2833 "\nTYPEs include:" \
2834 "\n b: Make a block device" \
2835 "\n c or u: Make a character device" \
2836 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002837 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002838 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002839 )
2840
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002841#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002842 "$ mknod /dev/fd0 b 2 0\n" \
2843 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002844
Eric Andersen7e9276b2001-02-22 01:15:47 +00002845#define mkswap_trivial_usage \
Denys Vlasenko68c67462009-11-03 05:51:20 +01002846 "[OPTIONS] BLOCKDEV" /* [SIZE_IN_KB] */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002847#define mkswap_full_usage "\n\n" \
Denys Vlasenko68c67462009-11-03 05:51:20 +01002848 "Prepare BLOCKDEV to be used as swap partition\n" \
2849 "\nOptions:" \
2850 "\n -L LBL Label" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002851
Eric Andersen7e9276b2001-02-22 01:15:47 +00002852#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002853 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002854#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002855 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002856 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002857 "\nOptions:" \
2858 "\n -d Make a directory instead of a file" \
2859/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2860 "\n -t Generate a path rooted in temporary directory" \
2861 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2862 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002863 "\nFor -t or -p, directory is chosen as follows:" \
2864 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002865
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002866#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002867 "$ mktemp /tmp/temp.XXXXXX\n" \
2868 "/tmp/temp.mWiLjM\n" \
2869 "$ ls -la /tmp/temp.mWiLjM\n" \
2870 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002871
Eric Andersen8d79ce82001-07-22 23:00:15 +00002872#define modprobe_trivial_usage \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002873 IF_MODPROBE_SMALL("[-qfwrsv] MODULE [symbol=value...]") \
2874 IF_NOT_MODPROBE_SMALL("[-" \
2875 IF_FEATURE_2_4_MODULES("k")"nqrsv" \
2876 IF_FEATURE_MODPROBE_BLACKLIST("b")"] MODULE [symbol=value...]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002877#define modprobe_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002878 "Options:" \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002879 IF_MODPROBE_SMALL( \
2880 "\n -q Quiet" \
2881 "\n -f Force" \
2882 "\n -w Wait for unload" \
2883 "\n -r Remove module (stacks) or do autoclean" \
2884 "\n -s Report via syslog instead of stderr" \
2885 "\n -v Verbose" \
2886 ) \
2887 IF_NOT_MODPROBE_SMALL( \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002888 IF_FEATURE_2_4_MODULES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002889 "\n -k Make module autoclean-able" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002890 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002891 "\n -n Dry run" \
2892 "\n -q Quiet" \
2893 "\n -r Remove module (stacks) or do autoclean" \
2894 "\n -s Report via syslog instead of stderr" \
2895 "\n -v Verbose" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002896 IF_FEATURE_MODPROBE_BLACKLIST( \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002897 "\n -b Apply blacklist to module names too" \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002898 ) \
2899 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002900
Rob Landley9c32a152005-12-11 20:12:24 +00002901#define modprobe_notes_usage \
2902"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2903"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2904"pass each module it loads.\n" \
2905"\n" \
Bernhard Reutner-Fischer12aca792009-02-24 10:03:22 +00002906"The configuration file is searched (in this order):\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002907"\n" \
2908" /etc/modprobe.conf (2.6 only)\n" \
2909" /etc/modules.conf\n" \
2910" /etc/conf.modules (deprecated)\n" \
2911"\n" \
2912"They all have the same syntax (see below). If none is present, it is\n" \
2913"_not_ an error; each loaded module is then expected to load without\n" \
2914"options. Once a file is found, the others are tested for.\n" \
2915"\n" \
2916"/etc/modules.conf entry format:\n" \
2917"\n" \
2918" alias <alias_name> <mod_name>\n" \
2919" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002920" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002921" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2922" This makes it also possible to use a different set of options (below) for\n" \
2923" the module and the alias.\n" \
2924" A module can be aliased more than once.\n" \
2925"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002926" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002927" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2928" the \"symbol=value\" pairs as option to that module.\n" \
2929"\n" \
2930"Sample /etc/modules.conf file:\n" \
2931"\n" \
2932" options tulip irq=3\n" \
2933" alias tulip tulip2\n" \
2934" options tulip2 irq=4 io=0x308\n" \
2935"\n" \
2936"Other functionality offered by 'classic' modprobe is not available in\n" \
2937"this implementation.\n" \
2938"\n" \
2939"If module options are present both in the config file, and on the command line,\n" \
2940"then the options from the command line will be passed to the module _after_\n" \
2941"the options from the config file. That way, you can have defaults in the config\n" \
2942"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002943#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002944 "(with the above /etc/modules.conf):\n\n" \
2945 "$ modprobe tulip\n" \
2946 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2947 "$ modprobe tulip irq=5\n" \
2948 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2949 "$ modprobe tulip2\n" \
2950 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2951 " which are the default for alias 'tulip2'\n\n" \
2952 "$ modprobe tulip2 irq=8\n" \
2953 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2954 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2955 " from the command line\n\n" \
2956 "$ modprobe tulip2 irq=2 io=0x210\n" \
2957 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2958 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2959 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002960
Eric Andersen7e9276b2001-02-22 01:15:47 +00002961#define more_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002962 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002963#define more_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002964 "View FILE or standard input one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002965
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002966#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002967 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002968
Eric Andersen7e9276b2001-02-22 01:15:47 +00002969#define mount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002970 "[OPTIONS] [-o OPTS] DEVICE NODE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002971#define mount_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002972 "Mount a filesystem. Filesystem autodetection requires /proc.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002973 "\nOptions:" \
2974 "\n -a Mount all filesystems in fstab" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002975 IF_FEATURE_MOUNT_FAKE( \
2976 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002977 "\n -f Update /etc/mtab, but don't mount" \
2978 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002979 IF_NOT_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002980 "\n -f Dry run" \
2981 ) \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002982 ) \
Denys Vlasenkoe2e4cc22009-06-19 11:48:29 +02002983 IF_FEATURE_MOUNT_HELPERS( \
2984 "\n -i Don't run mount helper" \
2985 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002986 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002987 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002988 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002989 "\n -r Read-only mount" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002990 "\n -w Read-write mount (default)" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002991 "\n -t FSTYPE Filesystem type" \
2992 "\n -O OPT Mount only filesystems with option OPT (-a only)" \
2993 "\n-o OPT:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002994 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002995 "\n loop Ignored (loop devices are autodetected)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002996 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002997 IF_FEATURE_MOUNT_FLAGS( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002998 "\n [a]sync Writes are [a]synchronous" \
2999 "\n [no]atime Disable/enable updates to inode access times" \
3000 "\n [no]diratime Disable/enable atime updates to directories" \
3001 "\n [no]relatime Disable/enable atime updates relative to modification time" \
3002 "\n [no]dev (Dis)allow use of special device files" \
3003 "\n [no]exec (Dis)allow use of executable files" \
3004 "\n [no]suid (Dis)allow set-user-id-root programs" \
3005 "\n [r]shared Convert [recursively] to a shared subtree" \
3006 "\n [r]slave Convert [recursively] to a slave subtree" \
3007 "\n [r]private Convert [recursively] to a private subtree" \
3008 "\n [un]bindable Make mount point [un]able to be bind mounted" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003009 "\n bind Bind a file or directory to another location" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003010 "\n move Relocate an existing mount point" \
Rob Landleye55a73c2006-08-09 20:55:35 +00003011 ) \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003012 "\n remount Remount a mounted filesystem, changing flags" \
3013 "\n ro/rw Same as -r/-w" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003014 "\n" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003015 "\nThere are filesystem-specific -o flags." \
Denis Vlasenko397de612008-03-17 08:55:44 +00003016
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003017#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003018 "$ mount\n" \
3019 "/dev/hda3 on / type minix (rw)\n" \
3020 "proc on /proc type proc (rw)\n" \
3021 "devpts on /dev/pts type devpts (rw)\n" \
3022 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
3023 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
3024 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00003025#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003026 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003027
Rob Landleyd00b3a52005-08-20 05:07:08 +00003028#define mountpoint_trivial_usage \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003029 "[-q] <[-dn] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003030#define mountpoint_full_usage "\n\n" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003031 "Check if the directory is a mountpoint\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003032 "\nOptions:" \
3033 "\n -q Quiet" \
3034 "\n -d Print major/minor device number of the filesystem" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003035 "\n -n Print device name of the filesystem" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003036 "\n -x Print major/minor device number of the blockdevice" \
3037
Rob Landleyd00b3a52005-08-20 05:07:08 +00003038#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003039 "$ mountpoint /proc\n" \
3040 "/proc is not a mountpoint\n" \
3041 "$ mountpoint /sys\n" \
3042 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00003043
Eric Andersen7e9276b2001-02-22 01:15:47 +00003044#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003045 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003046#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003047 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003048 "\n" \
3049 "Available Opcodes:\n" \
3050 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003051 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
3052 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
3053 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003054 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003055
Eric Andersen7e9276b2001-02-22 01:15:47 +00003056#define mv_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003057 "[OPTIONS] SOURCE DEST\n" \
3058 "or: mv [OPTIONS] SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003059#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003060 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
3061 "\nOptions:" \
3062 "\n -f Don't prompt before overwriting" \
3063 "\n -i Interactive, prompt before overwrite" \
3064
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003065#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003066 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003067
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003068#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003069 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003070#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003071 "Rename network interface while it in the down state\n" \
3072 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003073 "\n -c FILE Use configuration file (default: /etc/mactab)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003074 "\n -s Use syslog (LOCAL0 facility)" \
3075 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
3076
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003077#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003078 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
3079 " or\n" \
3080 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003081
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003082#if !ENABLE_DESKTOP
3083
Rob Landley1cca9482006-07-10 19:45:20 +00003084#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003085#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003086#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003087#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003088#endif
Rob Landley1cca9482006-07-10 19:45:20 +00003089
Eric Andersen7e9276b2001-02-22 01:15:47 +00003090#define nc_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003091 IF_NC_EXTRA("[-iN] [-wN] ")IF_NC_SERVER("[-l] [-p PORT] ") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003092 "["IF_NC_EXTRA("-f FILENAME|")"IPADDR PORT]"IF_NC_EXTRA(" [-e PROG]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003093#define nc_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003094 "Open a pipe to IP:port" IF_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003095 NC_OPTIONS_STR \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003096 IF_NC_EXTRA( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003097 "\n -e PROG Run PROG after connect" \
3098 "\n -i SEC Delay interval for lines sent" \
3099 "\n -w SEC Timeout for connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003100 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003101 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003102 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003103 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003104 IF_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003105 "\n (use -l twice with -e for persistent server)") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003106 "\n -p PORT Local port" \
Rob Landley1cca9482006-07-10 19:45:20 +00003107 )
3108
Rob Landley1cca9482006-07-10 19:45:20 +00003109#define nc_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003110 IF_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003111 "To use netcat as a terminal emulator on a serial port:\n\n" \
3112 "$ stty 115200 -F /dev/ttyS0\n" \
3113 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
3114 )
Rob Landley1cca9482006-07-10 19:45:20 +00003115
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003116#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003117 "$ nc foobar.somedomain.com 25\n" \
3118 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
3119 "help\n" \
3120 "214-Commands supported:\n" \
3121 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
3122 "214 NOOP QUIT RSET HELP\n" \
3123 "quit\n" \
3124 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003125
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003126#else /* DESKTOP nc - much more compatible with nc 1.10 */
3127
3128#define nc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003129 "[OPTIONS] HOST PORT - connect" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003130 IF_NC_SERVER("\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003131 "nc [OPTIONS] -l -p PORT [HOST] [PORT] - listen")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003132#define nc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003133 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003134 "\n -e PROG Run PROG after connect (must be last)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003135 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003136 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003137 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003138 "\n -n Don't do DNS resolution" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003139 "\n -s ADDR Local address" \
3140 "\n -p PORT Local port" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003141 "\n -u UDP mode" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003142 "\n -v Verbose" \
3143 "\n -w SEC Timeout for connects and final net reads" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003144 IF_NC_EXTRA( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003145 "\n -i SEC Delay interval for lines sent" /* ", ports scanned" */ \
3146 "\n -o FILE Hex dump traffic" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003147 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003148 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003149/* "\n -r Randomize local and remote ports" */
3150/* "\n -g gateway Source-routing hop point[s], up to 8" */
3151/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003152/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
3153
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003154/* -e PROG can take ARGS too: "nc ... -e ls -l", but we don't document it
3155 * in help text: nc 1.10 does not allow that. We don't want to entice
3156 * users to use this incompatibility */
3157
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003158#endif
3159
Eric Andersen1552ff72001-10-31 11:07:12 +00003160#define netstat_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003161 "[-laentuwxr"IF_FEATURE_NETSTAT_WIDE("W")IF_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003162#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003163 "Display networking information\n" \
3164 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003165 "\n -l Display listening server sockets" \
3166 "\n -a Display all sockets (default: connected)" \
3167 "\n -e Display other/more information" \
3168 "\n -n Don't resolve names" \
3169 "\n -t Tcp sockets" \
3170 "\n -u Udp sockets" \
3171 "\n -w Raw sockets" \
3172 "\n -x Unix sockets" \
3173 "\n -r Display routing table" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003174 IF_FEATURE_NETSTAT_WIDE( \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003175 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003176 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003177 IF_FEATURE_NETSTAT_PRG( \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003178 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003179 )
Eric Andersen1552ff72001-10-31 11:07:12 +00003180
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003181#define nice_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003182 "[-n ADJUST] [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003183#define nice_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003184 "Run PROG with modified scheduling priority\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003185 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003186 "\n -n ADJUST Adjust priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003187
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003188#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003189 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003190#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003191 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003192 "Format specifiers:\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003193 " %Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003194 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003195 " %[niface] Monitor network interface 'iface'\n" \
3196 " %m Monitor allocated memory\n" \
3197 " %[mf] Monitor free memory\n" \
3198 " %[mt] Monitor total memory\n" \
3199 " %s Monitor allocated swap\n" \
3200 " %f Monitor number of used file descriptors\n" \
3201 " %Ni Monitor total/specific IRQ rate\n" \
3202 " %x Monitor context switch rate\n" \
3203 " %p Monitor forks\n" \
3204 " %[pn] Monitor # of processes\n" \
3205 " %b Monitor block io\n" \
3206 " %Nt Show time (with N decimal points)\n" \
3207 " %Nd Milliseconds between updates (default:1000)\n" \
3208 " %r Print <cr> instead of <lf> at EOL" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003209
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003210#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003211 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003212
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003213#define nohup_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003214 "PROG [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003215#define nohup_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003216 "Run PROG immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003217#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003218 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003219
Eric Andersen7e9276b2001-02-22 01:15:47 +00003220#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003221 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003222#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003223 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003224 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003225#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003226 "$ nslookup localhost\n" \
3227 "Server: default\n" \
3228 "Address: default\n" \
3229 "\n" \
3230 "Name: debian\n" \
3231 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003232
Adam Tkacb1585062009-11-22 03:43:55 +01003233#define ntpd_trivial_usage \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01003234 "[-dnqwl] [-S PROG] [-p PEER]..."
Adam Tkacb1585062009-11-22 03:43:55 +01003235#define ntpd_full_usage "\n\n" \
3236 "NTP client/server\n" \
3237 "\nOptions:" \
3238 "\n -d Verbose" \
3239 "\n -n Do not daemonize" \
Denys Vlasenko8d580c72009-11-23 16:27:16 +01003240 "\n -q Quit after clock is set" \
Denys Vlasenko907647f2009-12-02 23:17:45 +01003241/* -N exists for mostly compat reasons, thus not essential to inform */ \
Denys Vlasenkob2e5fc32009-11-25 14:52:47 +01003242/* the user that it exists: user may use nice as well */ \
3243/* "\n -N Run at high priority" */ \
Denys Vlasenko074e8dc2010-01-04 23:58:13 +01003244 "\n -w Do not set time (only query peers), implies -n" \
Adam Tkacb1585062009-11-22 03:43:55 +01003245 "\n -l Run as server on port 123" \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01003246 "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins" \
Adam Tkacb1585062009-11-22 03:43:55 +01003247 "\n -p PEER Obtain time from PEER (may be repeated)" \
3248
Glenn L McGrath60281112001-11-02 11:39:46 +00003249#define od_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003250 "[-aBbcDdeFfHhIiLlOovXx] " IF_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003251#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003252 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003253 "(or standard input) to standard output."
Glenn L McGrath60281112001-11-02 11:39:46 +00003254
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003255#define openvt_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003256 "[-c N] [-sw] [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003257#define openvt_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003258 "Start PROG on a new virtual terminal\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003259 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003260 "\n -c N Use specified VT" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003261 "\n -s Switch to the VT" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003262/* "\n -l Run PROG as login shell (by prepending '-')" */ \
3263 "\n -w Wait for PROG to exit" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003264
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003265#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003266 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003267
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003268/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003269#define parse_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003270 "[-n MAXTOKENS] [-m MINTOKENS] [-d DELIMS] [-f FLAGS] FILE..."
3271#define parse_full_usage ""
3272*/
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003273
Eric Andersen27f64e12002-06-23 04:24:25 +00003274#define passwd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003275 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003276#define passwd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003277 "Change USER's password. If no USER is specified,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003278 "changes the password for the current user.\n" \
3279 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003280 "\n -a Algorithm to use for password (des, md5)" /* ", sha1)" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00003281 "\n -d Delete password for the account" \
3282 "\n -l Lock (disable) account" \
3283 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003284
Denis Vlasenko21d10142007-07-20 21:28:41 +00003285#define chpasswd_trivial_usage \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003286 IF_LONG_OPTS("[--md5|--encrypted]") IF_NOT_LONG_OPTS("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003287#define chpasswd_full_usage "\n\n" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003288 "Read user:password from stdin and update /etc/passwd\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003289 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003290 IF_LONG_OPTS( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003291 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003292 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003293 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003294 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003295 "\n -e Supplied passwords are in encrypted form" \
3296 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003297 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00003298
Glenn L McGrath655d8142003-06-22 15:32:41 +00003299#define patch_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003300 "[OPTIONS] [ORIGFILE [PATCHFILE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003301#define patch_full_usage "\n\n" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003302 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003303 " -p,--strip N Strip N leading components from file names" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003304 "\n -i,--input DIFF Read DIFF instead of stdin" \
3305 "\n -R,--reverse Reverse patch" \
3306 "\n -N,--forward Ignore already applied patches" \
3307 "\n --dry-run Don't actually change files" \
3308 ) \
3309 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003310 " -p N Strip N leading components from file names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003311 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003312 "\n -R Reverse patch" \
Denys Vlasenkod7874ed2009-08-20 23:33:19 +02003313 "\n -N Ignore already applied patches" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003314 )
Denis Vlasenko397de612008-03-17 08:55:44 +00003315
Glenn L McGrath655d8142003-06-22 15:32:41 +00003316#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003317 "$ patch -p1 < example.diff\n" \
3318 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00003319
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003320#define pgrep_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003321 "[-flnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003322#define pgrep_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003323 "Display process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003324 "\nOptions:" \
3325 "\n -l Show command name too" \
3326 "\n -f Match against entire command line" \
3327 "\n -n Show the newest process only" \
3328 "\n -o Show the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003329 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003330 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003331 "\n -s Match session ID (0 for current)" \
3332 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003333
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003334#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00003335#define pidof_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003336 "[OPTIONS] [NAME...]"
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003337#define USAGE_PIDOF "\n\nOptions:"
3338#else
3339#define pidof_trivial_usage \
3340 "[NAME...]"
3341#define USAGE_PIDOF /* none */
3342#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003343#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003344 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003345 USAGE_PIDOF \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003346 IF_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003347 "\n -s Show only one PID") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003348 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003349 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003350 "\n Use %PPID to omit pid of pidof's parent") \
3351
Eric Andersen221b2ea2001-07-31 19:06:07 +00003352#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003353 "$ pidof init\n" \
3354 "1\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003355 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003356 "$ pidof /bin/sh\n20351 5973 5950\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003357 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003358 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00003359
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003360#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003361#define ping_trivial_usage \
3362 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003363#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003364 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003365#define ping6_trivial_usage \
3366 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003367#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003368 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003369#else
3370#define ping_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003371 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003372#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003373 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3374 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003375 "\n -4, -6 Force IP or IPv6 name resolution" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003376 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003377 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3378 "\n -I IFACE/IP Use interface or IP address as source" \
3379 "\n -W SEC Seconds to wait for the first response (default:10)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003380 "\n (after all -c CNT packets are sent)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003381 "\n -w SEC Seconds until ping exits (default:infinite)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003382 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003383 "\n -q Quiet, only displays output at start" \
3384 "\n and when finished" \
3385
Eric Andersen51b8bd62002-07-03 11:46:38 +00003386#define ping6_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003387 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003388#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003389 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3390 "\nOptions:" \
3391 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003392 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3393 "\n -I IFACE/IP Use interface or IP address as source" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003394 "\n -q Quiet, only displays output at start" \
3395 "\n and when finished" \
3396
Eric Andersen51b8bd62002-07-03 11:46:38 +00003397#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003398#define ping_example_usage \
3399 "$ ping localhost\n" \
3400 "PING slag (127.0.0.1): 56 data bytes\n" \
3401 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3402 "\n" \
3403 "--- debian ping statistics ---\n" \
3404 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3405 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003406#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003407 "$ ping6 ip6-localhost\n" \
3408 "PING ip6-localhost (::1): 56 data bytes\n" \
3409 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3410 "\n" \
3411 "--- ip6-localhost ping statistics ---\n" \
3412 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3413 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003414
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003415#define pipe_progress_trivial_usage NOUSAGE_STR
3416#define pipe_progress_full_usage ""
3417
Eric Andersen7e9276b2001-02-22 01:15:47 +00003418#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003419 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003420#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003421 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003422 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003423
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003424#define pkill_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003425 "[-l|-SIGNAL] [-fnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003426#define pkill_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003427 "Send a signal to process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003428 "\nOptions:" \
3429 "\n -l List all signals" \
3430 "\n -f Match against entire command line" \
3431 "\n -n Signal the newest process only" \
3432 "\n -o Signal the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003433 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003434 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003435 "\n -s Match session ID (0 for current)" \
3436 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003437
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003438#define popmaildir_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003439 "[OPTIONS] MAILDIR [CONN_HELPER ARGS]"
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003440#define popmaildir_full_usage "\n\n" \
3441 "Fetch content of remote mailbox to local maildir\n" \
3442 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003443/* "\n -b Binary mode. Ignored" */ \
3444/* "\n -d Debug. Ignored" */ \
3445/* "\n -m Show used memory. Ignored" */ \
3446/* "\n -V Show version. Ignored" */ \
3447/* "\n -c Use tcpclient. Ignored" */ \
3448/* "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003449 "\n -s Skip authorization" \
3450 "\n -T Get messages with TOP instead with RETR" \
3451 "\n -k Keep retrieved messages on the server" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003452 "\n -t SEC Network timeout" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003453 IF_FEATURE_POPMAILDIR_DELIVERY( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003454 "\n -F \"PROG ARGS\" Filter program. May be multiple" \
3455 "\n -M \"PROG ARGS\" Delivery program" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003456 ) \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003457/* "\n -R BYTES Remove old messages on the server >= BYTES. Ignored" */
3458/* "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" */
3459/* "\n -L BYTES Don't retrieve new messages >= BYTES. Ignored" */
3460/* "\n -H LINES Type first LINES of a message. Ignored" */
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003461#define popmaildir_example_usage \
3462 "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n" \
3463 "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
3464
Eric Andersen7e9276b2001-02-22 01:15:47 +00003465#define poweroff_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003466 "[-d DELAY] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003467#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003468 "Halt and shut off power\n" \
3469 "\nOptions:" \
3470 "\n -d Delay interval for halting" \
3471 "\n -n No call to sync()" \
3472 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003473
Mike Frysinger95d3c452005-04-21 23:29:24 +00003474#define printenv_trivial_usage \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003475 "[VARIABLE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003476#define printenv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003477 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003478 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003479
Eric Andersen7e9276b2001-02-22 01:15:47 +00003480#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003481 "FORMAT [ARGUMENT...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003482#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003483 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003484 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003485#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003486 "$ printf \"Val=%d\\n\" 5\n" \
3487 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003488
Denis Vlasenko94949192006-11-05 00:45:47 +00003489
3490#if ENABLE_DESKTOP
3491
3492#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003493 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003494#define ps_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003495 "Report process status\n" \
3496 "\nOptions:" \
3497 "\n -o col1,col2=header Select columns for display" \
Denys Vlasenko532609e2009-09-20 20:29:25 +02003498 IF_FEATURE_SHOW_THREADS( \
3499 "\n -T Show threads" \
3500 )
Denis Vlasenko94949192006-11-05 00:45:47 +00003501
3502#else /* !ENABLE_DESKTOP */
3503
Denis Vlasenko397de612008-03-17 08:55:44 +00003504#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003505#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003506#else
3507#define USAGE_PS "\nOptions:"
3508#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003509
Eric Andersen7e9276b2001-02-22 01:15:47 +00003510#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003511 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003512#define ps_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003513 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003514 USAGE_PS \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003515 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003516 "\n -Z Show SE Linux context" \
3517 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003518 IF_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003519 "\n w Wide output" \
3520 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003521
Denis Vlasenko94949192006-11-05 00:45:47 +00003522#endif /* ENABLE_DESKTOP */
3523
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003524#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003525 "$ ps\n" \
3526 " PID Uid Gid State Command\n" \
3527 " 1 root root S init\n" \
3528 " 2 root root S [kflushd]\n" \
3529 " 3 root root S [kupdate]\n" \
3530 " 4 root root S [kpiod]\n" \
3531 " 5 root root S [kswapd]\n" \
3532 " 742 andersen andersen S [bash]\n" \
3533 " 743 andersen andersen S -bash\n" \
3534 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003535 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003536
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003537#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003538 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003539#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003540 "Scan a host, print all open ports\n" \
3541 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003542 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003543 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003544 "\n -p Scan from this port (default 1)" \
3545 "\n -P Scan up to this port (default 1024)" \
3546 "\n -t Timeout (default 5000 ms)" \
3547 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3548
Eric Andersen7e9276b2001-02-22 01:15:47 +00003549#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003550 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003551#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003552 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003553#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003554 "$ pwd\n" \
3555 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003556
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003557#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003558 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003559#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003560 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003561#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003562 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003563
Eric Andersen7e9276b2001-02-22 01:15:47 +00003564#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003565 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003566#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003567 "Get and possibly set the system date and time from a remote HOST\n" \
3568 "\nOptions:" \
3569 "\n -s Set the system date and time (default)" \
3570 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003571
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00003572#define rdev_trivial_usage \
3573 ""
3574#define rdev_full_usage "\n\n" \
3575 "Print the device node associated with the filesystem mounted at '/'"
3576#define rdev_example_usage \
3577 "$ rdev\n" \
3578 "/dev/mtdblock9 /\n"
3579
Rob Landley0e4690d2006-08-20 22:12:18 +00003580#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003581 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003582#define readahead_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003583 "Preload FILEs to RAM"
Rob Landley0e4690d2006-08-20 22:12:18 +00003584
Eric Andersen7e9276b2001-02-22 01:15:47 +00003585#define readlink_trivial_usage \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003586 IF_FEATURE_READLINK_FOLLOW("[-fnv] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003587#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003588 "Display the value of a symlink" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003589 IF_FEATURE_READLINK_FOLLOW( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003590 "\nOptions:" \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003591 "\n -f Canonicalize by following all symlinks" \
3592 "\n -n Don't add newline" \
3593 "\n -v Verbose" \
3594 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003595
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003596#define readprofile_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003597 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003598#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003599 "Options:" \
3600 "\n -m mapfile (Default: /boot/System.map)" \
3601 "\n -p profile (Default: /proc/profile)" \
3602 "\n -M mult Set the profiling multiplier to mult" \
3603 "\n -i Print only info about the sampling step" \
3604 "\n -v Verbose" \
3605 "\n -a Print all symbols, even if count is 0" \
3606 "\n -b Print individual histogram-bin counts" \
3607 "\n -s Print individual counters within functions" \
3608 "\n -r Reset all the counters (root only)" \
3609 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003610
Glenn L McGrath62fae302002-12-10 00:14:33 +00003611#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003612 "pathname..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003613#define realpath_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003614 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00003615
Eric Andersen7e9276b2001-02-22 01:15:47 +00003616#define reboot_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003617 "[-d DELAY] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003618#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003619 "Reboot the system\n" \
3620 "\nOptions:" \
3621 "\n -d Delay interval for rebooting" \
3622 "\n -n No call to sync()" \
3623 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003624
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003625#define reformime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003626 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003627#define reformime_full_usage "\n\n" \
3628 "Parse MIME-encoded message\n" \
3629 "\nOptions:" \
3630 "\n -x prefix Extract content of MIME sections to files" \
3631 "\n -X prog [args] Filter content of MIME sections through prog." \
3632 "\n Must be the last option" \
3633 "\n" \
3634 "\nOther options are silently ignored." \
3635
Eric Andersen7e9276b2001-02-22 01:15:47 +00003636#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003637 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003638#define renice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003639 "Change priority of running processes\n" \
3640 "\nOptions:" \
3641 "\n -n Adjust current nice value (smaller is faster)" \
3642 "\n -p Process id(s) (default)" \
3643 "\n -g Process group id(s)" \
3644 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003645
Denys Vlasenko5e611152009-05-19 17:36:16 +02003646#define scriptreplay_trivial_usage \
3647 "timingfile [typescript [divisor]]"
3648#define scriptreplay_full_usage "\n\n" \
3649 "Play back typescripts, using timing information"
3650
Eric Andersen7e9276b2001-02-22 01:15:47 +00003651#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003652 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003653#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003654 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003655
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003656#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003657 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003658#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003659 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003660
Denis Vlasenko397137b2007-07-23 14:03:30 +00003661#define restorecon_trivial_usage \
3662 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003663#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003664 "Reset security contexts of files in pathname\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02003665 "\n -i Ignore files that don't exist" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003666 "\n -f file File with list of files to process. Use - for stdin" \
3667 "\n -e directory Directory to exclude" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003668 "\n -R,-r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003669 "\n -n Don't change any file labels" \
3670 "\n -o file Save list of files with incorrect context" \
3671 "\n -v Verbose" \
3672 "\n -vv Show changed labels" \
3673 "\n -F Force reset of context to match file_context" \
3674 "\n for customizable files, or the user section," \
3675 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003676
Eric Andersen7e9276b2001-02-22 01:15:47 +00003677#define rm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003678 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003679#define rm_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003680 "Remove (unlink) FILEs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003681 "\nOptions:" \
3682 "\n -i Always prompt before removing" \
3683 "\n -f Never prompt" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003684 "\n -R,-r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003685
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003686#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003687 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003688
Eric Andersen7e9276b2001-02-22 01:15:47 +00003689#define rmdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003690 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003691#define rmdir_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003692 "Remove DIRECTORY if it is empty\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003693 "\nOptions:" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003694 IF_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003695 "\n -p|--parents Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003696 "\n --ignore-fail-on-non-empty" \
3697 ) \
3698 IF_NOT_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003699 "\n -p Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003700 )
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003701
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003702#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003703 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003704
Eric Andersen7e9276b2001-02-22 01:15:47 +00003705#define rmmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003706 "[OPTIONS] [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003707#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003708 "Unload the specified kernel modules from the kernel\n" \
3709 "\nOptions:" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003710 "\n -w Wait until the module is no longer used" \
3711 "\n -f Force unloading" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003712 "\n -a Remove all unused modules (recursively)" \
3713
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003714#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003715 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003716
Eric Andersen7e9276b2001-02-22 01:15:47 +00003717#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003718 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003719#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003720 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003721 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003722 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003723 "\n -e Display other/more information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003724 "\n -A inet" IF_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003725
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003726#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003727 "-i -q[ildc]p package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003728#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003729 "Manipulate RPM packages\n" \
3730 "\nOptions:" \
3731 "\n -i Install package" \
3732 "\n -q Query package" \
3733 "\n -p Query uninstalled package" \
3734 "\n -i Show information" \
3735 "\n -l List contents" \
3736 "\n -d List documents" \
3737 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003738
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003739#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003740 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003741#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003742 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003743
Mike Frysinger6b160e42008-02-15 02:27:19 +00003744#define rtcwake_trivial_usage \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003745 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SEC | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003746#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003747 "Enter a system sleep state until specified wakeup time\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003748 IF_LONG_OPTS( \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003749 "\n -a,--auto Read clock mode from adjtime" \
3750 "\n -l,--local Clock is set to local time" \
3751 "\n -u,--utc Clock is set to UTC time" \
3752 "\n -d,--device=DEV Specify the RTC device" \
3753 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003754 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003755 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003756 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003757 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003758 "\n -a Read clock mode from adjtime" \
3759 "\n -l Clock is set to local time" \
3760 "\n -u Clock is set to UTC time" \
3761 "\n -d DEV Specify the RTC device" \
3762 "\n -m MODE Set the sleep state (default: standby)" \
3763 "\n -s SEC Set the timeout in SEC seconds from now" \
3764 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003765 )
3766
Denis Vlasenko49622d72007-03-10 16:58:49 +00003767#define runcon_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003768 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] PROG [ARGS]\n" \
3769 " runcon CONTEXT PROG [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003770#define runcon_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003771 "Run PROG in a different security context\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003772 "\n CONTEXT Complete security context\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003773 IF_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003774 "\n -c,--compute Compute process transition context before modifying" \
3775 "\n -t,--type=TYPE Type (for same role as parent)" \
3776 "\n -u,--user=USER User identity" \
3777 "\n -r,--role=ROLE Role" \
3778 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003779 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003780 IF_NOT_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003781 "\n -c Compute process transition context before modifying" \
3782 "\n -t TYPE Type (for same role as parent)" \
3783 "\n -u USER User identity" \
3784 "\n -r ROLE Role" \
3785 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003786 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003787
Eric Andersen6cf47a72001-10-31 10:24:36 +00003788#define run_parts_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003789 "[-t] "IF_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003790#define run_parts_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003791 "Run a bunch of scripts in DIRECTORY\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003792 "\nOptions:" \
3793 "\n -t Print what would be run, but don't actually run anything" \
3794 "\n -a ARG Pass ARG as argument for every program" \
3795 "\n -u MASK Set the umask to MASK before running every program" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003796 IF_FEATURE_RUN_PARTS_FANCY( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003797 "\n -l Print names of all matching files even if they are not executable" \
3798 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003799
3800#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003801 "$ run-parts -a start /etc/init.d\n" \
3802 "$ run-parts -a stop=now /etc/init.d\n\n" \
3803 "Let's assume you have a script foo/dosomething:\n" \
3804 "#!/bin/sh\n" \
3805 "for i in $*; do eval $i; done; unset i\n" \
3806 "case \"$1\" in\n" \
3807 "start*) echo starting something;;\n" \
3808 "stop*) set -x; shutdown -h $stop;;\n" \
3809 "esac\n\n" \
3810 "Running this yields:\n" \
3811 "$run-parts -a stop=+4m foo/\n" \
3812 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003813
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003814#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003815 "[utmp]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003816#define runlevel_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003817 "Find the current and previous system runlevel\n" \
3818 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003819 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003820 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003821#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003822 "$ runlevel /var/run/utmp\n" \
3823 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003824
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003825#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003826 "dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003827#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003828 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003829
3830#define runsvdir_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003831 "[-P] [-s SCRIPT] dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003832#define runsvdir_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003833 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
3834 "\n -P Put each runsv in a new session" \
3835 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003836
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003837#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003838 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003839#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003840 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003841#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003842 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003843
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003844#define script_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003845 "[-afq" IF_SCRIPTREPLAY("t") "] [-c PROG] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003846#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003847 "Options:" \
3848 "\n -a Append output" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003849 "\n -c Run PROG, not shell" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003850 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003851 "\n -q Quiet" \
Denys Vlasenko5e611152009-05-19 17:36:16 +02003852 IF_SCRIPTREPLAY( \
3853 "\n -t Send timing to stderr" \
3854 )
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003855
Eric Andersen7e9276b2001-02-22 01:15:47 +00003856#define sed_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003857 "[-efinr] SED_CMD [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003858#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003859 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003860 "\n -e CMD Add CMD to sed commands to be executed" \
3861 "\n -f FILE Add FILE contents to sed commands to be executed" \
Denys Vlasenkodac863a2009-10-27 09:11:17 +01003862 "\n -i Edit files in-place (else sends result to stdout)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003863 "\n -n Suppress automatic printing of pattern space" \
3864 "\n -r Use extended regex syntax" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003865 "\n" \
Rob Landley7b284152009-10-26 16:04:07 -05003866 "\nIf no -e or -f, the first non-option argument is the sed command string." \
3867 "\nRemaining arguments are input files (stdin if none)."
Eric Andersenf802ff72004-04-12 15:12:06 +00003868
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003869#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003870 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3871 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003872
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003873#define selinuxenabled_trivial_usage NOUSAGE_STR
3874#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003875
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003876#define sendmail_trivial_usage \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003877 "[OPTIONS] [RECIPIENT_EMAIL]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003878#define sendmail_full_usage "\n\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003879 "Read email from stdin and send it\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003880 "\nStandard options:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003881 "\n -t Read additional recipients from message body" \
3882 "\n -f sender Sender (required)" \
3883 "\n -o options Various options. -oi implied, others are ignored" \
Vladimir Dronnikovb618dba2009-10-04 01:34:54 +02003884 "\n -i -oi synonym. implied and ignored" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003885 "\n" \
3886 "\nBusybox specific options:" \
3887 "\n -w seconds Network timeout" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003888 "\n -H 'PROG ARGS' Run connection helper" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003889 "\n Examples:" \
Denis Vlasenko7e0c2432009-03-02 16:12:00 +00003890 "\n -H 'exec openssl s_client -quiet -tls1 -starttls smtp" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003891 "\n -connect smtp.gmail.com:25' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003892 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003893 "\n -H 'exec openssl s_client -quiet -tls1" \
3894 "\n -connect smtp.gmail.com:465' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003895 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003896 "\n -S server[:port] Server" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003897 "\n -au<username> Username for AUTH LOGIN" \
3898 "\n -ap<password> Password for AUTH LOGIN" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003899 "\n -am<method> Authentication method. Ignored. LOGIN is implied" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003900 "\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003901 "\nOther options are silently ignored; -oi -t is implied" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003902 IF_MAKEMIME( \
3903 "\nUse makemime applet to create message with attachments" \
3904 )
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003905
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003906#define seq_trivial_usage \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003907 "[-w] [-s SEP] [FIRST [INC]] LAST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003908#define seq_full_usage "\n\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003909 "Print numbers from FIRST to LAST, in steps of INC.\n" \
3910 "FIRST, INC default to 1\n" \
3911 "\nOptions:" \
3912 "\n -w Pad to last with leading zeros" \
3913 "\n -s SEP String separator" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003914
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003915#define sestatus_trivial_usage \
3916 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003917#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003918 " -v Verbose" \
3919 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003920
Paul Foxfc2256a2005-08-01 18:12:30 +00003921#define setconsole_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003922 "[-r" IF_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003923#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003924 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3925 "\nOptions:" \
3926 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003927
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003928#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003929 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003930#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003931
Denis Vlasenko397137b2007-07-23 14:03:30 +00003932#define setfiles_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003933 "[-dnpqsvW] [-e DIR]... [-o FILE] [-r alt_root_path]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003934 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003935 " [-c policyfile] spec_file" \
3936 ) \
3937 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003938#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003939 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003940 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003941 "\n -c FILE Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003942 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003943 "\n -d Show which specification matched each file" \
3944 "\n -l Log changes in file labels to syslog" \
3945 "\n -n Don't change any file labels" \
3946 "\n -q Suppress warnings" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003947 "\n -r DIR Use an alternate root path" \
3948 "\n -e DIR Exclude DIR" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003949 "\n -F Force reset of context to match file_context for customizable files" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003950 "\n -o FILE Save list of files with incorrect context" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003951 "\n -s Take a list of files from standard input (instead of command line)" \
3952 "\n -v Show changes in file labels, if type or role are changing" \
3953 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3954 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003955
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003956#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003957 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003958#define setfont_full_usage "\n\n" \
3959 "Load a console font\n" \
3960 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003961 "\n -m MAPFILE Load console screen map" \
3962 "\n -C TTY Affect TTY instead of /dev/tty" \
3963
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003964#define setfont_example_usage \
3965 "$ setfont -m koi8-r /etc/i18n/fontname\n"
3966
Eric Andersen7e9276b2001-02-22 01:15:47 +00003967#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003968 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003969#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003970 "Set entries into the kernel's scancode-to-keycode map,\n" \
3971 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3972 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003973 "and KEYCODE is given in decimal" \
3974
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003975#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003976 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003977
Rob Landley87848d92006-03-27 23:23:43 +00003978#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003979 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003980#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003981 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003982
Denis Vlasenkobe039372007-10-14 04:48:44 +00003983#define setsebool_trivial_usage \
3984 "boolean value"
3985
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003986#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00003987 "Change boolean setting"
3988
Paul Fox42403642005-08-01 22:52:09 +00003989#define setsid_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003990 "PROG [ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003991#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003992 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3993 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3994 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003995
Eric Andersen2e9c2572003-08-08 22:26:06 +00003996#define last_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003997 ""IF_FEATURE_LAST_FANCY("[-HW] [-f file]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003998#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003999 "Show listing of the last users that logged into the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004000 IF_FEATURE_LAST_FANCY( "\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004001 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00004002/* "\n -H Show header line" */ \
4003 "\n -W Display with no host column truncation" \
4004 "\n -f file Read from file instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004005 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00004006
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00004007#define showkey_trivial_usage \
4008 "[-a | -k | -s]"
4009#define showkey_full_usage "\n\n" \
4010 "Show keys pressed\n" \
4011 "\nOptions:" \
4012 "\n -a Display decimal/octal/hex values of the keys" \
4013 "\n -k Display interpreted keycodes (default)" \
4014 "\n -s Display raw scan-codes" \
4015
Denis Vlasenko14923db2007-06-20 15:23:03 +00004016#define slattach_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004017 "[-cehmLF] [-s SPEED] [-p PROTOCOL] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004018#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004019 "Attach network interface(s) to serial line(s)\n" \
4020 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004021 "\n -p PROT Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
4022 "\n -s SPD Set line speed" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004023 "\n -e Exit after initializing device" \
4024 "\n -h Exit when the carrier is lost" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004025 "\n -c PROG Run PROG when the line is hung up" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004026 "\n -m Do NOT initialize the line in raw 8 bits mode" \
4027 "\n -L Enable 3-wire operation" \
4028 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00004029
Eric Andersen7e9276b2001-02-22 01:15:47 +00004030#define sleep_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004031 IF_FEATURE_FANCY_SLEEP("[") "N" IF_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004032#define sleep_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004033 IF_NOT_FEATURE_FANCY_SLEEP("Pause for N seconds") \
4034 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004035 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004036 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004037#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004038 "$ sleep 2\n" \
4039 "[2 second delay results]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004040 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004041 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004042 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00004043
Eric Andersen7e9276b2001-02-22 01:15:47 +00004044#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004045 "[-nru" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004046 IF_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004047 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004048#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004049 "Sort lines of text\n" \
4050 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004051 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004052 "\n -b Ignore leading blanks" \
4053 "\n -c Check whether input is sorted" \
4054 "\n -d Dictionary order (blank or alphanumeric only)" \
4055 "\n -f Ignore case" \
4056 "\n -g General numerical sort" \
4057 "\n -i Ignore unprintable characters" \
4058 "\n -k Sort key" \
4059 "\n -M Sort month" \
4060 ) \
4061 "\n -n Sort numbers" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004062 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004063 "\n -o Output to file" \
4064 "\n -k Sort by key" \
4065 "\n -t CHAR Key separator" \
4066 ) \
4067 "\n -r Reverse sort order" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004068 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004069 "\n -s Stable (don't sort ties alphabetically)" \
4070 ) \
4071 "\n -u Suppress duplicate lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004072 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004073 "\n -z Lines are terminated by NUL, not newline" \
4074 "\n -mST Ignored for GNU compatibility") \
4075
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004076#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004077 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
4078 "a\n" \
4079 "b\n" \
4080 "c\n" \
4081 "d\n" \
4082 "e\n" \
4083 "f\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004084 IF_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00004085 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
4086 "d 2\n" \
4087 "b 2\n" \
4088 "c 3\n" \
4089 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004090 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004091
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00004092#define split_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004093 "[OPTIONS] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004094#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00004095 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004096 "\n -b n[k|m] Split by bytes" \
4097 "\n -l n Split by lines" \
4098 "\n -a n Use n letters as suffix" \
4099
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00004100#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00004101 "$ split TODO foo\n" \
4102 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00004103
Eric Andersenc2af1ee2001-10-18 19:33:06 +00004104#define start_stop_daemon_trivial_usage \
Denis Vlasenko7987a182008-07-01 10:00:46 +00004105 "[OPTIONS] [-S|-K] ... [-- arguments...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004106#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004107 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004108 "-K: stop all matching processes.\n" \
4109 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004110 IF_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004111 "\nProcess matching:" \
4112 "\n -u,--user USERNAME|UID Match only this user's processes" \
4113 "\n -n,--name NAME Match processes with NAME" \
4114 "\n in comm field in /proc/PID/stat" \
4115 "\n -x,--exec EXECUTABLE Match processes with this command" \
4116 "\n in /proc/PID/cmdline" \
4117 "\n -p,--pidfile FILE Match a process with PID from the file" \
4118 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004119 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004120 "\n -x,--exec EXECUTABLE Program to run" \
4121 "\n -a,--startas NAME Zeroth argument" \
4122 "\n -b,--background Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004123 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004124 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004125 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004126 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
4127 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004128 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004129 "\n -s,--signal SIG Signal to send" \
4130 "\n -t,--test Match only, exit with 0 if a process is found" \
4131 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004132 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004133 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004134 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00004135 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00004136 "\n -q,--quiet Quiet" \
4137 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004138 IF_NOT_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004139 "\nProcess matching:" \
4140 "\n -u USERNAME|UID Match only this user's processes" \
4141 "\n -n NAME Match processes with NAME" \
4142 "\n in comm field in /proc/PID/stat" \
4143 "\n -x EXECUTABLE Match processes with this command" \
4144 "\n command in /proc/PID/cmdline" \
4145 "\n -p FILE Match a process with PID from the file" \
4146 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004147 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004148 "\n -x EXECUTABLE Program to run" \
4149 "\n -a NAME Zeroth argument" \
4150 "\n -b Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004151 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004152 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00004153 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004154 "\n -c USER[:[GRP]] Change to user/group" \
4155 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004156 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004157 "\n -s SIG Signal to send" \
4158 "\n -t Match only, exit with 0 if a process is found" \
4159 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004160 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004161 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004162 "\n -v Verbose" \
4163 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00004164 "\n -q Quiet" \
4165 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00004166
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004167#define stat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004168 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004169#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004170 "Display file (default) or filesystem status\n" \
4171 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004172 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004173 "\n -c fmt Use the specified format" \
4174 ) \
4175 "\n -f Display filesystem status" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004176 "\n -L Follow links" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004177 "\n -t Display info in terse form" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004178 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004179 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004180 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004181 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004182 "\n\nValid format sequences for files:\n" \
4183 " %a Access rights in octal\n" \
4184 " %A Access rights in human readable form\n" \
4185 " %b Number of blocks allocated (see %B)\n" \
4186 " %B The size in bytes of each block reported by %b\n" \
4187 " %d Device number in decimal\n" \
4188 " %D Device number in hex\n" \
4189 " %f Raw mode in hex\n" \
4190 " %F File type\n" \
4191 " %g Group ID of owner\n" \
4192 " %G Group name of owner\n" \
4193 " %h Number of hard links\n" \
4194 " %i Inode number\n" \
4195 " %n File name\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004196 " %N File name, with -> TARGET if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004197 " %o I/O block size\n" \
4198 " %s Total size, in bytes\n" \
4199 " %t Major device type in hex\n" \
4200 " %T Minor device type in hex\n" \
4201 " %u User ID of owner\n" \
4202 " %U User name of owner\n" \
4203 " %x Time of last access\n" \
4204 " %X Time of last access as seconds since Epoch\n" \
4205 " %y Time of last modification\n" \
4206 " %Y Time of last modification as seconds since Epoch\n" \
4207 " %z Time of last change\n" \
4208 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004209 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004210 " %a Free blocks available to non-superuser\n" \
4211 " %b Total data blocks in file system\n" \
4212 " %c Total file nodes in file system\n" \
4213 " %d Free file nodes in file system\n" \
4214 " %f Free blocks in file system\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004215 IF_SELINUX( \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004216 " %C Security context in SELinux\n" \
4217 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004218 " %i File System ID in hex\n" \
4219 " %l Maximum length of filenames\n" \
4220 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004221 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004222 " %S Fundamental block size (for block counts)\n" \
4223 " %t Type in hex\n" \
4224 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004225 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004226
Eric Andersenef5e8f82002-11-07 02:09:37 +00004227#define strings_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004228 "[-afo] [-n LEN] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004229#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004230 "Display printable strings in a binary file\n" \
4231 "\nOptions:" \
4232 "\n -a Scan whole file (default)" \
4233 "\n -f Precede strings with filenames" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004234 "\n -n LEN At least LEN characters form a string (default 4)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004235 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00004236
Eric Andersen7e9276b2001-02-22 01:15:47 +00004237#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004238 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004239#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004240 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004241 "and deviations from stty sane\n" \
4242 "\nOptions:" \
4243 "\n -F DEVICE Open device instead of stdin" \
4244 "\n -a Print all current settings in human-readable form" \
4245 "\n -g Print in stty-readable form" \
4246 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004247
Robert Griebl1fca5582002-06-04 20:45:46 +00004248#define su_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004249 "[OPTIONS] [-] [USERNAME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004250#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004251 "Change user id or become root\n" \
4252 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004253 "\n -p,-m Preserve environment" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004254 "\n -c CMD Command to pass to 'sh -c'" \
4255 "\n -s SH Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00004256
Eric Andersen27f64e12002-06-23 04:24:25 +00004257#define sulogin_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004258 "[OPTIONS] [TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004259#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004260 "Single user login\n" \
4261 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004262 "\n -t N Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004263
Mike Frysinger95d3c452005-04-21 23:29:24 +00004264#define sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004265 "[-rs] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004266#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004267 "Checksum and count the blocks in a file\n" \
4268 "\nOptions:" \
4269 "\n -r Use BSD sum algorithm (1K blocks)" \
4270 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00004271
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004272#define sv_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004273 "[-v] [-w SEC] command service..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004274#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004275 "Control services monitored by runsv supervisor.\n" \
4276 "Commands (only first character is enough):\n" \
4277 "\n" \
4278 "status: query service status\n" \
4279 "up: if service isn't running, start it. If service stops, restart it\n" \
4280 "once: like 'up', but if service stops, don't restart it\n" \
4281 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004282 " if it exists. After it stops, don't restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004283 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004284 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004285 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004286 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004287
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004288#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004289 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004290#define svlogd_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004291 "Continuously read log data from standard input, optionally\n" \
4292 "filter log messages, and write the data to one or more automatically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004293 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004294
Eric Andersen7e9276b2001-02-22 01:15:47 +00004295#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004296 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004297#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004298 "Stop swapping on DEVICE\n" \
4299 "\nOptions:" \
4300 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004301
Eric Andersen7e9276b2001-02-22 01:15:47 +00004302#define swapon_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004303 "[-a]" IF_FEATURE_SWAPON_PRI(" [-p PRI]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004304#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004305 "Start swapping on DEVICE\n" \
4306 "\nOptions:" \
4307 "\n -a Start swapping on all swap devices" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004308 IF_FEATURE_SWAPON_PRI( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004309 "\n -p PRI Set swap device priority" \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004310 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004311
Rob Landley0f34a822005-10-27 22:55:50 +00004312#define switch_root_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004313 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004314#define switch_root_full_usage "\n\n" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004315 "Free initramfs and switch to another root fs:\n" \
4316 "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n" \
4317 "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004318 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004319 "\n -c DEV Reopen stdio to DEV after switch" \
Rob Landley0f34a822005-10-27 22:55:50 +00004320
Eric Andersen7e9276b2001-02-22 01:15:47 +00004321#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004322 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004323#define sync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004324 "Write all buffered blocks to disk"
4325
4326#define fsync_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004327 "[OPTIONS] FILE..."
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004328#define fsync_full_usage \
4329 "Write files' buffered blocks to disk\n" \
4330 "\nOptions:" \
4331 "\n -d Avoid syncing metadata"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004332
Eric Andersenb9050282003-12-24 06:02:11 +00004333#define sysctl_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004334 "[OPTIONS] [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004335#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004336 "Configure kernel parameters at runtime\n" \
4337 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004338 "\n -n Don't print key names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004339 "\n -e Don't warn about unknown keys" \
4340 "\n -w Change sysctl setting" \
4341 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
4342 "\n -a Display all values" \
4343 "\n -A Display all values in table form" \
4344
Eric Andersen5d38f5b2005-09-12 21:42:48 +00004345#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00004346 "sysctl [-n] [-e] variable...\n" \
4347 "sysctl [-n] [-e] -w variable=value...\n" \
4348 "sysctl [-n] [-e] -a\n" \
4349 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
4350 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00004351
Eric Andersen7e9276b2001-02-22 01:15:47 +00004352#define syslogd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004353 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004354#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004355 "System logging utility.\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004356 "Note that this version of syslogd ignores /etc/syslog.conf.\n" \
4357 "\nOptions:" \
4358 "\n -n Run in foreground" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004359 "\n -O FILE Log to given file (default:/var/log/messages)" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004360 "\n -l n Set local log level" \
4361 "\n -S Smaller logging output" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004362 IF_FEATURE_ROTATE_LOGFILE( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004363 "\n -s SIZE Max size (KB) before rotate (default:200KB, 0=off)" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004364 "\n -b N N rotated logs to keep (default:1, max=99, 0=purge)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004365 IF_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004366 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
4367 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004368 IF_FEATURE_SYSLOGD_DUP( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004369 "\n -D Drop duplicates") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004370 IF_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004371 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00004372 /* NB: -Csize shouldn't have space (because size is optional) */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004373/* "\n -m MIN Minutes between MARK lines (default:20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00004374
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004375#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004376 "$ syslogd -R masterlog:514\n" \
4377 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004378
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004379#define tac_trivial_usage \
4380 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004381#define tac_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004382 "Concatenate FILEs and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004383
Eric Andersen7e9276b2001-02-22 01:15:47 +00004384#define tail_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004385 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004386#define tail_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004387 "Print last 10 lines of each FILE (or standard input) to standard output.\n" \
4388 "With more than one FILE, precede each with a header giving the file name.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004389 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004390 IF_FEATURE_FANCY_TAIL( \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004391 "\n -c N[kbm] Output last N bytes") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004392 "\n -n N[kbm] Print last N lines instead of last 10" \
4393 "\n -f Output data as the file grows" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004394 IF_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004395 "\n -q Never output headers giving file names" \
4396 "\n -s SEC Wait SEC seconds between reads with -f" \
4397 "\n -v Always output headers giving file names" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004398 "\n" \
4399 "\nIf the first character of N (bytes or lines) is a '+', output begins with" \
4400 "\nthe Nth item from the start of each file, otherwise, print the last N items" \
4401 "\nin the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004402
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004403#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004404 "$ tail -n 1 /etc/resolv.conf\n" \
4405 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004406
Eric Andersen7e9276b2001-02-22 01:15:47 +00004407#define tar_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004408 "-[" IF_FEATURE_TAR_CREATE("c") IF_FEATURE_SEAMLESS_GZ("z") \
4409 IF_FEATURE_SEAMLESS_BZ2("j") IF_FEATURE_SEAMLESS_LZMA("a") \
4410 IF_FEATURE_SEAMLESS_Z("Z") "xtvO] " \
4411 IF_FEATURE_TAR_FROM("[-X FILE] ") \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004412 "[-f TARFILE] [-C DIR] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004413#define tar_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004414 IF_FEATURE_TAR_CREATE("Create, extract, ") \
4415 IF_NOT_FEATURE_TAR_CREATE("Extract ") \
4416 "or list files from a tar file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004417 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004418 IF_FEATURE_TAR_CREATE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004419 "\n c Create") \
4420 "\n x Extract" \
4421 "\n t List" \
4422 "\nArchive format selection:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004423 IF_FEATURE_SEAMLESS_GZ( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004424 "\n z Filter the archive through gzip" \
4425 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004426 IF_FEATURE_SEAMLESS_BZ2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004427 "\n j Filter the archive through bzip2" \
4428 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004429 IF_FEATURE_SEAMLESS_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004430 "\n a Filter the archive through lzma" \
4431 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004432 IF_FEATURE_SEAMLESS_Z( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004433 "\n Z Filter the archive through compress" \
4434 ) \
4435 "\nFile selection:" \
4436 "\n f Name of TARFILE or \"-\" for stdin" \
4437 "\n O Extract to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004438 IF_FEATURE_TAR_FROM( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004439 "\n exclude File to exclude" \
4440 "\n X File with names to exclude" \
4441 ) \
4442 "\n C Change to directory DIR before operation" \
4443 "\n v Verbose" \
4444
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004445#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004446 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
4447 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004448
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004449#define taskset_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004450 "[-p] [MASK] [PID | PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004451#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004452 "Set or get CPU affinity\n" \
4453 "\nOptions:" \
4454 "\n -p Operate on an existing PID" \
4455
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004456#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004457 "$ taskset 0x7 ./dgemm_test&\n" \
4458 "$ taskset -p 0x1 $!\n" \
4459 "pid 4790's current affinity mask: 7\n" \
4460 "pid 4790's new affinity mask: 1\n" \
4461 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4462 "pid 6671's current affinity mask: 1\n" \
4463 "pid 6671's new affinity mask: 1\n" \
4464 "$ taskset -p 1\n" \
4465 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004466
Eric Andersen7e9276b2001-02-22 01:15:47 +00004467#define tee_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004468 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004469#define tee_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004470 "Copy standard input to each FILE, and also to standard output\n" \
4471 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004472 "\n -a Append to the given FILEs, don't overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004473 "\n -i Ignore interrupt signals (SIGINT)" \
4474
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004475#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004476 "$ echo \"Hello\" | tee /tmp/foo\n" \
4477 "$ cat /tmp/foo\n" \
4478 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004479
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004480#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004481#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004482 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004483#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004484 "Connect to telnet server\n" \
4485 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004486 "\n -a Automatic login with $USER variable" \
4487 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004488
Eric Andersen539ffc92004-02-22 12:25:47 +00004489#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004490#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004491 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004492#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004493 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004494#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004495
Eric Andersen08a72202002-09-30 20:52:10 +00004496#define telnetd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004497 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004498#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004499 "Handle incoming telnet connections" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004500 IF_NOT_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004501 "\nOptions:" \
4502 "\n -l LOGIN Exec LOGIN on connect" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004503 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004504 "\n -K Close connection as soon as login exits" \
4505 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004506 IF_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004507 "\n -p PORT Port to listen on" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004508 "\n -b ADDR[:PORT] Address to bind to" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004509 "\n -F Run in foreground" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004510 "\n -i Run as inetd service" \
4511 IF_FEATURE_TELNETD_INETD_WAIT( \
4512 "\n -w SEC Run as inetd service in wait mode, linger time SEC" \
4513 "\n -S Log to syslog (implied by -i or without -F and -w)" \
4514 ) \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004515 )
Eric Andersen08a72202002-09-30 20:52:10 +00004516
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004517/* "test --help" does not print help (POSIX compat), only "[ --help" does.
Denys Vlasenko662078f2010-01-14 13:27:34 +01004518 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION")
4519 * Unfortunately, it screws up generated BusyBox.html. TODO. */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004520#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004521 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004522#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004523 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4524 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004525#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004526 "$ test 1 -eq 2\n" \
4527 "$ echo $?\n" \
4528 "1\n" \
4529 "$ test 1 -eq 1\n" \
4530 "$ echo $?\n" \
4531 "0\n" \
4532 "$ [ -d /etc ]\n" \
4533 "$ echo $?\n" \
4534 "0\n" \
4535 "$ [ -d /junk ]\n" \
4536 "$ echo $?\n" \
4537 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004538
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004539#define tc_trivial_usage \
4540 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
4541#define tc_full_usage "\n\n" \
4542 "OBJECT: {qdisc|class|filter}\n" \
4543 "CMD: {add|del|change|replace|show}\n" \
4544 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004545 "qdisc [ handle QHANDLE ] [ root |"IF_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004546 /* "[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4547 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4548 " QDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004549 "qdisc show [ dev STRING ]"IF_FEATURE_TC_INGRESS(" [ingress]")"\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004550 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004551 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004552 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
4553 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
4554 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004555 " [ root | classid CLASSID ] [ handle FILTERID ]\n" \
4556 " [ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004557 "filter show [ dev STRING ] [ root | parent CLASSID ]"
4558
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004559#define tcpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004560 "[-hEv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004561/* with not-implemented options: */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004562/* "[-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 +00004563#define tcpsvd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004564 "Create TCP socket, bind to IP:PORT and listen\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004565 "for incoming connection. Run PROG for each connection.\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004566 "\n IP IP to listen on. '0' = all" \
4567 "\n PORT Port to listen on" \
4568 "\n PROG [ARGS] Program to run" \
4569 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4570 "\n -u USER[:GRP] Change to user/group after bind" \
4571 "\n -c N Handle up to N connections simultaneously" \
4572 "\n -b N Allow a backlog of approximately N TCP SYNs" \
4573 "\n -C N[:MSG] Allow only up to N connections from the same IP" \
4574 "\n New connections from this IP address are closed" \
4575 "\n immediately. MSG is written to the peer before close" \
4576 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004577 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004578 "\n -v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004579
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004580#define udpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004581 "[-hEv] [-c N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004582#define udpsvd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004583 "Create UDP socket, bind to IP:PORT and wait\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004584 "for incoming packets. Run PROG for each packet,\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004585 "redirecting all further packets with same peer ip:port to it.\n" \
4586 "\n IP IP to listen on. '0' = all" \
4587 "\n PORT Port to listen on" \
4588 "\n PROG [ARGS] Program to run" \
4589 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4590 "\n -u USER[:GRP] Change to user/group after bind" \
4591 "\n -c N Handle up to N connections simultaneously" \
4592 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004593 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004594 "\n -v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004595
Mark Whitley450736c2001-03-02 19:08:50 +00004596#define tftp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004597 "[OPTIONS] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004598#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004599 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004600 "\nOptions:" \
4601 "\n -l FILE Local FILE" \
4602 "\n -r FILE Remote FILE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004603 IF_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004604 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004605 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004606 IF_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004607 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004608 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004609 IF_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004610 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004611 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004612
4613#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004614 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004615#define tftpd_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004616 "Transfer a file on tftp client's request\n" \
Denis Vlasenko91f8f822008-10-30 23:42:37 +00004617 "\n" \
4618 "tftpd should be used as an inetd service.\n" \
4619 "tftpd's line for inetd.conf:\n" \
4620 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
4621 "It also can be ran from udpsvd:\n" \
4622 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004623 "\nOptions:" \
4624 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004625 "\n -c Allow file creation via upload" \
4626 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004627
Eric Andersenc3657422001-11-30 07:54:32 +00004628#define time_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004629 "[OPTIONS] PROG [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004630#define time_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004631 "Run PROG. When it finishes, its resource usage is displayed.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004632 "\nOptions:" \
4633 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004634
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004635#define timeout_trivial_usage \
4636 "[-t SECS] [-s SIG] PROG [ARGS]"
4637#define timeout_full_usage "\n\n" \
4638 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
Denis Vlasenko42404082008-11-24 13:42:24 +00004639 "Defaults: SECS: 10, SIG: TERM." \
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004640
Eric Andersen420b2082002-09-17 22:14:58 +00004641#define top_trivial_usage \
Denys Vlasenko00528822009-09-11 23:26:42 +02004642 "[-b] [-nCOUNT] [-dSECONDS]" IF_FEATURE_TOPMEM(" [-m]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004643#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004644 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004645 "Read the status of all processes from /proc each SECONDS\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004646 "and show the status for however many processes will fit on the screen." \
Eric Andersen420b2082002-09-17 22:14:58 +00004647
Eric Andersen7e9276b2001-02-22 01:15:47 +00004648#define touch_trivial_usage \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004649 "[-c] [-d DATE] FILE [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004650#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004651 "Update the last-modified date on the given FILE[s]\n" \
4652 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004653 "\n -c Don't create files" \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004654 "\n -d DT Date/time to use" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004655
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004656#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004657 "$ ls -l /tmp/foo\n" \
4658 "/bin/ls: /tmp/foo: No such file or directory\n" \
4659 "$ touch /tmp/foo\n" \
4660 "$ ls -l /tmp/foo\n" \
4661 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004662
4663#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004664 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004665#define tr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004666 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004667 "standard input, writing to standard output\n" \
4668 "\nOptions:" \
4669 "\n -c Take complement of STRING1" \
4670 "\n -d Delete input characters coded STRING1" \
4671 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4672
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004673#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004674 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4675 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004676
Eric Andersen5c58d282001-07-10 16:29:00 +00004677#define traceroute_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004678 "[-"IF_TRACEROUTE6("46")"FIldnrv] [-f 1ST_TTL] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
4679 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-g GATEWAY] [-i IFACE]\n" \
4680 " [-z PAUSE_MSEC] HOST [BYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004681#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004682 "Trace the route to HOST\n" \
4683 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004684 IF_TRACEROUTE6( \
4685 "\n -4, -6 Force IP or IPv6 name resolution" \
4686 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004687 "\n -F Set the don't fragment bit" \
4688 "\n -I Use ICMP ECHO instead of UDP datagrams" \
4689 "\n -l Display the ttl value of the returned packet" \
4690 "\n -d Set SO_DEBUG options to socket" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004691 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004692 "\n -r Bypass routing tables, send directly to HOST" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004693 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004694 "\n -m Max time-to-live (max number of hops)" \
4695 "\n -p Base UDP port number used in probes" \
4696 "\n (default 33434)" \
4697 "\n -q Number of probes per 'ttl' (default 3)" \
4698 "\n -s IP address to use as the source address" \
4699 "\n -t Type-of-service in probe packets (default 0)" \
4700 "\n -w Time in seconds to wait for a response (default 3)" \
4701 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004702
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004703#define traceroute6_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004704 "[-dnrv] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
4705 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-i IFACE]\n" \
4706 " HOST [BYTES]"
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004707#define traceroute6_full_usage "\n\n" \
4708 "Trace the route to HOST\n" \
4709 "\nOptions:" \
4710 "\n -d Set SO_DEBUG options to socket" \
4711 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004712 "\n -r Bypass routing tables, send directly to HOST" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004713 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004714 "\n -m Max time-to-live (max number of hops)" \
4715 "\n -p Base UDP port number used in probes" \
4716 "\n (default is 33434)" \
4717 "\n -q Number of probes per 'ttl' (default 3)" \
4718 "\n -s IP address to use as the source address" \
4719 "\n -t Type-of-service in probe packets (default 0)" \
4720 "\n -w Time in seconds to wait for a response (default 3)" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004721
Eric Andersen7e9276b2001-02-22 01:15:47 +00004722#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004723 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004724#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004725 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004726#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004727 "$ true\n" \
4728 "$ echo $?\n" \
4729 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004730
Eric Andersen7e9276b2001-02-22 01:15:47 +00004731#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004732 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004733#define tty_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004734 "Print file name of standard input's terminal" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004735 IF_INCLUDE_SUSv2( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004736 "\nOptions:" \
4737 "\n -s Print nothing, only return exit status" \
4738 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004739#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004740 "$ tty\n" \
4741 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004742
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004743#define ttysize_trivial_usage \
4744 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004745#define ttysize_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004746 "Print dimension(s) of standard input's terminal, on error return 80x25"
4747
Denis Vlasenko39b68132009-01-23 02:07:14 +00004748#define tunctl_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004749 "[-f device] ([-t name] | -d name)" IF_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]")
Denis Vlasenko39b68132009-01-23 02:07:14 +00004750#define tunctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004751 "Create or delete tun interfaces\n" \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004752 "\nOptions:" \
4753 "\n -f name tun device (/dev/net/tun)" \
4754 "\n -t name Create iface 'name'" \
4755 "\n -d name Delete iface 'name'" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004756 IF_FEATURE_TUNCTL_UG( \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004757 "\n -u owner Set iface owner" \
4758 "\n -g group Set iface group" \
4759 "\n -b Brief output" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004760 )
Denis Vlasenko39b68132009-01-23 02:07:14 +00004761#define tunctl_example_usage \
4762 "# tunctl\n" \
4763 "# tunctl -d tun0\n"
4764
Mike Frysinger174808c2005-06-11 01:14:09 +00004765#define tune2fs_trivial_usage \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004766/* "[-c max-mounts-count] [-e errors-behavior] [-g group] " */ \
4767/* "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " */ \
4768/* "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " */ \
4769/* "[-r reserved-blocks-count] [-u user] [-C mount-count] " */ \
4770 "[-L LABEL] " \
4771/* "[-M last-mounted-dir] [-O [^]feature[,...]] " */ \
4772/* "[-T last-check-time] [-U UUID] " */ \
4773 "BLOCKDEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004774#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004775 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004776
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004777#define udhcpc_trivial_usage \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004778 "[-Cfbnqtvo] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004779 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." IF_FEATURE_UDHCP_PORT(" [-P N]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004780#define udhcpc_full_usage "\n\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004781 IF_LONG_OPTS( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004782 " -V,--vendorclass=CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004783 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
4784 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
4785 "\n -c,--clientid=CLIENTID Client identifier" \
4786 "\n -C,--clientid-none Suppress default client identifier" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +01004787 "\n -p,--pidfile=FILE Create pidfile" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004788 "\n -r,--request=IP IP address to request" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +01004789 "\n -s,--script=FILE Run FILE at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denys Vlasenkof26e98f2009-10-10 16:14:41 +02004790 "\n -t,--retries=N Send up to N discover packets" \
Denys Vlasenko84e1caf2009-10-10 16:13:17 +02004791 "\n -T,--timeout=N Pause between packets (default 3 seconds)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004792 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004793 "\n -O,--request-option=OPT Request DHCP option OPT (cumulative)" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004794 "\n -o,--no-default-options Don't request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004795 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004796 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004797 "\n -b,--background Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004798 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004799 "\n -S,--syslog Log to syslog too" \
4800 "\n -n,--now Exit with failure if lease is not immediately obtained" \
4801 "\n -q,--quit Quit after obtaining lease" \
4802 "\n -R,--release Release IP on quit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004803 IF_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004804 "\n -P,--client-port N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004805 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004806 IF_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004807 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004808 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004809 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004810 IF_NOT_LONG_OPTS( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004811 " -V CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004812 "\n -i INTERFACE Interface to use (default: eth0)" \
4813 "\n -H,-h HOSTNAME Client hostname" \
4814 "\n -c CLIENTID Client identifier" \
4815 "\n -C Suppress default client identifier" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +01004816 "\n -p FILE Create pidfile" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004817 "\n -r IP IP address to request" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +01004818 "\n -s FILE Run FILE at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004819 "\n -t N Send up to N request packets" \
4820 "\n -T N Try to get a lease for N seconds (default 3)" \
4821 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004822 "\n -O OPT Request DHCP option OPT (cumulative)" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004823 "\n -o Don't request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004824 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004825 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004826 "\n -b Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004827 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004828 "\n -S Log to syslog too" \
4829 "\n -n Exit with failure if lease is not immediately obtained" \
4830 "\n -q Quit after obtaining lease" \
4831 "\n -R Release IP on quit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004832 IF_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004833 "\n -P N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004834 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004835 IF_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004836 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004837 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004838 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004839
Russ Dill61fb4892002-10-14 21:41:28 +00004840#define udhcpd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004841 "[-fS]" IF_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004842
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004843#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004844 "DHCP server\n" \
4845 "\n -f Run in foreground" \
4846 "\n -S Log to syslog too" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004847 IF_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004848 "\n -P N Use port N instead of default 67" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004849 )
Russ Dill61fb4892002-10-14 21:41:28 +00004850
Eric Andersen7e9276b2001-02-22 01:15:47 +00004851#define umount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004852 "[OPTIONS] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004853#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004854 "Unmount file systems\n" \
4855 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004856 IF_FEATURE_UMOUNT_ALL( \
4857 "\n -a Unmount all file systems" IF_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004858 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004859 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004860 "\n -n Don't erase /etc/mtab entries" \
4861 ) \
4862 "\n -r Try to remount devices as read-only if mount is busy" \
4863 "\n -l Lazy umount (detach filesystem)" \
4864 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004865 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004866 "\n -d Free loop device if it has been used" \
4867 )
4868
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004869#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004870 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004871
4872#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004873 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004874#define uname_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004875 "Print system information\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004876 "\nOptions:" \
4877 "\n -a Print all" \
4878 "\n -m The machine (hardware) type" \
4879 "\n -n Hostname" \
4880 "\n -r OS release" \
4881 "\n -s OS name (default)" \
4882 "\n -p Processor type" \
4883 "\n -v OS version" \
4884
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004885#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004886 "$ uname -a\n" \
4887 "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 +00004888
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004889#define uncompress_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004890 "[-c] [-f] [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004891#define uncompress_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004892 "Uncompress .Z file[s]\n" \
4893 "\nOptions:" \
4894 "\n -c Extract to stdout" \
4895 "\n -f Overwrite an existing file" \
Tim Riker7b253f82003-12-28 05:02:40 +00004896
Denis Vlasenko3952f202007-08-13 14:10:24 +00004897#define unexpand_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004898 "[-f][-a][-t N] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004899#define unexpand_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004900 "Convert spaces to tabs, writing to standard output\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004901 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004902 IF_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004903 "\n -a,--all Convert all blanks" \
4904 "\n -f,--first-only Convert only leading blanks" \
4905 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004906 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004907 IF_NOT_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004908 "\n -a Convert all blanks" \
4909 "\n -f Convert only leading blanks" \
4910 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004911 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004912
Eric Andersen7e9276b2001-02-22 01:15:47 +00004913#define uniq_trivial_usage \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004914 "[-fscduw]... [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004915#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004916 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004917 "\nOptions:" \
4918 "\n -c Prefix lines by the number of occurrences" \
4919 "\n -d Only print duplicate lines" \
4920 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004921 "\n -f N Skip first N fields" \
4922 "\n -s N Skip first N chars (after any skipped fields)" \
4923 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004924
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004925#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004926 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4927 "a\n" \
4928 "b\n" \
4929 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004930
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004931#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004932 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004933#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004934 "Extract files from ZIP archives\n" \
4935 "\nOptions:" \
4936 "\n -l List archive contents (with -q for short form)" \
4937 "\n -n Never overwrite existing files (default)" \
4938 "\n -o Overwrite files without prompting" \
4939 "\n -p Send output to stdout" \
4940 "\n -q Quiet" \
4941 "\n -x Exclude these files" \
4942 "\n -d Extract files into this directory" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004943
Eric Andersen7e9276b2001-02-22 01:15:47 +00004944#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004945 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004946#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004947 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004948
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004949#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004950 "$ uptime\n" \
4951 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004952
4953#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004954 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004955#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004956 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004957
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004958#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004959 "$ usleep 1000000\n" \
4960 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004961
4962#define uudecode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004963 "[-o OUTFILE] [INFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004964#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004965 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004966 "Finds outfile name in uuencoded source unless -o is given"
4967
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004968#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004969 "$ uudecode -o busybox busybox.uu\n" \
4970 "$ ls -l busybox\n" \
4971 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004972
4973#define uuencode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004974 "[-m] [INFILE] STORED_FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004975#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004976 "Uuencode a file to stdout\n" \
4977 "\nOptions:" \
4978 "\n -m Use base64 encoding per RFC1521" \
4979
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004980#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004981 "$ uuencode busybox busybox\n" \
4982 "begin 755 busybox\n" \
4983 "<encoded file snipped>\n" \
4984 "$ uudecode busybox busybox > busybox.uu\n" \
4985 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004986
Eric Andersen853c4942003-01-23 05:59:32 +00004987#define vconfig_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004988 "COMMAND [OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004989#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004990 "Create and remove virtual ethernet devices\n" \
4991 "\nOptions:" \
4992 "\n add [interface-name] [vlan_id]" \
4993 "\n rem [vlan-name]" \
4994 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4995 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4996 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4997 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004998
Eric Andersen3f980402001-04-04 17:31:15 +00004999#define vi_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005000 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005001#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005002 "Edit FILE\n" \
5003 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005004 IF_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00005005 "\n -c Initial command to run ($EXINIT also available)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005006 IF_FEATURE_VI_READONLY( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01005007 "\n -R Read-only") \
Denis Vlasenko397de612008-03-17 08:55:44 +00005008 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00005009
Eric Andersen27f64e12002-06-23 04:24:25 +00005010#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005011 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005012#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005013 "Lock a virtual terminal. A password is required to unlock.\n" \
5014 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00005015 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00005016
Matthew Stoltenberg4803db52009-08-13 00:59:32 +02005017#define volname_trivial_usage \
5018 "[DEVICE]"
5019#define volname_full_usage "\n\n" \
5020 "Show CD volume name of the DEVICE (default /dev/cdrom)"
5021
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005022#define wall_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01005023 "[FILE]"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005024#define wall_full_usage "\n\n" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01005025 "Write content of FILE or standard-input to all logged-in users"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005026#define wall_sample_usage \
5027 "echo foo | wall\n" \
5028 "wall ./mymessage"
5029
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005030#define watch_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005031 "[-n seconds] [-t] PROG [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005032#define watch_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005033 "Run PROG periodically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005034 "\nOptions:" \
5035 "\n -n Loop period in seconds (default 2)" \
5036 "\n -t Don't print header" \
5037
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005038#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005039 "$ watch date\n" \
5040 "Mon Dec 17 10:31:40 GMT 2000\n" \
5041 "Mon Dec 17 10:31:42 GMT 2000\n" \
5042 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005043
Eric Andersen7e9276b2001-02-22 01:15:47 +00005044#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005045 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005046#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005047 "Periodically write to watchdog device DEV\n" \
5048 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005049 "\n -T N Reboot after N seconds if not reset (default 60)" \
5050 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00005051 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00005052 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005053 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005054
5055#define wc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005056 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005057#define wc_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005058 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005059 "more than one FILE is specified. With no FILE, read standard input.\n" \
5060 "\nOptions:" \
5061 "\n -c Print the byte counts" \
5062 "\n -l Print the newline counts" \
5063 "\n -L Print the length of the longest line" \
5064 "\n -w Print the word counts" \
5065
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005066#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005067 "$ wc /etc/passwd\n" \
5068 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005069
5070#define wget_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005071 IF_FEATURE_WGET_LONG_OPTIONS( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00005072 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00005073 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
5074 " [-U|--user-agent agent] url" \
5075 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005076 IF_NOT_FEATURE_WGET_LONG_OPTIONS( \
Denis Vlasenko03630782007-10-18 11:11:12 +00005077 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
5078 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005079#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005080 "Retrieve files via HTTP or FTP\n" \
5081 "\nOptions:" \
5082 "\n -s Spider mode - only check file existence" \
5083 "\n -c Continue retrieval of aborted transfer" \
5084 "\n -q Quiet" \
5085 "\n -P Set directory prefix to DIR" \
5086 "\n -O Save to filename ('-' for stdout)" \
5087 "\n -U Adjust 'User-Agent' field" \
5088 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005089
5090#define which_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005091 "[COMMAND]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005092#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005093 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005094#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005095 "$ which login\n" \
5096 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00005097
Eric Andersen00a6a752002-04-26 23:53:10 +00005098#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00005099 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005100#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005101 "Show who is logged on\n" \
5102 "\nOptions:" \
5103 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005104
5105#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005106 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005107#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005108 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005109
5110#define xargs_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005111 "[OPTIONS] [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005112#define xargs_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005113 "Run PROG on every item given by standard input\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005114 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005115 IF_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005116 "\n -p Ask user whether to run each command") \
Denys Vlasenko07697852009-10-06 21:11:37 +02005117 "\n -r Don't run command if input is empty" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005118 IF_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005119 "\n -0 Input is separated by NUL characters") \
5120 "\n -t Print the command on stderr before execution" \
Denis Vlasenkoe82da4d2008-08-21 19:59:30 +00005121 "\n -e[STR] STR stops input processing" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005122 "\n -n N Pass no more than N args to PROG" \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005123 "\n -s N Pass command line of no more than N bytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005124 IF_FEATURE_XARGS_SUPPORT_TERMOPT( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005125 "\n -x Exit if size is exceeded") \
Denis Vlasenko397de612008-03-17 08:55:44 +00005126
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005127#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005128 "$ ls | xargs gzip\n" \
5129 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005130
5131#define yes_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005132 "[OPTIONS] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005133#define yes_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005134 "Repeatedly output a line with STRING, or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00005135
Eric Andersen7e9276b2001-02-22 01:15:47 +00005136#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005137 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005138#define zcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005139 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00005140
Rob Landleyad8071f2005-04-30 03:49:37 +00005141#define zcip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005142 "[OPTIONS] IFACE SCRIPT"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005143#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005144 "Manage a ZeroConf IPv4 link-local address\n" \
5145 "\nOptions:" \
5146 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00005147 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005148 "\n -r 169.254.x.x Request this address first" \
5149 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00005150 "\n" \
5151 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
5152 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00005153
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00005154
5155#endif