blob: 85561c558449c2fee8067fece7583c9b305a504b [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" \
133 "\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 \
148 "-f freq -l length -d delay -r repetitions -n"
149#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 \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000294 "[-R] [-+=AacDdijsStTu] [-v version] files..."
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:" \
314 "\n -R Recursively list subdirectories" \
315 "\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:" \
534 "\n -p Operate on pid" \
535 "\n -r Set scheduling policy to SCHED_RR" \
536 "\n -f Set scheduling policy to SCHED_FIFO" \
537 "\n -o Set scheduling policy to SCHED_OTHER" \
538 "\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 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000554 "\n -d,-P Preserve links" \
555 "\n -H,-L Dereference all symlinks (default)" \
556 "\n -p Preserve file attributes if possible" \
557 "\n -f Force overwrite" \
558 "\n -i Prompt before overwrite" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200559 "\n -R,-r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000560 "\n -l,-s Create (sym)links" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000561
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000562#define cpio_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000563 "-[ti" IF_FEATURE_CPIO_O("o") IF_FEATURE_CPIO_P("p") "dmvu] [-F FILE]" \
564 IF_FEATURE_CPIO_O( " [-H newc]" )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000565#define cpio_full_usage "\n\n" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000566 "Extract or list files from a cpio archive" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000567 IF_FEATURE_CPIO_O( ", or create a cpio archive" ) \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000568 "\nMain operation mode:" \
569 "\n -t List" \
570 "\n -i Extract" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000571 IF_FEATURE_CPIO_O( \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000572 "\n -o Create" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000573 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000574 IF_FEATURE_CPIO_P( \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000575 "\n -p Passthrough" \
576 ) \
577 "\nOptions:" \
578 "\n -d Make leading directories" \
579 "\n -m Preserve mtime" \
580 "\n -v Verbose" \
581 "\n -u Overwrite" \
582 "\n -F Input file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000583 IF_FEATURE_CPIO_O( \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000584 "\n -H Define format" \
585 ) \
Tim Riker7b253f82003-12-28 05:02:40 +0000586
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000587#define crond_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000588 "-fbS -l N " IF_FEATURE_CROND_D("-d N ") "-L LOGFILE -c DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000589#define crond_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000590 " -f Foreground" \
591 "\n -b Background (default)" \
592 "\n -S Log to syslog (default)" \
593 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000594 IF_FEATURE_CROND_D( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000595 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000596 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000597 "\n -L Log to file" \
598 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000599
600#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000601 "[-c DIR] [-u USER] [-ler]|[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000602#define crontab_full_usage "\n\n" \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000603 " -c Crontab directory" \
604 "\n -u User" \
605 "\n -l List crontab" \
606 "\n -e Edit crontab" \
607 "\n -r Delete crontab" \
608 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000609
Denis Vlasenko2211d522008-11-10 18:52:35 +0000610#define cryptpw_trivial_usage \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000611 "[OPTIONS] [PASSWORD] [SALT]"
612/* We do support -s, we just don't mention it */
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000613#define cryptpw_full_usage "\n\n" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000614 "Crypt the PASSWORD using crypt(3)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000615 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200616 IF_LONG_OPTS( \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000617 "\n -P,--password-fd=NUM Read password from fd NUM" \
618/* "\n -s,--stdin Use stdin; like -P0" */ \
619 "\n -m,--method=TYPE Encryption method TYPE" \
620 "\n -S,--salt=SALT" \
621 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200622 IF_NOT_LONG_OPTS( \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000623 "\n -P NUM Read password from fd NUM" \
624/* "\n -s Use stdin; like -P0" */ \
625 "\n -m TYPE Encryption method TYPE" \
626 "\n -S SALT" \
627 ) \
628
629/* mkpasswd is an alias to cryptpw */
630
631#define mkpasswd_trivial_usage \
632 "[OPTIONS] [PASSWORD] [SALT]"
633/* We do support -s, we just don't mention it */
634#define mkpasswd_full_usage "\n\n" \
635 "Crypt the PASSWORD using crypt(3)\n" \
636 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200637 IF_LONG_OPTS( \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000638 "\n -P,--password-fd=NUM Read password from fd NUM" \
639/* "\n -s,--stdin Use stdin; like -P0" */ \
640 "\n -m,--method=TYPE Encryption method TYPE" \
641 "\n -S,--salt=SALT" \
642 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200643 IF_NOT_LONG_OPTS( \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000644 "\n -P NUM Read password from fd NUM" \
645/* "\n -s Use stdin; like -P0" */ \
646 "\n -m TYPE Encryption method TYPE" \
647 "\n -S SALT" \
648 ) \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000649
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000650#define cttyhack_trivial_usage NOUSAGE_STR
651#define cttyhack_full_usage ""
652
Eric Andersen7e9276b2001-02-22 01:15:47 +0000653#define cut_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200654 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000655#define cut_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000656 "Print selected fields from each input FILE to standard output\n" \
657 "\nOptions:" \
658 "\n -b LIST Output only bytes from LIST" \
659 "\n -c LIST Output only characters from LIST" \
660 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
661 "\n -s Output only the lines containing delimiter" \
662 "\n -f N Print only these fields" \
663 "\n -n Ignored" \
664
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000665#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000666 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
667 "Hello\n" \
668 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
669 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000670
Eric Andersen7e9276b2001-02-22 01:15:47 +0000671#define date_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200672 "[OPTIONS] [+FMT] [TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000673#define date_full_usage "\n\n" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000674 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000675 "\nOptions:" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200676 IF_NOT_LONG_OPTS( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200677 "\n [-s] TIME Set time to TIME" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000678 "\n -u Work in UTC (don't convert to local time)" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200679 "\n -R Output RFC-2822 compliant date string" \
680 ) IF_LONG_OPTS( \
681 "\n [-s,--set] TIME Set time to TIME" \
Denys Vlasenko50be9632009-10-23 16:25:20 +0200682 "\n -u,--utc Work in UTC (don't convert to local time)" \
683 "\n -R,--rfc-2822 Output RFC-2822 compliant date string" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200684 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000685 IF_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000686 "\n -I[SPEC] Output ISO-8601 compliant date string" \
687 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000688 "\n 'hours', 'minutes', or 'seconds' for date and" \
689 "\n time to the indicated precision" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200690 ) IF_NOT_LONG_OPTS( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000691 "\n -r FILE Display last modification time of FILE" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200692 "\n -d TIME Display TIME, not 'now'" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200693 ) IF_LONG_OPTS( \
Denys Vlasenko50be9632009-10-23 16:25:20 +0200694 "\n -r,--reference FILE Display last modification time of FILE" \
695 "\n -d,--date TIME Display TIME, not 'now'" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200696 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000697 IF_FEATURE_DATE_ISOFMT( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200698 "\n -D FMT Use FMT for -d TIME conversion" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000699 ) \
700 "\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +0200701 "\nRecognized TIME formats:" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000702 "\n hh:mm[:ss]" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000703 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000704 "\n YYYY-MM-DD hh:mm[:ss]" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200705 "\n [[[[[YY]YY]MM]DD]hh]mm[.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000706
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000707#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000708 "$ date\n" \
709 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000710
Eric Andersen7e9276b2001-02-22 01:15:47 +0000711#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000712 "expression..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000713#define dc_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +0000714 "Tiny RPN calculator. Operations:\n" \
715 "+, add, -, sub, *, mul, /, div, %, mod, **, exp, and, or, not, eor,\n" \
716 "p - print top of the stack (without altering the stack),\n" \
717 "f - print entire stack, o - pop the value and set output radix\n" \
718 "(value must be 10 or 16).\n" \
719 "Examples: 'dc 2 2 add' -> 4, 'dc 8 8 * 2 2 + /' -> 16.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000720
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000721#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000722 "$ dc 2 2 + p\n" \
723 "4\n" \
724 "$ dc 8 8 \\* 2 2 + / p\n" \
725 "16\n" \
726 "$ dc 0 1 and p\n" \
727 "0\n" \
728 "$ dc 0 1 or p\n" \
729 "1\n" \
730 "$ echo 72 9 div 8 mul p | dc\n" \
731 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000732
Eric Andersen7e9276b2001-02-22 01:15:47 +0000733#define dd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000734 "[if=FILE] [of=FILE] " IF_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
735 " [seek=N]" IF_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000736#define dd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000737 "Copy a file with converting and formatting\n" \
738 "\nOptions:" \
739 "\n if=FILE Read from FILE instead of stdin" \
740 "\n of=FILE Write to FILE instead of stdout" \
741 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000742 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000743 "\n ibs=N Read N bytes at a time" \
744 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000745 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000746 "\n obs=N Write N bytes at a time" \
747 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000748 "\n count=N Copy only N input blocks" \
749 "\n skip=N Skip N input blocks" \
750 "\n seek=N Skip N output blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000751 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000752 "\n conv=notrunc Don't truncate output file" \
753 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000754 "\n conv=sync Pad blocks with zeros" \
755 "\n conv=fsync Physically write data out before finishing" \
756 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000757 "\n" \
758 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
759 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
760
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000761#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000762 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
763 "4+0 records in\n" \
764 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000765
Eric Andersen7e9276b2001-02-22 01:15:47 +0000766#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000767 "[N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000768#define deallocvt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000769 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000770
Eric Andersenf349e972001-08-21 16:18:59 +0000771#define delgroup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000772 IF_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000773#define delgroup_full_usage "\n\n" \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000774 "Delete group GROUP from the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000775 IF_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000776
777#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000778 "USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000779#define deluser_full_usage "\n\n" \
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000780 "Delete USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000781
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000782#define depmod_trivial_usage NOUSAGE_STR
783#define depmod_full_usage ""
Bernhard Reutner-Fischer55e547e2008-05-26 12:01:49 +0000784
Denis Vlasenkoc94fa562008-10-26 11:08:14 +0000785#define devmem_trivial_usage \
786 "ADDRESS [WIDTH [VALUE]]"
787
788#define devmem_full_usage "\n\n" \
789 "Read/write from physical address\n" \
790 "\n ADDRESS Address to act upon" \
791 "\n WIDTH Width (8/16/...)" \
792 "\n VALUE Data to be written" \
793
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000794#define devfsd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000795 "mntpnt [-v]" IF_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000796#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000797 "Manage devfs permissions and old device name symlinks\n" \
798 "\nOptions:" \
799 "\n mntpnt The mount point where devfs is mounted" \
800 "\n -v Print the protocol version numbers for devfsd" \
801 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000802 IF_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000803 "\n -fg Run in foreground" \
804 "\n -np Exit after parsing the configuration file" \
805 "\n and processing synthetic REGISTER events," \
Denys Vlasenko07697852009-10-06 21:11:37 +0200806 "\n don't poll for events" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000807 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000808
Eric Andersen7e9276b2001-02-22 01:15:47 +0000809#define df_trivial_usage \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000810 "[-Pk" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000811 IF_FEATURE_HUMAN_READABLE("mh") \
812 IF_FEATURE_DF_FANCY("ai] [-B SIZE") \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000813 "] [FILESYSTEM...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000814#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000815 "Print filesystem usage statistics\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000816 "\nOptions:" \
817 "\n -P POSIX output format" \
818 "\n -k 1024-byte blocks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000819 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000820 "\n -m 1M-byte blocks" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000821 "\n -h Human readable (e.g. 1K 243M 2G)" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000822 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000823 IF_FEATURE_DF_FANCY( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000824 "\n -a Show all filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000825 "\n -i Inodes" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000826 "\n -B SIZE Blocksize" \
827 ) \
828
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000829#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000830 "$ df\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000831 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000832 "/dev/sda3 8690864 8553540 137324 98% /\n" \
833 "/dev/sda1 64216 36364 27852 57% /boot\n" \
834 "$ df /dev/sda3\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000835 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
836 "/dev/sda3 8690864 8553540 137324 98% /\n" \
837 "$ POSIXLY_CORRECT=sure df /dev/sda3\n" \
838 "Filesystem 512B-blocks Used Available Use% Mounted on\n" \
839 "/dev/sda3 17381728 17107080 274648 98% /\n" \
840 "$ POSIXLY_CORRECT=yep df -P /dev/sda3\n" \
841 "Filesystem 512-blocks Used Available Capacity Mounted on\n" \
842 "/dev/sda3 17381728 17107080 274648 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000843
Denis Vlasenko736230e2006-11-20 19:40:36 +0000844#define dhcprelay_trivial_usage \
Denis Vlasenkoe8a79682009-04-13 03:33:46 +0000845 "CLIENT_IFACE[,CLIENT_IFACE2...] SERVER_IFACE [SERVER_IP]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000846#define dhcprelay_full_usage "\n\n" \
Denis Vlasenkoe8a79682009-04-13 03:33:46 +0000847 "Relay DHCP requests between clients and server" \
Denis Vlasenko736230e2006-11-20 19:40:36 +0000848
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000849#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000850 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000851#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000852 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000853 "This implementation supports unified diffs only.\n" \
854 "\nOptions:" \
855 "\n -a Treat all files as text" \
856 "\n -b Ignore changes in the amount of whitespace" \
857 "\n -d Try hard to find a smaller set of changes" \
858 "\n -i Ignore case differences" \
859 "\n -L Use LABEL instead of the filename in the unified header" \
860 "\n -N Treat absent files as empty" \
861 "\n -q Output only whether files differ" \
862 "\n -r Recursively compare subdirectories" \
863 "\n -S Start with FILE when comparing directories" \
864 "\n -T Make tabs line up by prefixing a tab when necessary" \
865 "\n -s Report when two files are the same" \
866 "\n -t Expand tabs to spaces in output" \
867 "\n -U Output LINES lines of context" \
868 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000869
Eric Andersen7e9276b2001-02-22 01:15:47 +0000870#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000871 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000872#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000873 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000874#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000875 "$ dirname /tmp/foo\n" \
876 "/tmp\n" \
877 "$ dirname /tmp/foo/\n" \
878 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000879
Eric Andersen7e9276b2001-02-22 01:15:47 +0000880#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000881 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000882#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000883 "Print or control the kernel ring buffer\n" \
884 "\nOptions:" \
885 "\n -c Clear ring buffer after printing" \
886 "\n -n LEVEL Set console logging level" \
887 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000888
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000889#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000890 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000891#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000892 "Small static DNS server daemon\n" \
893 "\nOptions:" \
894 "\n -c Config filename" \
895 "\n -t TTL in seconds" \
896 "\n -p Listening port" \
897 "\n -i Listening ip (default all)" \
898 "\n -d Daemonize" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000899
Eric Andersen7e9276b2001-02-22 01:15:47 +0000900#define dos2unix_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +0200901 "[OPTIONS] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000902#define dos2unix_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200903 "Convert FILE in-place from DOS to Unix format.\n" \
904 "When no file is given, use stdin/stdout.\n" \
905 "\nOptions:" \
906 "\n -u dos2unix" \
907 "\n -d unix2dos" \
908
909#define unix2dos_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +0200910 "[OPTIONS] [FILE]"
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200911#define unix2dos_full_usage "\n\n" \
912 "Convert FILE in-place from Unix to DOS format.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000913 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000914 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000915 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000916 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000917
Eric Andersen7e9276b2001-02-22 01:15:47 +0000918#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000919 "[-ilCPru] [-F option] package_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000920#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000921 "Install, remove and manage Debian packages\n" \
922 "\nOptions:" \
923 "\n -i Install the package" \
924 "\n -l List of installed packages" \
925 "\n -C Configure an unpackaged package" \
926 "\n -F depends Ignore dependency problems" \
927 "\n -P Purge all files of a package" \
928 "\n -r Remove all but the configuration files for a package" \
929 "\n -u Unpack a package, but don't configure it" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000930
Eric Andersen7e9276b2001-02-22 01:15:47 +0000931#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000932 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000933#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000934 "Perform actions on Debian packages (.debs)\n" \
935 "\nOptions:" \
936 "\n -c List contents of filesystem tree" \
937 "\n -e Extract control files to [argument] directory" \
938 "\n -f Display control field name starting with [argument]" \
939 "\n -x Extract packages filesystem tree to directory" \
940 "\n -X Verbose extract" \
941
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000942#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000943 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000944
Eric Andersen7e9276b2001-02-22 01:15:47 +0000945#define du_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000946 "[-aHLdclsx" IF_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000947#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000948 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000949 "Disk space is printed in units of " \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000950 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
951 IF_NOT_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000952 " bytes.\n" \
953 "\nOptions:" \
954 "\n -a Show file sizes too" \
955 "\n -H Follow symlinks on command line" \
956 "\n -L Follow all symlinks" \
957 "\n -d N Limit output to directories (and files with -a) of depth < N" \
958 "\n -c Show grand total" \
959 "\n -l Count sizes many times if hard linked" \
960 "\n -s Display only a total for each argument" \
961 "\n -x Skip directories on different filesystems" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000962 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000963 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
964 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000965 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000966 "\n -k Sizes in kilobytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000967 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000968
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000969#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000970 "$ du\n" \
971 "16 ./CVS\n" \
972 "12 ./kernel-patches/CVS\n" \
973 "80 ./kernel-patches\n" \
974 "12 ./tests/CVS\n" \
975 "36 ./tests\n" \
976 "12 ./scripts/CVS\n" \
977 "16 ./scripts\n" \
978 "12 ./docs/CVS\n" \
979 "104 ./docs\n" \
980 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000981
Eric Andersen7e9276b2001-02-22 01:15:47 +0000982#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000983 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000984#define dumpkmap_full_usage "\n\n" \
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000985 "Print a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000986#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000987 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000988
Russ Dill61fb4892002-10-14 21:41:28 +0000989#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000990 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000991#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000992 "Display DHCP leases granted by udhcpd\n" \
993 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200994 IF_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000995 "\n -f,--file=FILE Leases file to load" \
996 "\n -r,--remaining Interpret lease times as time remaining" \
997 "\n -a,--absolute Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000998 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200999 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001000 "\n -f FILE Leases file to load" \
1001 "\n -r Interpret lease times as time remaining" \
1002 "\n -a Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001003 )
Russ Dill61fb4892002-10-14 21:41:28 +00001004
Mike Frysinger51a43b42005-09-24 07:11:16 +00001005#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001006 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
1007 "[-I inode_buffer_blocks] [-P process_inode_size] " \
1008 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
1009 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001010#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001011 "Check ext2/ext3 file system\n" \
1012 "\nOptions:" \
1013 "\n -p Automatic repair (no questions)" \
1014 "\n -n Make no changes to the filesystem" \
1015 "\n -y Assume 'yes' to all questions" \
1016 "\n -c Check for bad blocks and add them to the badblock list" \
1017 "\n -f Force checking even if filesystem is marked clean" \
1018 "\n -v Verbose" \
1019 "\n -b superblock Use alternative superblock" \
1020 "\n -B blocksize Force blocksize when looking for superblock" \
1021 "\n -j journal Set location of the external journal" \
1022 "\n -l file Add to badblocks list" \
1023 "\n -L file Set badblocks list" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001024
Eric Andersen7e9276b2001-02-22 01:15:47 +00001025#define echo_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001026 IF_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001027#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001028 "Print the specified ARGs to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001029 IF_FEATURE_FANCY_ECHO( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001030 "\nOptions:" \
1031 "\n -n Suppress trailing newline" \
1032 "\n -e Interpret backslash-escaped characters (i.e., \\t=tab)" \
1033 "\n -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001034 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001035#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001036 "$ echo \"Erik is cool\"\n" \
1037 "Erik is cool\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001038 IF_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001039 "Erik\n" \
1040 "is\n" \
1041 "cool\n" \
1042 "$ echo \"Erik\\nis\\ncool\"\n" \
1043 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001044
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001045#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001046 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001047#define eject_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001048 "Eject specified DEVICE (or default /dev/cdrom)\n" \
1049 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001050 IF_FEATURE_EJECT_SCSI( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001051 "\n -s SCSI device" \
1052 ) \
1053 "\n -t Close tray" \
1054 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001055
Rob Landley3b890392006-05-04 20:56:43 +00001056#define ed_trivial_usage ""
1057#define ed_full_usage ""
1058
Eric Andersen84e229c2001-03-29 22:48:33 +00001059#define env_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001060 "[-iu] [-] [name=value]... [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001061#define env_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001062 "Print the current environment or run PROG after setting up\n" \
1063 "the specified environment\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001064 "\nOptions:" \
1065 "\n -, -i Start with an empty environment" \
1066 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +00001067
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001068#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001069 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001070#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001071 "Send a magic packet to wake up sleeping machines.\n" \
1072 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001073 "a hostname with a known 'ethers' entry.\n" \
1074 "\nOptions:" \
1075 "\n -b Send wake-up packet to the broadcast address" \
1076 "\n -i iface Interface to use (default eth0)" \
1077 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001078
Denis Vlasenko3952f202007-08-13 14:10:24 +00001079#define expand_trivial_usage \
1080 "[-i] [-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001081#define expand_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001082 "Convert tabs to spaces, writing to standard output\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001083 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001084 IF_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001085 "\n -i,--initial Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001086 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001087 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001088 IF_NOT_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001089 "\n -i Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001090 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001091 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00001092
Eric Andersen7e9276b2001-02-22 01:15:47 +00001093#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001094 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001095#define expr_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001096 "Print the value of EXPRESSION to standard output\n" \
1097 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001098 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001099 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
1100 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1101 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1102 " ARG1 <= ARG2\n" \
1103 " ARG1 = ARG2\n" \
1104 " ARG1 != ARG2\n" \
1105 " ARG1 >= ARG2\n" \
1106 " ARG1 > ARG2\n" \
1107 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1108 " ARG1 - ARG2\n" \
1109 " ARG1 * ARG2\n" \
1110 " ARG1 / ARG2\n" \
1111 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001112 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1113 " match STRING REGEXP Same as STRING : REGEXP\n" \
1114 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1115 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1116 " length STRING Length of STRING\n" \
1117 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001118 " it is a keyword like 'match' or an\n" \
1119 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001120 " (EXPRESSION) Value of EXPRESSION\n" \
1121 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001122 "Beware that many operators need to be escaped or quoted for shells.\n" \
1123 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001124 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001125 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1126 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001127
Mike Frysingerfa69f112005-04-17 07:24:19 +00001128#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001129 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001130#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001131 "Provide fake ident (auth) service\n" \
1132 "\nOptions:" \
1133 "\n -f Run in foreground" \
1134 "\n -i Inetd mode" \
1135 "\n -w Inetd 'wait' mode" \
1136 "\n -b ADDR Bind to specified address" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001137 "\n STRING Ident answer string (default: nobody)" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001138
Eric Andersen7e9276b2001-02-22 01:15:47 +00001139#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001140 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001141#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001142 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001143
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001144#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001145 "$ false\n" \
1146 "$ echo $?\n" \
1147 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001148
1149#define fbset_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001150 "[OPTIONS] [MODE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001151#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001152 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001153
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001154#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001155 "$ fbset\n" \
1156 "mode \"1024x768-76\"\n" \
1157 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1158 " geometry 1024 768 1024 768 16\n" \
1159 " timings 12714 128 32 16 4 128 4\n" \
1160 " accel false\n" \
1161 " rgba 5/11,6/5,5/0,0/0\n" \
1162 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001163
Eric Andersen7e9276b2001-02-22 01:15:47 +00001164#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001165 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001166#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001167 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001168
Eric Andersen01c3d402003-07-05 07:51:31 +00001169#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001170 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001171#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001172 "Format floppy disk\n" \
1173 "\nOptions:" \
1174 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001175
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001176/* Looks like someone forgot to add this to config system */
1177#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1178# define ENABLE_FEATURE_FDISK_BLKSIZE 0
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001179# define IF_FEATURE_FDISK_BLKSIZE(a)
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001180#endif
1181
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001182#define fdisk_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001183 "[-ul" IF_FEATURE_FDISK_BLKSIZE("s") "] " \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001184 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001185#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001186 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001187 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001188 "\n -u Start and End are in sectors (instead of cylinders)" \
1189 "\n -l Show partition table for each DISK, then exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001190 IF_FEATURE_FDISK_BLKSIZE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001191 "\n -s Show partition sizes in kb for each DISK, then exit" \
1192 ) \
1193 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1194 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
1195 "\n -H HEADS\n" \
1196 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001197
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001198#define blkid_trivial_usage \
1199 ""
1200#define blkid_full_usage "\n\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02001201 "Print UUIDs of all filesystems"
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001202
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001203#define findfs_trivial_usage \
1204 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001205#define findfs_full_usage "\n\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02001206 "Find a filesystem device based on a label or UUID"
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001207#define findfs_example_usage \
1208 "$ findfs LABEL=MyDevice"
1209
Eric Andersen7e9276b2001-02-22 01:15:47 +00001210#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001211 "[PATH...] [EXPRESSION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001212#define find_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001213 "Search for files. The default PATH is the current directory,\n" \
1214 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001215 "\nEXPRESSION may consist of:" \
1216 "\n -follow Dereference symlinks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001217 IF_FEATURE_FIND_XDEV( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001218 "\n -xdev Don't descend directories on other filesystems") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001219 IF_FEATURE_FIND_MAXDEPTH( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001220 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1221 "\n tests/actions to command line arguments only") \
Denys Vlasenko07697852009-10-06 21:11:37 +02001222 "\n -mindepth N Don't act on first N levels" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001223 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001224 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001225 IF_FEATURE_FIND_PATH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001226 "\n -path PATTERN Path matches PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001227 IF_FEATURE_FIND_REGEX( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001228 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001229 IF_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001230 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001231 IF_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001232 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001233 "\n or exactly (NNN)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001234 IF_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001235 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001236 "\n or exactly (N) days") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001237 IF_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001238 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001239 "\n or exactly (N) minutes") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001240 IF_FEATURE_FIND_NEWER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001241 "\n -newer FILE Modified time is more recent than FILE's") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001242 IF_FEATURE_FIND_INUM( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001243 "\n -inum N File has inode number N") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001244 IF_FEATURE_FIND_USER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001245 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001246 IF_FEATURE_FIND_GROUP( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001247 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001248 IF_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001249 "\n -depth Process directory name after traversing it") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001250 IF_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001251 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1252 "\n +/-N: file size is bigger/smaller than N") \
1253 "\n -print Print (default and assumed)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001254 IF_FEATURE_FIND_PRINT0( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001255 "\n -print0 Delimit output with null characters rather than" \
1256 "\n newlines") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001257 IF_FEATURE_FIND_CONTEXT ( \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001258 "\n -context File has specified security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001259 IF_FEATURE_FIND_EXEC( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001260 "\n -exec CMD ARG ; Run CMD with all instances of {} replaced by the" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001261 "\n matching files") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001262 IF_FEATURE_FIND_PRUNE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001263 "\n -prune Stop traversing current subtree") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001264 IF_FEATURE_FIND_DELETE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001265 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001266 IF_FEATURE_FIND_PAREN( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001267 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001268
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001269#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001270 "$ find / -name passwd\n" \
1271 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001272
Denys Vlasenkobf2af9a2009-05-25 04:15:37 +02001273#define flash_lock_trivial_usage \
1274 "MTD_DEVICE OFFSET SECTORS"
1275#define flash_lock_full_usage "\n\n" \
1276 "Lock part or all of an MTD device. If SECTORS is -1, then all sectors\n" \
1277 "will be locked, regardless of the value of OFFSET"
1278
1279#define flash_unlock_trivial_usage \
1280 "MTD_DEVICE"
1281#define flash_unlock_full_usage "\n\n" \
1282 "Unlock an MTD device"
1283
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001284#define flash_eraseall_trivial_usage \
1285 "[-jq] MTD_DEVICE"
1286#define flash_eraseall_full_usage "\n\n" \
1287 "Erase an MTD device\n" \
1288 "\nOptions:" \
1289 "\n -j format the device for jffs2" \
1290 "\n -q don't display progress messages"
1291
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001292#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001293 "[-bs] [-w WIDTH] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001294#define fold_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001295 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001296 "standard output\n" \
1297 "\nOptions:" \
1298 "\n -b Count bytes rather than columns" \
1299 "\n -s Break at spaces" \
1300 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001301
Eric Andersen7e9276b2001-02-22 01:15:47 +00001302#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001303 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001304#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001305 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001306#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001307 "$ free\n" \
1308 " total used free shared buffers\n" \
1309 " Mem: 257628 248724 8904 59644 93124\n" \
1310 " Swap: 128516 8404 120112\n" \
1311 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001312
Eric Andersen7e9276b2001-02-22 01:15:47 +00001313#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001314 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001315#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001316 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001317#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001318 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001319
Mike Frysinger51a43b42005-09-24 07:11:16 +00001320#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001321 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001322#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001323 "Check and repair filesystems\n" \
1324 "\nOptions:" \
1325 "\n -A Walk /etc/fstab and check all filesystems" \
1326 "\n -N Don't execute, just show what would be done" \
1327 "\n -P With -A, check filesystems in parallel" \
1328 "\n -R With -A, skip the root filesystem" \
1329 "\n -T Don't show title on startup" \
1330 "\n -V Verbose" \
1331 "\n -C n Write status information to specified filedescriptor" \
1332 "\n -t type List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001333
Eric Andersen7e9276b2001-02-22 01:15:47 +00001334#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001335 "[-larvsmf] /dev/name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001336#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001337 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001338 "\nOptions:" \
1339 "\n -l List all filenames" \
1340 "\n -r Perform interactive repairs" \
1341 "\n -a Perform automatic repairs" \
1342 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001343 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001344 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001345 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001346
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001347#define ftpd_trivial_usage \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001348 "[-wvS] [-t N] [-T N] [DIR]"
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001349#define ftpd_full_usage "\n\n" \
Denys Vlasenkoae357bd2009-09-11 23:29:45 +02001350 "Anonymous FTP server\n" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001351 "\n" \
1352 "ftpd should be used as an inetd service.\n" \
1353 "ftpd's line for inetd.conf:\n" \
1354 " 21 stream tcp nowait root ftpd ftpd /files/to/serve\n" \
1355 "It also can be ran from tcpsvd:\n" \
1356 " tcpsvd -vE 0.0.0.0 21 ftpd /files/to/serve\n" \
1357 "\nOptions:" \
1358 "\n -w Allow upload" \
Denis Vlasenko4221e902009-03-11 15:07:44 +00001359 "\n -v Log to stderr" \
1360 "\n -S Log to syslog" \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001361 "\n -t,-T Idle and absolute timeouts" \
Denis Vlasenko92576712009-03-09 16:25:33 +00001362 "\n DIR Change root to this directory" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001363
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001364#define ftpget_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001365 "[OPTIONS] HOST [LOCAL_FILE] REMOTE_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001366#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001367 "Retrieve a remote file via FTP\n" \
1368 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001369 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001370 "\n -c,--continue Continue previous transfer" \
1371 "\n -v,--verbose Verbose" \
1372 "\n -u,--username Username" \
1373 "\n -p,--password Password" \
1374 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001375 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001376 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001377 "\n -c Continue previous transfer" \
1378 "\n -v Verbose" \
1379 "\n -u Username" \
1380 "\n -p Password" \
1381 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001382 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001383
1384#define ftpput_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001385 "[OPTIONS] HOST [REMOTE_FILE] LOCAL_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001386#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001387 "Store a local file on a remote machine via FTP\n" \
1388 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001389 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001390 "\n -v,--verbose Verbose" \
1391 "\n -u,--username Username" \
1392 "\n -p,--password Password" \
1393 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001394 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001395 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001396 "\n -v Verbose" \
1397 "\n -u Username" \
1398 "\n -p Password" \
1399 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001400 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001401
Rob Landleyaa872762005-10-28 13:05:12 +00001402#define fuser_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001403 "[OPTIONS] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001404#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001405 "Find processes which use FILEs or PORTs\n" \
1406 "\nOptions:" \
1407 "\n -m Find processes which use same fs as FILEs" \
1408 "\n -4 Search only IPv4 space" \
1409 "\n -6 Search only IPv6 space" \
1410 "\n -s Silent: just exit with 0 if any processes are found" \
1411 "\n -k Kill found processes (otherwise display PIDs)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001412 "\n -SIGNAL Signal to send (default: TERM)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001413
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001414#define getenforce_trivial_usage NOUSAGE_STR
1415#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001416
Eric Andersen7e9276b2001-02-22 01:15:47 +00001417#define getopt_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001418 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001419#define getopt_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001420 "Options:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001421 IF_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001422 "\n -a,--alternative Allow long options starting with single -" \
1423 "\n -l,--longoptions=longopts Long options to be recognized" \
1424 "\n -n,--name=progname The name under which errors are reported" \
1425 "\n -o,--options=optstring Short options to be recognized" \
1426 "\n -q,--quiet Disable error reporting by getopt(3)" \
1427 "\n -Q,--quiet-output No normal output" \
1428 "\n -s,--shell=shell Set shell quoting conventions" \
1429 "\n -T,--test Test for getopt(1) version" \
1430 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001431 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001432 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001433 "\n -a Allow long options starting with single -" \
1434 "\n -l longopts Long options to be recognized" \
1435 "\n -n progname The name under which errors are reported" \
1436 "\n -o optstring Short options to be recognized" \
1437 "\n -q Disable error reporting by getopt(3)" \
1438 "\n -Q No normal output" \
1439 "\n -s shell Set shell quoting conventions" \
1440 "\n -T Test for getopt(1) version" \
1441 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001442 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001443#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001444 "$ cat getopt.test\n" \
1445 "#!/bin/sh\n" \
1446 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1447 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001448 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001449 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001450 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001451 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001452 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1453 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001454 " -c|--c-long)\n" \
1455 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001456 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1457 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1458 " esac;;\n" \
1459 " --) shift; break;;\n" \
1460 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001461 " esac\n" \
1462 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001463
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001464#define getsebool_trivial_usage \
1465 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001466#define getsebool_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001467 " -a Show all SELinux booleans"
1468
Eric Andersenf349e972001-08-21 16:18:59 +00001469#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001470 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001471#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001472 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1473 "\nOptions:" \
1474 "\n -h Enable hardware (RTS/CTS) flow control" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001475 "\n -i Don't display /etc/issue before running login" \
1476 "\n -L Local line, don't do carrier detect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001477 "\n -m Get baud rate from modem's CONNECT status message" \
1478 "\n -w Wait for a CR or LF before sending /etc/issue" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001479 "\n -n Don't prompt the user for a login name" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02001480 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
1481 "\n -l LOGIN Invoke LOGIN instead of /bin/login" \
1482 "\n -t SEC Terminate after SEC if no username is read" \
1483 "\n -I INITSTR Send INITSTR before anything else" \
1484 "\n -H HOST Log HOST into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001485
Eric Andersen7e9276b2001-02-22 01:15:47 +00001486#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001487 "[-HhrilLnqvso" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001488 IF_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001489 "eF" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001490 IF_FEATURE_GREP_EGREP_ALIAS("E") \
1491 IF_FEATURE_GREP_CONTEXT("ABC") \
1492 IF_EXTRA_COMPAT("z") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001493 "] PATTERN [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001494#define grep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001495 "Search for PATTERN in each FILE or standard input\n" \
1496 "\nOptions:" \
1497 "\n -H Prefix output lines with filename where match was found" \
1498 "\n -h Suppress the prefixing filename on output" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001499 "\n -r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001500 "\n -i Ignore case distinctions" \
1501 "\n -l List names of files that match" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001502 "\n -L List names of files that don't match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001503 "\n -n Print line number with output lines" \
1504 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1505 "\n -v Select non-matching lines" \
1506 "\n -s Suppress file open/read error messages" \
1507 "\n -c Only print count of matching lines" \
1508 "\n -o Show only the part of a line that matches PATTERN" \
1509 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001510 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001511 "\n -w Match whole words only") \
1512 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001513 IF_FEATURE_GREP_EGREP_ALIAS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001514 "\n -E PATTERN is an extended regular expression") \
1515 "\n -e PTRN Pattern to match" \
1516 "\n -f FILE Read pattern from file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001517 IF_FEATURE_GREP_CONTEXT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001518 "\n -A Print NUM lines of trailing context" \
1519 "\n -B Print NUM lines of leading context" \
1520 "\n -C Print NUM lines of output context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001521 IF_EXTRA_COMPAT( \
Denis Vlasenko83518d12009-03-20 22:17:13 +00001522 "\n -z Input is NUL terminated") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001523
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001524#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001525 "$ grep root /etc/passwd\n" \
1526 "root:x:0:0:root:/root:/bin/bash\n" \
1527 "$ grep ^[rR]oo. /etc/passwd\n" \
1528 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001529
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001530#define egrep_trivial_usage NOUSAGE_STR
1531#define egrep_full_usage ""
1532
1533#define fgrep_trivial_usage NOUSAGE_STR
1534#define fgrep_full_usage ""
1535
Eric Andersen7e9276b2001-02-22 01:15:47 +00001536#define gunzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001537 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001538#define gunzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001539 "Uncompress FILEs (or standard input)\n" \
1540 "\nOptions:" \
1541 "\n -c Write to standard output" \
1542 "\n -f Force" \
1543 "\n -t Test file integrity" \
1544
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001545#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001546 "$ ls -la /tmp/BusyBox*\n" \
1547 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1548 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1549 "$ ls -la /tmp/BusyBox*\n" \
1550 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001551
1552#define gzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001553 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001554#define gzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001555 "Compress FILEs (or standard input)\n" \
1556 "\nOptions:" \
1557 "\n -c Write to standard output" \
1558 "\n -d Decompress" \
1559 "\n -f Force" \
1560
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001561#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001562 "$ ls -la /tmp/busybox*\n" \
1563 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1564 "$ gzip /tmp/busybox.tar\n" \
1565 "$ ls -la /tmp/busybox*\n" \
1566 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001567
1568#define halt_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001569 "[-d delay] [-n] [-f]" IF_FEATURE_WTMP(" [-w]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001570#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001571 "Halt the system\n" \
1572 "\nOptions:" \
1573 "\n -d Delay interval for halting" \
1574 "\n -n No call to sync()" \
1575 "\n -f Force halt (don't go through init)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001576 IF_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001577 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001578 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001579
Eric Andersen3443bd72003-07-22 07:30:36 +00001580#define hdparm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001581 "[OPTIONS] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001582#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001583 "Options:" \
1584 "\n -a Get/set fs readahead" \
1585 "\n -A Set drive read-lookahead flag (0/1)" \
1586 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1587 "\n -B Set Advanced Power Management setting (1-255)" \
1588 "\n -c Get/set IDE 32-bit IO setting" \
1589 "\n -C Check IDE power mode status" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001590 IF_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001591 "\n -d Get/set using_dma flag") \
1592 "\n -D Enable/disable drive defect-mgmt" \
1593 "\n -f Flush buffer cache for device on exit" \
1594 "\n -g Display drive geometry" \
1595 "\n -h Display terse usage information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001596 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001597 "\n -i Display drive identification") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001598 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001599 "\n -I Detailed/current information directly from drive") \
1600 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1601 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1602 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1603 "\n -m Get/set multiple sector count" \
1604 "\n -n Get/set ignore-write-errors flag (0/1)" \
1605 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1606 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001607/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001608 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1609 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001610 IF_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001611 "\n -R Register an IDE interface (DANGEROUS)") \
1612 "\n -S Set standby (spindown) timeout" \
1613 "\n -t Perform device read timings" \
1614 "\n -T Perform cache read timings" \
1615 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001616 IF_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001617 "\n -U Un-register an IDE interface (DANGEROUS)") \
1618 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1619 "\n -V Display program version and exit immediately" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001620 IF_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001621 "\n -w Perform device reset (DANGEROUS)") \
1622 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001623 IF_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001624 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1625 "\n -X Set IDE xfer mode (DANGEROUS)" \
1626 "\n -y Put IDE drive in standby mode" \
1627 "\n -Y Put IDE drive to sleep" \
1628 "\n -Z Disable Seagate auto-powersaving mode" \
1629 "\n -z Re-read partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001630
Eric Andersen7e9276b2001-02-22 01:15:47 +00001631#define head_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001632 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001633#define head_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02001634 "Print first 10 lines of each FILE (or standard input) to standard output.\n" \
1635 "With more than one FILE, precede each with a header giving the file name.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001636 "\nOptions:" \
1637 "\n -n NUM Print first NUM lines instead of first 10" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001638 IF_FEATURE_FANCY_HEAD( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001639 "\n -c NUM Output the first NUM bytes" \
1640 "\n -q Never output headers giving file names" \
1641 "\n -v Always output headers giving file names") \
1642
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001643#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001644 "$ head -n 2 /etc/passwd\n" \
1645 "root:x:0:0:root:/root:/bin/bash\n" \
1646 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001647
Glenn L McGrath60281112001-11-02 11:39:46 +00001648#define hexdump_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001649 "[-bcCdefnosvx" IF_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001650#define hexdump_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02001651 "Display FILEs or standard input in a user specified format\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001652 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001653 "\n -b One-byte octal display" \
1654 "\n -c One-byte character display" \
1655 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1656 "\n -d Two-byte decimal display" \
1657 "\n -e FORMAT STRING" \
1658 "\n -f FORMAT FILE" \
1659 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1660 "\n -o Two-byte octal display" \
1661 "\n -s OFFSET Skip OFFSET bytes" \
1662 "\n -v Display all input data" \
1663 "\n -x Two-byte hexadecimal display" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001664 IF_FEATURE_HEXDUMP_REVERSE( \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001665 "\n -R Reverse of 'hexdump -Cv'") \
1666
1667#define hd_trivial_usage \
1668 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001669#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001670 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001671
Eric Andersen7e9276b2001-02-22 01:15:47 +00001672#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001673 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001674#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001675 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001676
1677#define hostname_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001678 "[OPTIONS] [HOSTNAME | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001679#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001680 "Get or set hostname or DNS domain name\n" \
1681 "\nOptions:" \
1682 "\n -s Short" \
1683 "\n -i Addresses for the hostname" \
1684 "\n -d DNS domain name" \
1685 "\n -f Fully qualified domain name" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001686 "\n -F FILE Use FILE's content as hostname" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001687
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001688#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001689 "$ hostname\n" \
1690 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001691
Denys Vlasenkod30b89c2009-06-26 01:55:45 +02001692#define dnsdomainname_trivial_usage NOUSAGE_STR
1693#define dnsdomainname_full_usage ""
1694
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001695#define httpd_trivial_usage \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001696 "[-ifv[v]]" \
1697 " [-c CONFFILE]" \
1698 " [-p [IP:]PORT]" \
1699 IF_FEATURE_HTTPD_SETUID(" [-u USER[:GRP]]") \
1700 IF_FEATURE_HTTPD_BASIC_AUTH(" [-r REALM]") \
1701 " [-h HOME]\n" \
1702 "or httpd -d/-e" IF_FEATURE_HTTPD_AUTH_MD5("/-m") " STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001703#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001704 "Listen for incoming HTTP requests\n" \
1705 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001706 "\n -i Inetd mode" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001707 "\n -f Don't daemonize" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001708 "\n -v[v] Verbose" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001709 "\n -c FILE Configuration file (default httpd.conf)" \
1710 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001711 IF_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001712 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001713 IF_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001714 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001715 "\n -h HOME Home directory (default .)" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001716 IF_FEATURE_HTTPD_AUTH_MD5( \
1717 "\n -m STRING MD5 crypt STRING") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001718 "\n -e STRING HTML encode STRING" \
1719 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001720
Robert Griebl1cd04452002-07-21 16:50:49 +00001721#define hwclock_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001722 IF_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001723 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1724 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001725 " [-f FILE]" \
1726 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001727 IF_NOT_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001728 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1729 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001730#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001731 "Query and set hardware clock (RTC)\n" \
1732 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001733 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001734 "\n -s Set system time from hardware clock" \
1735 "\n -w Set hardware clock to system time" \
1736 "\n -u Hardware clock is in UTC" \
1737 "\n -l Hardware clock is in local time" \
1738 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001739
Eric Andersen7e9276b2001-02-22 01:15:47 +00001740#define id_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001741 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001742#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001743 "Print information about USER or the current user\n" \
1744 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001745 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001746 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001747 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001748 "\n -u Print user ID" \
Denis Vlasenko4f3209b2008-09-13 12:51:10 +00001749 "\n -g Print group ID" \
1750 "\n -G Print supplementary group IDs" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001751 "\n -n Print name instead of a number" \
1752 "\n -r Print real user ID instead of effective ID" \
1753
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001754#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001755 "$ id\n" \
1756 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001757
Eric Andersen7e9276b2001-02-22 01:15:47 +00001758#define ifconfig_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001759 IF_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001760#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001761 "Configure a network interface\n" \
1762 "\nOptions:" \
1763 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001764 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001765 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001766 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001767 " [del ADDRESS[/PREFIXLEN]]\n") \
1768 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1769 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001770 IF_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001771 " [outfill NN] [keepalive NN]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001772 " " IF_FEATURE_IFCONFIG_HW("[hw ether" IF_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001773 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001774 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001775 IF_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001776 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001777 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001778
Denis Vlasenko06aed432008-02-26 18:25:24 +00001779#define ifenslave_trivial_usage \
1780 "[-cdf] master-iface <slave-iface...>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001781#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001782 "Configure network interfaces for parallel routing\n" \
1783 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001784 "\n -c, --change-active Change active slave" \
1785 "\n -d, --detach Remove slave interface from bonding device" \
1786 "\n -f, --force Force, even if interface is not Ethernet" \
1787/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001788
Denis Vlasenko06aed432008-02-26 18:25:24 +00001789#define ifenslave_example_usage \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001790 "To create a bond device, simply follow these three steps:\n" \
1791 "- ensure that the required drivers are properly loaded:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001792 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001793 "- assign an IP address to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001794 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001795 "- attach all the interfaces you need to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001796 " # ifenslave bond0 eth0 eth1 eth2\n" \
1797 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1798 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001799 " To detach a dead interface without setting the bond device down:\n" \
1800 " # ifenslave -d bond0 eth1\n\n" \
1801 " To set the bond device down and automatically release all the slaves:\n" \
1802 " # ifconfig bond0 down\n\n" \
1803 " To change active slave:\n" \
1804 " # ifenslave -c bond0 eth0\n" \
1805
1806#define ifplugd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001807 "[OPTIONS]"
Denis Vlasenko71c16572009-04-26 01:08:51 +00001808#define ifplugd_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +02001809 "Network interface plug detection daemon\n" \
1810 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001811 "\n -n Don't daemonize" \
1812 "\n -s Don't log to syslog" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001813 "\n -i IFACE Interface" \
1814 "\n -f/-F Treat link detection error as link down/link up" \
1815 "\n (otherwise exit on error)" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001816 "\n -a Don't up interface automatically" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001817 "\n -M Monitor creation/destruction of interface" \
1818 "\n (otherwise it must exist)" \
1819 "\n -r PROG Script to run" \
1820 "\n -x ARG Extra argument for script" \
1821 "\n -I Don't exit on nonzero exit code from script" \
1822 "\n -p Don't run script on daemon startup" \
1823 "\n -q Don't run script on daemon quit" \
1824 "\n -l Run script on startup even if no cable is detected" \
1825 "\n -t SECS Poll time in seconds" \
1826 "\n -u SECS Delay before running script after link up" \
1827 "\n -d SECS Delay after link down" \
1828 "\n -m MODE API mode (mii, priv, ethtool, wlan, auto)" \
1829 "\n -k Kill running daemon" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001830
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001831#define ifup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001832 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001833#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001834 "Options:" \
1835 "\n -a De/configure all interfaces automatically" \
1836 "\n -i FILE Use FILE for interface definitions" \
1837 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001838 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001839 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001840 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001841 ) \
1842 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001843 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001844
1845#define ifdown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001846 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001847#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001848 "Options:" \
1849 "\n -a De/configure all interfaces automatically" \
1850 "\n -i FILE Use FILE for interface definitions" \
1851 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001852 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001853 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001854 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001855 ) \
1856 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001857 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001858
Glenn L McGrath06e95652003-02-09 06:51:14 +00001859#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001860 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001861#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001862 "Listen for network connections and launch programs\n" \
1863 "\nOptions:" \
1864 "\n -f Run in foreground" \
1865 "\n -e Log to stderr" \
1866 "\n -q N Socket listen queue (default: 128)" \
1867 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001868 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001869
Eric Andersen7e9276b2001-02-22 01:15:47 +00001870#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001871 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001872#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001873 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001874
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001875#define init_notes_usage \
1876"This version of init is designed to be run only by the kernel.\n" \
1877"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001878"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001879"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001880"runlevels, use sysvinit.\n" \
1881"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001882"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001883"it has the following default behavior:\n" \
1884"\n" \
1885" ::sysinit:/etc/init.d/rcS\n" \
1886" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001887" ::ctrlaltdel:/sbin/reboot\n" \
1888" ::shutdown:/sbin/swapoff -a\n" \
1889" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001890" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001891"\n" \
1892"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1893"\n" \
1894" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001895" tty3::askfirst:/bin/sh\n" \
1896" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001897"\n" \
1898"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1899"\n" \
1900" <id>:<runlevels>:<action>:<process>\n" \
1901"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001902" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001903"\n" \
1904" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1905" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001906" the specified process to run on. The contents of this field are\n" \
1907" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1908" be unique, although if it isn't you may have strange results. If this\n" \
1909" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001910" note that if BusyBox detects that a serial console is in use, then only\n" \
1911" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001912" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001913" stinkin' utmp.\n" \
1914"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001915" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001916"\n" \
1917" The runlevels field is completely ignored.\n" \
1918"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001919" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001920"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001921" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001922" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001923"\n" \
1924" The available actions can be classified into two groups: actions\n" \
1925" that are run only once, and actions that are re-run when the specified\n" \
1926" process exits.\n" \
1927"\n" \
1928" Run only-once actions:\n" \
1929"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001930" 'sysinit' is the first item run on boot. init waits until all\n" \
1931" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001932" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001933" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001934" the specified task completes. 'once' actions are asynchronous,\n" \
1935" therefore, init does not wait for them to complete. 'restart' is\n" \
1936" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001937" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001938" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001939" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001940" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001941" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001942" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001943" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001944" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001945"\n" \
1946" Run repeatedly actions:\n" \
1947"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001948" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001949" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001950" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1951" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001952" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001953" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001954" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001955" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001956"\n" \
1957" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001958" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001959" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001960"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001961" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001962"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001963" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001964"\n" \
1965"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001966"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001967" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001968" #\n" \
1969" ::sysinit:/etc/init.d/rcS\n" \
1970" \n" \
1971" # /bin/sh invocations on selected ttys\n" \
1972" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001973" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001974" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001975" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001976" tty2::askfirst:-/bin/sh\n" \
1977" tty3::askfirst:-/bin/sh\n" \
1978" tty4::askfirst:-/bin/sh\n" \
1979" \n" \
1980" # /sbin/getty invocations for selected ttys\n" \
1981" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001982" tty4::respawn:/sbin/getty 38400 tty4\n" \
1983" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001984" \n" \
1985" \n" \
1986" # Example of how to put a getty on a serial line (for a terminal)\n" \
1987" #\n" \
1988" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1989" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1990" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001991" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001992" #::respawn:/sbin/getty 57600 ttyS2\n" \
1993" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001994" # Stuff to do when restarting the init process\n" \
1995" ::restart:/sbin/init\n" \
1996" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001997" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001998" ::ctrlaltdel:/sbin/reboot\n" \
1999" ::shutdown:/bin/umount -a -r\n" \
2000" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002001
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002002#define inotifyd_trivial_usage \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002003 "PROG FILE1[:MASK] ..."
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002004#define inotifyd_full_usage "\n\n" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002005 "Run PROG on filesystem changes." \
2006 "\nWhen a filesystem event matching MASK occurs on FILEn," \
2007 "\nPROG <actual_event(s)> <FILEn> [<subfile_name>] is run." \
Denis Vlasenko289ff0e2008-11-14 21:52:16 +00002008 "\nEvents:" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002009 "\n a File is accessed" \
2010 "\n c File is modified" \
2011 "\n e Metadata changed" \
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02002012 "\n w Writable file is closed" \
2013 "\n 0 Unwritable file is closed" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002014 "\n r File is opened" \
Denis Vlasenkoa09a42c2008-11-17 22:19:18 +00002015 "\n D File is deleted" \
2016 "\n M File is moved" \
2017 "\n u Backing fs is unmounted" \
2018 "\n o Event queue overflowed" \
2019 "\n x File can't be watched anymore" \
2020 "\nIf watching a directory:" \
2021 "\n m Subfile is moved into dir" \
2022 "\n y Subfile is moved out of dir" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002023 "\n n Subfile is created" \
2024 "\n d Subfile is deleted" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002025 "\n" \
2026 "\ninotifyd waits for PROG to exit." \
2027 "\nWhen x event happens for all FILEs, inotifyd exits" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002028
Denis Vlasenko36309cf2008-11-22 18:29:01 +00002029/* 2.6 style insmod has no options and required filename
2030 * (not module name - .ko can't be omitted) */
Eric Andersen7e9276b2001-02-22 01:15:47 +00002031#define insmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002032 IF_FEATURE_2_4_MODULES("[OPTIONS] MODULE ") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002033 IF_NOT_FEATURE_2_4_MODULES("FILE ") \
Denis Vlasenko36309cf2008-11-22 18:29:01 +00002034 "[symbol=value]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002035#define insmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002036 "Load the specified kernel modules into the kernel" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002037 IF_FEATURE_2_4_MODULES( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002038 "\nOptions:" \
2039 "\n -f Force module to load into the wrong kernel version" \
2040 "\n -k Make module autoclean-able" \
2041 "\n -v Verbose" \
2042 "\n -q Quiet" \
2043 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002044 IF_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002045 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00002046 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002047 "\n -o NAME Set internal module name to NAME" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002048 "\n -x Don't export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00002049 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00002050
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002051/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00002052#define install_trivial_usage \
Denis Vlasenko4acdb462009-01-31 21:45:57 +00002053 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [source] dest|directory"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002054#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002055 "Copy files and set attributes\n" \
2056 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002057 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002058 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002059 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002060 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002061 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002062 "\n -o USER Set ownership" \
2063 "\n -g GRP Set group ownership" \
2064 "\n -m MODE Set permissions" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002065 IF_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002066 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002067 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002068
Denis Vlasenko4acdb462009-01-31 21:45:57 +00002069#define ionice_trivial_usage \
2070 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
2071#define ionice_full_usage "\n\n" \
2072 "Change I/O scheduling class and priority\n" \
2073 "\nOptions:" \
2074 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
2075 "\n -n Priority" \
2076
Denis Vlasenko397de612008-03-17 08:55:44 +00002077/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002078#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00002079 "[OPTIONS] {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002080 IF_FEATURE_IP_ADDRESS("address | ") \
2081 IF_FEATURE_IP_ROUTE("route | ") \
2082 IF_FEATURE_IP_LINK("link | ") \
2083 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2084 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002085 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002086#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002087 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002088 "where OBJECT := {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002089 IF_FEATURE_IP_ADDRESS("address | ") \
2090 IF_FEATURE_IP_ROUTE("route | ") \
2091 IF_FEATURE_IP_LINK("link | ") \
2092 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2093 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002094 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002095 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002096
2097#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002098 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002099 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002100#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002101 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002102 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
2103 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002104 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002105 " [broadcast ADDR] [anycast ADDR]\n" \
2106 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002107 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002108
Eric Andersende4f07e2003-12-11 01:18:07 +00002109#define ipcalc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002110 "[OPTIONS] ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002111#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002112 "Calculate IP network settings from a IP address\n" \
2113 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002114 IF_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002115 "\n -b,--broadcast Display calculated broadcast address" \
2116 "\n -n,--network Display calculated network address" \
2117 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002118 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002119 "\n -p,--prefix Display the prefix for IP/NETMASK" \
2120 "\n -h,--hostname Display first resolved host name" \
2121 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002122 ) \
2123 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002124 IF_NOT_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002125 "\n -b Display calculated broadcast address" \
2126 "\n -n Display calculated network address" \
2127 "\n -m Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002128 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002129 "\n -p Display the prefix for IP/NETMASK" \
2130 "\n -h Display first resolved host name" \
2131 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002132 ) \
2133 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00002134
Rob Landley6eb1e412005-06-20 04:30:36 +00002135#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002136 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002137#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002138 "Upper-case options MQS remove an object by shmkey value.\n" \
2139 "Lower-case options remove an object by shmid value.\n" \
2140 "\nOptions:" \
2141 "\n -mM Remove memory segment after last detach" \
2142 "\n -qQ Remove message queue" \
2143 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002144
2145#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002146 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002147#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002148 " -i Show specific resource" \
2149 "\nResource specification:" \
2150 "\n -m Shared memory segments" \
2151 "\n -q Message queues" \
2152 "\n -s Semaphore arrays" \
2153 "\n -a All (default)" \
2154 "\nOutput format:" \
2155 "\n -t Time" \
2156 "\n -c Creator" \
2157 "\n -p Pid" \
2158 "\n -l Limits" \
2159 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002160
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002161#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002162 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002163#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00002164 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002165 " dynamic { on | off } |\n" \
2166 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002167 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002168
2169#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002170 "{ list | flush | { add | del | change | append |\n" \
2171 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002172#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002173 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002174 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
2175 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002176 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002177 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00002178 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
2179 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002180
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002181#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002182 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002183#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002184 "iprule [list | add | del] SELECTOR ACTION\n" \
2185 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2186 " [dev STRING] [pref NUMBER]\n" \
2187 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2188 " [prohibit | reject | unreachable]\n" \
2189 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002190 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002191
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002192#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002193 "{ add | change | del | show } [NAME]\n" \
2194 " [mode { ipip | gre | sit }]\n" \
2195 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002196#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002197 "iptunnel { add | change | del | show } [NAME]\n" \
2198 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2199 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002200 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002201
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002202#define kbd_mode_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002203 "[-a|k|s|u] [-C TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002204#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002205 "Report or set the keyboard mode\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002206 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002207 "\n -a Default (ASCII)" \
2208 "\n -k Medium-raw (keyboard)" \
2209 "\n -s Raw (scancode)" \
2210 "\n -u Unicode (utf-8)" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002211 "\n -C TTY Affect TTY instead of /dev/tty" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002212
Eric Andersen7e9276b2001-02-22 01:15:47 +00002213#define kill_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002214 "[-l] [-SIG] PID..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002215#define kill_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002216 "Send a signal (default: TERM) to given PIDs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002217 "\nOptions:" \
2218 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002219/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002220
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002221#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002222 "$ ps | grep apache\n" \
2223 "252 root root S [apache]\n" \
2224 "263 www-data www-data S [apache]\n" \
2225 "264 www-data www-data S [apache]\n" \
2226 "265 www-data www-data S [apache]\n" \
2227 "266 www-data www-data S [apache]\n" \
2228 "267 www-data www-data S [apache]\n" \
2229 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002230
2231#define killall_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002232 "[-l] [-q] [-SIG] process-name..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002233#define killall_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002234 "Send a signal (default: TERM) to given processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002235 "\nOptions:" \
2236 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002237/* "\n -s SIG Yet another way of specifying SIG" */ \
Denys Vlasenko07697852009-10-06 21:11:37 +02002238 "\n -q Don't complain if no processes were killed" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002239
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002240#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002241 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002242
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002243#define killall5_trivial_usage \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002244 "[-l] [-SIG] [-o PID]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002245#define killall5_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002246 "Send a signal (default: TERM) to all processes outside current session\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002247 "\nOptions:" \
2248 "\n -l List all signal names and numbers" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002249 "\n -o PID Don't signal this PID" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002250/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002251
Mark Whitley6317c4b2001-03-12 22:51:50 +00002252#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002253 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002254#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002255 "Kernel logger\n" \
2256 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002257 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002258 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002259
Eric Andersen7e9276b2001-02-22 01:15:47 +00002260#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002261 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002262#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002263 "Print STRING's length"
2264
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002265#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002266 "$ length Hello\n" \
2267 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002268
Rob Landley9200e792005-09-15 19:26:59 +00002269#define less_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002270 "[-EMNmh~I?] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002271#define less_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002272 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002273 "changed, and files can be manipulated in various ways.\n" \
2274 "\nOptions:" \
2275 "\n -E Quit once the end of a file is reached" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002276 "\n -M,-m Display status line with line numbers" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002277 "\n and percentage through the file" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002278 "\n -N Prefix line number to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002279 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002280 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002281
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002282#define linux32_trivial_usage NOUSAGE_STR
2283#define linux32_full_usage ""
2284#define linux64_trivial_usage NOUSAGE_STR
2285#define linux64_full_usage ""
2286
2287#define linuxrc_trivial_usage NOUSAGE_STR
2288#define linuxrc_full_usage ""
2289
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002290#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002291 "personality program [args...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002292#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002293 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002294 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002295 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002296
Eric Andersen7e9276b2001-02-22 01:15:47 +00002297#define ln_trivial_usage \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02002298 "[OPTIONS] TARGET... LINK|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002299#define ln_full_usage "\n\n" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02002300 "Create a link LINK or DIRECTORY/TARGET to the specified TARGET(s)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002301 "\nOptions:" \
2302 "\n -s Make symlinks instead of hardlinks" \
2303 "\n -f Remove existing destination files" \
2304 "\n -n Don't dereference symlinks - treat like normal file" \
2305 "\n -b Make a backup of the target (if exists) before link operation" \
2306 "\n -S suf Use suffix instead of ~ when making backup files" \
2307
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002308#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002309 "$ ln -s BusyBox /tmp/ls\n" \
2310 "$ ls -l /tmp/ls\n" \
2311 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002312
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002313#define load_policy_trivial_usage NOUSAGE_STR
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002314#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002315
Eric Andersen7e9276b2001-02-22 01:15:47 +00002316#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002317 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002318#define loadfont_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002319 "Load a console font from standard input" \
2320/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2321
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002322#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002323 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002324
2325#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002326 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002327#define loadkmap_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002328 "Load a binary keyboard translation table from standard input\n" \
2329/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2330
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002331#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002332 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002333
2334#define logger_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002335 "[OPTIONS] [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002336#define logger_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002337 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n" \
2338 "\nOptions:" \
2339 "\n -s Log to stderr as well as the system log" \
2340 "\n -t TAG Log using the specified tag (defaults to user name)" \
2341 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002342
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002343#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002344 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002345
Robert Griebl1fca5582002-06-04 20:45:46 +00002346#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002347 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002348#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002349 "Begin a new session on the system\n" \
2350 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002351 "\n -f Don't authenticate (user already authenticated)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002352 "\n -h Name of the remote host" \
2353 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002354
Eric Andersen7e9276b2001-02-22 01:15:47 +00002355#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002356 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002357#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002358 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002359#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002360 "$ logname\n" \
2361 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002362
Mark Whitley6317c4b2001-03-12 22:51:50 +00002363#define logread_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002364 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002365#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002366 "Show messages in syslogd's circular buffer\n" \
2367 "\nOptions:" \
2368 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002369
Matt Kraai83788da2002-03-20 17:38:37 +00002370#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002371 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2372 " losetup -d LOOPDEV - disassociate\n" \
2373 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002374#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002375 "Options:" \
2376 "\n -o OFS Start OFS bytes into FILE" \
2377 "\n -f Show first free loop device" \
2378
Rob Landley1d589b22005-11-29 23:47:10 +00002379#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002380 "No arguments will display all current associations.\n" \
2381 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002382 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002383 "and filename of the file the loop device is currently bound to.\n\n" \
2384 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002385 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2386 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002387
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002388#define lpd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002389 "SPOOLDIR [HELPER [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002390#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002391 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2392 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002393 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002394 "\ndirectory and HELPER program is called. Name of file to print" \
2395 "\nis passed in $DATAFILE variable." \
2396 "\nExample:" \
2397 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002398
Denis Vlasenko68444b92008-02-22 22:24:48 +00002399#define lpq_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002400 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID...] [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002401#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002402 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002403 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002404 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002405 "\n -f Force any waiting job to be printed" \
2406 "\n -s Short display" \
2407
2408#define lpr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002409 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE]..."
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002410/* -C CLASS exists too, not shown.
2411 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002412#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002413 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002414 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002415 "\n -m Send mail on completion" \
2416 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002417 "\n -V Verbose" \
2418
Eric Andersen7e9276b2001-02-22 01:15:47 +00002419#define ls_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002420 "[-1Aa" IF_FEATURE_LS_TIMESTAMPS("c") "Cd" \
2421 IF_FEATURE_LS_TIMESTAMPS("e") IF_FEATURE_LS_FILETYPES("F") "iln" \
2422 IF_FEATURE_LS_FILETYPES("p") IF_FEATURE_LS_FOLLOWLINKS("L") \
2423 IF_FEATURE_LS_RECURSIVE("R") IF_FEATURE_LS_SORTFILES("rS") "s" \
2424 IF_FEATURE_AUTOWIDTH("T") IF_FEATURE_LS_TIMESTAMPS("tu") \
2425 IF_FEATURE_LS_SORTFILES("v") IF_FEATURE_AUTOWIDTH("w") "x" \
2426 IF_FEATURE_LS_SORTFILES("X") IF_FEATURE_HUMAN_READABLE("h") "k" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002427 IF_SELINUX("K") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002428#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002429 "List directory contents\n" \
2430 "\nOptions:" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002431 "\n -1 List in a single column" \
2432 "\n -A Don't list . and .." \
2433 "\n -a Don't hide entries starting with ." \
2434 "\n -C List by columns" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002435 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002436 "\n -c With -l: sort by ctime") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002437 IF_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002438 "\n --color[={always,never,auto}] Control coloring") \
2439 "\n -d List directory entries instead of contents" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002440 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002441 "\n -e List full date and time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002442 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002443 "\n -F Append indicator (one of */=@|) to entries") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002444 "\n -i List inode numbers" \
2445 "\n -l Long listing format" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002446 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002447 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002448 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002449 IF_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002450 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002451 IF_FEATURE_LS_RECURSIVE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002452 "\n -R List subdirectories recursively") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002453 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002454 "\n -r Sort in reverse order") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002455 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002456 "\n -S Sort by file size") \
Denis Vlasenko397de612008-03-17 08:55:44 +00002457 "\n -s List the size of each file, in blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002458 IF_FEATURE_AUTOWIDTH( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002459 "\n -T NUM Assume tabstop every NUM columns") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002460 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002461 "\n -t With -l: sort by modification time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002462 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002463 "\n -u With -l: sort by access time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002464 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002465 "\n -v Sort by version") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002466 IF_FEATURE_AUTOWIDTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002467 "\n -w NUM Assume the terminal is NUM columns wide") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002468 "\n -x List by lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002469 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002470 "\n -X Sort by extension") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002471 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002472 "\n -h List sizes in human readable format (1K 243M 2G)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002473 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002474 "\n -k List security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002475 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002476 "\n -K List security context in long format") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002477 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002478 "\n -Z List security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002479
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002480#define lsattr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002481 "[-Radlv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002482#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002483 "List file attributes on an ext2 fs\n" \
2484 "\nOptions:" \
2485 "\n -R Recursively list subdirectories" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002486 "\n -a Don't hide entries starting with ." \
Denis Vlasenko397de612008-03-17 08:55:44 +00002487 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002488 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002489 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002490
Eric Andersen7e9276b2001-02-22 01:15:47 +00002491#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002492 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002493#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002494 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002495
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002496#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002497#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002498 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002499#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002500 "Create a range of block or character special files" \
2501 "\n" \
2502 "\nTYPE is:" \
2503 "\n b Block device" \
2504 "\n c Character device" \
2505 "\n f FIFO, MAJOR and MINOR are ignored" \
2506 "\n" \
2507 "\nFIRST..LAST specify numbers appended to NAME." \
2508 "\nIf 's' is the last argument, the base device is created as well." \
2509 "\n" \
2510 "\nExamples:" \
2511 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2512 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002513#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002514 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2515 "[creates ttyS2-ttyS63]\n" \
2516 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2517 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002518#endif
2519
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002520#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002521#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002522 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002523#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002524 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002525 "Device table entries take the form of:\n" \
2526 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002527 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002528 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002529 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002530 " c Character device\n" \
2531 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002532 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002533 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002534 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2535 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002536#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002537 "For example:\n" \
2538 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2539 "/dev d 755 0 0 - - - - -\n" \
2540 "/dev/console c 666 0 0 5 1 - - -\n" \
2541 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2542 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2543 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2544 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2545 "Will Produce:\n" \
2546 "/dev\n" \
2547 "/dev/console\n" \
2548 "/dev/null\n" \
2549 "/dev/zero\n" \
2550 "/dev/hda\n" \
2551 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002552#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002553
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002554#define makemime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002555 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002556#define makemime_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002557 "Create multipart MIME-encoded message from FILEs\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002558/* "Transfer encoding is base64, disposition is inline (not attachment)\n" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002559 "\nOptions:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002560 "\n -o FILE Output. Default: stdout" \
2561 "\n -a HDR Add header. Examples:" \
2562 "\n \"From: user@host.org\", \"Date: `date -R`\"" \
2563 "\n -c CT Content type. Default: text/plain" \
2564 "\n -C CS Charset. Default: " CONFIG_FEATURE_MIME_CHARSET \
2565/* "\n -e ENC Transfer encoding. Ignored. base64 is assumed" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002566 "\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002567 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002568
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002569#define man_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002570 "[OPTIONS] [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002571#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002572 "Format and display manual page\n" \
2573 "\nOptions:" \
2574 "\n -a Display all pages" \
2575 "\n -w Show page locations" \
2576
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002577#define matchpathcon_trivial_usage \
2578 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002579#define matchpathcon_full_usage "\n\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002580 " -n Don't display path" \
2581 "\n -N Don't use translations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002582 "\n -f Use alternate file_context file" \
2583 "\n -p Use prefix to speed translations" \
2584 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002585
Eric Andersen7e9276b2001-02-22 01:15:47 +00002586#define md5sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002587 "[OPTIONS] [FILE]..." \
2588 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTIONS] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002589#define md5sum_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002590 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2591 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002592 "\nOptions:" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002593 "\n -c Check sums against given list" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002594 "\n -s Don't output anything, status code shows success" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002595 "\n -w Warn about improperly formatted checksum lines" \
2596 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002597
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002598#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002599 "$ md5sum < busybox\n" \
2600 "6fd11e98b98a58f64ff3398d7b324003\n" \
2601 "$ md5sum busybox\n" \
2602 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2603 "$ md5sum -c -\n" \
2604 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2605 "busybox: OK\n" \
2606 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002607
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002608#define sha1sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002609 "[OPTIONS] [FILE]..." \
2610 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002611#define sha1sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002612 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002613 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002614 "\nOptions:" \
2615 "\n -c Check sums against given list" \
2616 "\n -s Don't output anything, status code shows success" \
2617 "\n -w Warn about improperly formatted checksum lines" \
2618 )
2619
2620#define sha256sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002621 "[OPTIONS] [FILE]..." \
2622 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha256sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002623#define sha256sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002624 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA256 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002625 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002626 "\nOptions:" \
2627 "\n -c Check sums against given list" \
2628 "\n -s Don't output anything, status code shows success" \
2629 "\n -w Warn about improperly formatted checksum lines" \
2630 )
2631
2632#define sha512sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002633 "[OPTIONS] [FILE]..." \
2634 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha512sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002635#define sha512sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002636 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA512 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002637 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002638 "\nOptions:" \
2639 "\n -c Check sums against given list" \
2640 "\n -s Don't output anything, status code shows success" \
2641 "\n -w Warn about improperly formatted checksum lines" \
2642 )
2643
Rob Landley70f7ef72005-12-13 08:21:33 +00002644#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002645 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002646#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002647 " -s Scan /sys and populate /dev during system boot\n" \
2648 "\n" \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002649 "It can be run by kernel as a hotplug helper. To activate it:\n" \
2650 " echo /bin/mdev >/proc/sys/kernel/hotplug\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002651 IF_FEATURE_MDEV_CONF( \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002652 "It uses /etc/mdev.conf with lines\n" \
Denis Vlasenkof2b39e02009-04-13 23:18:52 +00002653 "[-]DEVNAME UID:GID PERM" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002654 IF_FEATURE_MDEV_RENAME(" [>|=PATH]") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002655 IF_FEATURE_MDEV_EXEC(" [@|$|*PROG]") \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002656 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002657
Rob Landleyef10d522006-06-26 14:11:33 +00002658#define mdev_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002659 IF_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002660 "The mdev config file contains lines that look like:\n" \
2661 " hd[a-z][0-9]* 0:3 660\n\n" \
2662 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002663 IF_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002664 "Optionally, that can be followed (on the same line) by a special character\n" \
2665 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002666 "device(s). The environment variable $MDEV indicates the active device node\n" \
2667 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002668 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2669 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002670 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002671 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002672 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002673 "Config file parsing stops on the first matching line. If no config\n" \
2674 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002675 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002676 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002677
Glenn L McGrath061c9002002-09-16 04:21:46 +00002678#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002679 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002680#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002681 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002682 " y Allow write access to your terminal\n" \
2683 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002684
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002685#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002686 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002687#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002688 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2689 "\nOptions:" \
2690 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2691 "\n next byte to it" \
2692 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2693 "\n -s Set serial line to SPEED" \
2694 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002695
Eric Andersen7e9276b2001-02-22 01:15:47 +00002696#define mkdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002697 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002698#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002699 "Create DIRECTORY\n" \
2700 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002701 "\n -m Mode" \
2702 "\n -p No error if exists; make parent directories as needed" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002703 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002704 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002705 )
2706
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002707#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002708 "$ mkdir /tmp/foo\n" \
2709 "$ mkdir /tmp/foo\n" \
2710 "/tmp/foo: File exists\n" \
2711 "$ mkdir /tmp/foo/bar/baz\n" \
2712 "/tmp/foo/bar/baz: No such file or directory\n" \
2713 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002714
Eric Andersen7e9276b2001-02-22 01:15:47 +00002715#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002716 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002717#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002718 "Create named pipe (identical to 'mknod name p')\n" \
2719 "\nOptions:" \
2720 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002721 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002722 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002723 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002724
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002725#define mkfs_ext2_trivial_usage \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002726 "[-Fn] " \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002727 /* "[-c|-l filename] " */ \
2728 "[-b BLK_SIZE] " \
2729 /* "[-f fragment-size] [-g blocks-per-group] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002730 "[-i INODE_RATIO] [-I INODE_SIZE] " \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002731 /* "[-j] [-J journal-options] [-N number-of-inodes] " */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002732 "[-m RESERVED_PERCENT] " \
2733 /* "[-o creator-os] [-O feature[,...]] [-q] " */ \
2734 /* "[r fs-revision-level] [-E extended-options] [-v] [-F] " */ \
2735 "[-L LABEL] " \
2736 /* "[-M last-mounted-directory] [-S] [-T filesystem-type] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002737 "BLOCKDEV [KBYTES]"
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002738#define mkfs_ext2_full_usage "\n" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002739 "\n -b BLK_SIZE Block size, bytes" \
2740/* "\n -c Check device for bad blocks" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002741/* "\n -E opts Set extended options" */ \
2742/* "\n -f size Fragment size in bytes" */ \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002743 "\n -F Force" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002744/* "\n -g num Number of blocks in a block group" */ \
Denys Vlasenko838e07a2009-10-22 12:15:33 +02002745 "\n -i RATIO Max number of files is filesystem_size / RATIO" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002746 "\n -I BYTES Inode size (min 128)" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002747/* "\n -j Create a journal (ext3)" */ \
2748/* "\n -J opts Set journal options (size/device)" */ \
2749/* "\n -l file Read bad blocks list from file" */ \
Denys Vlasenko6a8cfdc2009-10-17 23:41:15 +02002750 "\n -L LBL Volume label" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002751 "\n -m PERCENT Percent of blocks to reserve for admin" \
2752/* "\n -M dir Set last mounted directory" */ \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002753 "\n -n Dry run" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002754/* "\n -N num Number of inodes to create" */ \
2755/* "\n -o os Set the 'creator os' field" */ \
2756/* "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" */ \
2757/* "\n -q Quiet" */ \
2758/* "\n -r rev Set filesystem revision" */ \
2759/* "\n -S Write superblock and group descriptors only" */ \
2760/* "\n -T fs-type Set usage type (news/largefile/largefile4)" */ \
2761/* "\n -v Verbose" */ \
2762
Eric Andersen7e9276b2001-02-22 01:15:47 +00002763#define mkfs_minix_trivial_usage \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002764 "[-c | -l filename] [-nXX] [-iXX] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002765#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002766 "Make a MINIX filesystem\n" \
2767 "\nOptions:" \
2768 "\n -c Check device for bad blocks" \
2769 "\n -n [14|30] Maximum length of filenames" \
2770 "\n -i INODES Number of inodes for the filesystem" \
2771 "\n -l FILENAME Read bad blocks list from FILENAME" \
2772 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002773
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002774#define mkfs_vfat_trivial_usage \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002775 "[-v] [-n LABEL] BLOCKDEV [KBYTES]"
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002776/* Accepted but ignored:
2777 "[-c] [-C] [-I] [-l bad-block-file] [-b backup-boot-sector] "
2778 "[-m boot-msg-file] [-i volume-id] "
2779 "[-s sectors-per-cluster] [-S logical-sector-size] [-f number-of-FATs] "
2780 "[-h hidden-sectors] [-F fat-size] [-r root-dir-entries] [-R reserved-sectors] "
2781*/
2782#define mkfs_vfat_full_usage "\n\n" \
2783 "Make a FAT32 filesystem\n" \
2784 "\nOptions:" \
2785/* "\n -c Check device for bad blocks" */ \
2786 "\n -v Verbose" \
2787/* "\n -I Allow to use entire disk device (e.g. /dev/hda)" */ \
2788 "\n -n LBL Volume label" \
2789
Eric Andersen7e9276b2001-02-22 01:15:47 +00002790#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002791 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002792#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002793 "Create a special file (block, character, or pipe)\n" \
2794 "\nOptions:" \
2795 "\n -m Create the special file using the specified mode (default a=rw)" \
2796 "\nTYPEs include:" \
2797 "\n b: Make a block device" \
2798 "\n c or u: Make a character device" \
2799 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002800 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002801 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002802 )
2803
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002804#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002805 "$ mknod /dev/fd0 b 2 0\n" \
2806 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002807
Eric Andersen7e9276b2001-02-22 01:15:47 +00002808#define mkswap_trivial_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002809 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002810#define mkswap_full_usage "\n\n" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002811 "Prepare block device to be used as swap partition"
2812#if 0
2813 "[-c] [-v0|-v1] DEVICE [BLOCKS]"
Denis Vlasenko397de612008-03-17 08:55:44 +00002814 "\nOptions:"
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002815 "\n -c Check for readability"
2816 "\n -v0 Make swap version 0 (max 128M)"
2817 "\n -v1 Make swap version 1 (default for kernels > 2.1.117)"
2818 "\n BLOCKS Number of blocks to use (default is entire partition)"
2819#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002820
Eric Andersen7e9276b2001-02-22 01:15:47 +00002821#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002822 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002823#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002824 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002825 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002826 "\nOptions:" \
2827 "\n -d Make a directory instead of a file" \
2828/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2829 "\n -t Generate a path rooted in temporary directory" \
2830 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2831 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002832 "\nFor -t or -p, directory is chosen as follows:" \
2833 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002834
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002835#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002836 "$ mktemp /tmp/temp.XXXXXX\n" \
2837 "/tmp/temp.mWiLjM\n" \
2838 "$ ls -la /tmp/temp.mWiLjM\n" \
2839 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002840
Eric Andersen8d79ce82001-07-22 23:00:15 +00002841#define modprobe_trivial_usage \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002842 IF_MODPROBE_SMALL("[-qfwrsv] MODULE [symbol=value...]") \
2843 IF_NOT_MODPROBE_SMALL("[-" \
2844 IF_FEATURE_2_4_MODULES("k")"nqrsv" \
2845 IF_FEATURE_MODPROBE_BLACKLIST("b")"] MODULE [symbol=value...]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002846#define modprobe_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002847 "Options:" \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002848 IF_MODPROBE_SMALL( \
2849 "\n -q Quiet" \
2850 "\n -f Force" \
2851 "\n -w Wait for unload" \
2852 "\n -r Remove module (stacks) or do autoclean" \
2853 "\n -s Report via syslog instead of stderr" \
2854 "\n -v Verbose" \
2855 ) \
2856 IF_NOT_MODPROBE_SMALL( \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002857 IF_FEATURE_2_4_MODULES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002858 "\n -k Make module autoclean-able" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002859 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002860 "\n -n Dry run" \
2861 "\n -q Quiet" \
2862 "\n -r Remove module (stacks) or do autoclean" \
2863 "\n -s Report via syslog instead of stderr" \
2864 "\n -v Verbose" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002865 IF_FEATURE_MODPROBE_BLACKLIST( \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002866 "\n -b Apply blacklist to module names too" \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002867 ) \
2868 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002869
Rob Landley9c32a152005-12-11 20:12:24 +00002870#define modprobe_notes_usage \
2871"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2872"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2873"pass each module it loads.\n" \
2874"\n" \
Bernhard Reutner-Fischer12aca792009-02-24 10:03:22 +00002875"The configuration file is searched (in this order):\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002876"\n" \
2877" /etc/modprobe.conf (2.6 only)\n" \
2878" /etc/modules.conf\n" \
2879" /etc/conf.modules (deprecated)\n" \
2880"\n" \
2881"They all have the same syntax (see below). If none is present, it is\n" \
2882"_not_ an error; each loaded module is then expected to load without\n" \
2883"options. Once a file is found, the others are tested for.\n" \
2884"\n" \
2885"/etc/modules.conf entry format:\n" \
2886"\n" \
2887" alias <alias_name> <mod_name>\n" \
2888" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002889" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002890" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2891" This makes it also possible to use a different set of options (below) for\n" \
2892" the module and the alias.\n" \
2893" A module can be aliased more than once.\n" \
2894"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002895" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002896" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2897" the \"symbol=value\" pairs as option to that module.\n" \
2898"\n" \
2899"Sample /etc/modules.conf file:\n" \
2900"\n" \
2901" options tulip irq=3\n" \
2902" alias tulip tulip2\n" \
2903" options tulip2 irq=4 io=0x308\n" \
2904"\n" \
2905"Other functionality offered by 'classic' modprobe is not available in\n" \
2906"this implementation.\n" \
2907"\n" \
2908"If module options are present both in the config file, and on the command line,\n" \
2909"then the options from the command line will be passed to the module _after_\n" \
2910"the options from the config file. That way, you can have defaults in the config\n" \
2911"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002912#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002913 "(with the above /etc/modules.conf):\n\n" \
2914 "$ modprobe tulip\n" \
2915 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2916 "$ modprobe tulip irq=5\n" \
2917 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2918 "$ modprobe tulip2\n" \
2919 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2920 " which are the default for alias 'tulip2'\n\n" \
2921 "$ modprobe tulip2 irq=8\n" \
2922 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2923 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2924 " from the command line\n\n" \
2925 "$ modprobe tulip2 irq=2 io=0x210\n" \
2926 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2927 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2928 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002929
Eric Andersen7e9276b2001-02-22 01:15:47 +00002930#define more_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002931 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002932#define more_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002933 "View FILE or standard input one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002934
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002935#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002936 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002937
Eric Andersen7e9276b2001-02-22 01:15:47 +00002938#define mount_trivial_usage \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002939 "[flags] DEVICE NODE [-o OPT,OPT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002940#define mount_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002941 "Mount a filesystem. Filesystem autodetection requires /proc.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002942 "\nOptions:" \
2943 "\n -a Mount all filesystems in fstab" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002944 IF_FEATURE_MOUNT_FAKE( \
2945 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002946 "\n -f Update /etc/mtab, but don't mount" \
2947 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002948 IF_NOT_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002949 "\n -f Dry run" \
2950 ) \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002951 ) \
Denys Vlasenkoe2e4cc22009-06-19 11:48:29 +02002952 IF_FEATURE_MOUNT_HELPERS( \
2953 "\n -i Don't run mount helper" \
2954 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002955 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002956 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002957 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002958 "\n -r Read-only mount" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002959 "\n -w Read-write mount (default)" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002960 "\n -t FSTYPE Filesystem type" \
2961 "\n -O OPT Mount only filesystems with option OPT (-a only)" \
2962 "\n-o OPT:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002963 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002964 "\n loop Ignored (loop devices are autodetected)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002965 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002966 IF_FEATURE_MOUNT_FLAGS( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002967 "\n [a]sync Writes are [a]synchronous" \
2968 "\n [no]atime Disable/enable updates to inode access times" \
2969 "\n [no]diratime Disable/enable atime updates to directories" \
2970 "\n [no]relatime Disable/enable atime updates relative to modification time" \
2971 "\n [no]dev (Dis)allow use of special device files" \
2972 "\n [no]exec (Dis)allow use of executable files" \
2973 "\n [no]suid (Dis)allow set-user-id-root programs" \
2974 "\n [r]shared Convert [recursively] to a shared subtree" \
2975 "\n [r]slave Convert [recursively] to a slave subtree" \
2976 "\n [r]private Convert [recursively] to a private subtree" \
2977 "\n [un]bindable Make mount point [un]able to be bind mounted" \
2978 "\n bind Bind a directory to an additional location" \
2979 "\n move Relocate an existing mount point" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002980 ) \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002981 "\n remount Remount a mounted filesystem, changing its flags" \
2982 "\n ro/rw Read-only/read-write mount" \
2983 "\n" \
2984 "\nThere are EVEN MORE flags that are specific to each filesystem" \
2985 "\nYou'll have to see the written documentation for those filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002986
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002987#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002988 "$ mount\n" \
2989 "/dev/hda3 on / type minix (rw)\n" \
2990 "proc on /proc type proc (rw)\n" \
2991 "devpts on /dev/pts type devpts (rw)\n" \
2992 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2993 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2994 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002995#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002996 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002997
Rob Landleyd00b3a52005-08-20 05:07:08 +00002998#define mountpoint_trivial_usage \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002999 "[-q] <[-dn] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003000#define mountpoint_full_usage "\n\n" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003001 "Check if the directory is a mountpoint\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003002 "\nOptions:" \
3003 "\n -q Quiet" \
3004 "\n -d Print major/minor device number of the filesystem" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003005 "\n -n Print device name of the filesystem" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003006 "\n -x Print major/minor device number of the blockdevice" \
3007
Rob Landleyd00b3a52005-08-20 05:07:08 +00003008#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003009 "$ mountpoint /proc\n" \
3010 "/proc is not a mountpoint\n" \
3011 "$ mountpoint /sys\n" \
3012 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00003013
Eric Andersen7e9276b2001-02-22 01:15:47 +00003014#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003015 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003016#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003017 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003018 "\n" \
3019 "Available Opcodes:\n" \
3020 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003021 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
3022 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
3023 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003024 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003025
Eric Andersen7e9276b2001-02-22 01:15:47 +00003026#define mv_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003027 "[OPTIONS] SOURCE DEST\n" \
3028 "or: mv [OPTIONS] SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003029#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003030 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
3031 "\nOptions:" \
3032 "\n -f Don't prompt before overwriting" \
3033 "\n -i Interactive, prompt before overwrite" \
3034
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003035#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003036 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003037
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003038#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003039 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003040#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003041 "Rename network interface while it in the down state\n" \
3042 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003043 "\n -c FILE Use configuration file (default: /etc/mactab)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003044 "\n -s Use syslog (LOCAL0 facility)" \
3045 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
3046
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003047#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003048 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
3049 " or\n" \
3050 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003051
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003052#if !ENABLE_DESKTOP
3053
Rob Landley1cca9482006-07-10 19:45:20 +00003054#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003055#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003056#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003057#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003058#endif
Rob Landley1cca9482006-07-10 19:45:20 +00003059
Eric Andersen7e9276b2001-02-22 01:15:47 +00003060#define nc_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003061 IF_NC_EXTRA("[-iN] [-wN] ")IF_NC_SERVER("[-l] [-p PORT] ") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003062 "["IF_NC_EXTRA("-f FILENAME|")"IPADDR PORT]"IF_NC_EXTRA(" [-e PROG]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003063#define nc_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003064 "Open a pipe to IP:port" IF_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003065 NC_OPTIONS_STR \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003066 IF_NC_EXTRA( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003067 "\n -e PROG Run PROG after connect" \
3068 "\n -i SEC Delay interval for lines sent" \
3069 "\n -w SEC Timeout for connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003070 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003071 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003072 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003073 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003074 IF_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003075 "\n (use -l twice with -e for persistent server)") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003076 "\n -p PORT Local port" \
Rob Landley1cca9482006-07-10 19:45:20 +00003077 )
3078
Rob Landley1cca9482006-07-10 19:45:20 +00003079#define nc_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003080 IF_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003081 "To use netcat as a terminal emulator on a serial port:\n\n" \
3082 "$ stty 115200 -F /dev/ttyS0\n" \
3083 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
3084 )
Rob Landley1cca9482006-07-10 19:45:20 +00003085
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003086#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003087 "$ nc foobar.somedomain.com 25\n" \
3088 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
3089 "help\n" \
3090 "214-Commands supported:\n" \
3091 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
3092 "214 NOOP QUIT RSET HELP\n" \
3093 "quit\n" \
3094 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003095
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003096#else /* DESKTOP nc - much more compatible with nc 1.10 */
3097
3098#define nc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003099 "[OPTIONS] HOST PORT - connect" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003100 IF_NC_SERVER("\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003101 "nc [OPTIONS] -l -p PORT [HOST] [PORT] - listen")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003102#define nc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003103 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003104 "\n -e PROG Run PROG after connect (must be last)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003105 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003106 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003107 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003108 "\n -n Don't do DNS resolution" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003109 "\n -s ADDR Local address" \
3110 "\n -p PORT Local port" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003111 "\n -u UDP mode" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003112 "\n -v Verbose" \
3113 "\n -w SEC Timeout for connects and final net reads" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003114 IF_NC_EXTRA( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003115 "\n -i SEC Delay interval for lines sent" /* ", ports scanned" */ \
3116 "\n -o FILE Hex dump traffic" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003117 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003118 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003119/* "\n -r Randomize local and remote ports" */
3120/* "\n -g gateway Source-routing hop point[s], up to 8" */
3121/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003122/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
3123
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003124/* -e PROG can take ARGS too: "nc ... -e ls -l", but we don't document it
3125 * in help text: nc 1.10 does not allow that. We don't want to entice
3126 * users to use this incompatibility */
3127
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003128#endif
3129
Eric Andersen1552ff72001-10-31 11:07:12 +00003130#define netstat_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003131 "[-laentuwxr"IF_FEATURE_NETSTAT_WIDE("W")IF_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003132#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003133 "Display networking information\n" \
3134 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003135 "\n -l Display listening server sockets" \
3136 "\n -a Display all sockets (default: connected)" \
3137 "\n -e Display other/more information" \
3138 "\n -n Don't resolve names" \
3139 "\n -t Tcp sockets" \
3140 "\n -u Udp sockets" \
3141 "\n -w Raw sockets" \
3142 "\n -x Unix sockets" \
3143 "\n -r Display routing table" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003144 IF_FEATURE_NETSTAT_WIDE( \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003145 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003146 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003147 IF_FEATURE_NETSTAT_PRG( \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003148 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003149 )
Eric Andersen1552ff72001-10-31 11:07:12 +00003150
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003151#define nice_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003152 "[-n ADJUST] [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003153#define nice_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003154 "Run PROG with modified scheduling priority\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003155 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003156 "\n -n ADJUST Adjust priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003157
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003158#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003159 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003160#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003161 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003162 "Format specifiers:\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003163 " %Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003164 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003165 " %[niface] Monitor network interface 'iface'\n" \
3166 " %m Monitor allocated memory\n" \
3167 " %[mf] Monitor free memory\n" \
3168 " %[mt] Monitor total memory\n" \
3169 " %s Monitor allocated swap\n" \
3170 " %f Monitor number of used file descriptors\n" \
3171 " %Ni Monitor total/specific IRQ rate\n" \
3172 " %x Monitor context switch rate\n" \
3173 " %p Monitor forks\n" \
3174 " %[pn] Monitor # of processes\n" \
3175 " %b Monitor block io\n" \
3176 " %Nt Show time (with N decimal points)\n" \
3177 " %Nd Milliseconds between updates (default:1000)\n" \
3178 " %r Print <cr> instead of <lf> at EOL" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003179
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003180#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003181 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003182
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003183#define nohup_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003184 "PROG [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003185#define nohup_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003186 "Run PROG immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003187#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003188 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003189
Eric Andersen7e9276b2001-02-22 01:15:47 +00003190#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003191 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003192#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003193 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003194 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003195#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003196 "$ nslookup localhost\n" \
3197 "Server: default\n" \
3198 "Address: default\n" \
3199 "\n" \
3200 "Name: debian\n" \
3201 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003202
Glenn L McGrath60281112001-11-02 11:39:46 +00003203#define od_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003204 "[-aBbcDdeFfHhIiLlOovXx] " IF_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003205#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003206 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003207 "(or standard input) to standard output."
Glenn L McGrath60281112001-11-02 11:39:46 +00003208
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003209#define openvt_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003210 "[-c N] [-sw] [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003211#define openvt_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003212 "Start PROG on a new virtual terminal\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003213 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003214 "\n -c N Use specified VT" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003215 "\n -s Switch to the VT" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003216/* "\n -l Run PROG as login shell (by prepending '-')" */ \
3217 "\n -w Wait for PROG to exit" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003218
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003219#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003220 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003221
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003222#define parse_trivial_usage \
3223 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
3224#define parse_full_usage "\n\n" \
3225 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
3226
Eric Andersen27f64e12002-06-23 04:24:25 +00003227#define passwd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003228 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003229#define passwd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003230 "Change USER's password. If no USER is specified,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003231 "changes the password for the current user.\n" \
3232 "\nOptions:" \
3233 "\n -a Algorithm to use for password (choices: des, md5)" /* ", sha1)" */ \
3234 "\n -d Delete password for the account" \
3235 "\n -l Lock (disable) account" \
3236 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003237
Denis Vlasenko21d10142007-07-20 21:28:41 +00003238#define chpasswd_trivial_usage \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003239 IF_LONG_OPTS("[--md5|--encrypted]") IF_NOT_LONG_OPTS("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003240#define chpasswd_full_usage "\n\n" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003241 "Read user:password from stdin and update /etc/passwd\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003242 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003243 IF_LONG_OPTS( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003244 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003245 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003246 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003247 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003248 "\n -e Supplied passwords are in encrypted form" \
3249 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003250 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00003251
Glenn L McGrath655d8142003-06-22 15:32:41 +00003252#define patch_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003253 "[OPTIONS] [ORIGFILE [PATCHFILE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003254#define patch_full_usage "\n\n" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003255 IF_LONG_OPTS( \
3256 " -p,--strip NUM Strip NUM leading components from file names" \
3257 "\n -i,--input DIFF Read DIFF instead of stdin" \
3258 "\n -R,--reverse Reverse patch" \
3259 "\n -N,--forward Ignore already applied patches" \
3260 "\n --dry-run Don't actually change files" \
3261 ) \
3262 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003263 " -p NUM Strip NUM leading components from file names" \
3264 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003265 "\n -R Reverse patch" \
Denys Vlasenkod7874ed2009-08-20 23:33:19 +02003266 "\n -N Ignore already applied patches" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003267 )
Denis Vlasenko397de612008-03-17 08:55:44 +00003268
Glenn L McGrath655d8142003-06-22 15:32:41 +00003269#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003270 "$ patch -p1 < example.diff\n" \
3271 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00003272
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003273#define pgrep_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003274 "[-flnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003275#define pgrep_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003276 "Display process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003277 "\nOptions:" \
3278 "\n -l Show command name too" \
3279 "\n -f Match against entire command line" \
3280 "\n -n Show the newest process only" \
3281 "\n -o Show the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003282 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003283 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003284 "\n -s Match session ID (0 for current)" \
3285 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003286
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003287#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00003288#define pidof_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003289 "[OPTIONS] [NAME...]"
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003290#define USAGE_PIDOF "\n\nOptions:"
3291#else
3292#define pidof_trivial_usage \
3293 "[NAME...]"
3294#define USAGE_PIDOF /* none */
3295#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003296#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003297 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003298 USAGE_PIDOF \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003299 IF_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003300 "\n -s Show only one PID") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003301 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003302 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003303 "\n Use %PPID to omit pid of pidof's parent") \
3304
Eric Andersen221b2ea2001-07-31 19:06:07 +00003305#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003306 "$ pidof init\n" \
3307 "1\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003308 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003309 "$ pidof /bin/sh\n20351 5973 5950\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003310 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003311 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00003312
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003313#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003314#define ping_trivial_usage \
3315 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003316#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003317 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003318#define ping6_trivial_usage \
3319 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003320#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003321 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003322#else
3323#define ping_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003324 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003325#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003326 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3327 "\nOptions:" \
3328 "\n -4, -6 Force IPv4 or IPv6 hostname resolution" \
3329 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003330 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3331 "\n -I IFACE/IP Use interface or IP address as source" \
3332 "\n -W SEC Seconds to wait for the first response (default:10)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003333 "\n (after all -c CNT packets are sent)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003334 "\n -w SEC Seconds until ping exits (default:infinite)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003335 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003336 "\n -q Quiet, only displays output at start" \
3337 "\n and when finished" \
3338
Eric Andersen51b8bd62002-07-03 11:46:38 +00003339#define ping6_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003340 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003341#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003342 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3343 "\nOptions:" \
3344 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003345 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3346 "\n -I IFACE/IP Use interface or IP address as source" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003347 "\n -q Quiet, only displays output at start" \
3348 "\n and when finished" \
3349
Eric Andersen51b8bd62002-07-03 11:46:38 +00003350#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003351#define ping_example_usage \
3352 "$ ping localhost\n" \
3353 "PING slag (127.0.0.1): 56 data bytes\n" \
3354 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3355 "\n" \
3356 "--- debian ping statistics ---\n" \
3357 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3358 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003359#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003360 "$ ping6 ip6-localhost\n" \
3361 "PING ip6-localhost (::1): 56 data bytes\n" \
3362 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3363 "\n" \
3364 "--- ip6-localhost ping statistics ---\n" \
3365 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3366 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003367
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003368#define pipe_progress_trivial_usage NOUSAGE_STR
3369#define pipe_progress_full_usage ""
3370
Eric Andersen7e9276b2001-02-22 01:15:47 +00003371#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003372 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003373#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003374 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003375 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003376
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003377#define pkill_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003378 "[-l|-SIGNAL] [-fnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003379#define pkill_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003380 "Send a signal to process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003381 "\nOptions:" \
3382 "\n -l List all signals" \
3383 "\n -f Match against entire command line" \
3384 "\n -n Signal the newest process only" \
3385 "\n -o Signal the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003386 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003387 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003388 "\n -s Match session ID (0 for current)" \
3389 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003390
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003391#define popmaildir_trivial_usage \
3392 "[OPTIONS] Maildir [connection-helper ...]"
3393#define popmaildir_full_usage "\n\n" \
3394 "Fetch content of remote mailbox to local maildir\n" \
3395 "\nOptions:" \
3396 "\n -b Binary mode. Ignored" \
3397 "\n -d Debug. Ignored" \
3398 "\n -m Show used memory. Ignored" \
3399 "\n -V Show version. Ignored" \
3400 "\n -c Use tcpclient. Ignored" \
3401 "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" \
3402 "\n -s Skip authorization" \
3403 "\n -T Get messages with TOP instead with RETR" \
3404 "\n -k Keep retrieved messages on the server" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003405 "\n -t timeout Network timeout" \
3406 IF_FEATURE_POPMAILDIR_DELIVERY( \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003407 "\n -F \"program arg1 arg2 ...\" Filter by program. May be multiple" \
3408 "\n -M \"program arg1 arg2 ...\" Deliver by program" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003409 ) \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003410 "\n -R size Remove old messages on the server >= size (in bytes). Ignored" \
3411 "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" \
Denys Vlasenko07697852009-10-06 21:11:37 +02003412 "\n -L size Don't retrieve new messages >= size (in bytes). Ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003413 "\n -H lines Type specified number of lines of a message. Ignored"
3414#define popmaildir_example_usage \
3415 "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n" \
3416 "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
3417
Eric Andersen7e9276b2001-02-22 01:15:47 +00003418#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003419 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003420#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003421 "Halt and shut off power\n" \
3422 "\nOptions:" \
3423 "\n -d Delay interval for halting" \
3424 "\n -n No call to sync()" \
3425 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003426
Mike Frysinger95d3c452005-04-21 23:29:24 +00003427#define printenv_trivial_usage \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003428 "[VARIABLE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003429#define printenv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003430 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003431 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003432
Eric Andersen7e9276b2001-02-22 01:15:47 +00003433#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003434 "FORMAT [ARGUMENT...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003435#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003436 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003437 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003438#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003439 "$ printf \"Val=%d\\n\" 5\n" \
3440 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003441
Denis Vlasenko94949192006-11-05 00:45:47 +00003442
3443#if ENABLE_DESKTOP
3444
3445#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003446 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003447#define ps_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003448 "Report process status\n" \
3449 "\nOptions:" \
3450 "\n -o col1,col2=header Select columns for display" \
Denys Vlasenko532609e2009-09-20 20:29:25 +02003451 IF_FEATURE_SHOW_THREADS( \
3452 "\n -T Show threads" \
3453 )
Denis Vlasenko94949192006-11-05 00:45:47 +00003454
3455#else /* !ENABLE_DESKTOP */
3456
Denis Vlasenko397de612008-03-17 08:55:44 +00003457#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003458#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003459#else
3460#define USAGE_PS "\nOptions:"
3461#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003462
Eric Andersen7e9276b2001-02-22 01:15:47 +00003463#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003464 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003465#define ps_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003466 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003467 USAGE_PS \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003468 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003469 "\n -Z Show SE Linux context" \
3470 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003471 IF_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003472 "\n w Wide output" \
3473 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003474
Denis Vlasenko94949192006-11-05 00:45:47 +00003475#endif /* ENABLE_DESKTOP */
3476
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003477#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003478 "$ ps\n" \
3479 " PID Uid Gid State Command\n" \
3480 " 1 root root S init\n" \
3481 " 2 root root S [kflushd]\n" \
3482 " 3 root root S [kupdate]\n" \
3483 " 4 root root S [kpiod]\n" \
3484 " 5 root root S [kswapd]\n" \
3485 " 742 andersen andersen S [bash]\n" \
3486 " 743 andersen andersen S -bash\n" \
3487 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003488 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003489
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003490#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003491 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003492#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003493 "Scan a host, print all open ports\n" \
3494 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003495 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003496 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003497 "\n -p Scan from this port (default 1)" \
3498 "\n -P Scan up to this port (default 1024)" \
3499 "\n -t Timeout (default 5000 ms)" \
3500 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3501
Eric Andersen7e9276b2001-02-22 01:15:47 +00003502#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003503 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003504#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003505 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003506#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003507 "$ pwd\n" \
3508 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003509
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003510#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003511 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003512#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003513 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003514#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003515 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003516
Eric Andersen7e9276b2001-02-22 01:15:47 +00003517#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003518 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003519#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003520 "Get and possibly set the system date and time from a remote HOST\n" \
3521 "\nOptions:" \
3522 "\n -s Set the system date and time (default)" \
3523 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003524
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00003525#define rdev_trivial_usage \
3526 ""
3527#define rdev_full_usage "\n\n" \
3528 "Print the device node associated with the filesystem mounted at '/'"
3529#define rdev_example_usage \
3530 "$ rdev\n" \
3531 "/dev/mtdblock9 /\n"
3532
Rob Landley0e4690d2006-08-20 22:12:18 +00003533#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003534 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003535#define readahead_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003536 "Preload FILEs to RAM"
Rob Landley0e4690d2006-08-20 22:12:18 +00003537
Eric Andersen7e9276b2001-02-22 01:15:47 +00003538#define readlink_trivial_usage \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003539 IF_FEATURE_READLINK_FOLLOW("[-fnv] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003540#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003541 "Display the value of a symlink" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003542 IF_FEATURE_READLINK_FOLLOW( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003543 "\nOptions:" \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003544 "\n -f Canonicalize by following all symlinks" \
3545 "\n -n Don't add newline" \
3546 "\n -v Verbose" \
3547 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003548
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003549#define readprofile_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003550 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003551#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003552 "Options:" \
3553 "\n -m mapfile (Default: /boot/System.map)" \
3554 "\n -p profile (Default: /proc/profile)" \
3555 "\n -M mult Set the profiling multiplier to mult" \
3556 "\n -i Print only info about the sampling step" \
3557 "\n -v Verbose" \
3558 "\n -a Print all symbols, even if count is 0" \
3559 "\n -b Print individual histogram-bin counts" \
3560 "\n -s Print individual counters within functions" \
3561 "\n -r Reset all the counters (root only)" \
3562 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003563
Glenn L McGrath62fae302002-12-10 00:14:33 +00003564#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003565 "pathname..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003566#define realpath_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003567 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00003568
Eric Andersen7e9276b2001-02-22 01:15:47 +00003569#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003570 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003571#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003572 "Reboot the system\n" \
3573 "\nOptions:" \
3574 "\n -d Delay interval for rebooting" \
3575 "\n -n No call to sync()" \
3576 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003577
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003578#define reformime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003579 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003580#define reformime_full_usage "\n\n" \
3581 "Parse MIME-encoded message\n" \
3582 "\nOptions:" \
3583 "\n -x prefix Extract content of MIME sections to files" \
3584 "\n -X prog [args] Filter content of MIME sections through prog." \
3585 "\n Must be the last option" \
3586 "\n" \
3587 "\nOther options are silently ignored." \
3588
Eric Andersen7e9276b2001-02-22 01:15:47 +00003589#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003590 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003591#define renice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003592 "Change priority of running processes\n" \
3593 "\nOptions:" \
3594 "\n -n Adjust current nice value (smaller is faster)" \
3595 "\n -p Process id(s) (default)" \
3596 "\n -g Process group id(s)" \
3597 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003598
Denys Vlasenko5e611152009-05-19 17:36:16 +02003599#define scriptreplay_trivial_usage \
3600 "timingfile [typescript [divisor]]"
3601#define scriptreplay_full_usage "\n\n" \
3602 "Play back typescripts, using timing information"
3603
Eric Andersen7e9276b2001-02-22 01:15:47 +00003604#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003605 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003606#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003607 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003608
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003609#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003610 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003611#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003612 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003613
Denis Vlasenko397137b2007-07-23 14:03:30 +00003614#define restorecon_trivial_usage \
3615 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003616#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003617 "Reset security contexts of files in pathname\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02003618 "\n -i Ignore files that don't exist" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003619 "\n -f file File with list of files to process. Use - for stdin" \
3620 "\n -e directory Directory to exclude" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003621 "\n -R,-r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003622 "\n -n Don't change any file labels" \
3623 "\n -o file Save list of files with incorrect context" \
3624 "\n -v Verbose" \
3625 "\n -vv Show changed labels" \
3626 "\n -F Force reset of context to match file_context" \
3627 "\n for customizable files, or the user section," \
3628 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003629
Eric Andersen7e9276b2001-02-22 01:15:47 +00003630#define rm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003631 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003632#define rm_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003633 "Remove (unlink) FILEs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003634 "\nOptions:" \
3635 "\n -i Always prompt before removing" \
3636 "\n -f Never prompt" \
3637 "\n -r,-R Remove directories recursively" \
3638
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003639#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003640 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003641
Eric Andersen7e9276b2001-02-22 01:15:47 +00003642#define rmdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003643 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003644#define rmdir_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003645 "Remove the DIRECTORY, if it is empty\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003646 "\nOptions:" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003647 IF_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003648 "\n -p|--parents Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003649 "\n --ignore-fail-on-non-empty" \
3650 ) \
3651 IF_NOT_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003652 "\n -p Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003653 )
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003654
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003655#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003656 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003657
Eric Andersen7e9276b2001-02-22 01:15:47 +00003658#define rmmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003659 "[OPTIONS] [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003660#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003661 "Unload the specified kernel modules from the kernel\n" \
3662 "\nOptions:" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003663 "\n -w Wait until the module is no longer used" \
3664 "\n -f Force unloading" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003665 "\n -a Remove all unused modules (recursively)" \
3666
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003667#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003668 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003669
Eric Andersen7e9276b2001-02-22 01:15:47 +00003670#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003671 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003672#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003673 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003674 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003675 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003676 "\n -e Display other/more information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003677 "\n -A inet" IF_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003678
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003679#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003680 "-i -q[ildc]p package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003681#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003682 "Manipulate RPM packages\n" \
3683 "\nOptions:" \
3684 "\n -i Install package" \
3685 "\n -q Query package" \
3686 "\n -p Query uninstalled package" \
3687 "\n -i Show information" \
3688 "\n -l List contents" \
3689 "\n -d List documents" \
3690 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003691
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003692#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003693 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003694#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003695 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003696
Mike Frysinger6b160e42008-02-15 02:27:19 +00003697#define rtcwake_trivial_usage \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003698 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SEC | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003699#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003700 "Enter a system sleep state until specified wakeup time\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003701 IF_LONG_OPTS( \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003702 "\n -a,--auto Read clock mode from adjtime" \
3703 "\n -l,--local Clock is set to local time" \
3704 "\n -u,--utc Clock is set to UTC time" \
3705 "\n -d,--device=DEV Specify the RTC device" \
3706 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003707 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003708 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003709 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003710 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003711 "\n -a Read clock mode from adjtime" \
3712 "\n -l Clock is set to local time" \
3713 "\n -u Clock is set to UTC time" \
3714 "\n -d DEV Specify the RTC device" \
3715 "\n -m MODE Set the sleep state (default: standby)" \
3716 "\n -s SEC Set the timeout in SEC seconds from now" \
3717 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003718 )
3719
Denis Vlasenko49622d72007-03-10 16:58:49 +00003720#define runcon_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003721 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] PROG [ARGS]\n" \
3722 " runcon CONTEXT PROG [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003723#define runcon_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003724 "Run PROG in a different security context\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003725 "\n CONTEXT Complete security context\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003726 IF_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003727 "\n -c,--compute Compute process transition context before modifying" \
3728 "\n -t,--type=TYPE Type (for same role as parent)" \
3729 "\n -u,--user=USER User identity" \
3730 "\n -r,--role=ROLE Role" \
3731 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003732 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003733 IF_NOT_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003734 "\n -c Compute process transition context before modifying" \
3735 "\n -t TYPE Type (for same role as parent)" \
3736 "\n -u USER User identity" \
3737 "\n -r ROLE Role" \
3738 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003739 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003740
Eric Andersen6cf47a72001-10-31 10:24:36 +00003741#define run_parts_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003742 "[-t] "IF_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003743#define run_parts_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003744 "Run a bunch of scripts in a directory\n" \
3745 "\nOptions:" \
3746 "\n -t Print what would be run, but don't actually run anything" \
3747 "\n -a ARG Pass ARG as argument for every program" \
3748 "\n -u MASK Set the umask to MASK before running every program" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003749 IF_FEATURE_RUN_PARTS_FANCY( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003750 "\n -l Print names of all matching files even if they are not executable" \
3751 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003752
3753#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003754 "$ run-parts -a start /etc/init.d\n" \
3755 "$ run-parts -a stop=now /etc/init.d\n\n" \
3756 "Let's assume you have a script foo/dosomething:\n" \
3757 "#!/bin/sh\n" \
3758 "for i in $*; do eval $i; done; unset i\n" \
3759 "case \"$1\" in\n" \
3760 "start*) echo starting something;;\n" \
3761 "stop*) set -x; shutdown -h $stop;;\n" \
3762 "esac\n\n" \
3763 "Running this yields:\n" \
3764 "$run-parts -a stop=+4m foo/\n" \
3765 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003766
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003767#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003768 "[utmp]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003769#define runlevel_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003770 "Find the current and previous system runlevel\n" \
3771 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003772 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003773 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003774#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003775 "$ runlevel /var/run/utmp\n" \
3776 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003777
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003778#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003779 "dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003780#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003781 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003782
3783#define runsvdir_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003784 "[-P] [-s SCRIPT] dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003785#define runsvdir_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003786 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
3787 "\n -P Put each runsv in a new session" \
3788 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003789
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003790#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003791 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003792#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003793 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003794#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003795 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003796
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003797#define script_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003798 "[-afq" IF_SCRIPTREPLAY("t") "] [-c PROG] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003799#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003800 "Options:" \
3801 "\n -a Append output" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003802 "\n -c Run PROG, not shell" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003803 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003804 "\n -q Quiet" \
Denys Vlasenko5e611152009-05-19 17:36:16 +02003805 IF_SCRIPTREPLAY( \
3806 "\n -t Send timing to stderr" \
3807 )
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003808
Eric Andersen7e9276b2001-02-22 01:15:47 +00003809#define sed_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003810 "[-efinr] SED_CMD [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003811#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003812 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003813 "\n -e CMD Add CMD to sed commands to be executed" \
3814 "\n -f FILE Add FILE contents to sed commands to be executed" \
3815 "\n -i Edit files in-place" \
3816 "\n -n Suppress automatic printing of pattern space" \
3817 "\n -r Use extended regex syntax" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003818 "\n" \
3819 "\nIf no -e or -f is given, the first non-option argument is taken as the sed" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003820 "\ncommand to interpret. All remaining arguments are names of input files; if no" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003821 "\ninput files are specified, then the standard input is read. Source files" \
3822 "\nwill not be modified unless -i option is given." \
Eric Andersenf802ff72004-04-12 15:12:06 +00003823
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003824#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003825 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3826 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003827
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003828#define selinuxenabled_trivial_usage NOUSAGE_STR
3829#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003830
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003831#define sendmail_trivial_usage \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003832 "[OPTIONS] [RECIPIENT_EMAIL]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003833#define sendmail_full_usage "\n\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003834 "Read email from stdin and send it\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003835 "\nStandard options:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003836 "\n -t Read additional recipients from message body" \
3837 "\n -f sender Sender (required)" \
3838 "\n -o options Various options. -oi implied, others are ignored" \
Vladimir Dronnikovb618dba2009-10-04 01:34:54 +02003839 "\n -i -oi synonym. implied and ignored" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003840 "\n" \
3841 "\nBusybox specific options:" \
3842 "\n -w seconds Network timeout" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003843 "\n -H 'PROG ARGS' Run connection helper" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003844 "\n Examples:" \
Denis Vlasenko7e0c2432009-03-02 16:12:00 +00003845 "\n -H 'exec openssl s_client -quiet -tls1 -starttls smtp" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003846 "\n -connect smtp.gmail.com:25' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003847 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003848 "\n -H 'exec openssl s_client -quiet -tls1" \
3849 "\n -connect smtp.gmail.com:465' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003850 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003851 "\n -S server[:port] Server" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003852 "\n -au<username> Username for AUTH LOGIN" \
3853 "\n -ap<password> Password for AUTH LOGIN" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003854 "\n -am<method> Authentication method. Ignored. LOGIN is implied" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003855 "\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003856 "\nOther options are silently ignored; -oi -t is implied" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003857 IF_MAKEMIME( \
3858 "\nUse makemime applet to create message with attachments" \
3859 )
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003860
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003861#define seq_trivial_usage \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003862 "[-w] [-s SEP] [FIRST [INC]] LAST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003863#define seq_full_usage "\n\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003864 "Print numbers from FIRST to LAST, in steps of INC.\n" \
3865 "FIRST, INC default to 1\n" \
3866 "\nOptions:" \
3867 "\n -w Pad to last with leading zeros" \
3868 "\n -s SEP String separator" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003869
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003870#define sestatus_trivial_usage \
3871 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003872#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003873 " -v Verbose" \
3874 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003875
Paul Foxfc2256a2005-08-01 18:12:30 +00003876#define setconsole_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003877 "[-r" IF_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003878#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003879 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3880 "\nOptions:" \
3881 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003882
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003883#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003884 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003885#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003886
Denis Vlasenko397137b2007-07-23 14:03:30 +00003887#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003888 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003889 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003890 " [-c policyfile] spec_file" \
3891 ) \
3892 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003893#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003894 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003895 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003896 "\n -c file Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003897 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003898 "\n -d Show which specification matched each file" \
3899 "\n -l Log changes in file labels to syslog" \
3900 "\n -n Don't change any file labels" \
3901 "\n -q Suppress warnings" \
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02003902 "\n -r dir Use an alternate root path" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003903 "\n -e dir Exclude directory" \
3904 "\n -F Force reset of context to match file_context for customizable files" \
3905 "\n -o file Save list of files with incorrect context" \
3906 "\n -s Take a list of files from standard input (instead of command line)" \
3907 "\n -v Show changes in file labels, if type or role are changing" \
3908 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3909 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003910
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003911#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003912 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003913#define setfont_full_usage "\n\n" \
3914 "Load a console font\n" \
3915 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003916 "\n -m MAPFILE Load console screen map" \
3917 "\n -C TTY Affect TTY instead of /dev/tty" \
3918
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003919#define setfont_example_usage \
3920 "$ setfont -m koi8-r /etc/i18n/fontname\n"
3921
Eric Andersen7e9276b2001-02-22 01:15:47 +00003922#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003923 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003924#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003925 "Set entries into the kernel's scancode-to-keycode map,\n" \
3926 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3927 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003928 "and KEYCODE is given in decimal" \
3929
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003930#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003931 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003932
Rob Landley87848d92006-03-27 23:23:43 +00003933#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003934 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003935#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003936 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003937
Denis Vlasenkobe039372007-10-14 04:48:44 +00003938#define setsebool_trivial_usage \
3939 "boolean value"
3940
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003941#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00003942 "Change boolean setting"
3943
Paul Fox42403642005-08-01 22:52:09 +00003944#define setsid_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003945 "PROG [ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003946#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003947 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3948 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3949 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003950
Eric Andersen2e9c2572003-08-08 22:26:06 +00003951#define last_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003952 ""IF_FEATURE_LAST_FANCY("[-HW] [-f file]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003953#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003954 "Show listing of the last users that logged into the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003955 IF_FEATURE_LAST_FANCY( "\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003956 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00003957/* "\n -H Show header line" */ \
3958 "\n -W Display with no host column truncation" \
3959 "\n -f file Read from file instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003960 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00003961
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00003962#define showkey_trivial_usage \
3963 "[-a | -k | -s]"
3964#define showkey_full_usage "\n\n" \
3965 "Show keys pressed\n" \
3966 "\nOptions:" \
3967 "\n -a Display decimal/octal/hex values of the keys" \
3968 "\n -k Display interpreted keycodes (default)" \
3969 "\n -s Display raw scan-codes" \
3970
Denis Vlasenko14923db2007-06-20 15:23:03 +00003971#define slattach_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003972 "[-cehmLF] [-s SPEED] [-p PROTOCOL] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003973#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003974 "Attach network interface(s) to serial line(s)\n" \
3975 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003976 "\n -p PROT Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3977 "\n -s SPD Set line speed" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003978 "\n -e Exit after initializing device" \
3979 "\n -h Exit when the carrier is lost" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003980 "\n -c PROG Run PROG when the line is hung up" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003981 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3982 "\n -L Enable 3-wire operation" \
3983 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003984
Eric Andersen7e9276b2001-02-22 01:15:47 +00003985#define sleep_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003986 IF_FEATURE_FANCY_SLEEP("[") "N" IF_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003987#define sleep_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003988 IF_NOT_FEATURE_FANCY_SLEEP("Pause for N seconds") \
3989 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003990 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003991 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003992#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003993 "$ sleep 2\n" \
3994 "[2 second delay results]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003995 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003996 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003997 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003998
Eric Andersen7e9276b2001-02-22 01:15:47 +00003999#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004000 "[-nru" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004001 IF_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004002 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004003#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004004 "Sort lines of text\n" \
4005 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004006 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004007 "\n -b Ignore leading blanks" \
4008 "\n -c Check whether input is sorted" \
4009 "\n -d Dictionary order (blank or alphanumeric only)" \
4010 "\n -f Ignore case" \
4011 "\n -g General numerical sort" \
4012 "\n -i Ignore unprintable characters" \
4013 "\n -k Sort key" \
4014 "\n -M Sort month" \
4015 ) \
4016 "\n -n Sort numbers" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004017 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004018 "\n -o Output to file" \
4019 "\n -k Sort by key" \
4020 "\n -t CHAR Key separator" \
4021 ) \
4022 "\n -r Reverse sort order" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004023 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004024 "\n -s Stable (don't sort ties alphabetically)" \
4025 ) \
4026 "\n -u Suppress duplicate lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004027 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004028 "\n -z Lines are terminated by NUL, not newline" \
4029 "\n -mST Ignored for GNU compatibility") \
4030
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004031#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004032 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
4033 "a\n" \
4034 "b\n" \
4035 "c\n" \
4036 "d\n" \
4037 "e\n" \
4038 "f\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004039 IF_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00004040 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
4041 "d 2\n" \
4042 "b 2\n" \
4043 "c 3\n" \
4044 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004045 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004046
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00004047#define split_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004048 "[OPTIONS] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004049#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00004050 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004051 "\n -b n[k|m] Split by bytes" \
4052 "\n -l n Split by lines" \
4053 "\n -a n Use n letters as suffix" \
4054
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00004055#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00004056 "$ split TODO foo\n" \
4057 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00004058
Eric Andersenc2af1ee2001-10-18 19:33:06 +00004059#define start_stop_daemon_trivial_usage \
Denis Vlasenko7987a182008-07-01 10:00:46 +00004060 "[OPTIONS] [-S|-K] ... [-- arguments...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004061#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004062 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004063 "-K: stop all matching processes.\n" \
4064 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004065 IF_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004066 "\nProcess matching:" \
4067 "\n -u,--user USERNAME|UID Match only this user's processes" \
4068 "\n -n,--name NAME Match processes with NAME" \
4069 "\n in comm field in /proc/PID/stat" \
4070 "\n -x,--exec EXECUTABLE Match processes with this command" \
4071 "\n in /proc/PID/cmdline" \
4072 "\n -p,--pidfile FILE Match a process with PID from the file" \
4073 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004074 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004075 "\n -x,--exec EXECUTABLE Program to run" \
4076 "\n -a,--startas NAME Zeroth argument" \
4077 "\n -b,--background Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004078 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004079 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004080 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004081 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
4082 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004083 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004084 "\n -s,--signal SIG Signal to send" \
4085 "\n -t,--test Match only, exit with 0 if a process is found" \
4086 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004087 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004088 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004089 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00004090 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00004091 "\n -q,--quiet Quiet" \
4092 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004093 IF_NOT_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004094 "\nProcess matching:" \
4095 "\n -u USERNAME|UID Match only this user's processes" \
4096 "\n -n NAME Match processes with NAME" \
4097 "\n in comm field in /proc/PID/stat" \
4098 "\n -x EXECUTABLE Match processes with this command" \
4099 "\n command in /proc/PID/cmdline" \
4100 "\n -p FILE Match a process with PID from the file" \
4101 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004102 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004103 "\n -x EXECUTABLE Program to run" \
4104 "\n -a NAME Zeroth argument" \
4105 "\n -b Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004106 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004107 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00004108 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004109 "\n -c USER[:[GRP]] Change to user/group" \
4110 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004111 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004112 "\n -s SIG Signal to send" \
4113 "\n -t Match only, exit with 0 if a process is found" \
4114 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004115 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004116 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004117 "\n -v Verbose" \
4118 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00004119 "\n -q Quiet" \
4120 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00004121
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004122#define stat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004123 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004124#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004125 "Display file (default) or filesystem status\n" \
4126 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004127 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004128 "\n -c fmt Use the specified format" \
4129 ) \
4130 "\n -f Display filesystem status" \
4131 "\n -L Dereference links" \
4132 "\n -t Display info in terse form" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004133 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004134 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004135 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004136 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004137 "\n\nValid format sequences for files:\n" \
4138 " %a Access rights in octal\n" \
4139 " %A Access rights in human readable form\n" \
4140 " %b Number of blocks allocated (see %B)\n" \
4141 " %B The size in bytes of each block reported by %b\n" \
4142 " %d Device number in decimal\n" \
4143 " %D Device number in hex\n" \
4144 " %f Raw mode in hex\n" \
4145 " %F File type\n" \
4146 " %g Group ID of owner\n" \
4147 " %G Group name of owner\n" \
4148 " %h Number of hard links\n" \
4149 " %i Inode number\n" \
4150 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00004151 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004152 " %o I/O block size\n" \
4153 " %s Total size, in bytes\n" \
4154 " %t Major device type in hex\n" \
4155 " %T Minor device type in hex\n" \
4156 " %u User ID of owner\n" \
4157 " %U User name of owner\n" \
4158 " %x Time of last access\n" \
4159 " %X Time of last access as seconds since Epoch\n" \
4160 " %y Time of last modification\n" \
4161 " %Y Time of last modification as seconds since Epoch\n" \
4162 " %z Time of last change\n" \
4163 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004164 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004165 " %a Free blocks available to non-superuser\n" \
4166 " %b Total data blocks in file system\n" \
4167 " %c Total file nodes in file system\n" \
4168 " %d Free file nodes in file system\n" \
4169 " %f Free blocks in file system\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004170 IF_SELINUX( \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004171 " %C Security context in SELinux\n" \
4172 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004173 " %i File System ID in hex\n" \
4174 " %l Maximum length of filenames\n" \
4175 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004176 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004177 " %S Fundamental block size (for block counts)\n" \
4178 " %t Type in hex\n" \
4179 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004180 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004181
Eric Andersenef5e8f82002-11-07 02:09:37 +00004182#define strings_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004183 "[-afo] [-n LEN] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004184#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004185 "Display printable strings in a binary file\n" \
4186 "\nOptions:" \
4187 "\n -a Scan whole file (default)" \
4188 "\n -f Precede strings with filenames" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004189 "\n -n LEN At least LEN characters form a string (default 4)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004190 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00004191
Eric Andersen7e9276b2001-02-22 01:15:47 +00004192#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004193 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004194#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004195 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004196 "and deviations from stty sane\n" \
4197 "\nOptions:" \
4198 "\n -F DEVICE Open device instead of stdin" \
4199 "\n -a Print all current settings in human-readable form" \
4200 "\n -g Print in stty-readable form" \
4201 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004202
Robert Griebl1fca5582002-06-04 20:45:46 +00004203#define su_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004204 "[OPTIONS] [-] [username]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004205#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004206 "Change user id or become root\n" \
4207 "\nOptions:" \
4208 "\n -p, -m Preserve environment" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004209 "\n -c CMD Command to pass to 'sh -c'" \
4210 "\n -s SH Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00004211
Eric Andersen27f64e12002-06-23 04:24:25 +00004212#define sulogin_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004213 "[OPTIONS] [TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004214#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004215 "Single user login\n" \
4216 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004217 "\n -t N Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004218
Mike Frysinger95d3c452005-04-21 23:29:24 +00004219#define sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004220 "[-rs] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004221#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004222 "Checksum and count the blocks in a file\n" \
4223 "\nOptions:" \
4224 "\n -r Use BSD sum algorithm (1K blocks)" \
4225 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00004226
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004227#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004228 "[-v] [-w sec] command service..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004229#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004230 "Control services monitored by runsv supervisor.\n" \
4231 "Commands (only first character is enough):\n" \
4232 "\n" \
4233 "status: query service status\n" \
4234 "up: if service isn't running, start it. If service stops, restart it\n" \
4235 "once: like 'up', but if service stops, don't restart it\n" \
4236 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004237 " if it exists. After it stops, don't restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004238 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004239 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004240 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004241 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004242
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004243#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004244 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004245#define svlogd_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004246 "Continuously read log data from standard input, optionally\n" \
4247 "filter log messages, and write the data to one or more automatically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004248 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004249
Eric Andersen7e9276b2001-02-22 01:15:47 +00004250#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004251 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004252#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004253 "Stop swapping on DEVICE\n" \
4254 "\nOptions:" \
4255 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004256
Eric Andersen7e9276b2001-02-22 01:15:47 +00004257#define swapon_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004258 "[-a]" IF_FEATURE_SWAPON_PRI(" [-p pri]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004259#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004260 "Start swapping on DEVICE\n" \
4261 "\nOptions:" \
4262 "\n -a Start swapping on all swap devices" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004263 IF_FEATURE_SWAPON_PRI( \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004264 "\n -p pri Set swap device priority" \
4265 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004266
Rob Landley0f34a822005-10-27 22:55:50 +00004267#define switch_root_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004268 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004269#define switch_root_full_usage "\n\n" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004270 "Free initramfs and switch to another root fs:\n" \
4271 "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n" \
4272 "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004273 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004274 "\n -c DEV Reopen stdio to DEV after switch" \
Rob Landley0f34a822005-10-27 22:55:50 +00004275
Eric Andersen7e9276b2001-02-22 01:15:47 +00004276#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004277 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004278#define sync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004279 "Write all buffered blocks to disk"
4280
4281#define fsync_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004282 "[OPTIONS] FILE..."
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004283#define fsync_full_usage \
4284 "Write files' buffered blocks to disk\n" \
4285 "\nOptions:" \
4286 "\n -d Avoid syncing metadata"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004287
Eric Andersenb9050282003-12-24 06:02:11 +00004288#define sysctl_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004289 "[OPTIONS] [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004290#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004291 "Configure kernel parameters at runtime\n" \
4292 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004293 "\n -n Don't print key names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004294 "\n -e Don't warn about unknown keys" \
4295 "\n -w Change sysctl setting" \
4296 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
4297 "\n -a Display all values" \
4298 "\n -A Display all values in table form" \
4299
Eric Andersen5d38f5b2005-09-12 21:42:48 +00004300#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00004301 "sysctl [-n] [-e] variable...\n" \
4302 "sysctl [-n] [-e] -w variable=value...\n" \
4303 "sysctl [-n] [-e] -a\n" \
4304 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
4305 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00004306
Eric Andersen7e9276b2001-02-22 01:15:47 +00004307#define syslogd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004308 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004309#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004310 "System logging utility.\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004311 "Note that this version of syslogd ignores /etc/syslog.conf.\n" \
4312 "\nOptions:" \
4313 "\n -n Run in foreground" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004314 "\n -O FILE Log to given file (default:/var/log/messages)" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004315 "\n -l n Set local log level" \
4316 "\n -S Smaller logging output" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004317 IF_FEATURE_ROTATE_LOGFILE( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004318 "\n -s SIZE Max size (KB) before rotate (default:200KB, 0=off)" \
4319 "\n -b NUM Number of rotated logs to keep (default:1, max=99, 0=purge)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004320 IF_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004321 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
4322 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004323 IF_FEATURE_SYSLOGD_DUP( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004324 "\n -D Drop duplicates") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004325 IF_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004326 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00004327 /* NB: -Csize shouldn't have space (because size is optional) */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004328/* "\n -m MIN Minutes between MARK lines (default:20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00004329
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004330#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004331 "$ syslogd -R masterlog:514\n" \
4332 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004333
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004334#define tac_trivial_usage \
4335 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004336#define tac_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004337 "Concatenate FILEs and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004338
Eric Andersen7e9276b2001-02-22 01:15:47 +00004339#define tail_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004340 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004341#define tail_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004342 "Print last 10 lines of each FILE (or standard input) to standard output.\n" \
4343 "With more than one FILE, precede each with a header giving the file name.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004344 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004345 IF_FEATURE_FANCY_TAIL( \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004346 "\n -c N[kbm] Output last N bytes") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004347 "\n -n N[kbm] Print last N lines instead of last 10" \
4348 "\n -f Output data as the file grows" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004349 IF_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004350 "\n -q Never output headers giving file names" \
4351 "\n -s SEC Wait SEC seconds between reads with -f" \
4352 "\n -v Always output headers giving file names" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004353 "\n" \
4354 "\nIf the first character of N (bytes or lines) is a '+', output begins with" \
4355 "\nthe Nth item from the start of each file, otherwise, print the last N items" \
4356 "\nin the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004357
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004358#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004359 "$ tail -n 1 /etc/resolv.conf\n" \
4360 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004361
Eric Andersen7e9276b2001-02-22 01:15:47 +00004362#define tar_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004363 "-[" IF_FEATURE_TAR_CREATE("c") IF_FEATURE_SEAMLESS_GZ("z") \
4364 IF_FEATURE_SEAMLESS_BZ2("j") IF_FEATURE_SEAMLESS_LZMA("a") \
4365 IF_FEATURE_SEAMLESS_Z("Z") "xtvO] " \
4366 IF_FEATURE_TAR_FROM("[-X FILE] ") \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004367 "[-f TARFILE] [-C DIR] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004368#define tar_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004369 IF_FEATURE_TAR_CREATE("Create, extract, ") \
4370 IF_NOT_FEATURE_TAR_CREATE("Extract ") \
4371 "or list files from a tar file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004372 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004373 IF_FEATURE_TAR_CREATE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004374 "\n c Create") \
4375 "\n x Extract" \
4376 "\n t List" \
4377 "\nArchive format selection:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004378 IF_FEATURE_SEAMLESS_GZ( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004379 "\n z Filter the archive through gzip" \
4380 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004381 IF_FEATURE_SEAMLESS_BZ2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004382 "\n j Filter the archive through bzip2" \
4383 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004384 IF_FEATURE_SEAMLESS_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004385 "\n a Filter the archive through lzma" \
4386 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004387 IF_FEATURE_SEAMLESS_Z( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004388 "\n Z Filter the archive through compress" \
4389 ) \
4390 "\nFile selection:" \
4391 "\n f Name of TARFILE or \"-\" for stdin" \
4392 "\n O Extract to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004393 IF_FEATURE_TAR_FROM( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004394 "\n exclude File to exclude" \
4395 "\n X File with names to exclude" \
4396 ) \
4397 "\n C Change to directory DIR before operation" \
4398 "\n v Verbose" \
4399
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004400#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004401 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
4402 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004403
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004404#define taskset_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004405 "[-p] [MASK] [PID | PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004406#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004407 "Set or get CPU affinity\n" \
4408 "\nOptions:" \
4409 "\n -p Operate on an existing PID" \
4410
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004411#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004412 "$ taskset 0x7 ./dgemm_test&\n" \
4413 "$ taskset -p 0x1 $!\n" \
4414 "pid 4790's current affinity mask: 7\n" \
4415 "pid 4790's new affinity mask: 1\n" \
4416 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4417 "pid 6671's current affinity mask: 1\n" \
4418 "pid 6671's new affinity mask: 1\n" \
4419 "$ taskset -p 1\n" \
4420 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004421
Eric Andersen7e9276b2001-02-22 01:15:47 +00004422#define tee_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004423 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004424#define tee_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004425 "Copy standard input to each FILE, and also to standard output\n" \
4426 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004427 "\n -a Append to the given FILEs, don't overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004428 "\n -i Ignore interrupt signals (SIGINT)" \
4429
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004430#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004431 "$ echo \"Hello\" | tee /tmp/foo\n" \
4432 "$ cat /tmp/foo\n" \
4433 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004434
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004435#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004436#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004437 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004438#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004439 "Connect to telnet server\n" \
4440 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004441 "\n -a Automatic login with $USER variable" \
4442 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004443
Eric Andersen539ffc92004-02-22 12:25:47 +00004444#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004445#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004446 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004447#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004448 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004449#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004450
Eric Andersen08a72202002-09-30 20:52:10 +00004451#define telnetd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004452 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004453#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004454 "Handle incoming telnet connections" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004455 IF_NOT_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004456 "\nOptions:" \
4457 "\n -l LOGIN Exec LOGIN on connect" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004458 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004459 "\n -K Close connection as soon as login exits" \
4460 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004461 IF_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004462 "\n -p PORT Port to listen on" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004463 "\n -b ADDR[:PORT] Address to bind to" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004464 "\n -F Run in foreground" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004465 "\n -i Run as inetd service" \
4466 IF_FEATURE_TELNETD_INETD_WAIT( \
4467 "\n -w SEC Run as inetd service in wait mode, linger time SEC" \
4468 "\n -S Log to syslog (implied by -i or without -F and -w)" \
4469 ) \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004470 )
Eric Andersen08a72202002-09-30 20:52:10 +00004471
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004472/* "test --help" does not print help (POSIX compat), only "[ --help" does.
4473 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION") */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004474#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004475 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004476#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004477 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4478 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004479#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004480 "$ test 1 -eq 2\n" \
4481 "$ echo $?\n" \
4482 "1\n" \
4483 "$ test 1 -eq 1\n" \
4484 "$ echo $?\n" \
4485 "0\n" \
4486 "$ [ -d /etc ]\n" \
4487 "$ echo $?\n" \
4488 "0\n" \
4489 "$ [ -d /junk ]\n" \
4490 "$ echo $?\n" \
4491 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004492
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004493#define tc_trivial_usage \
4494 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
4495#define tc_full_usage "\n\n" \
4496 "OBJECT: {qdisc|class|filter}\n" \
4497 "CMD: {add|del|change|replace|show}\n" \
4498 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004499 "qdisc [ handle QHANDLE ] [ root |"IF_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004500 /* "[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4501 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4502 " QDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004503 "qdisc show [ dev STRING ]"IF_FEATURE_TC_INGRESS(" [ingress]")"\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004504 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004505 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004506 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
4507 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
4508 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004509 " [ root | classid CLASSID ] [ handle FILTERID ]\n" \
4510 " [ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004511 "filter show [ dev STRING ] [ root | parent CLASSID ]"
4512
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004513#define tcpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004514 "[-hEv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004515/* with not-implemented options: */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004516/* "[-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 +00004517#define tcpsvd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004518 "Create TCP socket, bind to IP:PORT and listen\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004519 "for incoming connection. Run PROG for each connection.\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004520 "\n IP IP to listen on. '0' = all" \
4521 "\n PORT Port to listen on" \
4522 "\n PROG [ARGS] Program to run" \
4523 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4524 "\n -u USER[:GRP] Change to user/group after bind" \
4525 "\n -c N Handle up to N connections simultaneously" \
4526 "\n -b N Allow a backlog of approximately N TCP SYNs" \
4527 "\n -C N[:MSG] Allow only up to N connections from the same IP" \
4528 "\n New connections from this IP address are closed" \
4529 "\n immediately. MSG is written to the peer before close" \
4530 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004531 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004532 "\n -v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004533
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004534#define udpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004535 "[-hEv] [-c N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004536#define udpsvd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004537 "Create UDP socket, bind to IP:PORT and wait\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004538 "for incoming packets. Run PROG for each packet,\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004539 "redirecting all further packets with same peer ip:port to it.\n" \
4540 "\n IP IP to listen on. '0' = all" \
4541 "\n PORT Port to listen on" \
4542 "\n PROG [ARGS] Program to run" \
4543 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4544 "\n -u USER[:GRP] Change to user/group after bind" \
4545 "\n -c N Handle up to N connections simultaneously" \
4546 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004547 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004548 "\n -v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004549
Mark Whitley450736c2001-03-02 19:08:50 +00004550#define tftp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004551 "[OPTIONS] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004552#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004553 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004554 "\nOptions:" \
4555 "\n -l FILE Local FILE" \
4556 "\n -r FILE Remote FILE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004557 IF_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004558 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004559 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004560 IF_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004561 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004562 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004563 IF_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004564 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004565 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004566
4567#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004568 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004569#define tftpd_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004570 "Transfer a file on tftp client's request\n" \
Denis Vlasenko91f8f822008-10-30 23:42:37 +00004571 "\n" \
4572 "tftpd should be used as an inetd service.\n" \
4573 "tftpd's line for inetd.conf:\n" \
4574 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
4575 "It also can be ran from udpsvd:\n" \
4576 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004577 "\nOptions:" \
4578 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004579 "\n -c Allow file creation via upload" \
4580 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004581
Eric Andersenc3657422001-11-30 07:54:32 +00004582#define time_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004583 "[OPTIONS] PROG [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004584#define time_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004585 "Run PROG. When it finishes, its resource usage is displayed.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004586 "\nOptions:" \
4587 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004588
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004589#define timeout_trivial_usage \
4590 "[-t SECS] [-s SIG] PROG [ARGS]"
4591#define timeout_full_usage "\n\n" \
4592 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
Denis Vlasenko42404082008-11-24 13:42:24 +00004593 "Defaults: SECS: 10, SIG: TERM." \
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004594
Eric Andersen420b2082002-09-17 22:14:58 +00004595#define top_trivial_usage \
Denys Vlasenko00528822009-09-11 23:26:42 +02004596 "[-b] [-nCOUNT] [-dSECONDS]" IF_FEATURE_TOPMEM(" [-m]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004597#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004598 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004599 "Read the status of all processes from /proc each SECONDS\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004600 "and show the status for however many processes will fit on the screen." \
Eric Andersen420b2082002-09-17 22:14:58 +00004601
Eric Andersen7e9276b2001-02-22 01:15:47 +00004602#define touch_trivial_usage \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004603 "[-c] [-d DATE] FILE [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004604#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004605 "Update the last-modified date on the given FILE[s]\n" \
4606 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004607 "\n -c Don't create files" \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004608 "\n -d DT Date/time to use" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004609
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004610#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004611 "$ ls -l /tmp/foo\n" \
4612 "/bin/ls: /tmp/foo: No such file or directory\n" \
4613 "$ touch /tmp/foo\n" \
4614 "$ ls -l /tmp/foo\n" \
4615 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004616
4617#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004618 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004619#define tr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004620 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004621 "standard input, writing to standard output\n" \
4622 "\nOptions:" \
4623 "\n -c Take complement of STRING1" \
4624 "\n -d Delete input characters coded STRING1" \
4625 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4626
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004627#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004628 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4629 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004630
Eric Andersen5c58d282001-07-10 16:29:00 +00004631#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004632 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
4633 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004634 " [-z pausemsecs] HOST [data size]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004635#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004636 "Trace the route to HOST\n" \
4637 "\nOptions:" \
4638 "\n -F Set the don't fragment bit" \
4639 "\n -I Use ICMP ECHO instead of UDP datagrams" \
4640 "\n -l Display the ttl value of the returned packet" \
4641 "\n -d Set SO_DEBUG options to socket" \
4642 "\n -n Print hop addresses numerically rather than symbolically" \
4643 "\n -r Bypass the normal routing tables and send directly to a host" \
4644 "\n -v Verbose" \
4645 "\n -m max_ttl Max time-to-live (max number of hops)" \
4646 "\n -p port# Base UDP port number used in probes" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004647 "\n (default 33434)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004648 "\n -q nqueries Number of probes per 'ttl' (default 3)" \
4649 "\n -s src_addr IP address to use as the source address" \
4650 "\n -t tos Type-of-service in probe packets (default 0)" \
4651 "\n -w wait Time in seconds to wait for a response" \
4652 "\n (default 3 sec)" \
4653 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004654
Eric Andersen7e9276b2001-02-22 01:15:47 +00004655#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004656 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004657#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004658 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004659#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004660 "$ true\n" \
4661 "$ echo $?\n" \
4662 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004663
Eric Andersen7e9276b2001-02-22 01:15:47 +00004664#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004665 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004666#define tty_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004667 "Print file name of standard input's terminal" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004668 IF_INCLUDE_SUSv2( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004669 "\nOptions:" \
4670 "\n -s Print nothing, only return exit status" \
4671 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004672#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004673 "$ tty\n" \
4674 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004675
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004676#define ttysize_trivial_usage \
4677 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004678#define ttysize_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004679 "Print dimension(s) of standard input's terminal, on error return 80x25"
4680
Denis Vlasenko39b68132009-01-23 02:07:14 +00004681#define tunctl_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004682 "[-f device] ([-t name] | -d name)" IF_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]")
Denis Vlasenko39b68132009-01-23 02:07:14 +00004683#define tunctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004684 "Create or delete tun interfaces\n" \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004685 "\nOptions:" \
4686 "\n -f name tun device (/dev/net/tun)" \
4687 "\n -t name Create iface 'name'" \
4688 "\n -d name Delete iface 'name'" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004689 IF_FEATURE_TUNCTL_UG( \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004690 "\n -u owner Set iface owner" \
4691 "\n -g group Set iface group" \
4692 "\n -b Brief output" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004693 )
Denis Vlasenko39b68132009-01-23 02:07:14 +00004694#define tunctl_example_usage \
4695 "# tunctl\n" \
4696 "# tunctl -d tun0\n"
4697
Mike Frysinger174808c2005-06-11 01:14:09 +00004698#define tune2fs_trivial_usage \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004699/* "[-c max-mounts-count] [-e errors-behavior] [-g group] " */ \
4700/* "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " */ \
4701/* "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " */ \
4702/* "[-r reserved-blocks-count] [-u user] [-C mount-count] " */ \
4703 "[-L LABEL] " \
4704/* "[-M last-mounted-dir] [-O [^]feature[,...]] " */ \
4705/* "[-T last-check-time] [-U UUID] " */ \
4706 "BLOCKDEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004707#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004708 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004709
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004710#define udhcpc_trivial_usage \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004711 "[-Cfbnqtvo] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004712 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." IF_FEATURE_UDHCP_PORT(" [-P N]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004713#define udhcpc_full_usage "\n\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004714 IF_LONG_OPTS( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004715 " -V,--vendorclass=CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004716 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
4717 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
4718 "\n -c,--clientid=CLIENTID Client identifier" \
4719 "\n -C,--clientid-none Suppress default client identifier" \
4720 "\n -p,--pidfile=file Create pidfile" \
4721 "\n -r,--request=IP IP address to request" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +00004722 "\n -s,--script=file Run file at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denys Vlasenkof26e98f2009-10-10 16:14:41 +02004723 "\n -t,--retries=N Send up to N discover packets" \
Denys Vlasenko84e1caf2009-10-10 16:13:17 +02004724 "\n -T,--timeout=N Pause between packets (default 3 seconds)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004725 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004726 "\n -O,--request-option=OPT Request DHCP option OPT (cumulative)" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004727 "\n -o,--no-default-options Don't request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004728 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004729 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004730 "\n -b,--background Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004731 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004732 "\n -S,--syslog Log to syslog too" \
4733 "\n -n,--now Exit with failure if lease is not immediately obtained" \
4734 "\n -q,--quit Quit after obtaining lease" \
4735 "\n -R,--release Release IP on quit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004736 IF_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004737 "\n -P,--client-port N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004738 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004739 IF_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004740 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004741 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004742 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004743 IF_NOT_LONG_OPTS( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004744 " -V CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004745 "\n -i INTERFACE Interface to use (default: eth0)" \
4746 "\n -H,-h HOSTNAME Client hostname" \
4747 "\n -c CLIENTID Client identifier" \
4748 "\n -C Suppress default client identifier" \
4749 "\n -p file Create pidfile" \
4750 "\n -r IP IP address to request" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +00004751 "\n -s file Run file at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004752 "\n -t N Send up to N request packets" \
4753 "\n -T N Try to get a lease for N seconds (default 3)" \
4754 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004755 "\n -O OPT Request DHCP option OPT (cumulative)" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004756 "\n -o Don't request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004757 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004758 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004759 "\n -b Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004760 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004761 "\n -S Log to syslog too" \
4762 "\n -n Exit with failure if lease is not immediately obtained" \
4763 "\n -q Quit after obtaining lease" \
4764 "\n -R Release IP on quit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004765 IF_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004766 "\n -P N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004767 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004768 IF_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004769 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004770 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004771 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004772
Russ Dill61fb4892002-10-14 21:41:28 +00004773#define udhcpd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004774 "[-fS]" IF_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004775
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004776#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004777 "DHCP server\n" \
4778 "\n -f Run in foreground" \
4779 "\n -S Log to syslog too" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004780 IF_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004781 "\n -P N Use port N instead of default 67" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004782 )
Russ Dill61fb4892002-10-14 21:41:28 +00004783
Eric Andersen7e9276b2001-02-22 01:15:47 +00004784#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004785 "[flags] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004786#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004787 "Unmount file systems\n" \
4788 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004789 IF_FEATURE_UMOUNT_ALL( \
4790 "\n -a Unmount all file systems" IF_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004791 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004792 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004793 "\n -n Don't erase /etc/mtab entries" \
4794 ) \
4795 "\n -r Try to remount devices as read-only if mount is busy" \
4796 "\n -l Lazy umount (detach filesystem)" \
4797 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004798 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004799 "\n -d Free loop device if it has been used" \
4800 )
4801
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004802#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004803 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004804
4805#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004806 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004807#define uname_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004808 "Print system information\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004809 "\nOptions:" \
4810 "\n -a Print all" \
4811 "\n -m The machine (hardware) type" \
4812 "\n -n Hostname" \
4813 "\n -r OS release" \
4814 "\n -s OS name (default)" \
4815 "\n -p Processor type" \
4816 "\n -v OS version" \
4817
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004818#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004819 "$ uname -a\n" \
4820 "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 +00004821
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004822#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004823 "[-c] [-f] [name...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004824#define uncompress_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004825 "Uncompress .Z file[s]\n" \
4826 "\nOptions:" \
4827 "\n -c Extract to stdout" \
4828 "\n -f Overwrite an existing file" \
Tim Riker7b253f82003-12-28 05:02:40 +00004829
Denis Vlasenko3952f202007-08-13 14:10:24 +00004830#define unexpand_trivial_usage \
4831 "[-f][-a][-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004832#define unexpand_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004833 "Convert spaces to tabs, writing to standard output\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004834 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004835 IF_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004836 "\n -a,--all Convert all blanks" \
4837 "\n -f,--first-only Convert only leading blanks" \
4838 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004839 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004840 IF_NOT_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004841 "\n -a Convert all blanks" \
4842 "\n -f Convert only leading blanks" \
4843 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004844 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004845
Eric Andersen7e9276b2001-02-22 01:15:47 +00004846#define uniq_trivial_usage \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004847 "[-fscduw]... [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004848#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004849 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004850 "\nOptions:" \
4851 "\n -c Prefix lines by the number of occurrences" \
4852 "\n -d Only print duplicate lines" \
4853 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004854 "\n -f N Skip first N fields" \
4855 "\n -s N Skip first N chars (after any skipped fields)" \
4856 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004857
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004858#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004859 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4860 "a\n" \
4861 "b\n" \
4862 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004863
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004864#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004865 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004866#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004867 "Extract files from ZIP archives\n" \
4868 "\nOptions:" \
4869 "\n -l List archive contents (with -q for short form)" \
4870 "\n -n Never overwrite existing files (default)" \
4871 "\n -o Overwrite files without prompting" \
4872 "\n -p Send output to stdout" \
4873 "\n -q Quiet" \
4874 "\n -x Exclude these files" \
4875 "\n -d Extract files into this directory" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004876
Eric Andersen7e9276b2001-02-22 01:15:47 +00004877#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004878 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004879#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004880 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004881
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004882#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004883 "$ uptime\n" \
4884 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004885
4886#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004887 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004888#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004889 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004890
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004891#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004892 "$ usleep 1000000\n" \
4893 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004894
4895#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004896 "[-o outfile] [infile]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004897#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004898 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004899 "Finds outfile name in uuencoded source unless -o is given"
4900
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004901#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004902 "$ uudecode -o busybox busybox.uu\n" \
4903 "$ ls -l busybox\n" \
4904 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004905
4906#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004907 "[-m] [infile] stored_filename"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004908#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004909 "Uuencode a file to stdout\n" \
4910 "\nOptions:" \
4911 "\n -m Use base64 encoding per RFC1521" \
4912
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004913#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004914 "$ uuencode busybox busybox\n" \
4915 "begin 755 busybox\n" \
4916 "<encoded file snipped>\n" \
4917 "$ uudecode busybox busybox > busybox.uu\n" \
4918 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004919
Eric Andersen853c4942003-01-23 05:59:32 +00004920#define vconfig_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004921 "COMMAND [OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004922#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004923 "Create and remove virtual ethernet devices\n" \
4924 "\nOptions:" \
4925 "\n add [interface-name] [vlan_id]" \
4926 "\n rem [vlan-name]" \
4927 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4928 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4929 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4930 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004931
Eric Andersen3f980402001-04-04 17:31:15 +00004932#define vi_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004933 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004934#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004935 "Edit FILE\n" \
4936 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004937 IF_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004938 "\n -c Initial command to run ($EXINIT also available)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004939 IF_FEATURE_VI_READONLY( \
Denys Vlasenko07697852009-10-06 21:11:37 +02004940 "\n -R Read-only - don't write to the file") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004941 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00004942
Eric Andersen27f64e12002-06-23 04:24:25 +00004943#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004944 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004945#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004946 "Lock a virtual terminal. A password is required to unlock.\n" \
4947 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00004948 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004949
Matthew Stoltenberg4803db52009-08-13 00:59:32 +02004950#define volname_trivial_usage \
4951 "[DEVICE]"
4952#define volname_full_usage "\n\n" \
4953 "Show CD volume name of the DEVICE (default /dev/cdrom)"
4954
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004955#define watch_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004956 "[-n seconds] [-t] PROG [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004957#define watch_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004958 "Run PROG periodically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004959 "\nOptions:" \
4960 "\n -n Loop period in seconds (default 2)" \
4961 "\n -t Don't print header" \
4962
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004963#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004964 "$ watch date\n" \
4965 "Mon Dec 17 10:31:40 GMT 2000\n" \
4966 "Mon Dec 17 10:31:42 GMT 2000\n" \
4967 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004968
Eric Andersen7e9276b2001-02-22 01:15:47 +00004969#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004970 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004971#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004972 "Periodically write to watchdog device DEV\n" \
4973 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004974 "\n -T N Reboot after N seconds if not reset (default 60)" \
4975 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004976 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004977 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004978 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004979
4980#define wc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004981 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004982#define wc_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004983 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004984 "more than one FILE is specified. With no FILE, read standard input.\n" \
4985 "\nOptions:" \
4986 "\n -c Print the byte counts" \
4987 "\n -l Print the newline counts" \
4988 "\n -L Print the length of the longest line" \
4989 "\n -w Print the word counts" \
4990
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004991#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004992 "$ wc /etc/passwd\n" \
4993 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004994
4995#define wget_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004996 IF_FEATURE_WGET_LONG_OPTIONS( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004997 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004998 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4999 " [-U|--user-agent agent] url" \
5000 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005001 IF_NOT_FEATURE_WGET_LONG_OPTIONS( \
Denis Vlasenko03630782007-10-18 11:11:12 +00005002 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
5003 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005004#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005005 "Retrieve files via HTTP or FTP\n" \
5006 "\nOptions:" \
5007 "\n -s Spider mode - only check file existence" \
5008 "\n -c Continue retrieval of aborted transfer" \
5009 "\n -q Quiet" \
5010 "\n -P Set directory prefix to DIR" \
5011 "\n -O Save to filename ('-' for stdout)" \
5012 "\n -U Adjust 'User-Agent' field" \
5013 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005014
5015#define which_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005016 "[COMMAND]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005017#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005018 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005019#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005020 "$ which login\n" \
5021 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00005022
Eric Andersen00a6a752002-04-26 23:53:10 +00005023#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00005024 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005025#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005026 "Show who is logged on\n" \
5027 "\nOptions:" \
5028 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005029
5030#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005031 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005032#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005033 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005034
5035#define xargs_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005036 "[OPTIONS] [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005037#define xargs_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005038 "Run PROG on every item given by standard input\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005039 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005040 IF_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005041 "\n -p Ask user whether to run each command") \
Denys Vlasenko07697852009-10-06 21:11:37 +02005042 "\n -r Don't run command if input is empty" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005043 IF_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005044 "\n -0 Input is separated by NUL characters") \
5045 "\n -t Print the command on stderr before execution" \
Denis Vlasenkoe82da4d2008-08-21 19:59:30 +00005046 "\n -e[STR] STR stops input processing" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005047 "\n -n N Pass no more than N args to PROG" \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005048 "\n -s N Pass command line of no more than N bytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005049 IF_FEATURE_XARGS_SUPPORT_TERMOPT( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005050 "\n -x Exit if size is exceeded") \
Denis Vlasenko397de612008-03-17 08:55:44 +00005051
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005052#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005053 "$ ls | xargs gzip\n" \
5054 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005055
5056#define yes_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005057 "[OPTIONS] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005058#define yes_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005059 "Repeatedly output a line with STRING, or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00005060
Eric Andersen7e9276b2001-02-22 01:15:47 +00005061#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005062 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005063#define zcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005064 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00005065
Rob Landleyad8071f2005-04-30 03:49:37 +00005066#define zcip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005067 "[OPTIONS] IFACE SCRIPT"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005068#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005069 "Manage a ZeroConf IPv4 link-local address\n" \
5070 "\nOptions:" \
5071 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00005072 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005073 "\n -r 169.254.x.x Request this address first" \
5074 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00005075 "\n" \
5076 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
5077 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00005078
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00005079
5080#endif