blob: 40cb6b2bbeffb004c82cbd15a7beceec57fd2f71 [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 \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010019 "[-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 \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010036 "[-g GID] " IF_FEATURE_ADDUSER_TO_GROUP("[USER] ") "GROUP"
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 \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010044 "[OPTIONS] USER"
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 \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010058 "[-q] [-o OFF] [-f FREQ] [-p TCONST] [-t TICK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000059#define adjtimex_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +010060 "Read and optionally set system timebase parameters. See adjtimex(2)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000061 "\nOptions:" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010062 "\n -q Quiet" \
63 "\n -o OFF Time offset, microseconds" \
64 "\n -f FREQ 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 TCONST" \
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 \
Denys Vlasenko125c2d22010-02-13 02:59:30 +010081 "\n[-vn] [-H HWTYPE] [-i IF] -a [HOSTNAME]" \
82 "\n[-v] [-i IF] -d HOSTNAME [pub]" \
83 "\n[-v] [-H HWTYPE] [-i IF] -s HOSTNAME HWADDR [temp]" \
84 "\n[-v] [-H HWTYPE] [-i IF] -s HOSTNAME HWADDR [netmask MASK] pub" \
85 "\n[-v] [-H HWTYPE] [-i IF] -Ds HOSTNAME IFACE [netmask MASK] 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 \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100100 "[-fqbDUA] [-c CNT] [-w TIMEOUT] [-I IFACE] [-s SRC_IP] DST_IP"
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" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100111 "\n -w TIMEOUT Time to wait for ARP reply, seconds" \
112 "\n -I IFACE Interface to use (default eth0)" \
113 "\n -s SRC_IP Sender IP address" \
114 "\n DST_IP Target IP address" \
Glenn L McGrath9e598412003-01-09 10:06:01 +0000115
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000116#define sh_trivial_usage NOUSAGE_STR
117#define sh_full_usage ""
118#define ash_trivial_usage NOUSAGE_STR
119#define ash_full_usage ""
120#define hush_trivial_usage NOUSAGE_STR
121#define hush_full_usage ""
Denys Vlasenko1cc4b132009-08-21 00:05:51 +0200122#define lash_trivial_usage NOUSAGE_STR
123#define lash_full_usage ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000124#define msh_trivial_usage NOUSAGE_STR
125#define msh_full_usage ""
Eric Andersen08f59e32004-03-12 22:07:10 +0000126
127#define awk_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200128 "[OPTIONS] [AWK_PROGRAM] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000129#define awk_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000130 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200131 "\n -v VAR=VAL Set variable" \
132 "\n -F SEP Use SEP as field separator" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +0100133 "\n -f FILE Read program from FILE" \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +0000134
Eric Andersen7e9276b2001-02-22 01:15:47 +0000135#define basename_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000136 "FILE [SUFFIX]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000137#define basename_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200138 "Strip directory path and .SUFFIX from FILE\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000139#define basename_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000140 "$ basename /usr/local/bin/foo\n" \
141 "foo\n" \
142 "$ basename /usr/local/bin/\n" \
143 "bin\n" \
144 "$ basename /foo/bar.txt .txt\n" \
145 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000146
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200147#define beep_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100148 "-f FREQ -l LEN -d DELAY -r COUNT -n"
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200149#define beep_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +0200150 "Options:" \
Bernhard Reutner-Fischer45de0742009-08-21 13:18:31 +0200151 "\n -f Frequency in Hz" \
152 "\n -l Length in ms" \
153 "\n -d Delay in ms" \
154 "\n -r Repetitions" \
155 "\n -n Start new tone" \
156
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000157#define fbsplash_trivial_usage \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000158 "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000159#define fbsplash_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +0200160 "Options:" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000161 "\n -s Image" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000162 "\n -c Hide cursor" \
163 "\n -d Framebuffer device (default /dev/fb0)" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000164 "\n -i Config file (var=value):" \
165 "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT" \
166 "\n BAR_R,BAR_G,BAR_B" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000167 "\n -f Control pipe (else exit after drawing image)" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000168 "\n commands: 'NN' (% for progress bar) or 'exit'" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000169
Bernhard Reutner-Fischerd27d9252008-01-13 15:23:27 +0000170#define brctl_trivial_usage \
171 "COMMAND [BRIDGE [INTERFACE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000172#define brctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200173 "Manage ethernet bridges\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000174 "\nCommands:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000175 IF_FEATURE_BRCTL_SHOW( \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000176 "\n show Show a list of bridges" \
177 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000178 "\n addbr BRIDGE Create BRIDGE" \
179 "\n delbr BRIDGE Delete BRIDGE" \
180 "\n addif BRIDGE IFACE Add IFACE to BRIDGE" \
181 "\n delif BRIDGE IFACE Delete IFACE from BRIDGE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000182 IF_FEATURE_BRCTL_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000183 "\n setageing BRIDGE TIME Set ageing time" \
184 "\n setfd BRIDGE TIME Set bridge forward delay" \
185 "\n sethello BRIDGE TIME Set hello time" \
186 "\n setmaxage BRIDGE TIME Set max message age" \
187 "\n setpathcost BRIDGE COST Set path cost" \
188 "\n setportprio BRIDGE PRIO Set port priority" \
189 "\n setbridgeprio BRIDGE PRIO Set bridge priority" \
Maciek Borzecki30ebd7b2010-03-23 05:18:38 +0100190 "\n stp BRIDGE [1/yes/on|0/no/off] 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 Vlasenkobb169f42010-02-14 05:43:22 +0100194 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000195#define bunzip2_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100196 "Uncompress FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000197 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100198 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000199 "\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 Vlasenkobb169f42010-02-14 05:43:22 +0100204 "Compress FILEs (or stdin) with bzip2 algorithm\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000205 "\nOptions:" \
Bernhard Reutner-Fischerbaab3272010-02-14 11:11:47 +0100206 "\n -c Write to stdout" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000207 "\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" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100217 " -c Write to stdout" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000218 "\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" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100234 " -c Write to stdout" \
Denis Vlasenko052ad9a2009-04-29 12:01:51 +0000235 "\n -f Force" \
236 "\n -v Verbose" \
237 "\n -F Don't store or verify checksum" \
238
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 Vlasenkobb169f42010-02-14 05:43:22 +0100245 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000246#define unlzma_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100247 "Uncompress FILE (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000248 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100249 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000250 "\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 \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100258 "[-jy] [[MONTH] YEAR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000259#define cal_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000260 "Display a calendar\n" \
261 "\nOptions:" \
262 "\n -j Use julian dates" \
263 "\n -y Display the entire year" \
Eric Andersenc98c0622001-12-06 15:16:43 +0000264
Eric Andersen7e9276b2001-02-22 01:15:47 +0000265#define cat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000266 "[-u] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000267#define cat_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +0200268 "Concatenate FILEs and print them to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000269 "\nOptions:" \
270 "\n -u Use unbuffered i/o (ignored)" \
271
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000272#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000273 "$ cat /proc/uptime\n" \
274 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000275
Rob Landley8abbee42006-05-31 19:36:04 +0000276#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000277 "[-etv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000278#define catv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000279 "Display nonprinting characters as ^x or M-x\n" \
280 "\nOptions:" \
281 "\n -e End each line with $" \
282 "\n -t Show tabs as ^I" \
283 "\n -v Don't use ^x or M-x escapes" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000284
285#define chat_trivial_usage \
286 "EXPECT [SEND [EXPECT [SEND...]]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000287#define chat_full_usage "\n\n" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000288 "Useful for interacting with a modem connected to stdin/stdout.\n" \
289 "A script consists of one or more \"expect-send\" pairs of strings,\n" \
290 "each pair is a pair of arguments. Example:\n" \
291 "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \
292
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000293#define chattr_trivial_usage \
Denys Vlasenko79ae5342010-01-06 12:27:18 +0100294 "[-R] [-+=AacDdijsStTu] [-v VERSION] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000295#define chattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000296 "Change file attributes on an ext2 fs\n" \
297 "\nModifiers:" \
298 "\n - Remove attributes" \
299 "\n + Add attributes" \
300 "\n = Set attributes" \
301 "\nAttributes:" \
302 "\n A Don't track atime" \
303 "\n a Append mode only" \
304 "\n c Enable compress" \
305 "\n D Write dir contents synchronously" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200306 "\n d Don't backup with dump" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000307 "\n i Cannot be modified (immutable)" \
308 "\n j Write all data to journal first" \
309 "\n s Zero disk storage when deleted" \
310 "\n S Write file contents synchronously" \
311 "\n t Disable tail-merging of partial blocks with other files" \
312 "\n u Allow file to be undeleted" \
313 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100314 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000315 "\n -v Set the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000316
Denis Vlasenko49622d72007-03-10 16:58:49 +0000317#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000318 "[OPTIONS] CONTEXT FILE..." \
319 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000320 IF_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000321 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
322 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000323#define chcon_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000324 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000325 IF_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000326 "\n -v,--verbose Verbose" \
327 "\n -c,--changes Report changes made" \
328 "\n -h,--no-dereference Affect symlinks instead of their targets" \
329 "\n -f,--silent,--quiet Suppress most error messages" \
330 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
331 "\n -u,--user=USER Set user/role/type/range in the target" \
332 "\n -r,--role=ROLE security context" \
333 "\n -t,--type=TYPE" \
334 "\n -l,--range=RANGE" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200335 "\n -R,--recursive Recurse" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000336 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000337 IF_NOT_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000338 "\n -v Verbose" \
339 "\n -c Report changes made" \
340 "\n -h Affect symlinks instead of their targets" \
341 "\n -f Suppress most error messages" \
342 "\n -u USER Set user/role/type/range in the target security context" \
343 "\n -r ROLE" \
344 "\n -t TYPE" \
345 "\n -l RNG" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200346 "\n -R Recurse" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000347 )
348
Eric Andersen7e9276b2001-02-22 01:15:47 +0000349#define chmod_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000350 "[-R"IF_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000351#define chmod_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000352 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000353 "symbols +-= and one or more of the letters rwxst\n" \
354 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200355 "\n -R Recurse" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000356 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000357 "\n -c List changed files" \
358 "\n -v List all files" \
359 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000360 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000361#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000362 "$ ls -l /tmp/foo\n" \
363 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
364 "$ chmod u+x /tmp/foo\n" \
365 "$ ls -l /tmp/foo\n" \
366 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
367 "$ chmod 444 /tmp/foo\n" \
368 "$ ls -l /tmp/foo\n" \
369 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000370
Denis Vlasenko081ef792007-03-17 16:38:21 +0000371#define chgrp_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000372 "[-RhLHP"IF_DESKTOP("cvf")"]... GROUP FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000373#define chgrp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000374 "Change the group membership of each FILE to GROUP\n" \
375 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200376 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000377 "\n -h Affect symlinks instead of symlink targets" \
378 "\n -L Traverse all symlinks to directories" \
379 "\n -H Traverse symlinks on command line only" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200380 "\n -P Don't traverse symlinks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000381 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000382 "\n -c List changed files" \
383 "\n -v Verbose" \
384 "\n -f Hide errors" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000385 )
386#define chgrp_example_usage \
387 "$ ls -l /tmp/foo\n" \
388 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
389 "$ chgrp root /tmp/foo\n" \
390 "$ ls -l /tmp/foo\n" \
391 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
392
Eric Andersen7e9276b2001-02-22 01:15:47 +0000393#define chown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000394 "[-RhLHP"IF_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000395#define chown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000396 "Change the owner and/or group of each FILE to OWNER and/or GROUP\n" \
397 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +0200398 "\n -R Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000399 "\n -h Affect symlinks instead of symlink targets" \
400 "\n -L Traverse all symlinks to directories" \
401 "\n -H Traverse symlinks on command line only" \
Denys Vlasenko07697852009-10-06 21:11:37 +0200402 "\n -P Don't traverse symlinks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000403 IF_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000404 "\n -c List changed files" \
405 "\n -v List all files" \
406 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000407 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000408#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000409 "$ ls -l /tmp/foo\n" \
410 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
411 "$ chown root /tmp/foo\n" \
412 "$ ls -l /tmp/foo\n" \
413 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
414 "$ chown root.root /tmp/foo\n" \
415 "ls -l /tmp/foo\n" \
416 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000417
Denis Vlasenkofe544582006-10-03 15:57:40 +0000418#define chpst_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000419 "[-vP012] [-u USER[:GRP]] [-U USER[:GRP]] [-e DIR]\n" \
420 " [-/ DIR] [-n NICE] [-m BYTES] [-d BYTES] [-o N]\n" \
421 " [-p N] [-f BYTES] [-c BYTES] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000422#define chpst_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000423 "Change the process state and run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000424 "\nOptions:" \
425 "\n -u USER[:GRP] Set uid and gid" \
426 "\n -U USER[:GRP] Set $UID and $GID in environment" \
427 "\n -e DIR Set environment variables as specified by files" \
428 "\n in DIR: file=1st_line_of_file" \
429 "\n -/ DIR Chroot to DIR" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000430 "\n -n NICE Add NICE to nice value" \
431 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000432 "\n -d BYTES Limit data segment" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000433 "\n -o N Limit number of open files per process" \
434 "\n -p N Limit number of processes per uid" \
435 "\n -f BYTES Limit output file sizes" \
436 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000437 "\n -v Verbose" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000438 "\n -P Create new process group" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100439 "\n -0 Close stdin" \
440 "\n -1 Close stdout" \
441 "\n -2 Close stderr" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000442
Denis Vlasenkofe544582006-10-03 15:57:40 +0000443#define setuidgid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100444 "USER PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000445#define setuidgid_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100446 "Set uid and gid to USER'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 \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100449 "USER PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000450#define envuidgid_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100451 "Set $UID to USER's uid and $GID to USER's gid and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000452#define envdir_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100453 "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 Vlasenko125c2d22010-02-13 02:59:30 +0100480 "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 Vlasenko125c2d22010-02-13 02:59:30 +0100530 "[OPTIONS] [PRIO] [PID | PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000531#define chrt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000532 "Manipulate real-time attributes of a process\n" \
533 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100534 "\n -p Operate on PID" \
535 "\n -r Set SCHED_RR scheduling" \
536 "\n -f Set SCHED_FIFO scheduling" \
537 "\n -o Set SCHED_OTHER scheduling" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000538 "\n -m Show min and max priorities" \
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000539
540#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000541 "$ chrt -r 4 sleep 900; x=$!\n" \
542 "$ chrt -f -p 3 $x\n" \
543 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000544
Eric Andersen7e9276b2001-02-22 01:15:47 +0000545#define cp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200546 "[OPTIONS] SOURCE DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000547#define cp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000548 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY\n" \
549 "\nOptions:" \
550 "\n -a Same as -dpR" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000551 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000552 "\n -c Preserve security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000553 ) \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100554 "\n -R,-r Recurse" \
555 "\n -d,-P Preserve symlinks (default if -R)" \
556 "\n -L Follow all symlinks" \
557 "\n -H Follow symlinks on command line" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000558 "\n -p Preserve file attributes if possible" \
559 "\n -f Force overwrite" \
560 "\n -i Prompt before overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000561 "\n -l,-s Create (sym)links" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000562
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000563#define cpio_trivial_usage \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100564 "[-dmvu] [-F FILE]" IF_FEATURE_CPIO_O(" [-H newc]") \
565 " [-ti"IF_FEATURE_CPIO_O("o")"]" IF_FEATURE_CPIO_P(" [-p DIR]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000566#define cpio_full_usage "\n\n" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000567 "Extract or list files from a cpio archive" \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100568 IF_FEATURE_CPIO_O(", or" \
569 "\ncreate an archive" IF_FEATURE_CPIO_P(" (-o) or copy files (-p)") \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100570 " using file list on stdin" \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100571 ) \
572 "\n" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000573 "\nMain operation mode:" \
574 "\n -t List" \
575 "\n -i Extract" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000576 IF_FEATURE_CPIO_O( \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100577 "\n -o Create (requires -H newc)" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000578 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000579 IF_FEATURE_CPIO_P( \
Denys Vlasenko93ac7d82010-01-09 19:56:15 +0100580 "\n -p DIR Copy files to DIR" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000581 ) \
582 "\nOptions:" \
583 "\n -d Make leading directories" \
584 "\n -m Preserve mtime" \
585 "\n -v Verbose" \
586 "\n -u Overwrite" \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100587 "\n -F FILE Input (-t,-i,-p) or output (-o) file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000588 IF_FEATURE_CPIO_O( \
Denys Vlasenko607f65d2010-01-09 20:23:03 +0100589 "\n -H newc Archive format" \
Denis Vlasenko83518d12009-03-20 22:17:13 +0000590 ) \
Tim Riker7b253f82003-12-28 05:02:40 +0000591
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000592#define crond_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000593 "-fbS -l N " IF_FEATURE_CROND_D("-d N ") "-L LOGFILE -c DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000594#define crond_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000595 " -f Foreground" \
596 "\n -b Background (default)" \
597 "\n -S Log to syslog (default)" \
598 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000599 IF_FEATURE_CROND_D( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000600 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000601 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000602 "\n -L Log to file" \
603 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000604
605#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000606 "[-c DIR] [-u USER] [-ler]|[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000607#define crontab_full_usage "\n\n" \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000608 " -c Crontab directory" \
609 "\n -u User" \
610 "\n -l List crontab" \
611 "\n -e Edit crontab" \
612 "\n -r Delete crontab" \
613 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000614
Denis Vlasenko2211d522008-11-10 18:52:35 +0000615#define cryptpw_trivial_usage \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000616 "[OPTIONS] [PASSWORD] [SALT]"
617/* We do support -s, we just don't mention it */
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000618#define cryptpw_full_usage "\n\n" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000619 "Crypt the PASSWORD using crypt(3)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000620 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200621 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100622 "\n -P,--password-fd=N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000623/* "\n -s,--stdin Use stdin; like -P0" */ \
624 "\n -m,--method=TYPE Encryption method TYPE" \
625 "\n -S,--salt=SALT" \
626 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200627 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100628 "\n -P N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000629/* "\n -s Use stdin; like -P0" */ \
630 "\n -m TYPE Encryption method TYPE" \
631 "\n -S SALT" \
632 ) \
633
634/* mkpasswd is an alias to cryptpw */
635
636#define mkpasswd_trivial_usage \
637 "[OPTIONS] [PASSWORD] [SALT]"
638/* We do support -s, we just don't mention it */
639#define mkpasswd_full_usage "\n\n" \
640 "Crypt the PASSWORD using crypt(3)\n" \
641 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200642 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100643 "\n -P,--password-fd=N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000644/* "\n -s,--stdin Use stdin; like -P0" */ \
645 "\n -m,--method=TYPE Encryption method TYPE" \
646 "\n -S,--salt=SALT" \
647 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200648 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +0100649 "\n -P N Read password from fd N" \
Denis Vlasenkoe45930e2008-12-04 12:05:26 +0000650/* "\n -s Use stdin; like -P0" */ \
651 "\n -m TYPE Encryption method TYPE" \
652 "\n -S SALT" \
653 ) \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000654
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000655#define cttyhack_trivial_usage NOUSAGE_STR
656#define cttyhack_full_usage ""
657
Eric Andersen7e9276b2001-02-22 01:15:47 +0000658#define cut_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200659 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000660#define cut_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100661 "Print selected fields from each input FILE to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000662 "\nOptions:" \
663 "\n -b LIST Output only bytes from LIST" \
664 "\n -c LIST Output only characters from LIST" \
665 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
666 "\n -s Output only the lines containing delimiter" \
667 "\n -f N Print only these fields" \
668 "\n -n Ignored" \
669
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000670#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000671 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
672 "Hello\n" \
673 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
674 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000675
Eric Andersen7e9276b2001-02-22 01:15:47 +0000676#define date_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200677 "[OPTIONS] [+FMT] [TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000678#define date_full_usage "\n\n" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000679 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000680 "\nOptions:" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200681 IF_NOT_LONG_OPTS( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200682 "\n [-s] TIME Set time to TIME" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000683 "\n -u Work in UTC (don't convert to local time)" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200684 "\n -R Output RFC-2822 compliant date string" \
685 ) IF_LONG_OPTS( \
686 "\n [-s,--set] TIME Set time to TIME" \
Denys Vlasenko50be9632009-10-23 16:25:20 +0200687 "\n -u,--utc Work in UTC (don't convert to local time)" \
688 "\n -R,--rfc-2822 Output RFC-2822 compliant date string" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200689 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000690 IF_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000691 "\n -I[SPEC] Output ISO-8601 compliant date string" \
692 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000693 "\n 'hours', 'minutes', or 'seconds' for date and" \
694 "\n time to the indicated precision" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200695 ) IF_NOT_LONG_OPTS( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000696 "\n -r FILE Display last modification time of FILE" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200697 "\n -d TIME Display TIME, not 'now'" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200698 ) IF_LONG_OPTS( \
Denys Vlasenko50be9632009-10-23 16:25:20 +0200699 "\n -r,--reference FILE Display last modification time of FILE" \
700 "\n -d,--date TIME Display TIME, not 'now'" \
Bernhard Reutner-Fischerca22cda2009-10-23 15:44:51 +0200701 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000702 IF_FEATURE_DATE_ISOFMT( \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200703 "\n -D FMT Use FMT for -d TIME conversion" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000704 ) \
705 "\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +0200706 "\nRecognized TIME formats:" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000707 "\n hh:mm[:ss]" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000708 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000709 "\n YYYY-MM-DD hh:mm[:ss]" \
Denys Vlasenko38dd8aa2009-07-18 04:49:20 +0200710 "\n [[[[[YY]YY]MM]DD]hh]mm[.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000711
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000712#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000713 "$ date\n" \
714 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000715
Eric Andersen7e9276b2001-02-22 01:15:47 +0000716#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000717 "expression..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000718#define dc_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +0000719 "Tiny RPN calculator. Operations:\n" \
720 "+, add, -, sub, *, mul, /, div, %, mod, **, exp, and, or, not, eor,\n" \
721 "p - print top of the stack (without altering the stack),\n" \
722 "f - print entire stack, o - pop the value and set output radix\n" \
723 "(value must be 10 or 16).\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100724 "Examples: 'dc 2 2 add' -> 4, 'dc 8 8 * 2 2 + /' -> 16\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000725
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000726#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000727 "$ dc 2 2 + p\n" \
728 "4\n" \
729 "$ dc 8 8 \\* 2 2 + / p\n" \
730 "16\n" \
731 "$ dc 0 1 and p\n" \
732 "0\n" \
733 "$ dc 0 1 or p\n" \
734 "1\n" \
735 "$ echo 72 9 div 8 mul p | dc\n" \
736 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000737
Eric Andersen7e9276b2001-02-22 01:15:47 +0000738#define dd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000739 "[if=FILE] [of=FILE] " IF_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
740 " [seek=N]" IF_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000741#define dd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000742 "Copy a file with converting and formatting\n" \
743 "\nOptions:" \
744 "\n if=FILE Read from FILE instead of stdin" \
745 "\n of=FILE Write to FILE instead of stdout" \
746 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000747 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000748 "\n ibs=N Read N bytes at a time" \
749 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000750 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000751 "\n obs=N Write N bytes at a time" \
752 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000753 "\n count=N Copy only N input blocks" \
754 "\n skip=N Skip N input blocks" \
755 "\n seek=N Skip N output blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000756 IF_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000757 "\n conv=notrunc Don't truncate output file" \
758 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000759 "\n conv=sync Pad blocks with zeros" \
760 "\n conv=fsync Physically write data out before finishing" \
761 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000762 "\n" \
763 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
764 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
765
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000766#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000767 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
768 "4+0 records in\n" \
769 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000770
Eric Andersen7e9276b2001-02-22 01:15:47 +0000771#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000772 "[N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000773#define deallocvt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000774 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000775
Eric Andersenf349e972001-08-21 16:18:59 +0000776#define delgroup_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000777 IF_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000778#define delgroup_full_usage "\n\n" \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000779 "Delete group GROUP from the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000780 IF_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000781
782#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000783 "USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000784#define deluser_full_usage "\n\n" \
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000785 "Delete USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000786
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000787#define depmod_trivial_usage NOUSAGE_STR
788#define depmod_full_usage ""
Bernhard Reutner-Fischer55e547e2008-05-26 12:01:49 +0000789
Denis Vlasenkoc94fa562008-10-26 11:08:14 +0000790#define devmem_trivial_usage \
791 "ADDRESS [WIDTH [VALUE]]"
792
793#define devmem_full_usage "\n\n" \
794 "Read/write from physical address\n" \
795 "\n ADDRESS Address to act upon" \
796 "\n WIDTH Width (8/16/...)" \
797 "\n VALUE Data to be written" \
798
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000799#define devfsd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000800 "mntpnt [-v]" IF_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000801#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000802 "Manage devfs permissions and old device name symlinks\n" \
803 "\nOptions:" \
804 "\n mntpnt The mount point where devfs is mounted" \
805 "\n -v Print the protocol version numbers for devfsd" \
806 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000807 IF_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000808 "\n -fg Run in foreground" \
809 "\n -np Exit after parsing the configuration file" \
810 "\n and processing synthetic REGISTER events," \
Denys Vlasenko07697852009-10-06 21:11:37 +0200811 "\n don't poll for events" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000812 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000813
Eric Andersen7e9276b2001-02-22 01:15:47 +0000814#define df_trivial_usage \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000815 "[-Pk" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000816 IF_FEATURE_HUMAN_READABLE("mh") \
817 IF_FEATURE_DF_FANCY("ai] [-B SIZE") \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100818 "] [FILESYSTEM]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000819#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000820 "Print filesystem usage statistics\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000821 "\nOptions:" \
822 "\n -P POSIX output format" \
823 "\n -k 1024-byte blocks (default)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000824 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000825 "\n -m 1M-byte blocks" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000826 "\n -h Human readable (e.g. 1K 243M 2G)" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000827 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000828 IF_FEATURE_DF_FANCY( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000829 "\n -a Show all filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000830 "\n -i Inodes" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000831 "\n -B SIZE Blocksize" \
832 ) \
833
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000834#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000835 "$ df\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000836 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000837 "/dev/sda3 8690864 8553540 137324 98% /\n" \
838 "/dev/sda1 64216 36364 27852 57% /boot\n" \
839 "$ df /dev/sda3\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000840 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
841 "/dev/sda3 8690864 8553540 137324 98% /\n" \
842 "$ POSIXLY_CORRECT=sure df /dev/sda3\n" \
843 "Filesystem 512B-blocks Used Available Use% Mounted on\n" \
844 "/dev/sda3 17381728 17107080 274648 98% /\n" \
845 "$ POSIXLY_CORRECT=yep df -P /dev/sda3\n" \
846 "Filesystem 512-blocks Used Available Capacity Mounted on\n" \
847 "/dev/sda3 17381728 17107080 274648 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000848
Denis Vlasenko736230e2006-11-20 19:40:36 +0000849#define dhcprelay_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100850 "CLIENT_IFACE[,CLIENT_IFACE2]... SERVER_IFACE [SERVER_IP]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000851#define dhcprelay_full_usage "\n\n" \
Denis Vlasenkoe8a79682009-04-13 03:33:46 +0000852 "Relay DHCP requests between clients and server" \
Denis Vlasenko736230e2006-11-20 19:40:36 +0000853
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000854#define diff_trivial_usage \
Matheus Izvekovfe1ce2e2010-01-18 16:07:07 -0200855 "[-abBdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000856#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000857 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000858 "This implementation supports unified diffs only.\n" \
859 "\nOptions:" \
860 "\n -a Treat all files as text" \
861 "\n -b Ignore changes in the amount of whitespace" \
Matheus Izvekovfe1ce2e2010-01-18 16:07:07 -0200862 "\n -B Ignore changes whose lines are all blank" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000863 "\n -d Try hard to find a smaller set of changes" \
864 "\n -i Ignore case differences" \
865 "\n -L Use LABEL instead of the filename in the unified header" \
866 "\n -N Treat absent files as empty" \
867 "\n -q Output only whether files differ" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100868 "\n -r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000869 "\n -S Start with FILE when comparing directories" \
870 "\n -T Make tabs line up by prefixing a tab when necessary" \
871 "\n -s Report when two files are the same" \
872 "\n -t Expand tabs to spaces in output" \
873 "\n -U Output LINES lines of context" \
874 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000875
Eric Andersen7e9276b2001-02-22 01:15:47 +0000876#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000877 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000878#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000879 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000880#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000881 "$ dirname /tmp/foo\n" \
882 "/tmp\n" \
883 "$ dirname /tmp/foo/\n" \
884 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000885
Eric Andersen7e9276b2001-02-22 01:15:47 +0000886#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000887 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000888#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000889 "Print or control the kernel ring buffer\n" \
890 "\nOptions:" \
891 "\n -c Clear ring buffer after printing" \
892 "\n -n LEVEL Set console logging level" \
893 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000894
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000895#define dnsd_trivial_usage \
Denys Vlasenko343dfd72010-02-07 02:45:03 +0100896 "[-dvs] [-c CONFFILE] [-t TTL_SEC] [-p PORT] [-i ADDR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000897#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000898 "Small static DNS server daemon\n" \
899 "\nOptions:" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +0100900 "\n -c FILE Config file" \
901 "\n -t SEC TTL" \
902 "\n -p PORT Listen on PORT" \
903 "\n -i ADDR Listen on ADDR" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000904 "\n -d Daemonize" \
Denys Vlasenko343dfd72010-02-07 02:45:03 +0100905 "\n -v Verbose" \
906 "\n -s Send successful replies only. Use this if you want" \
907 "\n to use /etc/resolv.conf with two nameserver lines:" \
908 "\n nameserver DNSD_SERVER" \
909 "\n nameserver NORNAL_DNS_SERVER" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000910
Eric Andersen7e9276b2001-02-22 01:15:47 +0000911#define dos2unix_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +0200912 "[OPTIONS] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000913#define dos2unix_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200914 "Convert FILE in-place from DOS to Unix format.\n" \
915 "When no file is given, use stdin/stdout.\n" \
916 "\nOptions:" \
917 "\n -u dos2unix" \
918 "\n -d unix2dos" \
919
920#define unix2dos_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +0200921 "[OPTIONS] [FILE]"
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +0200922#define unix2dos_full_usage "\n\n" \
923 "Convert FILE in-place from Unix to DOS format.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000924 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000925 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000926 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000927 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000928
Eric Andersen7e9276b2001-02-22 01:15:47 +0000929#define dpkg_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +0100930 "[-ilCPru] [-F OPT] PACKAGE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000931#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000932 "Install, remove and manage Debian packages\n" \
933 "\nOptions:" \
934 "\n -i Install the package" \
935 "\n -l List of installed packages" \
936 "\n -C Configure an unpackaged package" \
937 "\n -F depends Ignore dependency problems" \
938 "\n -P Purge all files of a package" \
939 "\n -r Remove all but the configuration files for a package" \
940 "\n -u Unpack a package, but don't configure it" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000941
Eric Andersen7e9276b2001-02-22 01:15:47 +0000942#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000943 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000944#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000945 "Perform actions on Debian packages (.debs)\n" \
946 "\nOptions:" \
947 "\n -c List contents of filesystem tree" \
948 "\n -e Extract control files to [argument] directory" \
949 "\n -f Display control field name starting with [argument]" \
950 "\n -x Extract packages filesystem tree to directory" \
951 "\n -X Verbose extract" \
952
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000953#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000954 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000955
Eric Andersen7e9276b2001-02-22 01:15:47 +0000956#define du_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000957 "[-aHLdclsx" IF_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000958#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000959 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000960 "Disk space is printed in units of " \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000961 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
962 IF_NOT_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000963 " bytes.\n" \
964 "\nOptions:" \
965 "\n -a Show file sizes too" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000966 "\n -L Follow all symlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +0100967 "\n -H Follow symlinks on command line" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000968 "\n -d N Limit output to directories (and files with -a) of depth < N" \
969 "\n -c Show grand total" \
970 "\n -l Count sizes many times if hard linked" \
971 "\n -s Display only a total for each argument" \
972 "\n -x Skip directories on different filesystems" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000973 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000974 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
975 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000976 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000977 "\n -k Sizes in kilobytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000978 IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000979
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000980#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000981 "$ du\n" \
982 "16 ./CVS\n" \
983 "12 ./kernel-patches/CVS\n" \
984 "80 ./kernel-patches\n" \
985 "12 ./tests/CVS\n" \
986 "36 ./tests\n" \
987 "12 ./scripts/CVS\n" \
988 "16 ./scripts\n" \
989 "12 ./docs/CVS\n" \
990 "104 ./docs\n" \
991 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000992
Eric Andersen7e9276b2001-02-22 01:15:47 +0000993#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000994 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000995#define dumpkmap_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +0100996 "Print a binary keyboard translation table to stdout"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000997#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000998 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000999
Russ Dill61fb4892002-10-14 21:41:28 +00001000#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001001 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001002#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001003 "Display DHCP leases granted by udhcpd\n" \
1004 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001005 IF_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001006 "\n -f,--file=FILE Leases file to load" \
1007 "\n -r,--remaining Interpret lease times as time remaining" \
1008 "\n -a,--absolute Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001009 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001010 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001011 "\n -f FILE Leases file to load" \
1012 "\n -r Interpret lease times as time remaining" \
1013 "\n -a Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001014 )
Russ Dill61fb4892002-10-14 21:41:28 +00001015
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001016/*
Mike Frysinger51a43b42005-09-24 07:11:16 +00001017#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001018 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
1019 "[-I inode_buffer_blocks] [-P process_inode_size] " \
1020 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
1021 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001022#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001023 "Check ext2/ext3 file system\n" \
1024 "\nOptions:" \
1025 "\n -p Automatic repair (no questions)" \
1026 "\n -n Make no changes to the filesystem" \
1027 "\n -y Assume 'yes' to all questions" \
1028 "\n -c Check for bad blocks and add them to the badblock list" \
1029 "\n -f Force checking even if filesystem is marked clean" \
1030 "\n -v Verbose" \
1031 "\n -b superblock Use alternative superblock" \
1032 "\n -B blocksize Force blocksize when looking for superblock" \
1033 "\n -j journal Set location of the external journal" \
1034 "\n -l file Add to badblocks list" \
1035 "\n -L file Set badblocks list" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001036*/
Mike Frysinger51a43b42005-09-24 07:11:16 +00001037
Eric Andersen7e9276b2001-02-22 01:15:47 +00001038#define echo_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001039 IF_FEATURE_FANCY_ECHO("[-neE] ") "[ARG]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001040#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001041 "Print the specified ARGs to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001042 IF_FEATURE_FANCY_ECHO( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001043 "\nOptions:" \
1044 "\n -n Suppress trailing newline" \
1045 "\n -e Interpret backslash-escaped characters (i.e., \\t=tab)" \
1046 "\n -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001047 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001048#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001049 "$ echo \"Erik is cool\"\n" \
1050 "Erik is cool\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001051 IF_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001052 "Erik\n" \
1053 "is\n" \
1054 "cool\n" \
1055 "$ echo \"Erik\\nis\\ncool\"\n" \
1056 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001057
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001058#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001059 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001060#define eject_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001061 "Eject DEVICE or default /dev/cdrom\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001062 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001063 IF_FEATURE_EJECT_SCSI( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001064 "\n -s SCSI device" \
1065 ) \
1066 "\n -t Close tray" \
1067 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +00001068
Rob Landley3b890392006-05-04 20:56:43 +00001069#define ed_trivial_usage ""
1070#define ed_full_usage ""
1071
Eric Andersen84e229c2001-03-29 22:48:33 +00001072#define env_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001073 "[-iu] [-] [name=value]... [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001074#define env_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001075 "Print the current environment or run PROG after setting up\n" \
1076 "the specified environment\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001077 "\nOptions:" \
1078 "\n -, -i Start with an empty environment" \
1079 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +00001080
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001081#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001082 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001083#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001084 "Send a magic packet to wake up sleeping machines.\n" \
1085 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001086 "a hostname with a known 'ethers' entry.\n" \
1087 "\nOptions:" \
1088 "\n -b Send wake-up packet to the broadcast address" \
1089 "\n -i iface Interface to use (default eth0)" \
1090 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +00001091
Denis Vlasenko3952f202007-08-13 14:10:24 +00001092#define expand_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001093 "[-i] [-t N] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001094#define expand_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001095 "Convert tabs to spaces, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001096 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001097 IF_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001098 "\n -i,--initial Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001099 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001100 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001101 IF_NOT_FEATURE_EXPAND_LONG_OPTIONS( \
Denys Vlasenko07697852009-10-06 21:11:37 +02001102 "\n -i Don't convert tabs after non blanks" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001103 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001104 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00001105
Eric Andersen7e9276b2001-02-22 01:15:47 +00001106#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001107 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001108#define expr_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001109 "Print the value of EXPRESSION to stdout\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001110 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001111 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001112 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
1113 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1114 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1115 " ARG1 <= ARG2\n" \
1116 " ARG1 = ARG2\n" \
1117 " ARG1 != ARG2\n" \
1118 " ARG1 >= ARG2\n" \
1119 " ARG1 > ARG2\n" \
1120 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1121 " ARG1 - ARG2\n" \
1122 " ARG1 * ARG2\n" \
1123 " ARG1 / ARG2\n" \
1124 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001125 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1126 " match STRING REGEXP Same as STRING : REGEXP\n" \
1127 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1128 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1129 " length STRING Length of STRING\n" \
1130 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001131 " it is a keyword like 'match' or an\n" \
1132 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001133 " (EXPRESSION) Value of EXPRESSION\n" \
1134 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001135 "Beware that many operators need to be escaped or quoted for shells.\n" \
1136 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001137 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001138 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1139 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001140
Mike Frysingerfa69f112005-04-17 07:24:19 +00001141#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001142 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001143#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001144 "Provide fake ident (auth) service\n" \
1145 "\nOptions:" \
1146 "\n -f Run in foreground" \
1147 "\n -i Inetd mode" \
1148 "\n -w Inetd 'wait' mode" \
1149 "\n -b ADDR Bind to specified address" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001150 "\n STRING Ident answer string (default: nobody)" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001151
Eric Andersen7e9276b2001-02-22 01:15:47 +00001152#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001153 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001154#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001155 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001156
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001157#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001158 "$ false\n" \
1159 "$ echo $?\n" \
1160 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001161
1162#define fbset_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001163 "[OPTIONS] [MODE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001164#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001165 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001166
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001167#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001168 "$ fbset\n" \
1169 "mode \"1024x768-76\"\n" \
1170 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1171 " geometry 1024 768 1024 768 16\n" \
1172 " timings 12714 128 32 16 4 128 4\n" \
1173 " accel false\n" \
1174 " rgba 5/11,6/5,5/0,0/0\n" \
1175 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001176
Eric Andersen7e9276b2001-02-22 01:15:47 +00001177#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001178 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001179#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001180 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001181
Eric Andersen01c3d402003-07-05 07:51:31 +00001182#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001183 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001184#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001185 "Format floppy disk\n" \
1186 "\nOptions:" \
1187 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001188
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001189/* Looks like someone forgot to add this to config system */
1190#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1191# define ENABLE_FEATURE_FDISK_BLKSIZE 0
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001192# define IF_FEATURE_FDISK_BLKSIZE(a)
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001193#endif
1194
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001195#define fdisk_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001196 "[-ul" IF_FEATURE_FDISK_BLKSIZE("s") "] " \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001197 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001198#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001199 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001200 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001201 "\n -u Start and End are in sectors (instead of cylinders)" \
1202 "\n -l Show partition table for each DISK, then exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001203 IF_FEATURE_FDISK_BLKSIZE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001204 "\n -s Show partition sizes in kb for each DISK, then exit" \
1205 ) \
1206 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1207 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
1208 "\n -H HEADS\n" \
1209 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001210
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001211#define blkid_trivial_usage \
1212 ""
1213#define blkid_full_usage "\n\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02001214 "Print UUIDs of all filesystems"
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001215
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001216#define findfs_trivial_usage \
1217 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001218#define findfs_full_usage "\n\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02001219 "Find a filesystem device based on a label or UUID"
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001220#define findfs_example_usage \
1221 "$ findfs LABEL=MyDevice"
1222
Eric Andersen7e9276b2001-02-22 01:15:47 +00001223#define find_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001224 "[PATH]... [EXPRESSION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001225#define find_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001226 "Search for files. The default PATH is the current directory,\n" \
1227 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001228 "\nEXPRESSION may consist of:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001229 "\n -follow Follow symlinks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001230 IF_FEATURE_FIND_XDEV( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001231 "\n -xdev Don't descend directories on other filesystems") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001232 IF_FEATURE_FIND_MAXDEPTH( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001233 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1234 "\n tests/actions to command line arguments only") \
Denys Vlasenko07697852009-10-06 21:11:37 +02001235 "\n -mindepth N Don't act on first N levels" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001236 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001237 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001238 IF_FEATURE_FIND_PATH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001239 "\n -path PATTERN Path matches PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001240 IF_FEATURE_FIND_REGEX( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001241 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001242 IF_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001243 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001244 IF_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001245 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001246 "\n or exactly NNN") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001247 IF_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001248 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001249 "\n or exactly N days") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001250 IF_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001251 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001252 "\n or exactly N minutes") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001253 IF_FEATURE_FIND_NEWER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001254 "\n -newer FILE Modified time is more recent than FILE's") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001255 IF_FEATURE_FIND_INUM( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001256 "\n -inum N File has inode number N") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001257 IF_FEATURE_FIND_USER( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001258 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001259 IF_FEATURE_FIND_GROUP( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001260 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001261 IF_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001262 "\n -depth Process directory name after traversing it") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001263 IF_FEATURE_FIND_SIZE( \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001264 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001265 "\n +/-N: file size is bigger/smaller than N") \
Matheus Izvekovd0f601f2010-01-06 09:19:04 +01001266 IF_FEATURE_FIND_LINKS( \
1267 "\n -links N Number of links is greater than (+N), less than (-N)," \
1268 "\n or exactly N") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001269 "\n -print Print (default and assumed)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001270 IF_FEATURE_FIND_PRINT0( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001271 "\n -print0 Delimit output with null characters rather than" \
1272 "\n newlines") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001273 IF_FEATURE_FIND_CONTEXT ( \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001274 "\n -context File has specified security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001275 IF_FEATURE_FIND_EXEC( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001276 "\n -exec CMD ARG ; Run CMD with all instances of {} replaced by the" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001277 "\n matching files") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001278 IF_FEATURE_FIND_PRUNE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001279 "\n -prune Stop traversing current subtree") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001280 IF_FEATURE_FIND_DELETE( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001281 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001282 IF_FEATURE_FIND_PAREN( \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001283 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001284
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001285#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001286 "$ find / -name passwd\n" \
1287 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001288
Denys Vlasenkobf2af9a2009-05-25 04:15:37 +02001289#define flash_lock_trivial_usage \
1290 "MTD_DEVICE OFFSET SECTORS"
1291#define flash_lock_full_usage "\n\n" \
1292 "Lock part or all of an MTD device. If SECTORS is -1, then all sectors\n" \
1293 "will be locked, regardless of the value of OFFSET"
1294
1295#define flash_unlock_trivial_usage \
1296 "MTD_DEVICE"
1297#define flash_unlock_full_usage "\n\n" \
1298 "Unlock an MTD device"
1299
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001300#define flash_eraseall_trivial_usage \
1301 "[-jq] MTD_DEVICE"
1302#define flash_eraseall_full_usage "\n\n" \
1303 "Erase an MTD device\n" \
1304 "\nOptions:" \
Stefan Seyfriedd095fd42009-11-21 18:32:19 +01001305 "\n -j Format the device for jffs2" \
1306 "\n -q Don't display progress messages" \
1307
1308#define flashcp_trivial_usage \
1309 "-v FILE MTD_DEVICE"
1310#define flashcp_full_usage "\n\n" \
1311 "Copy an image to MTD device\n" \
1312 "\nOptions:" \
1313 "\n -v Verbose" \
Bernhard Reutner-Fischer0d22d172009-02-18 13:23:46 +00001314
Timo Teras892d4b62010-03-18 22:45:35 +01001315#define flock_trivial_usage \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001316 "[-sxun] FD|{FILE [-c] PROG ARGS}"
Timo Teras892d4b62010-03-18 22:45:35 +01001317#define flock_full_usage "\n\n" \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001318 "[Un]lock file descriptor, or lock FILE and run PROG\n" \
Timo Teras892d4b62010-03-18 22:45:35 +01001319 "\nOptions:" \
1320 "\n -s Shared lock" \
1321 "\n -x Exclusive lock (default)" \
Denys Vlasenkode9e7722010-03-20 00:07:11 +01001322 "\n -u Unlock FD" \
Timo Teras892d4b62010-03-18 22:45:35 +01001323 "\n -n Fail rather than wait" \
1324
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001325#define fold_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001326 "[-bs] [-w WIDTH] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001327#define fold_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001328 "Wrap input lines in each FILE (or stdin), writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001329 "\nOptions:" \
1330 "\n -b Count bytes rather than columns" \
1331 "\n -s Break at spaces" \
1332 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001333
Eric Andersen7e9276b2001-02-22 01:15:47 +00001334#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001335 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001336#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001337 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001338#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001339 "$ free\n" \
1340 " total used free shared buffers\n" \
1341 " Mem: 257628 248724 8904 59644 93124\n" \
1342 " Swap: 128516 8404 120112\n" \
1343 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001344
Eric Andersen7e9276b2001-02-22 01:15:47 +00001345#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001346 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001347#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001348 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001349#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001350 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001351
Mike Frysinger51a43b42005-09-24 07:11:16 +00001352#define fsck_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001353 "[-ANPRTV] [-C FD] [-t FSTYPE] [FS_OPTS] [BLOCKDEV]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001354#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001355 "Check and repair filesystems\n" \
1356 "\nOptions:" \
1357 "\n -A Walk /etc/fstab and check all filesystems" \
1358 "\n -N Don't execute, just show what would be done" \
1359 "\n -P With -A, check filesystems in parallel" \
1360 "\n -R With -A, skip the root filesystem" \
1361 "\n -T Don't show title on startup" \
1362 "\n -V Verbose" \
1363 "\n -C n Write status information to specified filedescriptor" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001364 "\n -t TYPE List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001365
Eric Andersen7e9276b2001-02-22 01:15:47 +00001366#define fsck_minix_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001367 "[-larvsmf] BLOCKDEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001368#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001369 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001370 "\nOptions:" \
1371 "\n -l List all filenames" \
1372 "\n -r Perform interactive repairs" \
1373 "\n -a Perform automatic repairs" \
1374 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001375 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001376 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001377 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001378
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001379#define ftpd_trivial_usage \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001380 "[-wvS] [-t N] [-T N] [DIR]"
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001381#define ftpd_full_usage "\n\n" \
Denys Vlasenkoae357bd2009-09-11 23:29:45 +02001382 "Anonymous FTP server\n" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001383 "\n" \
1384 "ftpd should be used as an inetd service.\n" \
1385 "ftpd's line for inetd.conf:\n" \
1386 " 21 stream tcp nowait root ftpd ftpd /files/to/serve\n" \
1387 "It also can be ran from tcpsvd:\n" \
1388 " tcpsvd -vE 0.0.0.0 21 ftpd /files/to/serve\n" \
1389 "\nOptions:" \
1390 "\n -w Allow upload" \
Denis Vlasenko4221e902009-03-11 15:07:44 +00001391 "\n -v Log to stderr" \
1392 "\n -S Log to syslog" \
Denis Vlasenko20c82162009-03-16 16:19:53 +00001393 "\n -t,-T Idle and absolute timeouts" \
Denis Vlasenko92576712009-03-09 16:25:33 +00001394 "\n DIR Change root to this directory" \
Denis Vlasenko16b4a2d2009-03-08 09:30:56 +00001395
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001396#define ftpget_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001397 "[OPTIONS] HOST [LOCAL_FILE] REMOTE_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001398#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001399 "Retrieve a remote file via FTP\n" \
1400 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001401 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001402 "\n -c,--continue Continue previous transfer" \
1403 "\n -v,--verbose Verbose" \
1404 "\n -u,--username Username" \
1405 "\n -p,--password Password" \
1406 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001407 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001408 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001409 "\n -c Continue previous transfer" \
1410 "\n -v Verbose" \
1411 "\n -u Username" \
1412 "\n -p Password" \
1413 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001414 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001415
1416#define ftpput_trivial_usage \
Vladimir Dronnikov1dacfbb2009-10-23 23:34:43 +02001417 "[OPTIONS] HOST [REMOTE_FILE] LOCAL_FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001418#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001419 "Store a local file on a remote machine via FTP\n" \
1420 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001421 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001422 "\n -v,--verbose Verbose" \
1423 "\n -u,--username Username" \
1424 "\n -p,--password Password" \
1425 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001426 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001427 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001428 "\n -v Verbose" \
1429 "\n -u Username" \
1430 "\n -p Password" \
1431 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001432 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001433
Rob Landleyaa872762005-10-28 13:05:12 +00001434#define fuser_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001435 "[OPTIONS] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001436#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001437 "Find processes which use FILEs or PORTs\n" \
1438 "\nOptions:" \
1439 "\n -m Find processes which use same fs as FILEs" \
1440 "\n -4 Search only IPv4 space" \
1441 "\n -6 Search only IPv6 space" \
1442 "\n -s Silent: just exit with 0 if any processes are found" \
1443 "\n -k Kill found processes (otherwise display PIDs)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001444 "\n -SIGNAL Signal to send (default: TERM)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001445
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001446#define getenforce_trivial_usage NOUSAGE_STR
1447#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001448
Eric Andersen7e9276b2001-02-22 01:15:47 +00001449#define getopt_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001450 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001451#define getopt_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02001452 "Options:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001453 IF_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001454 "\n -a,--alternative Allow long options starting with single -" \
1455 "\n -l,--longoptions=longopts Long options to be recognized" \
1456 "\n -n,--name=progname The name under which errors are reported" \
1457 "\n -o,--options=optstring Short options to be recognized" \
1458 "\n -q,--quiet Disable error reporting by getopt(3)" \
1459 "\n -Q,--quiet-output No normal output" \
1460 "\n -s,--shell=shell Set shell quoting conventions" \
1461 "\n -T,--test Test for getopt(1) version" \
1462 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001463 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001464 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001465 "\n -a Allow long options starting with single -" \
1466 "\n -l longopts Long options to be recognized" \
1467 "\n -n progname The name under which errors are reported" \
1468 "\n -o optstring Short options to be recognized" \
1469 "\n -q Disable error reporting by getopt(3)" \
1470 "\n -Q No normal output" \
1471 "\n -s shell Set shell quoting conventions" \
1472 "\n -T Test for getopt(1) version" \
1473 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001474 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001475#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001476 "$ cat getopt.test\n" \
1477 "#!/bin/sh\n" \
1478 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1479 " -n 'example.busybox' -- \"$@\"`\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001480 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001481 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001482 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001483 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001484 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1485 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001486 " -c|--c-long)\n" \
1487 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001488 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1489 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1490 " esac;;\n" \
1491 " --) shift; break;;\n" \
1492 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001493 " esac\n" \
1494 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001495
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001496#define getsebool_trivial_usage \
1497 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001498#define getsebool_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001499 " -a Show all SELinux booleans"
1500
Eric Andersenf349e972001-08-21 16:18:59 +00001501#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001502 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001503#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001504 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1505 "\nOptions:" \
1506 "\n -h Enable hardware (RTS/CTS) flow control" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001507 "\n -i Don't display /etc/issue before running login" \
1508 "\n -L Local line, don't do carrier detect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001509 "\n -m Get baud rate from modem's CONNECT status message" \
1510 "\n -w Wait for a CR or LF before sending /etc/issue" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001511 "\n -n Don't prompt the user for a login name" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02001512 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
1513 "\n -l LOGIN Invoke LOGIN instead of /bin/login" \
1514 "\n -t SEC Terminate after SEC if no username is read" \
1515 "\n -I INITSTR Send INITSTR before anything else" \
1516 "\n -H HOST Log HOST into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001517
Eric Andersen7e9276b2001-02-22 01:15:47 +00001518#define grep_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001519 "[-HhnlLoqvsri" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001520 IF_DESKTOP("w") \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001521 "F" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001522 IF_FEATURE_GREP_EGREP_ALIAS("E") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001523 IF_EXTRA_COMPAT("z") \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001524 "] [-m N] " \
1525 IF_FEATURE_GREP_CONTEXT("[-A/B/C N] ") \
1526 "PATTERN/-e PATTERN.../-f FILE [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001527#define grep_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001528 "Search for PATTERN in FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001529 "\nOptions:" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001530 "\n -H Add 'filename:' prefix" \
1531 "\n -h Do not add 'filename:' prefix" \
1532 "\n -n Add 'line_no:' prefix" \
1533 "\n -l Show only names of files that match" \
1534 "\n -L Show only names of files that don't match" \
1535 "\n -c Show only count of matching lines" \
1536 "\n -o Show only the matching part of line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001537 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1538 "\n -v Select non-matching lines" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001539 "\n -s Suppress open and read errors" \
1540 "\n -r Recurse" \
1541 "\n -i Ignore case" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001542 IF_DESKTOP( \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001543 "\n -w Match whole words only" \
1544 ) \
1545 "\n -F PATTERN is a literal (not regexp)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001546 IF_FEATURE_GREP_EGREP_ALIAS( \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001547 "\n -E PATTERN is an extended regexp" \
1548 ) \
1549 IF_EXTRA_COMPAT( \
1550 "\n -z Input is NUL terminated" \
1551 ) \
1552 "\n -m N Match up to N times per file" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001553 IF_FEATURE_GREP_CONTEXT( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001554 "\n -A N Print N lines of trailing context" \
1555 "\n -B N Print N lines of leading context" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001556 "\n -C N Same as '-A N -B N'" \
1557 ) \
1558 "\n -e PTRN Pattern to match" \
1559 "\n -f FILE Read pattern from file" \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001560
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001561#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001562 "$ grep root /etc/passwd\n" \
1563 "root:x:0:0:root:/root:/bin/bash\n" \
1564 "$ grep ^[rR]oo. /etc/passwd\n" \
1565 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001566
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001567#define egrep_trivial_usage NOUSAGE_STR
1568#define egrep_full_usage ""
1569
1570#define fgrep_trivial_usage NOUSAGE_STR
1571#define fgrep_full_usage ""
1572
Eric Andersen7e9276b2001-02-22 01:15:47 +00001573#define gunzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001574 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001575#define gunzip_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001576 "Uncompress FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001577 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001578 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001579 "\n -f Force" \
1580 "\n -t Test file integrity" \
1581
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001582#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001583 "$ ls -la /tmp/BusyBox*\n" \
1584 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1585 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1586 "$ ls -la /tmp/BusyBox*\n" \
1587 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001588
1589#define gzip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001590 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001591#define gzip_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001592 "Compress FILEs (or stdin)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001593 "\nOptions:" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001594 "\n -c Write to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001595 "\n -d Decompress" \
1596 "\n -f Force" \
1597
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001598#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001599 "$ ls -la /tmp/busybox*\n" \
1600 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1601 "$ gzip /tmp/busybox.tar\n" \
1602 "$ ls -la /tmp/busybox*\n" \
1603 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001604
1605#define halt_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01001606 "[-d DELAY] [-n] [-f]" IF_FEATURE_WTMP(" [-w]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001607#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001608 "Halt the system\n" \
1609 "\nOptions:" \
1610 "\n -d Delay interval for halting" \
1611 "\n -n No call to sync()" \
1612 "\n -f Force halt (don't go through init)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001613 IF_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001614 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001615 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001616
Eric Andersen3443bd72003-07-22 07:30:36 +00001617#define hdparm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001618 "[OPTIONS] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001619#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001620 "Options:" \
1621 "\n -a Get/set fs readahead" \
1622 "\n -A Set drive read-lookahead flag (0/1)" \
1623 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1624 "\n -B Set Advanced Power Management setting (1-255)" \
1625 "\n -c Get/set IDE 32-bit IO setting" \
1626 "\n -C Check IDE power mode status" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001627 IF_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001628 "\n -d Get/set using_dma flag") \
1629 "\n -D Enable/disable drive defect-mgmt" \
1630 "\n -f Flush buffer cache for device on exit" \
1631 "\n -g Display drive geometry" \
1632 "\n -h Display terse usage information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001633 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001634 "\n -i Display drive identification") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001635 IF_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001636 "\n -I Detailed/current information directly from drive") \
1637 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1638 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1639 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1640 "\n -m Get/set multiple sector count" \
1641 "\n -n Get/set ignore-write-errors flag (0/1)" \
1642 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1643 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001644/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001645 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1646 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001647 IF_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001648 "\n -R Register an IDE interface (DANGEROUS)") \
1649 "\n -S Set standby (spindown) timeout" \
1650 "\n -t Perform device read timings" \
1651 "\n -T Perform cache read timings" \
1652 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001653 IF_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001654 "\n -U Unregister an IDE interface (DANGEROUS)") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001655 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1656 "\n -V Display program version and exit immediately" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001657 IF_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001658 "\n -w Perform device reset (DANGEROUS)") \
1659 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001660 IF_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001661 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1662 "\n -X Set IDE xfer mode (DANGEROUS)" \
1663 "\n -y Put IDE drive in standby mode" \
1664 "\n -Y Put IDE drive to sleep" \
1665 "\n -Z Disable Seagate auto-powersaving mode" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01001666 "\n -z Reread partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001667
Eric Andersen7e9276b2001-02-22 01:15:47 +00001668#define head_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001669 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001670#define head_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001671 "Print first 10 lines of each FILE (or stdin) to stdout.\n" \
Denys Vlasenko57493282010-03-02 16:18:14 +01001672 "With more than one FILE, precede each with a filename header.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001673 "\nOptions:" \
Denys Vlasenko57493282010-03-02 16:18:14 +01001674 "\n -n N[kbm] Print first N lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001675 IF_FEATURE_FANCY_HEAD( \
Denys Vlasenko57493282010-03-02 16:18:14 +01001676 "\n -c N[kbm] Print first N bytes" \
1677 "\n -q Never print headers" \
1678 "\n -v Always print headers" \
1679 ) \
1680 "\n" \
1681 "\nN may be suffixed by k (x1024), b (x512), or m (x1024^2)." \
Denis Vlasenko397de612008-03-17 08:55:44 +00001682
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001683#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001684 "$ head -n 2 /etc/passwd\n" \
1685 "root:x:0:0:root:/root:/bin/bash\n" \
1686 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001687
Denys Vlasenko57493282010-03-02 16:18:14 +01001688#define tail_trivial_usage \
1689 "[OPTIONS] [FILE]..."
1690#define tail_full_usage "\n\n" \
1691 "Print last 10 lines of each FILE (or stdin) to stdout.\n" \
1692 "With more than one FILE, precede each with a filename header.\n" \
1693 "\nOptions:" \
1694 "\n -f Print data as file grows" \
1695 IF_FEATURE_FANCY_TAIL( \
1696 "\n -s SECONDS Wait SECONDS between reads with -f" \
1697 ) \
1698 "\n -n N[kbm] Print last N lines" \
1699 IF_FEATURE_FANCY_TAIL( \
1700 "\n -c N[kbm] Print last N bytes" \
1701 "\n -q Never print headers" \
1702 "\n -v Always print headers" \
1703 "\n" \
1704 "\nN may be suffixed by k (x1024), b (x512), or m (x1024^2)." \
1705 "\nIf N starts with a '+', output begins with the Nth item from the start" \
1706 "\nof each file, not from the end." \
1707 ) \
1708
1709#define tail_example_usage \
1710 "$ tail -n 1 /etc/resolv.conf\n" \
1711 "nameserver 10.0.0.1\n"
1712
Glenn L McGrath60281112001-11-02 11:39:46 +00001713#define hexdump_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001714 "[-bcCdefnosvx" IF_FEATURE_HEXDUMP_REVERSE("R") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001715#define hexdump_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01001716 "Display FILEs (or stdin) in a user specified format\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001717 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001718 "\n -b One-byte octal display" \
1719 "\n -c One-byte character display" \
1720 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1721 "\n -d Two-byte decimal display" \
1722 "\n -e FORMAT STRING" \
1723 "\n -f FORMAT FILE" \
1724 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1725 "\n -o Two-byte octal display" \
1726 "\n -s OFFSET Skip OFFSET bytes" \
1727 "\n -v Display all input data" \
1728 "\n -x Two-byte hexadecimal display" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001729 IF_FEATURE_HEXDUMP_REVERSE( \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001730 "\n -R Reverse of 'hexdump -Cv'") \
1731
1732#define hd_trivial_usage \
1733 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001734#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001735 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001736
Eric Andersen7e9276b2001-02-22 01:15:47 +00001737#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001738 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001739#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001740 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001741
1742#define hostname_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001743 "[OPTIONS] [HOSTNAME | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001744#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001745 "Get or set hostname or DNS domain name\n" \
1746 "\nOptions:" \
1747 "\n -s Short" \
1748 "\n -i Addresses for the hostname" \
1749 "\n -d DNS domain name" \
1750 "\n -f Fully qualified domain name" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001751 "\n -F FILE Use FILE's content as hostname" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001752
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001753#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001754 "$ hostname\n" \
1755 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001756
Denys Vlasenkod30b89c2009-06-26 01:55:45 +02001757#define dnsdomainname_trivial_usage NOUSAGE_STR
1758#define dnsdomainname_full_usage ""
1759
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001760#define httpd_trivial_usage \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001761 "[-ifv[v]]" \
1762 " [-c CONFFILE]" \
1763 " [-p [IP:]PORT]" \
1764 IF_FEATURE_HTTPD_SETUID(" [-u USER[:GRP]]") \
1765 IF_FEATURE_HTTPD_BASIC_AUTH(" [-r REALM]") \
1766 " [-h HOME]\n" \
1767 "or httpd -d/-e" IF_FEATURE_HTTPD_AUTH_MD5("/-m") " STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001768#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001769 "Listen for incoming HTTP requests\n" \
1770 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001771 "\n -i Inetd mode" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001772 "\n -f Don't daemonize" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001773 "\n -v[v] Verbose" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001774 "\n -c FILE Configuration file (default httpd.conf)" \
1775 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001776 IF_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001777 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001778 IF_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001779 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001780 "\n -h HOME Home directory (default .)" \
Denis Vlasenkob0291542009-04-22 00:26:39 +00001781 IF_FEATURE_HTTPD_AUTH_MD5( \
1782 "\n -m STRING MD5 crypt STRING") \
Denis Vlasenko397de612008-03-17 08:55:44 +00001783 "\n -e STRING HTML encode STRING" \
1784 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001785
Robert Griebl1cd04452002-07-21 16:50:49 +00001786#define hwclock_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001787 IF_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001788 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1789 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001790 " [-f FILE]" \
1791 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001792 IF_NOT_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001793 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1794 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001795#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001796 "Query and set hardware clock (RTC)\n" \
1797 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001798 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001799 "\n -s Set system time from hardware clock" \
1800 "\n -w Set hardware clock to system time" \
1801 "\n -u Hardware clock is in UTC" \
1802 "\n -l Hardware clock is in local time" \
1803 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001804
Eric Andersen7e9276b2001-02-22 01:15:47 +00001805#define id_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001806 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001807#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001808 "Print information about USER or the current user\n" \
1809 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001810 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001811 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001812 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001813 "\n -u Print user ID" \
Denis Vlasenko4f3209b2008-09-13 12:51:10 +00001814 "\n -g Print group ID" \
1815 "\n -G Print supplementary group IDs" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001816 "\n -n Print name instead of a number" \
1817 "\n -r Print real user ID instead of effective ID" \
1818
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001819#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001820 "$ id\n" \
1821 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001822
Eric Andersen7e9276b2001-02-22 01:15:47 +00001823#define ifconfig_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001824 IF_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001825#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001826 "Configure a network interface\n" \
1827 "\nOptions:" \
1828 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001829 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001830 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001831 IF_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001832 " [del ADDRESS[/PREFIXLEN]]\n") \
1833 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1834 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001835 IF_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001836 " [outfill NN] [keepalive NN]\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001837 " " IF_FEATURE_IFCONFIG_HW("[hw ether" IF_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001838 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001839 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001840 IF_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001841 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001842 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001843
Denis Vlasenko06aed432008-02-26 18:25:24 +00001844#define ifenslave_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001845 "[-cdf] MASTER_IFACE SLAVE_IFACE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001846#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001847 "Configure network interfaces for parallel routing\n" \
1848 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001849 "\n -c, --change-active Change active slave" \
1850 "\n -d, --detach Remove slave interface from bonding device" \
1851 "\n -f, --force Force, even if interface is not Ethernet" \
1852/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001853
Denis Vlasenko06aed432008-02-26 18:25:24 +00001854#define ifenslave_example_usage \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001855 "To create a bond device, simply follow these three steps:\n" \
1856 "- ensure that the required drivers are properly loaded:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001857 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001858 "- assign an IP address to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001859 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001860 "- attach all the interfaces you need to the bond device:\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001861 " # ifenslave bond0 eth0 eth1 eth2\n" \
1862 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1863 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001864 " To detach a dead interface without setting the bond device down:\n" \
1865 " # ifenslave -d bond0 eth1\n\n" \
1866 " To set the bond device down and automatically release all the slaves:\n" \
1867 " # ifconfig bond0 down\n\n" \
1868 " To change active slave:\n" \
1869 " # ifenslave -c bond0 eth0\n" \
1870
1871#define ifplugd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02001872 "[OPTIONS]"
Denis Vlasenko71c16572009-04-26 01:08:51 +00001873#define ifplugd_full_usage "\n\n" \
Denys Vlasenkoca899ef2009-08-27 03:20:45 +02001874 "Network interface plug detection daemon\n" \
1875 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02001876 "\n -n Don't daemonize" \
1877 "\n -s Don't log to syslog" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001878 "\n -i IFACE Interface" \
1879 "\n -f/-F Treat link detection error as link down/link up" \
1880 "\n (otherwise exit on error)" \
Denys Vlasenko999e4422010-01-08 13:03:48 +01001881 "\n -a Don't up interface at each link probe" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001882 "\n -M Monitor creation/destruction of interface" \
1883 "\n (otherwise it must exist)" \
1884 "\n -r PROG Script to run" \
1885 "\n -x ARG Extra argument for script" \
1886 "\n -I Don't exit on nonzero exit code from script" \
1887 "\n -p Don't run script on daemon startup" \
1888 "\n -q Don't run script on daemon quit" \
1889 "\n -l Run script on startup even if no cable is detected" \
1890 "\n -t SECS Poll time in seconds" \
1891 "\n -u SECS Delay before running script after link up" \
1892 "\n -d SECS Delay after link down" \
Denys Vlasenkob8f0e802010-01-07 14:56:50 +01001893 "\n -m MODE API mode (mii, priv, ethtool, wlan, iff, auto)" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00001894 "\n -k Kill running daemon" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001895
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001896#define ifup_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01001897 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] IFACE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001898#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001899 "Options:" \
1900 "\n -a De/configure all interfaces automatically" \
1901 "\n -i FILE Use FILE for interface definitions" \
1902 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001903 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001904 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001905 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001906 ) \
1907 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001908 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001909
1910#define ifdown_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001911 "[-ain"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001912#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001913 "Options:" \
1914 "\n -a De/configure all interfaces automatically" \
1915 "\n -i FILE Use FILE for interface definitions" \
1916 "\n -n Print out what would happen, but don't do it" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001917 IF_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001918 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001919 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001920 ) \
1921 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001922 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001923
Glenn L McGrath06e95652003-02-09 06:51:14 +00001924#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001925 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001926#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001927 "Listen for network connections and launch programs\n" \
1928 "\nOptions:" \
1929 "\n -f Run in foreground" \
1930 "\n -e Log to stderr" \
1931 "\n -q N Socket listen queue (default: 128)" \
1932 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001933 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001934
Eric Andersen7e9276b2001-02-22 01:15:47 +00001935#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001936 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001937#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001938 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001939
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001940#define init_notes_usage \
1941"This version of init is designed to be run only by the kernel.\n" \
1942"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001943"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001944"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001945"runlevels, use sysvinit.\n" \
1946"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001947"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001948"it has the following default behavior:\n" \
1949"\n" \
1950" ::sysinit:/etc/init.d/rcS\n" \
1951" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001952" ::ctrlaltdel:/sbin/reboot\n" \
1953" ::shutdown:/sbin/swapoff -a\n" \
1954" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001955" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001956"\n" \
1957"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1958"\n" \
1959" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001960" tty3::askfirst:/bin/sh\n" \
1961" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001962"\n" \
1963"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1964"\n" \
1965" <id>:<runlevels>:<action>:<process>\n" \
1966"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001967" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001968"\n" \
1969" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1970" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001971" the specified process to run on. The contents of this field are\n" \
1972" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1973" be unique, although if it isn't you may have strange results. If this\n" \
1974" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001975" note that if BusyBox detects that a serial console is in use, then only\n" \
1976" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001977" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001978" stinkin' utmp.\n" \
1979"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001980" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001981"\n" \
1982" The runlevels field is completely ignored.\n" \
1983"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001984" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001985"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001986" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001987" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001988"\n" \
1989" The available actions can be classified into two groups: actions\n" \
1990" that are run only once, and actions that are re-run when the specified\n" \
1991" process exits.\n" \
1992"\n" \
1993" Run only-once actions:\n" \
1994"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001995" 'sysinit' is the first item run on boot. init waits until all\n" \
1996" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001997" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001998" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001999" the specified task completes. 'once' actions are asynchronous,\n" \
2000" therefore, init does not wait for them to complete. 'restart' is\n" \
2001" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00002002" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002003" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002004" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002005" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002006" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002007" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002008" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002009" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002010"\n" \
2011" Run repeatedly actions:\n" \
2012"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002013" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002014" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002015" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
2016" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002017" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002018" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002019" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002020" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002021"\n" \
2022" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002023" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00002024" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002025"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00002026" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002027"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00002028" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002029"\n" \
2030"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00002031"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002032" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002033" #\n" \
2034" ::sysinit:/etc/init.d/rcS\n" \
2035" \n" \
2036" # /bin/sh invocations on selected ttys\n" \
2037" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002038" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002039" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00002040" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002041" tty2::askfirst:-/bin/sh\n" \
2042" tty3::askfirst:-/bin/sh\n" \
2043" tty4::askfirst:-/bin/sh\n" \
2044" \n" \
2045" # /sbin/getty invocations for selected ttys\n" \
2046" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00002047" tty4::respawn:/sbin/getty 38400 tty4\n" \
2048" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002049" \n" \
2050" \n" \
2051" # Example of how to put a getty on a serial line (for a terminal)\n" \
2052" #\n" \
2053" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
2054" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
2055" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002056" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002057" #::respawn:/sbin/getty 57600 ttyS2\n" \
2058" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00002059" # Stuff to do when restarting the init process\n" \
2060" ::restart:/sbin/init\n" \
2061" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002062" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00002063" ::ctrlaltdel:/sbin/reboot\n" \
2064" ::shutdown:/bin/umount -a -r\n" \
2065" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002066
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002067#define inotifyd_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002068 "PROG FILE1[:MASK]..."
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002069#define inotifyd_full_usage "\n\n" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002070 "Run PROG on filesystem changes." \
2071 "\nWhen a filesystem event matching MASK occurs on FILEn," \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002072 "\nPROG ACTUAL_EVENTS FILEn [SUBFILE] is run." \
Denis Vlasenko289ff0e2008-11-14 21:52:16 +00002073 "\nEvents:" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002074 "\n a File is accessed" \
2075 "\n c File is modified" \
2076 "\n e Metadata changed" \
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02002077 "\n w Writable file is closed" \
2078 "\n 0 Unwritable file is closed" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002079 "\n r File is opened" \
Denis Vlasenkoa09a42c2008-11-17 22:19:18 +00002080 "\n D File is deleted" \
2081 "\n M File is moved" \
2082 "\n u Backing fs is unmounted" \
2083 "\n o Event queue overflowed" \
2084 "\n x File can't be watched anymore" \
2085 "\nIf watching a directory:" \
2086 "\n m Subfile is moved into dir" \
2087 "\n y Subfile is moved out of dir" \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002088 "\n n Subfile is created" \
2089 "\n d Subfile is deleted" \
Denis Vlasenko9a4c0d52008-11-20 01:24:39 +00002090 "\n" \
2091 "\ninotifyd waits for PROG to exit." \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002092 "\nWhen x event happens for all FILEs, inotifyd exits." \
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00002093
Denis Vlasenko36309cf2008-11-22 18:29:01 +00002094/* 2.6 style insmod has no options and required filename
2095 * (not module name - .ko can't be omitted) */
Eric Andersen7e9276b2001-02-22 01:15:47 +00002096#define insmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002097 IF_FEATURE_2_4_MODULES("[OPTIONS] MODULE ") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002098 IF_NOT_FEATURE_2_4_MODULES("FILE ") \
Denis Vlasenko36309cf2008-11-22 18:29:01 +00002099 "[symbol=value]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002100#define insmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002101 "Load the specified kernel modules into the kernel" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002102 IF_FEATURE_2_4_MODULES( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002103 "\nOptions:" \
2104 "\n -f Force module to load into the wrong kernel version" \
2105 "\n -k Make module autoclean-able" \
2106 "\n -v Verbose" \
2107 "\n -q Quiet" \
2108 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002109 IF_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002110 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00002111 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002112 "\n -o NAME Set internal module name to NAME" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002113 "\n -x Don't export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00002114 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00002115
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002116/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00002117#define install_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002118 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [SOURCE]... DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002119#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002120 "Copy files and set attributes\n" \
2121 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002122 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002123 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00002124 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002125 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002126 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002127 "\n -o USER Set ownership" \
2128 "\n -g GRP Set group ownership" \
2129 "\n -m MODE Set permissions" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002130 IF_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00002131 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002132 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002133
Denis Vlasenko4acdb462009-01-31 21:45:57 +00002134#define ionice_trivial_usage \
2135 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
2136#define ionice_full_usage "\n\n" \
2137 "Change I/O scheduling class and priority\n" \
2138 "\nOptions:" \
2139 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
2140 "\n -n Priority" \
2141
Denis Vlasenko397de612008-03-17 08:55:44 +00002142/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002143#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00002144 "[OPTIONS] {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002145 IF_FEATURE_IP_ADDRESS("address | ") \
2146 IF_FEATURE_IP_ROUTE("route | ") \
2147 IF_FEATURE_IP_LINK("link | ") \
2148 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2149 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002150 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002151#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002152 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002153 "where OBJECT := {" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002154 IF_FEATURE_IP_ADDRESS("address | ") \
2155 IF_FEATURE_IP_ROUTE("route | ") \
2156 IF_FEATURE_IP_LINK("link | ") \
2157 IF_FEATURE_IP_TUNNEL("tunnel | ") \
2158 IF_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002159 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002160 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002161
2162#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002163 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002164 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002165#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002166 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002167 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
2168 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002169 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002170 " [broadcast ADDR] [anycast ADDR]\n" \
2171 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002172 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00002173
Eric Andersende4f07e2003-12-11 01:18:07 +00002174#define ipcalc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002175 "[OPTIONS] ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002176#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002177 "Calculate IP network settings from a IP address\n" \
2178 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002179 IF_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002180 "\n -b,--broadcast Display calculated broadcast address" \
2181 "\n -n,--network Display calculated network address" \
2182 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002183 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002184 "\n -p,--prefix Display the prefix for IP/NETMASK" \
2185 "\n -h,--hostname Display first resolved host name" \
2186 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002187 ) \
2188 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002189 IF_NOT_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002190 "\n -b Display calculated broadcast address" \
2191 "\n -n Display calculated network address" \
2192 "\n -m Display default netmask for IP" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002193 IF_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002194 "\n -p Display the prefix for IP/NETMASK" \
2195 "\n -h Display first resolved host name" \
2196 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00002197 ) \
2198 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00002199
Rob Landley6eb1e412005-06-20 04:30:36 +00002200#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002201 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002202#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002203 "Upper-case options MQS remove an object by shmkey value.\n" \
2204 "Lower-case options remove an object by shmid value.\n" \
2205 "\nOptions:" \
2206 "\n -mM Remove memory segment after last detach" \
2207 "\n -qQ Remove message queue" \
2208 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002209
2210#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002211 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002212#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002213 " -i Show specific resource" \
2214 "\nResource specification:" \
2215 "\n -m Shared memory segments" \
2216 "\n -q Message queues" \
2217 "\n -s Semaphore arrays" \
2218 "\n -a All (default)" \
2219 "\nOutput format:" \
2220 "\n -t Time" \
2221 "\n -c Creator" \
2222 "\n -p Pid" \
2223 "\n -l Limits" \
2224 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002225
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002226#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002227 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002228#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00002229 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002230 " dynamic { on | off } |\n" \
2231 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002232 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002233
2234#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002235 "{ list | flush | { add | del | change | append |\n" \
2236 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002237#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002238 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002239 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
2240 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002241 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002242 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00002243 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
2244 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002245
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002246#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002247 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002248#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002249 "iprule [list | add | del] SELECTOR ACTION\n" \
2250 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2251 " [dev STRING] [pref NUMBER]\n" \
2252 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2253 " [prohibit | reject | unreachable]\n" \
2254 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002255 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002256
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002257#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002258 "{ add | change | del | show } [NAME]\n" \
2259 " [mode { ipip | gre | sit }]\n" \
2260 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002261#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002262 "iptunnel { add | change | del | show } [NAME]\n" \
2263 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2264 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002265 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002266
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002267#define kbd_mode_trivial_usage \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002268 "[-a|k|s|u] [-C TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002269#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002270 "Report or set the keyboard mode\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002271 "\nOptions:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002272 "\n -a Default (ASCII)" \
2273 "\n -k Medium-raw (keyboard)" \
2274 "\n -s Raw (scancode)" \
2275 "\n -u Unicode (utf-8)" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002276 "\n -C TTY Affect TTY instead of /dev/tty" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002277
Eric Andersen7e9276b2001-02-22 01:15:47 +00002278#define kill_trivial_usage \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002279 "[-l] [-SIG] PID..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002280#define kill_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002281 "Send a signal (default: TERM) to given PIDs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002282 "\nOptions:" \
2283 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002284/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00002285
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002286#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002287 "$ ps | grep apache\n" \
2288 "252 root root S [apache]\n" \
2289 "263 www-data www-data S [apache]\n" \
2290 "264 www-data www-data S [apache]\n" \
2291 "265 www-data www-data S [apache]\n" \
2292 "266 www-data www-data S [apache]\n" \
2293 "267 www-data www-data S [apache]\n" \
2294 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002295
2296#define killall_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002297 "[-l] [-q] [-SIG] PROCESS_NAME..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002298#define killall_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002299 "Send a signal (default: TERM) to given processes\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002300 "\nOptions:" \
2301 "\n -l List all signal names and numbers" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002302/* "\n -s SIG Yet another way of specifying SIG" */ \
Denys Vlasenko07697852009-10-06 21:11:37 +02002303 "\n -q Don't complain if no processes were killed" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002304
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002305#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002306 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002307
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002308#define killall5_trivial_usage \
Denis Vlasenkoa0ab9432009-02-07 22:30:39 +00002309 "[-l] [-SIG] [-o PID]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002310#define killall5_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002311 "Send a signal (default: TERM) to all processes outside current session\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002312 "\nOptions:" \
2313 "\n -l List all signal names and numbers" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002314 "\n -o PID Don't signal this PID" \
Denis Vlasenkob9b344a2008-10-31 00:30:48 +00002315/* "\n -s SIG Yet another way of specifying SIG" */ \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002316
Mark Whitley6317c4b2001-03-12 22:51:50 +00002317#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002318 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002319#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002320 "Kernel logger\n" \
2321 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002322 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002323 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002324
Eric Andersen7e9276b2001-02-22 01:15:47 +00002325#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002326 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002327#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002328 "Print STRING's length"
2329
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002330#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002331 "$ length Hello\n" \
2332 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002333
Rob Landley9200e792005-09-15 19:26:59 +00002334#define less_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002335 "[-EMNmh~I?] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002336#define less_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002337 "View FILE (or stdin) one screenful at a time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002338 "\nOptions:" \
2339 "\n -E Quit once the end of a file is reached" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002340 "\n -M,-m Display status line with line numbers" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002341 "\n and percentage through the file" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002342 "\n -N Prefix line number to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002343 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002344 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002345
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002346#define linux32_trivial_usage NOUSAGE_STR
2347#define linux32_full_usage ""
2348#define linux64_trivial_usage NOUSAGE_STR
2349#define linux64_full_usage ""
2350
2351#define linuxrc_trivial_usage NOUSAGE_STR
2352#define linuxrc_full_usage ""
2353
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002354#define setarch_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002355 "personality PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002356#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002357 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002358 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002359 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002360
Eric Andersen7e9276b2001-02-22 01:15:47 +00002361#define ln_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002362 "[OPTIONS] TARGET... LINK|DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002363#define ln_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002364 "Create a link LINK or DIR/TARGET to the specified TARGET(s)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002365 "\nOptions:" \
2366 "\n -s Make symlinks instead of hardlinks" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002367 "\n -f Remove existing destinations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002368 "\n -n Don't dereference symlinks - treat like normal file" \
2369 "\n -b Make a backup of the target (if exists) before link operation" \
2370 "\n -S suf Use suffix instead of ~ when making backup files" \
2371
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002372#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002373 "$ ln -s BusyBox /tmp/ls\n" \
2374 "$ ls -l /tmp/ls\n" \
2375 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002376
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002377#define load_policy_trivial_usage NOUSAGE_STR
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002378#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002379
Eric Andersen7e9276b2001-02-22 01:15:47 +00002380#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002381 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002382#define loadfont_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002383 "Load a console font from stdin" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002384/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2385
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002386#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002387 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002388
2389#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002390 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002391#define loadkmap_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002392 "Load a binary keyboard translation table from stdin\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00002393/* "\n -C TTY Affect TTY instead of /dev/tty" */ \
2394
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002395#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002396 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002397
2398#define logger_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002399 "[OPTIONS] [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002400#define logger_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01002401 "Write MESSAGE (or stdin) to syslog\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002402 "\nOptions:" \
2403 "\n -s Log to stderr as well as the system log" \
2404 "\n -t TAG Log using the specified tag (defaults to user name)" \
2405 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002406
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002407#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002408 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002409
Robert Griebl1fca5582002-06-04 20:45:46 +00002410#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002411 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002412#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002413 "Begin a new session on the system\n" \
2414 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002415 "\n -f Don't authenticate (user already authenticated)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002416 "\n -h Name of the remote host" \
2417 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002418
Eric Andersen7e9276b2001-02-22 01:15:47 +00002419#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002420 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002421#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002422 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002423#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002424 "$ logname\n" \
2425 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002426
Mark Whitley6317c4b2001-03-12 22:51:50 +00002427#define logread_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002428 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002429#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002430 "Show messages in syslogd's circular buffer\n" \
2431 "\nOptions:" \
2432 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002433
Matt Kraai83788da2002-03-20 17:38:37 +00002434#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002435 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2436 " losetup -d LOOPDEV - disassociate\n" \
2437 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002438#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002439 "Options:" \
2440 "\n -o OFS Start OFS bytes into FILE" \
2441 "\n -f Show first free loop device" \
2442
Rob Landley1d589b22005-11-29 23:47:10 +00002443#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002444 "No arguments will display all current associations.\n" \
2445 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002446 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002447 "and filename of the file the loop device is currently bound to.\n\n" \
2448 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002449 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2450 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002451
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002452#define lpd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002453 "SPOOLDIR [HELPER [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002454#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002455 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2456 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002457 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002458 "\ndirectory and HELPER program is called. Name of file to print" \
2459 "\nis passed in $DATAFILE variable." \
2460 "\nExample:" \
2461 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002462
Denis Vlasenko68444b92008-02-22 22:24:48 +00002463#define lpq_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002464 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID]... [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002465#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002466 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002467 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002468 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002469 "\n -f Force any waiting job to be printed" \
2470 "\n -s Short display" \
2471
2472#define lpr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002473 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE]..."
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002474/* -C CLASS exists too, not shown.
2475 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002476#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002477 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002478 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002479 "\n -m Send mail on completion" \
2480 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002481 "\n -V Verbose" \
2482
Eric Andersen7e9276b2001-02-22 01:15:47 +00002483#define ls_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002484 "[-1Aa" IF_FEATURE_LS_TIMESTAMPS("c") "Cd" \
2485 IF_FEATURE_LS_TIMESTAMPS("e") IF_FEATURE_LS_FILETYPES("F") "iln" \
2486 IF_FEATURE_LS_FILETYPES("p") IF_FEATURE_LS_FOLLOWLINKS("L") \
2487 IF_FEATURE_LS_RECURSIVE("R") IF_FEATURE_LS_SORTFILES("rS") "s" \
2488 IF_FEATURE_AUTOWIDTH("T") IF_FEATURE_LS_TIMESTAMPS("tu") \
2489 IF_FEATURE_LS_SORTFILES("v") IF_FEATURE_AUTOWIDTH("w") "x" \
2490 IF_FEATURE_LS_SORTFILES("X") IF_FEATURE_HUMAN_READABLE("h") "k" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002491 IF_SELINUX("K") "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002492#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002493 "List directory contents\n" \
2494 "\nOptions:" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002495 "\n -1 List in a single column" \
2496 "\n -A Don't list . and .." \
2497 "\n -a Don't hide entries starting with ." \
2498 "\n -C List by columns" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002499 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002500 "\n -c With -l: sort by ctime") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002501 IF_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002502 "\n --color[={always,never,auto}] Control coloring") \
2503 "\n -d List directory entries instead of contents" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002504 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002505 "\n -e List full date and time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002506 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002507 "\n -F Append indicator (one of */=@|) to entries") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002508 "\n -i List inode numbers" \
2509 "\n -l Long listing format" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002510 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002511 IF_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002512 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002513 IF_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002514 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002515 IF_FEATURE_LS_RECURSIVE( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002516 "\n -R Recurse") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002517 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002518 "\n -r Sort in reverse order") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002519 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002520 "\n -S Sort by file size") \
Denis Vlasenko397de612008-03-17 08:55:44 +00002521 "\n -s List the size of each file, in blocks" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002522 IF_FEATURE_AUTOWIDTH( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002523 "\n -T N Assume tabstop every N columns") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002524 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002525 "\n -t With -l: sort by modification time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002526 IF_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002527 "\n -u With -l: sort by access time") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002528 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002529 "\n -v Sort by version") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002530 IF_FEATURE_AUTOWIDTH( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002531 "\n -w N Assume the terminal is N columns wide") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002532 "\n -x List by lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002533 IF_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002534 "\n -X Sort by extension") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002535 IF_FEATURE_HUMAN_READABLE( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002536 "\n -h List sizes in human readable format (1K 243M 2G)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002537 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002538 "\n -k List security context") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002539 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002540 "\n -K List security context in long format") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002541 IF_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002542 "\n -Z List security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002543
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002544#define lsattr_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002545 "[-Radlv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002546#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002547 "List file attributes on an ext2 fs\n" \
2548 "\nOptions:" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01002549 "\n -R Recurse" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002550 "\n -a Don't hide entries starting with ." \
Denis Vlasenko397de612008-03-17 08:55:44 +00002551 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002552 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002553 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002554
Eric Andersen7e9276b2001-02-22 01:15:47 +00002555#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002556 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002557#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002558 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002559
Souf Oued982bc712009-12-05 17:56:25 +01002560#define lspci_trivial_usage \
2561 "[-mk]"
2562#define lspci_full_usage "\n\n" \
2563 "List all PCI devices" \
2564 "\n" \
2565 "\n -m Parseable output" \
2566 "\n -k Show driver" \
2567
Souf Oued11a802a2009-12-07 01:37:34 +01002568#define lsusb_trivial_usage NOUSAGE_STR
2569#define lsusb_full_usage ""
2570
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002571#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002572#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002573 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002574#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002575 "Create a range of block or character special files" \
2576 "\n" \
2577 "\nTYPE is:" \
2578 "\n b Block device" \
2579 "\n c Character device" \
2580 "\n f FIFO, MAJOR and MINOR are ignored" \
2581 "\n" \
2582 "\nFIRST..LAST specify numbers appended to NAME." \
2583 "\nIf 's' is the last argument, the base device is created as well." \
2584 "\n" \
2585 "\nExamples:" \
2586 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2587 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002588#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002589 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2590 "[creates ttyS2-ttyS63]\n" \
2591 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2592 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002593#endif
2594
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002595#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002596#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002597 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002598#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002599 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002600 "Device table entries take the form of:\n" \
2601 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002602 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002603 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002604 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002605 " c Character device\n" \
2606 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002607 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002608 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002609 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2610 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002611#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002612 "For example:\n" \
2613 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2614 "/dev d 755 0 0 - - - - -\n" \
2615 "/dev/console c 666 0 0 5 1 - - -\n" \
2616 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2617 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2618 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2619 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2620 "Will Produce:\n" \
2621 "/dev\n" \
2622 "/dev/console\n" \
2623 "/dev/null\n" \
2624 "/dev/zero\n" \
2625 "/dev/hda\n" \
2626 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002627#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002628
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002629#define makemime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002630 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002631#define makemime_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002632 "Create multipart MIME-encoded message from FILEs\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002633/* "Transfer encoding is base64, disposition is inline (not attachment)\n" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002634 "\nOptions:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002635 "\n -o FILE Output. Default: stdout" \
2636 "\n -a HDR Add header. Examples:" \
2637 "\n \"From: user@host.org\", \"Date: `date -R`\"" \
2638 "\n -c CT Content type. Default: text/plain" \
2639 "\n -C CS Charset. Default: " CONFIG_FEATURE_MIME_CHARSET \
2640/* "\n -e ENC Transfer encoding. Ignored. base64 is assumed" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002641 "\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02002642 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00002643
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002644#define man_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002645 "[OPTIONS] [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002646#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002647 "Format and display manual page\n" \
2648 "\nOptions:" \
2649 "\n -a Display all pages" \
2650 "\n -w Show page locations" \
2651
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002652#define matchpathcon_trivial_usage \
2653 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002654#define matchpathcon_full_usage "\n\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02002655 " -n Don't display path" \
2656 "\n -N Don't use translations" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002657 "\n -f Use alternate file_context file" \
2658 "\n -p Use prefix to speed translations" \
2659 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002660
Eric Andersen7e9276b2001-02-22 01:15:47 +00002661#define md5sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002662 "[OPTIONS] [FILE]..." \
2663 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTIONS] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002664#define md5sum_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002665 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2666 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002667 "\nOptions:" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002668 "\n -c Check sums against given list" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002669 "\n -s Don't output anything, status code shows success" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002670 "\n -w Warn about improperly formatted checksum lines" \
2671 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002672
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002673#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002674 "$ md5sum < busybox\n" \
2675 "6fd11e98b98a58f64ff3398d7b324003\n" \
2676 "$ md5sum busybox\n" \
2677 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2678 "$ md5sum -c -\n" \
2679 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2680 "busybox: OK\n" \
2681 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002682
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002683#define sha1sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002684 "[OPTIONS] [FILE]..." \
2685 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002686#define sha1sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002687 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002688 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002689 "\nOptions:" \
2690 "\n -c Check sums against given list" \
2691 "\n -s Don't output anything, status code shows success" \
2692 "\n -w Warn about improperly formatted checksum lines" \
2693 )
2694
2695#define sha256sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002696 "[OPTIONS] [FILE]..." \
2697 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha256sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002698#define sha256sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002699 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA256 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002700 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002701 "\nOptions:" \
2702 "\n -c Check sums against given list" \
2703 "\n -s Don't output anything, status code shows success" \
2704 "\n -w Warn about improperly formatted checksum lines" \
2705 )
2706
2707#define sha512sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002708 "[OPTIONS] [FILE]..." \
2709 IF_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha512sum [OPTIONS] -c [FILE]")
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002710#define sha512sum_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002711 "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA512 checksums" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002712 IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
Denis Vlasenko56dceb92008-11-10 13:32:50 +00002713 "\nOptions:" \
2714 "\n -c Check sums against given list" \
2715 "\n -s Don't output anything, status code shows success" \
2716 "\n -w Warn about improperly formatted checksum lines" \
2717 )
2718
Rob Landley70f7ef72005-12-13 08:21:33 +00002719#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002720 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002721#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002722 " -s Scan /sys and populate /dev during system boot\n" \
2723 "\n" \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002724 "It can be run by kernel as a hotplug helper. To activate it:\n" \
Denys Vlasenkof92874e2009-12-05 15:59:05 +01002725 " echo /sbin/mdev > /proc/sys/kernel/hotplug\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002726 IF_FEATURE_MDEV_CONF( \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002727 "It uses /etc/mdev.conf with lines\n" \
Denis Vlasenkof2b39e02009-04-13 23:18:52 +00002728 "[-]DEVNAME UID:GID PERM" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002729 IF_FEATURE_MDEV_RENAME(" [>|=PATH]") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002730 IF_FEATURE_MDEV_EXEC(" [@|$|*PROG]") \
Denis Vlasenkoaafbae62009-04-13 13:33:02 +00002731 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002732
Rob Landleyef10d522006-06-26 14:11:33 +00002733#define mdev_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002734 IF_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002735 "The mdev config file contains lines that look like:\n" \
2736 " hd[a-z][0-9]* 0:3 660\n\n" \
2737 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002738 IF_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002739 "Optionally, that can be followed (on the same line) by a special character\n" \
2740 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002741 "device(s). The environment variable $MDEV indicates the active device node\n" \
2742 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002743 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2744 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002745 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002746 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002747 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002748 "Config file parsing stops on the first matching line. If no config\n" \
2749 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002750 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002751 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002752
Glenn L McGrath061c9002002-09-16 04:21:46 +00002753#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002754 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002755#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002756 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002757 " y Allow write access to your terminal\n" \
2758 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002759
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002760#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002761 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002762#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002763 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2764 "\nOptions:" \
2765 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2766 "\n next byte to it" \
2767 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2768 "\n -s Set serial line to SPEED" \
2769 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002770
Eric Andersen7e9276b2001-02-22 01:15:47 +00002771#define mkdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02002772 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002773#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002774 "Create DIRECTORY\n" \
2775 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02002776 "\n -m Mode" \
2777 "\n -p No error if exists; make parent directories as needed" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002778 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002779 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002780 )
2781
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002782#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002783 "$ mkdir /tmp/foo\n" \
2784 "$ mkdir /tmp/foo\n" \
2785 "/tmp/foo: File exists\n" \
2786 "$ mkdir /tmp/foo/bar/baz\n" \
2787 "/tmp/foo/bar/baz: No such file or directory\n" \
2788 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002789
Eric Andersen7e9276b2001-02-22 01:15:47 +00002790#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002791 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002792#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002793 "Create named pipe (identical to 'mknod name p')\n" \
2794 "\nOptions:" \
2795 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002796 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002797 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002798 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002799
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002800#define mkfs_ext2_trivial_usage \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002801 "[-Fn] " \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002802 /* "[-c|-l filename] " */ \
2803 "[-b BLK_SIZE] " \
2804 /* "[-f fragment-size] [-g blocks-per-group] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002805 "[-i INODE_RATIO] [-I INODE_SIZE] " \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002806 /* "[-j] [-J journal-options] [-N number-of-inodes] " */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002807 "[-m RESERVED_PERCENT] " \
2808 /* "[-o creator-os] [-O feature[,...]] [-q] " */ \
2809 /* "[r fs-revision-level] [-E extended-options] [-v] [-F] " */ \
2810 "[-L LABEL] " \
2811 /* "[-M last-mounted-directory] [-S] [-T filesystem-type] " */ \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002812 "BLOCKDEV [KBYTES]"
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002813#define mkfs_ext2_full_usage "\n\n" \
2814 " -b BLK_SIZE Block size, bytes" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002815/* "\n -c Check device for bad blocks" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002816/* "\n -E opts Set extended options" */ \
2817/* "\n -f size Fragment size in bytes" */ \
Denys Vlasenkoc1ab01b2009-10-22 12:24:48 +02002818 "\n -F Force" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002819/* "\n -g N Number of blocks in a block group" */ \
Denys Vlasenko838e07a2009-10-22 12:15:33 +02002820 "\n -i RATIO Max number of files is filesystem_size / RATIO" \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002821 "\n -I BYTES Inode size (min 128)" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002822/* "\n -j Create a journal (ext3)" */ \
2823/* "\n -J opts Set journal options (size/device)" */ \
2824/* "\n -l file Read bad blocks list from file" */ \
Denys Vlasenko6a8cfdc2009-10-17 23:41:15 +02002825 "\n -L LBL Volume label" \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002826 "\n -m PERCENT Percent of blocks to reserve for admin" \
2827/* "\n -M dir Set last mounted directory" */ \
Denys Vlasenko77da1ca2009-10-18 16:29:30 +02002828 "\n -n Dry run" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01002829/* "\n -N N Number of inodes to create" */ \
Vladimir Dronnikov823b4e62009-10-17 21:38:19 +02002830/* "\n -o os Set the 'creator os' field" */ \
2831/* "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" */ \
2832/* "\n -q Quiet" */ \
2833/* "\n -r rev Set filesystem revision" */ \
2834/* "\n -S Write superblock and group descriptors only" */ \
2835/* "\n -T fs-type Set usage type (news/largefile/largefile4)" */ \
2836/* "\n -v Verbose" */ \
2837
Eric Andersen7e9276b2001-02-22 01:15:47 +00002838#define mkfs_minix_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002839 "[-c | -l FILE] [-nXX] [-iXX] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002840#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002841 "Make a MINIX filesystem\n" \
2842 "\nOptions:" \
2843 "\n -c Check device for bad blocks" \
2844 "\n -n [14|30] Maximum length of filenames" \
2845 "\n -i INODES Number of inodes for the filesystem" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002846 "\n -l FILE Read bad blocks list from FILE" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002847 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002848
Vladimir Dronnikov0d8ea642009-11-02 10:41:46 +01002849#define mkfs_reiser_trivial_usage \
2850 "[-f] [-l LABEL] BLOCKDEV [4K-BLOCKS]"
2851
2852#define mkfs_reiser_full_usage "\n\n" \
2853 "Make a ReiserFS V3 filesystem\n" \
2854 "\nOptions:" \
2855 "\n -f Force" \
2856 "\n -l LBL Volume label" \
2857
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002858#define mkfs_vfat_trivial_usage \
Denys Vlasenko149a32a2009-10-22 12:12:17 +02002859 "[-v] [-n LABEL] BLOCKDEV [KBYTES]"
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +00002860/* Accepted but ignored:
2861 "[-c] [-C] [-I] [-l bad-block-file] [-b backup-boot-sector] "
2862 "[-m boot-msg-file] [-i volume-id] "
2863 "[-s sectors-per-cluster] [-S logical-sector-size] [-f number-of-FATs] "
2864 "[-h hidden-sectors] [-F fat-size] [-r root-dir-entries] [-R reserved-sectors] "
2865*/
2866#define mkfs_vfat_full_usage "\n\n" \
2867 "Make a FAT32 filesystem\n" \
2868 "\nOptions:" \
2869/* "\n -c Check device for bad blocks" */ \
2870 "\n -v Verbose" \
2871/* "\n -I Allow to use entire disk device (e.g. /dev/hda)" */ \
2872 "\n -n LBL Volume label" \
2873
Eric Andersen7e9276b2001-02-22 01:15:47 +00002874#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002875 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002876#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002877 "Create a special file (block, character, or pipe)\n" \
2878 "\nOptions:" \
2879 "\n -m Create the special file using the specified mode (default a=rw)" \
2880 "\nTYPEs include:" \
2881 "\n b: Make a block device" \
2882 "\n c or u: Make a character device" \
2883 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002884 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002885 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002886 )
2887
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002888#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002889 "$ mknod /dev/fd0 b 2 0\n" \
2890 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002891
Eric Andersen7e9276b2001-02-22 01:15:47 +00002892#define mkswap_trivial_usage \
Denys Vlasenko40e7d252010-02-01 23:48:27 +01002893 "[OPTIONS] BLOCKDEV [KBYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002894#define mkswap_full_usage "\n\n" \
Denys Vlasenko68c67462009-11-03 05:51:20 +01002895 "Prepare BLOCKDEV to be used as swap partition\n" \
2896 "\nOptions:" \
2897 "\n -L LBL Label" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002898
Eric Andersen7e9276b2001-02-22 01:15:47 +00002899#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002900 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002901#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002902 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002903 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002904 "\nOptions:" \
2905 "\n -d Make a directory instead of a file" \
2906/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2907 "\n -t Generate a path rooted in temporary directory" \
2908 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2909 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002910 "\nFor -t or -p, directory is chosen as follows:" \
2911 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002912
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002913#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002914 "$ mktemp /tmp/temp.XXXXXX\n" \
2915 "/tmp/temp.mWiLjM\n" \
2916 "$ ls -la /tmp/temp.mWiLjM\n" \
2917 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002918
Eric Andersen8d79ce82001-07-22 23:00:15 +00002919#define modprobe_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002920 IF_MODPROBE_SMALL("[-qfwrsv] MODULE [symbol=value]...") \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002921 IF_NOT_MODPROBE_SMALL("[-" \
2922 IF_FEATURE_2_4_MODULES("k")"nqrsv" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01002923 IF_FEATURE_MODPROBE_BLACKLIST("b")"] MODULE [symbol=value]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002924#define modprobe_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002925 "Options:" \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002926 IF_MODPROBE_SMALL( \
2927 "\n -q Quiet" \
2928 "\n -f Force" \
2929 "\n -w Wait for unload" \
2930 "\n -r Remove module (stacks) or do autoclean" \
2931 "\n -s Report via syslog instead of stderr" \
2932 "\n -v Verbose" \
2933 ) \
2934 IF_NOT_MODPROBE_SMALL( \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002935 IF_FEATURE_2_4_MODULES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002936 "\n -k Make module autoclean-able" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002937 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002938 "\n -n Dry run" \
2939 "\n -q Quiet" \
2940 "\n -r Remove module (stacks) or do autoclean" \
2941 "\n -s Report via syslog instead of stderr" \
2942 "\n -v Verbose" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002943 IF_FEATURE_MODPROBE_BLACKLIST( \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002944 "\n -b Apply blacklist to module names too" \
Denys Vlasenko0c6914e2009-09-07 02:38:26 +02002945 ) \
2946 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002947
Rob Landley9c32a152005-12-11 20:12:24 +00002948#define modprobe_notes_usage \
2949"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2950"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2951"pass each module it loads.\n" \
2952"\n" \
Bernhard Reutner-Fischer12aca792009-02-24 10:03:22 +00002953"The configuration file is searched (in this order):\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002954"\n" \
2955" /etc/modprobe.conf (2.6 only)\n" \
2956" /etc/modules.conf\n" \
2957" /etc/conf.modules (deprecated)\n" \
2958"\n" \
2959"They all have the same syntax (see below). If none is present, it is\n" \
2960"_not_ an error; each loaded module is then expected to load without\n" \
2961"options. Once a file is found, the others are tested for.\n" \
2962"\n" \
2963"/etc/modules.conf entry format:\n" \
2964"\n" \
2965" alias <alias_name> <mod_name>\n" \
2966" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002967" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002968" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2969" This makes it also possible to use a different set of options (below) for\n" \
2970" the module and the alias.\n" \
2971" A module can be aliased more than once.\n" \
2972"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002973" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002974" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2975" the \"symbol=value\" pairs as option to that module.\n" \
2976"\n" \
2977"Sample /etc/modules.conf file:\n" \
2978"\n" \
2979" options tulip irq=3\n" \
2980" alias tulip tulip2\n" \
2981" options tulip2 irq=4 io=0x308\n" \
2982"\n" \
2983"Other functionality offered by 'classic' modprobe is not available in\n" \
2984"this implementation.\n" \
2985"\n" \
2986"If module options are present both in the config file, and on the command line,\n" \
2987"then the options from the command line will be passed to the module _after_\n" \
2988"the options from the config file. That way, you can have defaults in the config\n" \
2989"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002990#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002991 "(with the above /etc/modules.conf):\n\n" \
2992 "$ modprobe tulip\n" \
2993 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2994 "$ modprobe tulip irq=5\n" \
2995 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2996 "$ modprobe tulip2\n" \
2997 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2998 " which are the default for alias 'tulip2'\n\n" \
2999 "$ modprobe tulip2 irq=8\n" \
3000 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
3001 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
3002 " from the command line\n\n" \
3003 "$ modprobe tulip2 irq=2 io=0x210\n" \
3004 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
3005 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
3006 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00003007
Eric Andersen7e9276b2001-02-22 01:15:47 +00003008#define more_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003009 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003010#define more_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003011 "View FILE (or stdin) one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00003012
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003013#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003014 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003015
Eric Andersen7e9276b2001-02-22 01:15:47 +00003016#define mount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003017 "[OPTIONS] [-o OPTS] DEVICE NODE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003018#define mount_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003019 "Mount a filesystem. Filesystem autodetection requires /proc.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003020 "\nOptions:" \
3021 "\n -a Mount all filesystems in fstab" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003022 IF_FEATURE_MOUNT_FAKE( \
3023 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003024 "\n -f Update /etc/mtab, but don't mount" \
3025 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003026 IF_NOT_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003027 "\n -f Dry run" \
3028 ) \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00003029 ) \
Denys Vlasenkoe2e4cc22009-06-19 11:48:29 +02003030 IF_FEATURE_MOUNT_HELPERS( \
3031 "\n -i Don't run mount helper" \
3032 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003033 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003034 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003035 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003036 "\n -r Read-only mount" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003037 "\n -w Read-write mount (default)" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003038 "\n -t FSTYPE Filesystem type" \
3039 "\n -O OPT Mount only filesystems with option OPT (-a only)" \
3040 "\n-o OPT:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003041 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003042 "\n loop Ignored (loop devices are autodetected)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003043 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003044 IF_FEATURE_MOUNT_FLAGS( \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003045 "\n [a]sync Writes are [a]synchronous" \
3046 "\n [no]atime Disable/enable updates to inode access times" \
3047 "\n [no]diratime Disable/enable atime updates to directories" \
3048 "\n [no]relatime Disable/enable atime updates relative to modification time" \
3049 "\n [no]dev (Dis)allow use of special device files" \
3050 "\n [no]exec (Dis)allow use of executable files" \
3051 "\n [no]suid (Dis)allow set-user-id-root programs" \
3052 "\n [r]shared Convert [recursively] to a shared subtree" \
3053 "\n [r]slave Convert [recursively] to a slave subtree" \
3054 "\n [r]private Convert [recursively] to a private subtree" \
3055 "\n [un]bindable Make mount point [un]able to be bind mounted" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003056 "\n bind Bind a file or directory to another location" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003057 "\n move Relocate an existing mount point" \
Rob Landleye55a73c2006-08-09 20:55:35 +00003058 ) \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003059 "\n remount Remount a mounted filesystem, changing flags" \
3060 "\n ro/rw Same as -r/-w" \
Denis Vlasenko7aaedcf2009-03-14 22:57:20 +00003061 "\n" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003062 "\nThere are filesystem-specific -o flags." \
Denis Vlasenko397de612008-03-17 08:55:44 +00003063
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003064#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003065 "$ mount\n" \
3066 "/dev/hda3 on / type minix (rw)\n" \
3067 "proc on /proc type proc (rw)\n" \
3068 "devpts on /dev/pts type devpts (rw)\n" \
3069 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
3070 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
3071 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00003072#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003073 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003074
Rob Landleyd00b3a52005-08-20 05:07:08 +00003075#define mountpoint_trivial_usage \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003076 "[-q] <[-dn] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003077#define mountpoint_full_usage "\n\n" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003078 "Check if the directory is a mountpoint\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003079 "\nOptions:" \
3080 "\n -q Quiet" \
3081 "\n -d Print major/minor device number of the filesystem" \
Denis Vlasenko7a1ddf22008-11-29 12:54:16 +00003082 "\n -n Print device name of the filesystem" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003083 "\n -x Print major/minor device number of the blockdevice" \
3084
Rob Landleyd00b3a52005-08-20 05:07:08 +00003085#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003086 "$ mountpoint /proc\n" \
3087 "/proc is not a mountpoint\n" \
3088 "$ mountpoint /sys\n" \
3089 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00003090
Eric Andersen7e9276b2001-02-22 01:15:47 +00003091#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003092 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003093#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003094 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003095 "\n" \
3096 "Available Opcodes:\n" \
3097 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003098 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
3099 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
3100 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003101 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003102
Eric Andersen7e9276b2001-02-22 01:15:47 +00003103#define mv_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003104 "[OPTIONS] SOURCE DEST\n" \
3105 "or: mv [OPTIONS] SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003106#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003107 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
3108 "\nOptions:" \
3109 "\n -f Don't prompt before overwriting" \
3110 "\n -i Interactive, prompt before overwrite" \
3111
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003112#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003113 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003114
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003115#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003116 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003117#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003118 "Rename network interface while it in the down state\n" \
3119 "\nOptions:" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003120 "\n -c FILE Use configuration file (default: /etc/mactab)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003121 "\n -s Use syslog (LOCAL0 facility)" \
3122 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
3123
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003124#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003125 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
3126 " or\n" \
3127 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00003128
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003129#if !ENABLE_DESKTOP
3130
Rob Landley1cca9482006-07-10 19:45:20 +00003131#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003132#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003133#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003134#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003135#endif
Rob Landley1cca9482006-07-10 19:45:20 +00003136
Eric Andersen7e9276b2001-02-22 01:15:47 +00003137#define nc_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003138 IF_NC_EXTRA("[-iN] [-wN] ")IF_NC_SERVER("[-l] [-p PORT] ") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003139 "["IF_NC_EXTRA("-f FILENAME|")"IPADDR PORT]"IF_NC_EXTRA(" [-e PROG]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003140#define nc_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003141 "Open a pipe to IP:port" IF_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00003142 NC_OPTIONS_STR \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003143 IF_NC_EXTRA( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003144 "\n -e PROG Run PROG after connect" \
3145 "\n -i SEC Delay interval for lines sent" \
3146 "\n -w SEC Timeout for connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003147 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00003148 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003149 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003150 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003151 IF_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003152 "\n (use -l twice with -e for persistent server)") \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003153 "\n -p PORT Local port" \
Rob Landley1cca9482006-07-10 19:45:20 +00003154 )
3155
Rob Landley1cca9482006-07-10 19:45:20 +00003156#define nc_notes_usage "" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003157 IF_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003158 "To use netcat as a terminal emulator on a serial port:\n\n" \
3159 "$ stty 115200 -F /dev/ttyS0\n" \
3160 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
3161 )
Rob Landley1cca9482006-07-10 19:45:20 +00003162
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003163#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003164 "$ nc foobar.somedomain.com 25\n" \
3165 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
3166 "help\n" \
3167 "214-Commands supported:\n" \
3168 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
3169 "214 NOOP QUIT RSET HELP\n" \
3170 "quit\n" \
3171 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003172
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003173#else /* DESKTOP nc - much more compatible with nc 1.10 */
3174
3175#define nc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003176 "[OPTIONS] HOST PORT - connect" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003177 IF_NC_SERVER("\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003178 "nc [OPTIONS] -l -p PORT [HOST] [PORT] - listen")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003179#define nc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003180 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003181 "\n -e PROG Run PROG after connect (must be last)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003182 IF_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003183 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003184 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003185 "\n -n Don't do DNS resolution" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003186 "\n -s ADDR Local address" \
3187 "\n -p PORT Local port" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003188 "\n -u UDP mode" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003189 "\n -v Verbose" \
3190 "\n -w SEC Timeout for connects and final net reads" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003191 IF_NC_EXTRA( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003192 "\n -i SEC Delay interval for lines sent" /* ", ports scanned" */ \
3193 "\n -o FILE Hex dump traffic" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003194 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003195 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003196/* "\n -r Randomize local and remote ports" */
3197/* "\n -g gateway Source-routing hop point[s], up to 8" */
3198/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003199/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
3200
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003201/* -e PROG can take ARGS too: "nc ... -e ls -l", but we don't document it
3202 * in help text: nc 1.10 does not allow that. We don't want to entice
3203 * users to use this incompatibility */
3204
Denis Vlasenko29fe7262007-04-05 20:26:28 +00003205#endif
3206
Eric Andersen1552ff72001-10-31 11:07:12 +00003207#define netstat_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003208 "[-laentuwxr"IF_FEATURE_NETSTAT_WIDE("W")IF_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003209#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003210 "Display networking information\n" \
3211 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003212 "\n -l Display listening server sockets" \
3213 "\n -a Display all sockets (default: connected)" \
3214 "\n -e Display other/more information" \
3215 "\n -n Don't resolve names" \
3216 "\n -t Tcp sockets" \
3217 "\n -u Udp sockets" \
3218 "\n -w Raw sockets" \
3219 "\n -x Unix sockets" \
3220 "\n -r Display routing table" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003221 IF_FEATURE_NETSTAT_WIDE( \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003222 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003223 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003224 IF_FEATURE_NETSTAT_PRG( \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00003225 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00003226 )
Eric Andersen1552ff72001-10-31 11:07:12 +00003227
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003228#define nice_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003229 "[-n ADJUST] [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003230#define nice_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003231 "Run PROG with modified scheduling priority\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003232 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003233 "\n -n ADJUST Adjust priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00003234
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003235#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003236 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003237#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003238 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003239 "Format specifiers:\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003240 " %Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003241 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02003242 " %[niface] Monitor network interface 'iface'\n" \
3243 " %m Monitor allocated memory\n" \
3244 " %[mf] Monitor free memory\n" \
3245 " %[mt] Monitor total memory\n" \
3246 " %s Monitor allocated swap\n" \
3247 " %f Monitor number of used file descriptors\n" \
3248 " %Ni Monitor total/specific IRQ rate\n" \
3249 " %x Monitor context switch rate\n" \
3250 " %p Monitor forks\n" \
3251 " %[pn] Monitor # of processes\n" \
3252 " %b Monitor block io\n" \
3253 " %Nt Show time (with N decimal points)\n" \
3254 " %Nd Milliseconds between updates (default:1000)\n" \
3255 " %r Print <cr> instead of <lf> at EOL" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003256
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003257#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003258 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00003259
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003260#define nohup_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003261 "PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003262#define nohup_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003263 "Run PROG immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003264#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003265 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00003266
Eric Andersen7e9276b2001-02-22 01:15:47 +00003267#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003268 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003269#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003270 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003271 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003272#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003273 "$ nslookup localhost\n" \
3274 "Server: default\n" \
3275 "Address: default\n" \
3276 "\n" \
3277 "Name: debian\n" \
3278 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003279
Adam Tkacb1585062009-11-22 03:43:55 +01003280#define ntpd_trivial_usage \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01003281 "[-dnqwl] [-S PROG] [-p PEER]..."
Adam Tkacb1585062009-11-22 03:43:55 +01003282#define ntpd_full_usage "\n\n" \
3283 "NTP client/server\n" \
3284 "\nOptions:" \
3285 "\n -d Verbose" \
3286 "\n -n Do not daemonize" \
Denys Vlasenko8d580c72009-11-23 16:27:16 +01003287 "\n -q Quit after clock is set" \
Denys Vlasenko907647f2009-12-02 23:17:45 +01003288/* -N exists for mostly compat reasons, thus not essential to inform */ \
Denys Vlasenkob2e5fc32009-11-25 14:52:47 +01003289/* the user that it exists: user may use nice as well */ \
3290/* "\n -N Run at high priority" */ \
Denys Vlasenko074e8dc2010-01-04 23:58:13 +01003291 "\n -w Do not set time (only query peers), implies -n" \
Adam Tkacb1585062009-11-22 03:43:55 +01003292 "\n -l Run as server on port 123" \
Denys Vlasenkoede737b2010-01-06 12:27:47 +01003293 "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins" \
Adam Tkacb1585062009-11-22 03:43:55 +01003294 "\n -p PEER Obtain time from PEER (may be repeated)" \
3295
Glenn L McGrath60281112001-11-02 11:39:46 +00003296#define od_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003297 "[-aBbcDdeFfHhIiLlOovXx] " IF_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003298#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003299 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003300 "(or stdin) to stdout"
Glenn L McGrath60281112001-11-02 11:39:46 +00003301
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003302#define openvt_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003303 "[-c N] [-sw] [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003304#define openvt_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003305 "Start PROG on a new virtual terminal\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003306 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003307 "\n -c N Use specified VT" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003308 "\n -s Switch to the VT" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003309/* "\n -l Run PROG as login shell (by prepending '-')" */ \
3310 "\n -w Wait for PROG to exit" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00003311
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003312#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003313 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00003314
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003315/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003316#define parse_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003317 "[-n MAXTOKENS] [-m MINTOKENS] [-d DELIMS] [-f FLAGS] FILE..."
3318#define parse_full_usage ""
3319*/
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00003320
Eric Andersen27f64e12002-06-23 04:24:25 +00003321#define passwd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003322 "[OPTIONS] [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003323#define passwd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003324 "Change USER's password. If no USER is specified,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003325 "changes the password for the current user.\n" \
3326 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003327 "\n -a Algorithm to use for password (des, md5)" /* ", sha1)" */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00003328 "\n -d Delete password for the account" \
3329 "\n -l Lock (disable) account" \
3330 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003331
Denis Vlasenko21d10142007-07-20 21:28:41 +00003332#define chpasswd_trivial_usage \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003333 IF_LONG_OPTS("[--md5|--encrypted]") IF_NOT_LONG_OPTS("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003334#define chpasswd_full_usage "\n\n" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003335 "Read user:password from stdin and update /etc/passwd\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003336 "\nOptions:" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003337 IF_LONG_OPTS( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00003338 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003339 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003340 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003341 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003342 "\n -e Supplied passwords are in encrypted form" \
3343 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003344 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00003345
Glenn L McGrath655d8142003-06-22 15:32:41 +00003346#define patch_trivial_usage \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003347 "[OPTIONS] [ORIGFILE [PATCHFILE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003348#define patch_full_usage "\n\n" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003349 IF_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003350 " -p,--strip N Strip N leading components from file names" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003351 "\n -i,--input DIFF Read DIFF instead of stdin" \
3352 "\n -R,--reverse Reverse patch" \
3353 "\n -N,--forward Ignore already applied patches" \
3354 "\n --dry-run Don't actually change files" \
3355 ) \
3356 IF_NOT_LONG_OPTS( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003357 " -p N Strip N leading components from file names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003358 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00003359 "\n -R Reverse patch" \
Denys Vlasenkod7874ed2009-08-20 23:33:19 +02003360 "\n -N Ignore already applied patches" \
Denys Vlasenko17c838b2009-10-24 17:11:55 +02003361 )
Denis Vlasenko397de612008-03-17 08:55:44 +00003362
Glenn L McGrath655d8142003-06-22 15:32:41 +00003363#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003364 "$ patch -p1 < example.diff\n" \
3365 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00003366
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003367#define pgrep_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003368 "[-flnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003369#define pgrep_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003370 "Display process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003371 "\nOptions:" \
3372 "\n -l Show command name too" \
3373 "\n -f Match against entire command line" \
3374 "\n -n Show the newest process only" \
3375 "\n -o Show the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003376 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003377 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003378 "\n -s Match session ID (0 for current)" \
3379 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003380
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003381#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00003382#define pidof_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003383 "[OPTIONS] [NAME]..."
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003384#define USAGE_PIDOF "\n\nOptions:"
3385#else
3386#define pidof_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003387 "[NAME]..."
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003388#define USAGE_PIDOF /* none */
3389#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003390#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003391 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003392 USAGE_PIDOF \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003393 IF_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003394 "\n -s Show only one PID") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003395 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003396 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003397 "\n Use %PPID to omit pid of pidof's parent") \
3398
Eric Andersen221b2ea2001-07-31 19:06:07 +00003399#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003400 "$ pidof init\n" \
3401 "1\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003402 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003403 "$ pidof /bin/sh\n20351 5973 5950\n") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003404 IF_FEATURE_PIDOF_OMIT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003405 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00003406
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003407#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003408#define ping_trivial_usage \
3409 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003410#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003411 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003412#define ping6_trivial_usage \
3413 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003414#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003415 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003416#else
3417#define ping_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003418 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003419#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003420 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3421 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01003422 "\n -4, -6 Force IP or IPv6 name resolution" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003423 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003424 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3425 "\n -I IFACE/IP Use interface or IP address as source" \
3426 "\n -W SEC Seconds to wait for the first response (default:10)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003427 "\n (after all -c CNT packets are sent)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003428 "\n -w SEC Seconds until ping exits (default:infinite)" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003429 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003430 "\n -q Quiet, only displays output at start" \
3431 "\n and when finished" \
3432
Eric Andersen51b8bd62002-07-03 11:46:38 +00003433#define ping6_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003434 "[OPTIONS] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003435#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003436 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3437 "\nOptions:" \
3438 "\n -c CNT Send only CNT pings" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003439 "\n -s SIZE Send SIZE data bytes in packets (default:56)" \
3440 "\n -I IFACE/IP Use interface or IP address as source" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003441 "\n -q Quiet, only displays output at start" \
3442 "\n and when finished" \
3443
Eric Andersen51b8bd62002-07-03 11:46:38 +00003444#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003445#define ping_example_usage \
3446 "$ ping localhost\n" \
3447 "PING slag (127.0.0.1): 56 data bytes\n" \
3448 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3449 "\n" \
3450 "--- debian ping statistics ---\n" \
3451 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3452 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003453#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003454 "$ ping6 ip6-localhost\n" \
3455 "PING ip6-localhost (::1): 56 data bytes\n" \
3456 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3457 "\n" \
3458 "--- ip6-localhost ping statistics ---\n" \
3459 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3460 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003461
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003462#define pipe_progress_trivial_usage NOUSAGE_STR
3463#define pipe_progress_full_usage ""
3464
Eric Andersen7e9276b2001-02-22 01:15:47 +00003465#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003466 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003467#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003468 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003469 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003470
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003471#define pkill_trivial_usage \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003472 "[-l|-SIGNAL] [-fnovx] [-s SID|-P PPID|PATTERN]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003473#define pkill_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003474 "Send a signal to process(es) selected by regex PATTERN\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003475 "\nOptions:" \
3476 "\n -l List all signals" \
3477 "\n -f Match against entire command line" \
3478 "\n -n Signal the newest process only" \
3479 "\n -o Signal the oldest process only" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003480 "\n -v Negate the match" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003481 "\n -x Match whole name (not substring)" \
Denys Vlasenko57dc5342009-07-06 00:00:12 +02003482 "\n -s Match session ID (0 for current)" \
3483 "\n -P Match parent process ID" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003484
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003485#define popmaildir_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003486 "[OPTIONS] MAILDIR [CONN_HELPER ARGS]"
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003487#define popmaildir_full_usage "\n\n" \
3488 "Fetch content of remote mailbox to local maildir\n" \
3489 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003490/* "\n -b Binary mode. Ignored" */ \
3491/* "\n -d Debug. Ignored" */ \
3492/* "\n -m Show used memory. Ignored" */ \
3493/* "\n -V Show version. Ignored" */ \
3494/* "\n -c Use tcpclient. Ignored" */ \
3495/* "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" */ \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003496 "\n -s Skip authorization" \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003497 "\n -T Get messages with TOP instead of RETR" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003498 "\n -k Keep retrieved messages on the server" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003499 "\n -t SEC Network timeout" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003500 IF_FEATURE_POPMAILDIR_DELIVERY( \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003501 "\n -F \"PROG ARGS\" Filter program (may be repeated)" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003502 "\n -M \"PROG ARGS\" Delivery program" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003503 ) \
Denys Vlasenkoeae697f2010-03-10 13:01:14 +01003504 "\n" \
3505 "\nFetch from plain POP3 server:" \
3506 "\npopmaildir -k DIR nc pop3.server.com 110 <user_and_pass.txt" \
3507 "\nFetch from SSLed POP3 server and delete fetched emails:" \
3508 "\npopmaildir DIR -- openssl s_client -quiet -connect pop3.server.com:995 <user_and_pass.txt"
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003509/* "\n -R BYTES Remove old messages on the server >= BYTES. Ignored" */
3510/* "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" */
3511/* "\n -L BYTES Don't retrieve new messages >= BYTES. Ignored" */
3512/* "\n -H LINES Type first LINES of a message. Ignored" */
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003513#define popmaildir_example_usage \
3514 "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n" \
3515 "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
3516
Eric Andersen7e9276b2001-02-22 01:15:47 +00003517#define poweroff_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003518 "[-d DELAY] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003519#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003520 "Halt and shut off power\n" \
3521 "\nOptions:" \
3522 "\n -d Delay interval for halting" \
3523 "\n -n No call to sync()" \
3524 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003525
Mike Frysinger95d3c452005-04-21 23:29:24 +00003526#define printenv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003527 "[VARIABLE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003528#define printenv_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003529 "Print environment VARIABLEs.\n" \
3530 "If no VARIABLE specified, print all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003531
Eric Andersen7e9276b2001-02-22 01:15:47 +00003532#define printf_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003533 "FORMAT [ARGUMENT]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003534#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003535 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003536 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003537#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003538 "$ printf \"Val=%d\\n\" 5\n" \
3539 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003540
Denis Vlasenko94949192006-11-05 00:45:47 +00003541
3542#if ENABLE_DESKTOP
3543
3544#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003545 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003546#define ps_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003547 "Report process status\n" \
3548 "\nOptions:" \
3549 "\n -o col1,col2=header Select columns for display" \
Denys Vlasenko532609e2009-09-20 20:29:25 +02003550 IF_FEATURE_SHOW_THREADS( \
3551 "\n -T Show threads" \
3552 )
Denis Vlasenko94949192006-11-05 00:45:47 +00003553
3554#else /* !ENABLE_DESKTOP */
3555
Denis Vlasenko397de612008-03-17 08:55:44 +00003556#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003557#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003558#else
3559#define USAGE_PS "\nOptions:"
3560#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003561
Eric Andersen7e9276b2001-02-22 01:15:47 +00003562#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003563 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003564#define ps_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003565 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003566 USAGE_PS \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003567 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003568 "\n -Z Show SE Linux context" \
3569 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003570 IF_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003571 "\n w Wide output" \
3572 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003573
Denis Vlasenko94949192006-11-05 00:45:47 +00003574#endif /* ENABLE_DESKTOP */
3575
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003576#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003577 "$ ps\n" \
3578 " PID Uid Gid State Command\n" \
3579 " 1 root root S init\n" \
3580 " 2 root root S [kflushd]\n" \
3581 " 3 root root S [kupdate]\n" \
3582 " 4 root root S [kpiod]\n" \
3583 " 5 root root S [kswapd]\n" \
3584 " 742 andersen andersen S [bash]\n" \
3585 " 743 andersen andersen S -bash\n" \
3586 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003587 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003588
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003589#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003590 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003591#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003592 "Scan a host, print all open ports\n" \
3593 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003594 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003595 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003596 "\n -p Scan from this port (default 1)" \
3597 "\n -P Scan up to this port (default 1024)" \
3598 "\n -t Timeout (default 5000 ms)" \
3599 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3600
Eric Andersen7e9276b2001-02-22 01:15:47 +00003601#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003602 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003603#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003604 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003605#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003606 "$ pwd\n" \
3607 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003608
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003609#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003610 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003611#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003612 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003613#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003614 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003615
Eric Andersen7e9276b2001-02-22 01:15:47 +00003616#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003617 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003618#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003619 "Get and possibly set the system date and time from a remote HOST\n" \
3620 "\nOptions:" \
3621 "\n -s Set the system date and time (default)" \
3622 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003623
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00003624#define rdev_trivial_usage \
3625 ""
3626#define rdev_full_usage "\n\n" \
3627 "Print the device node associated with the filesystem mounted at '/'"
3628#define rdev_example_usage \
3629 "$ rdev\n" \
3630 "/dev/mtdblock9 /\n"
3631
Rob Landley0e4690d2006-08-20 22:12:18 +00003632#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003633 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003634#define readahead_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003635 "Preload FILEs to RAM"
Rob Landley0e4690d2006-08-20 22:12:18 +00003636
Eric Andersen7e9276b2001-02-22 01:15:47 +00003637#define readlink_trivial_usage \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003638 IF_FEATURE_READLINK_FOLLOW("[-fnv] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003639#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003640 "Display the value of a symlink" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003641 IF_FEATURE_READLINK_FOLLOW( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003642 "\nOptions:" \
Denys Vlasenkoa99aa6e2009-06-12 13:16:21 +02003643 "\n -f Canonicalize by following all symlinks" \
3644 "\n -n Don't add newline" \
3645 "\n -v Verbose" \
3646 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003647
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003648#define readprofile_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003649 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003650#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003651 "Options:" \
3652 "\n -m mapfile (Default: /boot/System.map)" \
3653 "\n -p profile (Default: /proc/profile)" \
3654 "\n -M mult Set the profiling multiplier to mult" \
3655 "\n -i Print only info about the sampling step" \
3656 "\n -v Verbose" \
3657 "\n -a Print all symbols, even if count is 0" \
3658 "\n -b Print individual histogram-bin counts" \
3659 "\n -s Print individual counters within functions" \
3660 "\n -r Reset all the counters (root only)" \
3661 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003662
Glenn L McGrath62fae302002-12-10 00:14:33 +00003663#define realpath_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003664 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003665#define realpath_full_usage "\n\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003666 "Return the absolute pathnames of given FILE"
Tim Riker7b253f82003-12-28 05:02:40 +00003667
Eric Andersen7e9276b2001-02-22 01:15:47 +00003668#define reboot_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01003669 "[-d DELAY] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003670#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003671 "Reboot the system\n" \
3672 "\nOptions:" \
3673 "\n -d Delay interval for rebooting" \
3674 "\n -n No call to sync()" \
3675 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003676
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003677#define reformime_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003678 "[OPTIONS] [FILE]..."
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003679#define reformime_full_usage "\n\n" \
3680 "Parse MIME-encoded message\n" \
3681 "\nOptions:" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003682 "\n -x PREFIX Extract content of MIME sections to files" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003683 "\n -X PROG ARGS Filter content of MIME sections through PROG" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003684 "\n Must be the last option" \
3685 "\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003686 "\nOther options are silently ignored" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003687
Eric Andersen7e9276b2001-02-22 01:15:47 +00003688#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003689 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003690#define renice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003691 "Change priority of running processes\n" \
3692 "\nOptions:" \
3693 "\n -n Adjust current nice value (smaller is faster)" \
3694 "\n -p Process id(s) (default)" \
3695 "\n -g Process group id(s)" \
3696 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003697
Denys Vlasenko5e611152009-05-19 17:36:16 +02003698#define scriptreplay_trivial_usage \
3699 "timingfile [typescript [divisor]]"
3700#define scriptreplay_full_usage "\n\n" \
3701 "Play back typescripts, using timing information"
3702
Eric Andersen7e9276b2001-02-22 01:15:47 +00003703#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003704 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003705#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003706 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003707
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003708#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003709 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003710#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003711 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003712
Denis Vlasenko397137b2007-07-23 14:03:30 +00003713#define restorecon_trivial_usage \
3714 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003715#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003716 "Reset security contexts of files in pathname\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02003717 "\n -i Ignore files that don't exist" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003718 "\n -f file File with list of files to process. Use - for stdin" \
3719 "\n -e directory Directory to exclude" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003720 "\n -R,-r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003721 "\n -n Don't change any file labels" \
3722 "\n -o file Save list of files with incorrect context" \
3723 "\n -v Verbose" \
3724 "\n -vv Show changed labels" \
3725 "\n -F Force reset of context to match file_context" \
3726 "\n for customizable files, or the user section," \
3727 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003728
Eric Andersen7e9276b2001-02-22 01:15:47 +00003729#define rm_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003730 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003731#define rm_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02003732 "Remove (unlink) FILEs\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003733 "\nOptions:" \
3734 "\n -i Always prompt before removing" \
3735 "\n -f Never prompt" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003736 "\n -R,-r Recurse" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003737
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003738#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003739 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003740
Eric Andersen7e9276b2001-02-22 01:15:47 +00003741#define rmdir_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003742 "[OPTIONS] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003743#define rmdir_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003744 "Remove DIRECTORY if it is empty\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003745 "\nOptions:" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003746 IF_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003747 "\n -p|--parents Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003748 "\n --ignore-fail-on-non-empty" \
3749 ) \
3750 IF_NOT_FEATURE_RMDIR_LONG_OPTIONS( \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003751 "\n -p Include parents" \
Denys Vlasenko33d7b722009-08-27 20:47:35 +02003752 )
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003753
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003754#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003755 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003756
Eric Andersen7e9276b2001-02-22 01:15:47 +00003757#define rmmod_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003758 "[OPTIONS] [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003759#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003760 "Unload the specified kernel modules from the kernel\n" \
3761 "\nOptions:" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003762 "\n -w Wait until the module is no longer used" \
3763 "\n -f Force unloading" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003764 "\n -a Remove all unused modules (recursively)" \
3765
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003766#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003767 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003768
Eric Andersen7e9276b2001-02-22 01:15:47 +00003769#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003770 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003771#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003772 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003773 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003774 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003775 "\n -e Display other/more information" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003776 "\n -A inet" IF_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003777
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003778#define rpm_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003779 "-i -q[ildc]p PACKAGE.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003780#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003781 "Manipulate RPM packages\n" \
3782 "\nOptions:" \
3783 "\n -i Install package" \
3784 "\n -q Query package" \
3785 "\n -p Query uninstalled package" \
3786 "\n -i Show information" \
3787 "\n -l List contents" \
3788 "\n -d List documents" \
3789 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003790
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003791#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003792 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003793#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003794 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003795
Mike Frysinger6b160e42008-02-15 02:27:19 +00003796#define rtcwake_trivial_usage \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003797 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SEC | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003798#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003799 "Enter a system sleep state until specified wakeup time\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003800 IF_LONG_OPTS( \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003801 "\n -a,--auto Read clock mode from adjtime" \
3802 "\n -l,--local Clock is set to local time" \
3803 "\n -u,--utc Clock is set to UTC time" \
3804 "\n -d,--device=DEV Specify the RTC device" \
3805 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003806 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003807 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003808 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02003809 IF_NOT_LONG_OPTS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003810 "\n -a Read clock mode from adjtime" \
3811 "\n -l Clock is set to local time" \
3812 "\n -u Clock is set to UTC time" \
3813 "\n -d DEV Specify the RTC device" \
3814 "\n -m MODE Set the sleep state (default: standby)" \
3815 "\n -s SEC Set the timeout in SEC seconds from now" \
3816 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003817 )
3818
Denis Vlasenko49622d72007-03-10 16:58:49 +00003819#define runcon_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003820 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] PROG ARGS\n" \
3821 " runcon CONTEXT PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003822#define runcon_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003823 "Run PROG in a different security context\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003824 "\n CONTEXT Complete security context\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003825 IF_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003826 "\n -c,--compute Compute process transition context before modifying" \
3827 "\n -t,--type=TYPE Type (for same role as parent)" \
3828 "\n -u,--user=USER User identity" \
3829 "\n -r,--role=ROLE Role" \
3830 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003831 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003832 IF_NOT_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003833 "\n -c Compute process transition context before modifying" \
3834 "\n -t TYPE Type (for same role as parent)" \
3835 "\n -u USER User identity" \
3836 "\n -r ROLE Role" \
3837 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003838 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003839
Eric Andersen6cf47a72001-10-31 10:24:36 +00003840#define run_parts_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003841 "[-t] "IF_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003842#define run_parts_full_usage "\n\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003843 "Run a bunch of scripts in DIRECTORY\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003844 "\nOptions:" \
3845 "\n -t Print what would be run, but don't actually run anything" \
3846 "\n -a ARG Pass ARG as argument for every program" \
3847 "\n -u MASK Set the umask to MASK before running every program" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003848 IF_FEATURE_RUN_PARTS_FANCY( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003849 "\n -l Print names of all matching files even if they are not executable" \
3850 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003851
3852#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003853 "$ run-parts -a start /etc/init.d\n" \
3854 "$ run-parts -a stop=now /etc/init.d\n\n" \
3855 "Let's assume you have a script foo/dosomething:\n" \
3856 "#!/bin/sh\n" \
3857 "for i in $*; do eval $i; done; unset i\n" \
3858 "case \"$1\" in\n" \
3859 "start*) echo starting something;;\n" \
3860 "stop*) set -x; shutdown -h $stop;;\n" \
3861 "esac\n\n" \
3862 "Running this yields:\n" \
3863 "$run-parts -a stop=+4m foo/\n" \
3864 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003865
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003866#define runlevel_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003867 "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003868#define runlevel_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02003869 "Find the current and previous system runlevel\n" \
3870 "\n" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003871 "If no utmp FILE exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003872 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003873#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003874 "$ runlevel /var/run/utmp\n" \
3875 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003876
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003877#define runsv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003878 "DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003879#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003880 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003881
3882#define runsvdir_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01003883 "[-P] [-s SCRIPT] DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003884#define runsvdir_full_usage "\n\n" \
Denis Vlasenkodc700692008-11-08 21:39:06 +00003885 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
3886 "\n -P Put each runsv in a new session" \
3887 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003888
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003889#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003890 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003891#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003892 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003893#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003894 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003895
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003896#define script_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003897 "[-afq" IF_SCRIPTREPLAY("t") "] [-c PROG] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003898#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003899 "Options:" \
3900 "\n -a Append output" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003901 "\n -c Run PROG, not shell" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003902 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003903 "\n -q Quiet" \
Denys Vlasenko5e611152009-05-19 17:36:16 +02003904 IF_SCRIPTREPLAY( \
3905 "\n -t Send timing to stderr" \
3906 )
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003907
Eric Andersen7e9276b2001-02-22 01:15:47 +00003908#define sed_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003909 "[-efinr] SED_CMD [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003910#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003911 "Options:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003912 "\n -e CMD Add CMD to sed commands to be executed" \
3913 "\n -f FILE Add FILE contents to sed commands to be executed" \
Denys Vlasenkodac863a2009-10-27 09:11:17 +01003914 "\n -i Edit files in-place (else sends result to stdout)" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02003915 "\n -n Suppress automatic printing of pattern space" \
3916 "\n -r Use extended regex syntax" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003917 "\n" \
Rob Landley7b284152009-10-26 16:04:07 -05003918 "\nIf no -e or -f, the first non-option argument is the sed command string." \
3919 "\nRemaining arguments are input files (stdin if none)."
Eric Andersenf802ff72004-04-12 15:12:06 +00003920
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003921#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003922 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3923 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003924
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003925#define selinuxenabled_trivial_usage NOUSAGE_STR
3926#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003927
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003928#define sendmail_trivial_usage \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003929 "[OPTIONS] [RECIPIENT_EMAIL]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003930#define sendmail_full_usage "\n\n" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003931 "Read email from stdin and send it\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003932 "\nStandard options:" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003933 "\n -t Read additional recipients from message body" \
3934 "\n -f sender Sender (required)" \
3935 "\n -o options Various options. -oi implied, others are ignored" \
Vladimir Dronnikovb618dba2009-10-04 01:34:54 +02003936 "\n -i -oi synonym. implied and ignored" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003937 "\n" \
3938 "\nBusybox specific options:" \
3939 "\n -w seconds Network timeout" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003940 "\n -H 'PROG ARGS' Run connection helper" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003941 "\n Examples:" \
Denis Vlasenko7e0c2432009-03-02 16:12:00 +00003942 "\n -H 'exec openssl s_client -quiet -tls1 -starttls smtp" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003943 "\n -connect smtp.gmail.com:25' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003944 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkoa6eb7f42009-03-29 16:53:25 +00003945 "\n -H 'exec openssl s_client -quiet -tls1" \
3946 "\n -connect smtp.gmail.com:465' <email.txt" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003947 "\n [4<username_and_passwd.txt | -au<username> -ap<password>]" \
Denis Vlasenkob9d572a2008-11-06 23:41:38 +00003948 "\n -S server[:port] Server" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003949 "\n -au<username> Username for AUTH LOGIN" \
3950 "\n -ap<password> Password for AUTH LOGIN" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003951 "\n -am<method> Authentication method. Ignored. LOGIN is implied" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003952 "\n" \
Denis Vlasenko88b8f0a2009-03-31 23:41:53 +00003953 "\nOther options are silently ignored; -oi -t is implied" \
Denys Vlasenko666e1d32009-07-05 21:46:37 +02003954 IF_MAKEMIME( \
3955 "\nUse makemime applet to create message with attachments" \
3956 )
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003957
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003958#define seq_trivial_usage \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003959 "[-w] [-s SEP] [FIRST [INC]] LAST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003960#define seq_full_usage "\n\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003961 "Print numbers from FIRST to LAST, in steps of INC.\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01003962 "FIRST, INC default to 1.\n" \
Denis Vlasenkocf3e05b2008-11-12 21:18:58 +00003963 "\nOptions:" \
3964 "\n -w Pad to last with leading zeros" \
3965 "\n -s SEP String separator" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003966
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003967#define sestatus_trivial_usage \
3968 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003969#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003970 " -v Verbose" \
3971 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003972
Paul Foxfc2256a2005-08-01 18:12:30 +00003973#define setconsole_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003974 "[-r" IF_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003975#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003976 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3977 "\nOptions:" \
3978 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003979
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003980#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003981 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003982#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003983
Denis Vlasenko397137b2007-07-23 14:03:30 +00003984#define setfiles_trivial_usage \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003985 "[-dnpqsvW] [-e DIR]... [-o FILE] [-r alt_root_path]" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003986 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003987 " [-c policyfile] spec_file" \
3988 ) \
3989 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003990#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003991 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00003992 IF_FEATURE_SETFILES_CHECK_OPTION( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003993 "\n -c FILE Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003994 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003995 "\n -d Show which specification matched each file" \
3996 "\n -l Log changes in file labels to syslog" \
3997 "\n -n Don't change any file labels" \
3998 "\n -q Suppress warnings" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01003999 "\n -r DIR Use an alternate root path" \
4000 "\n -e DIR Exclude DIR" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004001 "\n -F Force reset of context to match file_context for customizable files" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004002 "\n -o FILE Save list of files with incorrect context" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004003 "\n -s Take a list of files from stdin (instead of command line)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004004 "\n -v Show changes in file labels, if type or role are changing" \
4005 "\n -vv Show changes in file labels, if type, role, or user are changing" \
4006 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00004007
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00004008#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00004009 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00004010#define setfont_full_usage "\n\n" \
4011 "Load a console font\n" \
4012 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00004013 "\n -m MAPFILE Load console screen map" \
4014 "\n -C TTY Affect TTY instead of /dev/tty" \
4015
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00004016#define setfont_example_usage \
4017 "$ setfont -m koi8-r /etc/i18n/fontname\n"
4018
Eric Andersen7e9276b2001-02-22 01:15:47 +00004019#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004020 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004021#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004022 "Set entries into the kernel's scancode-to-keycode map,\n" \
4023 "allowing unusual keyboards to generate usable keycodes.\n\n" \
4024 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004025 "and KEYCODE is given in decimal." \
Denis Vlasenko397de612008-03-17 08:55:44 +00004026
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004027#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004028 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004029
Rob Landley87848d92006-03-27 23:23:43 +00004030#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004031 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004032#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004033 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00004034
Denis Vlasenkobe039372007-10-14 04:48:44 +00004035#define setsebool_trivial_usage \
4036 "boolean value"
4037
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004038#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00004039 "Change boolean setting"
4040
Paul Fox42403642005-08-01 22:52:09 +00004041#define setsid_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004042 "PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004043#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004044 "Run PROG in a new session. PROG will have no controlling terminal\n" \
4045 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
4046 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00004047
Eric Andersen2e9c2572003-08-08 22:26:06 +00004048#define last_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004049 ""IF_FEATURE_LAST_FANCY("[-HW] [-f file]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004050#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004051 "Show listing of the last users that logged into the system" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004052 IF_FEATURE_LAST_FANCY( "\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004053 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00004054/* "\n -H Show header line" */ \
4055 "\n -W Display with no host column truncation" \
4056 "\n -f file Read from file instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00004057 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00004058
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00004059#define showkey_trivial_usage \
4060 "[-a | -k | -s]"
4061#define showkey_full_usage "\n\n" \
4062 "Show keys pressed\n" \
4063 "\nOptions:" \
4064 "\n -a Display decimal/octal/hex values of the keys" \
4065 "\n -k Display interpreted keycodes (default)" \
4066 "\n -s Display raw scan-codes" \
4067
Denis Vlasenko14923db2007-06-20 15:23:03 +00004068#define slattach_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004069 "[-cehmLF] [-s SPEED] [-p PROTOCOL] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004070#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004071 "Attach network interface(s) to serial line(s)\n" \
4072 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004073 "\n -p PROT Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
4074 "\n -s SPD Set line speed" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004075 "\n -e Exit after initializing device" \
4076 "\n -h Exit when the carrier is lost" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004077 "\n -c PROG Run PROG when the line is hung up" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00004078 "\n -m Do NOT initialize the line in raw 8 bits mode" \
4079 "\n -L Enable 3-wire operation" \
4080 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00004081
Eric Andersen7e9276b2001-02-22 01:15:47 +00004082#define sleep_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004083 IF_FEATURE_FANCY_SLEEP("[") "N" IF_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004084#define sleep_full_usage "\n\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004085 IF_NOT_FEATURE_FANCY_SLEEP("Pause for N seconds") \
4086 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004087 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004088 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004089#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004090 "$ sleep 2\n" \
4091 "[2 second delay results]\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004092 IF_FEATURE_FANCY_SLEEP( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004093 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004094 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00004095
Eric Andersen7e9276b2001-02-22 01:15:47 +00004096#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004097 "[-nru" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004098 IF_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004099 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004100#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004101 "Sort lines of text\n" \
4102 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004103 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004104 "\n -b Ignore leading blanks" \
4105 "\n -c Check whether input is sorted" \
4106 "\n -d Dictionary order (blank or alphanumeric only)" \
4107 "\n -f Ignore case" \
4108 "\n -g General numerical sort" \
4109 "\n -i Ignore unprintable characters" \
4110 "\n -k Sort key" \
4111 "\n -M Sort month" \
4112 ) \
4113 "\n -n Sort numbers" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004114 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004115 "\n -o Output to file" \
4116 "\n -k Sort by key" \
4117 "\n -t CHAR Key separator" \
4118 ) \
4119 "\n -r Reverse sort order" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004120 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004121 "\n -s Stable (don't sort ties alphabetically)" \
4122 ) \
4123 "\n -u Suppress duplicate lines" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004124 IF_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00004125 "\n -z Lines are terminated by NUL, not newline" \
4126 "\n -mST Ignored for GNU compatibility") \
4127
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004128#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004129 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
4130 "a\n" \
4131 "b\n" \
4132 "c\n" \
4133 "d\n" \
4134 "e\n" \
4135 "f\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004136 IF_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00004137 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
4138 "d 2\n" \
4139 "b 2\n" \
4140 "c 3\n" \
4141 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004142 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004143
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00004144#define split_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004145 "[OPTIONS] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004146#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00004147 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004148 "\n -b n[k|m] Split by bytes" \
4149 "\n -l n Split by lines" \
4150 "\n -a n Use n letters as suffix" \
4151
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00004152#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00004153 "$ split TODO foo\n" \
4154 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00004155
Eric Andersenc2af1ee2001-10-18 19:33:06 +00004156#define start_stop_daemon_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004157 "[OPTIONS] [-S|-K] ... [-- ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004158#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004159 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004160 "-K: stop all matching processes.\n" \
4161 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004162 IF_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004163 "\nProcess matching:" \
4164 "\n -u,--user USERNAME|UID Match only this user's processes" \
4165 "\n -n,--name NAME Match processes with NAME" \
4166 "\n in comm field in /proc/PID/stat" \
4167 "\n -x,--exec EXECUTABLE Match processes with this command" \
4168 "\n in /proc/PID/cmdline" \
4169 "\n -p,--pidfile FILE Match a process with PID from the file" \
4170 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004171 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004172 "\n -x,--exec EXECUTABLE Program to run" \
4173 "\n -a,--startas NAME Zeroth argument" \
4174 "\n -b,--background Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004175 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004176 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004177 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004178 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
4179 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004180 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004181 "\n -s,--signal SIG Signal to send" \
4182 "\n -t,--test Match only, exit with 0 if a process is found" \
4183 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004184 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004185 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004186 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00004187 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00004188 "\n -q,--quiet Quiet" \
4189 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004190 IF_NOT_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004191 "\nProcess matching:" \
4192 "\n -u USERNAME|UID Match only this user's processes" \
4193 "\n -n NAME Match processes with NAME" \
4194 "\n in comm field in /proc/PID/stat" \
4195 "\n -x EXECUTABLE Match processes with this command" \
4196 "\n command in /proc/PID/cmdline" \
4197 "\n -p FILE Match a process with PID from the file" \
4198 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004199 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004200 "\n -x EXECUTABLE Program to run" \
4201 "\n -a NAME Zeroth argument" \
4202 "\n -b Background" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004203 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004204 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00004205 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004206 "\n -c USER[:[GRP]] Change to user/group" \
4207 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00004208 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004209 "\n -s SIG Signal to send" \
4210 "\n -t Match only, exit with 0 if a process is found" \
4211 "\nOther:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004212 IF_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004213 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00004214 "\n -v Verbose" \
4215 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00004216 "\n -q Quiet" \
4217 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00004218
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004219#define stat_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004220 "[OPTIONS] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004221#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004222 "Display file (default) or filesystem status\n" \
4223 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004224 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004225 "\n -c fmt Use the specified format" \
4226 ) \
4227 "\n -f Display filesystem status" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004228 "\n -L Follow links" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004229 "\n -t Display info in terse form" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004230 IF_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004231 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004232 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004233 IF_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004234 "\n\nValid format sequences for files:\n" \
4235 " %a Access rights in octal\n" \
4236 " %A Access rights in human readable form\n" \
4237 " %b Number of blocks allocated (see %B)\n" \
4238 " %B The size in bytes of each block reported by %b\n" \
4239 " %d Device number in decimal\n" \
4240 " %D Device number in hex\n" \
4241 " %f Raw mode in hex\n" \
4242 " %F File type\n" \
4243 " %g Group ID of owner\n" \
4244 " %G Group name of owner\n" \
4245 " %h Number of hard links\n" \
4246 " %i Inode number\n" \
4247 " %n File name\n" \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01004248 " %N File name, with -> TARGET if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004249 " %o I/O block size\n" \
4250 " %s Total size, in bytes\n" \
4251 " %t Major device type in hex\n" \
4252 " %T Minor device type in hex\n" \
4253 " %u User ID of owner\n" \
4254 " %U User name of owner\n" \
4255 " %x Time of last access\n" \
4256 " %X Time of last access as seconds since Epoch\n" \
4257 " %y Time of last modification\n" \
4258 " %Y Time of last modification as seconds since Epoch\n" \
4259 " %z Time of last change\n" \
4260 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004261 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004262 " %a Free blocks available to non-superuser\n" \
4263 " %b Total data blocks in file system\n" \
4264 " %c Total file nodes in file system\n" \
4265 " %d Free file nodes in file system\n" \
4266 " %f Free blocks in file system\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004267 IF_SELINUX( \
Denis Vlasenko49622d72007-03-10 16:58:49 +00004268 " %C Security context in SELinux\n" \
4269 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004270 " %i File System ID in hex\n" \
4271 " %l Maximum length of filenames\n" \
4272 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004273 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004274 " %S Fundamental block size (for block counts)\n" \
4275 " %t Type in hex\n" \
4276 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004277 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00004278
Eric Andersenef5e8f82002-11-07 02:09:37 +00004279#define strings_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004280 "[-afo] [-n LEN] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004281#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004282 "Display printable strings in a binary file\n" \
4283 "\nOptions:" \
4284 "\n -a Scan whole file (default)" \
4285 "\n -f Precede strings with filenames" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004286 "\n -n LEN At least LEN characters form a string (default 4)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004287 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00004288
Eric Andersen7e9276b2001-02-22 01:15:47 +00004289#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004290 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004291#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004292 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004293 "and deviations from stty sane\n" \
4294 "\nOptions:" \
4295 "\n -F DEVICE Open device instead of stdin" \
4296 "\n -a Print all current settings in human-readable form" \
4297 "\n -g Print in stty-readable form" \
4298 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004299
Robert Griebl1fca5582002-06-04 20:45:46 +00004300#define su_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004301 "[OPTIONS] [-] [USERNAME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004302#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004303 "Change user id or become root\n" \
4304 "\nOptions:" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004305 "\n -p,-m Preserve environment" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004306 "\n -c CMD Command to pass to 'sh -c'" \
4307 "\n -s SH Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00004308
Eric Andersen27f64e12002-06-23 04:24:25 +00004309#define sulogin_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004310 "[-t N] [TTY]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004311#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004312 "Single user login\n" \
4313 "\nOptions:" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004314 "\n -t N Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004315
Mike Frysinger95d3c452005-04-21 23:29:24 +00004316#define sum_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004317 "[-rs] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004318#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004319 "Checksum and count the blocks in a file\n" \
4320 "\nOptions:" \
4321 "\n -r Use BSD sum algorithm (1K blocks)" \
4322 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00004323
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004324#define sv_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004325 "[-v] [-w SEC] CMD SERVICE_DIR..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004326#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004327 "Control services monitored by runsv supervisor.\n" \
4328 "Commands (only first character is enough):\n" \
4329 "\n" \
4330 "status: query service status\n" \
4331 "up: if service isn't running, start it. If service stops, restart it\n" \
4332 "once: like 'up', but if service stops, don't restart it\n" \
4333 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004334 " if it exists. After it stops, don't restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004335 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004336 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00004337 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004338 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00004339
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004340#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004341 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004342#define svlogd_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004343 "Continuously read log data from stdin, optionally\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004344 "filter log messages, and write the data to one or more automatically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004345 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00004346
Eric Andersen7e9276b2001-02-22 01:15:47 +00004347#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004348 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004349#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004350 "Stop swapping on DEVICE\n" \
4351 "\nOptions:" \
4352 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004353
Eric Andersen7e9276b2001-02-22 01:15:47 +00004354#define swapon_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004355 "[-a]" IF_FEATURE_SWAPON_PRI(" [-p PRI]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004356#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004357 "Start swapping on DEVICE\n" \
4358 "\nOptions:" \
4359 "\n -a Start swapping on all swap devices" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004360 IF_FEATURE_SWAPON_PRI( \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004361 "\n -p PRI Set swap device priority" \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00004362 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004363
Rob Landley0f34a822005-10-27 22:55:50 +00004364#define switch_root_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004365 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004366#define switch_root_full_usage "\n\n" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004367 "Free initramfs and switch to another root fs:\n" \
4368 "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n" \
4369 "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004370 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004371 "\n -c DEV Reopen stdio to DEV after switch" \
Rob Landley0f34a822005-10-27 22:55:50 +00004372
Eric Andersen7e9276b2001-02-22 01:15:47 +00004373#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004374 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004375#define sync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004376 "Write all buffered blocks to disk"
4377
4378#define fsync_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004379 "[OPTIONS] FILE..."
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004380#define fsync_full_usage "\n\n" \
Denys Vlasenko14f6f0a2009-06-18 08:20:02 +02004381 "Write files' buffered blocks to disk\n" \
4382 "\nOptions:" \
4383 "\n -d Avoid syncing metadata"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004384
Eric Andersenb9050282003-12-24 06:02:11 +00004385#define sysctl_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004386 "[OPTIONS] [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004387#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004388 "Configure kernel parameters at runtime\n" \
4389 "\nOptions:" \
Denis Vlasenkof9d4fc32009-04-21 20:40:51 +00004390 "\n -n Don't print key names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004391 "\n -e Don't warn about unknown keys" \
4392 "\n -w Change sysctl setting" \
4393 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
4394 "\n -a Display all values" \
4395 "\n -A Display all values in table form" \
4396
Eric Andersen5d38f5b2005-09-12 21:42:48 +00004397#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00004398 "sysctl [-n] [-e] variable...\n" \
4399 "sysctl [-n] [-e] -w variable=value...\n" \
4400 "sysctl [-n] [-e] -a\n" \
4401 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
4402 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00004403
Eric Andersen7e9276b2001-02-22 01:15:47 +00004404#define syslogd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004405 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004406#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004407 "System logging utility.\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004408 "This version of syslogd ignores /etc/syslog.conf\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004409 "\nOptions:" \
4410 "\n -n Run in foreground" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004411 "\n -O FILE Log to given file (default:/var/log/messages)" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004412 "\n -l N Set local log level" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004413 "\n -S Smaller logging output" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004414 IF_FEATURE_ROTATE_LOGFILE( \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004415 "\n -s SIZE Max size (KB) before rotate (default:200KB, 0=off)" \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004416 "\n -b N N rotated logs to keep (default:1, max=99, 0=purge)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004417 IF_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004418 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
4419 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004420 IF_FEATURE_SYSLOGD_DUP( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00004421 "\n -D Drop duplicates") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004422 IF_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004423 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00004424 /* NB: -Csize shouldn't have space (because size is optional) */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004425/* "\n -m MIN Minutes between MARK lines (default:20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00004426
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004427#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004428 "$ syslogd -R masterlog:514\n" \
4429 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004430
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004431#define tac_trivial_usage \
4432 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004433#define tac_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004434 "Concatenate FILEs and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00004435
Eric Andersen7e9276b2001-02-22 01:15:47 +00004436#define tar_trivial_usage \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004437 "-[" IF_FEATURE_TAR_CREATE("c") "xt" IF_FEATURE_SEAMLESS_GZ("z") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004438 IF_FEATURE_SEAMLESS_BZ2("j") IF_FEATURE_SEAMLESS_LZMA("a") \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004439 IF_FEATURE_SEAMLESS_Z("Z") IF_FEATURE_TAR_NOPRESERVE_TIME("m") "vO] " \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004440 IF_FEATURE_TAR_FROM("[-X FILE] ") \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004441 "[-f TARFILE] [-C DIR] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004442#define tar_full_usage "\n\n" \
Denys Vlasenko8d680b52009-10-06 21:23:02 +02004443 IF_FEATURE_TAR_CREATE("Create, extract, ") \
4444 IF_NOT_FEATURE_TAR_CREATE("Extract ") \
4445 "or list files from a tar file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004446 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004447 IF_FEATURE_TAR_CREATE( \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004448 "\n c Create" \
4449 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004450 "\n x Extract" \
4451 "\n t List" \
4452 "\nArchive format selection:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004453 IF_FEATURE_SEAMLESS_GZ( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004454 "\n z Filter the archive through gzip" \
4455 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004456 IF_FEATURE_SEAMLESS_BZ2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004457 "\n j Filter the archive through bzip2" \
4458 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004459 IF_FEATURE_SEAMLESS_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004460 "\n a Filter the archive through lzma" \
4461 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004462 IF_FEATURE_SEAMLESS_Z( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004463 "\n Z Filter the archive through compress" \
4464 ) \
Mikhail Gusarov0d478332010-01-19 20:22:30 +06004465 IF_FEATURE_TAR_NOPRESERVE_TIME( \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004466 "\n m Do not restore mtime" \
Mikhail Gusarov0d478332010-01-19 20:22:30 +06004467 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004468 "\nFile selection:" \
4469 "\n f Name of TARFILE or \"-\" for stdin" \
4470 "\n O Extract to stdout" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004471 IF_FEATURE_TAR_FROM( \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004472 IF_FEATURE_TAR_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004473 "\n exclude File to exclude" \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004474 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004475 "\n X File with names to exclude" \
4476 ) \
Denys Vlasenko94ca6942010-01-20 02:51:09 +01004477 "\n C Change to DIR before operation" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004478 "\n v Verbose" \
4479
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004480#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004481 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
4482 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004483
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004484#define taskset_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004485 "[-p] [MASK] [PID | PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004486#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004487 "Set or get CPU affinity\n" \
4488 "\nOptions:" \
4489 "\n -p Operate on an existing PID" \
4490
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004491#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004492 "$ taskset 0x7 ./dgemm_test&\n" \
4493 "$ taskset -p 0x1 $!\n" \
4494 "pid 4790's current affinity mask: 7\n" \
4495 "pid 4790's new affinity mask: 1\n" \
4496 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4497 "pid 6671's current affinity mask: 1\n" \
4498 "pid 6671's new affinity mask: 1\n" \
4499 "$ taskset -p 1\n" \
4500 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004501
Eric Andersen7e9276b2001-02-22 01:15:47 +00004502#define tee_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004503 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004504#define tee_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004505 "Copy stdin to each FILE, and also to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004506 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004507 "\n -a Append to the given FILEs, don't overwrite" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004508 "\n -i Ignore interrupt signals (SIGINT)" \
4509
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004510#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004511 "$ echo \"Hello\" | tee /tmp/foo\n" \
4512 "$ cat /tmp/foo\n" \
4513 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004514
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004515#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004516#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004517 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004518#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004519 "Connect to telnet server\n" \
4520 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004521 "\n -a Automatic login with $USER variable" \
4522 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004523
Eric Andersen539ffc92004-02-22 12:25:47 +00004524#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004525#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004526 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004527#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004528 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004529#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004530
Eric Andersen08a72202002-09-30 20:52:10 +00004531#define telnetd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004532 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004533#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004534 "Handle incoming telnet connections" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004535 IF_NOT_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004536 "\nOptions:" \
4537 "\n -l LOGIN Exec LOGIN on connect" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004538 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004539 "\n -K Close connection as soon as login exits" \
4540 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004541 IF_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004542 "\n -p PORT Port to listen on" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004543 "\n -b ADDR[:PORT] Address to bind to" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004544 "\n -F Run in foreground" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004545 "\n -i Inetd mode" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004546 IF_FEATURE_TELNETD_INETD_WAIT( \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004547 "\n -w SEC Inetd 'wait' mode, linger time SEC" \
Denys Vlasenkoed1667e2009-09-04 02:21:13 +02004548 "\n -S Log to syslog (implied by -i or without -F and -w)" \
4549 ) \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004550 )
Eric Andersen08a72202002-09-30 20:52:10 +00004551
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004552/* "test --help" does not print help (POSIX compat), only "[ --help" does.
Denys Vlasenko662078f2010-01-14 13:27:34 +01004553 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION")
4554 * Unfortunately, it screws up generated BusyBox.html. TODO. */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004555#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004556 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004557#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004558 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4559 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004560#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004561 "$ test 1 -eq 2\n" \
4562 "$ echo $?\n" \
4563 "1\n" \
4564 "$ test 1 -eq 1\n" \
4565 "$ echo $?\n" \
4566 "0\n" \
4567 "$ [ -d /etc ]\n" \
4568 "$ echo $?\n" \
4569 "0\n" \
4570 "$ [ -d /junk ]\n" \
4571 "$ echo $?\n" \
4572 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004573
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004574#define tc_trivial_usage \
4575 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
4576#define tc_full_usage "\n\n" \
4577 "OBJECT: {qdisc|class|filter}\n" \
4578 "CMD: {add|del|change|replace|show}\n" \
4579 "\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004580 "qdisc [ handle QHANDLE ] [ root |"IF_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004581 /* "[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4582 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4583 " QDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004584 "qdisc show [ dev STRING ]"IF_FEATURE_TC_INGRESS(" [ingress]")"\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004585 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004586 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004587 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
4588 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
4589 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
Denis Vlasenko71c16572009-04-26 01:08:51 +00004590 " [ root | classid CLASSID ] [ handle FILTERID ]\n" \
4591 " [ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004592 "filter show [ dev STRING ] [ root | parent CLASSID ]"
4593
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004594#define tcpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004595 "[-hEv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004596/* with not-implemented options: */
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004597/* "[-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 +00004598#define tcpsvd_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004599 "Create TCP socket, bind to IP:PORT and listen\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004600 "for incoming connection. Run PROG for each connection.\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004601 "\n IP IP to listen on. '0' = all" \
4602 "\n PORT Port to listen on" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004603 "\n PROG ARGS Program to run" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004604 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4605 "\n -u USER[:GRP] Change to user/group after bind" \
4606 "\n -c N Handle up to N connections simultaneously" \
4607 "\n -b N Allow a backlog of approximately N TCP SYNs" \
4608 "\n -C N[:MSG] Allow only up to N connections from the same IP" \
4609 "\n New connections from this IP address are closed" \
4610 "\n immediately. MSG is written to the peer before close" \
4611 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004612 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004613 "\n -v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004614
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004615#define udpsvd_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004616 "[-hEv] [-c N] [-u USER] [-l NAME] IP PORT PROG"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004617#define udpsvd_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004618 "Create UDP socket, bind to IP:PORT and wait\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004619 "for incoming packets. Run PROG for each packet,\n" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004620 "redirecting all further packets with same peer ip:port to it.\n" \
4621 "\n IP IP to listen on. '0' = all" \
4622 "\n PORT Port to listen on" \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004623 "\n PROG ARGS Program to run" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004624 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
4625 "\n -u USER[:GRP] Change to user/group after bind" \
4626 "\n -c N Handle up to N connections simultaneously" \
4627 "\n -h Look up peer's hostname" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004628 "\n -E Don't set up environment variables" \
Denys Vlasenko26ff18b2009-10-02 11:37:17 +02004629 "\n -v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004630
Mark Whitley450736c2001-03-02 19:08:50 +00004631#define tftp_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02004632 "[OPTIONS] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004633#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004634 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004635 "\nOptions:" \
4636 "\n -l FILE Local FILE" \
4637 "\n -r FILE Remote FILE" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004638 IF_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004639 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004640 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004641 IF_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004642 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004643 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004644 IF_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004645 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004646 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004647
4648#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004649 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004650#define tftpd_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004651 "Transfer a file on tftp client's request\n" \
Denis Vlasenko91f8f822008-10-30 23:42:37 +00004652 "\n" \
4653 "tftpd should be used as an inetd service.\n" \
4654 "tftpd's line for inetd.conf:\n" \
4655 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
4656 "It also can be ran from udpsvd:\n" \
4657 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004658 "\nOptions:" \
4659 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004660 "\n -c Allow file creation via upload" \
4661 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004662
Eric Andersenc3657422001-11-30 07:54:32 +00004663#define time_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004664 "[OPTIONS] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004665#define time_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004666 "Run PROG, display resource usage when it exits\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004667 "\nOptions:" \
4668 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004669
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004670#define timeout_trivial_usage \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004671 "[-t SECS] [-s SIG] PROG ARGS"
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004672#define timeout_full_usage "\n\n" \
4673 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
Denis Vlasenko42404082008-11-24 13:42:24 +00004674 "Defaults: SECS: 10, SIG: TERM." \
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +00004675
Eric Andersen420b2082002-09-17 22:14:58 +00004676#define top_trivial_usage \
Denys Vlasenko00528822009-09-11 23:26:42 +02004677 "[-b] [-nCOUNT] [-dSECONDS]" IF_FEATURE_TOPMEM(" [-m]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004678#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004679 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004680 "Read the status of all processes from /proc each SECONDS\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004681 "and display a screenful of them." \
4682//TODO: add options and keyboard commands
Eric Andersen420b2082002-09-17 22:14:58 +00004683
Eric Andersen7e9276b2001-02-22 01:15:47 +00004684#define touch_trivial_usage \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004685 "[-c] [-d DATE] FILE [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004686#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004687 "Update the last-modified date on the given FILE[s]\n" \
4688 "\nOptions:" \
Denys Vlasenko07697852009-10-06 21:11:37 +02004689 "\n -c Don't create files" \
Denys Vlasenko7aca89a2009-07-18 03:41:29 +02004690 "\n -d DT Date/time to use" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004691
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004692#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004693 "$ ls -l /tmp/foo\n" \
4694 "/bin/ls: /tmp/foo: No such file or directory\n" \
4695 "$ touch /tmp/foo\n" \
4696 "$ ls -l /tmp/foo\n" \
4697 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004698
4699#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004700 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004701#define tr_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004702 "Translate, squeeze, or delete characters from stdin, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004703 "\nOptions:" \
4704 "\n -c Take complement of STRING1" \
4705 "\n -d Delete input characters coded STRING1" \
4706 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4707
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004708#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004709 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4710 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004711
Eric Andersen5c58d282001-07-10 16:29:00 +00004712#define traceroute_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004713 "[-"IF_TRACEROUTE6("46")"FIldnrv] [-f 1ST_TTL] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
4714 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-g GATEWAY] [-i IFACE]\n" \
4715 " [-z PAUSE_MSEC] HOST [BYTES]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004716#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004717 "Trace the route to HOST\n" \
4718 "\nOptions:" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004719 IF_TRACEROUTE6( \
4720 "\n -4, -6 Force IP or IPv6 name resolution" \
4721 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004722 "\n -F Set the don't fragment bit" \
4723 "\n -I Use ICMP ECHO instead of UDP datagrams" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004724 "\n -l Display the TTL value of the returned packet" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004725 "\n -d Set SO_DEBUG options to socket" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004726 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004727 "\n -r Bypass routing tables, send directly to HOST" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004728 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004729 "\n -m Max time-to-live (max number of hops)" \
4730 "\n -p Base UDP port number used in probes" \
4731 "\n (default 33434)" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004732 "\n -q Number of probes per TTL (default 3)" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004733 "\n -s IP address to use as the source address" \
4734 "\n -t Type-of-service in probe packets (default 0)" \
4735 "\n -w Time in seconds to wait for a response (default 3)" \
4736 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004737
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004738#define traceroute6_trivial_usage \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004739 "[-dnrv] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
4740 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-i IFACE]\n" \
4741 " HOST [BYTES]"
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004742#define traceroute6_full_usage "\n\n" \
4743 "Trace the route to HOST\n" \
4744 "\nOptions:" \
4745 "\n -d Set SO_DEBUG options to socket" \
4746 "\n -n Print numeric addresses" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004747 "\n -r Bypass routing tables, send directly to HOST" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004748 "\n -v Verbose" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004749 "\n -m Max time-to-live (max number of hops)" \
4750 "\n -p Base UDP port number used in probes" \
4751 "\n (default is 33434)" \
Denys Vlasenkob55d6522010-02-06 23:44:59 +01004752 "\n -q Number of probes per TTL (default 3)" \
Denys Vlasenko74f8e782009-11-23 06:34:04 +01004753 "\n -s IP address to use as the source address" \
4754 "\n -t Type-of-service in probe packets (default 0)" \
4755 "\n -w Time in seconds to wait for a response (default 3)" \
Leonid Lisovskiy4c065312009-11-23 06:20:09 +01004756
Eric Andersen7e9276b2001-02-22 01:15:47 +00004757#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004758 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004759#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004760 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004761#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004762 "$ true\n" \
4763 "$ echo $?\n" \
4764 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004765
Eric Andersen7e9276b2001-02-22 01:15:47 +00004766#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004767 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004768#define tty_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004769 "Print file name of stdin's terminal" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004770 IF_INCLUDE_SUSv2( "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004771 "\nOptions:" \
4772 "\n -s Print nothing, only return exit status" \
4773 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004774#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004775 "$ tty\n" \
4776 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004777
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004778#define ttysize_trivial_usage \
4779 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004780#define ttysize_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004781 "Print dimension(s) of stdin's terminal, on error return 80x25"
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004782
Denis Vlasenko39b68132009-01-23 02:07:14 +00004783#define tunctl_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004784 "[-f device] ([-t name] | -d name)" IF_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]")
Denis Vlasenko39b68132009-01-23 02:07:14 +00004785#define tunctl_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004786 "Create or delete tun interfaces\n" \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004787 "\nOptions:" \
4788 "\n -f name tun device (/dev/net/tun)" \
4789 "\n -t name Create iface 'name'" \
4790 "\n -d name Delete iface 'name'" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004791 IF_FEATURE_TUNCTL_UG( \
Denis Vlasenko39b68132009-01-23 02:07:14 +00004792 "\n -u owner Set iface owner" \
4793 "\n -g group Set iface group" \
4794 "\n -b Brief output" \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004795 )
Denis Vlasenko39b68132009-01-23 02:07:14 +00004796#define tunctl_example_usage \
4797 "# tunctl\n" \
4798 "# tunctl -d tun0\n"
4799
Mike Frysinger174808c2005-06-11 01:14:09 +00004800#define tune2fs_trivial_usage \
Denys Vlasenko3945bc12009-10-22 00:55:55 +02004801/* "[-c max-mounts-count] [-e errors-behavior] [-g group] " */ \
4802/* "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " */ \
4803/* "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " */ \
4804/* "[-r reserved-blocks-count] [-u user] [-C mount-count] " */ \
4805 "[-L LABEL] " \
4806/* "[-M last-mounted-dir] [-O [^]feature[,...]] " */ \
4807/* "[-T last-check-time] [-U UUID] " */ \
4808 "BLOCKDEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004809#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004810 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004811
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004812#define udhcpc_trivial_usage \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004813 "[-fbnqvoCR] [-i IFACE] [-r IP] [-s PROG] [-p PIDFILE]\n" \
4814 " [-H HOSTNAME] [-c CID] [-V VENDOR] [-O DHCP_OPT]..." IF_FEATURE_UDHCP_PORT(" [-P N]")
4815#define udhcpc_full_usage "\n" \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004816 IF_LONG_OPTS( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004817 "\n -i,--interface IFACE Interface to use (default eth0)" \
4818 "\n -p,--pidfile FILE Create pidfile" \
4819 "\n -r,--request IP IP address to request" \
4820 "\n -s,--script PROG Run PROG at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
4821 "\n -t,--retries N Send up to N discover packets" \
4822 "\n -T,--timeout N Pause between packets (default 3 seconds)" \
4823 "\n -A,--tryagain N Wait N seconds (default 20) after failure" \
4824 "\n -O,--request-option OPT Request DHCP option OPT (cumulative)" \
4825 "\n -o,--no-default-options Don't request any options (unless -O is given)" \
4826 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004827 USE_FOR_MMU( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004828 "\n -b,--background Background if lease is not obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004829 ) \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004830 "\n -S,--syslog Log to syslog too" \
4831 "\n -n,--now Exit if lease is not obtained" \
4832 "\n -q,--quit Exit after obtaining lease" \
4833 "\n -R,--release Release IP on exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004834 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004835 "\n -P,--client-port N Use port N (default 68)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004836 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004837 IF_FEATURE_UDHCPC_ARPING( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004838 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004839 ) \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004840 "\n -F,--fqdn NAME Ask server to update DNS mapping for NAME" \
4841 "\n -H,-h,--hostname NAME Send NAME as client hostname (default none)" \
4842 "\n -V,--vendorclass VENDOR Vendor identifier (default 'udhcp VERSION')" \
4843 "\n -c,--clientid CLIENTID Client identifier (default own MAC)" \
4844 "\n -C,--clientid-none Don't send client identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004845 ) \
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02004846 IF_NOT_LONG_OPTS( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004847 "\n -i IFACE Interface to use (default eth0)" \
Denys Vlasenko79ae5342010-01-06 12:27:18 +01004848 "\n -p FILE Create pidfile" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004849 "\n -r IP IP address to request" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004850 "\n -s PROG Run PROG at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")" \
4851 "\n -t N Send up to N discover packets" \
4852 "\n -T N Pause between packets (default 3 seconds)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004853 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004854 "\n -O OPT Request DHCP option OPT (cumulative)" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004855 "\n -o Don't request any options (unless -O is given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004856 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004857 USE_FOR_MMU( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004858 "\n -b Background if lease is not obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004859 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004860 "\n -S Log to syslog too" \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004861 "\n -n Exit if lease is not obtained" \
4862 "\n -q Exit after obtaining lease" \
4863 "\n -R Release IP on exit" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004864 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004865 "\n -P N Use port N (default 68)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004866 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004867 IF_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004868 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004869 ) \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004870 "\n -F NAME Ask server to update DNS mapping for NAME" \
4871 "\n -H,-h NAME Send NAME as client hostname (default none)" \
4872 "\n -V VENDOR Vendor identifier (default 'udhcp VERSION')" \
4873 "\n -c CLIENTID Client identifier (default own MAC)" \
4874 "\n -C Don't send client identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004875 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004876
Russ Dill61fb4892002-10-14 21:41:28 +00004877#define udhcpd_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004878 "[-fS]" IF_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004879
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004880#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004881 "DHCP server\n" \
4882 "\n -f Run in foreground" \
4883 "\n -S Log to syslog too" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004884 IF_FEATURE_UDHCP_PORT( \
Denys Vlasenko87fa2162010-03-20 18:06:23 +01004885 "\n -P N Use port N (default 67)" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004886 )
Russ Dill61fb4892002-10-14 21:41:28 +00004887
Eric Andersen7e9276b2001-02-22 01:15:47 +00004888#define umount_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004889 "[OPTIONS] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004890#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004891 "Unmount file systems\n" \
4892 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004893 IF_FEATURE_UMOUNT_ALL( \
4894 "\n -a Unmount all file systems" IF_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004895 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004896 IF_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004897 "\n -n Don't erase /etc/mtab entries" \
4898 ) \
4899 "\n -r Try to remount devices as read-only if mount is busy" \
4900 "\n -l Lazy umount (detach filesystem)" \
4901 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004902 IF_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004903 "\n -d Free loop device if it has been used" \
4904 )
4905
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004906#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004907 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004908
4909#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004910 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004911#define uname_full_usage "\n\n" \
Denys Vlasenko691161a2009-08-27 20:38:17 +02004912 "Print system information\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004913 "\nOptions:" \
4914 "\n -a Print all" \
4915 "\n -m The machine (hardware) type" \
4916 "\n -n Hostname" \
4917 "\n -r OS release" \
4918 "\n -s OS name (default)" \
4919 "\n -p Processor type" \
4920 "\n -v OS version" \
4921
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004922#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004923 "$ uname -a\n" \
4924 "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 +00004925
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004926#define uncompress_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01004927 "[-c] [-f] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004928#define uncompress_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004929 "Uncompress .Z file[s]\n" \
4930 "\nOptions:" \
4931 "\n -c Extract to stdout" \
4932 "\n -f Overwrite an existing file" \
Tim Riker7b253f82003-12-28 05:02:40 +00004933
Denis Vlasenko3952f202007-08-13 14:10:24 +00004934#define unexpand_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01004935 "[-f][-a][-t N] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004936#define unexpand_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01004937 "Convert spaces to tabs, writing to stdout\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004938 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004939 IF_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004940 "\n -a,--all Convert all blanks" \
4941 "\n -f,--first-only Convert only leading blanks" \
4942 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004943 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00004944 IF_NOT_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004945 "\n -a Convert all blanks" \
4946 "\n -f Convert only leading blanks" \
4947 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004948 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004949
Eric Andersen7e9276b2001-02-22 01:15:47 +00004950#define uniq_trivial_usage \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004951 "[-fscduw]... [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004952#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004953 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004954 "\nOptions:" \
4955 "\n -c Prefix lines by the number of occurrences" \
4956 "\n -d Only print duplicate lines" \
4957 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004958 "\n -f N Skip first N fields" \
4959 "\n -s N Skip first N chars (after any skipped fields)" \
4960 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004961
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004962#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004963 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4964 "a\n" \
4965 "b\n" \
4966 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004967
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004968#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004969 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004970#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004971 "Extract files from ZIP archives\n" \
4972 "\nOptions:" \
4973 "\n -l List archive contents (with -q for short form)" \
4974 "\n -n Never overwrite existing files (default)" \
4975 "\n -o Overwrite files without prompting" \
4976 "\n -p Send output to stdout" \
4977 "\n -q Quiet" \
4978 "\n -x Exclude these files" \
4979 "\n -d Extract files into this directory" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004980
Eric Andersen7e9276b2001-02-22 01:15:47 +00004981#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004982 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004983#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004984 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004985
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004986#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004987 "$ uptime\n" \
4988 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004989
4990#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004991 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004992#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004993 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004994
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004995#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004996 "$ usleep 1000000\n" \
4997 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004998
4999#define uudecode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01005000 "[-o OUTFILE] [INFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005001#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00005002 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005003 "Finds outfile name in uuencoded source unless -o is given"
5004
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005005#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005006 "$ uudecode -o busybox busybox.uu\n" \
5007 "$ ls -l busybox\n" \
5008 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005009
5010#define uuencode_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01005011 "[-m] [INFILE] STORED_FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005012#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005013 "Uuencode a file to stdout\n" \
5014 "\nOptions:" \
5015 "\n -m Use base64 encoding per RFC1521" \
5016
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005017#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005018 "$ uuencode busybox busybox\n" \
5019 "begin 755 busybox\n" \
5020 "<encoded file snipped>\n" \
5021 "$ uudecode busybox busybox > busybox.uu\n" \
5022 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005023
Eric Andersen853c4942003-01-23 05:59:32 +00005024#define vconfig_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005025 "COMMAND [OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005026#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005027 "Create and remove virtual ethernet devices\n" \
5028 "\nOptions:" \
5029 "\n add [interface-name] [vlan_id]" \
5030 "\n rem [vlan-name]" \
5031 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
5032 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
5033 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
5034 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00005035
Eric Andersen3f980402001-04-04 17:31:15 +00005036#define vi_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005037 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005038#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005039 "Edit FILE\n" \
5040 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005041 IF_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00005042 "\n -c Initial command to run ($EXINIT also available)") \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005043 IF_FEATURE_VI_READONLY( \
Denys Vlasenkod084cb92010-01-15 22:30:30 +01005044 "\n -R Read-only") \
Denis Vlasenko397de612008-03-17 08:55:44 +00005045 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00005046
Eric Andersen27f64e12002-06-23 04:24:25 +00005047#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005048 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005049#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005050 "Lock a virtual terminal. A password is required to unlock.\n" \
5051 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00005052 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00005053
Matthew Stoltenberg4803db52009-08-13 00:59:32 +02005054#define volname_trivial_usage \
5055 "[DEVICE]"
5056#define volname_full_usage "\n\n" \
5057 "Show CD volume name of the DEVICE (default /dev/cdrom)"
5058
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005059#define wall_trivial_usage \
Denys Vlasenko14b0f4f2009-12-05 02:44:34 +01005060 "[FILE]"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005061#define wall_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01005062 "Write content of FILE or stdin to all logged-in users"
Bernhard Reutner-Fischere039e682009-10-26 23:29:03 +01005063#define wall_sample_usage \
5064 "echo foo | wall\n" \
5065 "wall ./mymessage"
5066
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005067#define watch_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01005068 "[-n SEC] [-t] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005069#define watch_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005070 "Run PROG periodically\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005071 "\nOptions:" \
5072 "\n -n Loop period in seconds (default 2)" \
5073 "\n -t Don't print header" \
5074
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005075#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005076 "$ watch date\n" \
5077 "Mon Dec 17 10:31:40 GMT 2000\n" \
5078 "Mon Dec 17 10:31:42 GMT 2000\n" \
5079 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00005080
Eric Andersen7e9276b2001-02-22 01:15:47 +00005081#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005082 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005083#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005084 "Periodically write to watchdog device DEV\n" \
5085 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005086 "\n -T N Reboot after N seconds if not reset (default 60)" \
5087 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00005088 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00005089 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00005090 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005091
5092#define wc_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005093 "[OPTIONS] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005094#define wc_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01005095 "Print line, word, and byte counts for each FILE (or stdin),\n" \
5096 "and a total line if more than one FILE is specified\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005097 "\nOptions:" \
5098 "\n -c Print the byte counts" \
5099 "\n -l Print the newline counts" \
5100 "\n -L Print the length of the longest line" \
5101 "\n -w Print the word counts" \
5102
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005103#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005104 "$ wc /etc/passwd\n" \
5105 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005106
5107#define wget_trivial_usage \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005108 IF_FEATURE_WGET_LONG_OPTIONS( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00005109 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00005110 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
Bernhard Reutner-Fischer3fdba182010-02-10 19:37:29 +01005111 " [--no-check-certificate] [-U|--user-agent agent] url" \
Denis Vlasenko03630782007-10-18 11:11:12 +00005112 ) \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005113 IF_NOT_FEATURE_WGET_LONG_OPTIONS( \
Denis Vlasenko03630782007-10-18 11:11:12 +00005114 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
5115 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005116#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005117 "Retrieve files via HTTP or FTP\n" \
5118 "\nOptions:" \
5119 "\n -s Spider mode - only check file existence" \
5120 "\n -c Continue retrieval of aborted transfer" \
5121 "\n -q Quiet" \
5122 "\n -P Set directory prefix to DIR" \
5123 "\n -O Save to filename ('-' for stdout)" \
5124 "\n -U Adjust 'User-Agent' field" \
5125 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005126
5127#define which_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005128 "[COMMAND]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005129#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005130 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005131#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005132 "$ which login\n" \
5133 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00005134
Eric Andersen00a6a752002-04-26 23:53:10 +00005135#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00005136 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005137#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005138 "Show who is logged on\n" \
5139 "\nOptions:" \
5140 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00005141
5142#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005143 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005144#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005145 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005146
5147#define xargs_trivial_usage \
Denys Vlasenko125c2d22010-02-13 02:59:30 +01005148 "[OPTIONS] [PROG ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005149#define xargs_full_usage "\n\n" \
Denys Vlasenkobb169f42010-02-14 05:43:22 +01005150 "Run PROG on every item given by stdin\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005151 "\nOptions:" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005152 IF_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005153 "\n -p Ask user whether to run each command") \
Denys Vlasenko07697852009-10-06 21:11:37 +02005154 "\n -r Don't run command if input is empty" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005155 IF_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005156 "\n -0 Input is separated by NUL characters") \
5157 "\n -t Print the command on stderr before execution" \
Denis Vlasenkoe82da4d2008-08-21 19:59:30 +00005158 "\n -e[STR] STR stops input processing" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005159 "\n -n N Pass no more than N args to PROG" \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005160 "\n -s N Pass command line of no more than N bytes" \
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00005161 IF_FEATURE_XARGS_SUPPORT_TERMOPT( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00005162 "\n -x Exit if size is exceeded") \
Denis Vlasenko397de612008-03-17 08:55:44 +00005163
Eric Andersen0d3a02e2001-03-15 18:14:25 +00005164#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005165 "$ ls | xargs gzip\n" \
5166 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00005167
5168#define yes_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005169 "[OPTIONS] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005170#define yes_full_usage "\n\n" \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005171 "Repeatedly output a line with STRING, or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00005172
Eric Andersen7e9276b2001-02-22 01:15:47 +00005173#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00005174 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005175#define zcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00005176 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00005177
Rob Landleyad8071f2005-04-30 03:49:37 +00005178#define zcip_trivial_usage \
Denys Vlasenkob0bee2b2009-06-20 03:59:02 +02005179 "[OPTIONS] IFACE SCRIPT"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00005180#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005181 "Manage a ZeroConf IPv4 link-local address\n" \
5182 "\nOptions:" \
5183 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00005184 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00005185 "\n -r 169.254.x.x Request this address first" \
5186 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00005187 "\n" \
5188 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
5189 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00005190
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00005191
5192#endif