blob: d1847020b3894cbd28a2ed0d8eb3b791a8603579 [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 */
12
Eric Andersen178de172004-04-06 16:36:20 +000013#ifndef __BB_USAGE_H__
14#define __BB_USAGE_H__
15
Eric Andersenf349e972001-08-21 16:18:59 +000016#define addgroup_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +000017 "[-g GID] " USE_FEATURE_ADDUSER_TO_GROUP("[user_name] ") "group_name"
Eric Andersenf349e972001-08-21 16:18:59 +000018#define addgroup_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +000019 "Add a group " USE_FEATURE_ADDUSER_TO_GROUP("or add an user to a group") "\n" \
20 "\nOptions:" \
21 "\n -g GID Group id"
Eric Andersenf349e972001-08-21 16:18:59 +000022
23#define adduser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000024 "[OPTIONS] user_name"
Eric Andersenf349e972001-08-21 16:18:59 +000025#define adduser_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +000026 "Add an user\n" \
27 "\nOptions:" \
28 "\n -h DIR Home directory" \
29 "\n -g GECOS GECOS field" \
30 "\n -s SHELL Login shell" \
31 "\n -G GROUP Add user to existing group" \
32 "\n -S Create a system user" \
33 "\n -D Do not assign a password" \
34 "\n -H Do not create home directory" \
Eric Andersenf349e972001-08-21 16:18:59 +000035
Mark Whitley6f932772001-03-20 19:18:10 +000036#define adjtimex_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000037 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
Mark Whitley6f932772001-03-20 19:18:10 +000038#define adjtimex_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +000039 "Read and optionally set system timebase parameters. See adjtimex(2).\n" \
40 "\nOptions:" \
41 "\n -q Quiet" \
42 "\n -o offset Time offset, microseconds" \
43 "\n -f frequency Frequency adjust, integer kernel units (65536 is 1ppm)" \
44 "\n (positive values make clock run faster)" \
45 "\n -t tick Microseconds per tick, usually 10000" \
46 "\n -p timeconstant" \
Mark Whitley6f932772001-03-20 19:18:10 +000047
Eric Andersen7e9276b2001-02-22 01:15:47 +000048#define ar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000049 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Eric Andersen7e9276b2001-02-22 01:15:47 +000050#define ar_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +000051 "Extract or list FILES from an ar archive\n" \
52 "\nOptions:" \
53 "\n -o Preserve original dates" \
54 "\n -p Extract to stdout" \
55 "\n -t List" \
56 "\n -x Extract" \
57 "\n -v Verbose" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000058
Denis Vlasenkofa85b862007-01-07 01:24:12 +000059#define arp_trivial_usage \
60 "\n" \
61 "[-vn] [-H type] [-i if] -a [hostname]\n" \
62 "[-v] [-i if] -d hostname [pub]\n" \
63 "[-v] [-H type] [-i if] -s hostname hw_addr [temp]\n" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +000064 "[-v] [-H type] [-i if] -s hostname hw_addr [netmask nm] pub\n" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000065 "[-v] [-H type] [-i if] -Ds hostname ifa [netmask nm] pub\n"
66#define arp_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +000067 "Manipulate ARP cache\n" \
68 "\nOptions:" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000069 "\n -a Display (all) hosts" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000070 "\n -s Set new ARP entry" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000071 "\n -d Delete a specified entry" \
72 "\n -v Verbose" \
73 "\n -n Don't resolve names" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000074 "\n -i IF Network interface" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000075 "\n -D Read <hwaddr> from given device" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000076 "\n -A, -p AF Protocol family" \
Denis Vlasenko397de612008-03-17 08:55:44 +000077 "\n -H HWTYPE Hardware address type" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000078
Glenn L McGrath9e598412003-01-09 10:06:01 +000079#define arping_trivial_usage \
Denis Vlasenkof23c3f92007-11-23 09:27:05 +000080 "[-fqbDUA] [-c count] [-w timeout] [-I dev] [-s sender] target"
Glenn L McGrath9e598412003-01-09 10:06:01 +000081#define arping_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +000082 "Send ARP requests/replies\n" \
83 "\nOptions:" \
84 "\n -f Quit on first ARP reply" \
85 "\n -q Quiet" \
86 "\n -b Keep broadcasting, don't go unicast" \
87 "\n -D Duplicated address detection mode" \
88 "\n -U Unsolicited ARP mode, update your neighbors" \
89 "\n -A ARP answer mode, update your neighbors" \
90 "\n -c N Stop after sending N ARP requests" \
91 "\n -w timeout Time to wait for ARP reply, in seconds" \
92 "\n -I dev Interface to use (default eth0)" \
93 "\n -s sender Sender IP address" \
94 "\n target Target IP address" \
Glenn L McGrath9e598412003-01-09 10:06:01 +000095
Eric Andersen08f59e32004-03-12 22:07:10 +000096#define ash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000097 "[FILE]...\n" \
98 "or: ash -c command [args]..."
Eric Andersen08f59e32004-03-12 22:07:10 +000099#define ash_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000100 "The ash shell"
Eric Andersen08f59e32004-03-12 22:07:10 +0000101
102#define awk_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000103 "[OPTION]... [program-text] [FILE...]"
Eric Andersen08f59e32004-03-12 22:07:10 +0000104#define awk_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000105 "Options:" \
106 "\n -v var=val Set variable" \
107 "\n -F sep Use sep as field separator" \
108 "\n -f file Read program from file" \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +0000109
Eric Andersen7e9276b2001-02-22 01:15:47 +0000110#define basename_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000111 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000112#define basename_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000113 "Strip directory path and suffixes from FILE.\n" \
114 "If specified, also remove any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000115#define basename_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000116 "$ basename /usr/local/bin/foo\n" \
117 "foo\n" \
118 "$ basename /usr/local/bin/\n" \
119 "bin\n" \
120 "$ basename /foo/bar.txt .txt\n" \
121 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000122
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000123#define fbsplash_trivial_usage \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000124 "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000125#define fbsplash_full_usage \
126 "Options:\n" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000127 "\n -s Image" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000128 "\n -c Hide cursor" \
129 "\n -d Framebuffer device (default /dev/fb0)" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000130 "\n -i Config file (var=value):" \
131 "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT" \
132 "\n BAR_R,BAR_G,BAR_B" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000133 "\n -f Control pipe (else exit after drawing image)" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000134 "\n commands: 'NN' (% for progress bar) or 'exit'" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000135
Bernhard Reutner-Fischerd27d9252008-01-13 15:23:27 +0000136#define brctl_trivial_usage \
137 "COMMAND [BRIDGE [INTERFACE]]"
138#define brctl_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000139 "Manage ethernet bridges.\n" \
140 "\nCommands:" \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000141 USE_FEATURE_BRCTL_SHOW( \
142 "\n show Show a list of bridges" \
143 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000144 "\n addbr BRIDGE Create BRIDGE" \
145 "\n delbr BRIDGE Delete BRIDGE" \
146 "\n addif BRIDGE IFACE Add IFACE to BRIDGE" \
147 "\n delif BRIDGE IFACE Delete IFACE from BRIDGE" \
148 USE_FEATURE_BRCTL_FANCY( \
149 "\n setageing BRIDGE TIME Set ageing time" \
150 "\n setfd BRIDGE TIME Set bridge forward delay" \
151 "\n sethello BRIDGE TIME Set hello time" \
152 "\n setmaxage BRIDGE TIME Set max message age" \
153 "\n setpathcost BRIDGE COST Set path cost" \
154 "\n setportprio BRIDGE PRIO Set port priority" \
155 "\n setbridgeprio BRIDGE PRIO Set bridge priority" \
156 "\n stp BRIDGE [1|0] STP on/off" \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000157 ) \
158
Glenn L McGrath24e28332001-10-05 03:48:57 +0000159#define bunzip2_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000160 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000161#define bunzip2_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000162 "Uncompress FILE (or standard input if FILE is '-' or omitted)\n" \
163 "\nOptions:" \
164 "\n -c Write to standard output" \
165 "\n -f Force" \
Glenn L McGrath24e28332001-10-05 03:48:57 +0000166
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000167#define bzip2_trivial_usage \
168 "[OPTION]... [FILE]..."
169#define bzip2_full_usage \
170 "Compress FILE(s) with bzip2 algorithm.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000171 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n" \
172 "\nOptions:" \
173 "\n -c Write to standard output" \
174 "\n -d Decompress" \
175 "\n -f Force" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000176 "\n -1..-9 Compression level" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000177
Rob Landley6130b9b2006-01-23 21:10:38 +0000178#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000179 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000180
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000181#define bzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000182 "FILE"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000183#define bzcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000184 "Uncompress to stdout"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000185
Rob Landleyc1d69902006-01-20 18:28:50 +0000186#define unlzma_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000187 "[OPTION]... [FILE]"
Rob Landleyc1d69902006-01-20 18:28:50 +0000188#define unlzma_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000189 "Uncompress FILE (or standard input if FILE is '-' or omitted)\n" \
190 "\nOptions:" \
191 "\n -c Write to standard output" \
192 "\n -f Force" \
Rob Landleyc1d69902006-01-20 18:28:50 +0000193
194#define lzmacat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000195 "FILE"
Rob Landleyc1d69902006-01-20 18:28:50 +0000196#define lzmacat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000197 "Uncompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000198
Eric Andersenc98c0622001-12-06 15:16:43 +0000199#define cal_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000200 "[-jy] [[month] year]"
Eric Andersenc98c0622001-12-06 15:16:43 +0000201#define cal_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000202 "Display a calendar\n" \
203 "\nOptions:" \
204 "\n -j Use julian dates" \
205 "\n -y Display the entire year" \
Eric Andersenc98c0622001-12-06 15:16:43 +0000206
Eric Andersen7e9276b2001-02-22 01:15:47 +0000207#define cat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000208 "[-u] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000209#define cat_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000210 "Concatenate FILE(s) and print them to stdout\n" \
211 "\nOptions:" \
212 "\n -u Use unbuffered i/o (ignored)" \
213
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000214#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000215 "$ cat /proc/uptime\n" \
216 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000217
Rob Landley8abbee42006-05-31 19:36:04 +0000218#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000219 "[-etv] [FILE]..."
Rob Landley8abbee42006-05-31 19:36:04 +0000220#define catv_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000221 "Display nonprinting characters as ^x or M-x\n" \
222 "\nOptions:" \
223 "\n -e End each line with $" \
224 "\n -t Show tabs as ^I" \
225 "\n -v Don't use ^x or M-x escapes" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000226
227#define chat_trivial_usage \
228 "EXPECT [SEND [EXPECT [SEND...]]]"
229#define chat_full_usage \
230 "Useful for interacting with a modem connected to stdin/stdout.\n" \
231 "A script consists of one or more \"expect-send\" pairs of strings,\n" \
232 "each pair is a pair of arguments. Example:\n" \
233 "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \
234
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000235#define chattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000236 "[-R] [-+=AacDdijsStTu] [-v version] files..."
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000237#define chattr_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000238 "Change file attributes on an ext2 fs\n" \
239 "\nModifiers:" \
240 "\n - Remove attributes" \
241 "\n + Add attributes" \
242 "\n = Set attributes" \
243 "\nAttributes:" \
244 "\n A Don't track atime" \
245 "\n a Append mode only" \
246 "\n c Enable compress" \
247 "\n D Write dir contents synchronously" \
248 "\n d Do not backup with dump" \
249 "\n i Cannot be modified (immutable)" \
250 "\n j Write all data to journal first" \
251 "\n s Zero disk storage when deleted" \
252 "\n S Write file contents synchronously" \
253 "\n t Disable tail-merging of partial blocks with other files" \
254 "\n u Allow file to be undeleted" \
255 "\nOptions:" \
256 "\n -R Recursively list subdirectories" \
257 "\n -v Set the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000258
Denis Vlasenko49622d72007-03-10 16:58:49 +0000259#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000260 "[OPTIONS] CONTEXT FILE..." \
261 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
262 USE_FEATURE_CHCON_LONG_OPTIONS( \
263 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
264 )
Denis Vlasenko49622d72007-03-10 16:58:49 +0000265#define chcon_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000266 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000267 USE_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000268 "\n -v,--verbose Verbose" \
269 "\n -c,--changes Report changes made" \
270 "\n -h,--no-dereference Affect symlinks instead of their targets" \
271 "\n -f,--silent,--quiet Suppress most error messages" \
272 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
273 "\n -u,--user=USER Set user/role/type/range in the target" \
274 "\n -r,--role=ROLE security context" \
275 "\n -t,--type=TYPE" \
276 "\n -l,--range=RANGE" \
277 "\n -R,--recursive Recurse subdirectories" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000278 ) \
279 SKIP_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000280 "\n -v Verbose" \
281 "\n -c Report changes made" \
282 "\n -h Affect symlinks instead of their targets" \
283 "\n -f Suppress most error messages" \
284 "\n -u USER Set user/role/type/range in the target security context" \
285 "\n -r ROLE" \
286 "\n -t TYPE" \
287 "\n -l RNG" \
288 "\n -R Recurse subdirectories" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000289 )
290
Eric Andersen7e9276b2001-02-22 01:15:47 +0000291#define chmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000292 "[-R"USE_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000293#define chmod_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000294 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000295 "symbols +-= and one or more of the letters rwxst\n" \
296 "\nOptions:" \
297 "\n -R Recurse directories" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000298 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000299 "\n -c List changed files" \
300 "\n -v List all files" \
301 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000302 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000303#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000304 "$ ls -l /tmp/foo\n" \
305 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
306 "$ chmod u+x /tmp/foo\n" \
307 "$ ls -l /tmp/foo\n" \
308 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
309 "$ chmod 444 /tmp/foo\n" \
310 "$ ls -l /tmp/foo\n" \
311 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000312
Denis Vlasenko081ef792007-03-17 16:38:21 +0000313#define chgrp_trivial_usage \
314 "[-RhLHP"USE_DESKTOP("cvf")"]... GROUP FILE..."
315#define chgrp_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000316 "Change the group membership of each FILE to GROUP\n" \
317 "\nOptions:" \
318 "\n -R Recurse directories" \
319 "\n -h Affect symlinks instead of symlink targets" \
320 "\n -L Traverse all symlinks to directories" \
321 "\n -H Traverse symlinks on command line only" \
322 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000323 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000324 "\n -c List changed files" \
325 "\n -v Verbose" \
326 "\n -f Hide errors" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000327 )
328#define chgrp_example_usage \
329 "$ ls -l /tmp/foo\n" \
330 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
331 "$ chgrp root /tmp/foo\n" \
332 "$ ls -l /tmp/foo\n" \
333 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
334
Eric Andersen7e9276b2001-02-22 01:15:47 +0000335#define chown_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000336 "[-RhLHP"USE_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000337#define chown_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000338 "Change the owner and/or group of each FILE to OWNER and/or GROUP\n" \
339 "\nOptions:" \
340 "\n -R Recurse directories" \
341 "\n -h Affect symlinks instead of symlink targets" \
342 "\n -L Traverse all symlinks to directories" \
343 "\n -H Traverse symlinks on command line only" \
344 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000345 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000346 "\n -c List changed files" \
347 "\n -v List all files" \
348 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000349 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000350#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000351 "$ ls -l /tmp/foo\n" \
352 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
353 "$ chown root /tmp/foo\n" \
354 "$ ls -l /tmp/foo\n" \
355 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
356 "$ chown root.root /tmp/foo\n" \
357 "ls -l /tmp/foo\n" \
358 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000359
Denis Vlasenkofe544582006-10-03 15:57:40 +0000360#define chpst_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000361 "[-vP012] [-u user[:group]] [-U user[:group]] [-e dir] " \
362 "[-/ dir] [-n nice] [-m bytes] [-d bytes] [-o files] " \
363 "[-p processes] [-f bytes] [-c bytes] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000364#define chpst_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000365 "Change the process state and run specified program\n" \
366 "\nOptions:" \
367 "\n -u USER[:GRP] Set uid and gid" \
368 "\n -U USER[:GRP] Set $UID and $GID in environment" \
369 "\n -e DIR Set environment variables as specified by files" \
370 "\n in DIR: file=1st_line_of_file" \
371 "\n -/ DIR Chroot to DIR" \
372 "\n -n INC Add INC to nice value" \
373 "\n -m BYTES Limit data segment, stack segment, locked physical pages," \
374 "\n and total of all segment per process to BYTES each" \
375 "\n -d BYTES Limit data segment" \
376 "\n -o N Limit the number of open file descriptors per process to N" \
377 "\n -p N Limit number of processes per uid to N" \
378 "\n -f BYTES Limit output file size to BYTES" \
379 "\n -c BYTES Limit core file size to BYTES" \
380 "\n -v Verbose" \
381 "\n -P Run prog in a new process group" \
382 "\n -0 Close standard input" \
383 "\n -1 Close standard output" \
384 "\n -2 Close standard error" \
385
Denis Vlasenkofe544582006-10-03 15:57:40 +0000386#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000387 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000388#define setuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000389 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
390 "groups, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000391#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000392 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000393#define envuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000394 "Set $UID to account's uid and $GID to account's gid, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000395#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000396 "dir prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000397#define envdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000398 "Set various environment variables as specified by files\n" \
399 "in the directory dir, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000400#define softlimit_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000401 "[-a allbytes] [-c corebytes] [-d databytes] [-f filebytes] " \
402 "[-l lockbytes] [-m membytes] [-o openfiles] [-p processes] " \
403 "[-r residentbytes] [-s stackbytes] [-t cpusecs] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000404#define softlimit_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000405 "Set soft resource limits, then run prog\n" \
406 "\nOptions:" \
407 "\n -m n Same as -d n -s n -l n -a n" \
408 "\n -d n Limit the data segment per process to n bytes" \
409 "\n -s n Limit the stack segment per process to n bytes" \
410 "\n -l n Limit the locked physical pages per process to n bytes" \
411 "\n -a n Limit the total of all segments per process to n bytes" \
412 "\n -o n Limit the number of open file descriptors per process to n" \
413 "\n -p n Limit the number of processes per uid to n" \
414 "\nOptions controlling file sizes:" \
415 "\n -f n Limit output file sizes to n bytes" \
416 "\n -c n Limit core file sizes to n bytes" \
417 "\nEfficiency opts:" \
418 "\n -r n Limit the resident set size to n bytes. This limit is not" \
419 "\n enforced unless physical memory is full" \
420 "\n -t n Limit the CPU time to n seconds. This limit is not enforced" \
421 "\n except that the process receives a SIGXCPU signal after n seconds" \
422 "\n" \
423 "\nSome options may have no effect on some operating systems" \
424 "\nn may be =, indicating that soft limit should be set equal to hard limit" \
Denis Vlasenkofe544582006-10-03 15:57:40 +0000425
Eric Andersen7e9276b2001-02-22 01:15:47 +0000426#define chroot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000427 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000428#define chroot_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000429 "Run COMMAND with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000430#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000431 "$ ls -l /bin/ls\n" \
432 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
433 "# mount /dev/hdc1 /mnt -t minix\n" \
434 "# chroot /mnt\n" \
435 "# ls -l /bin/ls\n" \
436 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000437
Eric Andersen7e9276b2001-02-22 01:15:47 +0000438#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000439 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000440#define chvt_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000441 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000442
Rob Landley856489b2006-04-18 20:57:28 +0000443#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000444 "FILES..."
Rob Landley856489b2006-04-18 20:57:28 +0000445#define cksum_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000446 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000447
Eric Andersen7e9276b2001-02-22 01:15:47 +0000448#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000449 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000450#define clear_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000451 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000452
Eric Andersen7e9276b2001-02-22 01:15:47 +0000453#define cmp_trivial_usage \
Denis Vlasenko9a1fa8c2007-03-21 22:30:14 +0000454 "[-l] [-s] FILE1 [FILE2" USE_DESKTOP(" [SKIP1 [SKIP2]") "]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000455#define cmp_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000456 "Compares FILE1 vs stdin if FILE2 is not specified\n" \
457 "\nOptions:" \
458 "\n -l Write the byte numbers (decimal) and values (octal)" \
459 "\n for all differing bytes" \
460 "\n -s Quiet" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000461
Rob Landley2acfd7b2005-05-11 23:12:49 +0000462#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000463 "[-123] FILE1 FILE2"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000464#define comm_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000465 "Compare FILE1 to FILE2, or to stdin if - is specified\n" \
466 "\nOptions:" \
467 "\n -1 Suppress lines unique to FILE1" \
468 "\n -2 Suppress lines unique to FILE2" \
469 "\n -3 Suppress lines common to both files" \
Rob Landley2acfd7b2005-05-11 23:12:49 +0000470
Paul Fox79c142d2005-08-01 16:04:40 +0000471#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000472 ""
Paul Fox79c142d2005-08-01 16:04:40 +0000473#define bbconfig_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000474 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000475
Rob Landley69674942006-09-11 00:34:01 +0000476#define bbsh_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000477 "[FILE]...\n" \
478 "or: bbsh -c command [args]..."
Rob Landley69674942006-09-11 00:34:01 +0000479#define bbsh_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000480 "The bbsh shell (command interpreter)"
Rob Landley69674942006-09-11 00:34:01 +0000481
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000482#define chrt_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000483 "[OPTION]... [prio] [pid | command [arg]...]"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000484#define chrt_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000485 "Manipulate real-time attributes of a process\n" \
486 "\nOptions:" \
487 "\n -p Operate on pid" \
488 "\n -r Set scheduling policy to SCHED_RR" \
489 "\n -f Set scheduling policy to SCHED_FIFO" \
490 "\n -o Set scheduling policy to SCHED_OTHER" \
491 "\n -m Show min and max priorities" \
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000492
493#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000494 "$ chrt -r 4 sleep 900; x=$!\n" \
495 "$ chrt -f -p 3 $x\n" \
496 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000497
Eric Andersen7e9276b2001-02-22 01:15:47 +0000498#define cp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000499 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000500#define cp_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000501 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY\n" \
502 "\nOptions:" \
503 "\n -a Same as -dpR" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000504 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000505 "\n -c Preserve security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000506 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000507 "\n -d,-P Preserve links" \
508 "\n -H,-L Dereference all symlinks (default)" \
509 "\n -p Preserve file attributes if possible" \
510 "\n -f Force overwrite" \
511 "\n -i Prompt before overwrite" \
512 "\n -R,-r Recurse directories" \
513 "\n -l,-s Create (sym)links" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000514
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000515#define cpio_trivial_usage \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000516 "-[dim" USE_FEATURE_CPIO_O("o") "tuv][F cpiofile]" \
517 USE_FEATURE_CPIO_O( "[H newc]" )
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000518#define cpio_full_usage \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000519 "Extract or list files from a cpio archive" \
520 USE_FEATURE_CPIO_O( ", or create a cpio archive" ) \
521 "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000522 "Main operation mode:" \
523 "\n d Make leading directories" \
524 "\n i Extract" \
525 "\n m Preserve mtime" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000526 USE_FEATURE_CPIO_O( \
527 "\n o Create" \
528 "\n H newc Define format" \
529 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000530 "\n t List" \
531 "\n v Verbose" \
532 "\n u Unconditional overwrite" \
533 "\n F Input from file" \
Tim Riker7b253f82003-12-28 05:02:40 +0000534
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000535#define crond_trivial_usage \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000536 "-fbS -l N " USE_DEBUG_CROND_OPTION("-d N ") "-L LOGFILE -c DIR"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000537#define crond_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000538 " -f Foreground" \
539 "\n -b Background (default)" \
540 "\n -S Log to syslog (default)" \
541 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000542 USE_DEBUG_CROND_OPTION( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000543 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000544 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000545 "\n -L Log to file" \
546 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000547
548#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000549 "[-c DIR] [-u USER] [-ler]|[FILE]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000550#define crontab_full_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000551 " -c Crontab directory" \
552 "\n -u User" \
553 "\n -l List crontab" \
554 "\n -e Edit crontab" \
555 "\n -r Delete crontab" \
556 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000557
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000558#define cryptpw_trivial_usage \
559 "[-a des|md5] [string]"
560#define cryptpw_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000561 "Output crypted string.\n" \
562 "If string isn't supplied on cmdline, read it from stdin.\n" \
563 "\nOptions:" \
564 "\n -a Algorithm to use (default: md5)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000565
Eric Andersen7e9276b2001-02-22 01:15:47 +0000566#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000567 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000568#define cut_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000569 "Print selected fields from each input FILE to standard output\n" \
570 "\nOptions:" \
571 "\n -b LIST Output only bytes from LIST" \
572 "\n -c LIST Output only characters from LIST" \
573 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
574 "\n -s Output only the lines containing delimiter" \
575 "\n -f N Print only these fields" \
576 "\n -n Ignored" \
577
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000578#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000579 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
580 "Hello\n" \
581 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
582 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000583
Eric Andersen7e9276b2001-02-22 01:15:47 +0000584#define date_trivial_usage \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000585 "[OPTION]... [+FMT] [TIME]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000586#define date_full_usage \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000587 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000588 "\nOptions:" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000589 "\n -u Work in UTC (don't convert to local time)" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000590 "\n -R Output RFC-822 compliant date string" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000591 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000592 "\n -I[SPEC] Output ISO-8601 compliant date string" \
593 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000594 "\n 'hours', 'minutes', or 'seconds' for date and" \
595 "\n time to the indicated precision" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000596 ) \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000597 "\n -d TIME Display TIME, not 'now'" \
598 "\n -r FILE Display last modification time of FILE" \
599 "\n [-s] TIME Set time to TIME" \
600 USE_FEATURE_DATE_ISOFMT( \
601 "\n -D FMT Use FMT for str->date conversion" \
602 ) \
603 "\n" \
604 "\nRecognized formats for TIME:" \
605 "\n [hh:]mm:ss" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000606 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000607 "\n MMDDhhmm[[YY]YY][.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000608
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000609#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000610 "$ date\n" \
611 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000612
Eric Andersen7e9276b2001-02-22 01:15:47 +0000613#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000614 "expression..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000615#define dc_full_usage \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +0000616 "Tiny RPN calculator. Operations:\n" \
617 "+, add, -, sub, *, mul, /, div, %, mod, **, exp, and, or, not, eor,\n" \
618 "p - print top of the stack (without altering the stack),\n" \
619 "f - print entire stack, o - pop the value and set output radix\n" \
620 "(value must be 10 or 16).\n" \
621 "Examples: 'dc 2 2 add' -> 4, 'dc 8 8 * 2 2 + /' -> 16.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000622
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000623#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000624 "$ dc 2 2 + p\n" \
625 "4\n" \
626 "$ dc 8 8 \\* 2 2 + / p\n" \
627 "16\n" \
628 "$ dc 0 1 and p\n" \
629 "0\n" \
630 "$ dc 0 1 or p\n" \
631 "1\n" \
632 "$ echo 72 9 div 8 mul p | dc\n" \
633 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000634
Eric Andersen7e9276b2001-02-22 01:15:47 +0000635#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000636 "[if=FILE] [of=FILE] " USE_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000637 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000638#define dd_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000639 "Copy a file with converting and formatting\n" \
640 "\nOptions:" \
641 "\n if=FILE Read from FILE instead of stdin" \
642 "\n of=FILE Write to FILE instead of stdout" \
643 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000644 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000645 "\n ibs=N Read N bytes at a time" \
646 ) \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000647 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000648 "\n obs=N Write N bytes at a time" \
649 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000650 "\n count=N Copy only N input blocks" \
651 "\n skip=N Skip N input blocks" \
652 "\n seek=N Skip N output blocks" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000653 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000654 "\n conv=notrunc Don't truncate output file" \
655 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000656 "\n conv=sync Pad blocks with zeros" \
657 "\n conv=fsync Physically write data out before finishing" \
658 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000659 "\n" \
660 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
661 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
662
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000663#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000664 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
665 "4+0 records in\n" \
666 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000667
Eric Andersen7e9276b2001-02-22 01:15:47 +0000668#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000669 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000670#define deallocvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000671 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000672
Eric Andersenf349e972001-08-21 16:18:59 +0000673#define delgroup_trivial_usage \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000674 USE_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Eric Andersenf349e972001-08-21 16:18:59 +0000675#define delgroup_full_usage \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000676 "Delete group GROUP from the system" \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000677 USE_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000678
679#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000680 "USER"
Eric Andersenf349e972001-08-21 16:18:59 +0000681#define deluser_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000682 "Delete user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000683
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000684#define devfsd_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000685 "mntpnt [-v]" USE_DEVFSD_FG_NP("[-fg][-np]")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000686#define devfsd_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000687 "Manage devfs permissions and old device name symlinks\n" \
688 "\nOptions:" \
689 "\n mntpnt The mount point where devfs is mounted" \
690 "\n -v Print the protocol version numbers for devfsd" \
691 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000692 USE_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000693 "\n -fg Run in foreground" \
694 "\n -np Exit after parsing the configuration file" \
695 "\n and processing synthetic REGISTER events," \
696 "\n do not poll for events" \
697 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000698
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000699/* -k is accepted but ignored for !HUMAN_READABLE,
700 * but we won't mention this (unimportant) */
701#if ENABLE_FEATURE_HUMAN_READABLE || ENABLE_FEATURE_DF_INODE
702#define DF_HAS_OPTIONS(x) x
703#else
704#define DF_HAS_OPTIONS(x)
705#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000706#define df_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000707 DF_HAS_OPTIONS("[-") \
708 USE_FEATURE_HUMAN_READABLE("hmk") USE_FEATURE_DF_INODE("i") \
709 DF_HAS_OPTIONS("] ") "[FILESYSTEM...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000710#define df_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000711 "Print filesystem usage statistics\n" \
712 DF_HAS_OPTIONS("\nOptions:") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000713 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000714 "\n -h Human readable (e.g. 1K 243M 2G)" \
715 "\n -m 1024*1024 blocks" \
716 "\n -k 1024 blocks" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000717 ) \
718 USE_FEATURE_DF_INODE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000719 "\n -i Inodes" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000720 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000721#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000722 "$ df\n" \
723 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
724 "/dev/sda3 8690864 8553540 137324 98% /\n" \
725 "/dev/sda1 64216 36364 27852 57% /boot\n" \
726 "$ df /dev/sda3\n" \
727 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
728 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000729
Denis Vlasenko736230e2006-11-20 19:40:36 +0000730#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000731 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000732#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000733 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000734
735#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000736 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000737#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000738 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000739
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000740#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000741 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000742#define diff_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000743 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000744 "This implementation supports unified diffs only.\n" \
745 "\nOptions:" \
746 "\n -a Treat all files as text" \
747 "\n -b Ignore changes in the amount of whitespace" \
748 "\n -d Try hard to find a smaller set of changes" \
749 "\n -i Ignore case differences" \
750 "\n -L Use LABEL instead of the filename in the unified header" \
751 "\n -N Treat absent files as empty" \
752 "\n -q Output only whether files differ" \
753 "\n -r Recursively compare subdirectories" \
754 "\n -S Start with FILE when comparing directories" \
755 "\n -T Make tabs line up by prefixing a tab when necessary" \
756 "\n -s Report when two files are the same" \
757 "\n -t Expand tabs to spaces in output" \
758 "\n -U Output LINES lines of context" \
759 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000760
Eric Andersen7e9276b2001-02-22 01:15:47 +0000761#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000762 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000763#define dirname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000764 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000765#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000766 "$ dirname /tmp/foo\n" \
767 "/tmp\n" \
768 "$ dirname /tmp/foo/\n" \
769 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000770
Eric Andersen7e9276b2001-02-22 01:15:47 +0000771#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000772 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000773#define dmesg_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000774 "Print or control the kernel ring buffer\n" \
775 "\nOptions:" \
776 "\n -c Clear ring buffer after printing" \
777 "\n -n LEVEL Set console logging level" \
778 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000779
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000780#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000781 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000782#define dnsd_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000783 "Small static DNS server daemon\n" \
784 "\nOptions:" \
785 "\n -c Config filename" \
786 "\n -t TTL in seconds" \
787 "\n -p Listening port" \
788 "\n -i Listening ip (default all)" \
789 "\n -d Daemonize" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000790
Eric Andersen7e9276b2001-02-22 01:15:47 +0000791#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000792 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000793#define dos2unix_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000794 "Convert FILE from dos to unix format.\n" \
795 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000796 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000797 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000798 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000799
Eric Andersen7e9276b2001-02-22 01:15:47 +0000800#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000801 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000802#define dpkg_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000803 "Install, remove and manage Debian packages\n" \
804 "\nOptions:" \
805 "\n -i Install the package" \
806 "\n -l List of installed packages" \
807 "\n -C Configure an unpackaged package" \
808 "\n -F depends Ignore dependency problems" \
809 "\n -P Purge all files of a package" \
810 "\n -r Remove all but the configuration files for a package" \
811 "\n -u Unpack a package, but don't configure it" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000812
Eric Andersen7e9276b2001-02-22 01:15:47 +0000813#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000814 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000815#define dpkg_deb_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000816 "Perform actions on Debian packages (.debs)\n" \
817 "\nOptions:" \
818 "\n -c List contents of filesystem tree" \
819 "\n -e Extract control files to [argument] directory" \
820 "\n -f Display control field name starting with [argument]" \
821 "\n -x Extract packages filesystem tree to directory" \
822 "\n -X Verbose extract" \
823
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000824#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000825 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000826
Eric Andersen7e9276b2001-02-22 01:15:47 +0000827#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000828 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000829#define du_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000830 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000831 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000832 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
833 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000834 " bytes.\n" \
835 "\nOptions:" \
836 "\n -a Show file sizes too" \
837 "\n -H Follow symlinks on command line" \
838 "\n -L Follow all symlinks" \
839 "\n -d N Limit output to directories (and files with -a) of depth < N" \
840 "\n -c Show grand total" \
841 "\n -l Count sizes many times if hard linked" \
842 "\n -s Display only a total for each argument" \
843 "\n -x Skip directories on different filesystems" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000844 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000845 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
846 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000847 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000848 "\n -k Sizes in kilobytes" \
849 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
850
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000851#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000852 "$ du\n" \
853 "16 ./CVS\n" \
854 "12 ./kernel-patches/CVS\n" \
855 "80 ./kernel-patches\n" \
856 "12 ./tests/CVS\n" \
857 "36 ./tests\n" \
858 "12 ./scripts/CVS\n" \
859 "16 ./scripts\n" \
860 "12 ./docs/CVS\n" \
861 "104 ./docs\n" \
862 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000863
Eric Andersen7e9276b2001-02-22 01:15:47 +0000864#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000865 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000866#define dumpkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000867 "Print out a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000868#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000869 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000870
Russ Dill61fb4892002-10-14 21:41:28 +0000871#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000872 "[-r|-a] [-f LEASEFILE]"
Russ Dill61fb4892002-10-14 21:41:28 +0000873#define dumpleases_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000874 "Display DHCP leases granted by udhcpd\n" \
875 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000876 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000877 "\n -f,--file=FILE Leases file to load" \
878 "\n -r,--remaining Interpret lease times as time remaining" \
879 "\n -a,--absolute Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000880 ) \
881 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000882 "\n -f FILE Leases file to load" \
883 "\n -r Interpret lease times as time remaining" \
884 "\n -a Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000885 )
Russ Dill61fb4892002-10-14 21:41:28 +0000886
Mike Frysinger51a43b42005-09-24 07:11:16 +0000887#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000888 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
889 "[-I inode_buffer_blocks] [-P process_inode_size] " \
890 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
891 "[-E extended-options] device"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000892#define e2fsck_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000893 "Check ext2/ext3 file system\n" \
894 "\nOptions:" \
895 "\n -p Automatic repair (no questions)" \
896 "\n -n Make no changes to the filesystem" \
897 "\n -y Assume 'yes' to all questions" \
898 "\n -c Check for bad blocks and add them to the badblock list" \
899 "\n -f Force checking even if filesystem is marked clean" \
900 "\n -v Verbose" \
901 "\n -b superblock Use alternative superblock" \
902 "\n -B blocksize Force blocksize when looking for superblock" \
903 "\n -j journal Set location of the external journal" \
904 "\n -l file Add to badblocks list" \
905 "\n -L file Set badblocks list" \
Mike Frysinger51a43b42005-09-24 07:11:16 +0000906
Eric Andersen7e9276b2001-02-22 01:15:47 +0000907#define echo_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000908 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000909#define echo_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000910 "Print the specified ARGs to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000911 USE_FEATURE_FANCY_ECHO( "\n" \
912 "\nOptions:" \
913 "\n -n Suppress trailing newline" \
914 "\n -e Interpret backslash-escaped characters (i.e., \\t=tab)" \
915 "\n -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000916 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000917#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000918 "$ echo \"Erik is cool\"\n" \
919 "Erik is cool\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000920 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000921 "Erik\n" \
922 "is\n" \
923 "cool\n" \
924 "$ echo \"Erik\\nis\\ncool\"\n" \
925 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000926
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000927#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000928 "[-t] [-T] [DEVICE]"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000929#define eject_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000930 "Eject specified DEVICE (or default /dev/cdrom)\n" \
931 "\nOptions:" \
932 USE_FEATURE_EJECT_SCSI( \
933 "\n -s SCSI device" \
934 ) \
935 "\n -t Close tray" \
936 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000937
Rob Landley3b890392006-05-04 20:56:43 +0000938#define ed_trivial_usage ""
939#define ed_full_usage ""
940
Eric Andersen84e229c2001-03-29 22:48:33 +0000941#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000942 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000943#define env_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000944 "Print the current environment or run a program after setting\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000945 "up the specified environment\n" \
946 "\nOptions:" \
947 "\n -, -i Start with an empty environment" \
948 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +0000949
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000950#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000951 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000952#define ether_wake_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000953 "Send a magic packet to wake up sleeping machines.\n" \
954 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000955 "a hostname with a known 'ethers' entry.\n" \
956 "\nOptions:" \
957 "\n -b Send wake-up packet to the broadcast address" \
958 "\n -i iface Interface to use (default eth0)" \
959 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000960
Denis Vlasenko3952f202007-08-13 14:10:24 +0000961#define expand_trivial_usage \
962 "[-i] [-t NUM] [FILE|-]"
963#define expand_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000964 "Convert tabs to spaces, writing to standard output.\n" \
965 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000966 USE_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000967 "\n -i,--initial Do not convert tabs after non blanks" \
968 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000969 ) \
970 SKIP_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000971 "\n -i Do not convert tabs after non blanks" \
972 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000973 )
Denis Vlasenko3952f202007-08-13 14:10:24 +0000974
Eric Andersen7e9276b2001-02-22 01:15:47 +0000975#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000976 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000977#define expr_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000978 "Print the value of EXPRESSION to standard output.\n" \
979 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000980 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000981 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
982 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
983 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
984 " ARG1 <= ARG2\n" \
985 " ARG1 = ARG2\n" \
986 " ARG1 != ARG2\n" \
987 " ARG1 >= ARG2\n" \
988 " ARG1 > ARG2\n" \
989 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
990 " ARG1 - ARG2\n" \
991 " ARG1 * ARG2\n" \
992 " ARG1 / ARG2\n" \
993 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000994 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
995 " match STRING REGEXP Same as STRING : REGEXP\n" \
996 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
997 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
998 " length STRING Length of STRING\n" \
999 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001000 " it is a keyword like 'match' or an\n" \
1001 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001002 " (EXPRESSION) Value of EXPRESSION\n" \
1003 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001004 "Beware that many operators need to be escaped or quoted for shells.\n" \
1005 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001006 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001007 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1008 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001009
Mike Frysingerfa69f112005-04-17 07:24:19 +00001010#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001011 "[-fiw] [-b ADDR] [STRING]"
Mike Frysingerfa69f112005-04-17 07:24:19 +00001012#define fakeidentd_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001013 "Provide fake ident (auth) service\n" \
1014 "\nOptions:" \
1015 "\n -f Run in foreground" \
1016 "\n -i Inetd mode" \
1017 "\n -w Inetd 'wait' mode" \
1018 "\n -b ADDR Bind to specified address" \
1019 "\n STRING Ident answer string (default is 'nobody')" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001020
Eric Andersen7e9276b2001-02-22 01:15:47 +00001021#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001022 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001023#define false_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001024 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001025
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001026#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001027 "$ false\n" \
1028 "$ echo $?\n" \
1029 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001030
1031#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001032 "[options] [mode]"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001033#define fbset_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001034 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001035
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001036#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001037 "$ fbset\n" \
1038 "mode \"1024x768-76\"\n" \
1039 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1040 " geometry 1024 768 1024 768 16\n" \
1041 " timings 12714 128 32 16 4 128 4\n" \
1042 " accel false\n" \
1043 " rgba 5/11,6/5,5/0,0/0\n" \
1044 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001045
Eric Andersen7e9276b2001-02-22 01:15:47 +00001046#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001047 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001048#define fdflush_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001049 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001050
Eric Andersen01c3d402003-07-05 07:51:31 +00001051#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001052 "[-n] DEVICE"
Eric Andersen01c3d402003-07-05 07:51:31 +00001053#define fdformat_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001054 "Format floppy disk\n" \
1055 "\nOptions:" \
1056 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001057
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001058/* Looks like someone forgot to add this to config system */
1059#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1060# define ENABLE_FEATURE_FDISK_BLKSIZE 0
1061# define USE_FEATURE_FDISK_BLKSIZE(a)
1062#endif
1063
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001064#define fdisk_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001065 "[-ul" USE_FEATURE_FDISK_BLKSIZE("s") "] " \
1066 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001067#define fdisk_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001068 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001069 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001070 "\n -u Start and End are in sectors (instead of cylinders)" \
1071 "\n -l Show partition table for each DISK, then exit" \
1072 USE_FEATURE_FDISK_BLKSIZE( \
1073 "\n -s Show partition sizes in kb for each DISK, then exit" \
1074 ) \
1075 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1076 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
1077 "\n -H HEADS\n" \
1078 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001079
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001080#define fetchmail_trivial_usage \
Denis Vlasenko17db1a92008-02-26 21:13:17 +00001081 "[-w timeout] [-U user] -P password [-X] [-t] [-z] server[:port] maildir [prog]"
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001082#define fetchmail_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001083 "Fetch content of remote mailbox to local Maildir.\n" \
1084 "\nOptions:" \
1085 "\n -w timeout Set timeout on network operations" \
1086 "\n -U username Authenticate with specified username/password" \
1087 "\n -P password" \
1088 "\n -X Use openssl connection helper for secured servers" \
1089 "\n -t Get only headers" \
1090 "\n -z Delete messages on server" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00001091 "\n prog Run prog <message_file> on message delivery" \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001092
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001093#define findfs_trivial_usage \
1094 "LABEL=label or UUID=uuid"
1095#define findfs_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001096 "Find a filesystem device based on a label or UUID."
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001097#define findfs_example_usage \
1098 "$ findfs LABEL=MyDevice"
1099
Eric Andersen7e9276b2001-02-22 01:15:47 +00001100#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001101 "[PATH...] [EXPRESSION]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001102#define find_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001103 "Search for files. The default PATH is the current directory,\n" \
1104 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001105 "\nEXPRESSION may consist of:" \
1106 "\n -follow Dereference symlinks" \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001107 USE_FEATURE_FIND_XDEV( \
1108 "\n -xdev Don't descend directories on other filesystems") \
1109 USE_FEATURE_FIND_MAXDEPTH( \
1110 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1111 "\n tests/actions to command line arguments only") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001112 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001113 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001114 USE_FEATURE_FIND_PATH( \
1115 "\n -path PATTERN Path matches PATTERN") \
1116 USE_FEATURE_FIND_REGEX( \
1117 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001118 USE_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001119 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001120 USE_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001121 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001122 "\n or exactly (NNN)") \
1123 USE_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001124 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001125 "\n or exactly (N) days") \
1126 USE_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001127 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001128 "\n or exactly (N) minutes") \
1129 USE_FEATURE_FIND_NEWER( \
1130 "\n -newer FILE Modified time is more recent than FILE's") \
1131 USE_FEATURE_FIND_INUM( \
1132 "\n -inum N File has inode number N") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001133 USE_FEATURE_FIND_USER( \
1134 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
1135 USE_FEATURE_FIND_GROUP( \
1136 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
1137 USE_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001138 "\n -depth Process directory name after traversing it") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001139 USE_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001140 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1141 "\n +/-N: file size is bigger/smaller than N") \
1142 "\n -print Print (default and assumed)" \
1143 USE_FEATURE_FIND_PRINT0( \
1144 "\n -print0 Delimit output with null characters rather than" \
1145 "\n newlines") \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001146 USE_FEATURE_FIND_CONTEXT ( \
1147 "\n -context File has specified security context") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001148 USE_FEATURE_FIND_EXEC( \
1149 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1150 "\n matching files") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001151 USE_FEATURE_FIND_PRUNE( \
1152 "\n -prune Stop traversing current subtree") \
1153 USE_FEATURE_FIND_DELETE( \
1154 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001155 USE_FEATURE_FIND_PAREN( \
1156 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001157
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001158#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001159 "$ find / -name passwd\n" \
1160 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001161
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001162#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001163 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001164#define fold_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001165 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001166 "standard output\n" \
1167 "\nOptions:" \
1168 "\n -b Count bytes rather than columns" \
1169 "\n -s Break at spaces" \
1170 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001171
Eric Andersen7e9276b2001-02-22 01:15:47 +00001172#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001173 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001174#define free_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001175 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001176#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001177 "$ free\n" \
1178 " total used free shared buffers\n" \
1179 " Mem: 257628 248724 8904 59644 93124\n" \
1180 " Swap: 128516 8404 120112\n" \
1181 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001182
Eric Andersen7e9276b2001-02-22 01:15:47 +00001183#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001184 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001185#define freeramdisk_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001186 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001187#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001188 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001189
Mike Frysinger51a43b42005-09-24 07:11:16 +00001190#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001191 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001192#define fsck_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001193 "Check and repair filesystems\n" \
1194 "\nOptions:" \
1195 "\n -A Walk /etc/fstab and check all filesystems" \
1196 "\n -N Don't execute, just show what would be done" \
1197 "\n -P With -A, check filesystems in parallel" \
1198 "\n -R With -A, skip the root filesystem" \
1199 "\n -T Don't show title on startup" \
1200 "\n -V Verbose" \
1201 "\n -C n Write status information to specified filedescriptor" \
1202 "\n -t type List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001203
Eric Andersen7e9276b2001-02-22 01:15:47 +00001204#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001205 "[-larvsmf] /dev/name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001206#define fsck_minix_full_usage \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001207 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001208 "\nOptions:" \
1209 "\n -l List all filenames" \
1210 "\n -r Perform interactive repairs" \
1211 "\n -a Perform automatic repairs" \
1212 "\n -v Verbose" \
1213 "\n -s Output super-block information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001214 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001215 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001216
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001217#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001218 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001219#define ftpget_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001220 "Retrieve a remote file via FTP\n" \
1221 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001222 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001223 "\n -c,--continue Continue previous transfer" \
1224 "\n -v,--verbose Verbose" \
1225 "\n -u,--username Username" \
1226 "\n -p,--password Password" \
1227 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001228 ) \
1229 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001230 "\n -c Continue previous transfer" \
1231 "\n -v Verbose" \
1232 "\n -u Username" \
1233 "\n -p Password" \
1234 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001235 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001236
1237#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001238 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001239#define ftpput_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001240 "Store a local file on a remote machine via FTP\n" \
1241 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001242 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001243 "\n -v,--verbose Verbose" \
1244 "\n -u,--username Username" \
1245 "\n -p,--password Password" \
1246 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001247 ) \
1248 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001249 "\n -v Verbose" \
1250 "\n -u Username" \
1251 "\n -p Password" \
1252 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001253 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001254
Rob Landleyaa872762005-10-28 13:05:12 +00001255#define fuser_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001256 "[options] FILE or PORT/PROTO"
Rob Landleyaa872762005-10-28 13:05:12 +00001257#define fuser_full_usage \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001258 "Find processes which use FILEs or PORTs\n" \
1259 "\nOptions:" \
1260 "\n -m Find processes which use same fs as FILEs" \
1261 "\n -4 Search only IPv4 space" \
1262 "\n -6 Search only IPv6 space" \
1263 "\n -s Silent: just exit with 0 if any processes are found" \
1264 "\n -k Kill found processes (otherwise display PIDs)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001265 "\n -SIGNAL Signal to send (default: TERM)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001266
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001267#define getenforce_trivial_usage
1268#define getenforce_full_usage
1269
Eric Andersen7e9276b2001-02-22 01:15:47 +00001270#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001271 "[OPTIONS]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001272#define getopt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001273 "Parse command options\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001274 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001275 "\n -a,--alternative Allow long options starting with single -" \
1276 "\n -l,--longoptions=longopts Long options to be recognized" \
1277 "\n -n,--name=progname The name under which errors are reported" \
1278 "\n -o,--options=optstring Short options to be recognized" \
1279 "\n -q,--quiet Disable error reporting by getopt(3)" \
1280 "\n -Q,--quiet-output No normal output" \
1281 "\n -s,--shell=shell Set shell quoting conventions" \
1282 "\n -T,--test Test for getopt(1) version" \
1283 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001284 ) \
1285 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001286 "\n -a Allow long options starting with single -" \
1287 "\n -l longopts Long options to be recognized" \
1288 "\n -n progname The name under which errors are reported" \
1289 "\n -o optstring Short options to be recognized" \
1290 "\n -q Disable error reporting by getopt(3)" \
1291 "\n -Q No normal output" \
1292 "\n -s shell Set shell quoting conventions" \
1293 "\n -T Test for getopt(1) version" \
1294 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001295 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001296#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001297 "$ cat getopt.test\n" \
1298 "#!/bin/sh\n" \
1299 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1300 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001301 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001302 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001303 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001304 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001305 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1306 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001307 " -c|--c-long)\n" \
1308 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001309 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1310 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1311 " esac;;\n" \
1312 " --) shift; break;;\n" \
1313 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001314 " esac\n" \
1315 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001316
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001317#define getsebool_trivial_usage \
1318 "-a or getsebool boolean..."
1319#define getsebool_full_usage \
1320 " -a Show all SELinux booleans"
1321
Eric Andersenf349e972001-08-21 16:18:59 +00001322#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001323 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Eric Andersenf349e972001-08-21 16:18:59 +00001324#define getty_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001325 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1326 "\nOptions:" \
1327 "\n -h Enable hardware (RTS/CTS) flow control" \
1328 "\n -i Do not display /etc/issue before running login" \
1329 "\n -L Local line, do not do carrier detect" \
1330 "\n -m Get baud rate from modem's CONNECT status message" \
1331 "\n -w Wait for a CR or LF before sending /etc/issue" \
1332 "\n -n Do not prompt the user for a login name" \
1333 "\n -f issue_file Display issue_file instead of /etc/issue" \
1334 "\n -l login_app Invoke login_app instead of /bin/login" \
1335 "\n -t timeout Terminate after timeout if no username is read" \
1336 "\n -I initstring Init string to send before anything else" \
1337 "\n -H login_host Log login_host into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001338
Eric Andersen7e9276b2001-02-22 01:15:47 +00001339#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001340 "[-HhrilLnqvso" \
1341 USE_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001342 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001343 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1344 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001345 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001346#define grep_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001347 "Search for PATTERN in each FILE or standard input\n" \
1348 "\nOptions:" \
1349 "\n -H Prefix output lines with filename where match was found" \
1350 "\n -h Suppress the prefixing filename on output" \
1351 "\n -r Recurse subdirectories" \
1352 "\n -i Ignore case distinctions" \
1353 "\n -l List names of files that match" \
1354 "\n -L List names of files that do not match" \
1355 "\n -n Print line number with output lines" \
1356 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1357 "\n -v Select non-matching lines" \
1358 "\n -s Suppress file open/read error messages" \
1359 "\n -c Only print count of matching lines" \
1360 "\n -o Show only the part of a line that matches PATTERN" \
1361 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001362 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001363 "\n -w Match whole words only") \
1364 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001365 USE_FEATURE_GREP_EGREP_ALIAS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001366 "\n -E PATTERN is an extended regular expression") \
1367 "\n -e PTRN Pattern to match" \
1368 "\n -f FILE Read pattern from file" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001369 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001370 "\n -A Print NUM lines of trailing context" \
1371 "\n -B Print NUM lines of leading context" \
1372 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001373
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001374#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001375 "$ grep root /etc/passwd\n" \
1376 "root:x:0:0:root:/root:/bin/bash\n" \
1377 "$ grep ^[rR]oo. /etc/passwd\n" \
1378 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001379
Eric Andersen7e9276b2001-02-22 01:15:47 +00001380#define gunzip_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001381 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001382#define gunzip_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001383 "Uncompress FILEs (or standard input)\n" \
1384 "\nOptions:" \
1385 "\n -c Write to standard output" \
1386 "\n -f Force" \
1387 "\n -t Test file integrity" \
1388
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001389#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001390 "$ ls -la /tmp/BusyBox*\n" \
1391 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1392 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1393 "$ ls -la /tmp/BusyBox*\n" \
1394 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001395
1396#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001397 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001398#define gzip_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001399 "Compress FILEs (or standard input)\n" \
1400 "\nOptions:" \
1401 "\n -c Write to standard output" \
1402 "\n -d Decompress" \
1403 "\n -f Force" \
1404
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001405#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001406 "$ ls -la /tmp/busybox*\n" \
1407 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1408 "$ gzip /tmp/busybox.tar\n" \
1409 "$ ls -la /tmp/busybox*\n" \
1410 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001411
1412#define halt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001413 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001414#define halt_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001415 "Halt the system\n" \
1416 "\nOptions:" \
1417 "\n -d Delay interval for halting" \
1418 "\n -n No call to sync()" \
1419 "\n -f Force halt (don't go through init)" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001420 USE_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001421 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001422 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001423
Eric Andersen3443bd72003-07-22 07:30:36 +00001424#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001425 "[options] [device] .."
Eric Andersen3443bd72003-07-22 07:30:36 +00001426#define hdparm_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001427 "Options:" \
1428 "\n -a Get/set fs readahead" \
1429 "\n -A Set drive read-lookahead flag (0/1)" \
1430 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1431 "\n -B Set Advanced Power Management setting (1-255)" \
1432 "\n -c Get/set IDE 32-bit IO setting" \
1433 "\n -C Check IDE power mode status" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001434 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001435 "\n -d Get/set using_dma flag") \
1436 "\n -D Enable/disable drive defect-mgmt" \
1437 "\n -f Flush buffer cache for device on exit" \
1438 "\n -g Display drive geometry" \
1439 "\n -h Display terse usage information" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001440 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001441 "\n -i Display drive identification") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001442 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001443 "\n -I Detailed/current information directly from drive") \
1444 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1445 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1446 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1447 "\n -m Get/set multiple sector count" \
1448 "\n -n Get/set ignore-write-errors flag (0/1)" \
1449 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1450 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001451/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001452 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1453 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001454 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001455 "\n -R Register an IDE interface (DANGEROUS)") \
1456 "\n -S Set standby (spindown) timeout" \
1457 "\n -t Perform device read timings" \
1458 "\n -T Perform cache read timings" \
1459 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001460 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001461 "\n -U Un-register an IDE interface (DANGEROUS)") \
1462 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1463 "\n -V Display program version and exit immediately" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001464 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001465 "\n -w Perform device reset (DANGEROUS)") \
1466 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001467 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001468 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1469 "\n -X Set IDE xfer mode (DANGEROUS)" \
1470 "\n -y Put IDE drive in standby mode" \
1471 "\n -Y Put IDE drive to sleep" \
1472 "\n -Z Disable Seagate auto-powersaving mode" \
1473 "\n -z Re-read partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001474
Eric Andersen7e9276b2001-02-22 01:15:47 +00001475#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001476 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001477#define head_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001478 "Print first 10 lines of each FILE to standard output.\n" \
1479 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001480 "file name. With no FILE, or when FILE is -, read standard input.\n" \
1481 "\nOptions:" \
1482 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001483 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001484 "\n -c NUM Output the first NUM bytes" \
1485 "\n -q Never output headers giving file names" \
1486 "\n -v Always output headers giving file names") \
1487
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001488#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001489 "$ head -n 2 /etc/passwd\n" \
1490 "root:x:0:0:root:/root:/bin/bash\n" \
1491 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001492
Glenn L McGrath60281112001-11-02 11:39:46 +00001493#define hexdump_trivial_usage \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001494 "[-bcCdefnosvx" USE_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Glenn L McGrath60281112001-11-02 11:39:46 +00001495#define hexdump_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001496 "Display file(s) or standard input in a user specified format\n" \
1497 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001498 "\n -b One-byte octal display" \
1499 "\n -c One-byte character display" \
1500 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1501 "\n -d Two-byte decimal display" \
1502 "\n -e FORMAT STRING" \
1503 "\n -f FORMAT FILE" \
1504 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1505 "\n -o Two-byte octal display" \
1506 "\n -s OFFSET Skip OFFSET bytes" \
1507 "\n -v Display all input data" \
1508 "\n -x Two-byte hexadecimal display" \
1509 USE_FEATURE_HEXDUMP_REVERSE( \
1510 "\n -R Reverse of 'hexdump -Cv'") \
1511
1512#define hd_trivial_usage \
1513 "FILE..."
1514#define hd_full_usage \
1515 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001516
Eric Andersen7e9276b2001-02-22 01:15:47 +00001517#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001518 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001519#define hostid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001520 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001521
1522#define hostname_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001523 "[OPTION] [hostname | -F FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001524#define hostname_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001525 "Get or set hostname or DNS domain name\n" \
1526 "\nOptions:" \
1527 "\n -s Short" \
1528 "\n -i Addresses for the hostname" \
1529 "\n -d DNS domain name" \
1530 "\n -f Fully qualified domain name" \
1531 "\n -F FILE Use the contents of FILE to specify the hostname" \
1532
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001533#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001534 "$ hostname\n" \
1535 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001536
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001537#define httpd_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001538 "[-c conffile]" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001539 " [-p [ip:]port]" \
1540 " [-i] [-f] [-v[v]]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001541 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001542 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001543 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001544 " [-h home]" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001545 " [-d/-e string]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001546#define httpd_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001547 "Listen for incoming HTTP requests\n" \
1548 "\nOptions:" \
1549 "\n -c FILE Configuration file (default httpd.conf)" \
1550 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
1551 "\n -i Inetd mode" \
1552 "\n -f Do not daemonize" \
1553 "\n -v[v] Verbose" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001554 USE_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001555 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001556 USE_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001557 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001558 USE_FEATURE_HTTPD_AUTH_MD5( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001559 "\n -m PASS Crypt PASS with md5 algorithm") \
1560 "\n -h HOME Home directory (default .)" \
1561 "\n -e STRING HTML encode STRING" \
1562 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001563
Robert Griebl1cd04452002-07-21 16:50:49 +00001564#define hwclock_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001565 USE_GETOPT_LONG( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001566 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1567 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001568 " [-f FILE]" \
1569 ) \
1570 SKIP_GETOPT_LONG( \
1571 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1572 )
Robert Griebl1cd04452002-07-21 16:50:49 +00001573#define hwclock_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001574 "Query and set hardware clock (RTC)\n" \
1575 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001576 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001577 "\n -s Set system time from hardware clock" \
1578 "\n -w Set hardware clock to system time" \
1579 "\n -u Hardware clock is in UTC" \
1580 "\n -l Hardware clock is in local time" \
1581 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001582
Eric Andersen7e9276b2001-02-22 01:15:47 +00001583#define id_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001584 "[OPTIONS]... [USER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001585#define id_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001586 "Print information about USER or the current user\n" \
1587 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001588 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001589 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001590 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001591 "\n -g Print group ID" \
1592 "\n -u Print user ID" \
1593 "\n -n Print name instead of a number" \
1594 "\n -r Print real user ID instead of effective ID" \
1595
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001596#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001597 "$ id\n" \
1598 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001599
Eric Andersen7e9276b2001-02-22 01:15:47 +00001600#define ifconfig_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001601 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001602#define ifconfig_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001603 "Configure a network interface\n" \
1604 "\nOptions:" \
1605 "\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001606 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001607 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001608 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001609 " [del ADDRESS[/PREFIXLEN]]\n") \
1610 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1611 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001612 USE_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001613 " [outfill NN] [keepalive NN]\n") \
1614 " " USE_FEATURE_IFCONFIG_HW("[hw ether ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001615 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001616 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001617 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001618 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001619 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001620
Denis Vlasenko06aed432008-02-26 18:25:24 +00001621#define ifenslave_trivial_usage \
1622 "[-cdf] master-iface <slave-iface...>"
1623#define ifenslave_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001624 "Configure network interfaces for parallel routing\n" \
1625 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001626 "\n -c, --change-active Change active slave" \
1627 "\n -d, --detach Remove slave interface from bonding device" \
1628 "\n -f, --force Force, even if interface is not Ethernet" \
1629/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001630
Denis Vlasenko06aed432008-02-26 18:25:24 +00001631#define ifenslave_example_usage \
1632 "To create a bond device, simply follow these three steps :\n" \
1633 "- ensure that the required drivers are properly loaded :\n" \
1634 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
1635 "- assign an IP address to the bond device :\n" \
1636 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
1637 "- attach all the interfaces you need to the bond device :\n" \
1638 " # ifenslave bond0 eth0 eth1 eth2\n" \
1639 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1640 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
1641 " To detach a dead interface without setting the bond device down :\n" \
1642 " # ifenslave -d bond0 eth1\n\n" \
1643 " To set the bond device down and automatically release all the slaves :\n" \
1644 " # ifconfig bond0 down\n\n" \
1645 " To change active slave :\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001646 " # ifenslave -c bond0 eth0\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001647
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001648#define ifup_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001649 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001650#define ifup_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001651 "Options:" \
1652 "\n -a De/configure all interfaces automatically" \
1653 "\n -i FILE Use FILE for interface definitions" \
1654 "\n -n Print out what would happen, but don't do it" \
1655 "\n (note: doesn't disable mappings)" \
1656 "\n -v Print out what would happen before doing it" \
1657 "\n -m Don't run any mappings" \
1658 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001659
1660#define ifdown_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001661 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001662#define ifdown_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001663 "Options:" \
1664 "\n -a De/configure all interfaces automatically" \
1665 "\n -i FILE Use FILE for interface definitions" \
1666 "\n -n Print out what would happen, but don't do it" \
1667 "\n (note: doesn't disable mappings)" \
1668 "\n -v Print out what would happen before doing it" \
1669 "\n -m Don't run any mappings" \
1670 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001671
Glenn L McGrath06e95652003-02-09 06:51:14 +00001672#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001673 "[-fe] [-q N] [-R N] [CONFFILE]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001674#define inetd_full_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001675 "Listen for network connections and launch programs\n" \
1676 "\nOptions:" \
1677 "\n -f Run in foreground" \
1678 "\n -e Log to stderr" \
1679 "\n -q N Socket listen queue (default: 128)" \
1680 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001681 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001682
Eric Andersen7e9276b2001-02-22 01:15:47 +00001683#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001684 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001685#define init_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001686 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001687
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001688#define init_notes_usage \
1689"This version of init is designed to be run only by the kernel.\n" \
1690"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001691"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001692"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001693"runlevels, use sysvinit.\n" \
1694"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001695"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001696"it has the following default behavior:\n" \
1697"\n" \
1698" ::sysinit:/etc/init.d/rcS\n" \
1699" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001700" ::ctrlaltdel:/sbin/reboot\n" \
1701" ::shutdown:/sbin/swapoff -a\n" \
1702" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001703" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001704"\n" \
1705"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1706"\n" \
1707" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001708" tty3::askfirst:/bin/sh\n" \
1709" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001710"\n" \
1711"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1712"\n" \
1713" <id>:<runlevels>:<action>:<process>\n" \
1714"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001715" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001716"\n" \
1717" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1718" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001719" the specified process to run on. The contents of this field are\n" \
1720" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1721" be unique, although if it isn't you may have strange results. If this\n" \
1722" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001723" note that if BusyBox detects that a serial console is in use, then only\n" \
1724" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001725" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001726" stinkin' utmp.\n" \
1727"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001728" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001729"\n" \
1730" The runlevels field is completely ignored.\n" \
1731"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001732" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001733"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001734" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001735" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001736"\n" \
1737" The available actions can be classified into two groups: actions\n" \
1738" that are run only once, and actions that are re-run when the specified\n" \
1739" process exits.\n" \
1740"\n" \
1741" Run only-once actions:\n" \
1742"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001743" 'sysinit' is the first item run on boot. init waits until all\n" \
1744" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001745" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001746" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001747" the specified task completes. 'once' actions are asynchronous,\n" \
1748" therefore, init does not wait for them to complete. 'restart' is\n" \
1749" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001750" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001751" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001752" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001753" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001754" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001755" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001756" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001757" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001758"\n" \
1759" Run repeatedly actions:\n" \
1760"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001761" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001762" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001763" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1764" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001765" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001766" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001767" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001768" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001769"\n" \
1770" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001771" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001772" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001773"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001774" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001775"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001776" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001777"\n" \
1778"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001779"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001780" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001781" #\n" \
1782" ::sysinit:/etc/init.d/rcS\n" \
1783" \n" \
1784" # /bin/sh invocations on selected ttys\n" \
1785" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001786" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001787" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001788" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001789" tty2::askfirst:-/bin/sh\n" \
1790" tty3::askfirst:-/bin/sh\n" \
1791" tty4::askfirst:-/bin/sh\n" \
1792" \n" \
1793" # /sbin/getty invocations for selected ttys\n" \
1794" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001795" tty4::respawn:/sbin/getty 38400 tty4\n" \
1796" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001797" \n" \
1798" \n" \
1799" # Example of how to put a getty on a serial line (for a terminal)\n" \
1800" #\n" \
1801" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1802" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1803" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001804" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001805" #::respawn:/sbin/getty 57600 ttyS2\n" \
1806" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001807" # Stuff to do when restarting the init process\n" \
1808" ::restart:/sbin/init\n" \
1809" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001810" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001811" ::ctrlaltdel:/sbin/reboot\n" \
1812" ::shutdown:/bin/umount -a -r\n" \
1813" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001814
1815#define insmod_trivial_usage \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001816 USE_FEATURE_2_4_MODULES("[OPTION]... ") "MODULE [symbol=value]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001817#define insmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001818 "Load the specified kernel modules into the kernel" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001819 USE_FEATURE_2_4_MODULES( "\n" \
1820 "\nOptions:" \
1821 "\n -f Force module to load into the wrong kernel version" \
1822 "\n -k Make module autoclean-able" \
1823 "\n -v Verbose" \
1824 "\n -q Quiet" \
1825 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001826 USE_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001827 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001828 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001829 "\n -o NAME Set internal module name to NAME" \
1830 "\n -x Do not export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001831 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001832
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001833#define install_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001834 "[-cgmops] [sources] dest|directory"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001835#define install_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001836 "Copy files and set attributes\n" \
1837 "\nOptions:" \
1838 "\n -c Copy the file, default" \
1839 "\n -d Create directories" \
1840 "\n -g Set group ownership" \
1841 "\n -m Set permissions" \
1842 "\n -o Set ownership" \
1843 "\n -p Preserve date" \
1844 "\n -s Strip symbol tables" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001845 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001846 "\n -Z Set security context of copy" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001847 )
Denis Vlasenko397de612008-03-17 08:55:44 +00001848
1849/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001850#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001851 "[OPTIONS] {" \
1852 USE_FEATURE_IP_ADDRESS("address | ") \
1853 USE_FEATURE_IP_ROUTE("route | ") \
1854 USE_FEATURE_IP_LINK("link | ") \
1855 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1856 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001857 "} {COMMAND}"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001858#define ip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001859 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001860 "where OBJECT := {" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001861 USE_FEATURE_IP_ADDRESS("address | ") \
1862 USE_FEATURE_IP_ROUTE("route | ") \
1863 USE_FEATURE_IP_LINK("link | ") \
1864 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1865 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001866 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001867 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001868
1869#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001870 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001871 " [dev STRING] [to PREFIX] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001872#define ipaddr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001873 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001874 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
1875 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001876 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001877 " [broadcast ADDR] [anycast ADDR]\n" \
1878 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001879 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001880
Eric Andersende4f07e2003-12-11 01:18:07 +00001881#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001882 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001883#define ipcalc_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001884 "Calculate IP network settings from a IP address\n" \
1885 "\nOptions:" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001886 USE_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001887 "\n -b,--broadcast Display calculated broadcast address" \
1888 "\n -n,--network Display calculated network address" \
1889 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001890 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001891 "\n -p,--prefix Display the prefix for IP/NETMASK" \
1892 "\n -h,--hostname Display first resolved host name" \
1893 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001894 ) \
1895 ) \
1896 SKIP_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001897 "\n -b Display calculated broadcast address" \
1898 "\n -n Display calculated network address" \
1899 "\n -m Display default netmask for IP" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001900 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001901 "\n -p Display the prefix for IP/NETMASK" \
1902 "\n -h Display first resolved host name" \
1903 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001904 ) \
1905 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001906
Rob Landley6eb1e412005-06-20 04:30:36 +00001907#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001908 "[-MQS key] [-mqs id]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001909#define ipcrm_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001910 "Upper-case options MQS remove an object by shmkey value.\n" \
1911 "Lower-case options remove an object by shmid value.\n" \
1912 "\nOptions:" \
1913 "\n -mM Remove memory segment after last detach" \
1914 "\n -qQ Remove message queue" \
1915 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001916
1917#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001918 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001919#define ipcs_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001920 " -i Show specific resource" \
1921 "\nResource specification:" \
1922 "\n -m Shared memory segments" \
1923 "\n -q Message queues" \
1924 "\n -s Semaphore arrays" \
1925 "\n -a All (default)" \
1926 "\nOutput format:" \
1927 "\n -t Time" \
1928 "\n -c Creator" \
1929 "\n -p Pid" \
1930 "\n -l Limits" \
1931 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001932
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001933#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001934 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001935#define iplink_full_usage \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00001936 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001937 " dynamic { on | off } |\n" \
1938 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001939 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001940
1941#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001942 "{ list | flush | { add | del | change | append |\n" \
1943 " replace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001944#define iproute_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001945 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001946 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
1947 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001948 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001949 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001950 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001951
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001952#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001953 "{[list | add | del] RULE}"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001954#define iprule_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001955 "iprule [list | add | del] SELECTOR ACTION\n" \
1956 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
1957 " [dev STRING] [pref NUMBER]\n" \
1958 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
1959 " [prohibit | reject | unreachable]\n" \
1960 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001961 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001962
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001963#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001964 "{ add | change | del | show } [NAME]\n" \
1965 " [mode { ipip | gre | sit }]\n" \
1966 " [remote ADDR] [local ADDR] [ttl TTL]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001967#define iptunnel_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001968 "iptunnel { add | change | del | show } [NAME]\n" \
1969 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
1970 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001971 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001972
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00001973#define kbd_mode_trivial_usage \
1974 "[-a|k|s|u]"
1975#define kbd_mode_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001976 "Report or set the keyboard mode\n" \
1977 "\nOptions set mode:" \
1978 "\n -a Default (ASCII)" \
1979 "\n -k Medium-raw (keyboard)" \
1980 "\n -s Raw (scancode)" \
1981 "\n -u Unicode (utf-8)" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00001982
Eric Andersen7e9276b2001-02-22 01:15:47 +00001983#define kill_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001984 "[-l] [-signal] process-id..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001985#define kill_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001986 "Send a signal (default is TERM) to the specified process(es)\n" \
1987 "\nOptions:" \
1988 "\n -l List all signal names and numbers" \
1989
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001990#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001991 "$ ps | grep apache\n" \
1992 "252 root root S [apache]\n" \
1993 "263 www-data www-data S [apache]\n" \
1994 "264 www-data www-data S [apache]\n" \
1995 "265 www-data www-data S [apache]\n" \
1996 "266 www-data www-data S [apache]\n" \
1997 "267 www-data www-data S [apache]\n" \
1998 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001999
2000#define killall_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002001 "[-l] [-q] [-signal] process-name..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002002#define killall_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002003 "Send a signal (default is TERM) to the specified process(es)\n" \
2004 "\nOptions:" \
2005 "\n -l List all signal names and numbers" \
2006 "\n -q Do not complain if no processes were killed" \
2007
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002008#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002009 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002010
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002011#define killall5_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002012 "[-l] [-signal]"
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002013#define killall5_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002014 "Send a signal (default is TERM) to all processes outside current session\n" \
2015 "\nOptions:" \
2016 "\n -l List all signal names and numbers" \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002017
Mark Whitley6317c4b2001-03-12 22:51:50 +00002018#define klogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002019 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00002020#define klogd_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002021 "Kernel logger\n" \
2022 "\nOptions:" \
2023 "\n -c n Set the default log level of console messages to n" \
2024 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002025
Eric Andersen7e9276b2001-02-22 01:15:47 +00002026#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002027 "STRING"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002028#define length_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002029 "Print STRING's length"
2030
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002031#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002032 "$ length Hello\n" \
2033 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002034
Rob Landley9200e792005-09-15 19:26:59 +00002035#define less_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002036 "[-EMNmh~?] [FILE...]"
Rob Landley9200e792005-09-15 19:26:59 +00002037#define less_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002038 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002039 "changed, and files can be manipulated in various ways.\n" \
2040 "\nOptions:" \
2041 "\n -E Quit once the end of a file is reached" \
2042 "\n -M,-m Display a status line containing the line numbers" \
2043 "\n and percentage through the file" \
2044 "\n -N Prefix line numbers to each line" \
2045 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002046
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002047#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002048 "personality program [args...]"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002049#define setarch_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002050 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002051 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002052 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002053
Eric Andersen7e9276b2001-02-22 01:15:47 +00002054#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002055 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002056#define ln_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002057 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002058 "Use '--' to indicate that all following arguments are non-options.\n" \
2059 "\nOptions:" \
2060 "\n -s Make symlinks instead of hardlinks" \
2061 "\n -f Remove existing destination files" \
2062 "\n -n Don't dereference symlinks - treat like normal file" \
2063 "\n -b Make a backup of the target (if exists) before link operation" \
2064 "\n -S suf Use suffix instead of ~ when making backup files" \
2065
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002066#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002067 "$ ln -s BusyBox /tmp/ls\n" \
2068 "$ ls -l /tmp/ls\n" \
2069 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002070
Denis Vlasenkob042bd92007-09-26 18:01:32 +00002071#define load_policy_trivial_usage
2072
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002073#define load_policy_full_usage
2074
Eric Andersen7e9276b2001-02-22 01:15:47 +00002075#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002076 "< font"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002077#define loadfont_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002078 "Load a console font from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002079#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002080 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002081
2082#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002083 "< keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002084#define loadkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002085 "Load a binary keyboard translation table from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002086#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002087 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002088
2089#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002090 "[OPTION]... [MESSAGE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002091#define logger_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002092 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n" \
2093 "\nOptions:" \
2094 "\n -s Log to stderr as well as the system log" \
2095 "\n -t TAG Log using the specified tag (defaults to user name)" \
2096 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002097
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002098#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002099 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002100
Robert Griebl1fca5582002-06-04 20:45:46 +00002101#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002102 "[-p] [-h HOST] [[-f] USER]"
Robert Griebl1fca5582002-06-04 20:45:46 +00002103#define login_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002104 "Begin a new session on the system\n" \
2105 "\nOptions:" \
2106 "\n -f Do not authenticate (user already authenticated)" \
2107 "\n -h Name of the remote host" \
2108 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002109
Eric Andersen7e9276b2001-02-22 01:15:47 +00002110#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002111 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002112#define logname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002113 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002114#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002115 "$ logname\n" \
2116 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002117
Mark Whitley6317c4b2001-03-12 22:51:50 +00002118#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002119 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00002120#define logread_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002121 "Show messages in syslogd's circular buffer\n" \
2122 "\nOptions:" \
2123 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002124
Matt Kraai83788da2002-03-20 17:38:37 +00002125#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002126 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2127 " losetup -d LOOPDEV - disassociate\n" \
2128 " losetup [-f] - show"
Matt Kraai83788da2002-03-20 17:38:37 +00002129#define losetup_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002130 "Options:" \
2131 "\n -o OFS Start OFS bytes into FILE" \
2132 "\n -f Show first free loop device" \
2133
Rob Landley1d589b22005-11-29 23:47:10 +00002134#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002135 "No arguments will display all current associations.\n" \
2136 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002137 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002138 "and filename of the file the loop device is currently bound to.\n\n" \
2139 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002140 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2141 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002142
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002143#define lpd_trivial_usage \
Denis Vlasenkoa7942892008-03-23 23:40:18 +00002144 "SPOOLDIR [HELPER [ARGS...]]"
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002145#define lpd_full_usage \
2146 "Example:" \
Denis Vlasenkoa7942892008-03-23 23:40:18 +00002147 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print"
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002148
Denis Vlasenko68444b92008-02-22 22:24:48 +00002149#define lpq_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002150 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID...] [-fs]"
Denis Vlasenko68444b92008-02-22 22:24:48 +00002151#define lpq_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002152 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002153 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002154 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002155 "\n -f Force any waiting job to be printed" \
2156 "\n -s Short display" \
2157
2158#define lpr_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002159 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE...]"
2160/* -C CLASS exists too, not shown.
2161 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko68444b92008-02-22 22:24:48 +00002162#define lpr_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002163 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002164 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002165 "\n -m Send mail on completion" \
2166 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002167 "\n -V Verbose" \
2168
Eric Andersen7e9276b2001-02-22 01:15:47 +00002169#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002170 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00002171 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002172 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
2173 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
2174 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
2175 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
2176 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
2177 USE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002178#define ls_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002179 "List directory contents\n" \
2180 "\nOptions:" \
2181 "\n -1 List files in a single column" \
2182 "\n -A Do not list implied . and .." \
2183 "\n -a Do not hide entries starting with ." \
2184 "\n -C List entries by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002185 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002186 "\n -c With -l: show ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002187 USE_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002188 "\n --color[={always,never,auto}] Control coloring") \
2189 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002190 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002191 "\n -e List both full date and full time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002192 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002193 "\n -F Append indicator (one of */=@|) to entries") \
2194 "\n -i List the i-node for each file" \
2195 "\n -l Use a long listing format" \
2196 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002197 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002198 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002199 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002200 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002201 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002202 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002203 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002204 "\n -r Sort the listing in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002205 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002206 "\n -S Sort the listing by file size") \
2207 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002208 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002209 "\n -T NUM Assume Tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002210 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002211 "\n -t With -l: show modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002212 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002213 "\n -u With -l: show access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002214 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002215 "\n -v Sort the listing by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002216 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002217 "\n -w NUM Assume the terminal is NUM columns wide") \
2218 "\n -x List entries by lines instead of by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002219 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002220 "\n -X Sort the listing by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00002221 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002222 "\n -h Print sizes in human readable format (e.g., 1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002223 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002224 "\n -k Print security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002225 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002226 "\n -K Print security context in long format") \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002227 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002228 "\n -Z Print security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002229
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002230#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002231 "[-Radlv] [files...]"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002232#define lsattr_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002233 "List file attributes on an ext2 fs\n" \
2234 "\nOptions:" \
2235 "\n -R Recursively list subdirectories" \
2236 "\n -a Do not hide entries starting with ." \
2237 "\n -d List directory entries instead of contents" \
2238 "\n -l Print long flag names" \
2239 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002240
Eric Andersen7e9276b2001-02-22 01:15:47 +00002241#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002242 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002243#define lsmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002244 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002245
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002246#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002247#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002248 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002249#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002250 "Create a range of block or character special files\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002251 "TYPEs include:\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00002252 " b Make a block device\n" \
2253 " c or u Make a character device\n" \
2254 " p Make a named pipe. MAJOR and MINOR are ignored\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002255 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002256 "FIRST specifies the number appended to NAME to create the first device.\n" \
2257 "LAST specifies the number of the last item that should be created\n" \
2258 "If 's' is the last argument, the base device is created as well.\n\n" \
2259 "For example:\n" \
2260 " makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
2261 " makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002262#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002263 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2264 "[creates ttyS2-ttyS63]\n" \
2265 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2266 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002267#endif
2268
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002269#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002270#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002271 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00002272#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002273 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002274 "Device table entries take the form of:\n" \
2275 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002276 "Where name is the file name, type can be one of:\n" \
2277 " f A regular file\n" \
2278 " d Directory\n" \
2279 " c Character special device file\n" \
2280 " b Block special device file\n" \
2281 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002282 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002283 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2284 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002285#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002286 "For example:\n" \
2287 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2288 "/dev d 755 0 0 - - - - -\n" \
2289 "/dev/console c 666 0 0 5 1 - - -\n" \
2290 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2291 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2292 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2293 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2294 "Will Produce:\n" \
2295 "/dev\n" \
2296 "/dev/console\n" \
2297 "/dev/null\n" \
2298 "/dev/zero\n" \
2299 "/dev/hda\n" \
2300 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002301#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002302
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002303#define man_trivial_usage \
2304 "[OPTION]... [MANPAGE]..."
2305#define man_full_usage \
2306 "Format and display manual page\n" \
2307 "\nOptions:" \
2308 "\n -a Display all pages" \
2309 "\n -w Show page locations" \
2310
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002311#define matchpathcon_trivial_usage \
2312 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
2313#define matchpathcon_full_usage \
2314 " -n Do not display path" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002315 "\n -N Do not use translations" \
2316 "\n -f Use alternate file_context file" \
2317 "\n -p Use prefix to speed translations" \
2318 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002319
Eric Andersen7e9276b2001-02-22 01:15:47 +00002320#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002321 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002322 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002323#define md5sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002324 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002325 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2326 "\nOptions:" \
2327 "\n -c Check MD5 sums against given list" \
2328 "\n -s Don't output anything, status code shows success" \
2329 "\n -w Warn about improperly formatted MD5 checksum lines") \
2330
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002331#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002332 "$ md5sum < busybox\n" \
2333 "6fd11e98b98a58f64ff3398d7b324003\n" \
2334 "$ md5sum busybox\n" \
2335 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2336 "$ md5sum -c -\n" \
2337 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2338 "busybox: OK\n" \
2339 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002340
Rob Landley70f7ef72005-12-13 08:21:33 +00002341#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002342 "[-s]"
Rob Landley70f7ef72005-12-13 08:21:33 +00002343#define mdev_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002344 " -s Scan /sys and populate /dev during system boot\n" \
2345 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002346 "Called with no options (via hotplug) it uses environment variables\n" \
2347 "to determine which device to add/remove."
Denis Vlasenko397de612008-03-17 08:55:44 +00002348
Rob Landleyef10d522006-06-26 14:11:33 +00002349#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002350 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002351 "The mdev config file contains lines that look like:\n" \
2352 " hd[a-z][0-9]* 0:3 660\n\n" \
2353 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002354 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002355 "Optionally, that can be followed (on the same line) by a special character\n" \
2356 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002357 "device(s). The environment variable $MDEV indicates the active device node\n" \
2358 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002359 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2360 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002361 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002362 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002363 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002364 "Config file parsing stops on the first matching line. If no config\n" \
2365 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002366 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002367 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002368
Glenn L McGrath061c9002002-09-16 04:21:46 +00002369#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002370 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002371#define mesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002372 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002373 " y Allow write access to your terminal\n" \
2374 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002375
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002376#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002377 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002378#define microcom_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002379 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2380 "\nOptions:" \
2381 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2382 "\n next byte to it" \
2383 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2384 "\n -s Set serial line to SPEED" \
2385 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002386
Eric Andersen7e9276b2001-02-22 01:15:47 +00002387#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002388 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002389#define mkdir_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002390 "Create DIRECTORY\n" \
2391 "\nOptions:" \
2392 "\n -m Set permission mode (as in chmod), not rwxrwxrwx - umask" \
2393 "\n -p No error if existing, make parent directories as needed" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002394 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002395 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002396 )
2397
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002398#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002399 "$ mkdir /tmp/foo\n" \
2400 "$ mkdir /tmp/foo\n" \
2401 "/tmp/foo: File exists\n" \
2402 "$ mkdir /tmp/foo/bar/baz\n" \
2403 "/tmp/foo/bar/baz: No such file or directory\n" \
2404 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002405
Mike Frysinger6447ac02005-06-11 05:29:40 +00002406#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002407 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2408 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2409 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2410 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2411 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2412 "device [blocks-count]"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002413#define mke2fs_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002414 " -b size Block size in bytes" \
2415 "\n -c Check for bad blocks before creating" \
2416 "\n -E opts Set extended options" \
2417 "\n -f size Fragment size in bytes" \
2418 "\n -F Force (ignore sanity checks)" \
2419 "\n -g num Number of blocks in a block group" \
2420 "\n -i ratio The bytes/inode ratio" \
2421 "\n -j Create a journal (ext3)" \
2422 "\n -J opts Set journal options (size/device)" \
2423 "\n -l file Read bad blocks list from file" \
2424 "\n -L lbl Set the volume label" \
2425 "\n -m percent Percent of fs blocks to reserve for admin" \
2426 "\n -M dir Set last mounted directory" \
2427 "\n -n Do not actually create anything" \
2428 "\n -N num Number of inodes to create" \
2429 "\n -o os Set the 'creator os' field" \
2430 "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" \
2431 "\n -q Quiet" \
2432 "\n -r rev Set filesystem revision" \
2433 "\n -S Write superblock and group descriptors only" \
2434 "\n -T fs-type Set usage type (news/largefile/largefile4)" \
2435 "\n -v Verbose" \
Mike Frysinger6447ac02005-06-11 05:29:40 +00002436
Eric Andersen7e9276b2001-02-22 01:15:47 +00002437#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002438 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002439#define mkfifo_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002440 "Create named pipe (identical to 'mknod name p')\n" \
2441 "\nOptions:" \
2442 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002443 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002444 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002445 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002446
Eric Andersen7e9276b2001-02-22 01:15:47 +00002447#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002448 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002449#define mkfs_minix_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002450 "Make a MINIX filesystem\n" \
2451 "\nOptions:" \
2452 "\n -c Check device for bad blocks" \
2453 "\n -n [14|30] Maximum length of filenames" \
2454 "\n -i INODES Number of inodes for the filesystem" \
2455 "\n -l FILENAME Read bad blocks list from FILENAME" \
2456 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002457
Eric Andersen7e9276b2001-02-22 01:15:47 +00002458#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002459 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002460#define mknod_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002461 "Create a special file (block, character, or pipe)\n" \
2462 "\nOptions:" \
2463 "\n -m Create the special file using the specified mode (default a=rw)" \
2464 "\nTYPEs include:" \
2465 "\n b: Make a block device" \
2466 "\n c or u: Make a character device" \
2467 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002468 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002469 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002470 )
2471
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002472#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002473 "$ mknod /dev/fd0 b 2 0\n" \
2474 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002475
Eric Andersen7e9276b2001-02-22 01:15:47 +00002476#define mkswap_trivial_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002477 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002478#define mkswap_full_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002479 "Prepare block device to be used as swap partition"
2480#if 0
2481 "[-c] [-v0|-v1] DEVICE [BLOCKS]"
Denis Vlasenko397de612008-03-17 08:55:44 +00002482 "\nOptions:"
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002483 "\n -c Check for readability"
2484 "\n -v0 Make swap version 0 (max 128M)"
2485 "\n -v1 Make swap version 1 (default for kernels > 2.1.117)"
2486 "\n BLOCKS Number of blocks to use (default is entire partition)"
2487#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002488
Eric Andersen7e9276b2001-02-22 01:15:47 +00002489#define mktemp_trivial_usage \
Denis Vlasenko761e1d12008-02-09 06:29:32 +00002490 "[-dt] [-p DIR] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002491#define mktemp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002492 "Create a temporary file with its name based on TEMPLATE.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002493 "TEMPLATE is any name with six 'Xs' (i.e., /tmp/temp.XXXXXX).\n" \
2494 "\nOptions:" \
2495 "\n -d Make a directory instead of a file" \
2496/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2497 "\n -t Generate a path rooted in temporary directory" \
2498 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2499 "\n" \
2500 "\n" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002501 "For -t or -p, directory is chosen as follows:\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002502 "$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002503
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002504#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002505 "$ mktemp /tmp/temp.XXXXXX\n" \
2506 "/tmp/temp.mWiLjM\n" \
2507 "$ ls -la /tmp/temp.mWiLjM\n" \
2508 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002509
Eric Andersen8d79ce82001-07-22 23:00:15 +00002510#define modprobe_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002511 "[-knqrsv] MODULE [symbol=value...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002512#define modprobe_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002513 "Options:" \
2514 "\n -k Make module autoclean-able" \
2515 "\n -n Dry run" \
2516 "\n -q Quiet" \
2517 "\n -r Remove module (stacks) or do autoclean" \
2518 "\n -s Report via syslog instead of stderr" \
2519 "\n -v Verbose" \
2520
Rob Landley9c32a152005-12-11 20:12:24 +00002521#define modprobe_notes_usage \
2522"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2523"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2524"pass each module it loads.\n" \
2525"\n" \
2526"The configuration file is searched (in order) amongst:\n" \
2527"\n" \
2528" /etc/modprobe.conf (2.6 only)\n" \
2529" /etc/modules.conf\n" \
2530" /etc/conf.modules (deprecated)\n" \
2531"\n" \
2532"They all have the same syntax (see below). If none is present, it is\n" \
2533"_not_ an error; each loaded module is then expected to load without\n" \
2534"options. Once a file is found, the others are tested for.\n" \
2535"\n" \
2536"/etc/modules.conf entry format:\n" \
2537"\n" \
2538" alias <alias_name> <mod_name>\n" \
2539" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002540" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002541" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2542" This makes it also possible to use a different set of options (below) for\n" \
2543" the module and the alias.\n" \
2544" A module can be aliased more than once.\n" \
2545"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002546" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002547" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2548" the \"symbol=value\" pairs as option to that module.\n" \
2549"\n" \
2550"Sample /etc/modules.conf file:\n" \
2551"\n" \
2552" options tulip irq=3\n" \
2553" alias tulip tulip2\n" \
2554" options tulip2 irq=4 io=0x308\n" \
2555"\n" \
2556"Other functionality offered by 'classic' modprobe is not available in\n" \
2557"this implementation.\n" \
2558"\n" \
2559"If module options are present both in the config file, and on the command line,\n" \
2560"then the options from the command line will be passed to the module _after_\n" \
2561"the options from the config file. That way, you can have defaults in the config\n" \
2562"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002563#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002564 "(with the above /etc/modules.conf):\n\n" \
2565 "$ modprobe tulip\n" \
2566 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2567 "$ modprobe tulip irq=5\n" \
2568 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2569 "$ modprobe tulip2\n" \
2570 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2571 " which are the default for alias 'tulip2'\n\n" \
2572 "$ modprobe tulip2 irq=8\n" \
2573 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2574 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2575 " from the command line\n\n" \
2576 "$ modprobe tulip2 irq=2 io=0x210\n" \
2577 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2578 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2579 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002580
Eric Andersen7e9276b2001-02-22 01:15:47 +00002581#define more_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002582 "[FILE...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002583#define more_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002584 "View FILE or standard input one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002585
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002586#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002587 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002588
Eric Andersen7e9276b2001-02-22 01:15:47 +00002589#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002590 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002591#define mount_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002592 "Mount a filesystem. Filesystem autodetection requires /proc be mounted.\n" \
2593 "\nOptions:" \
2594 "\n -a Mount all filesystems in fstab" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002595 USE_FEATURE_MOUNT_FAKE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002596 "\n -f "USE_FEATURE_MTAB_SUPPORT("Update /etc/mtab, but ")"don't mount" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002597 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002598 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002599 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002600 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002601 "\n -r Read-only mount" \
2602 "\n -t fs-type Filesystem type" \
2603 "\n -w Read-write mount (default)" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002604 "\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002605 "-o option:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002606 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002607 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002608 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002609 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002610 " [a]sync Writes are asynchronous / synchronous\n" \
2611 " [no]atime Disable / enable updates to inode access times\n" \
2612 " [no]diratime Disable / enable atime updates to directories\n" \
2613 " [no]dev Allow use of special device files / disallow them\n" \
2614 " [no]exec Allow use of executable files / disallow them\n" \
2615 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2616 " [r]shared Convert [recursively] to a shared subtree\n" \
2617 " [r]slave Convert [recursively] to a slave subtree\n" \
2618 " [r]private Convert [recursively] to a private subtree\n" \
2619 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2620 " bind Bind a directory to an additional location\n" \
2621 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002622 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002623 " remount Remount a mounted filesystem, changing its flags\n" \
2624 " ro/rw Mount for read-only / read-write\n" \
2625 "\n" \
2626 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002627 "You'll have to see the written documentation for those filesystems" \
2628
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002629#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002630 "$ mount\n" \
2631 "/dev/hda3 on / type minix (rw)\n" \
2632 "proc on /proc type proc (rw)\n" \
2633 "devpts on /dev/pts type devpts (rw)\n" \
2634 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2635 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2636 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002637#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002638 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002639
Rob Landleyd00b3a52005-08-20 05:07:08 +00002640#define mountpoint_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002641 "[-q] <[-d] DIR | -x DEVICE>"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002642#define mountpoint_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002643 "mountpoint checks if the directory is a mountpoint\n" \
2644 "\nOptions:" \
2645 "\n -q Quiet" \
2646 "\n -d Print major/minor device number of the filesystem" \
2647 "\n -x Print major/minor device number of the blockdevice" \
2648
Rob Landleyd00b3a52005-08-20 05:07:08 +00002649#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002650 "$ mountpoint /proc\n" \
2651 "/proc is not a mountpoint\n" \
2652 "$ mountpoint /sys\n" \
2653 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002654
Eric Andersen7e9276b2001-02-22 01:15:47 +00002655#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002656 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002657#define mt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002658 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002659 "\n" \
2660 "Available Opcodes:\n" \
2661 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002662 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2663 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2664 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002665 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002666
Eric Andersen7e9276b2001-02-22 01:15:47 +00002667#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002668 "[OPTION]... SOURCE DEST\n" \
2669 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002670#define mv_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002671 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
2672 "\nOptions:" \
2673 "\n -f Don't prompt before overwriting" \
2674 "\n -i Interactive, prompt before overwrite" \
2675
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002676#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002677 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002678
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002679#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002680 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002681#define nameif_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002682 "Rename network interface while it in the down state\n" \
2683 "\nOptions:" \
2684 "\n -c FILE Use configuration file (default is /etc/mactab)" \
2685 "\n -s Use syslog (LOCAL0 facility)" \
2686 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
2687
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002688#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002689 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2690 " or\n" \
2691 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002692
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002693#if !ENABLE_DESKTOP
2694
Rob Landley1cca9482006-07-10 19:45:20 +00002695#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002696#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002697#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002698#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002699#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002700
Eric Andersen7e9276b2001-02-22 01:15:47 +00002701#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002702 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002703 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002704#define nc_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002705 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002706 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002707 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002708 "\n -e Exec rest of command line after connect" \
2709 "\n -i SECS Delay interval for lines sent" \
2710 "\n -w SECS Timeout for connect" \
2711 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002712 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002713 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002714 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002715 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002716 "\n (use -l twice with -e for persistent server)") \
2717 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002718 )
2719
Rob Landley1cca9482006-07-10 19:45:20 +00002720#define nc_notes_usage "" \
2721 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002722 "To use netcat as a terminal emulator on a serial port:\n\n" \
2723 "$ stty 115200 -F /dev/ttyS0\n" \
2724 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2725 )
Rob Landley1cca9482006-07-10 19:45:20 +00002726
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002727#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002728 "$ nc foobar.somedomain.com 25\n" \
2729 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2730 "help\n" \
2731 "214-Commands supported:\n" \
2732 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2733 "214 NOOP QUIT RSET HELP\n" \
2734 "quit\n" \
2735 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002736
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002737#else /* DESKTOP nc - much more compatible with nc 1.10 */
2738
2739#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002740 "[-options] hostname port - connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002741 USE_NC_SERVER("\n" \
2742 "nc [-options] -l -p port [hostname] [port] - listen")
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002743#define nc_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002744 "Options:" \
2745 "\n -e prog [args] Program to exec after connect (must be last)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002746 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002747 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002748 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002749 "\n -n Don't do DNS resolution" \
2750 "\n -s addr Local address" \
2751 "\n -p port Local port" \
2752 "\n -u UDP mode" \
2753 "\n -v Verbose (cumulative: -vv)" \
2754 "\n -w secs Timeout for connects and final net reads" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002755 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002756 "\n -i sec Delay interval for lines sent" /* ", ports scanned" */ \
2757 "\n -o file Hex dump of traffic" \
2758 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002759 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002760/* "\n -r Randomize local and remote ports" */
2761/* "\n -g gateway Source-routing hop point[s], up to 8" */
2762/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002763/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2764
2765#endif
2766
Eric Andersen1552ff72001-10-31 11:07:12 +00002767#define netstat_trivial_usage \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002768 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")"]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002769#define netstat_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002770 "Display networking information\n" \
2771 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002772 "\n -l Display listening server sockets" \
2773 "\n -a Display all sockets (default: connected)" \
2774 "\n -e Display other/more information" \
2775 "\n -n Don't resolve names" \
2776 "\n -t Tcp sockets" \
2777 "\n -u Udp sockets" \
2778 "\n -w Raw sockets" \
2779 "\n -x Unix sockets" \
2780 "\n -r Display routing table" \
2781 USE_FEATURE_NETSTAT_WIDE( \
2782 "\n -W Display with no column truncation" \
2783 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002784
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002785#define nice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002786 "[-n ADJUST] [COMMAND [ARG]...]"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002787#define nice_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002788 "Run a program with modified scheduling priority\n" \
2789 "\nOptions:" \
2790 "\n -n ADJUST Adjust the scheduling priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002791
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002792#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002793 "format_string"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002794#define nmeter_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002795 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002796 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002797 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002798 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002799 "%[niface] Monitor network interface 'iface'\n" \
2800 "%m Monitor allocated memory\n" \
2801 "%[mf] Monitor free memory\n" \
2802 "%[mt] Monitor total memory\n" \
2803 "%s Monitor allocated swap\n" \
2804 "%f Monitor number of used file descriptors\n" \
2805 "%Ni Monitor total/specific IRQ rate\n" \
2806 "%x Monitor context switch rate\n" \
2807 "%p Monitor forks\n" \
2808 "%[pn] Monitor # of processes\n" \
2809 "%b Monitor block io\n" \
2810 "%Nt Show time (with N decimal points)\n" \
2811 "%Nd Milliseconds between updates (default=1000)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002812 "%r Print <cr> instead of <lf> at EOL" \
2813
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002814#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002815 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002816
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002817#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002818 "COMMAND [ARGS]"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002819#define nohup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002820 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002821#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002822 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002823
Eric Andersen7e9276b2001-02-22 01:15:47 +00002824#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002825 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002826#define nslookup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002827 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002828 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002829#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002830 "$ nslookup localhost\n" \
2831 "Server: default\n" \
2832 "Address: default\n" \
2833 "\n" \
2834 "Name: debian\n" \
2835 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002836
Glenn L McGrath60281112001-11-02 11:39:46 +00002837#define od_trivial_usage \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002838 "[-aBbcDdeFfHhIiLlOovXx] " USE_DESKTOP("[-t TYPE] ") "[FILE]"
Glenn L McGrath60281112001-11-02 11:39:46 +00002839#define od_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002840 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002841 "to standard output. With no FILE or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002842
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002843#define openvt_trivial_usage \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00002844 "[-c NUM] [-sw] [COMMAND [ARGS]]"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002845#define openvt_full_usage \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00002846 "Start COMMAND on a new virtual terminal\n" \
2847 "\nOptions:" \
2848 "\n -c Use specified VT" \
2849 "\n -s Switch to the VT" \
2850/* "\n -l Run COMMAND as login shell (by prepending '-')" */ \
2851 "\n -w Wait for COMMAND to exit" \
2852
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002853#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002854 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002855
Eric Andersen27f64e12002-06-23 04:24:25 +00002856#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002857 "[OPTION] [name]"
Eric Andersen27f64e12002-06-23 04:24:25 +00002858#define passwd_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002859 "Change user's password. If no name is specified,\n" \
2860 "changes the password for the current user.\n" \
2861 "\nOptions:" \
2862 "\n -a Algorithm to use for password (choices: des, md5)" /* ", sha1)" */ \
2863 "\n -d Delete password for the account" \
2864 "\n -l Lock (disable) account" \
2865 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00002866
Denis Vlasenko21d10142007-07-20 21:28:41 +00002867#define chpasswd_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002868 USE_GETOPT_LONG("[--md5|--encrypt]") SKIP_GETOPT_LONG("[-m|-e]")
Denis Vlasenko21d10142007-07-20 21:28:41 +00002869#define chpasswd_full_usage \
2870 "Read user:password information from stdin\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002871 "and update /etc/passwd accordingly.\n" \
2872 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002873 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002874 "\n -e,--encrypt Supplied passwords are in encrypted form" \
2875 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002876 ) \
2877 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002878 "\n -e Supplied passwords are in encrypted form" \
2879 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002880 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00002881
Glenn L McGrath655d8142003-06-22 15:32:41 +00002882#define patch_trivial_usage \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00002883 "[-p NUM] [-i DIFF] [-R]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002884#define patch_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002885 " -p NUM Strip NUM leading components from file names" \
2886 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00002887 "\n -R Reverse patch" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002888
Glenn L McGrath655d8142003-06-22 15:32:41 +00002889#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002890 "$ patch -p1 < example.diff\n" \
2891 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002892
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002893#define pgrep_trivial_usage \
2894 "[-flnovx] pattern"
2895#define pgrep_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002896 "Display process(es) selected by regex pattern\n" \
2897 "\nOptions:" \
2898 "\n -l Show command name too" \
2899 "\n -f Match against entire command line" \
2900 "\n -n Show the newest process only" \
2901 "\n -o Show the oldest process only" \
2902 "\n -v Negate the matching" \
2903 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002904
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002905#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00002906#define pidof_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002907 "[OPTION] [NAME...]"
2908#define USAGE_PIDOF "\n\nOptions:"
2909#else
2910#define pidof_trivial_usage \
2911 "[NAME...]"
2912#define USAGE_PIDOF /* none */
2913#endif
Eric Andersen221b2ea2001-07-31 19:06:07 +00002914#define pidof_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002915 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002916 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002917 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002918 "\n -s Show only one PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002919 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002920 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002921 "\n Use %PPID to omit pid of pidof's parent") \
2922
Eric Andersen221b2ea2001-07-31 19:06:07 +00002923#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002924 "$ pidof init\n" \
2925 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002926 USE_FEATURE_PIDOF_OMIT( \
2927 "$ pidof /bin/sh\n20351 5973 5950\n") \
2928 USE_FEATURE_PIDOF_OMIT( \
2929 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002930
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002931#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002932#define ping_trivial_usage \
2933 "host"
2934#define ping_full_usage \
2935 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002936#define ping6_trivial_usage \
2937 "host"
2938#define ping6_full_usage \
2939 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002940#else
2941#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002942 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002943#define ping_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002944 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
2945 "\nOptions:" \
2946 "\n -4, -6 Force IPv4 or IPv6 hostname resolution" \
2947 "\n -c CNT Send only CNT pings" \
2948 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
2949 "\n -I iface/IP Use interface or IP address as source" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00002950 "\n -W timeout Seconds to wait for the first response (default:10)" \
2951 "\n (after all -c CNT packets are sent)" \
2952 "\n -w deadline Seconds until ping exits (default:infinite)" \
2953 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002954 "\n -q Quiet, only displays output at start" \
2955 "\n and when finished" \
2956
Eric Andersen51b8bd62002-07-03 11:46:38 +00002957#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002958 "[OPTION]... host"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002959#define ping6_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002960 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
2961 "\nOptions:" \
2962 "\n -c CNT Send only CNT pings" \
2963 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
2964 "\n -I iface/IP Use interface or IP address as source" \
2965 "\n -q Quiet, only displays output at start" \
2966 "\n and when finished" \
2967
Eric Andersen51b8bd62002-07-03 11:46:38 +00002968#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002969#define ping_example_usage \
2970 "$ ping localhost\n" \
2971 "PING slag (127.0.0.1): 56 data bytes\n" \
2972 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2973 "\n" \
2974 "--- debian ping statistics ---\n" \
2975 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2976 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002977#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002978 "$ ping6 ip6-localhost\n" \
2979 "PING ip6-localhost (::1): 56 data bytes\n" \
2980 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2981 "\n" \
2982 "--- ip6-localhost ping statistics ---\n" \
2983 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2984 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002985
Eric Andersen7e9276b2001-02-22 01:15:47 +00002986#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002987 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002988#define pivot_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002989 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002990 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002991
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002992#define pkill_trivial_usage \
2993 "[-l] | [-fnovx] [-signal] pattern"
2994#define pkill_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002995 "Send a signal to process(es) selected by regex pattern\n" \
2996 "\nOptions:" \
2997 "\n -l List all signals" \
2998 "\n -f Match against entire command line" \
2999 "\n -n Signal the newest process only" \
3000 "\n -o Signal the oldest process only" \
3001 "\n -v Negate the matching" \
3002 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003003
Eric Andersen7e9276b2001-02-22 01:15:47 +00003004#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003005 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003006#define poweroff_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003007 "Halt and shut off power\n" \
3008 "\nOptions:" \
3009 "\n -d Delay interval for halting" \
3010 "\n -n No call to sync()" \
3011 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003012
Mike Frysinger95d3c452005-04-21 23:29:24 +00003013#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003014 "[VARIABLES...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003015#define printenv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003016 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003017 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003018
Eric Andersen7e9276b2001-02-22 01:15:47 +00003019#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003020 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003021#define printf_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003022 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003023 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003024#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003025 "$ printf \"Val=%d\\n\" 5\n" \
3026 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003027
Denis Vlasenko94949192006-11-05 00:45:47 +00003028
3029#if ENABLE_DESKTOP
3030
3031#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003032 ""
Denis Vlasenko94949192006-11-05 00:45:47 +00003033#define ps_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003034 "Report process status\n" \
3035 "\nOptions:" \
3036 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00003037
3038#else /* !ENABLE_DESKTOP */
3039
Denis Vlasenko397de612008-03-17 08:55:44 +00003040#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003041#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003042#else
3043#define USAGE_PS "\nOptions:"
3044#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003045
Eric Andersen7e9276b2001-02-22 01:15:47 +00003046#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003047 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003048#define ps_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003049 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003050 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003051 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003052 "\n -Z Show SE Linux context" \
3053 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003054 USE_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003055 "\n w Wide output" \
3056 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003057
Denis Vlasenko94949192006-11-05 00:45:47 +00003058#endif /* ENABLE_DESKTOP */
3059
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003060#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003061 "$ ps\n" \
3062 " PID Uid Gid State Command\n" \
3063 " 1 root root S init\n" \
3064 " 2 root root S [kflushd]\n" \
3065 " 3 root root S [kupdate]\n" \
3066 " 4 root root S [kpiod]\n" \
3067 " 5 root root S [kswapd]\n" \
3068 " 742 andersen andersen S [bash]\n" \
3069 " 743 andersen andersen S -bash\n" \
3070 " 745 root root S [getty]\n" \
3071 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003072
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003073#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003074 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003075#define pscan_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003076 "Scan a host, print all open ports\n" \
3077 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003078 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003079 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003080 "\n -p Scan from this port (default 1)" \
3081 "\n -P Scan up to this port (default 1024)" \
3082 "\n -t Timeout (default 5000 ms)" \
3083 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3084
Eric Andersen7e9276b2001-02-22 01:15:47 +00003085#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003086 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003087#define pwd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003088 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003089#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003090 "$ pwd\n" \
3091 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003092
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003093#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003094 "DEVICE"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003095#define raidautorun_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003096 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003097#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003098 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003099
Eric Andersen7e9276b2001-02-22 01:15:47 +00003100#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003101 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003102#define rdate_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003103 "Get and possibly set the system date and time from a remote HOST\n" \
3104 "\nOptions:" \
3105 "\n -s Set the system date and time (default)" \
3106 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003107
Rob Landley0e4690d2006-08-20 22:12:18 +00003108#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003109 "[FILE]..."
Rob Landley0e4690d2006-08-20 22:12:18 +00003110#define readahead_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003111 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
3112 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00003113
Eric Andersen7e9276b2001-02-22 01:15:47 +00003114#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003115 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003116#define readlink_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003117 "Display the value of a symlink" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003118 USE_FEATURE_READLINK_FOLLOW( "\n" \
3119 "\nOptions:" \
3120 "\n -f Canonicalize by following all symlinks") \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003121
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003122#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003123 "[OPTIONS]..."
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003124#define readprofile_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003125 "Options:" \
3126 "\n -m mapfile (Default: /boot/System.map)" \
3127 "\n -p profile (Default: /proc/profile)" \
3128 "\n -M mult Set the profiling multiplier to mult" \
3129 "\n -i Print only info about the sampling step" \
3130 "\n -v Verbose" \
3131 "\n -a Print all symbols, even if count is 0" \
3132 "\n -b Print individual histogram-bin counts" \
3133 "\n -s Print individual counters within functions" \
3134 "\n -r Reset all the counters (root only)" \
3135 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003136
Glenn L McGrath62fae302002-12-10 00:14:33 +00003137#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003138 "pathname..."
Glenn L McGrath62fae302002-12-10 00:14:33 +00003139#define realpath_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003140 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00003141
Eric Andersen7e9276b2001-02-22 01:15:47 +00003142#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003143 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003144#define reboot_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003145 "Reboot the system\n" \
3146 "\nOptions:" \
3147 "\n -d Delay interval for rebooting" \
3148 "\n -n No call to sync()" \
3149 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003150
3151#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003152 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003153#define renice_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003154 "Change priority of running processes\n" \
3155 "\nOptions:" \
3156 "\n -n Adjust current nice value (smaller is faster)" \
3157 "\n -p Process id(s) (default)" \
3158 "\n -g Process group id(s)" \
3159 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003160
Eric Andersen7e9276b2001-02-22 01:15:47 +00003161#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003162 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003163#define reset_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003164 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003165
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003166#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003167 ""
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003168#define resize_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003169 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003170
Denis Vlasenko397137b2007-07-23 14:03:30 +00003171#define restorecon_trivial_usage \
3172 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
3173#define restorecon_full_usage \
3174 "Reset security contexts of files in pathname\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003175 "\n -i Ignore files that do not exist" \
3176 "\n -f file File with list of files to process. Use - for stdin" \
3177 "\n -e directory Directory to exclude" \
3178 "\n -R,-r Recurse directories" \
3179 "\n -n Don't change any file labels" \
3180 "\n -o file Save list of files with incorrect context" \
3181 "\n -v Verbose" \
3182 "\n -vv Show changed labels" \
3183 "\n -F Force reset of context to match file_context" \
3184 "\n for customizable files, or the user section," \
3185 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003186
Eric Andersen7e9276b2001-02-22 01:15:47 +00003187#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003188 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003189#define rm_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003190 "Remove (unlink) the FILE(s). Use '--' to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003191 "indicate that all following arguments are non-options.\n" \
3192 "\nOptions:" \
3193 "\n -i Always prompt before removing" \
3194 "\n -f Never prompt" \
3195 "\n -r,-R Remove directories recursively" \
3196
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003197#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003198 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003199
Eric Andersen7e9276b2001-02-22 01:15:47 +00003200#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003201 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003202#define rmdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003203 "Remove the DIRECTORY, if it is empty"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003204#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003205 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003206
Eric Andersen7e9276b2001-02-22 01:15:47 +00003207#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003208 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003209#define rmmod_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003210 "Unload the specified kernel modules from the kernel\n" \
3211 "\nOptions:" \
3212 "\n -a Remove all unused modules (recursively)" \
3213
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003214#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003215 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003216
Eric Andersen7e9276b2001-02-22 01:15:47 +00003217#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003218 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003219#define route_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003220 "Edit the kernel's routing tables\n" \
3221 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003222 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003223 "\n -e Display other/more information" \
3224 "\n -A inet" USE_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003225
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003226#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003227 "-i -q[ildc]p package.rpm"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003228#define rpm_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003229 "Manipulate RPM packages\n" \
3230 "\nOptions:" \
3231 "\n -i Install package" \
3232 "\n -q Query package" \
3233 "\n -p Query uninstalled package" \
3234 "\n -i Show information" \
3235 "\n -l List contents" \
3236 "\n -d List documents" \
3237 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003238
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003239#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003240 "package.rpm"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003241#define rpm2cpio_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003242 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003243
Mike Frysinger6b160e42008-02-15 02:27:19 +00003244#define rtcwake_trivial_usage \
3245 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SECS | -t TIME]"
3246#define rtcwake_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003247 "Enter a system sleep state until specified wakeup time\n" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003248 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003249 "\n -a,--auto Read clock mode from adjtime" \
3250 "\n -l,--local Clock is set to local time" \
3251 "\n -u,--utc Clock is set to UTC time" \
3252 "\n -d,--device=DEV Specify the RTC device" \
3253 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
3254 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
3255 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003256 ) \
3257 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003258 "\n -a Read clock mode from adjtime" \
3259 "\n -l Clock is set to local time" \
3260 "\n -u Clock is set to UTC time" \
3261 "\n -d DEV Specify the RTC device" \
3262 "\n -m MODE Set the sleep state (default: standby)" \
3263 "\n -s SEC Set the timeout in SEC seconds from now" \
3264 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003265 )
3266
Denis Vlasenko49622d72007-03-10 16:58:49 +00003267#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003268 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3269 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko49622d72007-03-10 16:58:49 +00003270#define runcon_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003271 "Run a program in a different security context\n" \
3272 "\n CONTEXT Complete security context\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003273 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003274 "\n -c,--compute Compute process transition context before modifying" \
3275 "\n -t,--type=TYPE Type (for same role as parent)" \
3276 "\n -u,--user=USER User identity" \
3277 "\n -r,--role=ROLE Role" \
3278 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003279 ) \
3280 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003281 "\n -c Compute process transition context before modifying" \
3282 "\n -t TYPE Type (for same role as parent)" \
3283 "\n -u USER User identity" \
3284 "\n -r ROLE Role" \
3285 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003286 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003287
Eric Andersen6cf47a72001-10-31 10:24:36 +00003288#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003289 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003290#define run_parts_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003291 "Run a bunch of scripts in a directory\n" \
3292 "\nOptions:" \
3293 "\n -t Print what would be run, but don't actually run anything" \
3294 "\n -a ARG Pass ARG as argument for every program" \
3295 "\n -u MASK Set the umask to MASK before running every program" \
3296 USE_FEATURE_RUN_PARTS_FANCY( \
3297 "\n -l Print names of all matching files even if they are not executable" \
3298 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003299
3300#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003301 "$ run-parts -a start /etc/init.d\n" \
3302 "$ run-parts -a stop=now /etc/init.d\n\n" \
3303 "Let's assume you have a script foo/dosomething:\n" \
3304 "#!/bin/sh\n" \
3305 "for i in $*; do eval $i; done; unset i\n" \
3306 "case \"$1\" in\n" \
3307 "start*) echo starting something;;\n" \
3308 "stop*) set -x; shutdown -h $stop;;\n" \
3309 "esac\n\n" \
3310 "Running this yields:\n" \
3311 "$run-parts -a stop=+4m foo/\n" \
3312 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003313
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003314#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003315 "[utmp]"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003316#define runlevel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003317 "Find the current and previous system runlevel.\n\n" \
3318 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003319 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003320#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003321 "$ runlevel /var/run/utmp\n" \
3322 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003323
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003324#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003325 "dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003326#define runsv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003327 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003328
3329#define runsvdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003330 "[-P] dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003331#define runsvdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003332 "Start a runsv process for each subdirectory"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003333
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003334#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003335 "FILE"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003336#define rx_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003337 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003338#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003339 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003340
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003341#define script_trivial_usage \
3342 "[-afq] [-c COMMAND] [OUTFILE]"
3343#define script_full_usage \
3344 "Options:" \
3345 "\n -a Append output" \
3346 "\n -c Run COMMAND, not shell" \
3347 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003348 "\n -q Quiet" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003349
Eric Andersen7e9276b2001-02-22 01:15:47 +00003350#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003351 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003352#define sed_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003353 "Options:" \
3354 "\n -e script Add the script to the commands to be executed" \
3355 "\n -f scriptfile Add scriptfile contents to the" \
3356 "\n commands to be executed" \
3357 "\n -i Edit files in-place" \
3358 "\n -n Suppress automatic printing of pattern space" \
3359 "\n -r Use extended regular expression syntax" \
3360 "\n" \
3361 "\nIf no -e or -f is given, the first non-option argument is taken as the sed" \
3362 "\nscript to interpret. All remaining arguments are names of input files; if no" \
3363 "\ninput files are specified, then the standard input is read. Source files" \
3364 "\nwill not be modified unless -i option is given." \
Eric Andersenf802ff72004-04-12 15:12:06 +00003365
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003366#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003367 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3368 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003369
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003370#define selinuxenabled_trivial_usage
3371#define selinuxenabled_full_usage
3372
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003373#define sendmail_trivial_usage \
Denis Vlasenko17db1a92008-02-26 21:13:17 +00003374 "[-w timeout] [-U user] [-P password] [-X]\n" \
3375 "-t to [-t to]... [-n] [-s subject] [-c charset] server[:port] from [body] [attachment ...]"
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003376#define sendmail_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003377 "Send an email.\n" \
3378 "\nOptions:" \
3379 "\n -w timeout Set timeout on network operations" \
3380 "\n -U username Authenticate with specified username/password" \
3381 "\n -P password" \
3382 "\n -t address Recipient(s). May be repeated" \
3383 "\n -X Use openssl connection helper for secured servers" \
3384 "\n -n Request delivery notification to sender" \
3385 "\n -s subject Subject" \
3386 "\n -c charset Assumed charset for body and subject [utf-8]" \
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003387
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003388#define seq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003389 "[first [increment]] last"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003390#define seq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003391 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003392 "FIRST, INCREMENT default to 1" \
3393 "\n\nArguments:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003394 " LAST\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003395 " FIRST LAST\n" \
3396 " FIRST INCREMENT LAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003397
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003398#define sestatus_trivial_usage \
3399 "[-vb]"
3400#define sestatus_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003401 " -v Verbose" \
3402 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003403
Paul Foxfc2256a2005-08-01 18:12:30 +00003404#define setconsole_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003405 "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Paul Foxfc2256a2005-08-01 18:12:30 +00003406#define setconsole_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003407 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3408 "\nOptions:" \
3409 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003410
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003411#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003412 "[Enforcing | Permissive | 1 | 0]"
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003413#define setenforce_full_usage
3414
Denis Vlasenko397137b2007-07-23 14:03:30 +00003415#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003416 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003417 USE_FEATURE_SETFILES_CHECK_OPTION( \
3418 " [-c policyfile] spec_file" \
3419 ) \
3420 " pathname"
Denis Vlasenko397137b2007-07-23 14:03:30 +00003421#define setfiles_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003422 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003423 USE_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003424 "\n -c file Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003425 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003426 "\n -d Show which specification matched each file" \
3427 "\n -l Log changes in file labels to syslog" \
3428 "\n -n Don't change any file labels" \
3429 "\n -q Suppress warnings" \
3430 "\n -r dir Use an altenate root path" \
3431 "\n -e dir Exclude directory" \
3432 "\n -F Force reset of context to match file_context for customizable files" \
3433 "\n -o file Save list of files with incorrect context" \
3434 "\n -s Take a list of files from standard input (instead of command line)" \
3435 "\n -v Show changes in file labels, if type or role are changing" \
3436 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3437 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003438
Eric Andersen7e9276b2001-02-22 01:15:47 +00003439#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003440 "SCANCODE KEYCODE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003441#define setkeycodes_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003442 "Set entries into the kernel's scancode-to-keycode map,\n" \
3443 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3444 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003445 "and KEYCODE is given in decimal" \
3446
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003447#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003448 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003449
Rob Landley87848d92006-03-27 23:23:43 +00003450#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003451 "N"
Rob Landley87848d92006-03-27 23:23:43 +00003452#define setlogcons_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003453 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003454
Denis Vlasenkobe039372007-10-14 04:48:44 +00003455#define setsebool_trivial_usage \
3456 "boolean value"
3457
3458#define setsebool_full_usage \
3459 "Change boolean setting"
3460
Paul Fox42403642005-08-01 22:52:09 +00003461#define setsid_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003462 "PROG [ARG...]"
Paul Fox42403642005-08-01 22:52:09 +00003463#define setsid_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003464 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3465 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3466 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003467
Matt Kraai2d91deb2001-08-01 17:21:35 +00003468#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003469 "[FILE]...\n" \
3470 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00003471#define lash_full_usage \
Denis Vlasenko96702ca2007-11-23 23:28:55 +00003472 "lash is deprecated, please use hush"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003473
Eric Andersen2e9c2572003-08-08 22:26:06 +00003474#define last_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003475 ""
Eric Andersen2e9c2572003-08-08 22:26:06 +00003476#define last_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003477 "Show listing of the last users that logged into the system"
Eric Andersen2e9c2572003-08-08 22:26:06 +00003478
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003479#define sha1sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003480 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003481 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003482#define sha1sum_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003483 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
3484 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
3485 "\nOptions:" \
3486 "\n -c Check SHA1 sums against given list" \
3487 "\n -s Don't output anything, status code shows success" \
3488 "\n -w Warn about improperly formatted SHA1 checksum lines" \
3489 )
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003490
Denis Vlasenko14923db2007-06-20 15:23:03 +00003491#define slattach_trivial_usage \
3492 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
3493#define slattach_full_usage \
3494 "Attach network interface(s) to serial line(s)\n" \
3495 "\nOptions:" \
3496 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3497 "\n -s Set line speed" \
3498 "\n -e Exit after initializing device" \
3499 "\n -h Exit when the carrier is lost" \
3500 "\n -c Execute a command when the line is hung up" \
3501 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3502 "\n -L Enable 3-wire operation" \
3503 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003504
Eric Andersen7e9276b2001-02-22 01:15:47 +00003505#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003506 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003507#define sleep_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003508 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003509 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003510 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003511 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003512#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003513 "$ sleep 2\n" \
3514 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003515 USE_FEATURE_FANCY_SLEEP( \
3516 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003517 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003518
Eric Andersen7e9276b2001-02-22 01:15:47 +00003519#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003520 "[-nru" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003521 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003522 "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003523#define sort_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003524 "Sort lines of text\n" \
3525 "\nOptions:" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003526 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003527 "\n -b Ignore leading blanks" \
3528 "\n -c Check whether input is sorted" \
3529 "\n -d Dictionary order (blank or alphanumeric only)" \
3530 "\n -f Ignore case" \
3531 "\n -g General numerical sort" \
3532 "\n -i Ignore unprintable characters" \
3533 "\n -k Sort key" \
3534 "\n -M Sort month" \
3535 ) \
3536 "\n -n Sort numbers" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003537 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003538 "\n -o Output to file" \
3539 "\n -k Sort by key" \
3540 "\n -t CHAR Key separator" \
3541 ) \
3542 "\n -r Reverse sort order" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003543 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003544 "\n -s Stable (don't sort ties alphabetically)" \
3545 ) \
3546 "\n -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003547 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003548 "\n -z Lines are terminated by NUL, not newline" \
3549 "\n -mST Ignored for GNU compatibility") \
3550
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003551#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003552 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3553 "a\n" \
3554 "b\n" \
3555 "c\n" \
3556 "d\n" \
3557 "e\n" \
3558 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003559 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003560 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3561 "d 2\n" \
3562 "b 2\n" \
3563 "c 3\n" \
3564 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003565 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003566
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003567#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003568 "[OPTION] [INPUT [PREFIX]]"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003569#define split_full_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003570 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003571 "\n -b n[k|m] Split by bytes" \
3572 "\n -l n Split by lines" \
3573 "\n -a n Use n letters as suffix" \
3574
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003575#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003576 "$ split TODO foo\n" \
3577 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003578
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003579#define start_stop_daemon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003580 "[OPTIONS] [" \
3581 USE_GETOPT_LONG("--start|--stop") SKIP_GETOPT_LONG("-S|-K") \
3582 "] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003583#define start_stop_daemon_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003584 "Start and stop services\n" \
3585 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003586 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003587 "\n -S,--start Start" \
3588 "\n -K,--stop Stop" \
3589 "\n -a,--startas pathname Start process specified by pathname" \
3590 "\n -b,--background Put process into background" \
3591 "\n -u,--user username|uid Stop this user's processes" \
3592 "\n -x,--exec executable Program to either start or check" \
3593 "\n -n,--name process-name Stop processes with this name" \
3594 "\n -p,--pidfile pid-file Save or load pid using a pid-file" \
3595 "\n -m,--make-pidfile Create the -p file and enter pid in it" \
3596 "\n -q,--quiet Quiet" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003597 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003598 "\n -o,--oknodo Exit status 0 if nothing done" \
3599 "\n -v,--verbose Verbose" \
3600 "\n -N,--nicelevel N Add N to process's nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003601 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003602 "\n -s,--signal signal Signal to send (default TERM)" \
3603 "\n -c,--chuid user[:[grp]] Change to specified user/group" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003604 ) \
3605 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003606 "\n -S Start" \
3607 "\n -K Stop" \
3608 "\n -a pathname Start process specified by pathname" \
3609 "\n -b Put process into background" \
3610 "\n -u username|uid Stop this user's processes" \
3611 "\n -x executable Program to either start or check" \
3612 "\n -n process-name Stop processes with this name" \
3613 "\n -p pid-file Save or load pid using a pid-file" \
3614 "\n -m Create the -p file and enter pid in it" \
3615 "\n -q Quiet" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003616 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003617 "\n -o Exit status 0 if nothing done" \
3618 "\n -v Verbose" \
3619 "\n -N N Add N to process's nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003620 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003621 "\n -s signal Signal to send (default TERM)" \
3622 "\n -c user[:[grp]] Change to specified user/group" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003623 )
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003624
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003625#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003626 "[OPTION] FILE..."
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003627#define stat_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003628 "Display file (default) or filesystem status\n" \
3629 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003630 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003631 "\n -c fmt Use the specified format" \
3632 ) \
3633 "\n -f Display filesystem status" \
3634 "\n -L Dereference links" \
3635 "\n -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003636 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003637 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003638 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003639 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003640 "\n\nValid format sequences for files:\n" \
3641 " %a Access rights in octal\n" \
3642 " %A Access rights in human readable form\n" \
3643 " %b Number of blocks allocated (see %B)\n" \
3644 " %B The size in bytes of each block reported by %b\n" \
3645 " %d Device number in decimal\n" \
3646 " %D Device number in hex\n" \
3647 " %f Raw mode in hex\n" \
3648 " %F File type\n" \
3649 " %g Group ID of owner\n" \
3650 " %G Group name of owner\n" \
3651 " %h Number of hard links\n" \
3652 " %i Inode number\n" \
3653 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003654 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003655 " %o I/O block size\n" \
3656 " %s Total size, in bytes\n" \
3657 " %t Major device type in hex\n" \
3658 " %T Minor device type in hex\n" \
3659 " %u User ID of owner\n" \
3660 " %U User name of owner\n" \
3661 " %x Time of last access\n" \
3662 " %X Time of last access as seconds since Epoch\n" \
3663 " %y Time of last modification\n" \
3664 " %Y Time of last modification as seconds since Epoch\n" \
3665 " %z Time of last change\n" \
3666 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003667 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003668 " %a Free blocks available to non-superuser\n" \
3669 " %b Total data blocks in file system\n" \
3670 " %c Total file nodes in file system\n" \
3671 " %d Free file nodes in file system\n" \
3672 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003673 USE_SELINUX( \
3674 " %C Security context in SELinux\n" \
3675 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003676 " %i File System ID in hex\n" \
3677 " %l Maximum length of filenames\n" \
3678 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003679 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003680 " %S Fundamental block size (for block counts)\n" \
3681 " %t Type in hex\n" \
3682 " %T Type in human readable form" \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003683 )
3684
Eric Andersenef5e8f82002-11-07 02:09:37 +00003685#define strings_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003686 "[-afo] [-n length] [file...]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003687#define strings_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003688 "Display printable strings in a binary file\n" \
3689 "\nOptions:" \
3690 "\n -a Scan whole file (default)" \
3691 "\n -f Precede strings with filenames" \
3692 "\n -n N At least N characters form a string (default 4)" \
3693 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00003694
Eric Andersen7e9276b2001-02-22 01:15:47 +00003695#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003696 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003697#define stty_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003698 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003699 "and deviations from stty sane\n" \
3700 "\nOptions:" \
3701 "\n -F DEVICE Open device instead of stdin" \
3702 "\n -a Print all current settings in human-readable form" \
3703 "\n -g Print in stty-readable form" \
3704 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003705
Robert Griebl1fca5582002-06-04 20:45:46 +00003706#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003707 "[OPTION]... [-] [username]"
Robert Griebl1fca5582002-06-04 20:45:46 +00003708#define su_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003709 "Change user id or become root\n" \
3710 "\nOptions:" \
3711 "\n -p, -m Preserve environment" \
3712 "\n -c Command to pass to 'sh -c'" \
3713 "\n -s Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00003714
Eric Andersen27f64e12002-06-23 04:24:25 +00003715#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003716 "[OPTION]... [tty-device]"
Eric Andersen27f64e12002-06-23 04:24:25 +00003717#define sulogin_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003718 "Single user login\n" \
3719 "\nOptions:" \
3720 "\n -t Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003721
Mike Frysinger95d3c452005-04-21 23:29:24 +00003722#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003723 "[rs] [files...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003724#define sum_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003725 "Checksum and count the blocks in a file\n" \
3726 "\nOptions:" \
3727 "\n -r Use BSD sum algorithm (1K blocks)" \
3728 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00003729
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003730#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003731 "[-v] [-w sec] command service..."
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003732#define sv_full_usage \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003733 "Control services monitored by runsv supervisor.\n" \
3734 "Commands (only first character is enough):\n" \
3735 "\n" \
3736 "status: query service status\n" \
3737 "up: if service isn't running, start it. If service stops, restart it\n" \
3738 "once: like 'up', but if service stops, don't restart it\n" \
3739 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
3740 " if it exists. After it stops, do not restart service\n" \
3741 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
3742 " runsv exits too\n" \
3743 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003744 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003745
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003746#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003747 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003748#define svlogd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003749 "Continuously read log data from standard input, optionally " \
3750 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko397de612008-03-17 08:55:44 +00003751 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003752
Eric Andersen7e9276b2001-02-22 01:15:47 +00003753#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003754 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003755#define swapoff_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003756 "Stop swapping on DEVICE\n" \
3757 "\nOptions:" \
3758 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003759
Eric Andersen7e9276b2001-02-22 01:15:47 +00003760#define swapon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003761 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003762#define swapon_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003763 "Start swapping on DEVICE\n" \
3764 "\nOptions:" \
3765 "\n -a Start swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003766
Rob Landley0f34a822005-10-27 22:55:50 +00003767#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003768 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00003769#define switch_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003770 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003771 "and exec NEW_INIT\n" \
3772 "\nOptions:" \
3773 "\n -c Redirect console to device on new root" \
Rob Landley0f34a822005-10-27 22:55:50 +00003774
Eric Andersen7e9276b2001-02-22 01:15:47 +00003775#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003776 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003777#define sync_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003778 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003779
Eric Andersenb9050282003-12-24 06:02:11 +00003780#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003781 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003782#define sysctl_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003783 "Configure kernel parameters at runtime\n" \
3784 "\nOptions:" \
3785 "\n -n Disable printing of key names" \
3786 "\n -e Don't warn about unknown keys" \
3787 "\n -w Change sysctl setting" \
3788 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
3789 "\n -a Display all values" \
3790 "\n -A Display all values in table form" \
3791
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003792#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00003793 "sysctl [-n] [-e] variable...\n" \
3794 "sysctl [-n] [-e] -w variable=value...\n" \
3795 "sysctl [-n] [-e] -a\n" \
3796 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
3797 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003798
Eric Andersen7e9276b2001-02-22 01:15:47 +00003799#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003800 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003801#define syslogd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003802 "System logging utility.\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003803 "Note that this version of syslogd ignores /etc/syslog.conf.\n" \
3804 "\nOptions:" \
3805 "\n -n Run in foreground" \
3806 "\n -O FILE Log to given file (default=/var/log/messages)" \
3807 "\n -l n Set local log level" \
3808 "\n -S Smaller logging output" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003809 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003810 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3811 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003812 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003813 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
3814 "\n -L Log locally and via network (default is network only if -R)") \
3815 USE_FEATURE_SYSLOGD_DUP( \
3816 "\n -D Drop duplicates") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003817 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003818 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00003819 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003820/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00003821
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003822#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003823 "$ syslogd -R masterlog:514\n" \
3824 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003825
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003826#define tac_trivial_usage \
3827 "[FILE]..."
3828#define tac_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003829 "Concatenate FILE(s) and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003830
Eric Andersen7e9276b2001-02-22 01:15:47 +00003831#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003832 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003833#define tail_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003834 "Print last 10 lines of each FILE to standard output.\n" \
3835 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003836 "file name. With no FILE, or when FILE is -, read standard input.\n" \
3837 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003838 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003839 "\n -c N[kbm] Output the last N bytes") \
3840 "\n -n N[kbm] Print last N lines instead of last 10" \
3841 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003842 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003843 "\n -q Never output headers giving file names" \
3844 "\n -s SEC Wait SEC seconds between reads with -f" \
3845 "\n -v Always output headers giving file names" \
3846 "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003847 "If the first character of N (bytes or lines) is a '+', output begins with\n" \
3848 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003849 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) \
3850
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003851#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003852 "$ tail -n 1 /etc/resolv.conf\n" \
3853 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003854
Eric Andersen7e9276b2001-02-22 01:15:47 +00003855#define tar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003856 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_TAR_GZIP("z") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003857 USE_FEATURE_TAR_BZIP2("j") USE_FEATURE_TAR_LZMA("a") \
3858 USE_FEATURE_TAR_COMPRESS("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00003859 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003860 "[-f TARFILE] [-C DIR] [FILE(s)]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003861#define tar_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003862 "Create, extract, or list files from a tar file\n" \
3863 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003864 USE_FEATURE_TAR_CREATE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003865 "\n c Create") \
3866 "\n x Extract" \
3867 "\n t List" \
3868 "\nArchive format selection:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003869 USE_FEATURE_TAR_GZIP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003870 "\n z Filter the archive through gzip" \
3871 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003872 USE_FEATURE_TAR_BZIP2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003873 "\n j Filter the archive through bzip2" \
3874 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003875 USE_FEATURE_TAR_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003876 "\n a Filter the archive through lzma" \
3877 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003878 USE_FEATURE_TAR_COMPRESS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003879 "\n Z Filter the archive through compress" \
3880 ) \
3881 "\nFile selection:" \
3882 "\n f Name of TARFILE or \"-\" for stdin" \
3883 "\n O Extract to stdout" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003884 USE_FEATURE_TAR_FROM( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003885 "\n exclude File to exclude" \
3886 "\n X File with names to exclude" \
3887 ) \
3888 "\n C Change to directory DIR before operation" \
3889 "\n v Verbose" \
3890
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003891#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003892 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3893 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003894
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003895#define taskset_trivial_usage \
Denis Vlasenkob44c7902008-03-17 09:29:43 +00003896 "[-p] [mask] [pid | command [arg]...]"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003897#define taskset_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003898 "Set or get CPU affinity\n" \
3899 "\nOptions:" \
3900 "\n -p Operate on an existing PID" \
3901
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003902#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003903 "$ taskset 0x7 ./dgemm_test&\n" \
3904 "$ taskset -p 0x1 $!\n" \
3905 "pid 4790's current affinity mask: 7\n" \
3906 "pid 4790's new affinity mask: 1\n" \
3907 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
3908 "pid 6671's current affinity mask: 1\n" \
3909 "pid 6671's new affinity mask: 1\n" \
3910 "$ taskset -p 1\n" \
3911 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003912
Eric Andersen7e9276b2001-02-22 01:15:47 +00003913#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003914 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003915#define tee_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003916 "Copy standard input to each FILE, and also to standard output\n" \
3917 "\nOptions:" \
3918 "\n -a Append to the given FILEs, do not overwrite" \
3919 "\n -i Ignore interrupt signals (SIGINT)" \
3920
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003921#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003922 "$ echo \"Hello\" | tee /tmp/foo\n" \
3923 "$ cat /tmp/foo\n" \
3924 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003925
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003926#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00003927#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003928 "[-a] [-l USER] HOST [PORT]"
Eric Andersen539ffc92004-02-22 12:25:47 +00003929#define telnet_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003930 "Connect to telnet server\n" \
3931 "\nOptions:" \
3932 "\n -a Attempt an automatic login with USER variable" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003933 "\n -l USER Attempt an automatic login with USER argument" \
3934
Eric Andersen539ffc92004-02-22 12:25:47 +00003935#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003936#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003937 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003938#define telnet_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003939 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00003940#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003941
Eric Andersen08a72202002-09-30 20:52:10 +00003942#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003943 "[OPTION]"
Eric Andersen08a72202002-09-30 20:52:10 +00003944#define telnetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003945 "Handle incoming telnet connections" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003946 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
3947 "\nOptions:" \
3948 "\n -l LOGIN Exec LOGIN on connect" \
3949 "\n -f issue_file Display issue_file instead of /etc/issue" \
3950 "\n -K Close connection as soon as login exits" \
3951 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003952 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003953 "\n -p PORT Port to listen on" \
3954 "\n -b ADDR Address to bind to" \
3955 "\n -F Run in foreground" \
3956 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003957 )
Eric Andersen08a72202002-09-30 20:52:10 +00003958
Eric Andersen7e9276b2001-02-22 01:15:47 +00003959#define test_trivial_usage \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00003960 "EXPRESSION\n" \
3961 " or [ EXPRESSION ]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003962#define test_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003963 "Check file types and compares values returning an exit code\n" \
3964 "determined by the value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003965#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003966 "$ test 1 -eq 2\n" \
3967 "$ echo $?\n" \
3968 "1\n" \
3969 "$ test 1 -eq 1\n" \
3970 "$ echo $?\n" \
3971 "0\n" \
3972 "$ [ -d /etc ]\n" \
3973 "$ echo $?\n" \
3974 "0\n" \
3975 "$ [ -d /junk ]\n" \
3976 "$ echo $?\n" \
3977 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003978
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003979#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003980 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003981/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003982/* "[-hpEvv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] [-i dir|-x cdb] [-t sec] ip port prog..." */
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003983#define tcpsvd_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003984 "Create TCP socket, bind it to ip:port and listen\n" \
3985 "for incoming connection. Run PROG for each connection.\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003986 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003987 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003988 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003989 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3990 "\n-u user[:group] Change to user/group after bind" \
3991 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003992 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003993 "\n-C n[:msg] Allow only up to n connections from the same IP" \
3994 "\n New connections from this IP address are closed" \
3995 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003996 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003997 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003998 "\n-v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003999
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004000#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00004001 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004002#define udpsvd_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004003 "Create UDP socket, bind it to ip:port and wait\n" \
4004 "for incoming packets. Run PROG for each packet,\n" \
4005 "redirecting all further packets with same peer ip:port to it\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004006 "\nip IP to listen on. '0' = all" \
4007 "\nport Port to listen on" \
4008 "\nprog [arg] Program to run" \
4009 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4010 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004011 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004012 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004013 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004014 "\n-v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004015
Mark Whitley450736c2001-03-02 19:08:50 +00004016#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004017 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00004018#define tftp_full_usage \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004019 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004020 "\nOptions:" \
4021 "\n -l FILE Local FILE" \
4022 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004023 USE_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004024 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004025 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004026 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004027 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004028 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004029 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004030 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004031 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004032
4033#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004034 "[-cr] [-u USER] [DIR]"
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004035#define tftpd_full_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004036 "Transfer a file on tftp client's request.\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004037 "\nOptions:" \
4038 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004039 "\n -c Allow file creation via upload" \
4040 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004041
Eric Andersenc3657422001-11-30 07:54:32 +00004042#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004043 "[OPTION]... COMMAND [ARGS...]"
Eric Andersenc3657422001-11-30 07:54:32 +00004044#define time_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004045 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004046 "COMMAND's resource usage information is displayed.\n" \
4047 "\nOptions:" \
4048 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004049
Eric Andersen420b2082002-09-17 22:14:58 +00004050#define top_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004051 "[-b] [-n COUNT] [-d SECONDS]"
Eric Andersen420b2082002-09-17 22:14:58 +00004052#define top_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004053 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004054 "Read the status of all processes from /proc each SECONDS\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004055 "and show the status for however many processes will fit on the screen." \
Eric Andersen420b2082002-09-17 22:14:58 +00004056
Eric Andersen7e9276b2001-02-22 01:15:47 +00004057#define touch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004058 "[-c] FILE [FILE...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004059#define touch_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004060 "Update the last-modified date on the given FILE[s]\n" \
4061 "\nOptions:" \
4062 "\n -c Do not create any files" \
4063
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004064#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004065 "$ ls -l /tmp/foo\n" \
4066 "/bin/ls: /tmp/foo: No such file or directory\n" \
4067 "$ touch /tmp/foo\n" \
4068 "$ ls -l /tmp/foo\n" \
4069 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004070
4071#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004072 "[-cds] STRING1 [STRING2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004073#define tr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004074 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004075 "standard input, writing to standard output\n" \
4076 "\nOptions:" \
4077 "\n -c Take complement of STRING1" \
4078 "\n -d Delete input characters coded STRING1" \
4079 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4080
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004081#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004082 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4083 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004084
Eric Andersen5c58d282001-07-10 16:29:00 +00004085#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004086 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
4087 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004088 " [-z pausemsecs] HOST [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00004089#define traceroute_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004090 "Trace the route to HOST\n" \
4091 "\nOptions:" \
4092 "\n -F Set the don't fragment bit" \
4093 "\n -I Use ICMP ECHO instead of UDP datagrams" \
4094 "\n -l Display the ttl value of the returned packet" \
4095 "\n -d Set SO_DEBUG options to socket" \
4096 "\n -n Print hop addresses numerically rather than symbolically" \
4097 "\n -r Bypass the normal routing tables and send directly to a host" \
4098 "\n -v Verbose" \
4099 "\n -m max_ttl Max time-to-live (max number of hops)" \
4100 "\n -p port# Base UDP port number used in probes" \
4101 "\n (default is 33434)" \
4102 "\n -q nqueries Number of probes per 'ttl' (default 3)" \
4103 "\n -s src_addr IP address to use as the source address" \
4104 "\n -t tos Type-of-service in probe packets (default 0)" \
4105 "\n -w wait Time in seconds to wait for a response" \
4106 "\n (default 3 sec)" \
4107 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004108
Eric Andersen7e9276b2001-02-22 01:15:47 +00004109#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004110 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004111#define true_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004112 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004113#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004114 "$ true\n" \
4115 "$ echo $?\n" \
4116 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004117
Eric Andersen7e9276b2001-02-22 01:15:47 +00004118#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004119 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004120#define tty_full_usage \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004121 "Print file name of standard input's terminal" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004122 USE_INCLUDE_SUSv2( "\n" \
4123 "\nOptions:" \
4124 "\n -s Print nothing, only return exit status" \
4125 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004126#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004127 "$ tty\n" \
4128 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004129
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004130#define ttysize_trivial_usage \
4131 "[w] [h]"
4132#define ttysize_full_usage \
4133 "Print dimension(s) of standard input's terminal, on error return 80x25"
4134
Mike Frysinger174808c2005-06-11 01:14:09 +00004135#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004136 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
4137 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
4138 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
4139 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
4140 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
4141 "[-T last-check-time] [-U UUID] device"
Mike Frysinger174808c2005-06-11 01:14:09 +00004142#define tune2fs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004143 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004144
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004145#define udhcpc_trivial_usage \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004146 "[-Cfbnqtvo] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004147 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." USE_FEATURE_UDHCP_PORT(" [-P N]")
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004148#define udhcpc_full_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00004149 USE_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004150 " -V,--vendorclass=CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004151 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
4152 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
4153 "\n -c,--clientid=CLIENTID Client identifier" \
4154 "\n -C,--clientid-none Suppress default client identifier" \
4155 "\n -p,--pidfile=file Create pidfile" \
4156 "\n -r,--request=IP IP address to request" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004157 "\n -s,--script=file Run file at DHCP events (default "CONFIG_DHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004158 "\n -t,--retries=N Send up to N request packets" \
4159 "\n -T,--timeout=N Try to get a lease for N seconds (default 3)" \
4160 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004161 "\n -O,--request-option=OPT Request DHCP option OPT (cumulative)" \
4162 "\n -o,--no-default-options Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004163 "\n -f,--foreground Run in foreground" \
4164 "\n -b,--background Background if lease is not immediately obtained" \
4165 "\n -S,--syslog Log to syslog too" \
4166 "\n -n,--now Exit with failure if lease is not immediately obtained" \
4167 "\n -q,--quit Quit after obtaining lease" \
4168 "\n -R,--release Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004169 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004170 "\n -P,--client-port N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004171 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004172 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004173 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004174 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004175 ) \
4176 SKIP_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004177 " -V CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004178 "\n -i INTERFACE Interface to use (default: eth0)" \
4179 "\n -H,-h HOSTNAME Client hostname" \
4180 "\n -c CLIENTID Client identifier" \
4181 "\n -C Suppress default client identifier" \
4182 "\n -p file Create pidfile" \
4183 "\n -r IP IP address to request" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004184 "\n -s file Run file at DHCP events (default "CONFIG_DHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004185 "\n -t N Send up to N request packets" \
4186 "\n -T N Try to get a lease for N seconds (default 3)" \
4187 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004188 "\n -O OPT Request DHCP option OPT (cumulative)" \
4189 "\n -o Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004190 "\n -f Run in foreground" \
4191 "\n -b Background if lease is not immediately obtained" \
4192 "\n -S Log to syslog too" \
4193 "\n -n Exit with failure if lease is not immediately obtained" \
4194 "\n -q Quit after obtaining lease" \
4195 "\n -R Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004196 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004197 "\n -P N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004198 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004199 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004200 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004201 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004202 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004203
Russ Dill61fb4892002-10-14 21:41:28 +00004204#define udhcpd_trivial_usage \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004205 "[-fS]" USE_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004206
4207#define udhcpd_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004208 "DHCP server\n" \
4209 "\n -f Run in foreground" \
4210 "\n -S Log to syslog too" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004211 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004212 "\n -P N Use port N instead of default 67" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004213 )
Russ Dill61fb4892002-10-14 21:41:28 +00004214
Eric Andersen7e9276b2001-02-22 01:15:47 +00004215#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004216 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004217#define umount_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004218 "Unmount file systems\n" \
4219 "\nOptions:" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00004220 USE_FEATURE_UMOUNT_ALL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004221 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
4222 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004223 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004224 "\n -n Don't erase /etc/mtab entries" \
4225 ) \
4226 "\n -r Try to remount devices as read-only if mount is busy" \
4227 "\n -l Lazy umount (detach filesystem)" \
4228 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004229 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004230 "\n -d Free loop device if it has been used" \
4231 )
4232
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004233#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004234 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004235
4236#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004237 "[-amnrspv]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004238#define uname_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004239 "Print system information.\n" \
4240 "\nOptions:" \
4241 "\n -a Print all" \
4242 "\n -m The machine (hardware) type" \
4243 "\n -n Hostname" \
4244 "\n -r OS release" \
4245 "\n -s OS name (default)" \
4246 "\n -p Processor type" \
4247 "\n -v OS version" \
4248
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004249#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004250 "$ uname -a\n" \
4251 "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 +00004252
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004253#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004254 "[-c] [-f] [name...]"
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004255#define uncompress_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004256 "Uncompress .Z file[s]\n" \
4257 "\nOptions:" \
4258 "\n -c Extract to stdout" \
4259 "\n -f Overwrite an existing file" \
Tim Riker7b253f82003-12-28 05:02:40 +00004260
Denis Vlasenko3952f202007-08-13 14:10:24 +00004261#define unexpand_trivial_usage \
4262 "[-f][-a][-t NUM] [FILE|-]"
4263#define unexpand_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004264 "Convert spaces to tabs, writing to standard output.\n" \
4265 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004266 USE_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004267 "\n -a,--all Convert all blanks" \
4268 "\n -f,--first-only Convert only leading blanks" \
4269 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004270 ) \
4271 SKIP_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004272 "\n -a Convert all blanks" \
4273 "\n -f Convert only leading blanks" \
4274 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004275 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004276
Eric Andersen7e9276b2001-02-22 01:15:47 +00004277#define uniq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004278 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004279#define uniq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004280 "Discard all but one of successive identical lines from INPUT\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004281 "(or standard input), writing to OUTPUT (or standard output)\n" \
4282 "\nOptions:" \
4283 "\n -c Prefix lines by the number of occurrences" \
4284 "\n -d Only print duplicate lines" \
4285 "\n -u Only print unique lines" \
4286 "\n -f N Skip the first N fields" \
4287 "\n -s N Skip the first N chars (after any skipped fields)" \
4288
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004289#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004290 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4291 "a\n" \
4292 "b\n" \
4293 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004294
4295#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004296 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004297#define unix2dos_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004298 "Convert FILE from unix to dos format.\n" \
4299 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00004300 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004301 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004302 "\n -d unix2dos" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004303
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004304#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004305 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004306#define unzip_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004307 "Extract files from ZIP archives\n" \
4308 "\nOptions:" \
4309 "\n -l List archive contents (with -q for short form)" \
4310 "\n -n Never overwrite existing files (default)" \
4311 "\n -o Overwrite files without prompting" \
4312 "\n -p Send output to stdout" \
4313 "\n -q Quiet" \
4314 "\n -x Exclude these files" \
4315 "\n -d Extract files into this directory" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004316
Eric Andersen7e9276b2001-02-22 01:15:47 +00004317#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004318 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004319#define uptime_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004320 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004321
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004322#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004323 "$ uptime\n" \
4324 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004325
4326#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004327 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004328#define usleep_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004329 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004330
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004331#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004332 "$ usleep 1000000\n" \
4333 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004334
4335#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004336 "[-o outfile] [infile]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004337#define uudecode_full_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004338 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004339 "Finds outfile name in uuencoded source unless -o is given"
4340
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004341#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004342 "$ uudecode -o busybox busybox.uu\n" \
4343 "$ ls -l busybox\n" \
4344 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004345
4346#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004347 "[-m] [infile] stored_filename"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004348#define uuencode_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004349 "Uuencode a file to stdout\n" \
4350 "\nOptions:" \
4351 "\n -m Use base64 encoding per RFC1521" \
4352
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004353#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004354 "$ uuencode busybox busybox\n" \
4355 "begin 755 busybox\n" \
4356 "<encoded file snipped>\n" \
4357 "$ uudecode busybox busybox > busybox.uu\n" \
4358 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004359
Eric Andersen853c4942003-01-23 05:59:32 +00004360#define vconfig_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004361 "COMMAND [OPTIONS]..."
Eric Andersen853c4942003-01-23 05:59:32 +00004362#define vconfig_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004363 "Create and remove virtual ethernet devices\n" \
4364 "\nOptions:" \
4365 "\n add [interface-name] [vlan_id]" \
4366 "\n rem [vlan-name]" \
4367 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4368 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4369 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4370 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004371
Eric Andersen3f980402001-04-04 17:31:15 +00004372#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004373 "[OPTION] [FILE]..."
Eric Andersen3f980402001-04-04 17:31:15 +00004374#define vi_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004375 "Edit FILE\n" \
4376 "\nOptions:" \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004377 USE_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004378 "\n -c Initial command to run ($EXINIT also available)") \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004379 USE_FEATURE_VI_READONLY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004380 "\n -R Read-only - do not write to the file") \
4381 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00004382
Eric Andersen27f64e12002-06-23 04:24:25 +00004383#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004384 "[OPTIONS]"
Eric Andersen27f64e12002-06-23 04:24:25 +00004385#define vlock_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004386 "Lock a virtual terminal. A password is required to unlock.\n" \
4387 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00004388 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004389
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004390#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00004391 "[-n seconds] [-t] COMMAND..."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004392#define watch_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004393 "Execute a program periodically\n" \
4394 "\nOptions:" \
4395 "\n -n Loop period in seconds (default 2)" \
4396 "\n -t Don't print header" \
4397
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004398#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004399 "$ watch date\n" \
4400 "Mon Dec 17 10:31:40 GMT 2000\n" \
4401 "Mon Dec 17 10:31:42 GMT 2000\n" \
4402 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004403
Eric Andersen7e9276b2001-02-22 01:15:47 +00004404#define watchdog_trivial_usage \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004405 "[-t N[ms]] [-F] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004406#define watchdog_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004407 "Periodically write to watchdog device DEV\n" \
4408 "\nOptions:" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004409 "\n -t N Timer period (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004410 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004411 "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004412 "\nUse -t 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004413
4414#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004415 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00004416#define wc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004417 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004418 "more than one FILE is specified. With no FILE, read standard input.\n" \
4419 "\nOptions:" \
4420 "\n -c Print the byte counts" \
4421 "\n -l Print the newline counts" \
4422 "\n -L Print the length of the longest line" \
4423 "\n -w Print the word counts" \
4424
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004425#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004426 "$ wc /etc/passwd\n" \
4427 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004428
4429#define wget_trivial_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00004430 USE_GETOPT_LONG( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004431 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004432 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4433 " [-U|--user-agent agent] url" \
4434 ) \
4435 SKIP_GETOPT_LONG( \
4436 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4437 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00004438#define wget_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004439 "Retrieve files via HTTP or FTP\n" \
4440 "\nOptions:" \
4441 "\n -s Spider mode - only check file existence" \
4442 "\n -c Continue retrieval of aborted transfer" \
4443 "\n -q Quiet" \
4444 "\n -P Set directory prefix to DIR" \
4445 "\n -O Save to filename ('-' for stdout)" \
4446 "\n -U Adjust 'User-Agent' field" \
4447 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004448
4449#define which_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004450 "[COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004451#define which_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004452 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004453#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004454 "$ which login\n" \
4455 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004456
Eric Andersen00a6a752002-04-26 23:53:10 +00004457#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004458 "[-a]"
Eric Andersen00a6a752002-04-26 23:53:10 +00004459#define who_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004460 "Show who is logged on\n" \
4461 "\nOptions:" \
4462 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004463
4464#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004465 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004466#define whoami_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004467 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004468
4469#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004470 "[OPTIONS] [COMMAND] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004471#define xargs_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004472 "Execute COMMAND on every item given by standard input\n" \
4473 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004474 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004475 "\n -p Prompt the user about whether to run each command") \
4476 "\n -r Do not run command for empty read lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004477 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004478 "\n -x Exit if the size is exceeded") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004479 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004480 "\n -0 Input filenames are terminated by a null character") \
4481 "\n -t Print the command line on stderr before executing it" \
4482
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004483#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004484 "$ ls | xargs gzip\n" \
4485 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004486
4487#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004488 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00004489#define yes_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004490 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004491
Eric Andersen7e9276b2001-02-22 01:15:47 +00004492#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004493 "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004494#define zcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004495 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004496
Rob Landleyad8071f2005-04-30 03:49:37 +00004497#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004498 "[OPTIONS] ifname script"
Rob Landleyad8071f2005-04-30 03:49:37 +00004499#define zcip_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004500 "Manage a ZeroConf IPv4 link-local address\n" \
4501 "\nOptions:" \
4502 "\n -f Run in foreground" \
4503 "\n -q Quit after address (no daemon)" \
4504 "\n -r 169.254.x.x Request this address first" \
4505 "\n -v Verbose" \
Rob Landleyad8071f2005-04-30 03:49:37 +00004506
Eric Andersen178de172004-04-06 16:36:20 +00004507#endif /* __BB_USAGE_H__ */