blob: 0215fa5bfc9cb850b657bc9162ddf2ad92fa39cb [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:" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200676 "\n [-s] TIME Set time to TIME" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000677 "\n -u Work in UTC (don't convert to local time)" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000678 "\n -R Output RFC-822 compliant date string" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000679 IF_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000680 "\n -I[SPEC] Output ISO-8601 compliant date string" \
681 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000682 "\n 'hours', 'minutes', or 'seconds' for date and" \
683 "\n time to the indicated precision" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000684 ) \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000685 "\n -r FILE Display last modification time of FILE" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200686 "\n -d TIME Display TIME, not 'now'" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000687 IF_FEATURE_DATE_ISOFMT( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200688 "\n -D FMT Use FMT for -d TIME conversion" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000689 ) \
690 "\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +0200691 "\nRecognized TIME formats:" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000692 "\n hh:mm[:ss]" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000693 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000694 "\n YYYY-MM-DD hh:mm[:ss]" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200695 "\n [[[[[YY]YY]MM]DD]hh]mm[.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000696
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000697#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000698 "$ date\n" \
699 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000700
Eric Andersen7e9276b2001-02-22 01:15:47 +0000701#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000702 "expression..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000703#define dc_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +0000704 "Tiny RPN calculator. Operations:\n" \
705 "+, add, -, sub, *, mul, /, div, %, mod, **, exp, and, or, not, eor,\n" \
706 "p - print top of the stack (without altering the stack),\n" \
707 "f - print entire stack, o - pop the value and set output radix\n" \
708 "(value must be 10 or 16).\n" \
709 "Examples: 'dc 2 2 add' -> 4, 'dc 8 8 * 2 2 + /' -> 16.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000710
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000711#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000712 "$ dc 2 2 + p\n" \
713 "4\n" \
714 "$ dc 8 8 \\* 2 2 + / p\n" \
715 "16\n" \
716 "$ dc 0 1 and p\n" \
717 "0\n" \
718 "$ dc 0 1 or p\n" \
719 "1\n" \
720 "$ echo 72 9 div 8 mul p | dc\n" \
721 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000722
Eric Andersen7e9276b2001-02-22 01:15:47 +0000723#define dd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000724 "[if=FILE] [of=FILE] " IF_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
725 " [seek=N]" IF_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000726#define dd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000727 "Copy a file with converting and formatting\n" \
728 "\nOptions:" \
729 "\n if=FILE Read from FILE instead of stdin" \
730 "\n of=FILE Write to FILE instead of stdout" \
731 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000732 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000733 "\n ibs=N Read N bytes at a time" \
734 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000735 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000736 "\n obs=N Write N bytes at a time" \
737 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000738 "\n count=N Copy only N input blocks" \
739 "\n skip=N Skip N input blocks" \
740 "\n seek=N Skip N output blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000741 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000742 "\n conv=notrunc Don't truncate output file" \
743 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000744 "\n conv=sync Pad blocks with zeros" \
745 "\n conv=fsync Physically write data out before finishing" \
746 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000747 "\n" \
748 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
749 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
750
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000751#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000752 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
753 "4+0 records in\n" \
754 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000755
Eric Andersen7e9276b2001-02-22 01:15:47 +0000756#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000757 "[N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000758#define deallocvt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000759 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000760
Eric Andersenf349e972001-08-21 16:18:59 +0000761#define delgroup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000762 IF_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000763#define delgroup_full_usage "\n\n" \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000764 "Delete group GROUP from the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000765 IF_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000766
767#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000768 "USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000769#define deluser_full_usage "\n\n" \
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000770 "Delete USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000771
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000772#define depmod_trivial_usage NOUSAGE_STR
773#define depmod_full_usage ""
Bernhard Reutner-Fischer55e547e2008-05-26 12:01:49 +0000774
Denis Vlasenkoc94fa562008-10-26 11:08:14 +0000775#define devmem_trivial_usage \
776 "ADDRESS [WIDTH [VALUE]]"
777
778#define devmem_full_usage "\n\n" \
779 "Read/write from physical address\n" \
780 "\n ADDRESS Address to act upon" \
781 "\n WIDTH Width (8/16/...)" \
782 "\n VALUE Data to be written" \
783
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000784#define devfsd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000785 "mntpnt [-v]" IF_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000786#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000787 "Manage devfs permissions and old device name symlinks\n" \
788 "\nOptions:" \
789 "\n mntpnt The mount point where devfs is mounted" \
790 "\n -v Print the protocol version numbers for devfsd" \
791 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000792 IF_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000793 "\n -fg Run in foreground" \
794 "\n -np Exit after parsing the configuration file" \
795 "\n and processing synthetic REGISTER events," \
Denys Vlasenko07697852009-10-06 21:11:37 +0200796 "\n don't poll for events" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000797 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000798
Eric Andersen7e9276b2001-02-22 01:15:47 +0000799#define df_trivial_usage \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000800 "[-Pk" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000801 IF_FEATURE_HUMAN_READABLE("mh") \
802 IF_FEATURE_DF_FANCY("ai] [-B SIZE") \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000803 "] [FILESYSTEM...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000804#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000805 "Print filesystem usage statistics\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000806 "\nOptions:" \
807 "\n -P POSIX output format" \
808 "\n -k 1024-byte blocks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000809 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000810 "\n -m 1M-byte blocks" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000811 "\n -h Human readable (e.g. 1K 243M 2G)" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000812 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000813 IF_FEATURE_DF_FANCY( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000814 "\n -a Show all filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000815 "\n -i Inodes" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000816 "\n -B SIZE Blocksize" \
817 ) \
818
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000819#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000820 "$ df\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000821 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000822 "/dev/sda3 8690864 8553540 137324 98% /\n" \
823 "/dev/sda1 64216 36364 27852 57% /boot\n" \
824 "$ df /dev/sda3\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000825 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
826 "/dev/sda3 8690864 8553540 137324 98% /\n" \
827 "$ POSIXLY_CORRECT=sure df /dev/sda3\n" \
828 "Filesystem 512B-blocks Used Available Use% Mounted on\n" \
829 "/dev/sda3 17381728 17107080 274648 98% /\n" \
830 "$ POSIXLY_CORRECT=yep df -P /dev/sda3\n" \
831 "Filesystem 512-blocks Used Available Capacity Mounted on\n" \
832 "/dev/sda3 17381728 17107080 274648 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000833
Denis Vlasenko736230e2006-11-20 19:40:36 +0000834#define dhcprelay_trivial_usage \
Denis Vlasenkoe8a79682009-04-13 03:33:46 +0000835 "CLIENT_IFACE[,CLIENT_IFACE2...] SERVER_IFACE [SERVER_IP]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000836#define dhcprelay_full_usage "\n\n" \
Denis Vlasenkoe8a79682009-04-13 03:33:46 +0000837 "Relay DHCP requests between clients and server" \
Denis Vlasenko736230e2006-11-20 19:40:36 +0000838
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000839#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000840 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000841#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000842 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000843 "This implementation supports unified diffs only.\n" \
844 "\nOptions:" \
845 "\n -a Treat all files as text" \
846 "\n -b Ignore changes in the amount of whitespace" \
847 "\n -d Try hard to find a smaller set of changes" \
848 "\n -i Ignore case differences" \
849 "\n -L Use LABEL instead of the filename in the unified header" \
850 "\n -N Treat absent files as empty" \
851 "\n -q Output only whether files differ" \
852 "\n -r Recursively compare subdirectories" \
853 "\n -S Start with FILE when comparing directories" \
854 "\n -T Make tabs line up by prefixing a tab when necessary" \
855 "\n -s Report when two files are the same" \
856 "\n -t Expand tabs to spaces in output" \
857 "\n -U Output LINES lines of context" \
858 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000859
Eric Andersen7e9276b2001-02-22 01:15:47 +0000860#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000861 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000862#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000863 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000864#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000865 "$ dirname /tmp/foo\n" \
866 "/tmp\n" \
867 "$ dirname /tmp/foo/\n" \
868 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000869
Eric Andersen7e9276b2001-02-22 01:15:47 +0000870#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000871 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000872#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000873 "Print or control the kernel ring buffer\n" \
874 "\nOptions:" \
875 "\n -c Clear ring buffer after printing" \
876 "\n -n LEVEL Set console logging level" \
877 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000878
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000879#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000880 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000881#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000882 "Small static DNS server daemon\n" \
883 "\nOptions:" \
884 "\n -c Config filename" \
885 "\n -t TTL in seconds" \
886 "\n -p Listening port" \
887 "\n -i Listening ip (default all)" \
888 "\n -d Daemonize" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000889
Eric Andersen7e9276b2001-02-22 01:15:47 +0000890#define dos2unix_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200891 "[OPTION] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000892#define dos2unix_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200893 "Convert FILE in-place from DOS to Unix format.\n" \
894 "When no file is given, use stdin/stdout.\n" \
895 "\nOptions:" \
896 "\n -u dos2unix" \
897 "\n -d unix2dos" \
898
899#define unix2dos_trivial_usage \
900 "[OPTION] [FILE]"
901#define unix2dos_full_usage "\n\n" \
902 "Convert FILE in-place from Unix to DOS format.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000903 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000904 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000905 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000906 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000907
Eric Andersen7e9276b2001-02-22 01:15:47 +0000908#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000909 "[-ilCPru] [-F option] package_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000910#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000911 "Install, remove and manage Debian packages\n" \
912 "\nOptions:" \
913 "\n -i Install the package" \
914 "\n -l List of installed packages" \
915 "\n -C Configure an unpackaged package" \
916 "\n -F depends Ignore dependency problems" \
917 "\n -P Purge all files of a package" \
918 "\n -r Remove all but the configuration files for a package" \
919 "\n -u Unpack a package, but don't configure it" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000920
Eric Andersen7e9276b2001-02-22 01:15:47 +0000921#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000922 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000923#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000924 "Perform actions on Debian packages (.debs)\n" \
925 "\nOptions:" \
926 "\n -c List contents of filesystem tree" \
927 "\n -e Extract control files to [argument] directory" \
928 "\n -f Display control field name starting with [argument]" \
929 "\n -x Extract packages filesystem tree to directory" \
930 "\n -X Verbose extract" \
931
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000932#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000933 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000934
Eric Andersen7e9276b2001-02-22 01:15:47 +0000935#define du_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000936 "[-aHLdclsx" IF_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000937#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000938 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000939 "Disk space is printed in units of " \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000940 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
941 IF_NOT_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000942 " bytes.\n" \
943 "\nOptions:" \
944 "\n -a Show file sizes too" \
945 "\n -H Follow symlinks on command line" \
946 "\n -L Follow all symlinks" \
947 "\n -d N Limit output to directories (and files with -a) of depth < N" \
948 "\n -c Show grand total" \
949 "\n -l Count sizes many times if hard linked" \
950 "\n -s Display only a total for each argument" \
951 "\n -x Skip directories on different filesystems" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000952 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000953 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
954 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000955 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000956 "\n -k Sizes in kilobytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000957 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000958
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000959#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000960 "$ du\n" \
961 "16 ./CVS\n" \
962 "12 ./kernel-patches/CVS\n" \
963 "80 ./kernel-patches\n" \
964 "12 ./tests/CVS\n" \
965 "36 ./tests\n" \
966 "12 ./scripts/CVS\n" \
967 "16 ./scripts\n" \
968 "12 ./docs/CVS\n" \
969 "104 ./docs\n" \
970 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000971
Eric Andersen7e9276b2001-02-22 01:15:47 +0000972#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000973 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000974#define dumpkmap_full_usage "\n\n" \
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000975 "Print a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000976#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000977 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000978
Russ Dill61fb4892002-10-14 21:41:28 +0000979#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000980 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000981#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000982 "Display DHCP leases granted by udhcpd\n" \
983 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200984 IF_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000985 "\n -f,--file=FILE Leases file to load" \
986 "\n -r,--remaining Interpret lease times as time remaining" \
987 "\n -a,--absolute Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000988 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200989 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000990 "\n -f FILE Leases file to load" \
991 "\n -r Interpret lease times as time remaining" \
992 "\n -a Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000993 )
Russ Dill61fb4892002-10-14 21:41:28 +0000994
Mike Frysinger51a43b42005-09-24 07:11:16 +0000995#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000996 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
997 "[-I inode_buffer_blocks] [-P process_inode_size] " \
998 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
999 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001000#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001001 "Check ext2/ext3 file system\n" \
1002 "\nOptions:" \
1003 "\n -p Automatic repair (no questions)" \
1004 "\n -n Make no changes to the filesystem" \
1005 "\n -y Assume 'yes' to all questions" \
1006 "\n -c Check for bad blocks and add them to the badblock list" \
1007 "\n -f Force checking even if filesystem is marked clean" \
1008 "\n -v Verbose" \
1009 "\n -b superblock Use alternative superblock" \
1010 "\n -B blocksize Force blocksize when looking for superblock" \
1011 "\n -j journal Set location of the external journal" \
1012 "\n -l file Add to badblocks list" \
1013 "\n -L file Set badblocks list" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001014
Eric Andersen7e9276b2001-02-22 01:15:47 +00001015#define echo_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001016 IF_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001017#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001018 "Print the specified ARGs to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001019 IF_FEATURE_FANCY_ECHO( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001020 "\nOptions:" \
1021 "\n -n Suppress trailing newline" \
1022 "\n -e Interpret backslash-escaped characters (i.e., \\t=tab)" \
1023 "\n -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001024 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001025#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001026 "$ echo \"Erik is cool\"\n" \
1027 "Erik is cool\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001028 IF_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001029 "Erik\n" \
1030 "is\n" \
1031 "cool\n" \
1032 "$ echo \"Erik\\nis\\ncool\"\n" \
1033 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001034
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001035#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001036 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001037#define eject_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001038 "Eject specified DEVICE (or default /dev/cdrom)\n" \
1039 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001040 IF_FEATURE_EJECT_SCSI( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001041 "\n -s SCSI device" \
1042 ) \
1043 "\n -t Close tray" \
1044 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001045
Rob Landley3b890392006-05-04 20:56:43 +00001046#define ed_trivial_usage ""
1047#define ed_full_usage ""
1048
Eric Andersen84e229c2001-03-29 22:48:33 +00001049#define env_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001050 "[-iu] [-] [name=value]... [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001051#define env_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001052 "Print the current environment or run PROG after setting up\n" \
1053 "the specified environment\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001054 "\nOptions:" \
1055 "\n -, -i Start with an empty environment" \
1056 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +00001057
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001058#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001059 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001060#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001061 "Send a magic packet to wake up sleeping machines.\n" \
1062 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001063 "a hostname with a known 'ethers' entry.\n" \
1064 "\nOptions:" \
1065 "\n -b Send wake-up packet to the broadcast address" \
1066 "\n -i iface Interface to use (default eth0)" \
1067 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001068
Denis Vlasenko3952f202007-08-13 14:10:24 +00001069#define expand_trivial_usage \
1070 "[-i] [-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001071#define expand_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001072 "Convert tabs to spaces, writing to standard output\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001073 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001074 IF_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001075 "\n -i,--initial Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001076 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001077 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001078 IF_NOT_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001079 "\n -i Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001080 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001081 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00001082
Eric Andersen7e9276b2001-02-22 01:15:47 +00001083#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001084 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001085#define expr_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001086 "Print the value of EXPRESSION to standard output\n" \
1087 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001088 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001089 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
1090 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1091 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1092 " ARG1 <= ARG2\n" \
1093 " ARG1 = ARG2\n" \
1094 " ARG1 != ARG2\n" \
1095 " ARG1 >= ARG2\n" \
1096 " ARG1 > ARG2\n" \
1097 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1098 " ARG1 - ARG2\n" \
1099 " ARG1 * ARG2\n" \
1100 " ARG1 / ARG2\n" \
1101 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001102 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1103 " match STRING REGEXP Same as STRING : REGEXP\n" \
1104 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1105 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1106 " length STRING Length of STRING\n" \
1107 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001108 " it is a keyword like 'match' or an\n" \
1109 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001110 " (EXPRESSION) Value of EXPRESSION\n" \
1111 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001112 "Beware that many operators need to be escaped or quoted for shells.\n" \
1113 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001114 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001115 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1116 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001117
Mike Frysingerfa69f112005-04-17 07:24:19 +00001118#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001119 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001120#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001121 "Provide fake ident (auth) service\n" \
1122 "\nOptions:" \
1123 "\n -f Run in foreground" \
1124 "\n -i Inetd mode" \
1125 "\n -w Inetd 'wait' mode" \
1126 "\n -b ADDR Bind to specified address" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001127 "\n STRING Ident answer string (default: nobody)" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001128
Eric Andersen7e9276b2001-02-22 01:15:47 +00001129#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001130 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001131#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001132 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001133
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001134#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001135 "$ false\n" \
1136 "$ echo $?\n" \
1137 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001138
1139#define fbset_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001140 "[OPTIONS] [MODE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001141#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001142 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001143
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001144#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001145 "$ fbset\n" \
1146 "mode \"1024x768-76\"\n" \
1147 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1148 " geometry 1024 768 1024 768 16\n" \
1149 " timings 12714 128 32 16 4 128 4\n" \
1150 " accel false\n" \
1151 " rgba 5/11,6/5,5/0,0/0\n" \
1152 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001153
Eric Andersen7e9276b2001-02-22 01:15:47 +00001154#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001155 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001156#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001157 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001158
Eric Andersen01c3d402003-07-05 07:51:31 +00001159#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001160 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001161#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001162 "Format floppy disk\n" \
1163 "\nOptions:" \
1164 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001165
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001166/* Looks like someone forgot to add this to config system */
1167#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1168# define ENABLE_FEATURE_FDISK_BLKSIZE 0
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001169# define IF_FEATURE_FDISK_BLKSIZE(a)
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001170#endif
1171
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001172#define fdisk_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001173 "[-ul" IF_FEATURE_FDISK_BLKSIZE("s") "] " \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001174 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001175#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001176 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001177 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001178 "\n -u Start and End are in sectors (instead of cylinders)" \
1179 "\n -l Show partition table for each DISK, then exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001180 IF_FEATURE_FDISK_BLKSIZE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001181 "\n -s Show partition sizes in kb for each DISK, then exit" \
1182 ) \
1183 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1184 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
1185 "\n -H HEADS\n" \
1186 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001187
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001188#define blkid_trivial_usage \
1189 ""
1190#define blkid_full_usage "\n\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02001191 "Print UUIDs of all filesystems"
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001192
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001193#define findfs_trivial_usage \
1194 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001195#define findfs_full_usage "\n\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02001196 "Find a filesystem device based on a label or UUID"
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001197#define findfs_example_usage \
1198 "$ findfs LABEL=MyDevice"
1199
Eric Andersen7e9276b2001-02-22 01:15:47 +00001200#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001201 "[PATH...] [EXPRESSION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001202#define find_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001203 "Search for files. The default PATH is the current directory,\n" \
1204 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001205 "\nEXPRESSION may consist of:" \
1206 "\n -follow Dereference symlinks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001207 IF_FEATURE_FIND_XDEV( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001208 "\n -xdev Don't descend directories on other filesystems") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001209 IF_FEATURE_FIND_MAXDEPTH( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001210 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1211 "\n tests/actions to command line arguments only") \
Denys Vlasenko07697852009-10-06 21:11:37 +02001212 "\n -mindepth N Don't act on first N levels" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001213 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001214 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001215 IF_FEATURE_FIND_PATH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001216 "\n -path PATTERN Path matches PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001217 IF_FEATURE_FIND_REGEX( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001218 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001219 IF_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001220 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001221 IF_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001222 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001223 "\n or exactly (NNN)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001224 IF_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001225 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001226 "\n or exactly (N) days") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001227 IF_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001228 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001229 "\n or exactly (N) minutes") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001230 IF_FEATURE_FIND_NEWER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001231 "\n -newer FILE Modified time is more recent than FILE's") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001232 IF_FEATURE_FIND_INUM( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001233 "\n -inum N File has inode number N") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001234 IF_FEATURE_FIND_USER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001235 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001236 IF_FEATURE_FIND_GROUP( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001237 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001238 IF_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001239 "\n -depth Process directory name after traversing it") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001240 IF_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001241 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1242 "\n +/-N: file size is bigger/smaller than N") \
1243 "\n -print Print (default and assumed)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001244 IF_FEATURE_FIND_PRINT0( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001245 "\n -print0 Delimit output with null characters rather than" \
1246 "\n newlines") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001247 IF_FEATURE_FIND_CONTEXT ( \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001248 "\n -context File has specified security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001249 IF_FEATURE_FIND_EXEC( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001250 "\n -exec CMD ARG ; Run CMD with all instances of {} replaced by the" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001251 "\n matching files") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001252 IF_FEATURE_FIND_PRUNE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001253 "\n -prune Stop traversing current subtree") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001254 IF_FEATURE_FIND_DELETE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001255 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001256 IF_FEATURE_FIND_PAREN( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001257 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001258
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001259#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001260 "$ find / -name passwd\n" \
1261 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001262
Denys Vlasenkobf2af9a2009-05-25 04:15:37 +02001263#define flash_lock_trivial_usage \
1264 "MTD_DEVICE OFFSET SECTORS"
1265#define flash_lock_full_usage "\n\n" \
1266 "Lock part or all of an MTD device. If SECTORS is -1, then all sectors\n" \
1267 "will be locked, regardless of the value of OFFSET"
1268
1269#define flash_unlock_trivial_usage \
1270 "MTD_DEVICE"
1271#define flash_unlock_full_usage "\n\n" \
1272 "Unlock an MTD device"
1273
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001274#define flash_eraseall_trivial_usage \
1275 "[-jq] MTD_DEVICE"
1276#define flash_eraseall_full_usage "\n\n" \
1277 "Erase an MTD device\n" \
1278 "\nOptions:" \
1279 "\n -j format the device for jffs2" \
1280 "\n -q don't display progress messages"
1281
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001282#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001283 "[-bs] [-w WIDTH] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001284#define fold_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001285 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001286 "standard output\n" \
1287 "\nOptions:" \
1288 "\n -b Count bytes rather than columns" \
1289 "\n -s Break at spaces" \
1290 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001291
Eric Andersen7e9276b2001-02-22 01:15:47 +00001292#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001293 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001294#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001295 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001296#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001297 "$ free\n" \
1298 " total used free shared buffers\n" \
1299 " Mem: 257628 248724 8904 59644 93124\n" \
1300 " Swap: 128516 8404 120112\n" \
1301 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001302
Eric Andersen7e9276b2001-02-22 01:15:47 +00001303#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001304 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001305#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001306 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001307#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001308 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001309
Mike Frysinger51a43b42005-09-24 07:11:16 +00001310#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001311 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001312#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001313 "Check and repair filesystems\n" \
1314 "\nOptions:" \
1315 "\n -A Walk /etc/fstab and check all filesystems" \
1316 "\n -N Don't execute, just show what would be done" \
1317 "\n -P With -A, check filesystems in parallel" \
1318 "\n -R With -A, skip the root filesystem" \
1319 "\n -T Don't show title on startup" \
1320 "\n -V Verbose" \
1321 "\n -C n Write status information to specified filedescriptor" \
1322 "\n -t type List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001323
Eric Andersen7e9276b2001-02-22 01:15:47 +00001324#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001325 "[-larvsmf] /dev/name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001326#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001327 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001328 "\nOptions:" \
1329 "\n -l List all filenames" \
1330 "\n -r Perform interactive repairs" \
1331 "\n -a Perform automatic repairs" \
1332 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001333 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001334 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001335 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001336
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001337#define ftpd_trivial_usage \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001338 "[-wvS] [-t N] [-T N] [DIR]"
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001339#define ftpd_full_usage "\n\n" \
Denys Vlasenkoae357bd2009-09-11 23:29:45 +02001340 "Anonymous FTP server\n" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001341 "\n" \
1342 "ftpd should be used as an inetd service.\n" \
1343 "ftpd's line for inetd.conf:\n" \
1344 " 21 stream tcp nowait root ftpd ftpd /files/to/serve\n" \
1345 "It also can be ran from tcpsvd:\n" \
1346 " tcpsvd -vE 0.0.0.0 21 ftpd /files/to/serve\n" \
1347 "\nOptions:" \
1348 "\n -w Allow upload" \
Denis Vlasenko4221e902009-03-11 15:07:44 +00001349 "\n -v Log to stderr" \
1350 "\n -S Log to syslog" \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001351 "\n -t,-T Idle and absolute timeouts" \
Denis Vlasenko92576712009-03-09 16:25:33 +00001352 "\n DIR Change root to this directory" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001353
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001354#define ftpget_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001355 "[OPTIONS] HOST LOCAL_FILE REMOTE_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001356#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001357 "Retrieve a remote file via FTP\n" \
1358 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001359 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001360 "\n -c,--continue Continue previous transfer" \
1361 "\n -v,--verbose Verbose" \
1362 "\n -u,--username Username" \
1363 "\n -p,--password Password" \
1364 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001365 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001366 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001367 "\n -c Continue previous transfer" \
1368 "\n -v Verbose" \
1369 "\n -u Username" \
1370 "\n -p Password" \
1371 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001372 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001373
1374#define ftpput_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001375 "[OPTIONS] HOST REMOTE_FILE LOCAL_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001376#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001377 "Store a local file on a remote machine via FTP\n" \
1378 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001379 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001380 "\n -v,--verbose Verbose" \
1381 "\n -u,--username Username" \
1382 "\n -p,--password Password" \
1383 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001384 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001385 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001386 "\n -v Verbose" \
1387 "\n -u Username" \
1388 "\n -p Password" \
1389 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001390 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001391
Rob Landleyaa872762005-10-28 13:05:12 +00001392#define fuser_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001393 "[OPTIONS] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001394#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001395 "Find processes which use FILEs or PORTs\n" \
1396 "\nOptions:" \
1397 "\n -m Find processes which use same fs as FILEs" \
1398 "\n -4 Search only IPv4 space" \
1399 "\n -6 Search only IPv6 space" \
1400 "\n -s Silent: just exit with 0 if any processes are found" \
1401 "\n -k Kill found processes (otherwise display PIDs)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001402 "\n -SIGNAL Signal to send (default: TERM)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001403
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001404#define getenforce_trivial_usage NOUSAGE_STR
1405#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001406
Eric Andersen7e9276b2001-02-22 01:15:47 +00001407#define getopt_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001408 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001409#define getopt_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001410 "Options:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001411 IF_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001412 "\n -a,--alternative Allow long options starting with single -" \
1413 "\n -l,--longoptions=longopts Long options to be recognized" \
1414 "\n -n,--name=progname The name under which errors are reported" \
1415 "\n -o,--options=optstring Short options to be recognized" \
1416 "\n -q,--quiet Disable error reporting by getopt(3)" \
1417 "\n -Q,--quiet-output No normal output" \
1418 "\n -s,--shell=shell Set shell quoting conventions" \
1419 "\n -T,--test Test for getopt(1) version" \
1420 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001421 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001422 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001423 "\n -a Allow long options starting with single -" \
1424 "\n -l longopts Long options to be recognized" \
1425 "\n -n progname The name under which errors are reported" \
1426 "\n -o optstring Short options to be recognized" \
1427 "\n -q Disable error reporting by getopt(3)" \
1428 "\n -Q No normal output" \
1429 "\n -s shell Set shell quoting conventions" \
1430 "\n -T Test for getopt(1) version" \
1431 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001432 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001433#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001434 "$ cat getopt.test\n" \
1435 "#!/bin/sh\n" \
1436 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1437 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001438 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001439 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001440 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001441 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001442 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1443 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001444 " -c|--c-long)\n" \
1445 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001446 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1447 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1448 " esac;;\n" \
1449 " --) shift; break;;\n" \
1450 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001451 " esac\n" \
1452 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001453
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001454#define getsebool_trivial_usage \
1455 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001456#define getsebool_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001457 " -a Show all SELinux booleans"
1458
Eric Andersenf349e972001-08-21 16:18:59 +00001459#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001460 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001461#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001462 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1463 "\nOptions:" \
1464 "\n -h Enable hardware (RTS/CTS) flow control" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001465 "\n -i Don't display /etc/issue before running login" \
1466 "\n -L Local line, don't do carrier detect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001467 "\n -m Get baud rate from modem's CONNECT status message" \
1468 "\n -w Wait for a CR or LF before sending /etc/issue" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001469 "\n -n Don't prompt the user for a login name" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02001470 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
1471 "\n -l LOGIN Invoke LOGIN instead of /bin/login" \
1472 "\n -t SEC Terminate after SEC if no username is read" \
1473 "\n -I INITSTR Send INITSTR before anything else" \
1474 "\n -H HOST Log HOST into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001475
Eric Andersen7e9276b2001-02-22 01:15:47 +00001476#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001477 "[-HhrilLnqvso" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001478 IF_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001479 "eF" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001480 IF_FEATURE_GREP_EGREP_ALIAS("E") \
1481 IF_FEATURE_GREP_CONTEXT("ABC") \
1482 IF_EXTRA_COMPAT("z") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001483 "] PATTERN [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001484#define grep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001485 "Search for PATTERN in each FILE or standard input\n" \
1486 "\nOptions:" \
1487 "\n -H Prefix output lines with filename where match was found" \
1488 "\n -h Suppress the prefixing filename on output" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001489 "\n -r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001490 "\n -i Ignore case distinctions" \
1491 "\n -l List names of files that match" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001492 "\n -L List names of files that don't match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001493 "\n -n Print line number with output lines" \
1494 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1495 "\n -v Select non-matching lines" \
1496 "\n -s Suppress file open/read error messages" \
1497 "\n -c Only print count of matching lines" \
1498 "\n -o Show only the part of a line that matches PATTERN" \
1499 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001500 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001501 "\n -w Match whole words only") \
1502 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001503 IF_FEATURE_GREP_EGREP_ALIAS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001504 "\n -E PATTERN is an extended regular expression") \
1505 "\n -e PTRN Pattern to match" \
1506 "\n -f FILE Read pattern from file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001507 IF_FEATURE_GREP_CONTEXT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001508 "\n -A Print NUM lines of trailing context" \
1509 "\n -B Print NUM lines of leading context" \
1510 "\n -C Print NUM lines of output context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001511 IF_EXTRA_COMPAT( \
Denis Vlasenko83518d12009-03-20 22:17:13 +00001512 "\n -z Input is NUL terminated") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001513
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001514#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001515 "$ grep root /etc/passwd\n" \
1516 "root:x:0:0:root:/root:/bin/bash\n" \
1517 "$ grep ^[rR]oo. /etc/passwd\n" \
1518 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001519
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001520#define egrep_trivial_usage NOUSAGE_STR
1521#define egrep_full_usage ""
1522
1523#define fgrep_trivial_usage NOUSAGE_STR
1524#define fgrep_full_usage ""
1525
Eric Andersen7e9276b2001-02-22 01:15:47 +00001526#define gunzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001527 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001528#define gunzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001529 "Uncompress FILEs (or standard input)\n" \
1530 "\nOptions:" \
1531 "\n -c Write to standard output" \
1532 "\n -f Force" \
1533 "\n -t Test file integrity" \
1534
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001535#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001536 "$ ls -la /tmp/BusyBox*\n" \
1537 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1538 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1539 "$ ls -la /tmp/BusyBox*\n" \
1540 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001541
1542#define gzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001543 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001544#define gzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001545 "Compress FILEs (or standard input)\n" \
1546 "\nOptions:" \
1547 "\n -c Write to standard output" \
1548 "\n -d Decompress" \
1549 "\n -f Force" \
1550
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001551#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001552 "$ ls -la /tmp/busybox*\n" \
1553 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1554 "$ gzip /tmp/busybox.tar\n" \
1555 "$ ls -la /tmp/busybox*\n" \
1556 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001557
1558#define halt_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001559 "[-d delay] [-n] [-f]" IF_FEATURE_WTMP(" [-w]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001560#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001561 "Halt the system\n" \
1562 "\nOptions:" \
1563 "\n -d Delay interval for halting" \
1564 "\n -n No call to sync()" \
1565 "\n -f Force halt (don't go through init)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001566 IF_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001567 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001568 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001569
Eric Andersen3443bd72003-07-22 07:30:36 +00001570#define hdparm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001571 "[OPTIONS] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001572#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001573 "Options:" \
1574 "\n -a Get/set fs readahead" \
1575 "\n -A Set drive read-lookahead flag (0/1)" \
1576 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1577 "\n -B Set Advanced Power Management setting (1-255)" \
1578 "\n -c Get/set IDE 32-bit IO setting" \
1579 "\n -C Check IDE power mode status" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001580 IF_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001581 "\n -d Get/set using_dma flag") \
1582 "\n -D Enable/disable drive defect-mgmt" \
1583 "\n -f Flush buffer cache for device on exit" \
1584 "\n -g Display drive geometry" \
1585 "\n -h Display terse usage information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001586 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001587 "\n -i Display drive identification") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001588 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001589 "\n -I Detailed/current information directly from drive") \
1590 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1591 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1592 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1593 "\n -m Get/set multiple sector count" \
1594 "\n -n Get/set ignore-write-errors flag (0/1)" \
1595 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1596 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001597/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001598 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1599 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001600 IF_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001601 "\n -R Register an IDE interface (DANGEROUS)") \
1602 "\n -S Set standby (spindown) timeout" \
1603 "\n -t Perform device read timings" \
1604 "\n -T Perform cache read timings" \
1605 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001606 IF_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001607 "\n -U Un-register an IDE interface (DANGEROUS)") \
1608 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1609 "\n -V Display program version and exit immediately" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001610 IF_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001611 "\n -w Perform device reset (DANGEROUS)") \
1612 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001613 IF_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001614 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1615 "\n -X Set IDE xfer mode (DANGEROUS)" \
1616 "\n -y Put IDE drive in standby mode" \
1617 "\n -Y Put IDE drive to sleep" \
1618 "\n -Z Disable Seagate auto-powersaving mode" \
1619 "\n -z Re-read partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001620
Eric Andersen7e9276b2001-02-22 01:15:47 +00001621#define head_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001622 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001623#define head_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02001624 "Print first 10 lines of each FILE (or standard input) to standard output.\n" \
1625 "With more than one FILE, precede each with a header giving the file name.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001626 "\nOptions:" \
1627 "\n -n NUM Print first NUM lines instead of first 10" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001628 IF_FEATURE_FANCY_HEAD( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001629 "\n -c NUM Output the first NUM bytes" \
1630 "\n -q Never output headers giving file names" \
1631 "\n -v Always output headers giving file names") \
1632
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001633#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001634 "$ head -n 2 /etc/passwd\n" \
1635 "root:x:0:0:root:/root:/bin/bash\n" \
1636 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001637
Glenn L McGrath60281112001-11-02 11:39:46 +00001638#define hexdump_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001639 "[-bcCdefnosvx" IF_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001640#define hexdump_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02001641 "Display FILEs or standard input in a user specified format\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001642 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001643 "\n -b One-byte octal display" \
1644 "\n -c One-byte character display" \
1645 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1646 "\n -d Two-byte decimal display" \
1647 "\n -e FORMAT STRING" \
1648 "\n -f FORMAT FILE" \
1649 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1650 "\n -o Two-byte octal display" \
1651 "\n -s OFFSET Skip OFFSET bytes" \
1652 "\n -v Display all input data" \
1653 "\n -x Two-byte hexadecimal display" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001654 IF_FEATURE_HEXDUMP_REVERSE( \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001655 "\n -R Reverse of 'hexdump -Cv'") \
1656
1657#define hd_trivial_usage \
1658 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001659#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001660 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001661
Eric Andersen7e9276b2001-02-22 01:15:47 +00001662#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001663 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001664#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001665 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001666
1667#define hostname_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001668 "[OPTIONS] [HOSTNAME | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001669#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001670 "Get or set hostname or DNS domain name\n" \
1671 "\nOptions:" \
1672 "\n -s Short" \
1673 "\n -i Addresses for the hostname" \
1674 "\n -d DNS domain name" \
1675 "\n -f Fully qualified domain name" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001676 "\n -F FILE Use FILE's content as hostname" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001677
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001678#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001679 "$ hostname\n" \
1680 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001681
Denys Vlasenkod30b89c2009-06-26 01:55:45 +02001682#define dnsdomainname_trivial_usage NOUSAGE_STR
1683#define dnsdomainname_full_usage ""
1684
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001685#define httpd_trivial_usage \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001686 "[-ifv[v]]" \
1687 " [-c CONFFILE]" \
1688 " [-p [IP:]PORT]" \
1689 IF_FEATURE_HTTPD_SETUID(" [-u USER[:GRP]]") \
1690 IF_FEATURE_HTTPD_BASIC_AUTH(" [-r REALM]") \
1691 " [-h HOME]\n" \
1692 "or httpd -d/-e" IF_FEATURE_HTTPD_AUTH_MD5("/-m") " STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001693#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001694 "Listen for incoming HTTP requests\n" \
1695 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001696 "\n -i Inetd mode" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001697 "\n -f Don't daemonize" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001698 "\n -v[v] Verbose" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001699 "\n -c FILE Configuration file (default httpd.conf)" \
1700 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001701 IF_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001702 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001703 IF_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001704 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001705 "\n -h HOME Home directory (default .)" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001706 IF_FEATURE_HTTPD_AUTH_MD5( \
1707 "\n -m STRING MD5 crypt STRING") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001708 "\n -e STRING HTML encode STRING" \
1709 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001710
Robert Griebl1cd04452002-07-21 16:50:49 +00001711#define hwclock_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001712 IF_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001713 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1714 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001715 " [-f FILE]" \
1716 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001717 IF_NOT_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001718 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1719 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001720#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001721 "Query and set hardware clock (RTC)\n" \
1722 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001723 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001724 "\n -s Set system time from hardware clock" \
1725 "\n -w Set hardware clock to system time" \
1726 "\n -u Hardware clock is in UTC" \
1727 "\n -l Hardware clock is in local time" \
1728 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001729
Eric Andersen7e9276b2001-02-22 01:15:47 +00001730#define id_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001731 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001732#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001733 "Print information about USER or the current user\n" \
1734 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001735 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001736 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001737 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001738 "\n -u Print user ID" \
Denis Vlasenko4f3209b2008-09-13 12:51:10 +00001739 "\n -g Print group ID" \
1740 "\n -G Print supplementary group IDs" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001741 "\n -n Print name instead of a number" \
1742 "\n -r Print real user ID instead of effective ID" \
1743
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001744#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001745 "$ id\n" \
1746 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001747
Eric Andersen7e9276b2001-02-22 01:15:47 +00001748#define ifconfig_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001749 IF_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001750#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001751 "Configure a network interface\n" \
1752 "\nOptions:" \
1753 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001754 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001755 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001756 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001757 " [del ADDRESS[/PREFIXLEN]]\n") \
1758 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1759 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001760 IF_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001761 " [outfill NN] [keepalive NN]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001762 " " IF_FEATURE_IFCONFIG_HW("[hw ether" IF_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001763 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001764 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001765 IF_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001766 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001767 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001768
Denis Vlasenko06aed432008-02-26 18:25:24 +00001769#define ifenslave_trivial_usage \
1770 "[-cdf] master-iface <slave-iface...>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001771#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001772 "Configure network interfaces for parallel routing\n" \
1773 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001774 "\n -c, --change-active Change active slave" \
1775 "\n -d, --detach Remove slave interface from bonding device" \
1776 "\n -f, --force Force, even if interface is not Ethernet" \
1777/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001778
Denis Vlasenko06aed432008-02-26 18:25:24 +00001779#define ifenslave_example_usage \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001780 "To create a bond device, simply follow these three steps:\n" \
1781 "- ensure that the required drivers are properly loaded:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001782 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001783 "- assign an IP address to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001784 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001785 "- attach all the interfaces you need to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001786 " # ifenslave bond0 eth0 eth1 eth2\n" \
1787 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1788 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001789 " To detach a dead interface without setting the bond device down:\n" \
1790 " # ifenslave -d bond0 eth1\n\n" \
1791 " To set the bond device down and automatically release all the slaves:\n" \
1792 " # ifconfig bond0 down\n\n" \
1793 " To change active slave:\n" \
1794 " # ifenslave -c bond0 eth0\n" \
1795
1796#define ifplugd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001797 "[OPTIONS]"
Denis Vlasenko71c16572009-04-26 01:08:51 +00001798#define ifplugd_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +02001799 "Network interface plug detection daemon\n" \
1800 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001801 "\n -n Don't daemonize" \
1802 "\n -s Don't log to syslog" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001803 "\n -i IFACE Interface" \
1804 "\n -f/-F Treat link detection error as link down/link up" \
1805 "\n (otherwise exit on error)" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001806 "\n -a Don't up interface automatically" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001807 "\n -M Monitor creation/destruction of interface" \
1808 "\n (otherwise it must exist)" \
1809 "\n -r PROG Script to run" \
1810 "\n -x ARG Extra argument for script" \
1811 "\n -I Don't exit on nonzero exit code from script" \
1812 "\n -p Don't run script on daemon startup" \
1813 "\n -q Don't run script on daemon quit" \
1814 "\n -l Run script on startup even if no cable is detected" \
1815 "\n -t SECS Poll time in seconds" \
1816 "\n -u SECS Delay before running script after link up" \
1817 "\n -d SECS Delay after link down" \
1818 "\n -m MODE API mode (mii, priv, ethtool, wlan, auto)" \
1819 "\n -k Kill running daemon" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001820
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001821#define ifup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001822 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001823#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001824 "Options:" \
1825 "\n -a De/configure all interfaces automatically" \
1826 "\n -i FILE Use FILE for interface definitions" \
1827 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001828 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001829 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001830 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001831 ) \
1832 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001833 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001834
1835#define ifdown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001836 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001837#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001838 "Options:" \
1839 "\n -a De/configure all interfaces automatically" \
1840 "\n -i FILE Use FILE for interface definitions" \
1841 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001842 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001843 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001844 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001845 ) \
1846 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001847 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001848
Glenn L McGrath06e95652003-02-09 06:51:14 +00001849#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001850 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001851#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001852 "Listen for network connections and launch programs\n" \
1853 "\nOptions:" \
1854 "\n -f Run in foreground" \
1855 "\n -e Log to stderr" \
1856 "\n -q N Socket listen queue (default: 128)" \
1857 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001858 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001859
Eric Andersen7e9276b2001-02-22 01:15:47 +00001860#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001861 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001862#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001863 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001864
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001865#define init_notes_usage \
1866"This version of init is designed to be run only by the kernel.\n" \
1867"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001868"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001869"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001870"runlevels, use sysvinit.\n" \
1871"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001872"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001873"it has the following default behavior:\n" \
1874"\n" \
1875" ::sysinit:/etc/init.d/rcS\n" \
1876" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001877" ::ctrlaltdel:/sbin/reboot\n" \
1878" ::shutdown:/sbin/swapoff -a\n" \
1879" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001880" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001881"\n" \
1882"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1883"\n" \
1884" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001885" tty3::askfirst:/bin/sh\n" \
1886" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001887"\n" \
1888"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1889"\n" \
1890" <id>:<runlevels>:<action>:<process>\n" \
1891"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001892" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001893"\n" \
1894" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1895" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001896" the specified process to run on. The contents of this field are\n" \
1897" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1898" be unique, although if it isn't you may have strange results. If this\n" \
1899" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001900" note that if BusyBox detects that a serial console is in use, then only\n" \
1901" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001902" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001903" stinkin' utmp.\n" \
1904"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001905" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001906"\n" \
1907" The runlevels field is completely ignored.\n" \
1908"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001909" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001910"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001911" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001912" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001913"\n" \
1914" The available actions can be classified into two groups: actions\n" \
1915" that are run only once, and actions that are re-run when the specified\n" \
1916" process exits.\n" \
1917"\n" \
1918" Run only-once actions:\n" \
1919"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001920" 'sysinit' is the first item run on boot. init waits until all\n" \
1921" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001922" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001923" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001924" the specified task completes. 'once' actions are asynchronous,\n" \
1925" therefore, init does not wait for them to complete. 'restart' is\n" \
1926" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001927" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001928" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001929" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001930" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001931" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001932" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001933" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001934" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001935"\n" \
1936" Run repeatedly actions:\n" \
1937"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001938" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001939" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001940" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1941" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001942" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001943" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001944" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001945" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001946"\n" \
1947" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001948" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001949" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001950"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001951" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001952"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001953" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001954"\n" \
1955"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001956"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001957" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001958" #\n" \
1959" ::sysinit:/etc/init.d/rcS\n" \
1960" \n" \
1961" # /bin/sh invocations on selected ttys\n" \
1962" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001963" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001964" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001965" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001966" tty2::askfirst:-/bin/sh\n" \
1967" tty3::askfirst:-/bin/sh\n" \
1968" tty4::askfirst:-/bin/sh\n" \
1969" \n" \
1970" # /sbin/getty invocations for selected ttys\n" \
1971" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001972" tty4::respawn:/sbin/getty 38400 tty4\n" \
1973" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001974" \n" \
1975" \n" \
1976" # Example of how to put a getty on a serial line (for a terminal)\n" \
1977" #\n" \
1978" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1979" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1980" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001981" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001982" #::respawn:/sbin/getty 57600 ttyS2\n" \
1983" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001984" # Stuff to do when restarting the init process\n" \
1985" ::restart:/sbin/init\n" \
1986" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001987" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001988" ::ctrlaltdel:/sbin/reboot\n" \
1989" ::shutdown:/bin/umount -a -r\n" \
1990" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001991
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001992#define inotifyd_trivial_usage \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001993 "PROG FILE1[:MASK] ..."
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001994#define inotifyd_full_usage "\n\n" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00001995 "Run PROG on filesystem changes." \
1996 "\nWhen a filesystem event matching MASK occurs on FILEn," \
1997 "\nPROG <actual_event(s)> <FILEn> [<subfile_name>] is run." \
Denis Vlasenko289ff0e2008-11-14 21:52:16 +00001998 "\nEvents:" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001999 "\n a File is accessed" \
2000 "\n c File is modified" \
2001 "\n e Metadata changed" \
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02002002 "\n w Writable file is closed" \
2003 "\n 0 Unwritable file is closed" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002004 "\n r File is opened" \
Denis Vlasenkoa09a42c2008-11-17 22:19:18 +00002005 "\n D File is deleted" \
2006 "\n M File is moved" \
2007 "\n u Backing fs is unmounted" \
2008 "\n o Event queue overflowed" \
2009 "\n x File can't be watched anymore" \
2010 "\nIf watching a directory:" \
2011 "\n m Subfile is moved into dir" \
2012 "\n y Subfile is moved out of dir" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002013 "\n n Subfile is created" \
2014 "\n d Subfile is deleted" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002015 "\n" \
2016 "\ninotifyd waits for PROG to exit." \
2017 "\nWhen x event happens for all FILEs, inotifyd exits" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002018
Denis Vlasenko36309cf2008-11-22 18:29:01 +00002019/* 2.6 style insmod has no options and required filename
2020 * (not module name - .ko can't be omitted) */
Eric Andersen7e9276b2001-02-22 01:15:47 +00002021#define insmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002022 IF_FEATURE_2_4_MODULES("[OPTIONS] MODULE ") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002023 IF_NOT_FEATURE_2_4_MODULES("FILE ") \
Denis Vlasenko36309cf2008-11-22 18:29:01 +00002024 "[symbol=value]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002025#define insmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002026 "Load the specified kernel modules into the kernel" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002027 IF_FEATURE_2_4_MODULES( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002028 "\nOptions:" \
2029 "\n -f Force module to load into the wrong kernel version" \
2030 "\n -k Make module autoclean-able" \
2031 "\n -v Verbose" \
2032 "\n -q Quiet" \
2033 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002034 IF_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002035 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00002036 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002037 "\n -o NAME Set internal module name to NAME" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002038 "\n -x Don't export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00002039 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00002040
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002041/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00002042#define install_trivial_usage \
Denis Vlasenko4acdb462009-01-31 21:45:57 +00002043 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [source] dest|directory"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002044#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002045 "Copy files and set attributes\n" \
2046 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002047 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002048 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002049 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002050 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002051 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002052 "\n -o USER Set ownership" \
2053 "\n -g GRP Set group ownership" \
2054 "\n -m MODE Set permissions" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002055 IF_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002056 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002057 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002058
Denis Vlasenko4acdb462009-01-31 21:45:57 +00002059#define ionice_trivial_usage \
2060 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
2061#define ionice_full_usage "\n\n" \
2062 "Change I/O scheduling class and priority\n" \
2063 "\nOptions:" \
2064 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
2065 "\n -n Priority" \
2066
Denis Vlasenko397de612008-03-17 08:55:44 +00002067/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002068#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00002069 "[OPTIONS] {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002070 IF_FEATURE_IP_ADDRESS("address | ") \
2071 IF_FEATURE_IP_ROUTE("route | ") \
2072 IF_FEATURE_IP_LINK("link | ") \
2073 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2074 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002075 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002076#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002077 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002078 "where OBJECT := {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002079 IF_FEATURE_IP_ADDRESS("address | ") \
2080 IF_FEATURE_IP_ROUTE("route | ") \
2081 IF_FEATURE_IP_LINK("link | ") \
2082 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2083 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002084 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002085 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002086
2087#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002088 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002089 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002090#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002091 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002092 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
2093 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002094 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002095 " [broadcast ADDR] [anycast ADDR]\n" \
2096 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002097 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002098
Eric Andersende4f07e2003-12-11 01:18:07 +00002099#define ipcalc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002100 "[OPTIONS] ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002101#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002102 "Calculate IP network settings from a IP address\n" \
2103 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002104 IF_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002105 "\n -b,--broadcast Display calculated broadcast address" \
2106 "\n -n,--network Display calculated network address" \
2107 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002108 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002109 "\n -p,--prefix Display the prefix for IP/NETMASK" \
2110 "\n -h,--hostname Display first resolved host name" \
2111 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002112 ) \
2113 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002114 IF_NOT_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002115 "\n -b Display calculated broadcast address" \
2116 "\n -n Display calculated network address" \
2117 "\n -m 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 Display the prefix for IP/NETMASK" \
2120 "\n -h Display first resolved host name" \
2121 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002122 ) \
2123 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00002124
Rob Landley6eb1e412005-06-20 04:30:36 +00002125#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002126 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002127#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002128 "Upper-case options MQS remove an object by shmkey value.\n" \
2129 "Lower-case options remove an object by shmid value.\n" \
2130 "\nOptions:" \
2131 "\n -mM Remove memory segment after last detach" \
2132 "\n -qQ Remove message queue" \
2133 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002134
2135#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002136 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002137#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002138 " -i Show specific resource" \
2139 "\nResource specification:" \
2140 "\n -m Shared memory segments" \
2141 "\n -q Message queues" \
2142 "\n -s Semaphore arrays" \
2143 "\n -a All (default)" \
2144 "\nOutput format:" \
2145 "\n -t Time" \
2146 "\n -c Creator" \
2147 "\n -p Pid" \
2148 "\n -l Limits" \
2149 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002150
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002151#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002152 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002153#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00002154 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002155 " dynamic { on | off } |\n" \
2156 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002157 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002158
2159#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002160 "{ list | flush | { add | del | change | append |\n" \
2161 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002162#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002163 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002164 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
2165 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002166 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002167 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00002168 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
2169 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002170
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002171#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002172 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002173#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002174 "iprule [list | add | del] SELECTOR ACTION\n" \
2175 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2176 " [dev STRING] [pref NUMBER]\n" \
2177 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2178 " [prohibit | reject | unreachable]\n" \
2179 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002180 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002181
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002182#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002183 "{ add | change | del | show } [NAME]\n" \
2184 " [mode { ipip | gre | sit }]\n" \
2185 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002186#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002187 "iptunnel { add | change | del | show } [NAME]\n" \
2188 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2189 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002190 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002191
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002192#define kbd_mode_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002193 "[-a|k|s|u] [-C TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002194#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002195 "Report or set the keyboard mode\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002196 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002197 "\n -a Default (ASCII)" \
2198 "\n -k Medium-raw (keyboard)" \
2199 "\n -s Raw (scancode)" \
2200 "\n -u Unicode (utf-8)" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002201 "\n -C TTY Affect TTY instead of /dev/tty" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002202
Eric Andersen7e9276b2001-02-22 01:15:47 +00002203#define kill_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002204 "[-l] [-SIG] PID..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002205#define kill_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002206 "Send a signal (default: TERM) to given PIDs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002207 "\nOptions:" \
2208 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002209/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002210
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002211#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002212 "$ ps | grep apache\n" \
2213 "252 root root S [apache]\n" \
2214 "263 www-data www-data S [apache]\n" \
2215 "264 www-data www-data S [apache]\n" \
2216 "265 www-data www-data S [apache]\n" \
2217 "266 www-data www-data S [apache]\n" \
2218 "267 www-data www-data S [apache]\n" \
2219 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002220
2221#define killall_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002222 "[-l] [-q] [-SIG] process-name..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002223#define killall_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002224 "Send a signal (default: TERM) to given processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002225 "\nOptions:" \
2226 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002227/* "\n -s SIG Yet another way of specifying SIG" */ \
Denys Vlasenko07697852009-10-06 21:11:37 +02002228 "\n -q Don't complain if no processes were killed" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002229
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002230#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002231 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002232
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002233#define killall5_trivial_usage \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002234 "[-l] [-SIG] [-o PID]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002235#define killall5_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002236 "Send a signal (default: TERM) to all processes outside current session\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002237 "\nOptions:" \
2238 "\n -l List all signal names and numbers" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002239 "\n -o PID Don't signal this PID" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002240/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002241
Mark Whitley6317c4b2001-03-12 22:51:50 +00002242#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002243 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002244#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002245 "Kernel logger\n" \
2246 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002247 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002248 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002249
Eric Andersen7e9276b2001-02-22 01:15:47 +00002250#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002251 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002252#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002253 "Print STRING's length"
2254
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002255#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002256 "$ length Hello\n" \
2257 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002258
Rob Landley9200e792005-09-15 19:26:59 +00002259#define less_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002260 "[-EMNmh~I?] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002261#define less_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002262 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002263 "changed, and files can be manipulated in various ways.\n" \
2264 "\nOptions:" \
2265 "\n -E Quit once the end of a file is reached" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002266 "\n -M,-m Display status line with line numbers" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002267 "\n and percentage through the file" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002268 "\n -N Prefix line number to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002269 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002270 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002271
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002272#define linux32_trivial_usage NOUSAGE_STR
2273#define linux32_full_usage ""
2274#define linux64_trivial_usage NOUSAGE_STR
2275#define linux64_full_usage ""
2276
2277#define linuxrc_trivial_usage NOUSAGE_STR
2278#define linuxrc_full_usage ""
2279
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002280#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002281 "personality program [args...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002282#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002283 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002284 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002285 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002286
Eric Andersen7e9276b2001-02-22 01:15:47 +00002287#define ln_trivial_usage \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02002288 "[OPTIONS] TARGET... LINK|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002289#define ln_full_usage "\n\n" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02002290 "Create a link LINK or DIRECTORY/TARGET to the specified TARGET(s)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002291 "\nOptions:" \
2292 "\n -s Make symlinks instead of hardlinks" \
2293 "\n -f Remove existing destination files" \
2294 "\n -n Don't dereference symlinks - treat like normal file" \
2295 "\n -b Make a backup of the target (if exists) before link operation" \
2296 "\n -S suf Use suffix instead of ~ when making backup files" \
2297
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002298#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002299 "$ ln -s BusyBox /tmp/ls\n" \
2300 "$ ls -l /tmp/ls\n" \
2301 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002302
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002303#define load_policy_trivial_usage NOUSAGE_STR
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002304#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002305
Eric Andersen7e9276b2001-02-22 01:15:47 +00002306#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002307 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002308#define loadfont_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002309 "Load a console font from standard input" \
2310/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2311
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002312#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002313 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002314
2315#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002316 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002317#define loadkmap_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002318 "Load a binary keyboard translation table from standard input\n" \
2319/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2320
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002321#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002322 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002323
2324#define logger_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002325 "[OPTIONS] [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002326#define logger_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002327 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n" \
2328 "\nOptions:" \
2329 "\n -s Log to stderr as well as the system log" \
2330 "\n -t TAG Log using the specified tag (defaults to user name)" \
2331 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002332
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002333#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002334 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002335
Robert Griebl1fca5582002-06-04 20:45:46 +00002336#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002337 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002338#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002339 "Begin a new session on the system\n" \
2340 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002341 "\n -f Don't authenticate (user already authenticated)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002342 "\n -h Name of the remote host" \
2343 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002344
Eric Andersen7e9276b2001-02-22 01:15:47 +00002345#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002346 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002347#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002348 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002349#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002350 "$ logname\n" \
2351 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002352
Mark Whitley6317c4b2001-03-12 22:51:50 +00002353#define logread_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002354 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002355#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002356 "Show messages in syslogd's circular buffer\n" \
2357 "\nOptions:" \
2358 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002359
Matt Kraai83788da2002-03-20 17:38:37 +00002360#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002361 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2362 " losetup -d LOOPDEV - disassociate\n" \
2363 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002364#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002365 "Options:" \
2366 "\n -o OFS Start OFS bytes into FILE" \
2367 "\n -f Show first free loop device" \
2368
Rob Landley1d589b22005-11-29 23:47:10 +00002369#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002370 "No arguments will display all current associations.\n" \
2371 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002372 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002373 "and filename of the file the loop device is currently bound to.\n\n" \
2374 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002375 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2376 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002377
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002378#define lpd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002379 "SPOOLDIR [HELPER [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002380#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002381 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2382 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002383 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002384 "\ndirectory and HELPER program is called. Name of file to print" \
2385 "\nis passed in $DATAFILE variable." \
2386 "\nExample:" \
2387 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002388
Denis Vlasenko68444b92008-02-22 22:24:48 +00002389#define lpq_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002390 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID...] [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002391#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002392 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002393 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002394 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002395 "\n -f Force any waiting job to be printed" \
2396 "\n -s Short display" \
2397
2398#define lpr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002399 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE]..."
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002400/* -C CLASS exists too, not shown.
2401 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002402#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002403 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002404 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002405 "\n -m Send mail on completion" \
2406 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002407 "\n -V Verbose" \
2408
Eric Andersen7e9276b2001-02-22 01:15:47 +00002409#define ls_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002410 "[-1Aa" IF_FEATURE_LS_TIMESTAMPS("c") "Cd" \
2411 IF_FEATURE_LS_TIMESTAMPS("e") IF_FEATURE_LS_FILETYPES("F") "iln" \
2412 IF_FEATURE_LS_FILETYPES("p") IF_FEATURE_LS_FOLLOWLINKS("L") \
2413 IF_FEATURE_LS_RECURSIVE("R") IF_FEATURE_LS_SORTFILES("rS") "s" \
2414 IF_FEATURE_AUTOWIDTH("T") IF_FEATURE_LS_TIMESTAMPS("tu") \
2415 IF_FEATURE_LS_SORTFILES("v") IF_FEATURE_AUTOWIDTH("w") "x" \
2416 IF_FEATURE_LS_SORTFILES("X") IF_FEATURE_HUMAN_READABLE("h") "k" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002417 IF_SELINUX("K") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002418#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002419 "List directory contents\n" \
2420 "\nOptions:" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002421 "\n -1 List in a single column" \
2422 "\n -A Don't list . and .." \
2423 "\n -a Don't hide entries starting with ." \
2424 "\n -C List by columns" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002425 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002426 "\n -c With -l: sort by ctime") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002427 IF_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002428 "\n --color[={always,never,auto}] Control coloring") \
2429 "\n -d List directory entries instead of contents" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002430 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002431 "\n -e List full date and time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002432 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002433 "\n -F Append indicator (one of */=@|) to entries") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002434 "\n -i List inode numbers" \
2435 "\n -l Long listing format" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002436 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002437 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002438 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002439 IF_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002440 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002441 IF_FEATURE_LS_RECURSIVE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002442 "\n -R List subdirectories recursively") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002443 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002444 "\n -r Sort in reverse order") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002445 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002446 "\n -S Sort by file size") \
Denis Vlasenko397de612008-03-17 08:55:44 +00002447 "\n -s List the size of each file, in blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002448 IF_FEATURE_AUTOWIDTH( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002449 "\n -T NUM Assume tabstop every NUM columns") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002450 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002451 "\n -t With -l: sort by modification time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002452 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002453 "\n -u With -l: sort by access time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002454 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002455 "\n -v Sort by version") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002456 IF_FEATURE_AUTOWIDTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002457 "\n -w NUM Assume the terminal is NUM columns wide") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002458 "\n -x List by lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002459 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002460 "\n -X Sort by extension") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002461 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002462 "\n -h List sizes in human readable format (1K 243M 2G)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002463 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002464 "\n -k List security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002465 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002466 "\n -K List security context in long format") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002467 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002468 "\n -Z List security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002469
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002470#define lsattr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002471 "[-Radlv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002472#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002473 "List file attributes on an ext2 fs\n" \
2474 "\nOptions:" \
2475 "\n -R Recursively list subdirectories" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002476 "\n -a Don't hide entries starting with ." \
Denis Vlasenko397de612008-03-17 08:55:44 +00002477 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002478 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002479 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002480
Eric Andersen7e9276b2001-02-22 01:15:47 +00002481#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002482 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002483#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002484 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002485
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002486#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002487#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002488 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002489#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002490 "Create a range of block or character special files" \
2491 "\n" \
2492 "\nTYPE is:" \
2493 "\n b Block device" \
2494 "\n c Character device" \
2495 "\n f FIFO, MAJOR and MINOR are ignored" \
2496 "\n" \
2497 "\nFIRST..LAST specify numbers appended to NAME." \
2498 "\nIf 's' is the last argument, the base device is created as well." \
2499 "\n" \
2500 "\nExamples:" \
2501 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2502 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002503#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002504 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2505 "[creates ttyS2-ttyS63]\n" \
2506 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2507 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002508#endif
2509
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002510#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002511#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002512 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002513#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002514 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002515 "Device table entries take the form of:\n" \
2516 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002517 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002518 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002519 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002520 " c Character device\n" \
2521 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002522 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002523 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002524 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2525 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002526#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002527 "For example:\n" \
2528 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2529 "/dev d 755 0 0 - - - - -\n" \
2530 "/dev/console c 666 0 0 5 1 - - -\n" \
2531 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2532 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2533 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2534 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2535 "Will Produce:\n" \
2536 "/dev\n" \
2537 "/dev/console\n" \
2538 "/dev/null\n" \
2539 "/dev/zero\n" \
2540 "/dev/hda\n" \
2541 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002542#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002543
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002544#define makemime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002545 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002546#define makemime_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002547 "Create multipart MIME-encoded message from FILEs\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002548/* "Transfer encoding is base64, disposition is inline (not attachment)\n" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002549 "\nOptions:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002550 "\n -o FILE Output. Default: stdout" \
2551 "\n -a HDR Add header. Examples:" \
2552 "\n \"From: user@host.org\", \"Date: `date -R`\"" \
2553 "\n -c CT Content type. Default: text/plain" \
2554 "\n -C CS Charset. Default: " CONFIG_FEATURE_MIME_CHARSET \
2555/* "\n -e ENC Transfer encoding. Ignored. base64 is assumed" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002556 "\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002557 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002558
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002559#define man_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002560 "[OPTIONS] [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002561#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002562 "Format and display manual page\n" \
2563 "\nOptions:" \
2564 "\n -a Display all pages" \
2565 "\n -w Show page locations" \
2566
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002567#define matchpathcon_trivial_usage \
2568 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002569#define matchpathcon_full_usage "\n\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002570 " -n Don't display path" \
2571 "\n -N Don't use translations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002572 "\n -f Use alternate file_context file" \
2573 "\n -p Use prefix to speed translations" \
2574 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002575
Eric Andersen7e9276b2001-02-22 01:15:47 +00002576#define md5sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002577 "[OPTIONS] [FILE]..." \
2578 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTIONS] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002579#define md5sum_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002580 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2581 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002582 "\nOptions:" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002583 "\n -c Check sums against given list" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002584 "\n -s Don't output anything, status code shows success" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002585 "\n -w Warn about improperly formatted checksum lines" \
2586 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002587
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002588#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002589 "$ md5sum < busybox\n" \
2590 "6fd11e98b98a58f64ff3398d7b324003\n" \
2591 "$ md5sum busybox\n" \
2592 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2593 "$ md5sum -c -\n" \
2594 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2595 "busybox: OK\n" \
2596 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002597
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002598#define sha1sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002599 "[OPTIONS] [FILE]..." \
2600 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002601#define sha1sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002602 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002603 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002604 "\nOptions:" \
2605 "\n -c Check sums against given list" \
2606 "\n -s Don't output anything, status code shows success" \
2607 "\n -w Warn about improperly formatted checksum lines" \
2608 )
2609
2610#define sha256sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002611 "[OPTIONS] [FILE]..." \
2612 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha256sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002613#define sha256sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002614 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA256 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002615 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002616 "\nOptions:" \
2617 "\n -c Check sums against given list" \
2618 "\n -s Don't output anything, status code shows success" \
2619 "\n -w Warn about improperly formatted checksum lines" \
2620 )
2621
2622#define sha512sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002623 "[OPTIONS] [FILE]..." \
2624 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha512sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002625#define sha512sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002626 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA512 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002627 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002628 "\nOptions:" \
2629 "\n -c Check sums against given list" \
2630 "\n -s Don't output anything, status code shows success" \
2631 "\n -w Warn about improperly formatted checksum lines" \
2632 )
2633
Rob Landley70f7ef72005-12-13 08:21:33 +00002634#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002635 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002636#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002637 " -s Scan /sys and populate /dev during system boot\n" \
2638 "\n" \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002639 "It can be run by kernel as a hotplug helper. To activate it:\n" \
2640 " echo /bin/mdev >/proc/sys/kernel/hotplug\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002641 IF_FEATURE_MDEV_CONF( \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002642 "It uses /etc/mdev.conf with lines\n" \
Denis Vlasenkof2b39e02009-04-13 23:18:52 +00002643 "[-]DEVNAME UID:GID PERM" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002644 IF_FEATURE_MDEV_RENAME(" [>|=PATH]") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002645 IF_FEATURE_MDEV_EXEC(" [@|$|*PROG]") \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002646 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002647
Rob Landleyef10d522006-06-26 14:11:33 +00002648#define mdev_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002649 IF_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002650 "The mdev config file contains lines that look like:\n" \
2651 " hd[a-z][0-9]* 0:3 660\n\n" \
2652 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002653 IF_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002654 "Optionally, that can be followed (on the same line) by a special character\n" \
2655 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002656 "device(s). The environment variable $MDEV indicates the active device node\n" \
2657 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002658 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2659 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002660 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002661 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002662 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002663 "Config file parsing stops on the first matching line. If no config\n" \
2664 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002665 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002666 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002667
Glenn L McGrath061c9002002-09-16 04:21:46 +00002668#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002669 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002670#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002671 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002672 " y Allow write access to your terminal\n" \
2673 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002674
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002675#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002676 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002677#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002678 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2679 "\nOptions:" \
2680 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2681 "\n next byte to it" \
2682 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2683 "\n -s Set serial line to SPEED" \
2684 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002685
Eric Andersen7e9276b2001-02-22 01:15:47 +00002686#define mkdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002687 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002688#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002689 "Create DIRECTORY\n" \
2690 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002691 "\n -m Mode" \
2692 "\n -p No error if exists; make parent directories as needed" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002693 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002694 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002695 )
2696
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002697#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002698 "$ mkdir /tmp/foo\n" \
2699 "$ mkdir /tmp/foo\n" \
2700 "/tmp/foo: File exists\n" \
2701 "$ mkdir /tmp/foo/bar/baz\n" \
2702 "/tmp/foo/bar/baz: No such file or directory\n" \
2703 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002704
Eric Andersen7e9276b2001-02-22 01:15:47 +00002705#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002706 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002707#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002708 "Create named pipe (identical to 'mknod name p')\n" \
2709 "\nOptions:" \
2710 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002711 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002712 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002713 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002714
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002715#define mkfs_ext2_trivial_usage \
2716 /* "[-c|-l filename] " */ \
2717 "[-b BLK_SIZE] " \
2718 /* "[-f fragment-size] [-g blocks-per-group] " */ \
2719 "[-i BYTES_PER_INODE] " \
2720 /* "[-j] [-J journal-options] [-N number-of-inodes] [-n] " */ \
2721 "[-m RESERVED_PERCENT] " \
2722 /* "[-o creator-os] [-O feature[,...]] [-q] " */ \
2723 /* "[r fs-revision-level] [-E extended-options] [-v] [-F] " */ \
2724 "[-L LABEL] " \
2725 /* "[-M last-mounted-directory] [-S] [-T filesystem-type] " */ \
2726 "DEVICE [BLK_COUNT]"
2727#define mkfs_ext2_full_usage "\n" \
2728 "\n -b BLK_SIZE Block size in bytes" \
2729/* "\n -c Check for bad blocks before creating" */ \
2730/* "\n -E opts Set extended options" */ \
2731/* "\n -f size Fragment size in bytes" */ \
2732/* "\n -F Force (ignore sanity checks)" */ \
2733/* "\n -g num Number of blocks in a block group" */ \
2734 "\n -i BYTES The bytes/inode ratio" \
2735/* "\n -j Create a journal (ext3)" */ \
2736/* "\n -J opts Set journal options (size/device)" */ \
2737/* "\n -l file Read bad blocks list from file" */ \
2738 "\n -L LABEL Set the volume label" \
2739 "\n -m PERCENT Percent of blocks to reserve for admin" \
2740/* "\n -M dir Set last mounted directory" */ \
2741/* "\n -n Don't actually create anything" */ \
2742/* "\n -N num Number of inodes to create" */ \
2743/* "\n -o os Set the 'creator os' field" */ \
2744/* "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" */ \
2745/* "\n -q Quiet" */ \
2746/* "\n -r rev Set filesystem revision" */ \
2747/* "\n -S Write superblock and group descriptors only" */ \
2748/* "\n -T fs-type Set usage type (news/largefile/largefile4)" */ \
2749/* "\n -v Verbose" */ \
2750
Eric Andersen7e9276b2001-02-22 01:15:47 +00002751#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002752 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002753#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002754 "Make a MINIX filesystem\n" \
2755 "\nOptions:" \
2756 "\n -c Check device for bad blocks" \
2757 "\n -n [14|30] Maximum length of filenames" \
2758 "\n -i INODES Number of inodes for the filesystem" \
2759 "\n -l FILENAME Read bad blocks list from FILENAME" \
2760 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002761
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002762#define mkfs_vfat_trivial_usage \
2763 "[-v] [-n LABEL] FILE_OR_DEVICE [SIZE_IN_KB]"
2764/* Accepted but ignored:
2765 "[-c] [-C] [-I] [-l bad-block-file] [-b backup-boot-sector] "
2766 "[-m boot-msg-file] [-i volume-id] "
2767 "[-s sectors-per-cluster] [-S logical-sector-size] [-f number-of-FATs] "
2768 "[-h hidden-sectors] [-F fat-size] [-r root-dir-entries] [-R reserved-sectors] "
2769*/
2770#define mkfs_vfat_full_usage "\n\n" \
2771 "Make a FAT32 filesystem\n" \
2772 "\nOptions:" \
2773/* "\n -c Check device for bad blocks" */ \
2774 "\n -v Verbose" \
2775/* "\n -I Allow to use entire disk device (e.g. /dev/hda)" */ \
2776 "\n -n LBL Volume label" \
2777
Eric Andersen7e9276b2001-02-22 01:15:47 +00002778#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002779 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002780#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002781 "Create a special file (block, character, or pipe)\n" \
2782 "\nOptions:" \
2783 "\n -m Create the special file using the specified mode (default a=rw)" \
2784 "\nTYPEs include:" \
2785 "\n b: Make a block device" \
2786 "\n c or u: Make a character device" \
2787 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002788 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002789 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002790 )
2791
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002792#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002793 "$ mknod /dev/fd0 b 2 0\n" \
2794 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002795
Eric Andersen7e9276b2001-02-22 01:15:47 +00002796#define mkswap_trivial_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002797 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002798#define mkswap_full_usage "\n\n" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002799 "Prepare block device to be used as swap partition"
2800#if 0
2801 "[-c] [-v0|-v1] DEVICE [BLOCKS]"
Denis Vlasenko397de612008-03-17 08:55:44 +00002802 "\nOptions:"
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002803 "\n -c Check for readability"
2804 "\n -v0 Make swap version 0 (max 128M)"
2805 "\n -v1 Make swap version 1 (default for kernels > 2.1.117)"
2806 "\n BLOCKS Number of blocks to use (default is entire partition)"
2807#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002808
Eric Andersen7e9276b2001-02-22 01:15:47 +00002809#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002810 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002811#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002812 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002813 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002814 "\nOptions:" \
2815 "\n -d Make a directory instead of a file" \
2816/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2817 "\n -t Generate a path rooted in temporary directory" \
2818 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2819 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002820 "\nFor -t or -p, directory is chosen as follows:" \
2821 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002822
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002823#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002824 "$ mktemp /tmp/temp.XXXXXX\n" \
2825 "/tmp/temp.mWiLjM\n" \
2826 "$ ls -la /tmp/temp.mWiLjM\n" \
2827 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002828
Eric Andersen8d79ce82001-07-22 23:00:15 +00002829#define modprobe_trivial_usage \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002830 IF_MODPROBE_SMALL("[-qfwrsv] MODULE [symbol=value...]") \
2831 IF_NOT_MODPROBE_SMALL("[-" \
2832 IF_FEATURE_2_4_MODULES("k")"nqrsv" \
2833 IF_FEATURE_MODPROBE_BLACKLIST("b")"] MODULE [symbol=value...]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002834#define modprobe_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002835 "Options:" \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002836 IF_MODPROBE_SMALL( \
2837 "\n -q Quiet" \
2838 "\n -f Force" \
2839 "\n -w Wait for unload" \
2840 "\n -r Remove module (stacks) or do autoclean" \
2841 "\n -s Report via syslog instead of stderr" \
2842 "\n -v Verbose" \
2843 ) \
2844 IF_NOT_MODPROBE_SMALL( \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002845 IF_FEATURE_2_4_MODULES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002846 "\n -k Make module autoclean-able" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002847 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002848 "\n -n Dry run" \
2849 "\n -q Quiet" \
2850 "\n -r Remove module (stacks) or do autoclean" \
2851 "\n -s Report via syslog instead of stderr" \
2852 "\n -v Verbose" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002853 IF_FEATURE_MODPROBE_BLACKLIST( \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002854 "\n -b Apply blacklist to module names too" \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002855 ) \
2856 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002857
Rob Landley9c32a152005-12-11 20:12:24 +00002858#define modprobe_notes_usage \
2859"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2860"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2861"pass each module it loads.\n" \
2862"\n" \
Bernhard Reutner-Fischer12aca792009-02-24 10:03:22 +00002863"The configuration file is searched (in this order):\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002864"\n" \
2865" /etc/modprobe.conf (2.6 only)\n" \
2866" /etc/modules.conf\n" \
2867" /etc/conf.modules (deprecated)\n" \
2868"\n" \
2869"They all have the same syntax (see below). If none is present, it is\n" \
2870"_not_ an error; each loaded module is then expected to load without\n" \
2871"options. Once a file is found, the others are tested for.\n" \
2872"\n" \
2873"/etc/modules.conf entry format:\n" \
2874"\n" \
2875" alias <alias_name> <mod_name>\n" \
2876" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002877" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002878" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2879" This makes it also possible to use a different set of options (below) for\n" \
2880" the module and the alias.\n" \
2881" A module can be aliased more than once.\n" \
2882"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002883" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002884" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2885" the \"symbol=value\" pairs as option to that module.\n" \
2886"\n" \
2887"Sample /etc/modules.conf file:\n" \
2888"\n" \
2889" options tulip irq=3\n" \
2890" alias tulip tulip2\n" \
2891" options tulip2 irq=4 io=0x308\n" \
2892"\n" \
2893"Other functionality offered by 'classic' modprobe is not available in\n" \
2894"this implementation.\n" \
2895"\n" \
2896"If module options are present both in the config file, and on the command line,\n" \
2897"then the options from the command line will be passed to the module _after_\n" \
2898"the options from the config file. That way, you can have defaults in the config\n" \
2899"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002900#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002901 "(with the above /etc/modules.conf):\n\n" \
2902 "$ modprobe tulip\n" \
2903 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2904 "$ modprobe tulip irq=5\n" \
2905 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2906 "$ modprobe tulip2\n" \
2907 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2908 " which are the default for alias 'tulip2'\n\n" \
2909 "$ modprobe tulip2 irq=8\n" \
2910 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2911 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2912 " from the command line\n\n" \
2913 "$ modprobe tulip2 irq=2 io=0x210\n" \
2914 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2915 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2916 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002917
Eric Andersen7e9276b2001-02-22 01:15:47 +00002918#define more_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002919 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002920#define more_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002921 "View FILE or standard input one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002922
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002923#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002924 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002925
Eric Andersen7e9276b2001-02-22 01:15:47 +00002926#define mount_trivial_usage \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002927 "[flags] DEVICE NODE [-o OPT,OPT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002928#define mount_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002929 "Mount a filesystem. Filesystem autodetection requires /proc.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002930 "\nOptions:" \
2931 "\n -a Mount all filesystems in fstab" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002932 IF_FEATURE_MOUNT_FAKE( \
2933 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002934 "\n -f Update /etc/mtab, but don't mount" \
2935 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002936 IF_NOT_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002937 "\n -f Dry run" \
2938 ) \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002939 ) \
Denys Vlasenkoe2e4cc22009-06-19 11:48:29 +02002940 IF_FEATURE_MOUNT_HELPERS( \
2941 "\n -i Don't run mount helper" \
2942 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002943 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002944 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002945 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002946 "\n -r Read-only mount" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002947 "\n -w Read-write mount (default)" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002948 "\n -t FSTYPE Filesystem type" \
2949 "\n -O OPT Mount only filesystems with option OPT (-a only)" \
2950 "\n-o OPT:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002951 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002952 "\n loop Ignored (loop devices are autodetected)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002953 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002954 IF_FEATURE_MOUNT_FLAGS( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002955 "\n [a]sync Writes are [a]synchronous" \
2956 "\n [no]atime Disable/enable updates to inode access times" \
2957 "\n [no]diratime Disable/enable atime updates to directories" \
2958 "\n [no]relatime Disable/enable atime updates relative to modification time" \
2959 "\n [no]dev (Dis)allow use of special device files" \
2960 "\n [no]exec (Dis)allow use of executable files" \
2961 "\n [no]suid (Dis)allow set-user-id-root programs" \
2962 "\n [r]shared Convert [recursively] to a shared subtree" \
2963 "\n [r]slave Convert [recursively] to a slave subtree" \
2964 "\n [r]private Convert [recursively] to a private subtree" \
2965 "\n [un]bindable Make mount point [un]able to be bind mounted" \
2966 "\n bind Bind a directory to an additional location" \
2967 "\n move Relocate an existing mount point" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002968 ) \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00002969 "\n remount Remount a mounted filesystem, changing its flags" \
2970 "\n ro/rw Read-only/read-write mount" \
2971 "\n" \
2972 "\nThere are EVEN MORE flags that are specific to each filesystem" \
2973 "\nYou'll have to see the written documentation for those filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002974
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002975#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002976 "$ mount\n" \
2977 "/dev/hda3 on / type minix (rw)\n" \
2978 "proc on /proc type proc (rw)\n" \
2979 "devpts on /dev/pts type devpts (rw)\n" \
2980 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2981 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2982 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002983#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002984 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002985
Rob Landleyd00b3a52005-08-20 05:07:08 +00002986#define mountpoint_trivial_usage \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002987 "[-q] <[-dn] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002988#define mountpoint_full_usage "\n\n" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002989 "Check if the directory is a mountpoint\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002990 "\nOptions:" \
2991 "\n -q Quiet" \
2992 "\n -d Print major/minor device number of the filesystem" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00002993 "\n -n Print device name of the filesystem" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002994 "\n -x Print major/minor device number of the blockdevice" \
2995
Rob Landleyd00b3a52005-08-20 05:07:08 +00002996#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002997 "$ mountpoint /proc\n" \
2998 "/proc is not a mountpoint\n" \
2999 "$ mountpoint /sys\n" \
3000 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00003001
Eric Andersen7e9276b2001-02-22 01:15:47 +00003002#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003003 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003004#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003005 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003006 "\n" \
3007 "Available Opcodes:\n" \
3008 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003009 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
3010 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
3011 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003012 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003013
Eric Andersen7e9276b2001-02-22 01:15:47 +00003014#define mv_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003015 "[OPTIONS] SOURCE DEST\n" \
3016 "or: mv [OPTIONS] SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003017#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003018 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
3019 "\nOptions:" \
3020 "\n -f Don't prompt before overwriting" \
3021 "\n -i Interactive, prompt before overwrite" \
3022
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003023#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003024 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003025
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003026#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003027 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003028#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003029 "Rename network interface while it in the down state\n" \
3030 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003031 "\n -c FILE Use configuration file (default: /etc/mactab)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003032 "\n -s Use syslog (LOCAL0 facility)" \
3033 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
3034
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003035#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003036 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
3037 " or\n" \
3038 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003039
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003040#if !ENABLE_DESKTOP
3041
Rob Landley1cca9482006-07-10 19:45:20 +00003042#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003043#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003044#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003045#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003046#endif
Rob Landley1cca9482006-07-10 19:45:20 +00003047
Eric Andersen7e9276b2001-02-22 01:15:47 +00003048#define nc_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003049 IF_NC_EXTRA("[-iN] [-wN] ")IF_NC_SERVER("[-l] [-p PORT] ") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003050 "["IF_NC_EXTRA("-f FILENAME|")"IPADDR PORT]"IF_NC_EXTRA(" [-e PROG]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003051#define nc_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003052 "Open a pipe to IP:port" IF_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003053 NC_OPTIONS_STR \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003054 IF_NC_EXTRA( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003055 "\n -e PROG Run PROG after connect" \
3056 "\n -i SEC Delay interval for lines sent" \
3057 "\n -w SEC Timeout for connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003058 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003059 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003060 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003061 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003062 IF_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003063 "\n (use -l twice with -e for persistent server)") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003064 "\n -p PORT Local port" \
Rob Landley1cca9482006-07-10 19:45:20 +00003065 )
3066
Rob Landley1cca9482006-07-10 19:45:20 +00003067#define nc_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003068 IF_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003069 "To use netcat as a terminal emulator on a serial port:\n\n" \
3070 "$ stty 115200 -F /dev/ttyS0\n" \
3071 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
3072 )
Rob Landley1cca9482006-07-10 19:45:20 +00003073
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003074#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003075 "$ nc foobar.somedomain.com 25\n" \
3076 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
3077 "help\n" \
3078 "214-Commands supported:\n" \
3079 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
3080 "214 NOOP QUIT RSET HELP\n" \
3081 "quit\n" \
3082 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003083
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003084#else /* DESKTOP nc - much more compatible with nc 1.10 */
3085
3086#define nc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003087 "[OPTIONS] HOST PORT - connect" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003088 IF_NC_SERVER("\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003089 "nc [OPTIONS] -l -p PORT [HOST] [PORT] - listen")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003090#define nc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003091 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003092 "\n -e PROG Run PROG after connect (must be last)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003093 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003094 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003095 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003096 "\n -n Don't do DNS resolution" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003097 "\n -s ADDR Local address" \
3098 "\n -p PORT Local port" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003099 "\n -u UDP mode" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003100 "\n -v Verbose" \
3101 "\n -w SEC Timeout for connects and final net reads" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003102 IF_NC_EXTRA( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003103 "\n -i SEC Delay interval for lines sent" /* ", ports scanned" */ \
3104 "\n -o FILE Hex dump traffic" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003105 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003106 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003107/* "\n -r Randomize local and remote ports" */
3108/* "\n -g gateway Source-routing hop point[s], up to 8" */
3109/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003110/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
3111
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003112/* -e PROG can take ARGS too: "nc ... -e ls -l", but we don't document it
3113 * in help text: nc 1.10 does not allow that. We don't want to entice
3114 * users to use this incompatibility */
3115
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003116#endif
3117
Eric Andersen1552ff72001-10-31 11:07:12 +00003118#define netstat_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003119 "[-laentuwxr"IF_FEATURE_NETSTAT_WIDE("W")IF_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003120#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003121 "Display networking information\n" \
3122 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003123 "\n -l Display listening server sockets" \
3124 "\n -a Display all sockets (default: connected)" \
3125 "\n -e Display other/more information" \
3126 "\n -n Don't resolve names" \
3127 "\n -t Tcp sockets" \
3128 "\n -u Udp sockets" \
3129 "\n -w Raw sockets" \
3130 "\n -x Unix sockets" \
3131 "\n -r Display routing table" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003132 IF_FEATURE_NETSTAT_WIDE( \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003133 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003134 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003135 IF_FEATURE_NETSTAT_PRG( \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003136 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003137 )
Eric Andersen1552ff72001-10-31 11:07:12 +00003138
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003139#define nice_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003140 "[-n ADJUST] [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003141#define nice_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003142 "Run PROG with modified scheduling priority\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003143 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003144 "\n -n ADJUST Adjust priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003145
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003146#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003147 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003148#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003149 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003150 "Format specifiers:\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003151 " %Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003152 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003153 " %[niface] Monitor network interface 'iface'\n" \
3154 " %m Monitor allocated memory\n" \
3155 " %[mf] Monitor free memory\n" \
3156 " %[mt] Monitor total memory\n" \
3157 " %s Monitor allocated swap\n" \
3158 " %f Monitor number of used file descriptors\n" \
3159 " %Ni Monitor total/specific IRQ rate\n" \
3160 " %x Monitor context switch rate\n" \
3161 " %p Monitor forks\n" \
3162 " %[pn] Monitor # of processes\n" \
3163 " %b Monitor block io\n" \
3164 " %Nt Show time (with N decimal points)\n" \
3165 " %Nd Milliseconds between updates (default:1000)\n" \
3166 " %r Print <cr> instead of <lf> at EOL" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003167
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003168#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003169 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003170
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003171#define nohup_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003172 "PROG [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003173#define nohup_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003174 "Run PROG immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003175#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003176 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003177
Eric Andersen7e9276b2001-02-22 01:15:47 +00003178#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003179 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003180#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003181 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003182 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003183#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003184 "$ nslookup localhost\n" \
3185 "Server: default\n" \
3186 "Address: default\n" \
3187 "\n" \
3188 "Name: debian\n" \
3189 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003190
Glenn L McGrath60281112001-11-02 11:39:46 +00003191#define od_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003192 "[-aBbcDdeFfHhIiLlOovXx] " IF_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003193#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003194 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003195 "(or standard input) to standard output."
Glenn L McGrath60281112001-11-02 11:39:46 +00003196
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003197#define openvt_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003198 "[-c N] [-sw] [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003199#define openvt_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003200 "Start PROG on a new virtual terminal\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003201 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003202 "\n -c N Use specified VT" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003203 "\n -s Switch to the VT" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003204/* "\n -l Run PROG as login shell (by prepending '-')" */ \
3205 "\n -w Wait for PROG to exit" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003206
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003207#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003208 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003209
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003210#define parse_trivial_usage \
3211 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
3212#define parse_full_usage "\n\n" \
3213 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
3214
Eric Andersen27f64e12002-06-23 04:24:25 +00003215#define passwd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003216 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003217#define passwd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003218 "Change USER's password. If no USER is specified,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003219 "changes the password for the current user.\n" \
3220 "\nOptions:" \
3221 "\n -a Algorithm to use for password (choices: des, md5)" /* ", sha1)" */ \
3222 "\n -d Delete password for the account" \
3223 "\n -l Lock (disable) account" \
3224 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003225
Denis Vlasenko21d10142007-07-20 21:28:41 +00003226#define chpasswd_trivial_usage \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003227 IF_LONG_OPTS("[--md5|--encrypted]") IF_NOT_LONG_OPTS("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003228#define chpasswd_full_usage "\n\n" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003229 "Read user:password from stdin and update /etc/passwd\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003230 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003231 IF_LONG_OPTS( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003232 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003233 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003234 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003235 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003236 "\n -e Supplied passwords are in encrypted form" \
3237 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003238 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00003239
Glenn L McGrath655d8142003-06-22 15:32:41 +00003240#define patch_trivial_usage \
Denys Vlasenkod7874ed2009-08-20 23:33:19 +02003241 "[-p NUM] [-i DIFF] [-R] [-N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003242#define patch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003243 " -p NUM Strip NUM leading components from file names" \
3244 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003245 "\n -R Reverse patch" \
Denys Vlasenkod7874ed2009-08-20 23:33:19 +02003246 "\n -N Ignore already applied patches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003247
Glenn L McGrath655d8142003-06-22 15:32:41 +00003248#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003249 "$ patch -p1 < example.diff\n" \
3250 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00003251
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003252#define pgrep_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003253 "[-flnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003254#define pgrep_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003255 "Display process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003256 "\nOptions:" \
3257 "\n -l Show command name too" \
3258 "\n -f Match against entire command line" \
3259 "\n -n Show the newest process only" \
3260 "\n -o Show the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003261 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003262 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003263 "\n -s Match session ID (0 for current)" \
3264 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003265
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003266#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00003267#define pidof_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003268 "[OPTIONS] [NAME...]"
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003269#define USAGE_PIDOF "\n\nOptions:"
3270#else
3271#define pidof_trivial_usage \
3272 "[NAME...]"
3273#define USAGE_PIDOF /* none */
3274#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003275#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003276 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003277 USAGE_PIDOF \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003278 IF_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003279 "\n -s Show only one PID") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003280 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003281 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003282 "\n Use %PPID to omit pid of pidof's parent") \
3283
Eric Andersen221b2ea2001-07-31 19:06:07 +00003284#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003285 "$ pidof init\n" \
3286 "1\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003287 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003288 "$ pidof /bin/sh\n20351 5973 5950\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003289 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003290 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00003291
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003292#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003293#define ping_trivial_usage \
3294 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003295#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003296 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003297#define ping6_trivial_usage \
3298 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003299#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003300 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003301#else
3302#define ping_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003303 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003304#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003305 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3306 "\nOptions:" \
3307 "\n -4, -6 Force IPv4 or IPv6 hostname resolution" \
3308 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003309 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3310 "\n -I IFACE/IP Use interface or IP address as source" \
3311 "\n -W SEC Seconds to wait for the first response (default:10)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003312 "\n (after all -c CNT packets are sent)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003313 "\n -w SEC Seconds until ping exits (default:infinite)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003314 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003315 "\n -q Quiet, only displays output at start" \
3316 "\n and when finished" \
3317
Eric Andersen51b8bd62002-07-03 11:46:38 +00003318#define ping6_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003319 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003320#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003321 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3322 "\nOptions:" \
3323 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003324 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3325 "\n -I IFACE/IP Use interface or IP address as source" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003326 "\n -q Quiet, only displays output at start" \
3327 "\n and when finished" \
3328
Eric Andersen51b8bd62002-07-03 11:46:38 +00003329#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003330#define ping_example_usage \
3331 "$ ping localhost\n" \
3332 "PING slag (127.0.0.1): 56 data bytes\n" \
3333 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3334 "\n" \
3335 "--- debian ping statistics ---\n" \
3336 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3337 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003338#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003339 "$ ping6 ip6-localhost\n" \
3340 "PING ip6-localhost (::1): 56 data bytes\n" \
3341 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3342 "\n" \
3343 "--- ip6-localhost ping statistics ---\n" \
3344 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3345 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003346
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003347#define pipe_progress_trivial_usage NOUSAGE_STR
3348#define pipe_progress_full_usage ""
3349
Eric Andersen7e9276b2001-02-22 01:15:47 +00003350#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003351 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003352#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003353 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003354 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003355
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003356#define pkill_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003357 "[-l|-SIGNAL] [-fnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003358#define pkill_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003359 "Send a signal to process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003360 "\nOptions:" \
3361 "\n -l List all signals" \
3362 "\n -f Match against entire command line" \
3363 "\n -n Signal the newest process only" \
3364 "\n -o Signal the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003365 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003366 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003367 "\n -s Match session ID (0 for current)" \
3368 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003369
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003370#define popmaildir_trivial_usage \
3371 "[OPTIONS] Maildir [connection-helper ...]"
3372#define popmaildir_full_usage "\n\n" \
3373 "Fetch content of remote mailbox to local maildir\n" \
3374 "\nOptions:" \
3375 "\n -b Binary mode. Ignored" \
3376 "\n -d Debug. Ignored" \
3377 "\n -m Show used memory. Ignored" \
3378 "\n -V Show version. Ignored" \
3379 "\n -c Use tcpclient. Ignored" \
3380 "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" \
3381 "\n -s Skip authorization" \
3382 "\n -T Get messages with TOP instead with RETR" \
3383 "\n -k Keep retrieved messages on the server" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003384 "\n -t timeout Network timeout" \
3385 IF_FEATURE_POPMAILDIR_DELIVERY( \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003386 "\n -F \"program arg1 arg2 ...\" Filter by program. May be multiple" \
3387 "\n -M \"program arg1 arg2 ...\" Deliver by program" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003388 ) \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003389 "\n -R size Remove old messages on the server >= size (in bytes). Ignored" \
3390 "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" \
Denys Vlasenko07697852009-10-06 21:11:37 +02003391 "\n -L size Don't retrieve new messages >= size (in bytes). Ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003392 "\n -H lines Type specified number of lines of a message. Ignored"
3393#define popmaildir_example_usage \
3394 "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n" \
3395 "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
3396
Eric Andersen7e9276b2001-02-22 01:15:47 +00003397#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003398 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003399#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003400 "Halt and shut off power\n" \
3401 "\nOptions:" \
3402 "\n -d Delay interval for halting" \
3403 "\n -n No call to sync()" \
3404 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003405
Mike Frysinger95d3c452005-04-21 23:29:24 +00003406#define printenv_trivial_usage \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003407 "[VARIABLE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003408#define printenv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003409 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003410 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003411
Eric Andersen7e9276b2001-02-22 01:15:47 +00003412#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003413 "FORMAT [ARGUMENT...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003414#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003415 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003416 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003417#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003418 "$ printf \"Val=%d\\n\" 5\n" \
3419 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003420
Denis Vlasenko94949192006-11-05 00:45:47 +00003421
3422#if ENABLE_DESKTOP
3423
3424#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003425 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003426#define ps_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003427 "Report process status\n" \
3428 "\nOptions:" \
3429 "\n -o col1,col2=header Select columns for display" \
Denys Vlasenko532609e2009-09-20 20:29:25 +02003430 IF_FEATURE_SHOW_THREADS( \
3431 "\n -T Show threads" \
3432 )
Denis Vlasenko94949192006-11-05 00:45:47 +00003433
3434#else /* !ENABLE_DESKTOP */
3435
Denis Vlasenko397de612008-03-17 08:55:44 +00003436#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003437#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003438#else
3439#define USAGE_PS "\nOptions:"
3440#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003441
Eric Andersen7e9276b2001-02-22 01:15:47 +00003442#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003443 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003444#define ps_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003445 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003446 USAGE_PS \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003447 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003448 "\n -Z Show SE Linux context" \
3449 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003450 IF_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003451 "\n w Wide output" \
3452 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003453
Denis Vlasenko94949192006-11-05 00:45:47 +00003454#endif /* ENABLE_DESKTOP */
3455
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003456#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003457 "$ ps\n" \
3458 " PID Uid Gid State Command\n" \
3459 " 1 root root S init\n" \
3460 " 2 root root S [kflushd]\n" \
3461 " 3 root root S [kupdate]\n" \
3462 " 4 root root S [kpiod]\n" \
3463 " 5 root root S [kswapd]\n" \
3464 " 742 andersen andersen S [bash]\n" \
3465 " 743 andersen andersen S -bash\n" \
3466 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003467 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003468
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003469#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003470 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003471#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003472 "Scan a host, print all open ports\n" \
3473 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003474 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003475 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003476 "\n -p Scan from this port (default 1)" \
3477 "\n -P Scan up to this port (default 1024)" \
3478 "\n -t Timeout (default 5000 ms)" \
3479 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3480
Eric Andersen7e9276b2001-02-22 01:15:47 +00003481#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003482 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003483#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003484 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003485#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003486 "$ pwd\n" \
3487 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003488
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003489#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003490 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003491#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003492 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003493#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003494 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003495
Eric Andersen7e9276b2001-02-22 01:15:47 +00003496#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003497 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003498#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003499 "Get and possibly set the system date and time from a remote HOST\n" \
3500 "\nOptions:" \
3501 "\n -s Set the system date and time (default)" \
3502 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003503
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00003504#define rdev_trivial_usage \
3505 ""
3506#define rdev_full_usage "\n\n" \
3507 "Print the device node associated with the filesystem mounted at '/'"
3508#define rdev_example_usage \
3509 "$ rdev\n" \
3510 "/dev/mtdblock9 /\n"
3511
Rob Landley0e4690d2006-08-20 22:12:18 +00003512#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003513 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003514#define readahead_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003515 "Preload FILEs to RAM"
Rob Landley0e4690d2006-08-20 22:12:18 +00003516
Eric Andersen7e9276b2001-02-22 01:15:47 +00003517#define readlink_trivial_usage \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003518 IF_FEATURE_READLINK_FOLLOW("[-fnv] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003519#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003520 "Display the value of a symlink" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003521 IF_FEATURE_READLINK_FOLLOW( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003522 "\nOptions:" \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003523 "\n -f Canonicalize by following all symlinks" \
3524 "\n -n Don't add newline" \
3525 "\n -v Verbose" \
3526 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003527
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003528#define readprofile_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003529 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003530#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003531 "Options:" \
3532 "\n -m mapfile (Default: /boot/System.map)" \
3533 "\n -p profile (Default: /proc/profile)" \
3534 "\n -M mult Set the profiling multiplier to mult" \
3535 "\n -i Print only info about the sampling step" \
3536 "\n -v Verbose" \
3537 "\n -a Print all symbols, even if count is 0" \
3538 "\n -b Print individual histogram-bin counts" \
3539 "\n -s Print individual counters within functions" \
3540 "\n -r Reset all the counters (root only)" \
3541 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003542
Glenn L McGrath62fae302002-12-10 00:14:33 +00003543#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003544 "pathname..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003545#define realpath_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003546 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00003547
Eric Andersen7e9276b2001-02-22 01:15:47 +00003548#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003549 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003550#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003551 "Reboot the system\n" \
3552 "\nOptions:" \
3553 "\n -d Delay interval for rebooting" \
3554 "\n -n No call to sync()" \
3555 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003556
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003557#define reformime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003558 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003559#define reformime_full_usage "\n\n" \
3560 "Parse MIME-encoded message\n" \
3561 "\nOptions:" \
3562 "\n -x prefix Extract content of MIME sections to files" \
3563 "\n -X prog [args] Filter content of MIME sections through prog." \
3564 "\n Must be the last option" \
3565 "\n" \
3566 "\nOther options are silently ignored." \
3567
Eric Andersen7e9276b2001-02-22 01:15:47 +00003568#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003569 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003570#define renice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003571 "Change priority of running processes\n" \
3572 "\nOptions:" \
3573 "\n -n Adjust current nice value (smaller is faster)" \
3574 "\n -p Process id(s) (default)" \
3575 "\n -g Process group id(s)" \
3576 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003577
Denys Vlasenko5e611152009-05-19 17:36:16 +02003578#define scriptreplay_trivial_usage \
3579 "timingfile [typescript [divisor]]"
3580#define scriptreplay_full_usage "\n\n" \
3581 "Play back typescripts, using timing information"
3582
Eric Andersen7e9276b2001-02-22 01:15:47 +00003583#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003584 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003585#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003586 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003587
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003588#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003589 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003590#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003591 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003592
Denis Vlasenko397137b2007-07-23 14:03:30 +00003593#define restorecon_trivial_usage \
3594 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003595#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003596 "Reset security contexts of files in pathname\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02003597 "\n -i Ignore files that don't exist" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003598 "\n -f file File with list of files to process. Use - for stdin" \
3599 "\n -e directory Directory to exclude" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003600 "\n -R,-r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003601 "\n -n Don't change any file labels" \
3602 "\n -o file Save list of files with incorrect context" \
3603 "\n -v Verbose" \
3604 "\n -vv Show changed labels" \
3605 "\n -F Force reset of context to match file_context" \
3606 "\n for customizable files, or the user section," \
3607 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003608
Eric Andersen7e9276b2001-02-22 01:15:47 +00003609#define rm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003610 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003611#define rm_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003612 "Remove (unlink) FILEs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003613 "\nOptions:" \
3614 "\n -i Always prompt before removing" \
3615 "\n -f Never prompt" \
3616 "\n -r,-R Remove directories recursively" \
3617
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003618#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003619 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003620
Eric Andersen7e9276b2001-02-22 01:15:47 +00003621#define rmdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003622 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003623#define rmdir_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003624 "Remove the DIRECTORY, if it is empty\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003625 "\nOptions:" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003626 IF_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003627 "\n -p|--parents Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003628 "\n --ignore-fail-on-non-empty" \
3629 ) \
3630 IF_NOT_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003631 "\n -p Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003632 )
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003633
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003634#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003635 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003636
Eric Andersen7e9276b2001-02-22 01:15:47 +00003637#define rmmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003638 "[OPTIONS] [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003639#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003640 "Unload the specified kernel modules from the kernel\n" \
3641 "\nOptions:" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003642 "\n -w Wait until the module is no longer used" \
3643 "\n -f Force unloading" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003644 "\n -a Remove all unused modules (recursively)" \
3645
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003646#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003647 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003648
Eric Andersen7e9276b2001-02-22 01:15:47 +00003649#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003650 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003651#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003652 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003653 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003654 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003655 "\n -e Display other/more information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003656 "\n -A inet" IF_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003657
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003658#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003659 "-i -q[ildc]p package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003660#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003661 "Manipulate RPM packages\n" \
3662 "\nOptions:" \
3663 "\n -i Install package" \
3664 "\n -q Query package" \
3665 "\n -p Query uninstalled package" \
3666 "\n -i Show information" \
3667 "\n -l List contents" \
3668 "\n -d List documents" \
3669 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003670
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003671#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003672 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003673#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003674 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003675
Mike Frysinger6b160e42008-02-15 02:27:19 +00003676#define rtcwake_trivial_usage \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003677 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SEC | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003678#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003679 "Enter a system sleep state until specified wakeup time\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003680 IF_LONG_OPTS( \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003681 "\n -a,--auto Read clock mode from adjtime" \
3682 "\n -l,--local Clock is set to local time" \
3683 "\n -u,--utc Clock is set to UTC time" \
3684 "\n -d,--device=DEV Specify the RTC device" \
3685 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003686 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003687 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003688 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003689 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003690 "\n -a Read clock mode from adjtime" \
3691 "\n -l Clock is set to local time" \
3692 "\n -u Clock is set to UTC time" \
3693 "\n -d DEV Specify the RTC device" \
3694 "\n -m MODE Set the sleep state (default: standby)" \
3695 "\n -s SEC Set the timeout in SEC seconds from now" \
3696 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003697 )
3698
Denis Vlasenko49622d72007-03-10 16:58:49 +00003699#define runcon_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003700 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] PROG [ARGS]\n" \
3701 " runcon CONTEXT PROG [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003702#define runcon_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003703 "Run PROG in a different security context\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003704 "\n CONTEXT Complete security context\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003705 IF_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003706 "\n -c,--compute Compute process transition context before modifying" \
3707 "\n -t,--type=TYPE Type (for same role as parent)" \
3708 "\n -u,--user=USER User identity" \
3709 "\n -r,--role=ROLE Role" \
3710 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003711 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003712 IF_NOT_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003713 "\n -c Compute process transition context before modifying" \
3714 "\n -t TYPE Type (for same role as parent)" \
3715 "\n -u USER User identity" \
3716 "\n -r ROLE Role" \
3717 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003718 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003719
Eric Andersen6cf47a72001-10-31 10:24:36 +00003720#define run_parts_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003721 "[-t] "IF_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003722#define run_parts_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003723 "Run a bunch of scripts in a directory\n" \
3724 "\nOptions:" \
3725 "\n -t Print what would be run, but don't actually run anything" \
3726 "\n -a ARG Pass ARG as argument for every program" \
3727 "\n -u MASK Set the umask to MASK before running every program" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003728 IF_FEATURE_RUN_PARTS_FANCY( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003729 "\n -l Print names of all matching files even if they are not executable" \
3730 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003731
3732#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003733 "$ run-parts -a start /etc/init.d\n" \
3734 "$ run-parts -a stop=now /etc/init.d\n\n" \
3735 "Let's assume you have a script foo/dosomething:\n" \
3736 "#!/bin/sh\n" \
3737 "for i in $*; do eval $i; done; unset i\n" \
3738 "case \"$1\" in\n" \
3739 "start*) echo starting something;;\n" \
3740 "stop*) set -x; shutdown -h $stop;;\n" \
3741 "esac\n\n" \
3742 "Running this yields:\n" \
3743 "$run-parts -a stop=+4m foo/\n" \
3744 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003745
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003746#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003747 "[utmp]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003748#define runlevel_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003749 "Find the current and previous system runlevel\n" \
3750 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003751 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003752 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003753#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003754 "$ runlevel /var/run/utmp\n" \
3755 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003756
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003757#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003758 "dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003759#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003760 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003761
3762#define runsvdir_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003763 "[-P] [-s SCRIPT] dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003764#define runsvdir_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003765 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
3766 "\n -P Put each runsv in a new session" \
3767 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003768
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003769#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003770 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003771#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003772 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003773#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003774 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003775
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003776#define script_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003777 "[-afq" IF_SCRIPTREPLAY("t") "] [-c PROG] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003778#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003779 "Options:" \
3780 "\n -a Append output" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003781 "\n -c Run PROG, not shell" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003782 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003783 "\n -q Quiet" \
Denys Vlasenko5e611152009-05-19 17:36:16 +02003784 IF_SCRIPTREPLAY( \
3785 "\n -t Send timing to stderr" \
3786 )
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003787
Eric Andersen7e9276b2001-02-22 01:15:47 +00003788#define sed_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003789 "[-efinr] SED_CMD [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003790#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003791 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003792 "\n -e CMD Add CMD to sed commands to be executed" \
3793 "\n -f FILE Add FILE contents to sed commands to be executed" \
3794 "\n -i Edit files in-place" \
3795 "\n -n Suppress automatic printing of pattern space" \
3796 "\n -r Use extended regex syntax" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003797 "\n" \
3798 "\nIf no -e or -f is given, the first non-option argument is taken as the sed" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003799 "\ncommand to interpret. All remaining arguments are names of input files; if no" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003800 "\ninput files are specified, then the standard input is read. Source files" \
3801 "\nwill not be modified unless -i option is given." \
Eric Andersenf802ff72004-04-12 15:12:06 +00003802
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003803#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003804 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3805 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003806
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003807#define selinuxenabled_trivial_usage NOUSAGE_STR
3808#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003809
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003810#define sendmail_trivial_usage \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003811 "[OPTIONS] [RECIPIENT_EMAIL]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003812#define sendmail_full_usage "\n\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003813 "Read email from stdin and send it\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003814 "\nStandard options:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003815 "\n -t Read additional recipients from message body" \
3816 "\n -f sender Sender (required)" \
3817 "\n -o options Various options. -oi implied, others are ignored" \
Vladimir Dronnikovb618dba2009-10-04 01:34:54 +02003818 "\n -i -oi synonym. implied and ignored" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003819 "\n" \
3820 "\nBusybox specific options:" \
3821 "\n -w seconds Network timeout" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003822 "\n -H 'PROG ARGS' Run connection helper" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003823 "\n Examples:" \
Denis Vlasenko7e0c2432009-03-02 16:12:00 +00003824 "\n -H 'exec openssl s_client -quiet -tls1 -starttls smtp" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003825 "\n -connect smtp.gmail.com:25' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003826 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003827 "\n -H 'exec openssl s_client -quiet -tls1" \
3828 "\n -connect smtp.gmail.com:465' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003829 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003830 "\n -S server[:port] Server" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003831 "\n -au<username> Username for AUTH LOGIN" \
3832 "\n -ap<password> Password for AUTH LOGIN" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003833 "\n -am<method> Authentication method. Ignored. LOGIN is implied" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003834 "\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003835 "\nOther options are silently ignored; -oi -t is implied" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003836 IF_MAKEMIME( \
3837 "\nUse makemime applet to create message with attachments" \
3838 )
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003839
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003840#define seq_trivial_usage \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003841 "[-w] [-s SEP] [FIRST [INC]] LAST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003842#define seq_full_usage "\n\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003843 "Print numbers from FIRST to LAST, in steps of INC.\n" \
3844 "FIRST, INC default to 1\n" \
3845 "\nOptions:" \
3846 "\n -w Pad to last with leading zeros" \
3847 "\n -s SEP String separator" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003848
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003849#define sestatus_trivial_usage \
3850 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003851#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003852 " -v Verbose" \
3853 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003854
Paul Foxfc2256a2005-08-01 18:12:30 +00003855#define setconsole_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003856 "[-r" IF_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003857#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003858 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3859 "\nOptions:" \
3860 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003861
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003862#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003863 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003864#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003865
Denis Vlasenko397137b2007-07-23 14:03:30 +00003866#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003867 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003868 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003869 " [-c policyfile] spec_file" \
3870 ) \
3871 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003872#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003873 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003874 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003875 "\n -c file Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003876 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003877 "\n -d Show which specification matched each file" \
3878 "\n -l Log changes in file labels to syslog" \
3879 "\n -n Don't change any file labels" \
3880 "\n -q Suppress warnings" \
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02003881 "\n -r dir Use an alternate root path" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003882 "\n -e dir Exclude directory" \
3883 "\n -F Force reset of context to match file_context for customizable files" \
3884 "\n -o file Save list of files with incorrect context" \
3885 "\n -s Take a list of files from standard input (instead of command line)" \
3886 "\n -v Show changes in file labels, if type or role are changing" \
3887 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3888 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003889
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003890#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003891 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003892#define setfont_full_usage "\n\n" \
3893 "Load a console font\n" \
3894 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003895 "\n -m MAPFILE Load console screen map" \
3896 "\n -C TTY Affect TTY instead of /dev/tty" \
3897
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003898#define setfont_example_usage \
3899 "$ setfont -m koi8-r /etc/i18n/fontname\n"
3900
Eric Andersen7e9276b2001-02-22 01:15:47 +00003901#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003902 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003903#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003904 "Set entries into the kernel's scancode-to-keycode map,\n" \
3905 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3906 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003907 "and KEYCODE is given in decimal" \
3908
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003909#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003910 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003911
Rob Landley87848d92006-03-27 23:23:43 +00003912#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003913 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003914#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003915 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003916
Denis Vlasenkobe039372007-10-14 04:48:44 +00003917#define setsebool_trivial_usage \
3918 "boolean value"
3919
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003920#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00003921 "Change boolean setting"
3922
Paul Fox42403642005-08-01 22:52:09 +00003923#define setsid_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003924 "PROG [ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003925#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003926 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3927 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3928 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003929
Eric Andersen2e9c2572003-08-08 22:26:06 +00003930#define last_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003931 ""IF_FEATURE_LAST_FANCY("[-HW] [-f file]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003932#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003933 "Show listing of the last users that logged into the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003934 IF_FEATURE_LAST_FANCY( "\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003935 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00003936/* "\n -H Show header line" */ \
3937 "\n -W Display with no host column truncation" \
3938 "\n -f file Read from file instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003939 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00003940
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00003941#define showkey_trivial_usage \
3942 "[-a | -k | -s]"
3943#define showkey_full_usage "\n\n" \
3944 "Show keys pressed\n" \
3945 "\nOptions:" \
3946 "\n -a Display decimal/octal/hex values of the keys" \
3947 "\n -k Display interpreted keycodes (default)" \
3948 "\n -s Display raw scan-codes" \
3949
Denis Vlasenko14923db2007-06-20 15:23:03 +00003950#define slattach_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003951 "[-cehmLF] [-s SPEED] [-p PROTOCOL] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003952#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003953 "Attach network interface(s) to serial line(s)\n" \
3954 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003955 "\n -p PROT Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3956 "\n -s SPD Set line speed" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003957 "\n -e Exit after initializing device" \
3958 "\n -h Exit when the carrier is lost" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003959 "\n -c PROG Run PROG when the line is hung up" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003960 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3961 "\n -L Enable 3-wire operation" \
3962 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003963
Eric Andersen7e9276b2001-02-22 01:15:47 +00003964#define sleep_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003965 IF_FEATURE_FANCY_SLEEP("[") "N" IF_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003966#define sleep_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003967 IF_NOT_FEATURE_FANCY_SLEEP("Pause for N seconds") \
3968 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003969 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003970 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003971#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003972 "$ sleep 2\n" \
3973 "[2 second delay results]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003974 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003975 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003976 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003977
Eric Andersen7e9276b2001-02-22 01:15:47 +00003978#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003979 "[-nru" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003980 IF_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003981 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003982#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003983 "Sort lines of text\n" \
3984 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003985 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003986 "\n -b Ignore leading blanks" \
3987 "\n -c Check whether input is sorted" \
3988 "\n -d Dictionary order (blank or alphanumeric only)" \
3989 "\n -f Ignore case" \
3990 "\n -g General numerical sort" \
3991 "\n -i Ignore unprintable characters" \
3992 "\n -k Sort key" \
3993 "\n -M Sort month" \
3994 ) \
3995 "\n -n Sort numbers" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003996 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003997 "\n -o Output to file" \
3998 "\n -k Sort by key" \
3999 "\n -t CHAR Key separator" \
4000 ) \
4001 "\n -r Reverse sort order" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004002 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004003 "\n -s Stable (don't sort ties alphabetically)" \
4004 ) \
4005 "\n -u Suppress duplicate lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004006 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004007 "\n -z Lines are terminated by NUL, not newline" \
4008 "\n -mST Ignored for GNU compatibility") \
4009
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004010#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004011 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
4012 "a\n" \
4013 "b\n" \
4014 "c\n" \
4015 "d\n" \
4016 "e\n" \
4017 "f\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004018 IF_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00004019 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
4020 "d 2\n" \
4021 "b 2\n" \
4022 "c 3\n" \
4023 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004024 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004025
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00004026#define split_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004027 "[OPTIONS] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004028#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00004029 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004030 "\n -b n[k|m] Split by bytes" \
4031 "\n -l n Split by lines" \
4032 "\n -a n Use n letters as suffix" \
4033
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00004034#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00004035 "$ split TODO foo\n" \
4036 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00004037
Eric Andersenc2af1ee2001-10-18 19:33:06 +00004038#define start_stop_daemon_trivial_usage \
Denis Vlasenko7987a182008-07-01 10:00:46 +00004039 "[OPTIONS] [-S|-K] ... [-- arguments...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004040#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004041 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004042 "-K: stop all matching processes.\n" \
4043 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004044 IF_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004045 "\nProcess matching:" \
4046 "\n -u,--user USERNAME|UID Match only this user's processes" \
4047 "\n -n,--name NAME Match processes with NAME" \
4048 "\n in comm field in /proc/PID/stat" \
4049 "\n -x,--exec EXECUTABLE Match processes with this command" \
4050 "\n in /proc/PID/cmdline" \
4051 "\n -p,--pidfile FILE Match a process with PID from the file" \
4052 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004053 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004054 "\n -x,--exec EXECUTABLE Program to run" \
4055 "\n -a,--startas NAME Zeroth argument" \
4056 "\n -b,--background Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004057 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004058 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004059 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004060 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
4061 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004062 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004063 "\n -s,--signal SIG Signal to send" \
4064 "\n -t,--test Match only, exit with 0 if a process is found" \
4065 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004066 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004067 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004068 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00004069 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00004070 "\n -q,--quiet Quiet" \
4071 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004072 IF_NOT_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004073 "\nProcess matching:" \
4074 "\n -u USERNAME|UID Match only this user's processes" \
4075 "\n -n NAME Match processes with NAME" \
4076 "\n in comm field in /proc/PID/stat" \
4077 "\n -x EXECUTABLE Match processes with this command" \
4078 "\n command in /proc/PID/cmdline" \
4079 "\n -p FILE Match a process with PID from the file" \
4080 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004081 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004082 "\n -x EXECUTABLE Program to run" \
4083 "\n -a NAME Zeroth argument" \
4084 "\n -b Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004085 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004086 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00004087 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004088 "\n -c USER[:[GRP]] Change to user/group" \
4089 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004090 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004091 "\n -s SIG Signal to send" \
4092 "\n -t Match only, exit with 0 if a process is found" \
4093 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004094 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004095 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004096 "\n -v Verbose" \
4097 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00004098 "\n -q Quiet" \
4099 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00004100
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004101#define stat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004102 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004103#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004104 "Display file (default) or filesystem status\n" \
4105 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004106 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004107 "\n -c fmt Use the specified format" \
4108 ) \
4109 "\n -f Display filesystem status" \
4110 "\n -L Dereference links" \
4111 "\n -t Display info in terse form" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004112 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004113 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004114 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004115 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004116 "\n\nValid format sequences for files:\n" \
4117 " %a Access rights in octal\n" \
4118 " %A Access rights in human readable form\n" \
4119 " %b Number of blocks allocated (see %B)\n" \
4120 " %B The size in bytes of each block reported by %b\n" \
4121 " %d Device number in decimal\n" \
4122 " %D Device number in hex\n" \
4123 " %f Raw mode in hex\n" \
4124 " %F File type\n" \
4125 " %g Group ID of owner\n" \
4126 " %G Group name of owner\n" \
4127 " %h Number of hard links\n" \
4128 " %i Inode number\n" \
4129 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00004130 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004131 " %o I/O block size\n" \
4132 " %s Total size, in bytes\n" \
4133 " %t Major device type in hex\n" \
4134 " %T Minor device type in hex\n" \
4135 " %u User ID of owner\n" \
4136 " %U User name of owner\n" \
4137 " %x Time of last access\n" \
4138 " %X Time of last access as seconds since Epoch\n" \
4139 " %y Time of last modification\n" \
4140 " %Y Time of last modification as seconds since Epoch\n" \
4141 " %z Time of last change\n" \
4142 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004143 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004144 " %a Free blocks available to non-superuser\n" \
4145 " %b Total data blocks in file system\n" \
4146 " %c Total file nodes in file system\n" \
4147 " %d Free file nodes in file system\n" \
4148 " %f Free blocks in file system\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004149 IF_SELINUX( \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004150 " %C Security context in SELinux\n" \
4151 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004152 " %i File System ID in hex\n" \
4153 " %l Maximum length of filenames\n" \
4154 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004155 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004156 " %S Fundamental block size (for block counts)\n" \
4157 " %t Type in hex\n" \
4158 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004159 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004160
Eric Andersenef5e8f82002-11-07 02:09:37 +00004161#define strings_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004162 "[-afo] [-n LEN] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004163#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004164 "Display printable strings in a binary file\n" \
4165 "\nOptions:" \
4166 "\n -a Scan whole file (default)" \
4167 "\n -f Precede strings with filenames" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004168 "\n -n LEN At least LEN characters form a string (default 4)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004169 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00004170
Eric Andersen7e9276b2001-02-22 01:15:47 +00004171#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004172 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004173#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004174 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004175 "and deviations from stty sane\n" \
4176 "\nOptions:" \
4177 "\n -F DEVICE Open device instead of stdin" \
4178 "\n -a Print all current settings in human-readable form" \
4179 "\n -g Print in stty-readable form" \
4180 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004181
Robert Griebl1fca5582002-06-04 20:45:46 +00004182#define su_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004183 "[OPTIONS] [-] [username]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004184#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004185 "Change user id or become root\n" \
4186 "\nOptions:" \
4187 "\n -p, -m Preserve environment" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004188 "\n -c CMD Command to pass to 'sh -c'" \
4189 "\n -s SH Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00004190
Eric Andersen27f64e12002-06-23 04:24:25 +00004191#define sulogin_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004192 "[OPTIONS] [TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004193#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004194 "Single user login\n" \
4195 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004196 "\n -t N Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004197
Mike Frysinger95d3c452005-04-21 23:29:24 +00004198#define sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004199 "[-rs] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004200#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004201 "Checksum and count the blocks in a file\n" \
4202 "\nOptions:" \
4203 "\n -r Use BSD sum algorithm (1K blocks)" \
4204 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00004205
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004206#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004207 "[-v] [-w sec] command service..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004208#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004209 "Control services monitored by runsv supervisor.\n" \
4210 "Commands (only first character is enough):\n" \
4211 "\n" \
4212 "status: query service status\n" \
4213 "up: if service isn't running, start it. If service stops, restart it\n" \
4214 "once: like 'up', but if service stops, don't restart it\n" \
4215 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004216 " if it exists. After it stops, don't restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004217 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004218 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004219 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004220 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004221
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004222#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004223 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004224#define svlogd_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004225 "Continuously read log data from standard input, optionally\n" \
4226 "filter log messages, and write the data to one or more automatically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004227 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004228
Eric Andersen7e9276b2001-02-22 01:15:47 +00004229#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004230 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004231#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004232 "Stop swapping on DEVICE\n" \
4233 "\nOptions:" \
4234 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004235
Eric Andersen7e9276b2001-02-22 01:15:47 +00004236#define swapon_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004237 "[-a]" IF_FEATURE_SWAPON_PRI(" [-p pri]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004238#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004239 "Start swapping on DEVICE\n" \
4240 "\nOptions:" \
4241 "\n -a Start swapping on all swap devices" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004242 IF_FEATURE_SWAPON_PRI( \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004243 "\n -p pri Set swap device priority" \
4244 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004245
Rob Landley0f34a822005-10-27 22:55:50 +00004246#define switch_root_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004247 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004248#define switch_root_full_usage "\n\n" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004249 "Free initramfs and switch to another root fs:\n" \
4250 "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n" \
4251 "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004252 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004253 "\n -c DEV Reopen stdio to DEV after switch" \
Rob Landley0f34a822005-10-27 22:55:50 +00004254
Eric Andersen7e9276b2001-02-22 01:15:47 +00004255#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004256 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004257#define sync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004258 "Write all buffered blocks to disk"
4259
4260#define fsync_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004261 "[OPTIONS] FILE..."
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004262#define fsync_full_usage \
4263 "Write files' buffered blocks to disk\n" \
4264 "\nOptions:" \
4265 "\n -d Avoid syncing metadata"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004266
Eric Andersenb9050282003-12-24 06:02:11 +00004267#define sysctl_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004268 "[OPTIONS] [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004269#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004270 "Configure kernel parameters at runtime\n" \
4271 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004272 "\n -n Don't print key names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004273 "\n -e Don't warn about unknown keys" \
4274 "\n -w Change sysctl setting" \
4275 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
4276 "\n -a Display all values" \
4277 "\n -A Display all values in table form" \
4278
Eric Andersen5d38f5b2005-09-12 21:42:48 +00004279#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00004280 "sysctl [-n] [-e] variable...\n" \
4281 "sysctl [-n] [-e] -w variable=value...\n" \
4282 "sysctl [-n] [-e] -a\n" \
4283 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
4284 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00004285
Eric Andersen7e9276b2001-02-22 01:15:47 +00004286#define syslogd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004287 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004288#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004289 "System logging utility.\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004290 "Note that this version of syslogd ignores /etc/syslog.conf.\n" \
4291 "\nOptions:" \
4292 "\n -n Run in foreground" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004293 "\n -O FILE Log to given file (default:/var/log/messages)" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004294 "\n -l n Set local log level" \
4295 "\n -S Smaller logging output" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004296 IF_FEATURE_ROTATE_LOGFILE( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004297 "\n -s SIZE Max size (KB) before rotate (default:200KB, 0=off)" \
4298 "\n -b NUM Number of rotated logs to keep (default:1, max=99, 0=purge)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004299 IF_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004300 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
4301 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004302 IF_FEATURE_SYSLOGD_DUP( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004303 "\n -D Drop duplicates") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004304 IF_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004305 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00004306 /* NB: -Csize shouldn't have space (because size is optional) */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004307/* "\n -m MIN Minutes between MARK lines (default:20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00004308
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004309#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004310 "$ syslogd -R masterlog:514\n" \
4311 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004312
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004313#define tac_trivial_usage \
4314 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004315#define tac_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004316 "Concatenate FILEs and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004317
Eric Andersen7e9276b2001-02-22 01:15:47 +00004318#define tail_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004319 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004320#define tail_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004321 "Print last 10 lines of each FILE (or standard input) to standard output.\n" \
4322 "With more than one FILE, precede each with a header giving the file name.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004323 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004324 IF_FEATURE_FANCY_TAIL( \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004325 "\n -c N[kbm] Output last N bytes") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004326 "\n -n N[kbm] Print last N lines instead of last 10" \
4327 "\n -f Output data as the file grows" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004328 IF_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004329 "\n -q Never output headers giving file names" \
4330 "\n -s SEC Wait SEC seconds between reads with -f" \
4331 "\n -v Always output headers giving file names" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004332 "\n" \
4333 "\nIf the first character of N (bytes or lines) is a '+', output begins with" \
4334 "\nthe Nth item from the start of each file, otherwise, print the last N items" \
4335 "\nin the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004336
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004337#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004338 "$ tail -n 1 /etc/resolv.conf\n" \
4339 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004340
Eric Andersen7e9276b2001-02-22 01:15:47 +00004341#define tar_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004342 "-[" IF_FEATURE_TAR_CREATE("c") IF_FEATURE_SEAMLESS_GZ("z") \
4343 IF_FEATURE_SEAMLESS_BZ2("j") IF_FEATURE_SEAMLESS_LZMA("a") \
4344 IF_FEATURE_SEAMLESS_Z("Z") "xtvO] " \
4345 IF_FEATURE_TAR_FROM("[-X FILE] ") \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004346 "[-f TARFILE] [-C DIR] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004347#define tar_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004348 IF_FEATURE_TAR_CREATE("Create, extract, ") \
4349 IF_NOT_FEATURE_TAR_CREATE("Extract ") \
4350 "or list files from a tar file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004351 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004352 IF_FEATURE_TAR_CREATE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004353 "\n c Create") \
4354 "\n x Extract" \
4355 "\n t List" \
4356 "\nArchive format selection:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004357 IF_FEATURE_SEAMLESS_GZ( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004358 "\n z Filter the archive through gzip" \
4359 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004360 IF_FEATURE_SEAMLESS_BZ2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004361 "\n j Filter the archive through bzip2" \
4362 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004363 IF_FEATURE_SEAMLESS_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004364 "\n a Filter the archive through lzma" \
4365 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004366 IF_FEATURE_SEAMLESS_Z( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004367 "\n Z Filter the archive through compress" \
4368 ) \
4369 "\nFile selection:" \
4370 "\n f Name of TARFILE or \"-\" for stdin" \
4371 "\n O Extract to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004372 IF_FEATURE_TAR_FROM( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004373 "\n exclude File to exclude" \
4374 "\n X File with names to exclude" \
4375 ) \
4376 "\n C Change to directory DIR before operation" \
4377 "\n v Verbose" \
4378
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004379#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004380 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
4381 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004382
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004383#define taskset_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004384 "[-p] [MASK] [PID | PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004385#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004386 "Set or get CPU affinity\n" \
4387 "\nOptions:" \
4388 "\n -p Operate on an existing PID" \
4389
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004390#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004391 "$ taskset 0x7 ./dgemm_test&\n" \
4392 "$ taskset -p 0x1 $!\n" \
4393 "pid 4790's current affinity mask: 7\n" \
4394 "pid 4790's new affinity mask: 1\n" \
4395 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4396 "pid 6671's current affinity mask: 1\n" \
4397 "pid 6671's new affinity mask: 1\n" \
4398 "$ taskset -p 1\n" \
4399 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004400
Eric Andersen7e9276b2001-02-22 01:15:47 +00004401#define tee_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004402 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004403#define tee_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004404 "Copy standard input to each FILE, and also to standard output\n" \
4405 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004406 "\n -a Append to the given FILEs, don't overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004407 "\n -i Ignore interrupt signals (SIGINT)" \
4408
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004409#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004410 "$ echo \"Hello\" | tee /tmp/foo\n" \
4411 "$ cat /tmp/foo\n" \
4412 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004413
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004414#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004415#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004416 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004417#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004418 "Connect to telnet server\n" \
4419 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004420 "\n -a Automatic login with $USER variable" \
4421 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004422
Eric Andersen539ffc92004-02-22 12:25:47 +00004423#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004424#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004425 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004426#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004427 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004428#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004429
Eric Andersen08a72202002-09-30 20:52:10 +00004430#define telnetd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004431 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004432#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004433 "Handle incoming telnet connections" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004434 IF_NOT_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004435 "\nOptions:" \
4436 "\n -l LOGIN Exec LOGIN on connect" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004437 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004438 "\n -K Close connection as soon as login exits" \
4439 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004440 IF_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004441 "\n -p PORT Port to listen on" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004442 "\n -b ADDR[:PORT] Address to bind to" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004443 "\n -F Run in foreground" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004444 "\n -i Run as inetd service" \
4445 IF_FEATURE_TELNETD_INETD_WAIT( \
4446 "\n -w SEC Run as inetd service in wait mode, linger time SEC" \
4447 "\n -S Log to syslog (implied by -i or without -F and -w)" \
4448 ) \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004449 )
Eric Andersen08a72202002-09-30 20:52:10 +00004450
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004451/* "test --help" does not print help (POSIX compat), only "[ --help" does.
4452 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION") */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004453#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004454 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004455#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004456 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4457 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004458#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004459 "$ test 1 -eq 2\n" \
4460 "$ echo $?\n" \
4461 "1\n" \
4462 "$ test 1 -eq 1\n" \
4463 "$ echo $?\n" \
4464 "0\n" \
4465 "$ [ -d /etc ]\n" \
4466 "$ echo $?\n" \
4467 "0\n" \
4468 "$ [ -d /junk ]\n" \
4469 "$ echo $?\n" \
4470 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004471
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004472#define tc_trivial_usage \
4473 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
4474#define tc_full_usage "\n\n" \
4475 "OBJECT: {qdisc|class|filter}\n" \
4476 "CMD: {add|del|change|replace|show}\n" \
4477 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004478 "qdisc [ handle QHANDLE ] [ root |"IF_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004479 /* "[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4480 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4481 " QDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004482 "qdisc show [ dev STRING ]"IF_FEATURE_TC_INGRESS(" [ingress]")"\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004483 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004484 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004485 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
4486 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
4487 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004488 " [ root | classid CLASSID ] [ handle FILTERID ]\n" \
4489 " [ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004490 "filter show [ dev STRING ] [ root | parent CLASSID ]"
4491
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004492#define tcpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004493 "[-hEv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004494/* with not-implemented options: */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004495/* "[-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 +00004496#define tcpsvd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004497 "Create TCP socket, bind to IP:PORT and listen\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004498 "for incoming connection. Run PROG for each connection.\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004499 "\n IP IP to listen on. '0' = all" \
4500 "\n PORT Port to listen on" \
4501 "\n PROG [ARGS] Program to run" \
4502 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4503 "\n -u USER[:GRP] Change to user/group after bind" \
4504 "\n -c N Handle up to N connections simultaneously" \
4505 "\n -b N Allow a backlog of approximately N TCP SYNs" \
4506 "\n -C N[:MSG] Allow only up to N connections from the same IP" \
4507 "\n New connections from this IP address are closed" \
4508 "\n immediately. MSG is written to the peer before close" \
4509 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004510 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004511 "\n -v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004512
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004513#define udpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004514 "[-hEv] [-c N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004515#define udpsvd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004516 "Create UDP socket, bind to IP:PORT and wait\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004517 "for incoming packets. Run PROG for each packet,\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004518 "redirecting all further packets with same peer ip:port to it.\n" \
4519 "\n IP IP to listen on. '0' = all" \
4520 "\n PORT Port to listen on" \
4521 "\n PROG [ARGS] Program to run" \
4522 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4523 "\n -u USER[:GRP] Change to user/group after bind" \
4524 "\n -c N Handle up to N connections simultaneously" \
4525 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004526 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004527 "\n -v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004528
Mark Whitley450736c2001-03-02 19:08:50 +00004529#define tftp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004530 "[OPTIONS] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004531#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004532 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004533 "\nOptions:" \
4534 "\n -l FILE Local FILE" \
4535 "\n -r FILE Remote FILE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004536 IF_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004537 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004538 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004539 IF_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004540 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004541 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004542 IF_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004543 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004544 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004545
4546#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004547 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004548#define tftpd_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004549 "Transfer a file on tftp client's request\n" \
Denis Vlasenko91f8f822008-10-30 23:42:37 +00004550 "\n" \
4551 "tftpd should be used as an inetd service.\n" \
4552 "tftpd's line for inetd.conf:\n" \
4553 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
4554 "It also can be ran from udpsvd:\n" \
4555 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004556 "\nOptions:" \
4557 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004558 "\n -c Allow file creation via upload" \
4559 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004560
Eric Andersenc3657422001-11-30 07:54:32 +00004561#define time_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004562 "[OPTIONS] PROG [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004563#define time_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004564 "Run PROG. When it finishes, its resource usage is displayed.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004565 "\nOptions:" \
4566 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004567
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004568#define timeout_trivial_usage \
4569 "[-t SECS] [-s SIG] PROG [ARGS]"
4570#define timeout_full_usage "\n\n" \
4571 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
Denis Vlasenko42404082008-11-24 13:42:24 +00004572 "Defaults: SECS: 10, SIG: TERM." \
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004573
Eric Andersen420b2082002-09-17 22:14:58 +00004574#define top_trivial_usage \
Denys Vlasenko00528822009-09-11 23:26:42 +02004575 "[-b] [-nCOUNT] [-dSECONDS]" IF_FEATURE_TOPMEM(" [-m]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004576#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004577 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004578 "Read the status of all processes from /proc each SECONDS\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004579 "and show the status for however many processes will fit on the screen." \
Eric Andersen420b2082002-09-17 22:14:58 +00004580
Eric Andersen7e9276b2001-02-22 01:15:47 +00004581#define touch_trivial_usage \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004582 "[-c] [-d DATE] FILE [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004583#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004584 "Update the last-modified date on the given FILE[s]\n" \
4585 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004586 "\n -c Don't create files" \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004587 "\n -d DT Date/time to use" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004588
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004589#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004590 "$ ls -l /tmp/foo\n" \
4591 "/bin/ls: /tmp/foo: No such file or directory\n" \
4592 "$ touch /tmp/foo\n" \
4593 "$ ls -l /tmp/foo\n" \
4594 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004595
4596#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004597 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004598#define tr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004599 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004600 "standard input, writing to standard output\n" \
4601 "\nOptions:" \
4602 "\n -c Take complement of STRING1" \
4603 "\n -d Delete input characters coded STRING1" \
4604 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4605
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004606#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004607 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4608 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004609
Eric Andersen5c58d282001-07-10 16:29:00 +00004610#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004611 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
4612 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004613 " [-z pausemsecs] HOST [data size]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004614#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004615 "Trace the route to HOST\n" \
4616 "\nOptions:" \
4617 "\n -F Set the don't fragment bit" \
4618 "\n -I Use ICMP ECHO instead of UDP datagrams" \
4619 "\n -l Display the ttl value of the returned packet" \
4620 "\n -d Set SO_DEBUG options to socket" \
4621 "\n -n Print hop addresses numerically rather than symbolically" \
4622 "\n -r Bypass the normal routing tables and send directly to a host" \
4623 "\n -v Verbose" \
4624 "\n -m max_ttl Max time-to-live (max number of hops)" \
4625 "\n -p port# Base UDP port number used in probes" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004626 "\n (default 33434)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004627 "\n -q nqueries Number of probes per 'ttl' (default 3)" \
4628 "\n -s src_addr IP address to use as the source address" \
4629 "\n -t tos Type-of-service in probe packets (default 0)" \
4630 "\n -w wait Time in seconds to wait for a response" \
4631 "\n (default 3 sec)" \
4632 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004633
Eric Andersen7e9276b2001-02-22 01:15:47 +00004634#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004635 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004636#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004637 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004638#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004639 "$ true\n" \
4640 "$ echo $?\n" \
4641 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004642
Eric Andersen7e9276b2001-02-22 01:15:47 +00004643#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004644 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004645#define tty_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004646 "Print file name of standard input's terminal" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004647 IF_INCLUDE_SUSv2( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004648 "\nOptions:" \
4649 "\n -s Print nothing, only return exit status" \
4650 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004651#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004652 "$ tty\n" \
4653 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004654
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004655#define ttysize_trivial_usage \
4656 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004657#define ttysize_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004658 "Print dimension(s) of standard input's terminal, on error return 80x25"
4659
Denis Vlasenko39b68132009-01-23 02:07:14 +00004660#define tunctl_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004661 "[-f device] ([-t name] | -d name)" IF_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]")
Denis Vlasenko39b68132009-01-23 02:07:14 +00004662#define tunctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004663 "Create or delete tun interfaces\n" \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004664 "\nOptions:" \
4665 "\n -f name tun device (/dev/net/tun)" \
4666 "\n -t name Create iface 'name'" \
4667 "\n -d name Delete iface 'name'" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004668IF_FEATURE_TUNCTL_UG( \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004669 "\n -u owner Set iface owner" \
4670 "\n -g group Set iface group" \
4671 "\n -b Brief output" \
4672)
4673#define tunctl_example_usage \
4674 "# tunctl\n" \
4675 "# tunctl -d tun0\n"
4676
Mike Frysinger174808c2005-06-11 01:14:09 +00004677#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004678 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
4679 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
4680 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
4681 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
4682 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
4683 "[-T last-check-time] [-U UUID] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004684#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004685 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004686
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004687#define udhcpc_trivial_usage \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004688 "[-Cfbnqtvo] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004689 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." IF_FEATURE_UDHCP_PORT(" [-P N]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004690#define udhcpc_full_usage "\n\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004691 IF_LONG_OPTS( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004692 " -V,--vendorclass=CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004693 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
4694 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
4695 "\n -c,--clientid=CLIENTID Client identifier" \
4696 "\n -C,--clientid-none Suppress default client identifier" \
4697 "\n -p,--pidfile=file Create pidfile" \
4698 "\n -r,--request=IP IP address to request" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +00004699 "\n -s,--script=file Run file at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denys Vlasenkof26e98f2009-10-10 16:14:41 +02004700 "\n -t,--retries=N Send up to N discover packets" \
Denys Vlasenko84e1caf2009-10-10 16:13:17 +02004701 "\n -T,--timeout=N Pause between packets (default 3 seconds)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004702 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004703 "\n -O,--request-option=OPT Request DHCP option OPT (cumulative)" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004704 "\n -o,--no-default-options Don't request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004705 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004706 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004707 "\n -b,--background Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004708 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004709 "\n -S,--syslog Log to syslog too" \
4710 "\n -n,--now Exit with failure if lease is not immediately obtained" \
4711 "\n -q,--quit Quit after obtaining lease" \
4712 "\n -R,--release Release IP on quit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004713 IF_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004714 "\n -P,--client-port N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004715 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004716 IF_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004717 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004718 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004719 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004720 IF_NOT_LONG_OPTS( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004721 " -V CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004722 "\n -i INTERFACE Interface to use (default: eth0)" \
4723 "\n -H,-h HOSTNAME Client hostname" \
4724 "\n -c CLIENTID Client identifier" \
4725 "\n -C Suppress default client identifier" \
4726 "\n -p file Create pidfile" \
4727 "\n -r IP IP address to request" \
Denis Vlasenko35a064b2008-11-06 00:49:59 +00004728 "\n -s file Run file at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004729 "\n -t N Send up to N request packets" \
4730 "\n -T N Try to get a lease for N seconds (default 3)" \
4731 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004732 "\n -O OPT Request DHCP option OPT (cumulative)" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004733 "\n -o Don't request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004734 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004735 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004736 "\n -b Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004737 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004738 "\n -S Log to syslog too" \
4739 "\n -n Exit with failure if lease is not immediately obtained" \
4740 "\n -q Quit after obtaining lease" \
4741 "\n -R Release IP on quit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004742 IF_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004743 "\n -P N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004744 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004745 IF_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004746 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004747 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004748 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004749
Russ Dill61fb4892002-10-14 21:41:28 +00004750#define udhcpd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004751 "[-fS]" IF_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004752
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004753#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004754 "DHCP server\n" \
4755 "\n -f Run in foreground" \
4756 "\n -S Log to syslog too" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004757 IF_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004758 "\n -P N Use port N instead of default 67" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004759 )
Russ Dill61fb4892002-10-14 21:41:28 +00004760
Eric Andersen7e9276b2001-02-22 01:15:47 +00004761#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004762 "[flags] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004763#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004764 "Unmount file systems\n" \
4765 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004766 IF_FEATURE_UMOUNT_ALL( \
4767 "\n -a Unmount all file systems" IF_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004768 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004769 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004770 "\n -n Don't erase /etc/mtab entries" \
4771 ) \
4772 "\n -r Try to remount devices as read-only if mount is busy" \
4773 "\n -l Lazy umount (detach filesystem)" \
4774 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004775 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004776 "\n -d Free loop device if it has been used" \
4777 )
4778
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004779#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004780 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004781
4782#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004783 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004784#define uname_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004785 "Print system information\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004786 "\nOptions:" \
4787 "\n -a Print all" \
4788 "\n -m The machine (hardware) type" \
4789 "\n -n Hostname" \
4790 "\n -r OS release" \
4791 "\n -s OS name (default)" \
4792 "\n -p Processor type" \
4793 "\n -v OS version" \
4794
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004795#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004796 "$ uname -a\n" \
4797 "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 +00004798
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004799#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004800 "[-c] [-f] [name...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004801#define uncompress_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004802 "Uncompress .Z file[s]\n" \
4803 "\nOptions:" \
4804 "\n -c Extract to stdout" \
4805 "\n -f Overwrite an existing file" \
Tim Riker7b253f82003-12-28 05:02:40 +00004806
Denis Vlasenko3952f202007-08-13 14:10:24 +00004807#define unexpand_trivial_usage \
4808 "[-f][-a][-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004809#define unexpand_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004810 "Convert spaces to tabs, writing to standard output\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004811 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004812 IF_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004813 "\n -a,--all Convert all blanks" \
4814 "\n -f,--first-only Convert only leading blanks" \
4815 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004816 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004817 IF_NOT_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004818 "\n -a Convert all blanks" \
4819 "\n -f Convert only leading blanks" \
4820 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004821 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004822
Eric Andersen7e9276b2001-02-22 01:15:47 +00004823#define uniq_trivial_usage \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004824 "[-fscduw]... [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004825#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004826 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004827 "\nOptions:" \
4828 "\n -c Prefix lines by the number of occurrences" \
4829 "\n -d Only print duplicate lines" \
4830 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004831 "\n -f N Skip first N fields" \
4832 "\n -s N Skip first N chars (after any skipped fields)" \
4833 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004834
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004835#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004836 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4837 "a\n" \
4838 "b\n" \
4839 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004840
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004841#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004842 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004843#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004844 "Extract files from ZIP archives\n" \
4845 "\nOptions:" \
4846 "\n -l List archive contents (with -q for short form)" \
4847 "\n -n Never overwrite existing files (default)" \
4848 "\n -o Overwrite files without prompting" \
4849 "\n -p Send output to stdout" \
4850 "\n -q Quiet" \
4851 "\n -x Exclude these files" \
4852 "\n -d Extract files into this directory" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004853
Eric Andersen7e9276b2001-02-22 01:15:47 +00004854#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004855 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004856#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004857 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004858
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004859#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004860 "$ uptime\n" \
4861 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004862
4863#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004864 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004865#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004866 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004867
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004868#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004869 "$ usleep 1000000\n" \
4870 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004871
4872#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004873 "[-o outfile] [infile]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004874#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004875 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004876 "Finds outfile name in uuencoded source unless -o is given"
4877
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004878#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004879 "$ uudecode -o busybox busybox.uu\n" \
4880 "$ ls -l busybox\n" \
4881 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004882
4883#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004884 "[-m] [infile] stored_filename"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004885#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004886 "Uuencode a file to stdout\n" \
4887 "\nOptions:" \
4888 "\n -m Use base64 encoding per RFC1521" \
4889
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004890#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004891 "$ uuencode busybox busybox\n" \
4892 "begin 755 busybox\n" \
4893 "<encoded file snipped>\n" \
4894 "$ uudecode busybox busybox > busybox.uu\n" \
4895 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004896
Eric Andersen853c4942003-01-23 05:59:32 +00004897#define vconfig_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004898 "COMMAND [OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004899#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004900 "Create and remove virtual ethernet devices\n" \
4901 "\nOptions:" \
4902 "\n add [interface-name] [vlan_id]" \
4903 "\n rem [vlan-name]" \
4904 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4905 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4906 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4907 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004908
Eric Andersen3f980402001-04-04 17:31:15 +00004909#define vi_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004910 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004911#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004912 "Edit FILE\n" \
4913 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004914 IF_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004915 "\n -c Initial command to run ($EXINIT also available)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004916 IF_FEATURE_VI_READONLY( \
Denys Vlasenko07697852009-10-06 21:11:37 +02004917 "\n -R Read-only - don't write to the file") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004918 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00004919
Eric Andersen27f64e12002-06-23 04:24:25 +00004920#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004921 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004922#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004923 "Lock a virtual terminal. A password is required to unlock.\n" \
4924 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00004925 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004926
Matthew Stoltenberg4803db52009-08-13 00:59:32 +02004927#define volname_trivial_usage \
4928 "[DEVICE]"
4929#define volname_full_usage "\n\n" \
4930 "Show CD volume name of the DEVICE (default /dev/cdrom)"
4931
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004932#define watch_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004933 "[-n seconds] [-t] PROG [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004934#define watch_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004935 "Run PROG periodically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004936 "\nOptions:" \
4937 "\n -n Loop period in seconds (default 2)" \
4938 "\n -t Don't print header" \
4939
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004940#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004941 "$ watch date\n" \
4942 "Mon Dec 17 10:31:40 GMT 2000\n" \
4943 "Mon Dec 17 10:31:42 GMT 2000\n" \
4944 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004945
Eric Andersen7e9276b2001-02-22 01:15:47 +00004946#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004947 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004948#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004949 "Periodically write to watchdog device DEV\n" \
4950 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004951 "\n -T N Reboot after N seconds if not reset (default 60)" \
4952 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004953 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004954 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004955 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004956
4957#define wc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004958 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004959#define wc_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004960 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004961 "more than one FILE is specified. With no FILE, read standard input.\n" \
4962 "\nOptions:" \
4963 "\n -c Print the byte counts" \
4964 "\n -l Print the newline counts" \
4965 "\n -L Print the length of the longest line" \
4966 "\n -w Print the word counts" \
4967
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004968#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004969 "$ wc /etc/passwd\n" \
4970 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004971
4972#define wget_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004973 IF_FEATURE_WGET_LONG_OPTIONS( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004974 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004975 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4976 " [-U|--user-agent agent] url" \
4977 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004978 IF_NOT_FEATURE_WGET_LONG_OPTIONS( \
Denis Vlasenko03630782007-10-18 11:11:12 +00004979 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4980 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004981#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004982 "Retrieve files via HTTP or FTP\n" \
4983 "\nOptions:" \
4984 "\n -s Spider mode - only check file existence" \
4985 "\n -c Continue retrieval of aborted transfer" \
4986 "\n -q Quiet" \
4987 "\n -P Set directory prefix to DIR" \
4988 "\n -O Save to filename ('-' for stdout)" \
4989 "\n -U Adjust 'User-Agent' field" \
4990 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004991
4992#define which_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004993 "[COMMAND]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004994#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004995 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004996#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004997 "$ which login\n" \
4998 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004999
Eric Andersen00a6a752002-04-26 23:53:10 +00005000#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00005001 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005002#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005003 "Show who is logged on\n" \
5004 "\nOptions:" \
5005 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005006
5007#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005008 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005009#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005010 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005011
5012#define xargs_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005013 "[OPTIONS] [PROG [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005014#define xargs_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005015 "Run PROG on every item given by standard input\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005016 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005017 IF_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005018 "\n -p Ask user whether to run each command") \
Denys Vlasenko07697852009-10-06 21:11:37 +02005019 "\n -r Don't run command if input is empty" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005020 IF_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005021 "\n -0 Input is separated by NUL characters") \
5022 "\n -t Print the command on stderr before execution" \
Denis Vlasenkoe82da4d2008-08-21 19:59:30 +00005023 "\n -e[STR] STR stops input processing" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005024 "\n -n N Pass no more than N args to PROG" \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005025 "\n -s N Pass command line of no more than N bytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005026 IF_FEATURE_XARGS_SUPPORT_TERMOPT( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005027 "\n -x Exit if size is exceeded") \
Denis Vlasenko397de612008-03-17 08:55:44 +00005028
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005029#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005030 "$ ls | xargs gzip\n" \
5031 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005032
5033#define yes_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005034 "[OPTIONS] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005035#define yes_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005036 "Repeatedly output a line with STRING, or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00005037
Eric Andersen7e9276b2001-02-22 01:15:47 +00005038#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005039 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005040#define zcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005041 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00005042
Rob Landleyad8071f2005-04-30 03:49:37 +00005043#define zcip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005044 "[OPTIONS] IFACE SCRIPT"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005045#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005046 "Manage a ZeroConf IPv4 link-local address\n" \
5047 "\nOptions:" \
5048 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00005049 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005050 "\n -r 169.254.x.x Request this address first" \
5051 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00005052 "\n" \
5053 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
5054 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00005055
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00005056
5057#endif